Merge pull request #10 from karam-mustafa/main

Add Ableities to get features from getters

Author: zainaldeen

.php-cs-fixer.cache

@@ -1 +1 @@
-{"php":"8.1.3","version":"3.7.0","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"braces":{"allow_single_line_anonymous_class_with_empty_body":true},"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"class_attributes_separation":{"elements":{"method":"one"}}},"hashes":{"src\/Abstracts\/RelationalRelationAbstract.php":3099487083,"src\/Classes\/RelationalMetrics.php":3843364039,"src\/Interfaces\/RelationalInterface.php":1128215520,"tests\/Unit\/ExampleTest.php":3900274864,"tests\/BaseTest.php":3538535820,"tests\/Feature\/ExampleTest.php":3639981892}}
+{"php":"8.1.3","version":"3.7.0","indent":"    ","lineEnding":"\n","rules":{"blank_line_after_opening_tag":true,"braces":{"allow_single_line_anonymous_class_with_empty_body":true},"class_definition":{"inline_constructor_arguments":false,"space_before_parenthesis":true},"compact_nullable_typehint":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"visibility_required":true,"blank_line_after_namespace":true,"constant_case":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"on_multiline":"ensure_fully_multiline","keep_multiple_spaces_after_comma":true},"no_break_comment":true,"no_closing_tag":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":{"elements":["property"]},"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"array_syntax":{"syntax":"short"},"no_unused_imports":true,"not_operator_with_successor_space":true,"trailing_comma_in_multiline":true,"phpdoc_scalar":true,"unary_operator_spaces":true,"binary_operator_spaces":true,"blank_line_before_statement":{"statements":["break","continue","declare","return","throw","try"]},"phpdoc_single_line_var_spacing":true,"phpdoc_var_without_name":true,"class_attributes_separation":{"elements":{"method":"one"}}},"hashes":{"src\/Abstracts\/RelationalRelationAbstract.php":3299928560,"src\/Classes\/RelationalMetrics.php":842680276,"src\/Interfaces\/RelationalInterface.php":1128215520,"tests\/Unit\/ExampleTest.php":3900274864,"tests\/BaseTest.php":3538535820,"tests\/Feature\/ExampleTest.php":3639981892}}

README.md

@@ -25,7 +25,12 @@ The Basic Usage of this package is the same of getting count of some model insta
 ```php
         $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
         // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
+        // or you can specify thr model name by this way:  new RelationalMetrics(Store::class);
         $metrics = $instance->getBasicMetrics();
+        // or you can get the count or the message directly.
+        $directCount = $instance->getCount(); 
+        $directName = $instance->getName(); 
+
         /*
 	  *     Response will be like:
 	  *	[
@@ -42,6 +47,7 @@ Let's assume we want to get the number of stores that has products with price mo
 ```php
         $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
         // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
+        // or you can specify thr model name by this way:  new RelationalMetrics(Store::class);
         $metrics = $instance->getRelationalMetrics($relationName, $relationColumn, $value);
         // example: $instance->getRelationalMetrics('products, 'price', 500);
         /*
@@ -62,7 +68,7 @@ And last but not least, You could get the metrics about a model depending on any
 ```php
         $instance = (new \SOS\RelationalMetrics\Classes\RelationalMetrics("ModelName")); 
         // example: (new \SOS\RelationalMetrics\Classes\RelationalMetrics("Store"));
-        
+        // or you can specify thr model name by this way:  new RelationalMetrics(Store::class);
         // example for the conditions
         $conditions = [
                   ['method' => 'where', 'column' => 'address', 'operator' => 'like', 'value' => '%UAE%'],

src/Abstracts/RelationalRelationAbstract.php

@@ -2,10 +2,87 @@
 
 namespace SOS\RelationalMetrics\Abstracts;
 
+/**
+ * Class RelationalRelationAbstract
+ *
+ * @author karam mustafa
+ * @package SOS\RelationalMetrics\Abstracts
+ */
 abstract class RelationalRelationAbstract
 {
+    /**
+     * model to handle
+     * @author karam mustafa
+     * @var string
+     */
     protected $model = '';
 
+    /**
+     * count of rows
+     * @author karam mustafa
+     * @var string
+     */
+    private $count = null;
+
+    /**
+     * message for a count
+     * @author karam mustafa
+     * @var string
+     */
+    private $name = '';
+
+    /**
+     * @return string
+     * @author karam mustafa
+     */
+    public function getCount()
+    {
+        if (is_null($this->count)) {
+            $this->getCountDirectly();
+        }
+
+        return $this->count;
+    }
+
+    /**
+     * @param  string  $count
+     *
+     * @return RelationalRelationAbstract
+     * @author karam mustafa
+     */
+    public function setCount($count)
+    {
+        $this->count = $count;
+
+        return $this;
+    }
+
+    /**
+     * @return string
+     * @author karam mustafa
+     */
+    public function getName()
+    {
+        if (is_null($this->name)) {
+            $this->name = $this->getResponseName();
+        }
+
+        return $this->name;
+    }
+
+    /**
+     * @param  string  $name
+     *
+     * @return RelationalRelationAbstract
+     * @author karam mustafa
+     */
+    public function setName($name)
+    {
+        $this->name = $name;
+
+        return $this;
+    }
+
     /**
      *  return count for the model's relation depending on the relation type (where, when ... etc), column and value
      *
@@ -56,9 +133,19 @@ protected function getCountWithConditions(array $conditions): int
      */
     protected function getCountDirectly()
     {
-        return $this->model::query()->get()->count();
+        $this->count = $this->model::query()->get()->count();
+
+        return $this->count;
     }
 
+    /**
+     * append final values to their properties
+     *
+     * @param $model_count
+     *
+     * @return array
+     * @author karam mustafa
+     */
     protected function returnFinalResponse($model_count): array
     {
         return  [
@@ -67,6 +154,12 @@ protected function returnFinalResponse($model_count): array
         ];
     }
 
+    /**
+     * description
+     *
+     * @return string
+     * @author karam mustafa
+     */
     protected function getResponseName()
     {
         $path = explode('\\', $this->model);

src/Classes/RelationalMetrics.php

@@ -2,6 +2,7 @@
 
 namespace SOS\RelationalMetrics\Classes;
 
+use Illuminate\Database\Eloquent\Model;
 use SOS\RelationalMetrics\Abstracts\RelationalRelationAbstract;
 use SOS\RelationalMetrics\Interfaces\RelationalInterface;
 
@@ -14,60 +15,83 @@
 class RelationalMetrics extends RelationalRelationAbstract implements RelationalInterface
 {
     /**
-     * description
+     * class constructor
      *
+     * @throws \Exception
      * @author zainaldeen
      * @var string
      */
-    public function __construct(string $target)
+    public function __construct(string $class)
     {
-        if (class_exists('App\\Models\\'.$target)) {
-            $this->model = "App\\Models\\" . $target;
-        } else {
-            return "Target Model ". $target. " Is Not Found!";
-        }
+        $className = $this->validateClass($class);
+
+        $this->model = $className;
     }
 
     /**
      * return simple count for the model
      *
-     * @author zainaldeen
      * @return  array
+     * @author zainaldeen
      */
     public function getBasicMetrics()
     {
-        $model_count = $this->getCountDirectly();
-
-        return $this->returnFinalResponse($model_count);
+        return $this->returnFinalResponse(
+            $this->getCountDirectly()
+        );
     }
 
     /**
      * return count for the model's relation depending on the relation type (where, when ... etc), column and value
      *
-     * @author zainaldeen
-     * @param string $relation
-     * @param string $column
-     * @param mixed $value
+     * @param  string  $relation
+     * @param  string  $column
+     * @param  mixed  $value
+     *
      * @return  array
+     * @author zainaldeen
      */
     public function getRelationalMetrics($relation, $column, $value)
     {
-        $model_count = $this->returnRelationalCount($relation, $column, $value);
-
-        return $this->returnFinalResponse($model_count);
+        return $this->returnFinalResponse(
+            $this->returnRelationalCount($relation, $column, $value)
+        );
     }
 
     /**
      * return count for the model depending on the passing conditions
      *
-     * @author zainaldeen
-     * @param array $conditions
+     * @param  array  $conditions
+     *
      * @return  array
+     * @author zainaldeen
      */
     public function getConditionalMetrics($conditions)
     {
-        $model_count = $this->getCountWithConditions($conditions);
+        return $this->returnFinalResponse(
+            $this->getCountWithConditions($conditions)
+        );
+    }
+
+    /**
+     * check if user insert a correct class name, otherwise we will ty to resolve the model class name
+     *
+     * @param  string  $class
+     *
+     * @return \SOS\RelationalMetrics\Classes\string|string
+     * @throws \Exception
+     * @author karam mustafa
+     */
+    private function validateClass(string $class)
+    {
+        $fixedClassName = str_contains("App\\Models", $class)
+            ? $class
+            : "\\App\\Models\\$class";
+
+        if (! class_exists($fixedClassName) && $fixedClassName instanceof Model) {
+            throw new \Exception("model $class not found !!");
+        }
 
-        return $this->returnFinalResponse($model_count);
+        return $fixedClassName;
     }
 }