changed base param class to interface

Author: mtrajano

src/Generator.php

@@ -101,7 +101,7 @@ protected function addActionParameters()
     {
         $rules = $this->getFormRules() ?: [];
 
-        $parameters = (new Parameters\PathParameterGenerator($this->method, $this->originalUri, $rules))->getParameters();
+        $parameters = (new Parameters\PathParameterGenerator($this->originalUri))->getParameters();
 
         if (!empty($rules)) {
             $parameterGenerator = $this->getParameterGenerator($rules);
@@ -137,9 +137,9 @@ protected function getParameterGenerator($rules)
             case 'post':
             case 'put':
             case 'patch':
-                return new Parameters\BodyParameterGenerator($this->method, $this->originalUri, $rules);
+                return new Parameters\BodyParameterGenerator($rules);
             default:
-                return new Parameters\QueryParameterGenerator($this->method, $this->originalUri, $rules);
+                return new Parameters\QueryParameterGenerator($rules);
         }
     }
 }

src/Parameters/BodyParameterGenerator.php

@@ -2,8 +2,17 @@
 
 namespace Mtrajano\LaravelSwagger\Parameters;
 
-class BodyParameterGenerator extends ParameterGenerator
+class BodyParameterGenerator implements ParameterGenerator
 {
+    use Concerns\GeneratesFromRules;
+
+    protected $rules;
+
+    public function __construct($rules)
+    {
+        $this->rules = $rules;
+    }
+
     public function getParameters()
     {
         $required = [];

src/Parameters/Concerns/GeneratesFromRules.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace Mtrajano\LaravelSwagger\Parameters\Concerns;
+
+trait GeneratesFromRules
+{
+    protected function splitRules($rules)
+    {
+        if (is_string($rules)) {
+            return explode('|', $rules);
+        } else {
+            return $rules;
+        }
+    }
+
+    protected function getParamType(array $paramRules)
+    {
+        if (in_array('integer', $paramRules)) {
+            return 'integer';
+        } else if (in_array('numeric', $paramRules)) {
+            return 'number';
+        } else if (in_array('boolean', $paramRules)) {
+            return 'boolean';
+        } else if (in_array('array', $paramRules)) {
+            return 'array';
+        } else {
+            //date, ip, email, etc..
+            return 'string';
+        }
+    }
+
+    protected function isParamRequired(array $paramRules)
+    {
+        return in_array('required', $paramRules);
+    }
+
+    protected function getEnumValues(array $paramRules)
+    {
+        $in = $this->getInParameter($paramRules);
+
+        if (!$in) {
+            return [];
+        }
+
+        list($param, $vals) = explode(':', $in);
+
+        return explode(',', $vals);
+    }
+
+    private function getInParameter(array $paramRules)
+    {
+        foreach ($paramRules as $rule) {
+            if (starts_with($rule, 'in:')) {
+                return $rule;
+            }
+        }
+
+        return false;
+    }
+}

src/Parameters/ParameterGenerator.php

@@ -2,76 +2,9 @@
 
 namespace Mtrajano\LaravelSwagger\Parameters;
 
-abstract class ParameterGenerator
+interface ParameterGenerator
 {
-    protected $method;
+    public function getParameters();
 
-    protected $uri;
-
-    protected $rules;
-
-    public function __construct($method, $uri, array $rules)
-    {
-        $this->method = $method;
-        $this->uri = $uri;
-        $this->rules = $rules;
-    }
-
-    abstract public function getParameters();
-
-    abstract public function getParamLocation();
-
-    protected function getParamType(array $paramRules)
-    {
-        if (in_array('integer', $paramRules)) {
-            return 'integer';
-        } else if (in_array('numeric', $paramRules)) {
-            return 'number';
-        } else if (in_array('boolean', $paramRules)) {
-            return 'boolean';
-        } else if (in_array('array', $paramRules)) {
-            return 'array';
-        } else {
-            //date, ip, email, etc..
-            return 'string';
-        }
-    }
-
-    protected function isParamRequired(array $paramRules)
-    {
-        return in_array('required', $paramRules);
-    }
-
-    protected function splitRules($rules)
-    {
-        if (is_string($rules)) {
-            return explode('|', $rules);
-        } else {
-            return $rules;
-        }
-    }
-
-    protected function getEnumValues(array $paramRules)
-    {
-        $in = $this->getInParameter($paramRules);
-
-        if (!$in) {
-            return [];
-        }
-
-        list($param, $vals) = explode(':', $in);
-
-        return explode(',', $vals);
-    }
-
-    private function getInParameter(array $paramRules)
-    {
-        foreach ($paramRules as $rule) {
-            if (starts_with($rule, 'in:')) {
-                return $rule;
-            }
-        }
-
-        return false;
-    }
+    public function getParamLocation();
 }

src/Parameters/PathParameterGenerator.php

@@ -2,8 +2,15 @@
 
 namespace Mtrajano\LaravelSwagger\Parameters;
 
-class PathParameterGenerator extends ParameterGenerator
+class PathParameterGenerator implements ParameterGenerator
 {
+    protected $uri;
+
+    public function __construct($uri)
+    {
+        $this->uri = $uri;
+    }
+
     public function getParameters()
     {
         $params = [];

src/Parameters/QueryParameterGenerator.php

@@ -2,8 +2,17 @@
 
 namespace Mtrajano\LaravelSwagger\Parameters;
 
-class QueryParameterGenerator extends ParameterGenerator
+class QueryParameterGenerator implements ParameterGenerator
 {
+    use Concerns\GeneratesFromRules;
+
+    protected $rules;
+
+    public function __construct($rules)
+    {
+        $this->rules = $rules;
+    }
+
     public function getParameters()
     {
         $params = [];

tests/Parameters/BodyParameterGeneratorTest.php

@@ -78,7 +78,7 @@ public function testEnumInBody()
 
     private function getBodyParameters(array $rules)
     {
-        $bodyParameters = (new BodyParameterGenerator('post', '/', $rules))->getParameters();
+        $bodyParameters = (new BodyParameterGenerator($rules))->getParameters();
 
         return current($bodyParameters);
     }

tests/Parameters/PathParameterGeneratorTest.php

@@ -51,6 +51,6 @@ public function testEmptyParameters()
 
     private function getPathParameters($uri)
     {
-        return (new PathParameterGenerator('get', $uri, []))->getParameters();
+        return (new PathParameterGenerator($uri))->getParameters();
     }
 }

tests/Parameters/QueryParameterGeneratorTest.php

@@ -81,6 +81,6 @@ public function testEnumRuleObjet()
 
     private function getQueryParameters(array $rules)
     {
-        return (new QueryParameterGenerator('get', '/', $rules))->getParameters();
+        return (new QueryParameterGenerator($rules))->getParameters();
     }
 }