Merge branch 'release/0.4.1'

lindyhopchris · lindyhopchris · commit a27c86471734 · 2016-07-27T10:29:24.000+01:00
Closes cloudcreativity#11
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,23 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [0.4.1] - 2016-07-27
+
+### Added
+
+- Support for find-many requests in the default Eloquent model search implementation.
+- Hooks in `EloquentController` for `creating`, `created`, `updating` and `updated` events. This makes it
+easier for child classes to implement customer logic, e.g. dispatching events, jobs, etc.
+
+### Changed
+
+- Removed dependency between model test helper and Laravel's database test helper, as there was no need for
+this dependency to exist.
+
+### Fixed
+
+- Asserting that a model has been created now correctly checks expected attributes.
+
 ## [0.4.0] - 2016-07-20
 
 This is a substantial refactoring, based on using this package in production environments. We also updated 
diff --git a/src/Http/Controllers/EloquentController.php b/src/Http/Controllers/EloquentController.php
@@ -244,7 +244,47 @@ protected function hydrate(ResourceInterface $resource, Model $model)
      */
     protected function commit(Model $model)
     {
-        return $model->save();
+        $isUpdating = $model->exists;
+
+        $this->beforeCommit($model, $isUpdating);
+
+        $result = $model->save();
+
+        if ($result) {
+            $this->afterCommit($model, $isUpdating);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Determines which callback to use before creating or updating a model.
+     *
+     * @param Model $model
+     * @param bool $isUpdating
+     */
+    protected function beforeCommit(Model $model, $isUpdating)
+    {
+        if ($isUpdating) {
+            $this->updating($model);
+        } else {
+            $this->creating($model);
+        }
+    }
+
+    /**
+     * Determines which callback to use after a model is updated or created.
+     *
+     * @param Model $model
+     * @param bool $isUpdating
+     */
+    protected function afterCommit(Model $model, $isUpdating)
+    {
+        if ($isUpdating) {
+            $this->updated($model);
+        } else {
+            $this->created($model);
+        }
     }
 
     /**
@@ -350,4 +390,48 @@ private function doDestroy(Model $model)
             return $this->destroy($model);
         });
     }
+
+    /**
+     * Called before the model is created.
+     *
+     * Child classes can overload this method if they need to do any logic pre-creation.
+     *
+     * @param Model $model
+     */
+    protected function creating(Model $model)
+    {
+    }
+
+    /**
+     * Called after the model has been created.
+     *
+     * Child classes can overload this method if they need to do any logic post-creation.
+     *
+     * @param Model $model
+     */
+    protected function created(Model $model)
+    {
+    }
+
+    /**
+     * Called before the model is updated.
+     *
+     * Child classes can overload this method if they need to do any logic pre-updating.
+     *
+     * @param Model $model
+     */
+    protected function updating(Model $model)
+    {
+    }
+
+    /**
+     * Called after the model has been updated.
+     *
+     * Child classes can overload this method if they need to do any logic post-updating.
+     *
+     * @param Model $model
+     */
+    protected function updated(Model $model)
+    {
+    }
 }
diff --git a/src/Search/AbstractSearch.php b/src/Search/AbstractSearch.php
@@ -25,6 +25,7 @@
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Collection;
+use Neomerx\JsonApi\Contracts\Document\DocumentInterface;
 use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
 use Neomerx\JsonApi\Contracts\Encoder\Parameters\SortParameterInterface;
 
@@ -61,6 +62,13 @@ abstract class AbstractSearch implements SearchInterface
      */
     protected $simplePagination = false;
 
+    /**
+     * The filter param for a find-many request.
+     *
+     * @var string
+     */
+    protected $findManyFilter = DocumentInterface::KEYWORD_ID;
+
     /**
      * Apply the supplied filters to the builder instance.
      *
@@ -86,13 +94,16 @@ abstract protected function sort(Builder $builder, array $sortBy);
     abstract protected function isSearchOne(Collection $filters);
 
     /**
-     * @param Builder $builder
-     * @param EncodingParametersInterface $parameters
-     * @return Paginator|EloquentCollection
+     * @inheritdoc
      */
     public function search(Builder $builder, EncodingParametersInterface $parameters)
     {
         $filters = new Collection((array) $parameters->getFilteringParameters());
+
+        if ($this->isFindMany($filters)) {
+            return $this->findMany($builder, $filters);
+        }
+
         $this->filter($builder, $filters);
         $this->sort($builder, (array) $parameters->getSortParameters());
 
@@ -103,6 +114,23 @@ public function search(Builder $builder, EncodingParametersInterface $parameters
         return $this->isPaginated() ? $this->paginate($builder) : $this->all($builder);
     }
 
+    /**
+     * @param Collection $filters
+     * @return bool
+     */
+    protected function isFindMany(Collection $filters)
+    {
+        return $filters->has($this->getFindManyKey());
+    }
+
+    /**
+     * @return string
+     */
+    protected function getFindManyKey()
+    {
+        return $this->findManyFilter;
+    }
+
     /**
      * Should the result set be paginated?
      *
@@ -150,6 +178,27 @@ protected function first(Builder $builder)
         return $builder->first();
     }
 
+    /**
+     * @param Builder $builder
+     * @param Collection $filters
+     * @return EloquentCollection
+     */
+    protected function findMany(Builder $builder, Collection $filters)
+    {
+        $ids = $filters->get($this->getFindManyKey());
+
+        return $builder->findMany($this->normalizeIds($ids));
+    }
+
+    /**
+     * @param $ids
+     * @return array
+     */
+    protected function normalizeIds($ids)
+    {
+        return is_array($ids) ? $ids : explode(',', (string) $ids);
+    }
+
     /**
      * @return PageParameterHandlerInterface
      */
diff --git a/src/Testing/InteractsWithModels.php b/src/Testing/InteractsWithModels.php
@@ -24,9 +24,6 @@
 /**
  * Class InteractsWithModels
  * @package CloudCreativity\LaravelJsonApi\Testing
- *
- * This trait MUST be used on a class that also uses this trait:
- * Illuminate\Foundation\Testing\Concerns\InteractsWithDatabase
  */
 trait InteractsWithModels
 {
@@ -36,35 +33,37 @@ trait InteractsWithModels
      *
      * @param Model $model
      *      a representation of the model that should have been created.
-     * @param $expectedId
-     *      the expected id of the model.
+     * @param $expectedResourceId
+     *      the expected resource id of the model.
      * @param string|string[]|null $attributeKeys
      *      the keys of the model attributes that should be checked, or null to check all.
      * @param string|null $keyName
-     *      the key name to use for the id - defaults to `Model::getKeyName()`
+     *      the key name to use for the resource id - defaults to `Model::getKeyName()`
+     * @return $this
      */
-    public function assertModelCreated(
+    protected function assertModelCreated(
         Model $model,
-        $expectedId,
+        $expectedResourceId,
         $attributeKeys = null,
         $keyName = null
     ) {
-        if (!$keyName) {
-            $keyName = $model->getKeyName();
-        }
-
+        $keyName = $keyName ?: $model->getKeyName();
         $attributes = $model->getAttributes();
+        $expected = [$keyName => $expectedResourceId];
 
         if (is_null($attributeKeys)) {
             $attributeKeys = array_keys($attributes);
         }
 
         foreach ((array) $attributeKeys as $attr) {
+            if ($keyName === $attr) {
+                continue;
+            }
+
             $expected[$attr] = isset($attributes[$attr]) ? $attributes[$attr] : null;
         }
 
-        $expected = [$keyName => $expectedId];
-        $this->seeInDatabase($model->getTable(), $expected, $model->getConnectionName());
+        return $this->seeModelInDatabase($model, $expected);
     }
 
     /**
@@ -76,8 +75,9 @@ public function assertModelCreated(
      *      the expected changed attributes - key to value pairs.
      * @param string|string[] $unchangedKeys
      *      the keys of the attributes that should not have changed.
+     * @return $this
      */
-    public function assertModelPatched(Model $model, array $changedAttributes, $unchangedKeys = [])
+    protected function assertModelPatched(Model $model, array $changedAttributes, $unchangedKeys = [])
     {
         /** We need to ensure values are cast to database values */
         $expected = $model->newInstance($changedAttributes)->getAttributes();
@@ -88,29 +88,80 @@ public function assertModelPatched(Model $model, array $changedAttributes, $unch
         }
 
         $expected[$model->getKeyName()] = $model->getKey();
-        $this->seeInDatabase($model->getTable(), $expected, $model->getConnectionName());
+
+        return $this->seeModelInDatabase($model, $expected);
     }
 
     /**
      * Assert that a model was deleted.
      *
      * @param Model $model
+     * @return $this
      */
-    public function assertModelDeleted(Model $model)
+    protected function assertModelDeleted(Model $model)
     {
-        $this->notSeeInDatabase($model->getTable(), [
-            $model->getKeyName() => $model->getKey()
-        ], $model->getConnectionName());
+        return $this->notSeeModelInDatabase($model, [$model->getKeyName() => $model->getKey()]);
     }
 
     /**
      * Assert that a model was soft deleted.
      *
      * @param Model $model
+     * @return $this
      */
-    public function assertModelTrashed(Model $model)
+    protected function assertModelTrashed(Model $model)
     {
         PHPUnit::assertNull($model->fresh(), 'Model is not trashed.');
-        $this->seeInDatabase($model->getTable(), [$model->getKeyName() => $model->getKey()], $model->getConnectionName());
+        return $this->seeModelInDatabase($model, [$model->getKeyName() => $model->getKey()]);
+    }
+
+    /**
+     * @param Model $model
+     * @param array $expected
+     * @return $this
+     */
+    protected function seeModelInDatabase(Model $model, array $expected)
+    {
+        $message = sprintf(
+            'Unable to find model in database table [%s] that matched attributes [%s].',
+            $model->getTable(),
+            json_encode($expected)
+        );
+
+        PHPUnit::assertGreaterThan(0, $this->countModels($model, $expected), $message);
+
+        return $this;
+    }
+
+    /**
+     * @param Model $model
+     * @param array $expected
+     * @return $this
+     */
+    protected function notSeeModelInDatabase(Model $model, array $expected)
+    {
+        $message = sprintf(
+            'Found model in database table [%s] that matched attributes [%s].',
+            $model->getTable(),
+            json_encode($expected)
+        );
+
+        PHPUnit::assertEquals(0, $this->countModels($model, $expected), $message);
+
+        return $this;
+    }
+
+    /**
+     * @param Model $model
+     * @param array $expected
+     * @return int
+     */
+    private function countModels(Model $model, array $expected)
+    {
+        return $model
+            ->getConnection()
+            ->table($model->getTable())
+            ->where($expected)
+            ->count();
     }
 }
