Add DataTables

Author: MGatner

README.md

@@ -30,11 +30,24 @@ command to inject all assets into your front controller path:
 php spark publish
 ```
 
+<<<<<<< HEAD
+=======
+### Bootstrap and Versioning
+
+This dependency stack includes Bootstrap support for both versions 4 and 5. By default
+Composer will select the highest available version but it is a good idea to lock to one by
+requiring `twbs/bootstrap` with an explicit version:
+* Version 4: `composer require twbs/bootstrap:^4.0`
+* Version 5: `composer require twbs/bootstrap:^5.0`
+
+AdminLTE and other Bootstrap-specific libraries will adjust accordingly.
+
 ## Included Solutions
 
 ### Asset Libraries
 
 * [Bootstrap](https://getbootstrap.com) - Mobile-first front-end CSS framework directed at responsive web development
+* [DataTables](https://datatables.net) - To enhance the accessibility of data in HTML tables
 * [FontAwesome](https://fontawesome.com) - Popular icon set and toolkit for vector icons and social logos
 * [jQuery](https://jquery.com) - A fast, small, and feature-rich JavaScript library
 
@@ -45,6 +58,9 @@ php spark publish
 * [Tatter\Menus](https://packagist.org/packages/tatter/menus)
 * [Tatter\Themes](https://packagist.org/packages/tatter/themes)
 
+> *Note: jQuery is included because some other libraries depend on it; should those libraries
+> remove it as a dependency or be removed themselve then jQuery will no longer be included.
+
 ## Configuration
 
 *For full configuration details see the [Assets docs](https://github.com/tattersoftware/codeigniter4-assets).*

composer.json

@@ -23,6 +23,7 @@
     ],
     "require": {
         "php": "^7.3 || ^8.0",
+        "datatables.net/datatables.net-bs4": "dev-master",
         "fortawesome/font-awesome": "^5.15",
         "components/jquery": "^3.3",
         "league/commonmark": "^1.5",
@@ -51,7 +52,11 @@
     "repositories": [
         {
             "type": "vcs",
-            "url": "https://github.com/codeigniter4/CodeIgniter4"
+            "url": "https://github.com/codeigniter4/CodeIgniter4.git"
+        },
+        {
+            "type": "vcs",
+            "url": "https://github.com/DataTables/Dist-DataTables-Bootstrap4.git"
         },
         {
             "type": "composer",

src/Bundles/DataTablesBundle.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Tatter\Frontend\Bundles;
+
+use Tatter\Frontend\FrontendBundle;
+
+class DataTablesBundle extends FrontendBundle
+{
+    /**
+     * Applies any initial inputs after the constructor.
+     */
+    protected function define(): void
+    {
+        $this
+            ->addPath('datatables/js/jquery.dataTables.min.js')
+            ->addPath('datatables/js/dataTables.bootstrap4.min.js')
+            ->addPath('datatables/css/dataTables.bootstrap4.min.css')
+            ->merge(new BootstrapBundle());
+    }
+}

src/Publishers/DataTablesPublisher.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Tatter\Frontend\Publishers;
+
+use Tatter\Frontend\FrontendPublisher;
+
+class DataTablesPublisher extends FrontendPublisher
+{
+    protected $source = 'vendor/datatables.net/datatables.net';
+    protected $path   = 'datatables';
+
+    /**
+     * Reads files from the sources and copies them out to their destinations.
+     * This method should be reimplemented by child classes intended for
+     * discovery.
+     */
+    public function publish(): bool
+    {
+        return $this
+            ->addPath('js')
+            ->addPath('types')
+            ->merge(true);
+    }
+}

src/Publishers/DataTablesStylePublisher.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Tatter\Frontend\Publishers;
+
+use Tatter\Frontend\FrontendPublisher;
+
+class DataTablesStylePublisher extends FrontendPublisher
+{
+    protected $source = 'vendor/datatables.net/datatables.net-bs4';
+    protected $path   = 'datatables';
+
+    /**
+     * Reads files from the sources and copies them out to their destinations.
+     * This method should be reimplemented by child classes intended for
+     * discovery.
+     */
+    public function publish(): bool
+    {
+        return $this
+            ->addPath('css')
+            ->addPath('images')
+            ->addPath('js')
+            ->addPath('types')
+            ->merge(true);
+    }
+}

tests/BundlesTest.php

@@ -66,6 +66,18 @@ public function bundleProvider()
                     'bootstrap.bundle.min.js',
                 ],
             ],
+            [
+                DataTablesBundle::class,
+                [
+                    'bootstrap.min.css',
+                    'jquery.min.js',
+                ],
+                [
+                    'bootstrap.bundle.min.js',
+                    'dataTables.bootstrap4.min.js',
+                    'jquery.dataTables.min.js',
+                ],
+            ],
             [
                 FontAwesomeBundle::class,
                 [

tests/PublishersTest.php

@@ -45,6 +45,21 @@ public function publisherProvider()
                     'bootstrap/js/bootstrap.min.js.map',
                 ],
             ],
+            [
+                DataTablesPublisher::class,
+                [
+                    'datatables/js/jquery.dataTables.js',
+                    'datatables/types/types.d.ts',
+                ],
+            ],
+            [
+                DataTablesStylePublisher::class,
+                [
+                    'datatables/css/dataTables.bootstrap4.min.css',
+                    'datatables/images/sort_asc_disabled.png',
+                    'datatables/js/dataTables.bootstrap4.js',
+                ],
+            ],
             [
                 FontAwesomePublisher::class,
                 [