PATCH: module clean-up

.scrutinizer.yml

@@ -1,9 +1,69 @@
 inherit: true
+
+checks:
+  php:
+    verify_property_names: true
+    verify_argument_usable_as_reference: true
+    verify_access_scope_valid: true
+    useless_calls: true
+    use_statement_alias_conflict: true
+    variable_existence: true
+    unused_variables: true
+    unused_properties: true
+    unused_parameters: true
+    unused_methods: true
+    unreachable_code: true
+    too_many_arguments: true
+    sql_injection_vulnerabilities: true
+    simplify_boolean_return: true
+    side_effects_or_types: true
+    security_vulnerabilities: true
+    return_doc_comments: true
+    return_doc_comment_if_not_inferrable: true
+    require_scope_for_properties: true
+    require_scope_for_methods: true
+    require_php_tag_first: true
+    psr2_switch_declaration: true
+    psr2_class_declaration: true
+    property_assignments: true
+    prefer_while_loop_over_for_loop: true
+    precedence_mistakes: true
+    precedence_in_conditions: true
+    phpunit_assertions: true
+    php5_style_constructor: true
+    parse_doc_comments: true
+    parameter_non_unique: true
+    parameter_doc_comments: true
+    param_doc_comment_if_not_inferrable: true
+    optional_parameters_at_the_end: true
+    one_class_per_file: true
+    no_unnecessary_if: true
+    no_trailing_whitespace: true
+    no_property_on_interface: true
+    no_non_implemented_abstract_methods: true
+    no_error_suppression: true
+    no_duplicate_arguments: true
+    no_commented_out_code: true
+    newline_at_end_of_file: true
+    missing_arguments: true
+    method_calls_on_non_object: true
+    instanceof_class_exists: true
+    foreach_traversable: true
+    fix_line_ending: true
+    fix_doc_comments: true
+    duplication: true
+    deprecated_code_usage: true
+    deadlock_detection_in_loops: true
+    code_rating: true
+    closure_use_not_conflicting: true
+    catch_class_exists: true
+    blank_line_after_namespace_declaration: false
+    avoid_multiple_statements_on_same_line: true
+    avoid_duplicate_types: true
+    avoid_conflicting_incrementers: true
+    avoid_closing_tag: true
+    assignment_of_null_return: true
+    argument_type_checks: true
+
 filter:
-filter:
-  paths: ["code/*", "tests/*"]
-  excluded_paths:
-    - thirdparty/*
-    - parsers/*
-    - docs/*
-    - images/*
+  paths: [code/*, tests/*]

README.md

@@ -1,37 +1,72 @@
-Search Plus================================================================================
+# Silverstripe searchplus module
+[![Build Status](https://travis-ci.org/sunnysideup/silverstripe-searchplus.svg?branch=master)](https://travis-ci.org/sunnysideup/silverstripe-searchplus)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-searchplus/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-searchplus/?branch=master)
+[![codecov.io](https://codecov.io/github/sunnysideup/silverstripe-searchplus/coverage.svg?branch=master)](https://codecov.io/github/sunnysideup/silverstripe-searchplus?branch=master)
+![helpfulrobot](https://helpfulrobot.io/sunnysideup/searchplus/badge)
 
-Adds additional search functionality to your
-silverstripe website.
+[![Latest Stable Version](https://poser.pugx.org/sunnysideup/searchplus/version)](https://packagist.org/packages/sunnysideup/searchplus)
+[![License](https://poser.pugx.org/sunnysideup/searchplus/license)](https://packagist.org/packages/sunnysideup/searchplus)
+[![Monthly Downloads](https://poser.pugx.org/sunnysideup/searchplus/d/monthly)](https://packagist.org/packages/sunnysideup/searchplus)
 
 
-Developer
------------------------------------------------
-Nicolaas Francken [at] sunnysideup.co.nz
+## Documentation
 
 
-Requirements
------------------------------------------------
-see composer.json
-HIGHLY RECOMMENDED:
-http://svn.gpmd.net/svn/open/multiselectfield/
 
+ * [Developer Docs](docs/en/INDEX.md)
+ * [User Guide](docs/en/userguide.md)
+ * [API](http://ssmods.com/apis/searchplus/docs/en/api/)
 
-Documentation
------------------------------------------------
-Please contact author for more details.
+## Requirements
 
-Any bug reports and/or feature requests will be
-looked at in detail
 
-We are also very happy to provide personalised support
-for this module in exchange for a small donation.
 
+see [composer.json](composer.json) for details
 
-Installation Instructions
------------------------------------------------
-1. Find out how to add modules to SS and add module as per usual.
+### Suggested Modules
 
-2. Review configs and add entries to mysite/_config/config.yml
-(or similar) as necessary.
-In the _config/ folder of this module
-you can usually find some examples of config options (if any).
+
+
+see [composer.json](composer.json) for details
+
+
+## Installation
+
+
+```
+composer require sunnysideup/searchplus
+```
+
+### Configuration
+
+
+
+In the `_config` folder you will find the `searchplus.yml.example`
+file that shows options for the configuration of this module.
+
+We recommend that you:
+
+  1. copy these `searchplus.yml.example` files into your
+`mysite/_config` folder
+  2. remove the .example extension
+  3. delete the lines you not care about, and
+  4. adjust the configurations that you would like to use.
+
+
+## Contributing
+
+
+
+We welcome any contributions. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
+
+## Paid assistance
+
+
+
+You can pay us to create an improved / adapted version of this module for your own projects.  Please contact us if you like to find out more: [www.sunnysideup.co.nz](http://www.sunnysideup.co.nz)
+
+## Author
+
+
+
+Sunny Side Up Ltd.

_config/config.yml

@@ -1,7 +1,4 @@
-ContentController:
-  extensions:
-    - SearchPlusSearchForm
-
-SiteTree:
-  extensions:
-    - SearchPlusSearchSiteTreeExtension
+ContentController:
+    extensions: [SearchPlusSearchForm]
+SiteTree:
+    extensions: [SearchPlusSearchSiteTreeExtension]

docs/en/INDEX.md

@@ -0,0 +1,37 @@
+Search Plus================================================================================
+
+Adds additional search functionality to your
+silverstripe website.
+
+
+Developer
+-----------------------------------------------
+Nicolaas Francken [at] sunnysideup.co.nz
+
+
+Requirements
+-----------------------------------------------
+see composer.json
+HIGHLY RECOMMENDED:
+http://svn.gpmd.net/svn/open/multiselectfield/
+
+
+Documentation
+-----------------------------------------------
+Please contact author for more details.
+
+Any bug reports and/or feature requests will be
+looked at in detail
+
+We are also very happy to provide personalised support
+for this module in exchange for a small donation.
+
+
+Installation Instructions
+-----------------------------------------------
+1. Find out how to add modules to SS and add module as per usual.
+
+2. Review configs and add entries to mysite/_config/config.yml
+(or similar) as necessary.
+In the _config/ folder of this module
+you can usually find some examples of config options (if any).

docs/en/README.old.md

@@ -0,0 +1,37 @@
+Search Plus================================================================================
+
+Adds additional search functionality to your
+silverstripe website.
+
+
+Developer
+-----------------------------------------------
+Nicolaas Francken [at] sunnysideup.co.nz
+
+
+Requirements
+-----------------------------------------------
+see composer.json
+HIGHLY RECOMMENDED:
+http://svn.gpmd.net/svn/open/multiselectfield/
+
+
+Documentation
+-----------------------------------------------
+Please contact author for more details.
+
+Any bug reports and/or feature requests will be
+looked at in detail
+
+We are also very happy to provide personalised support
+for this module in exchange for a small donation.
+
+
+Installation Instructions
+-----------------------------------------------
+1. Find out how to add modules to SS and add module as per usual.
+
+2. Review configs and add entries to mysite/_config/config.yml
+(or similar) as necessary.
+In the _config/ folder of this module
+you can usually find some examples of config options (if any).

tests/SearchplusTest.php

@@ -0,0 +1,13 @@
+<?php
+class SearchplusTest extends SapphireTest {
+
+	protected $usesDatabase = false;
+
+	protected $requiredExtensions = array();
+
+	public function testMyMethod() {
+		$this->assertEquals(1, 1);
+	}
+
+}
+