Merge pull request #13 from Saritasa/feature/code-optimization

Improve inside logic of repository

Author: populov

CHANGES.md

@@ -1,5 +1,16 @@
 # Changes History
 
+3.3.0
+------
++ Count method now can receive fieldValues array to filter results
++ Repository methods create/save/delete/ now can throw an exception if given model type don't match with served
+model by repository
++ Repository findOrFail method now checks compliance types of given value and served model primary key.
++ getPage and getCursorPage methods now use nested queries functionality as well as findWhere/getWhere/getWith
++ Method getWithBuilder marked as deprecated
++ Increased unit tests coverage
++ Fixed small description issues
+
 3.2.1
 ------
 + Methods getWith/findWhere/getWhere call when as value uses Carbon\Carbon instance and as key field name, now not throws BadCriteriaException.

composer.json

@@ -19,7 +19,8 @@
     "require-dev": {
         "mockery/mockery": "^1.1",
         "phpunit/phpunit": "^7.5",
-        "squizlabs/php_codesniffer": "^3.0"
+        "squizlabs/php_codesniffer": "^3.0",
+        "slevomat/coding-standard": "^5.0"
     },
     "prefer-stable" : true,
     "minimum-stability": "alpha",

phpcs.xml

@@ -3,6 +3,7 @@
     <description>The coding standard for laravel package</description>
 
     <file>src</file>
+    <file>tests</file>
 
     <exclude-pattern>*.json</exclude-pattern>
     <exclude-pattern>*.xml</exclude-pattern>
@@ -25,13 +26,52 @@
     <rule ref="Generic.CodeAnalysis.JumbledIncrementer" />
     <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement" />
     <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier" />
-    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter">
-        <exclude-pattern>src/Scopes/SortByName.php</exclude-pattern>
-    </rule>
+    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter"/>
     <rule ref="Generic.CodeAnalysis.UselessOverridingMethod" />
     <rule ref="Generic.Commenting.Fixme" />
     <rule ref="Generic.Commenting.Todo" />
     <rule ref="Generic.ControlStructures.InlineControlStructure" />
+
+    <!-- Slevomat additioanl rules -->
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowEqualOperatorsSniff.php"/>
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/TrailingArrayCommaSniff.php"/>
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseDeclarationSniff.php"/>
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseSpacingSniff.php">
+        <properties>
+            <property name="linesCountBeforeFirstUse" value="0"/>
+            <property name="linesCountAfterLastUseWhenLastInClass" value="0"/>
+        </properties>
+    </rule>
+
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DocCommentSpacingSniff.php">
+        <properties>
+            <property name="linesCountBeforeFirstContent" value="0"/>
+            <property name="linesCountBetweenDescriptionAndAnnotations" value="1"/>
+            <property name="linesCountBetweenDifferentAnnotationsTypes" value="1"/>
+            <property name="linesCountAfterLastContent" value="0"/>
+        </properties>
+    </rule>
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/EmptyCommentSniff.php"/>
+    <rule
+            ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithParenthesesSniff.php"/>
+    <rule
+            ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AlphabeticallySortedUsesSniff.php"/>
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/ReferenceUsedNamesOnlySniff.php">
+        <properties>
+            <property name="searchAnnotations" value="1"/>
+        </properties>
+    </rule>
+    <rule ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UnusedUsesSniff.php">
+        <properties>
+            <property name="searchAnnotations" value="1"/>
+        </properties>
+    </rule>
+    <rule
+            ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseDoesNotStartWithBackslashSniff.php"/>
+    <rule
+            ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullableTypeForNullDefaultValueSniff.php"/>
+    <rule
+            ref="vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullTypeHintOnLastPositionSniff.php"/>
 </ruleset>
 
 

src/Contracts/IRepository.php

@@ -5,10 +5,12 @@
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
+use InvalidArgumentException;
 use Saritasa\DingoApi\Paging\CursorRequest;
 use Saritasa\DingoApi\Paging\CursorResult;
 use Saritasa\DingoApi\Paging\PagingInfo;
 use Saritasa\LaravelRepositories\DTO\SortOptions;
+use Saritasa\LaravelRepositories\Exceptions\BadCriteriaException;
 use Saritasa\LaravelRepositories\Exceptions\ModelNotFoundException;
 use Saritasa\LaravelRepositories\Exceptions\RepositoryException;
 
@@ -39,21 +41,26 @@ public function getModelValidationRules(): array;
      * @return Model
      *
      * @throws ModelNotFoundException
+     * @throws RepositoryException
      */
     public function findOrFail($id): Model;
 
     /**
      * Returns first model matching given filters.
      *
      * @param array $fieldValues Filters collection
+     *
      * @return Model|null
+     *
+     * @throws BadCriteriaException
      */
     public function findWhere(array $fieldValues): ?Model;
 
     /**
      * Create model in storage.
      *
      * @param Model $entity Model to create
+     *
      * @return Model
      *
      * @throws RepositoryException
@@ -75,6 +82,7 @@ public function save(Model $entity): Model;
      * Delete model in storage.
      *
      * @param Model $entity Model to delete
+     *
      * @return void
      *
      * @throws RepositoryException
@@ -84,7 +92,7 @@ public function delete(Model $entity): void;
     /**
      * Returns models list.
      *
-     * @return Collection
+     * @return Collection|Model[]
      */
     public function get(): Collection;
 
@@ -93,27 +101,34 @@ public function get(): Collection;
      *
      * @param array $fieldValues Filters collection
      *
-     * @return Collection
+     * @return Collection|Model[]
+     *
+     * @throws BadCriteriaException
      */
     public function getWhere(array $fieldValues): Collection;
 
     /**
      * Get models collection as pagination.
      *
      * @param PagingInfo $paging Paging information
-     * @param array|null $fieldValues Filters collection
+     * @param array $fieldValues Filters collection
      *
      * @return LengthAwarePaginator
+     *
+     * @throws BadCriteriaException
+     * @throws InvalidArgumentException
      */
     public function getPage(PagingInfo $paging, array $fieldValues = []): LengthAwarePaginator;
 
     /**
      * Get models collection as cursor.
      *
      * @param CursorRequest $cursor Request with cursor data
-     * @param array|null $fieldValues Filters collection
+     * @param array $fieldValues Filters collection
      *
      * @return CursorResult
+     *
+     * @throws BadCriteriaException
      */
     public function getCursorPage(CursorRequest $cursor, array $fieldValues = []): CursorResult;
 
@@ -123,29 +138,35 @@ public function getCursorPage(CursorRequest $cursor, array $fieldValues = []): C
      * @param array $with Which relations should be preloaded
      * @param array $withCounts Which related entities should be counted
      * @param array $fieldValues Conditions that retrieved entities should satisfy
-     * @param SortOptions $sortOptions How list of items should be sorted
+     * @param SortOptions|null $sortOptions How list of items should be sorted
      *
-     * @return Collection
+     * @return Collection|Model[]
+     *
+     * @throws BadCriteriaException
      */
     public function getWith(
         array $with,
         array $withCounts = [],
         array $fieldValues = [],
-        SortOptions $sortOptions = null
+        ?SortOptions $sortOptions = null
     ): Collection;
 
     /**
      * Return entities count.
      *
+     * @param array $fieldValues Conditions that retrieved entities should satisfy
+     *
      * @return integer
+     *
+     * @throws BadCriteriaException
      */
-    public function count(): int;
+    public function count(array $fieldValues = []): int;
 
     /**
      * List of fields, allowed to use in the search.
      * Should be determine in the inheritors. Determines the result of the list request of entities.
      *
-     * @return  array
+     * @return array
      */
     public function getSearchableFields(): array;
 }

src/DTO/SortOptions.php

@@ -3,8 +3,8 @@
 namespace Saritasa\LaravelRepositories\DTO;
 
 use Saritasa\Dto;
-use Saritasa\LaravelRepositories\Enums\OrderDirections;
 use Saritasa\Exceptions\InvalidEnumValueException;
+use Saritasa\LaravelRepositories\Enums\OrderDirections;
 
 /**
  * The model contains the sort order direction and the field to sort by.
@@ -14,15 +14,15 @@ class SortOptions extends Dto
     /**
      * Order by attribute name.
      */
-    const ORDER_BY = 'orderBy';
+    public const ORDER_BY = 'orderBy';
 
     /**
      * Sort order attribute name;
      */
-    const SORT_ORDER = 'sortOrder';
+    public const SORT_ORDER = 'sortOrder';
 
     /**
-     * Create SortOptionsData model.
+     * The model contains the sort order direction and the field to sort by.
      *
      * @param string $orderBy Field name to sort records by
      * @param string $sortOrder Sort order direction (asc, desc)
@@ -48,6 +48,7 @@ public function __construct(string $orderBy, string $sortOrder = OrderDirections
      * Sort order direction.
      *
      * @see OrderDirections
+     *
      * @var string
      */
     public $sortOrder;

src/Exceptions/RepositoryRegisterException.php

@@ -9,5 +9,4 @@
  */
 class RepositoryRegisterException extends Exception
 {
-
 }

src/LaravelRepositoriesServiceProvider.php

@@ -2,9 +2,10 @@
 
 namespace Saritasa\LaravelRepositories;
 
+use Illuminate\Contracts\Container\BindingResolutionException;
 use Illuminate\Support\ServiceProvider;
-use Saritasa\LaravelRepositories\Repositories\RepositoryFactory;
 use Saritasa\LaravelRepositories\Contracts\IRepositoryFactory;
+use Saritasa\LaravelRepositories\Repositories\RepositoryFactory;
 
 /**
  * Package providers. Registers package implementation in DI container.
@@ -26,6 +27,8 @@ public function register(): void
      * Make package settings needed to correct work.
      *
      * @return void
+     *
+     * @throws BindingResolutionException
      */
     public function boot(): void
     {
@@ -45,6 +48,8 @@ public function boot(): void
      * Register custom repositories implementations.
      *
      * @return void
+     *
+     * @throws BindingResolutionException
      */
     protected function registerCustomBindings(): void
     {

src/Repositories/CachingRepository.php

@@ -7,13 +7,14 @@
 use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
+use Psr\SimpleCache\InvalidArgumentException;
 use Saritasa\DingoApi\Paging\CursorRequest;
 use Saritasa\DingoApi\Paging\CursorResult;
 use Saritasa\DingoApi\Paging\PagingInfo;
+use Saritasa\LaravelRepositories\Contracts\IRepository;
 use Saritasa\LaravelRepositories\DTO\SortOptions;
 use Saritasa\LaravelRepositories\Exceptions\ModelNotFoundException;
 use Saritasa\LaravelRepositories\Exceptions\RepositoryException;
-use Saritasa\LaravelRepositories\Contracts\IRepository;
 
 /**
  * Wrapper for repositories to store data into cache.
@@ -194,6 +195,8 @@ public function getCursorPage(CursorRequest $cursor, array $fieldValues = []): C
      * @param string|int id Id to find
      *
      * @return Model|null
+     *
+     * @throws RepositoryException
      */
     private function find($id): ?Model
     {
@@ -224,6 +227,8 @@ protected function cachedFind($id): ?Model
      * @param Model $model Model to invalidate
      *
      * @return void
+     *
+     * @throws InvalidArgumentException
      */
     protected function invalidate(Model $model): void
     {
@@ -296,11 +301,11 @@ public function getWith(
     /**
      * {@inheritdoc}
      */
-    public function count(): int
+    public function count(array $fieldValues = []): int
     {
         $key = $this->prefix . ":all:count";
-        return $this->cached($key, function () {
-            return $this->repository->count();
+        return $this->cached($key, function () use ($fieldValues) {
+            return $this->repository->count($fieldValues);
         });
     }