Merge pull request #23 from farshadth/refactor

mbpcoder · web-flow · commit 8d70447adff8 · 2023-07-15T16:16:22.000+03:30
refactor
diff --git a/Readme.md b/Readme.md
@@ -49,6 +49,7 @@ List of artisan commands:
 - `-a|--all-tables`: Use all existing tables.
 - `--table_names=`: Add table names, separate names with comma.
 - `--selected_db=` : Use between `Mysql`,`Redis`, If it does not send, the value will return from `config/repository.php`
+- `--strategy_name=` : add a trait to your redis repository based on the strategy you choose
 
 Example 1. Create new Entity for a table named 'users'.
 ```bash
@@ -64,3 +65,12 @@ Example 3. Create all necessary classes for all tables with enabled foreign key
 ```bash
 php artisan repository:make-all -a -k
 ```
+
+## Strategy
+List of strategies for redis repository
+
+`ClearableTemporaryCacheStrategy` `QueryCacheStrategy` `SingleKeyCacheStrategy` `TemporaryCacheStrategy`
+
+```bash
+php artisan repository:make-all --table_names=users --strategy_name=QueryCacheStrategy
+```
diff --git a/src/Commands/MakeEnum.php b/src/Commands/MakeEnum.php
@@ -39,9 +39,8 @@ public function handle(): void
         $enums = [];
         foreach ($columns as $_column) {
             if ($_column->DATA_TYPE == 'enum') {
-                $enumClassName = Str::studly(Str::singular(ucfirst(Str::camel($_column->TABLE_NAME))) . '_' . $_column->COLUMN_NAME);
-                $enums[$enumClassName] = explode(',', str_replace(['enum(', '\'', ')'], ['', '', ''], $_column->COLUMN_TYPE));
-
+                $enumClassName = Str::studly(Str::singular(ucfirst(Str::camel($_column->TABLE_NAME))) . '_' . $_column->COLUMN_NAME)."Enum";
+                $enums[$enumClassName] = array_filter(explode(',', str_replace(['enum(', '\'', ')'], ['', '', ''], $_column->COLUMN_TYPE)));
                 $filenameWithPath = $this->relativeEnumsPath . $enumClassName.'.php';
                 $this->checkDelete($filenameWithPath,$enumClassName,"Enum");
             }
diff --git a/src/Creators/BaseCreator.php b/src/Creators/BaseCreator.php
@@ -10,9 +10,12 @@
 
 class BaseCreator extends BaseCommand
 {
+    const ENUM_TYPE = 'enum';
+    const CLASS_TYPE = 'class';
+    const ALL_OPTIONS = ['Current','New','Always keep current','Always replace with new'];
+
     private $creator;
     private null|string $choice=null;
-    const ALL_OPTIONS = ['Current','New','Always keep current','Always replace with new'];
 
     public function __construct(IClassCreator $creator)
     {
@@ -31,11 +34,13 @@ public function createClass(string $filenameWithPath,BaseCommand $command):strin
         $specificPattern = '/(public|protected|private) [^\s]* \$*(?<name>[^\s;\=]*)\s*[^;]*;/is';
         $attributesArray = $this->checkDiffrence($filenameWithPath,$attributesArray,$command,$specificPattern,$generalPattern);
 
-        $attributes = implode('    ',$attributesArray);
+        $attributes = trim(implode("\n\t",$attributesArray));
+        $attributes = (!empty($functionsArray)) ? $attributes."\n" : $attributes;
         $functions = implode('    ',$functionsArray);
         $uses = implode(PHP_EOL,$usesArray);
 
-        $basePath = __DIR__ . '/../../stubs/base.class.stub' ;
+        $type = (isset($this->creator->enum)) ? self::ENUM_TYPE : self::CLASS_TYPE;
+        $basePath = __DIR__ . "/../../stubs/base.$type.stub" ;
         $this->creator->baseContent = str_replace(['{{ Namespace }}', '{{ UseSection }}', '{{ ClassName }}', '{{ ExtendSection }}', '{{ Parameters }}', '{{ Functions }}'],
             [
                 $this->creator->getNameSpace(),
diff --git a/src/Creators/CreatorEntity.php b/src/Creators/CreatorEntity.php
@@ -8,8 +8,11 @@
 class CreatorEntity implements IClassCreator
 {
     use CustomMySqlQueries;
+
     protected const PARENT_NAME = 'Entity';
 
+    private const BOOL_TYPE = 'bool';
+
     public function __construct(
         public Collection $columns,
         public string $detectForeignKeys,
@@ -32,13 +35,19 @@ public function createAttributs():array{
         $detectForeignKeys = $this->detectForeignKeys;
         $tableName = $this->tableName;
         $attributes = [];
+
         foreach ($columns as $_column) {
+            $dataType = $this->getDataType($_column->COLUMN_TYPE, $_column->DATA_TYPE);
             $defaultValue = ($_column->COLUMN_DEFAULT ?? 'null') ? ($_column->COLUMN_DEFAULT ?? 'null') : "''";
+
+            $defaultValue = ($dataType == self::BOOL_TYPE) ? ((in_array($defaultValue, [0, '', "''"])) ? 'false' :
+                ((in_array($defaultValue, [1, '1'])) ? 'true' : $defaultValue)) : $defaultValue;
+
             $attributes[$_column->COLUMN_NAME] =
                 $this->writeAttribute(
                     $entityStubsPath,
-                    $_column->COLUMN_NAME.($_column->IS_NULLABLE === 'YES' ? ' = '.$defaultValue : ''),
-                    ($_column->IS_NULLABLE === 'YES' ? 'null|' : '') . $this->dataTypes[$_column->DATA_TYPE]
+                    $_column->COLUMN_NAME.(!in_array($_column->COLUMN_DEFAULT, [null, 'NULL']) ? ' = '.$defaultValue : ''),
+                    ($_column->IS_NULLABLE === 'YES' ? 'null|' : '') . $dataType
                 );
         }
 
@@ -73,18 +82,20 @@ public function createFunctions():array
         $tableName = $this->tableName;
         $settersAndGetters = [];
         foreach ($columns as $_column) {
+            $dataType = $this->getDataType($_column->COLUMN_TYPE, $_column->DATA_TYPE);
+
             $settersAndGetters['get'.ucwords($_column->COLUMN_NAME)] =
                 $this->writeAccessors(
                     $entityStubsPath,
                     $_column->COLUMN_NAME,
-                    ($_column->IS_NULLABLE === 'YES' ? 'null|' : '') . $this->dataTypes[$_column->DATA_TYPE],
+                    ($_column->IS_NULLABLE === 'YES' ? 'null|' : '') . $dataType,
                     'getter'
                 );
             $settersAndGetters['set'.ucwords($_column->COLUMN_NAME)] =
                 $this->writeAccessors(
                     $entityStubsPath,
                     $_column->COLUMN_NAME,
-                    ($_column->IS_NULLABLE === 'YES' ? 'null|' : '') . $this->dataTypes[$_column->DATA_TYPE],
+                    ($_column->IS_NULLABLE === 'YES' ? 'null|' : '') . $dataType,
                     'setter'
                 );
 
@@ -94,14 +105,14 @@ public function createFunctions():array
 
             // Create Additional Setters and Getters from Foreign keys
             foreach ($foreignKeys as $_foreignKey) {
-                $settersAndGetters['get'.ucwords($_column->COLUMN_NAME)] =
+                $settersAndGetters['get'.ucwords($_foreignKey->COLUMN_NAME)] =
                     $this->writeAccessors(
                         $entityStubsPath,
                         $_foreignKey->VARIABLE_NAME,
                         $_foreignKey->ENTITY_DATA_TYPE,
                         'getter'
                     );
-                $settersAndGetters['set'.ucwords($_column->COLUMN_NAME)] =
+                $settersAndGetters['set'.ucwords($_foreignKey->COLUMN_NAME)] =
                         $this->writeAccessors(
                             $entityStubsPath,
                             $_foreignKey->VARIABLE_NAME,
@@ -115,7 +126,6 @@ public function createFunctions():array
 
     private function writeAttribute(string $entityStubsPath, string $attributeName, string $attributeType): string
     {
-
         $attributeStub = file_get_contents($entityStubsPath.'attribute.stub');
         return str_replace(['{{ AttributeType }}', '{{ AttributeName }}'],
             [$attributeType, $attributeName],
diff --git a/src/Creators/CreatorEnum.php b/src/Creators/CreatorEnum.php
@@ -38,12 +38,12 @@ public function createFunctions(): array
 
     public function createUses(): array
     {
-        return ['use Nanvaie\DatabaseRepository\Models\Enums\Enum;'];
+        return [];
     }
 
     public function getExtendSection(): string
     {
-        return 'extends Enum';
+        return '';
     }
 
     public function getNameSpace(): string
diff --git a/src/CustomMySqlQueries.php b/src/CustomMySqlQueries.php
@@ -41,6 +41,10 @@ trait CustomMySqlQueries
         'point' => 'string',
     ];
 
+    protected $columnTypes = [
+        'tinyint(1)' => 'bool'
+    ];
+
     /**
      * Extract all columns from a given table.
      */
@@ -100,4 +104,13 @@ public function extractIndexes(string $tableName): Collection
 
         return $indexes;
     }
+
+    public function getDataType(string $columnType, string $dataType): string
+    {
+        if(array_key_exists($columnType, $this->columnTypes)) {
+            return $this->columnTypes[$columnType];
+        }
+
+        return $this->dataTypes[$dataType];
+    }
 }
diff --git a/stubs/Repositories/Redis/getAllBy/base.clearable_temporary_cache_strategy.stub b/stubs/Repositories/Redis/getAllBy/base.clearable_temporary_cache_strategy.stub
@@ -1,11 +1,11 @@
 $cacheKey = $this->redisRepository->makeKey([
-     'function_name' => 'getOneByIds',
+     'function_name' => 'getAllByIds',
       'id' => $ids,
 ]);
 
  $data= $this->redisRepository->get($cacheKey);
  if (is_null($data)) {
       $data = $this->repository
-       ->getOneByIds($ids);
+       ->getAllByIds($ids);
         $this->redisRepository->put($cacheKey, $data, Time::HALF_HOUR_BY_SECOND);
   }
diff --git a/stubs/Repositories/Redis/getAllBy/base.query_cache_strategy.stub b/stubs/Repositories/Redis/getAllBy/base.query_cache_strategy.stub
@@ -1,5 +1,5 @@
 $cacheKey = $this->redisRepository->makeKey([
-            'function_name' => 'getOneByIds',
+            'function_name' => 'getAllByIds',
             'id' => $ids,
         ]);
 
@@ -9,7 +9,7 @@ $cacheKey = $this->redisRepository->makeKey([
 
 
         if (is_null($entity)) {
-            $entity = $this->repository->getOneByIds($ids);
+            $entity = $this->repository->getAllByIds($ids);
             $this->redisRepository->put($cacheKey, $entity);
         }
 
diff --git a/stubs/Repositories/Redis/getAllBy/base.single_key_cache_strategy.stub b/stubs/Repositories/Redis/getAllBy/base.single_key_cache_strategy.stub
@@ -1,6 +1,6 @@
 
         $entity = $this->redisRepository->get();
         if (is_null($entity)) {
-            $entity = $this->repository->getOneByIds($id);
+            $entity = $this->repository->getAllByIds($id);
             $this->redisRepository->put($entity);
         }
diff --git a/stubs/Repositories/Redis/getAllBy/base.temporary_cache_strategy.stub b/stubs/Repositories/Redis/getAllBy/base.temporary_cache_strategy.stub
@@ -1,11 +1,11 @@
 $cacheKey = $this->redisRepository->makeKey([
-     'function_name' => 'getOneByIds',
+     'function_name' => 'getAllByIds',
       'id' => $ids,
 ]);
 
  $data= $this->redisRepository->get($cacheKey);
  if (is_null($data)) {
       $data = $this->repository
-       ->getOneByIds($ids);
+       ->getAllByIds($ids);
         $this->redisRepository->put($cacheKey, $data, Time::HALF_HOUR_BY_SECOND);
   }
diff --git a/stubs/base.enum.stub b/stubs/base.enum.stub
@@ -0,0 +1,8 @@
+<?php
+
+namespace {{ Namespace }};
+
+enum {{ ClassName }}
+{
+    {{ Parameters }}
+}

Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,12 @@ public function createFunctions(): array`
`38`	`38`
`39`	`39`	`public function createUses(): array`
`40`	`40`	`{`
`41`		`- return ['use Nanvaie\DatabaseRepository\Models\Enums\Enum;'];`
	`41`	`+ return [];`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`public function getExtendSection(): string`
`45`	`45`	`{`
`46`		`- return 'extends Enum';`
	`46`	`+ return '';`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`public function getNameSpace(): string`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`
`2`	`2`	`$entity = $this->redisRepository->get();`
`3`	`3`	`if (is_null($entity)) {`
`4`		`- $entity = $this->repository->getOneByIds($id);`
	`4`	`+ $entity = $this->repository->getAllByIds($id);`
`5`	`5`	`$this->redisRepository->put($entity);`
`6`	`6`	`}`