Improving namespace and adding Facade support

Author: Pablo Molina

composer.json

@@ -22,21 +22,23 @@
         "illuminate/container": "~5.4.36",
         "illuminate/http": "~5.4.36",
         "illuminate/support": "~5.4.36",
+        "psr/log": "^1.0",
         "zumba/swivel": "^2.1"
     },
     "require-dev": {
         "mockery/mockery": "^1.2",
+        "orchestra/testbench": "~3.4.0",
         "phpunit/phpunit": "~5.0",
         "squizlabs/php_codesniffer": "^3.4"
     },
     "autoload": {
         "psr-4": {
-            "Webkod3r\\LaravelSwivel\\": "src"
+            "LaravelSwivel\\": "src"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Tests\\Webkod3r\\LaravelSwivel\\": "tests"
+            "Tests\\LaravelSwivel\\": "tests"
         }
     },
     "scripts": {
@@ -51,11 +53,12 @@
         },
         "laravel": {
             "providers": [
-                "Webkod3r\\LaravelSwivel\\LaravelSwivelServiceProvider"
+                "LaravelSwivel\\LaravelSwivelServiceProvider"
             ]
         }
     },
     "config": {
+        "optimize-autoloader": true,
         "sort-packages": true
     },
     "minimum-stability": "dev"

composer.lock

@@ -21,7 +21,7 @@
     | Defines the class used to load the swivel feature and handle the behavior
     |
     */
-    'loader_class' => env('SWIVEL_LOADER_CLASS', \Webkod3r\LaravelSwivel\SwivelLoader::class),
+    'loader_class' => env('SWIVEL_LOADER_CLASS', \LaravelSwivel\SwivelLoader::class),
 
     /*
     |--------------------------------------------------------------------------
@@ -31,7 +31,7 @@
     | Defines the class used to load features from Database
     |
     */
-    'model_class' => env('SWIVEL_MODEL_CLASS', \Webkod3r\LaravelSwivel\Entity\SwivelFeature::class),
+    'model_class' => env('SWIVEL_MODEL_CLASS', \LaravelSwivel\Entity\SwivelFeature::class),
 
     /*
     |--------------------------------------------------------------------------

config/swivel.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Webkod3r\LaravelSwivel\Entity;
+namespace LaravelSwivel\Entity;
 
 use Illuminate\Container\Container;
 use Illuminate\Database\Eloquent\Model;
@@ -10,15 +10,15 @@
 /**
  * Class SwivelFeature
  *
- * @package Webkod3r\LaravelSwivel\Entity
+ * @package LaravelSwivel\Entity
  * @property integer $id
  * @property string $slug
  * @property string $buckets
  * @property \DateTime $created_at
  * @property \DateTime $updated_at
  */
-class SwivelFeature extends Model implements SwivelModelInterface {
-
+class SwivelFeature extends Model implements SwivelModelInterface
+{
     /**
      * The table associated with the model.
      *
@@ -57,7 +57,8 @@ protected function getContainer()
      * ]
      * </pre>
      */
-    public function getMapData() {
+    public function getMapData()
+    {
         // load configuration settings
         $config = (array)$this->getContainer()->make('config')->get('swivel');
 
@@ -81,10 +82,11 @@ public function getMapData() {
     /**
      * Format data from database to the data swivel expects
      *
-     * @param array $feature
+     * @param array $feature Feature record with behavior and buckets
      * @return array
      */
-    protected function formatRow(array $feature) {
+    protected function formatRow(array $feature)
+    {
         if (!empty($feature['id'])) {
             return [$feature['slug'] => explode(static::DELIMITER, $feature['buckets'])];
         }

src/Entity/SwivelFeature.php

@@ -1,8 +1,9 @@
 <?php
 
-namespace Webkod3r\LaravelSwivel\Entity;
+namespace LaravelSwivel\Entity;
 
-interface SwivelModelInterface {
+interface SwivelModelInterface
+{
     /**
      * Return an array of map data in the format that Swivel expects
      *

src/Entity/SwivelModelInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Webkod3r\LaravelSwivel\Support\Facades;
+namespace LaravelSwivel\Support\Facades;
 
 use Illuminate\Support\Facades\Facade;
 
@@ -13,6 +13,6 @@ class Swivel extends Facade
      */
     protected static function getFacadeAccessor()
     {
-        return 'Swivel';
+        return 'swivel';
     }
 }

src/Support/Facades/Swivel.php src/Facades/Swivel.phpsrc/Support/Facades/Swivel.php renamed to src/Facades/Swivel.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Webkod3r\LaravelSwivel;
+namespace LaravelSwivel;
 
 use \Illuminate\Contracts\Container\Container;
 use \Illuminate\Support\ServiceProvider;
@@ -9,13 +9,12 @@
 
 class LaravelSwivelServiceProvider extends ServiceProvider
 {
-
     /**
      * The package version.
      *
      * @var string
      */
-    const VERSION = '0.2.2';
+    const VERSION = '1.0.1';
 
     /**
      * Indicates if loading of the provider is deferred.
@@ -36,6 +35,21 @@ public function boot()
         $this->loadMigrationsFrom(__DIR__ . '/database/migrations');
     }
 
+    /**
+     * Register the application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        $this->app->singleton('swivel', function (Container $app) {
+            $request = $app->make(\Illuminate\Http\Request::class);
+            return new SwivelComponent($request);
+        });
+
+        $this->app->alias('swivel', SwivelComponent::class);
+    }
+
     /**
      * Returns the configuration path for the component
      *
@@ -62,52 +76,16 @@ protected function setupConfig(Container $app)
             $app->configure('swivel');
         }
 
-        // merge specific configurations
-        $source = $app->getConfigurationPath('swivel') ?: $source;
         $this->mergeConfigFrom($source, 'swivel');
     }
 
-    /**
-     * Sets swivel configuration
-     *
-     * @return void
-     */
-    private function publishAssets()
-    {
-        app()->make('config')->set('swivel', app()->getConfigurationPath('swivel'));
-        app()->configure('swivel');
-    }
-
-    /**
-     * @return void
-     */
-    public function register()
-    {
-        $this->registerClass();
-    }
-
-    /**
-     * Register single service provider
-     *
-     * @return void
-     */
-    private function registerClass()
-    {
-        $this->app->singleton('Swivel', function (Container $app) {
-            $request = app(\Illuminate\Http\Request::class);
-            return new SwivelComponent($request);
-        });
-
-        $this->app->alias('Swivel', SwivelComponent::class);
-    }
-
     /**
      * Get the services provided by the provider.
      *
      * @return array
      */
     public function provides()
     {
-        return ['Swivel'];
+        return ['swivel'];
     }
 }

src/LaravelSwivelServiceProvider.php

@@ -1,18 +1,17 @@
 <?php
 
-namespace Webkod3r\LaravelSwivel;
+namespace LaravelSwivel;
 
 use Illuminate\Http\Request;
 
 /**
- * @package Webkod3r\LaravelSwivel
+ * @package LaravelSwivel
  * @author Pablo Molina <web.kod3r@gmail.com>
  */
 class SwivelComponent
 {
-
     /**
-     * @var \Webkod3r\LaravelSwivel\SwivelLoader
+     * @var \LaravelSwivel\SwivelLoader
      */
     protected $loader;
 
@@ -59,7 +58,7 @@ public function __construct(Request $request)
     /**
      * Get the loader instance to access it easily
      *
-     * @return \Webkod3r\LaravelSwivel\SwivelLoader
+     * @return \LaravelSwivel\SwivelLoader
      */
     public function getLoader()
     {

src/SwivelComponent.php

@@ -1,8 +1,8 @@
 <?php
 
-namespace Webkod3r\LaravelSwivel;
+namespace LaravelSwivel;
 
-use Webkod3r\LaravelSwivel\Entity\SwivelFeature;
+use LaravelSwivel\Entity\SwivelFeature;
 
 /**
  * @package Webkod3r\LaravelSwivel