Only support latest stable Laravel version (#496)

Author: jasonmccreary

.github/workflows/build.yml

@@ -9,43 +9,22 @@ on:
     - cron: "0 0 * * *"
 
 env:
-  COMPOSER_FLAGS: "--ansi --no-interaction --no-progress --no-suggest --prefer-dist -o -n"
+  COMPOSER_FLAGS: "--ansi --no-interaction --no-progress --prefer-dist -o -n"
 
 jobs:
   tests:
     strategy:
       fail-fast: false
       matrix:
-        php-version: [7.2, 7.3, 7.4, 8.0]
+        php-version: [7.3, 7.4, 8.0]
 
-        laravel-version: [6, 7, 8]
-
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
 
         dependencies: [locked]
 
         experimental: [false]
 
-        include:
-          - php-version: 7.4
-            laravel-version: 7
-            dependencies: highest
-            os: ubuntu-latest
-            experimental: false
-
-          - php-version: 7.4
-            laravel-version: 7
-            os: windows-latest
-            dependencies: locked
-            experimental: false
-
-          - php-version: 7.4
-            laravel-version: 7
-            os: macos-latest
-            dependencies: locked
-            experimental: false
-
-    name: PHP ${{ matrix.php-version }} - L${{ matrix.laravel-version }} - ${{ matrix.os }}
+    name: PHP ${{ matrix.php-version }} - ${{ matrix.os }}
 
     runs-on: ${{ matrix.os }}
 
@@ -63,14 +42,14 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ${{ steps.determine-composer-cache-directory.outputs.directory }}
-          key: dependencies-os-${{ matrix.os }}-php-${{ matrix.php-version }}-laravel-${{ matrix.laravel-version }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: dependencies-os-${{ matrix.os }}-php-${{ matrix.php-version }}-laravel-${{ matrix.laravel-version }}-composer-
+          key: dependencies-os-${{ matrix.os }}-php-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: dependencies-os-${{ matrix.os }}-php-${{ matrix.php-version }}-composer-
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, gd
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, gd, fileinfo
           coverage: none
           ini-values: "memory_limit=-1"
 
@@ -104,12 +83,8 @@ jobs:
           max_attempts: 5
           command: composer install ${{ env.COMPOSER_FLAGS }}
 
-      - name: Select Laravel version
-        uses: nick-invision/retry@v1
-        with:
-          timeout_minutes: 5
-          max_attempts: 5
-          command: composer require "laravel/framework:${{ matrix.laravel-version }}.*" --no-update
+      - name: Install Laravel
+        run: composer require laravel/framework --no-update
 
       - name: Run tests
         run: vendor/bin/phpunit --verbose

README.md

@@ -8,7 +8,7 @@
 
 _Blueprint_ is an open-source tool for **rapidly generating multiple** Laravel components from a **single, human readable** definition.
 
-Watch a quick [demo of Blueprint](https://www.youtube.com/watch?v=A_gUCwni_6c) in action and continue reading this document to get started.
+Watch a quick [demo of Blueprint](https://www.youtube.com/watch?v=A_gUCwni_6c) in action and continue reading to get started.
 
 ## Requirements
 Blueprint requires a Laravel application running version 6.0 or higher.
@@ -72,8 +72,12 @@ From these simple 20 lines of YAML, Blueprint will generate all of the following
 - An _event_ class for `NewPost` complete with a `post` property set through the _constructor_.
 - A _Blade template_ of `post/index.blade.php` rendered by `PostController@index`.
 
-_**Note:** This example assumes features within a default Laravel application such as the `User` model and `app.blade.php
- layout. Otherwise, the generated test may have failures._
+_**Note:** This example assumes features within a default Laravel application such as the `User` model and `app.blade.php` layout. Otherwise, the generated test may have failures._
 
 ## Documentation
 Browse the [Blueprint Docs](https://blueprint.laravelshift.com/) for full details on [defining models](https://blueprint.laravelshift.com/docs/defining-models/), [defining controllers](https://blueprint.laravelshift.com/docs/defining-controllers/), [advanced configuration](https://blueprint.laravelshift.com/docs/advanced-configuration/), and [extending Blueprint](https://blueprint.laravelshift.com/docs/extending-blueprint/).
+
+## Support Policy
+Starting with version 2, Blueprint only generates code for the latest stable version of Laravel (currently Laravel 8). If you need to support older versions of Laravel, you may use version 1 or upgrade your application ([try using Shift](https://laravelshift.com)).
+
+Blueprint still follows [semantic versioning](https://semver.org/). However, it does so with respect to its grammar. Any changes to the grammar will increase its major version number. Otherwise, minor version number increases will contain new features. This includes generating code for future versions of Laravel.

UPGRADE.md

@@ -0,0 +1,17 @@
+# Upgrade Guide
+
+## Upgrading from 1.x to 2.x
+Version 2.x was a superficial major release to reflect Blueprint's new [Support Policy](https://github.com/laravel-shift/blueprint#support-policy). There were no changes to the underlying grammar. A few configuration options and methods were changed. Additional notes are below. You may view the full set of changes in [#496](https://github.com/laravel-shift/blueprint/pull/496).
+
+### Configuration changes
+The following configuration options were changed to reflect new conventions in Laravel 8.
+
+- `models_namespace` default value is now `Models`.
+- `generate_fqcn_route` was removed. Blueprint now generates all routes using fully qualified class names and tuples.
+
+### Removed methods
+The following static methods on the `Blueprint` class were changed:
+
+- `supportsReturnTypeHits` was renamed to `useReturnTypeHints`.
+- `isLaravel8OrHigher` was removed.
+- `isPHP7OrHigher` was removed.

composer.json

@@ -9,16 +9,16 @@
     "license": "MIT",
     "require": {
         "doctrine/dbal": "^2.9 || ^3.0",
-        "illuminate/console": "^6.0 || ^7.0 || ^8.0",
-        "illuminate/filesystem": "^6.0 || ^7.0 || ^8.0",
-        "illuminate/support": "^6.0 || ^7.0 || ^8.0",
+        "illuminate/console": "^8.0",
+        "illuminate/filesystem": "^8.0",
+        "illuminate/support": "^8.0",
         "laravel-shift/faker-registry": "^0.1",
-        "symfony/yaml": "^4.3 || ^5.0"
+        "symfony/yaml": "^5.1.4"
     },
     "require-dev": {
         "mockery/mockery": "^1.3",
-        "orchestra/testbench": "^4.0 || ^5.0 || ^6.0",
-        "phpunit/phpunit": "^8.0 || ^9.3"
+        "orchestra/testbench": "^6.0",
+        "phpunit/phpunit": "^9.3"
     },
     "suggest": {
         "jasonmccreary/laravel-test-assertions": "Required to use additional assertions in generated tests (^1.0)."

config/blueprint.php

@@ -15,7 +15,6 @@
     */
     'namespace' => 'App',
 
-
     /*
     |--------------------------------------------------------------------------
     | Component Namespaces
@@ -27,10 +26,9 @@
     | your own custom namespace when generating these components.
     |
     */
-    'models_namespace' => '',
+    'models_namespace' => 'Models',
     'controllers_namespace' => 'Http\\Controllers',
 
-
     /*
     |--------------------------------------------------------------------------
     | Application Path
@@ -116,20 +114,6 @@
     */
     'use_guarded' => false,
 
-    /*
-    |--------------------------------------------------------------------------
-    | Generate FQCN Routes
-    |--------------------------------------------------------------------------
-    |
-    | By default, Blueprint follows the Laravel convention of the controller
-    | namespace matches the namespace set within the RouteServiceProvider.
-    | However, you may configure Blueprint to generate routes using a
-    | "tuple syntax" in cases where you may not use this property
-    | or wish to improve static analysis.
-    |
-    */
-    'generate_fqcn_route' => false,
-
     /*
     |--------------------------------------------------------------------------
     | Generators

phpunit.xml

@@ -1,27 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="./vendor/phpunit/phpunit/phpunit.xsd"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="Unit">
-            <directory suffix="Test.php">./tests/Unit</directory>
-        </testsuite>
-
-        <testsuite name="Feature">
-            <directory suffix="Test.php">./tests/Feature</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" backupStaticAttributes="false" bootstrap="vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false">
+  <coverage processUncoveredFiles="true">
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Unit">
+      <directory suffix="Test.php">./tests/Unit</directory>
+    </testsuite>
+    <testsuite name="Feature">
+      <directory suffix="Test.php">./tests/Feature</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>

src/Blueprint.php

@@ -30,19 +30,9 @@ public static function appPath()
         return str_replace('\\', '/', config('blueprint.app_path'));
     }
 
-    public static function supportsReturnTypeHits()
+    public static function useReturnTypeHints()
     {
-        return boolval(config('blueprint.use_return_types')) && self::isPHP7OrHigher();
-    }
-
-    public static function isPHP7OrHigher()
-    {
-        return version_compare(PHP_VERSION, '7.0.0', '>=');
-    }
-
-    public static function isLaravel8OrHigher()
-    {
-        return version_compare(App::version(), '8.0.0', '>=');
+        return boolval(config('blueprint.use_return_types'));
     }
 
     public function parse($content, $strip_dashes = true)

src/Commands/BuildCommand.php

@@ -76,6 +76,8 @@ function ($file) {
                 $this->line('');
             }
         );
+
+        return 0;
     }
 
     /**

src/Commands/EraseCommand.php

@@ -33,11 +33,6 @@ public function __construct(Filesystem $filesystem)
         $this->filesystem = $filesystem;
     }
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
     public function handle()
     {
         $contents = $this->filesystem->get('.blueprint');
@@ -72,7 +67,7 @@ function ($file) {
 
         $this->filesystem->put('.blueprint', $blueprint->dump($generated));
 
-        $this->call('blueprint:trace');
+        return $this->call('blueprint:trace');
     }
 
     private function outputStyle($action)

src/Commands/InitCommand.php

@@ -20,13 +20,8 @@ class InitCommand extends Command
      */
     protected $description = 'An alias for "blueprint:new" command';
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
     public function handle()
     {
-        $this->call(\Blueprint\Commands\NewCommand::class);
+        return $this->call(\Blueprint\Commands\NewCommand::class);
     }
 }