Merge 26d77be into bde96e0

tattersoftware · Jul 28, 2022 · 5d1bd42 · 5d1bd42
2 parents bde96e0 + 26d77be
commit 5d1bd42
Show file tree

Hide file tree

Showing 23 changed files with 170 additions and 166 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{yml,yaml}]
+indent_size = 2
diff --git a/.github/workflows/deptrac.yml b/.github/workflows/deptrac.yml
@@ -31,7 +31,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           tools: phive
           extensions: intl, json, mbstring, xml
           coverage: none

diff --git a/.github/workflows/infection.yml b/.github/workflows/infection.yml
@@ -31,7 +31,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           tools: infection, phpunit
           extensions: intl, json, mbstring, gd, xml, sqlite3
           coverage: xdebug

diff --git a/.github/workflows/phpcpd.yml b/.github/workflows/phpcpd.yml
@@ -27,7 +27,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           tools: phpcpd
           extensions: dom, mbstring
           coverage: none

diff --git a/.github/workflows/phpcsfixer.yml b/.github/workflows/phpcsfixer.yml
@@ -16,13 +16,9 @@ on:
 
 jobs:
   build:
-    name: PHP ${{ matrix.php-versions }} Coding Standards
+    name: Coding Standards
     runs-on: ubuntu-latest
     if: "!contains(github.event.head_commit.message, '[ci skip]')"
-    strategy:
-      fail-fast: false
-      matrix:
-        php-versions: ['7.4', '8.0', '8.1']
 
     steps:
       - name: Checkout
@@ -31,7 +27,7 @@ jobs:
       - name: Set up PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-versions }}
+          php-version: '8.1'
           extensions: json, tokenizer
           coverage: none
         env:

diff --git a/.github/workflows/psalm.yml b/.github/workflows/psalm.yml
@@ -31,7 +31,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
           tools: phpstan, phpunit
           extensions: intl, json, mbstring, xml
           coverage: none

diff --git a/.github/workflows/rector.yml b/.github/workflows/rector.yml
@@ -63,5 +63,5 @@ jobs:
 
       - name: Analyze for refactoring
         run: |
-          composer global require --dev rector/rector:^0.12.16
+          composer global require --dev rector/rector:^0.13.8
           rector process --dry-run --no-progress-bar
diff --git a/.github/workflows/unused.yml b/.github/workflows/unused.yml
@@ -0,0 +1,59 @@
+name: Unused
+
+on:
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.*'
+      - '.github/workflows/unused.yml'
+  push:
+    branches:
+      - develop
+    paths:
+      - '**.php'
+      - 'composer.*'
+      - '.github/workflows/unused.yml'
+
+jobs:
+  build:
+    name: Unused Package Detection
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: composer, composer-unused
+          extensions: intl, json, mbstring, xml
+          coverage: none
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: |
+          if [ -f composer.lock ]; then
+            composer install --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          else
+            composer update --no-progress --no-interaction --prefer-dist --optimize-autoloader
+          fi
+
+      - name: Detect unused packages
+        run: composer-unused -vvv --output-format=github --ansi --no-interaction --no-progress
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -14,6 +14,7 @@
     ->append([__FILE__]);
 
 $overrides = [
+    // Some tests need to be rewritten to support assertSame instead of assertEquals
     'php_unit_strict' => false,
 ];
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Tatter Software
+Copyright (c) 2019-2022 Tatter Software
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,8 +1,9 @@
 # Tatter\Forms
 RESTful AJAX forms for CodeIgniter 4
 
-[![](https://github.com/tattersoftware/codeigniter4-forms/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-forms/actions?query=workflow%3A%22PHPUnit)
-[![](https://github.com/tattersoftware/codeigniter4-forms/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-forms/actions?query=workflow%3A%22PHPStan)
+[![](https://github.com/tattersoftware/codeigniter4-forms/workflows/PHPUnit/badge.svg)](https://github.com/tattersoftware/codeigniter4-forms/actions/workflows/phpunit.yml)
+[![](https://github.com/tattersoftware/codeigniter4-forms/workflows/PHPStan/badge.svg)](https://github.com/tattersoftware/codeigniter4-forms/actions/workflows/phpstan.yml)
+[![](https://github.com/tattersoftware/codeigniter4-forms/workflows/Deptrac/badge.svg)](https://github.com/tattersoftware/codeigniter4-forms/actions/workflows/deptrac.yml)
 [![Coverage Status](https://coveralls.io/repos/github/tattersoftware/codeigniter4-forms/badge.svg?branch=develop)](https://coveralls.io/github/tattersoftware/codeigniter4-forms?branch=develop)
 
 ## Quick Start
@@ -20,33 +21,28 @@ AJAX forms with CodeIgniter 4's native RESTful implementation.
 
 Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities
 and always be up-to-date:
-	> composer require tatter/forms
+```shell
+> composer require tatter/forms
+```
 
 Or, install manually by downloading the source files and adding the directory to
-`app/Config/Autoload.php`.
-
-After installation you will need to publish the required assets to your **public** folder,
-as defined by the [manifest files](src/Manifests/):
-	php spark assets:publish
+**app/Config/Autoload.php**.
 
-> *Tip*: You can add the publish command to your **composer.json**'s `post-update-cmd` section to ensure your assets are always in sync with the package source.
+After installation you will need to copy or publish the required assets to your
+**public/** folder. If you want to automate this process check out the
+[Assets Library](https://github.com/tattersoftware/codeigniter4-assets).
 
-Finally, notify your view/layout of your intention to use the JavaScript for your forms (your paths
-may vary):
-```
-<link href="assets/vendor/bootstrap/bootstrap.min.css" rel="stylesheet" type="text/css" />
+Finally, notify your view/layout of your intention to use the JavaScript for your forms
+(your paths may vary):
+```html
 <script src="assets/vendor/forms/forms.js" type="text/javascript"></script>
-<script src="assets/vendor/bootstrap/bootstrap.bundle.min.js" type="text/javascript"></script>
 <script>
 	var baseUrl = "<?= base_url() ?>";
 	var siteUrl = "<?= site_url() ?>";
 	var apiUrl  = "<?= site_url(config('forms')->apiUrl) ?>";
 </script>
 ```
 
-> *Tip*: **Forms** includes [Tatter\Assets](https://github.com/tattersoftware/codeigniter4-assets) which you can use to auto-include assets via the Config file
-
-
 ## Configuration (optional)
 
 The library's default behavior can be overridden or augment by its config file. Copy
@@ -55,12 +51,12 @@ comments. If no config file is found the library will use its defaults.
 
 ## Usage
 
-*N.B. Please consider this module to be modular itself - you need not use every piece!*
+***Note:*** Please consider this module to be modular itself - you need not use every piece!*
 *Treat portions of the code that you do not use as examples for how to implement this in your own app.*
 
 After the initial installation there are a few pieces to implement. **Forms** will run
-CRUD-style operations for you by interfacing views with the **ResourcePresenter** or
-**ResourceController** depending on the method of interaction (i.e. page load versus AJAX).
+CRUD-style operations for you by interfacing views with the `ResourcePresenter` or
+`ResourceController` depending on the method of interaction (i.e. page load versus AJAX).
 Not surprisingly, you will need some **Views** and two **Controllers** per resource.
 
 ### Naming
@@ -69,11 +65,11 @@ Not surprisingly, you will need some **Views** and two **Controllers** per resou
 If you are creating a game, your resource names might be *hero(es)*, *level(s)*, *reward(s)*,
 etc. The naming convention is important for autoloading resources and their endpoints. By
 default, **Forms** will use the name of the model associated with your resource. So a URL of
-`heroes/new` would route to the **HeroController** which uses **HeroModel** and the whole
-resource would be dubbed **hero** off that model.
+`heroes/new` would route to the `HeroController` which uses `HeroModel` and the whole
+resource would be dubbed "hero" off that model.
 
 If you need to set your own names, do so with your model's `$name` property:
-```
+```php
 class HeroModel extends \CodeIgniter\Model
 {
 	public $name = 'superhero';
@@ -97,38 +93,49 @@ for each resource (where {names} is the plural of your resource name):
 
 As you can see **Forms** expects some views that are part of a full page load layout and
 some that can be injected into an existing page via AJAX (e.g. in a modal). See
-[examples](examples/Views/) for a full set of example view files.
+[examples](examples/Views/) for a full set of example view files (note: these are presented
+"as is" and may not always be the best solution for all use cases).
 
 ### Controllers
 
 In addition to the views, you will need two controllers for each resource:
-* **Controllers/{names}.php** - Your presenter for page loads, extends `\Tatter\Forms\Controllers\ResourcePresenter.php`
-* **Controllers/API/{names}.php** - Your controller for AJAX calls, extends `\Tatter\Forms\Controllers\ResourceController.php`
+* **Controllers/{names}.php** - Your presenter for page loads, extends `Tatter\Forms\Controllers\ResourcePresenter`
+* **Controllers/API/{names}.php** - Your controller for AJAX calls, extends `Tatter\Forms\Controllers\ResourceController`
 
-As with standard framework controllers, your controllers set their model via the `$modelName`
-property:
-```
-<?php namespace App\Controllers;
+As with other framework RESTful controllers, your controllers set their model via the
+`$modelName` property:
+```php
+<?php
 
-class Heroes extends \Tatter\Forms\Controllers\ResourcePresenter
+namespace App\Controllers;
+
+use App\Models\HeroModel;
+use Tatter\Forms\Controllers\ResourcePresenter;
+
+class Heroes extends ResourcePresenter
 {	
-	protected $modelName = 'App\Models\HeroModel';
+	protected $modelName = HeroModel::class;
 	...
 ```
 
 Your resource controller can take an additional property, `$format`, to specify response
 format (**Forms** currently only supports JSON):
-```
-<?php namespace App\Controllers\API;
+```php
+<?php
 
-class Heroes extends \Tatter\Forms\Controllers\ResourceController
+namespace App\Controllers\API;
+
+use App\Models\HeroModel;
+use Tatter\Forms\Controllers\ResourceController;
+
+class Heroes extends ResourceController
 {	
-	protected $modelName = 'App\Models\BookModel';
+	protected $modelName = HeroModel::class;
 	protected $format    = 'json';
 	...
 ```
 
-See [RESTful Resource Handling](https://codeigniter4.github.io/userguide/incoming/restful.html)
+See [RESTful Resource Handling](https://codeigniter.com/user_guide/incoming/restful.html)
 in the CodeIgniter 4 User Guide for more info on using resource controllers.
 
 ### Routes
@@ -152,10 +159,7 @@ and controllers and auto-handling AJAX requests. If you want a more complete set
 or fully automated object handler you will want to include your own third-party tools and
 implement them in your view files.
 
-## Appendix
-
-### jQuery
+#### jQuery
 
-This package uses jQuery because Bootstrap 4 requires it. The Bootstrap team officially
-announced plans to remove the jQuery dependency in Bootstrap 5, at which point this package
-will transition to native JavaScript (via [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)).
+This package uses jQuery (not included). Future versions will drop jQuery in favor of
+native JavaScript (via [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)).
diff --git a/composer-unused.php b/composer-unused.php
@@ -7,11 +7,9 @@
 use ComposerUnused\ComposerUnused\Configuration\PatternFilter;
 use Webmozart\Glob\Glob;
 
-return static function (Configuration $config): Configuration {
-    return $config
-        // ->addNamedFilter(NamedFilter::fromString('symfony/config'))
-        // ->addPatternFilter(PatternFilter::fromString('/symfony-.*/'))
-        ->setAdditionalFilesFor('codeigniter4/framework', [
-            ...Glob::glob(__DIR__ . '/vendor/codeigniter4/framework/system/Helpers/*.php'),
-        ]);
-};
+return static fn (Configuration $config): Configuration => $config
+    // ->addNamedFilter(NamedFilter::fromString('symfony/config'))
+    // ->addPatternFilter(PatternFilter::fromString('/symfony-.*/'))
+    ->setAdditionalFilesFor('codeigniter4/framework', [
+        ...Glob::glob(__DIR__ . '/vendor/codeigniter4/framework/system/Helpers/*.php'),
+    ]);
diff --git a/composer.json b/composer.json
@@ -9,7 +9,7 @@
         "forms",
         "REST",
         "AJAX",
-        "javascript",
+        "JavaScript",
         "CRUD"
     ],
     "authors": [
@@ -22,15 +22,10 @@
     ],
     "homepage": "https://github.com/tattersoftware/codeigniter4-forms",
     "require": {
-        "php": "^7.4 || ^8.0",
-        "components/jquery": "^3.3",
-        "tatter/alerts": "^2.0",
-        "tatter/assets": "^2.0",
-        "twbs/bootstrap": "^4.3"
+        "php": "^7.4 || ^8.0"
     },
     "require-dev": {
         "codeigniter4/framework": "^4.1",
-        "mikey179/vfsstream": "^1.6",
         "tatter/tools": "^2.0"
     },
     "minimum-stability": "dev",
@@ -54,14 +49,18 @@
         }
     },
     "scripts": {
-        "analyze": "phpstan analyze",
+        "analyze": [
+            "phpstan analyze",
+            "psalm",
+            "rector process --dry-run"
+        ],
         "ci": [
             "Composer\\Config::disableProcessTimeout",
             "@deduplicate",
             "@analyze",
+            "@composer normalize --dry-run",
             "@test",
             "@inspect",
-            "rector process",
             "@style"
         ],
         "deduplicate": "phpcpd app/ src/",

diff --git a/deptrac.yaml b/deptrac.yaml
@@ -114,7 +114,7 @@ parameters:
     Service:
       - Config
       - Vendor Config
-  
+
     # Ignore anything in the Vendor layers
     Vendor Model:
       - Config