✨ added ignore-missing-auto setting, thanks @elyukai, jhercher

bnomei · bnomei · commit e05ef40a4d91 · 2025-05-18T14:03:44.000+01:00
closes #32 closes #47 Signed-off-by: Bruno Meilick <b@bnomei.com>
diff --git a/classes/Fingerprint.php b/classes/Fingerprint.php
@@ -25,6 +25,7 @@ public function __construct(array $options = [])
             'integrity' => option('bnomei.fingerprint.integrity'),
             'digest' => option('bnomei.fingerprint.digest'),
             'https' => option('bnomei.fingerprint.https'),
+            'ignore-missing-auto' => option('bnomei.fingerprint.ignore-missing-auto'),
         ];
         $this->options = array_merge($defaults, $options);
 
@@ -140,6 +141,8 @@ public function helper(string $extension, File|FileVersion|string $url, array $a
             $assetUrl = Url::toTemplateAsset($extension.'/templates', $extension);
             if ($assetUrl) {
                 $url = $assetUrl;
+            } elseif (! $assetUrl && $this->option('ignore-missing-auto')) {
+                return null;
             }
         }
 
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "bnomei/kirby3-fingerprint",
     "type": "kirby-plugin",
-    "version": "5.0.0",
+    "version": "5.1.0",
     "description": "File Method and css/js helper to add cache-busting hash and optional Subresource Integrity to file",
     "license": "MIT",
     "authors": [
diff --git a/composer.lock b/composer.lock
diff --git a/index.php b/index.php
@@ -40,6 +40,7 @@ function url_f(File|FileVersion|string $url): string
         'integrity' => function ($file, ?string $digest = null, ?string $manifest = null) {
             return (new \Bnomei\FingerprintFile($file))->integrity($digest, $manifest);
         },
+        'ignore-missing-auto' => true,
     ],
     'fileMethods' => [
         'fingerprint' => function () {
diff --git a/readme.md b/readme.md
@@ -99,13 +99,14 @@ The following plugins can do cache busting, but they do not cache the modified t
 
 ## Settings
 
-| bnomei.fingerprint.       | Default        | Description                                                                         |
-|---------------------------|----------------|-------------------------------------------------------------------------------------|
-| hash | `callback` | will lead to the hashing logic                                                      |
-| integrity | `callback` | use it to set option `'integrity' => null,`                                         |
-| digest | `'sha384'` | Cryptographic digest to be used for SRI hashes either `'sha256'`, `'sha384'` or `'sha512'`. |
-| https | `true` | boolean value or callback to force *https* scheme on all but localhost enviroments. |
-| query | `true` or `string` or `callback` | `myfile.js?v={HASH}`, `myfile.{HASH}.js` or loaded from manifest file               |
+| bnomei.fingerprint. | Default                          | Description                                                                                 |
+|---------------------|----------------------------------|---------------------------------------------------------------------------------------------|
+| hash                | `callback`                       | will lead to the hashing logic                                                              |
+| integrity           | `callback`                       | use it to set option `'integrity' => null,`                                                 |
+| digest              | `'sha384'`                       | Cryptographic digest to be used for SRI hashes either `'sha256'`, `'sha384'` or `'sha512'`. |
+| https               | `true`                           | boolean value or callback to force *https* scheme on all but localhost enviroments.         |
+| query               | `true` or `string` or `callback` | `myfile.js?v={HASH}`, `myfile.{HASH}.js` or loaded from manifest file                       |
+| ignore-missing-auto | `true` or `false`                | silently ignore if an asset requested by @auto rule does not exist                          |
 
 
 ### Query option: true (default)
diff --git a/tests/site/templates/default.php b/tests/site/templates/default.php
@@ -1,5 +1,5 @@
 <?php
 
-//echo \Bnomei\Fingerprint::css('/assets/css/style.css', ['async' => true, 'defer' => true, 'data-something' => 'my-value']);
+// echo \Bnomei\Fingerprint::css('/assets/css/style.css', ['async' => true, 'defer' => true, 'data-something' => 'my-value']);
 
 // echo Bnomei\Fingerprint::css('/assets/css/print.css', 'print');
diff --git a/vendor/autoload.php b/vendor/autoload.php
@@ -14,10 +14,7 @@
             echo $err;
         }
     }
-    trigger_error(
-        $err,
-        E_USER_ERROR
-    );
+    throw new RuntimeException($err);
 }
 
 require_once __DIR__ . '/composer/autoload_real.php';
diff --git a/vendor/composer/InstalledVersions.php b/vendor/composer/InstalledVersions.php
@@ -26,12 +26,23 @@
  */
 class InstalledVersions
 {
+    /**
+     * @var string|null if set (by reflection by Composer), this should be set to the path where this class is being copied to
+     * @internal
+     */
+    private static $selfDir = null;
+
     /**
      * @var mixed[]|null
      * @psalm-var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>}|array{}|null
      */
     private static $installed;
 
+    /**
+     * @var bool
+     */
+    private static $installedIsLocalDir;
+
     /**
      * @var bool|null
      */
@@ -309,6 +320,24 @@ public static function reload($data)
     {
         self::$installed = $data;
         self::$installedByVendor = array();
+
+        // when using reload, we disable the duplicate protection to ensure that self::$installed data is
+        // always returned, but we cannot know whether it comes from the installed.php in __DIR__ or not,
+        // so we have to assume it does not, and that may result in duplicate data being returned when listing
+        // all installed packages for example
+        self::$installedIsLocalDir = false;
+    }
+
+    /**
+     * @return string
+     */
+    private static function getSelfDir()
+    {
+        if (self::$selfDir === null) {
+            self::$selfDir = strtr(__DIR__, '\\', '/');
+        }
+
+        return self::$selfDir;
     }
 
     /**
@@ -322,19 +351,27 @@ private static function getInstalled()
         }
 
         $installed = array();
+        $copiedLocalDir = false;
 
         if (self::$canGetVendors) {
+            $selfDir = self::getSelfDir();
             foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) {
+                $vendorDir = strtr($vendorDir, '\\', '/');
                 if (isset(self::$installedByVendor[$vendorDir])) {
                     $installed[] = self::$installedByVendor[$vendorDir];
                 } elseif (is_file($vendorDir.'/composer/installed.php')) {
                     /** @var array{root: array{name: string, pretty_version: string, version: string, reference: string|null, type: string, install_path: string, aliases: string[], dev: bool}, versions: array<string, array{pretty_version?: string, version?: string, reference?: string|null, type?: string, install_path?: string, aliases?: string[], dev_requirement: bool, replaced?: string[], provided?: string[]}>} $required */
                     $required = require $vendorDir.'/composer/installed.php';
-                    $installed[] = self::$installedByVendor[$vendorDir] = $required;
-                    if (null === self::$installed && strtr($vendorDir.'/composer', '\\', '/') === strtr(__DIR__, '\\', '/')) {
-                        self::$installed = $installed[count($installed) - 1];
+                    self::$installedByVendor[$vendorDir] = $required;
+                    $installed[] = $required;
+                    if (self::$installed === null && $vendorDir.'/composer' === $selfDir) {
+                        self::$installed = $required;
+                        self::$installedIsLocalDir = true;
                     }
                 }
+                if (self::$installedIsLocalDir && $vendorDir.'/composer' === $selfDir) {
+                    $copiedLocalDir = true;
+                }
             }
         }
 
@@ -350,7 +387,7 @@ private static function getInstalled()
             }
         }
 
-        if (self::$installed !== array()) {
+        if (self::$installed !== array() && !$copiedLocalDir) {
             $installed[] = self::$installed;
         }
 
diff --git a/vendor/composer/installed.php b/vendor/composer/installed.php
@@ -1,8 +1,8 @@
 <?php return array(
     'root' => array(
         'name' => 'bnomei/kirby3-fingerprint',
-        'pretty_version' => '5.0.0',
-        'version' => '5.0.0.0',
+        'pretty_version' => '5.1.0',
+        'version' => '5.1.0.0',
         'reference' => null,
         'type' => 'kirby-plugin',
         'install_path' => __DIR__ . '/../../',
@@ -11,8 +11,8 @@
     ),
     'versions' => array(
         'bnomei/kirby3-fingerprint' => array(
-            'pretty_version' => '5.0.0',
-            'version' => '5.0.0.0',
+            'pretty_version' => '5.1.0',
+            'version' => '5.1.0.0',
             'reference' => null,
             'type' => 'kirby-plugin',
             'install_path' => __DIR__ . '/../../',

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ public function __construct(array $options = [])`
`25`	`25`	`'integrity' => option('bnomei.fingerprint.integrity'),`
`26`	`26`	`'digest' => option('bnomei.fingerprint.digest'),`
`27`	`27`	`'https' => option('bnomei.fingerprint.https'),`
	`28`	`+ 'ignore-missing-auto' => option('bnomei.fingerprint.ignore-missing-auto'),`
`28`	`29`	`];`
`29`	`30`	`$this->options = array_merge($defaults, $options);`
`30`	`31`
`@@ -140,6 +141,8 @@ public function helper(string $extension, File\|FileVersion\|string $url, array $a`
`140`	`141`	`$assetUrl = Url::toTemplateAsset($extension.'/templates', $extension);`
`141`	`142`	`if ($assetUrl) {`
`142`	`143`	`$url = $assetUrl;`
	`144`	`+ } elseif (! $assetUrl && $this->option('ignore-missing-auto')) {`
	`145`	`+ return null;`
`143`	`146`	`}`
`144`	`147`	`}`
`145`	`148`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "bnomei/kirby3-fingerprint",`
`3`	`3`	`"type": "kirby-plugin",`
`4`		`- "version": "5.0.0",`
	`4`	`+ "version": "5.1.0",`
`5`	`5`	`"description": "File Method and css/js helper to add cache-busting hash and optional Subresource Integrity to file",`
`6`	`6`	`"license": "MIT",`
`7`	`7`	`"authors": [`
Original file line number	Diff line number	Diff line change
`@@ -14,10 +14,7 @@`
`14`	`14`	`echo $err;`
`15`	`15`	`}`
`16`	`16`	`}`
`17`		`- trigger_error(`
`18`		`- $err,`
`19`		`- E_USER_ERROR`
`20`		`- );`
	`17`	`+ throw new RuntimeException($err);`
`21`	`18`	`}`
`22`	`19`
`23`	`20`	`require_once __DIR__ . '/composer/autoload_real.php';`