Add jQuery

Author: MGatner

README.md

@@ -30,26 +30,12 @@ command to inject all assets into your front controller path:
 php spark publish
 ```
 
-### 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. Using Bootstrap 4
-will also include jQuery (via [Tatter\JQuery](https://packagist.org/packages/tatter/jquery))
-as it is a dependency.
-
 ## Included Solutions
 
 ### Asset Libraries
 
-* [AdminLTE](https://adminlte.io) (via [Tatter\AdminLTE](https://packagist.org/packages/tatter/adminlte)) - Admin Dashboard Template
-* [Bootstrap](https://getbootstrap.com) (via [Tatter\Bootstrap](https://packagist.org/packages/tatter/bootstrap))  - 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
 
 ### Support Libraries
 
@@ -89,8 +75,8 @@ want them to be applied. **app/Config/Assets.php**:
 
 namespace Config;
 
-use Tatter\AdminLTE\Bundles\AdminLTEBundle;
-use Tatter\Bootstrap\Bundles\BootstrapBundle;
+use Tatter\Frontend\Bundles\AdminLTEBundle;
+use Tatter\Frontend\Bundles\BootstrapBundle;
 use Tatter\Frontend\Bundles\FontAwesomeBundle;
 
 class Assets extends \Tatter\Assets\Config\Assets
@@ -111,7 +97,18 @@ class Assets extends \Tatter\Assets\Config\Assets
 }
 ```
 
-Note that Bundles include their dependency (e.g. AdminLTE includes Bootstrap, Bootstrap 4
+Note that each Bundle includes its dependency (e.g. AdminLTE includes Bootstrap, Bootstrap
 includes jQuery), so while there is no harm in repeating assets it is also unnecessary.
-This does not extend to optional plugins, e.g. if we want to use FontAwesome in AdminLTE
+This does not extend to optional plugins, e.g. if you want to use FontAwesome in AdminLTE
 you will need to include both.
+
+## Versioning
+
+The intent is to maintain two major versions of this library for an indefinite amount of
+time until AdminLTE 4 is fully released and stable for production use. The core differences
+will be around the dependency stack for AdminLTE, Bootstrap, and jQuery.
+
+| Library version | Bootstrap version  | AdminLTE version  | jQuery |
+| --------------: | -----------------: | ----------------: | :----: |
+| `1.x`           | `4.x`              | `3.x`             | Yes    |
+| `2.x`           | `5.x`              | `4.x`             | No     |

composer.json

@@ -24,6 +24,7 @@
     "require": {
         "php": "^7.3 || ^8.0",
         "fortawesome/font-awesome": "^5.15",
+        "components/jquery": "^3.3",
         "league/commonmark": "^1.5",
         "tatter/assets": "^3.0",
         "tatter/menus": "^1.0",

src/Bundles/JQueryBundle.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Tatter\Frontend\Bundles;
+
+use Tatter\Assets\Asset;
+use Tatter\Frontend\FrontendBundle;
+
+class JQueryBundle extends FrontendBundle
+{
+    protected function define(): void
+    {
+        // JQuery needs to load early so we create the Asset then move it to the head tag
+        $asset = Asset::createFromPath(Asset::config()->vendor . 'jquery/jquery.min.js');
+
+        $this->add(new Asset($asset, true));
+    }
+}

src/Publishers/JQueryPublisher.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Tatter\Frontend\Publishers;
+
+use Tatter\Frontend\FrontendPublisher;
+
+class JQueryPublisher extends FrontendPublisher
+{
+    protected $source = 'vendor/components/jquery';
+    protected $path   = 'jquery';
+}

tests/BundlesTest.php

@@ -2,43 +2,44 @@
 
 use CodeIgniter\Publisher\Publisher;
 use Tatter\Frontend\Bundles\FontAwesomeBundle;
+use Tatter\Frontend\Bundles\JQueryBundle;
+use Tatter\Frontend\FrontendBundle;
 use Tests\Support\TestCase;
 
 /**
  * @internal
  */
 final class BundlesTest extends TestCase
 {
-	private $didPublish = false;
+    private $didPublish = false;
 
-	/**
-	 * Publishes all files once so they are
-	 * available for bundles.
-	 */
+    /**
+     * Publishes all files once so they are
+     * available for bundles.
+     */
     protected function setUp(): void
     {
         parent::setUp();
 
         // Make sure everything is published
         if (! $this->didPublish) {
-	        foreach (Publisher::discover() as $publisher) {
-    	        $publisher->publish();
-        	}
+            foreach (Publisher::discover() as $publisher) {
+                $publisher->publish();
+            }
 
-			$this->didPublish = true;
-		}
-	}
+            $this->didPublish = true;
+        }
+    }
 
     /**
-	 * @dataProvider bundleProvider
-	 *
+     * @dataProvider bundleProvider
+     *
      * @param class-string<FrontendBundle> $class
      * @param string[]                     $expectedHeadFiles
      * @param string[]                     $expectedBodyFiles
      */
     public function testBundlesFiles(string $class, array $expectedHeadFiles, array $expectedBodyFiles): void
     {
-
         $bundle = new $class();
         $head   = $bundle->head();
         $body   = $bundle->body();
@@ -54,14 +55,21 @@ public function testBundlesFiles(string $class, array $expectedHeadFiles, array
 
     public function bundleProvider()
     {
-    	return [
-    		[
-    			FontAwesomeBundle::class,
-    			[
-		            'all.min.css',
-				],
-    			[],
-    		],
-    	];
+        return [
+            [
+                FontAwesomeBundle::class,
+                [
+                    'all.min.css',
+                ],
+                [],
+            ],
+            [
+                JQueryBundle::class,
+                [
+                    'jquery.min.js', // Note that unlike most JS files this goes in <head>
+                ],
+                [],
+            ],
+        ];
     }
 }

tests/PublishersTest.php

@@ -1,6 +1,8 @@
 <?php
 
+use Tatter\Frontend\FrontendPublisher;
 use Tatter\Frontend\Publishers\FontAwesomePublisher;
+use Tatter\Frontend\Publishers\JQueryPublisher;
 use Tests\Support\TestCase;
 
 /**
@@ -9,8 +11,8 @@
 final class PublishersTest extends TestCase
 {
     /**
-	 * @dataProvider publisherProvider
-	 *
+     * @dataProvider publisherProvider
+     *
      * @param class-string<FrontendPublisher> $class
      * @param string[]                        $expected
      */
@@ -33,16 +35,22 @@ public function testPublishesFiles(string $class, array $expected): void
 
     public function publisherProvider()
     {
-    	return [
-    		[
-    			FontAwesomePublisher::class,
-    			[
-					'font-awesome/css/all.min.css',
-					'font-awesome/css/svg-with-js.css',
-					'font-awesome/webfonts/fa-brands-400.eot',
-					'font-awesome/webfonts/fa-solid-900.woff2',
-				],
-    		],
-    	];
+        return [
+            [
+                FontAwesomePublisher::class,
+                [
+                    'font-awesome/css/all.min.css',
+                    'font-awesome/css/svg-with-js.css',
+                    'font-awesome/webfonts/fa-brands-400.eot',
+                    'font-awesome/webfonts/fa-solid-900.woff2',
+                ],
+            ],
+            [
+                JQueryPublisher::class,
+                [
+                    'jquery/jquery.min.js',
+                ],
+            ],
+        ];
     }
 }

tests/_support/TestCase.php

@@ -7,8 +7,6 @@
 use org\bovigo\vfs\vfsStreamDirectory;
 use Tatter\Assets\Asset;
 use Tatter\Assets\Config\Assets as AssetsConfig;
-use Tatter\Frontend\FrontendBundle;
-use Tatter\Frontend\FrontendPublisher;
 
 abstract class TestCase extends CIUnitTestCase
 {