♻ add separate methods for loading php assets, deprecate load() method

Author: QWp6t

src/Roots/Acorn/Assets/Asset/PhpAsset.php

@@ -9,22 +9,77 @@ class PhpAsset extends Asset
     /**
      * Get the returned value of the asset
      *
+     * @deprecated since 2.1.2. Use require(), requireOnce(), include() or includeOnce() instead.
+     *
+     * @param  bool $require
+     * @param  bool $once
      * @return mixed
      */
     public function load($require = false, $once = false)
     {
-        if (! $this->exists()) {
-            throw new FileNotFoundException("Asset [{$this->path()}] not found.");
-        }
-
         if ($require) {
             return $once
-                ? require_once $this->path()
-                : require $this->path();
+                ? $this->requireOnce()
+                : $this->require();
         }
 
         return $once
-            ? include_once $this->path()
-            : include $this->path();
+            ? $this->includeOnce()
+            : $this->include();
+    }
+
+    /**
+     * Get the returned value of the asset
+     *
+     * @return mixed
+     */
+    public function requireOnce()
+    {
+        $this->assertExists();
+        return require_once $this->path();
+    }
+
+    /**
+     * Get the returned value of the asset
+     *
+     * @return mixed
+     */
+    public function require()
+    {
+        $this->assertExists();
+        return require $this->path();
+    }
+
+    /**
+     * Get the returned value of the asset
+     *
+     * @return mixed
+     */
+    public function includeOnce()
+    {
+        $this->assertExists();
+        return include_once $this->path();
+    }
+
+    /**
+     * Get the returned value of the asset
+     *
+     * @return mixed
+     */
+    public function include()
+    {
+        $this->assertExists();
+        return include $this->path();
+    }
+
+    /**
+     * Assert that the asset exists.
+     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
+     */
+    protected function assertExists()
+    {
+        if (! $this->exists()) {
+            throw new FileNotFoundException("Asset [{$this->path()}] not found.");
+        }
     }
 }

tests/Assets/AssetTest.php

@@ -55,23 +55,30 @@
 });
 
 it('can include a php asset', function () {
-    assertMatchesSnapshot($this->assets->asset('bnif.php')->load());
+    assertMatchesSnapshot($this->assets->asset('bnif.php')->include());
 });
 
 it('can include_once a php asset', function () {
-    assertMatchesSnapshot($this->assets->asset('bnif.php')->load(false, true));
+    assertMatchesSnapshot($this->assets->asset('bnif.php')->includeOnce());
 });
 
 it('can require a php asset', function () {
-    assertMatchesSnapshot($this->assets->asset('bnif.php')->load(true));
+    assertMatchesSnapshot($this->assets->asset('bnif.php')->require());
 });
 
 it('can require_once a php asset', function () {
+    assertMatchesSnapshot($this->assets->asset('bnif.php')->requireOnce());
+});
+
+it('can load a php asset', function () {
+    assertMatchesSnapshot($this->assets->asset('bnif.php')->load(false, false));
+    assertMatchesSnapshot($this->assets->asset('bnif.php')->load(false, true));
+    assertMatchesSnapshot($this->assets->asset('bnif.php')->load(true, false));
     assertMatchesSnapshot($this->assets->asset('bnif.php')->load(true, true));
 });
 
-it('can fail to load a php asset', function () {
-    (new PhpAsset(temp('does/not/exist.php'), 'https://kjo.kjo/'))->load();
+it('can fail to include a php asset', function () {
+    (new PhpAsset(temp('does/not/exist.php'), 'https://kjo.kjo/'))->include();
 })->throws(FileNotFoundException::class);
 
 it('can get a relative path', function () {

tests/__snapshots__/AssetTest__it_can_include_once_a_php_asset__1.txt

@@ -0,0 +1 @@
+bnif

tests/__snapshots__/AssetTest__it_can_load_a_php_asset__2.yml

@@ -0,0 +1 @@
+true

tests/__snapshots__/AssetTest__it_can_load_a_php_asset__3.txt

@@ -0,0 +1 @@
+bnif

tests/__snapshots__/AssetTest__it_can_load_a_php_asset__4.yml

@@ -0,0 +1 @@
+true