Vendor module and front end module support (#174)

* vendor module
* shifted more stuff around
* Started to shift things around to prep for front end modules
* Converted all string class refrences to static::class
Started to create tests for new methods

* Re-arranged tests
Added more tests to LocatorTest.php
  - split LocatorTest.php into locator and controller tests respectivly

* Fixed scrutinizer

* Added more tests

* Added another test

* Made locator less of a priority for templates
  - front end modules now get to be first

* moved the loading of google maps outside of trigger check

* Now uses config values to get variable names
  - Allows to change `Controller::curr()->getRequest()->getVar('Radius')` to `Controller::curr()->getRequest()->getVar('radius')`
  - same with category

* Updated docs

.editorconfig

@@ -7,8 +7,8 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-indent_size = 4
-indent_style = tab
+indent_size = 2
+indent_style = space
 insert_final_newline = true
 trim_trailing_whitespace = true
 

.scrutinizer.yml

@@ -27,5 +27,11 @@ checks:
         code_rating: true
         duplication: true
 
+build:
+  nodes:
+    analysis:
+      tests:
+        override: [php-scrutinizer-run]
+
 filter:
-    paths: [tests/*,code/*]
+    paths: [tests/*,code/*]

_config/config.yml

@@ -5,4 +5,21 @@ Dynamic\Locator\Location:
   extensions:
     - Dynamic\SilverStripeGeocoder\DistanceDataExtension
     - Dynamic\SilverStripeGeocoder\AddressDataExtension
-    - SilverStripe\Versioned\Versioned('Stage','Live')
+    - SilverStripe\Versioned\Versioned('Stage','Live')
+
+Dynamic\Locator\Locator:
+  infoWindowTemplate: 'dynamic/silverstripe-locator: client/infowindow-description.html'
+  listTemplate: 'dynamic/silverstripe-locator: client/location-list-description.html'
+  limit: 50
+  show_radius: true
+  radius_var: 'Radius'
+  category_var: 'CategoryID'
+
+---
+Name: modules-locator
+After: modules-other
+Before: modules-framework
+---
+SilverStripe\Core\Manifest\ModuleManifest:
+  module_priority:
+    - dynamic/silverstripe-locator

composer.json

@@ -10,7 +10,7 @@
     "google maps",
     "location"
   ],
-  "type": "silverstripe-module",
+  "type": "silverstripe-vendormodule",
   "license": "BSD-3-Clause",
   "authors": [
     {
@@ -21,12 +21,14 @@
   ],
   "require": {
     "silverstripe/recipe-cms": "^1.0",
+    "silverstripe/vendor-plugin": "^1.0",
     "muskie9/data-to-arraylist": "^2.0",
     "dynamic/silverstripe-geocoder": "^1.0",
     "symbiote/silverstripe-gridfieldextensions": "^3.0"
   },
   "require-dev": {
-    "phpunit/PHPUnit": "^5.7"
+    "phpunit/PHPUnit": "^5.7",
+    "squizlabs/php_codesniffer": "*"
   },
   "config": {
     "process-timeout": 600
@@ -44,7 +46,11 @@
   "minimum-stability": "dev",
   "prefer-stable": true,
   "extra": {
-    "installer-name": "locator",
+    "expose": [
+      "thirdparty",
+      "css",
+      "client"
+    ],
     "branch-alias": {
       "dev-master": "3.0.x-dev"
     }

docs/en/developerguide/customizing.md

@@ -0,0 +1,46 @@
+## Customizing
+Some customization is done through a yml config.
+
+### Limit
+Will limit the amount of locations that can be shown at one time. Set to `-1` to have no limit. Having no limit can result in slow load times, or even timeouts when loading the page or new data.
+```yaml
+Dynamic\Locator\Locator:
+  limit: 50
+```
+
+### Radius
+- `show_radius` will determine if a radius dropdown should be shown.
+- `radii` is a list of radii to use in the radius dropdown.
+```yaml
+Dynamic\Locator\Locator:
+  show_radius: true
+  radii: [30, 50, 100]
+```
+
+### Templates
+Overriding the templates for the info window and list can be overridden by using `infoWindowTemplate` and `listTemplate`.
+- `infoWindowTemplate` is the popup when a location is clicked.
+- `listTemplate` is a single location in the list
+```yaml
+Dynamic\Locator\Locator:
+  infoWindowTemplate: 'dynamic/silverstripe-locator: client/infowindow-description.html'
+  listTemplate: 'dynamic/silverstripe-locator: client/location-list-description.html'
+```
+The `vendor/module: file` pattern can be used to locate files.
+
+### Custom URL Variables
+Sometimes it is useful to override the defaults for url variables. 
+An example of this is when the module uses title case but you wrote everything for lowercase. It becomes seamless to switch out the variable names.
+- `radius_var` is the variable used to send and receive the currently selected radius.
+- `category_var` is the variable used to send and receive the currently selected category.
+- `address_var` is the variable used to send and receive the searched location.
+- `unit_var` is the variable used to send and receive the current unit of measure used for distance.
+```yaml
+Dynamic\Locator\Locator:
+  radius_var: 'Radius'
+  category_var: 'CategoryID'
+  
+Dynamic\SilverStripeGeocoder\DistanceDataExtension:
+  address_var: 'Address'
+  unit_var: 'Unit'
+```

docs/en/developerguide/setup.md

@@ -0,0 +1,8 @@
+## Setup
+To use google maps an api key is required. 
+In mysite/_config/settings.yml
+```yaml
+Dynamic\SilverStripeGeocoder\GoogleGeocoder:
+  geocoder_api_key: YOUR_API_KEY
+```
+Replace `YOUR_API_KEY` with your google maps api key. If you are unsure where to get an api key, [look here](https://developers.google.com/maps/documentation/javascript/get-api-key).

docs/en/index.md

@@ -1,7 +1,12 @@
-#SilverStripe Locator
+# SilverStripe Locator
 
-##Using Locator
+## Using Locator
 
 See [User Guide](userguide/index.md) for information on using the Locator module in the CMS.
 
-See [Importing Locations](userguide/import.md) for information on importing Location and Category records.
+See [Importing Locations](userguide/import.md) for information on importing Location and Category records.
+
+## Developer guides
+
+- [Setup](developerguide/setup.md)
+- [Customizing](developerguide/customizing.md)

phpunit.xml.dist

@@ -1,4 +1,4 @@
-<phpunit bootstrap="cms/tests/bootstrap.php" colors="true">
+<phpunit bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true">
     <testsuite name="locator">
         <directory>tests</directory>
     </testsuite>

src/admin/LocationAdmin.php

@@ -3,6 +3,8 @@
 namespace Dynamic\Locator;
 
 use SilverStripe\Admin\ModelAdmin;
+use SilverStripe\Dev\CsvBulkLoader;
+use SilverStripe\Forms\Form;
 
 /**
  * Class LocationAdmin
@@ -14,16 +16,16 @@ class LocationAdmin extends ModelAdmin
      * @var array
      */
     private static $managed_models = array(
-        'Dynamic\\Locator\\Location',
-        'Dynamic\\Locator\\LocationCategory',
+        Location::class,
+        LocationCategory::class,
     );
 
     /**
      * @var array
      */
     private static $model_importers = array(
-        'Dynamic\\Locator\\Location' => 'Dynamic\\Locator\\LocationCsvBulkLoader',
-        'Dynamic\\Locator\\LocationCategory' => 'SilverStripe\\Dev\\CsvBulkLoader',
+        Location::class => LocationCsvBulkLoader::class,
+        LocationCategory::class => CsvBulkLoader::class,
     );
 
     /**

src/form/LocatorForm.php

@@ -17,20 +17,6 @@
  */
 class LocatorForm extends Form
 {
-    /**
-     * @var bool
-     */
-    private static $show_radius = true;
-
-    /**
-     * @var array
-     */
-    private static $radius_array = [
-        '25' => '25',
-        '50' => '50',
-        '75' => '75',
-        '100' => '100',
-    ];
 
     /**
      * LocatorForm constructor.
@@ -64,8 +50,8 @@ public function __construct(Controller $controller, $name)
             $fields->push($categoriesField);
         }
 
-        if (Config::inst()->get(LocatorForm::class, 'show_radius')) {
-            $radiusArray = Config::inst()->get(LocatorForm::class, 'radius_array');
+        if ($controller->getShowRadius()) {
+            $radiusArray = $controller->getRadii();
             $this->extend('overrideRadiusArray', $radiusArray);
             $fields->push(DropdownField::create('Radius', '', $radiusArray)
                 ->setEmptyString('radius')
@@ -95,4 +81,4 @@ public function getValidator()
         $this->extend('updateRequiredFields', $validator);
         return $validator;
     }
-}
+}

src/objects/Location.php

@@ -34,6 +34,11 @@ class Location extends DataObject implements PermissionProvider
      */
     private static $plural_name = 'Locations';
 
+    /**
+     * @var bool
+     */
+    private static $versioned_gridfield_extensions = true;
+
     /**
      * @var array
      */

src/objects/LocationCategory.php

@@ -4,6 +4,7 @@
 
 use SilverStripe\Forms\GridField\GridField;
 use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
+use SilverStripe\Forms\GridField\GridFieldAddNewButton;
 use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
 use SilverStripe\ORM\DataObject;
 use SilverStripe\Security\Permission;
@@ -72,9 +73,9 @@ public function getCMSFields()
         if ($this->ID) {
             // Locations
             $config = GridFieldConfig_RelationEditor::create();
-            $config->removeComponentsByType('GridFieldAddExistingAutocompleter');
+            $config->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
             $config->addComponent(new GridFieldAddExistingAutocompleter());
-            $config->removeComponentsByType('GridFieldAddNewButton');
+            $config->removeComponentsByType(GridFieldAddNewButton::class);
             $locations = $this->Locations();
             $locationField = GridField::create('Locations', 'Locations', $locations, $config);