Fix Coding Style (#17)

* Format Code

* Update changelog and readme

.gitignore

@@ -4,4 +4,5 @@
 composer.lock
 .phpunit.result.cache
 testbench/
-/coverage
+/coverage
+.DS_Store

changelog.md

@@ -4,6 +4,11 @@ All notable changes to `laravel Ussd` will be documented in this file.
 
 ## [Unreleased]
 
+## [v2.3.1] - 2021-10-15
+
+### Fixed
+- Coding style
+
 ## [v2.3.0] - 2021-06-27
 ### Added
 - Add missen test to improve coverage
@@ -59,7 +64,8 @@ All notable changes to `laravel Ussd` will be documented in this file.
 - Ussd config to allow developers customize behaviour
 - Ussd service Provider class to allow laravel know how to integrate the package
 
-[Unreleased]: ../../compare/v2.3.0...HEAD
+[Unreleased]: ../../compare/v2.3.1...HEAD
+[v2.3.1]: ../../compare/v2.3.0...v2.3.1
 [v2.3.0]: ../../compare/v2.2.0...v2.3.0
 [v2.2.0]: ../../compare/v2.1.0...v2.2.0
 [v2.1.0]: ../../compare/v2.0.0...v2.1.0

config/ussd.php

@@ -1,7 +1,7 @@
 <?php
 
 return [
-    
+
     /*
     |--------------------------------------------------------------------------
     | State Class Namespace
@@ -62,4 +62,4 @@
     */
 
     'cache_default' => env('USSD_DEFAULT_VALUE', null),
-];
+];

readme.md

@@ -261,7 +261,7 @@ You'll find the documentation on [https://sparors.github.io/ussd-docs](https://s
 ### Testing
 
 ``` bash
-$ composer test
+$ vendor\bin\phpunit
 ```
 
 ### Change log

src/Action.php

@@ -8,7 +8,7 @@ abstract class Action
     /** @var Record */
     protected $record;
 
-    public abstract function run(): string;
+    abstract public function run(): string;
 
     /**
      * @param Record $record

src/Commands/GenerateCommand.php

@@ -11,7 +11,7 @@ class GenerateCommand extends Command
     protected function pathFromNamespace($namespace, $relativePath)
     {
         $extended_path = implode('\\', array_map(function ($value) {
-            return ucfirst($value); 
+            return ucfirst($value);
         }, explode(DIRECTORY_SEPARATOR, $relativePath)));
 
         $base_path = Str::replaceFirst(app()->getNamespace(), '', $namespace);
@@ -23,7 +23,7 @@ protected function pathFromNamespace($namespace, $relativePath)
     protected function classNamespace($namespace, $relativePath)
     {
         $path = array_map(function ($value) {
-            return ucfirst($value); 
+            return ucfirst($value);
         }, explode(DIRECTORY_SEPARATOR, $relativePath));
 
         array_pop($path);
@@ -46,4 +46,4 @@ protected function ensureDirectoryExists($namespace, $relativePath)
             File::makeDirectory(dirname($path), 0777, $recursive = true, $force = true);
         }
     }
-}
+}

src/Facades/Ussd.php

@@ -8,7 +8,7 @@
  * @method static \Sparors\Ussd\Record record(string $id, string $store = null)
  * @method static \Sparors\Ussd\Menu menu(string $menu)
  * @method static \Sparors\Ussd\Machine machine()
- * 
+ *
  * @see \Sparors\Ussd\Ussd
  */
 class Ussd extends Facade

src/HasManipulators.php

@@ -71,7 +71,7 @@ public function setStore(?string $store)
 
     public function set(array $parameters)
     {
-        foreach($parameters as $property => $value) {
+        foreach ($parameters as $property => $value) {
             $property = Str::camel($property);
             if (property_exists($this, $property)) {
                 $this->$property = $value;
@@ -83,7 +83,7 @@ public function set(array $parameters)
 
     public function setFromRequest(array $parameters)
     {
-        foreach($parameters as $property => $key) {
+        foreach ($parameters as $property => $key) {
             $property = Str::camel($property);
             if (property_exists($this, $property)) {
                 $this->$property = request($key);
@@ -106,7 +106,7 @@ public function setInitialState($state)
         } else {
             $this->initialState = null;
         }
-        
+
         return $this;
     }
 

src/Machine.php

@@ -18,7 +18,7 @@ class Machine
 
     /** @var Record */
     protected $record;
-    
+
     /** @var string|null */
     protected $sessionId;
 
@@ -52,7 +52,7 @@ public function __construct()
     public function run()
     {
         $this->ensureSessionIdIsSet($this->sessionId);
-        
+
         $this->record = new Record(
             Cache::store($this->store),
             $this->sessionId
@@ -64,12 +64,12 @@ public function run()
             $active = $this->record->get('__active');
 
             $this->ensureClassExist(
-                $active, 
+                $active,
                 'Active State Class needs to be set before ussd machine can'
                 . ' run. It may be that your session has ended.'
             );
 
-            $activeClass = new $active;
+            $activeClass = new $active();
             $activeClass->setRecord($this->record);
 
             $state = $activeClass->next($this->input);
@@ -80,10 +80,9 @@ public function run()
                 'Continuing State Class needs to be set before ussd '
                 . 'machine can run. It may be that your session has ended.'
             );
-            
+
             $this->record->set('__active', $state);
         } else {
-
             $this->processInitialState();
 
             $state = $this->initialState;
@@ -154,9 +153,9 @@ protected function processAction(&$stateClass, &$state, $exception): void
         $this->ensureClassExist(
             $state,
             $exception
-        );            
-        
-        $stateClass = new $state;
+        );
+
+        $stateClass = new $state();
         $stateClass->setRecord($this->record);
 
         if (is_subclass_of($stateClass, Action::class)) {
@@ -167,7 +166,7 @@ protected function processAction(&$stateClass, &$state, $exception): void
                 'Ussd Action Class needs to return next State Class'
             );
 
-            $stateClass = new $state;
+            $stateClass = new $state();
             $stateClass->setRecord($this->record);
         }
     }

src/Menu.php

@@ -4,24 +4,24 @@
 
 class Menu
 {
-    const NUMBERING_ALPHABETIC_LOWER = 'alphabetic_lower';
-    const NUMBERING_ALPHABETIC_UPPER = 'alphabetic_upper';
-    const NUMBERING_EMPTY = 'empty';
-    const NUMBERING_NUMERIC = 'numeric';
-
-    const ITEMS_SEPARATOR_NO_LINE_BREAK = "";
-    const ITEMS_SEPARATOR_LINE_BREAK = "\n";
-    const ITEMS_SEPARATOR_DOUBLE_LINE_BREAK = "\n\n";
-
-    const NUMBERING_SEPARATOR_NO_SPACE = "";
-    const NUMBERING_SEPARATOR_SPACE = " ";
-    const NUMBERING_SEPARATOR_DOUBLE_SPACE = "  ";
-    const NUMBERING_SEPARATOR_DOT = ".";
-    const NUMBERING_SEPARATOR_DOT_PLUS_SPACE = ". ";
-    const NUMBERING_SEPARATOR_DOT_PLUS_DOUBLE_SPACE = ".  ";
-    const NUMBERING_SEPARATOR_BRACKET = ")";
-    const NUMBERING_SEPARATOR_BRACKET_PLUS_SPACE = ") ";
-    const NUMBERING_SEPARATOR_BRACKET_PLUS_DOUBLE_SPACE = ")  ";
+    public const NUMBERING_ALPHABETIC_LOWER = 'alphabetic_lower';
+    public const NUMBERING_ALPHABETIC_UPPER = 'alphabetic_upper';
+    public const NUMBERING_EMPTY = 'empty';
+    public const NUMBERING_NUMERIC = 'numeric';
+
+    public const ITEMS_SEPARATOR_NO_LINE_BREAK = "";
+    public const ITEMS_SEPARATOR_LINE_BREAK = "\n";
+    public const ITEMS_SEPARATOR_DOUBLE_LINE_BREAK = "\n\n";
+
+    public const NUMBERING_SEPARATOR_NO_SPACE = "";
+    public const NUMBERING_SEPARATOR_SPACE = " ";
+    public const NUMBERING_SEPARATOR_DOUBLE_SPACE = "  ";
+    public const NUMBERING_SEPARATOR_DOT = ".";
+    public const NUMBERING_SEPARATOR_DOT_PLUS_SPACE = ". ";
+    public const NUMBERING_SEPARATOR_DOT_PLUS_DOUBLE_SPACE = ".  ";
+    public const NUMBERING_SEPARATOR_BRACKET = ")";
+    public const NUMBERING_SEPARATOR_BRACKET_PLUS_SPACE = ") ";
+    public const NUMBERING_SEPARATOR_BRACKET_PLUS_DOUBLE_SPACE = ")  ";
 
     /** @var string */
     protected $menu;
@@ -34,10 +34,10 @@ public function __construct($menu = '')
     protected function numberingFor(int $index, string $numbering): string
     {
         if ($numbering === self::NUMBERING_ALPHABETIC_LOWER) {
-            return range('a','z')[$index];
+            return range('a', 'z')[$index];
         }
         if ($numbering === self::NUMBERING_ALPHABETIC_UPPER) {
-            return range('A','Z')[$index];
+            return range('A', 'Z')[$index];
         }
         if ($numbering === self::NUMBERING_NUMERIC) {
             return (string) $index + 1;
@@ -63,8 +63,8 @@ protected function pageLimit(int $page, int $numberPerPage, array $items): int
     {
         return (
             $this->isLastPage($page, $numberPerPage, $items)
-            ? count($items) - $this->pageStartIndex($page, $numberPerPage)
-            : $numberPerPage
+                ? count($items) - $this->pageStartIndex($page, $numberPerPage)
+                : $numberPerPage
         );
     }
 
@@ -75,7 +75,7 @@ private function listParser(
         string $numberingSeparator,
         string $itemsSeparator,
         string $numbering
-        ): void {
+    ): void {
         $startIndex = $this->pageStartIndex($page, $numberPerPage);
         $limit = $this->pageLimit($page, $numberPerPage, $items);
         for ($i = 0; $i < $limit; $i++) {

src/Record.php

@@ -52,7 +52,9 @@ protected function getDefault($default)
     protected function getKeys($keys)
     {
         return array_map(
-            function ($key) { return $this->getKey($key); },
+            function ($key) {
+                return $this->getKey($key);
+            },
             $keys
         );
     }
@@ -64,19 +66,19 @@ function ($key) { return $this->getKey($key); },
     protected function getValues($values)
     {
         $newValues = array();
-        foreach($values as $key => $value) {
+        foreach ($values as $key => $value) {
             $newValues[$this->getKey($key)] = $value;
         }
 
         return $newValues;
     }
 
-     /**
-     * Determine if an item exists in the cache.
-     *
-     * @param  string  $key
-     * @return bool
-     */
+    /**
+    * Determine if an item exists in the cache.
+    *
+    * @param  string  $key
+    * @return bool
+    */
     public function has($key)
     {
         return $this->cache->has($this->getKey($key));

src/State.php

@@ -5,10 +5,10 @@
 abstract class State
 {
     /** @var int */
-    const INPUT = 'input';
+    public const INPUT = 'input';
 
     /** @var int */
-    const PROMPT = 'prompt';
+    public const PROMPT = 'prompt';
 
     /** @var string */
     protected $action = self::INPUT;
@@ -25,11 +25,11 @@ abstract class State
     /**
      * The function to run before the rendering
      */
-    protected abstract function beforeRendering(): void;
+    abstract protected function beforeRendering(): void;
 
     /**
      * The view to be displayed to users
-     * 
+     *
      * @return string
      */
     public function render(): string
@@ -41,10 +41,10 @@ public function render(): string
 
     /**
      * The function to run after the rendering
-     * 
+     *
      * @param string $argument
      */
-    protected abstract function afterRendering(string $argument): void;
+    abstract protected function afterRendering(string $argument): void;
 
     /**
      * The new State full path

src/Ussd.php

@@ -25,4 +25,4 @@ public function machine()
     {
         return new Machine();
     }
-}
+}

src/UssdServiceProvider.php

@@ -15,11 +15,6 @@ class UssdServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        // $this->loadTranslationsFrom(__DIR__.'/../resources/lang', 'sparors');
-        // $this->loadViewsFrom(__DIR__.'/../resources/views', 'sparors');
-        // $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
-        // $this->loadRoutesFrom(__DIR__.'/routes.php');
-
         // Publishing is only necessary when using the CLI.
         if ($this->app->runningInConsole()) {
             $this->bootForConsole();
@@ -50,7 +45,7 @@ public function provides()
     {
         return ['ussd'];
     }
-    
+
     /**
      * Console-specific booting.
      *
@@ -63,21 +58,6 @@ protected function bootForConsole()
             __DIR__.'/../config/ussd.php' => config_path('ussd.php'),
         ], 'ussd-config');
 
-        // Publishing the views.
-        /*$this->publishes([
-            __DIR__.'/../resources/views' => base_path('resources/views/vendor/sparors'),
-        ], 'ussd.views');*/
-
-        // Publishing assets.
-        /*$this->publishes([
-            __DIR__.'/../resources/assets' => public_path('vendor/sparors'),
-        ], 'ussd.views');*/
-
-        // Publishing the translation files.
-        /*$this->publishes([
-            __DIR__.'/../resources/lang' => resource_path('lang/vendor/sparors'),
-        ], 'ussd.views');*/
-
         // Registering package commands.
         $this->commands([
             StateCommand::class,