[Cleanup] Code cleanup and update doc blocks

Author: lindyhopchris

CHANGELOG.md

@@ -2,6 +2,19 @@
 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/).
 
+## Unreleased
+
+### Added
+- Default Eloquent hydration attributes are now calculated using `Model::getFillable()`. To use this,
+set the `$attributes` property on an Eloquent hydrator to `null`.
+- Default Eloquent serialization attribution in the `EloquentSchema` class. These are calculated using
+either `Model::getVisible()` or `Model::getFillable()` minus any `Model::getHidden()` keys. To use this,
+set the `$attributes` property on an Eloquent schema to `null`.
+
+### Changed
+- When generating an Eloquent hydrator or schema using the `make:json-api` commands, the `$attributes`
+property will be set as `null` by default.
+
 ## [0.6.2] - 2017-02-23
 
 ### Fixed

src/Hydrator/EloquentHydrator.php

@@ -38,6 +38,7 @@
 
 /**
  * Class EloquentHydrator
+ *
  * @package CloudCreativity\LaravelJsonApi
  */
 class EloquentHydrator extends AbstractHydrator implements HydratesRelatedInterface
@@ -48,6 +49,10 @@ class EloquentHydrator extends AbstractHydrator implements HydratesRelatedInterf
     /**
      * The resource attribute keys to hydrate.
      *
+     * - Empty array = hydrate no attributes.
+     * - Non-empty array = hydrate the specified attribute keys (see below).
+     * - Null = calculate the attributes to hydrate using `Model::getFillable()`
+     *
      * List the keys from the resource's attributes that should be transferred to your
      * model using the `fill()` method. To map a resource attribute key to a different
      * model key, use a key/value pair where the key is the resource attribute and the
@@ -68,9 +73,12 @@ class EloquentHydrator extends AbstractHydrator implements HydratesRelatedInterf
      * attribute will be converted to `foo_bar` if the Model uses snake case attributes,
      * or `fooBar` if it does not use snake case.
      *
-     * @var array
+     * If this property is `null`, the attributes to hydrate will be calculated using
+     * `Model::getFillable()`.
+     *
+     * @var array|null
      */
-    protected $attributes = NULL;
+    protected $attributes = null;
 
     /**
      * The resource attributes that are dates.
@@ -109,24 +117,27 @@ class EloquentHydrator extends AbstractHydrator implements HydratesRelatedInterf
 
     /**
      * EloquentHydrator constructor.
+     *
      * @param HttpServiceInterface $service
      */
     public function __construct(HttpServiceInterface $service)
     {
         $this->service = $service;
     }
-    
+
     /**
-     * @param $record
-     * @return void
+     * @param StandardObjectInterface $attributes
+     *      the attributes received from the client.
+     * @param Model $record
+     *      the model being hydrated
+     * @return array
+     *      the JSON API attribute keys to hydrate
      */
-    protected function attributeKeys($record)
+    protected function attributeKeys(StandardObjectInterface $attributes, $record)
     {
-        if(is_null($this->attributes))
-        {
+        if (is_null($this->attributes)) {
             $fillableAttributes = [];
-            foreach($record->getFillable() as $attribute)
-            {
+            foreach ($record->getFillable() as $attribute) {
                 $fillableAttributes[Str::dasherize($attribute)] = $attribute;
             }
             return $fillableAttributes;
@@ -145,7 +156,7 @@ protected function hydrateAttributes(StandardObjectInterface $attributes, $recor
 
         $data = [];
 
-        foreach ($this->attributeKeys($record) as $resourceKey => $modelKey) {
+        foreach ($this->attributeKeys($attributes, $record) as $resourceKey => $modelKey) {
             if (is_numeric($resourceKey)) {
                 $resourceKey = $modelKey;
                 $modelKey = $this->keyForAttribute($modelKey, $record);
@@ -193,7 +204,7 @@ public function hydrateRelated(ResourceInterface $resource, $record)
         foreach ($resource->getRelationships()->getAll() as $key => $relationship) {
 
             /** If there is a specific method for this related member, we'll hydrate that */
-            $related = $this->callHydrateRelated($key, $relationship, $record);
+            $related = $this->callHydrateRelatedRelationship($key, $relationship, $record);
 
             if (false !== $related) {
                 $results = array_merge($results, $related);

src/Schema/EloquentSchema.php

@@ -26,6 +26,7 @@
 
 /**
  * Class EloquentSchema
+ *
  * @package CloudCreativity\LaravelJsonApi
  */
 abstract class EloquentSchema extends AbstractSchema
@@ -80,9 +81,18 @@ abstract class EloquentSchema extends AbstractSchema
     /**
      * The model attribute keys to serialize.
      *
-     * @var array
+     * - Empty array: no attributes to serialize.
+     * - Non-empty array: serialize the specified model keys.
+     * - Null: work out the keys to serialize.
+     *
+     * If `null`, then `Model::getVisible()` is used if it returns a non-empty array.
+     * Otherwise, `Model::getFillable()` will be used, minus any keys specified in
+     * `Model::getHidden()`. We use `getFillable` because that is also the default
+     * in `EloquentHydrator`.
+     *
+     * @var array|null
      */
-    protected $attributes = NULL;
+    protected $attributes = null;
 
     /**
      * Whether resource member names are hyphenated
@@ -162,18 +172,15 @@ protected function getDefaultAttributes(Model $model)
      */
     protected function attributeKeys(Model $model)
     {
-        if(is_null($this->attributes))
-        {
-            if(! empty($model->getVisible()))
-            {
+        if (is_null($this->attributes)) {
+            if (!empty($model->getVisible())) {
                 return $model->getVisible();
             }
             return array_diff($model->getFillable(), $model->getHidden());
         }
         return $this->attributes;
     }
 
-
     /**
      * Get attributes for the provided model.
      *

stubs/eloquent/hydrator.stub

@@ -8,11 +8,9 @@ class Hydrator extends EloquentHydrator
 {
 
     /**
-     * @var array
+     * @var array|null
      */
-    protected $attributes = [
-        //
-    ];
+    protected $attributes = null;
 
     /**
      * @var array

stubs/eloquent/schema.stub

@@ -13,11 +13,9 @@ class Schema extends EloquentSchema
     const RESOURCE_TYPE = 'dummyResourceType';
 
     /**
-     * @var array
+     * @var array|null
      */
-    protected $attributes = [
-        //
-    ];
+    protected $attributes = null;
 
     /**
      * @return string