Merge branch 'release/0.5.2'

Author: lindyhopchris

.editorconfig

@@ -7,7 +7,7 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.php]
+[*.{php,stub}]
 indent_size = 4
 
 [*.md]

CHANGELOG.md

@@ -2,6 +2,13 @@
 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.5.2] - 2016-11-11
+
+### Added
+- Generator commands to generate the classes required for a JSON API resource. To view available commands use 
+`php artisan list make:json-api`. The main command is `make:json-api:resource` which generates multiple classes for
+a JSON API resource at once. Credit to @jstoone for contributing this feature.
+
 ## [0.5.1] - 2016-11-09
 
 ### Changed

UPGRADE.md

@@ -2,6 +2,14 @@
 
 This file provides notes on how to upgrade between versions.
 
+## v0.5.0|v0.5.1 to v0.5.2
+
+Version `0.5.2` adds generator commands to your application. We've updated the configuration so you will need to
+add the `generator` config array from the bottom of the `config/json-api.php` to the `json-api.php` config file
+in your application. 
+
+This however is optional as the generators will work without this configuration being added.
+
 ## v0.4 to v0.5
 
 Refer to the [UPGRADE-0.5.md](UPGRADE-0.5.md) file for instructions.

config/json-api.php

@@ -143,4 +143,43 @@
     */
     'adapters' => [],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Generators
+    |--------------------------------------------------------------------------
+    |
+    | This package supplies a set of handy generators. These make it possible
+    | to easily generate every class needed to implement a JSON API resource.
+    |
+    | So that we do not enforce any specific patterns, we have included a few
+    | handy configuration options. This is so that the generators can follow
+    | your workflow.
+    |
+    | ## namespace (default: 'JsonApi')
+    |
+    | The folder in which you will be storing everything related to your JSON
+    | API implementation.
+    |
+    | ## by-resource (default: true)
+    |
+    | How you are organising your JSON API classes within your application.
+    |
+    | - true: e.g. \App\JsonApi\Tasks\{Schema, Request, Hydrator}
+    | - false:
+    |   - e.g. \App\JsonApi\Schemas\{User, Post, Comment}
+    |   - e.g. \App\JsonApi\Requests\{User, Post, Comment}
+    |
+    | ## use-eloquent (default: true)
+    |
+    | Whether your JSON API resources predominantly relate to Eloquent models.
+    | You can override the setting here when running a generator. If the
+    | setting here is `true` running a generator with `--no-eloquent` will
+    | override it; if the setting is `false`, then `--eloquent` is the override.
+    |
+    */
+    'generator' => [
+        'namespace' => 'JsonApi',
+        'by-resource' => true,
+        'use-eloquent' => true,
+    ],
 ];

src/Console/Commands/AbstractGeneratorCommand.php

@@ -0,0 +1,270 @@
+<?php
+
+/**
+ * Copyright 2016 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace CloudCreativity\LaravelJsonApi\Console\Commands;
+
+use Illuminate\Console\GeneratorCommand;
+use Illuminate\Filesystem\Filesystem;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+
+/**
+ * Class AbstractGeneratorCommand
+ *
+ * @package CloudCreativity\LaravelJsonApi
+ */
+abstract class AbstractGeneratorCommand extends GeneratorCommand
+{
+
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name;
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description;
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type;
+
+    /**
+     * Whether the resource type is non-dependent on eloquent.
+     *
+     * @var boolean
+     */
+    protected $isIndependent = false;
+
+    /**
+     * Whether the resource should use eloquent implementations.
+     *
+     * @var boolean
+     */
+    protected $useEloquent;
+
+    /**
+     * The folder within the root namespace, where files should be generated.
+     *
+     * @var string
+     */
+    protected $subNamespace;
+
+    /**
+     * Whether generated files should be grouped by their resource files.
+     *
+     * @var mixed
+     */
+    protected $namespaceByResource;
+
+    /**
+     * The location of all generator stubs
+     *
+     * @var string
+     */
+    private $stubsDirectory = __DIR__ . '/../../../stubs';
+
+    /**
+     * Create a new config clear command instance.
+     *
+     * @param Filesystem $files
+     */
+    public function __construct(Filesystem $files)
+    {
+        parent::__construct($files);
+
+        $this->useEloquent = config('json-api.generator.use-eloquent', true);
+        $this->subNamespace = config('json-api.generator.namespace', 'JsonApi');
+        $this->namespaceByResource = config('json-api.generator.by-resource', true);
+    }
+
+    /**
+     * Build the class with the given name.
+     * Remove the base controller import if we are already in base namespace.
+     *
+     * @param  string $name
+     * @return string
+     */
+    protected function buildClass($name)
+    {
+        $stub = $this->files->get($this->getStub());
+
+        $this->replaceNamespace($stub, $name)
+            ->replaceResourceType($stub, $this->getResourceName());
+
+        return $stub;
+    }
+
+    /**
+     * Replace the value of the resource type constant
+     *
+     * @param mixed $stub
+     * @param mixed $resource
+     * @return $this
+     */
+    protected function replaceResourceType(&$stub, $resource)
+    {
+        $stub = str_replace('dummyResourceType', snake_case($resource, '-'), $stub);
+
+        return $this;
+    }
+
+    /**
+     * Get the resource name
+     *
+     * @return string
+     */
+    protected function getResourceName()
+    {
+        $name = ucwords($this->argument('resource'));
+
+        if ($this->namespaceByResource) {
+            return str_plural($name);
+        }
+
+        return $name;
+    }
+
+    /**
+     * Get the desired class name from the input.
+     *
+     * @return string
+     */
+    protected function getNameInput()
+    {
+        if (!$this->namespaceByResource) {
+            return $this->getResourceName();
+        }
+
+        return $this->type;
+    }
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        if ($this->isIndependent) {
+            return $this->getStubFor('independent');
+        }
+
+        if ($this->isEloquent()) {
+            return $this->getStubFor('eloquent');
+        }
+
+        return $this->getStubFor('abstract');
+    }
+
+    /**
+     * Get the stub for specific generator type
+     *
+     * @param string $implementationType
+     * @return string
+     */
+    private function getStubFor($implementationType)
+    {
+        return implode('', [
+            $this->stubsDirectory,
+            '/',
+            $implementationType,
+            '/',
+            lcfirst($this->type),
+            '.stub',
+        ]);
+    }
+
+    /**
+     * Determine whether a resource is eloquent or not
+     *
+     * @return boolean
+     */
+    private function isEloquent()
+    {
+        if ($this->isIndependent) {
+            return false;
+        }
+
+        if ($this->option('no-eloquent')) {
+            return false;
+        }
+
+        return $this->option('eloquent') ?: $this->useEloquent;
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param  string $rootNamespace
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        $namespace = [
+            $rootNamespace,             // #0
+            '\\',                       // #1
+            $this->subNamespace,        // #2
+            '\\',                       // #3
+            $this->getResourceName()    // #4
+        ];
+
+        if (!$this->namespaceByResource) {
+            $namespace[4] = str_plural($this->type);
+        }
+
+        return implode('', $namespace);
+    }
+
+    /**
+     * Get the console command arguments.
+     *
+     * @return array
+     */
+    protected function getArguments()
+    {
+        return [
+            ['resource', InputArgument::REQUIRED, "The resource for which a {$this->type} class will be generated"],
+        ];
+    }
+
+    /**
+     * Get the console command options.
+     *
+     * @return array
+     */
+    protected function getOptions()
+    {
+        if ($this->isIndependent) {
+            return [];
+        }
+
+        return [
+            ['eloquent', 'e', InputOption::VALUE_NONE, 'Use eloquent as adapter'],
+            ['no-eloquent', 'ne', InputOption::VALUE_NONE, 'Use an abstract adapter'],
+        ];
+    }
+}