💥 Automatically expose public properties and methods on View Composers (

#320)

* ✨ Automatically expose public properties and methods on View Composers
* 📝 Improve View Composer docblocks
* 🎨 Move the default ignored methods to a defaultExcept property
* 🎨 Define the except property inside of the Composer class
* 🚚 Rename `ExtractsClassAsVariables` to `Extractable`
* 🚚 Move the `Extractable` trait to `Roots\Acorn\View\Composers\Concerns`
* ♻️ Move `shouldIgnore` and `ignoredMethods` to the Composer class
* 🎨 Improve `defaultExcept` coverage
* 🎨 Use shorthanded functions in the Extractable trait where possible
* 🗑️ Remove deprecated call to `Roots\cache`
* 💥 Deprecate use of `$ignore` making use of the new `$except` Composer property
* 🧑‍💻 Reject static methods when mapping class to an array
* 🧑‍💻 Wrap the View Composer `Arrayable` trait `toArray()` method call in a try/catch statement
* 📝 Improve the `Arrayable` docblock
* 💡 Add copyright notice

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

@@ -114,7 +114,7 @@ public function base64()
      *
      * @param  string  $mediatype MIME content type
      */
-    public function dataUrl(string $mediatype = null): string
+    public function dataUrl(?string $mediatype = null): string
     {
         if ($this->dataUrl) {
             return $this->dataUrl;
@@ -132,7 +132,7 @@ public function dataUrl(string $mediatype = null): string
      *
      * @param  string  $mediatype MIME content type
      */
-    public function dataUri(string $mediatype = null): string
+    public function dataUri(?string $mediatype = null): string
     {
         return $this->dataUrl($mediatype);
     }

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

@@ -40,7 +40,7 @@ public function charset($fallback = 'UTF-8'): string
      * @param  string  $charset Character encoding
      * @param  string  $urlencode List of characters to be percent-encoded
      */
-    public function dataUrl(string $mediatype = null, string $charset = null, string $urlencode = '%\'"'): string
+    public function dataUrl(?string $mediatype = null, ?string $charset = null, string $urlencode = '%\'"'): string
     {
         if ($this->dataUrl) {
             return $this->dataUrl;
@@ -72,7 +72,7 @@ public function dataUrl(string $mediatype = null, string $charset = null, string
      * @param  string  $charset Character encoding
      * @param  string  $urlencode List of characters to be percent-encoded
      */
-    public function dataUri(string $mediatype = null, string $charset = null, string $urlencode = '%\'"'): string
+    public function dataUri(?string $mediatype = null, ?string $charset = null, string $urlencode = '%\'"'): string
     {
         return $this->dataUrl($mediatype, $charset, $urlencode);
     }

src/Roots/Acorn/Assets/AssetFactory.php

@@ -17,7 +17,7 @@ class AssetFactory
      * @param  string  $uri Remote URI
      * @param  string  $type Asset type
      */
-    public static function create(string $path, string $uri, string $type = null): AssetContract
+    public static function create(string $path, string $uri, ?string $type = null): AssetContract
     {
         if (! $type) {
             $type = pathinfo($path, PATHINFO_EXTENSION);

src/Roots/Acorn/Assets/Bundle.php

@@ -44,7 +44,7 @@ public function __construct(string $id, array $bundle, string $path, string $uri
      *
      * @return Collection|$this
      */
-    public function css(callable $callable = null)
+    public function css(?callable $callable = null)
     {
         $styles = $this->conditional ? $this->bundle['css'] : [];
 
@@ -67,7 +67,7 @@ public function css(callable $callable = null)
      *
      * @return Collection|$this
      */
-    public function js(callable $callable = null)
+    public function js(?callable $callable = null)
     {
         $scripts = $this->conditional ? array_merge($this->bundle['js'], $this->bundle['mjs']) : [];
 

src/Roots/Acorn/Assets/Concerns/Enqueuable.php

@@ -18,7 +18,7 @@ trait Enqueuable
      *
      * @return Collection|$this
      */
-    abstract public function js(callable $callable = null);
+    abstract public function js(?callable $callable = null);
 
     /**
      * Get CSS files in bundle.
@@ -27,7 +27,7 @@ abstract public function js(callable $callable = null);
      *
      * @return Collection|$this
      */
-    abstract public function css(callable $callable = null);
+    abstract public function css(?callable $callable = null);
 
     abstract public function runtime();
 

src/Roots/Acorn/Assets/Manager.php

@@ -66,7 +66,7 @@ public function register(string $name, ManifestContract $manifest): self
     /**
      * Get a Manifest
      */
-    public function manifest(string $name, array $config = null): ManifestContract
+    public function manifest(string $name, ?array $config = null): ManifestContract
     {
         $manifest = $this->manifests[$name] ?? $this->resolve($name, $config);
 

src/Roots/Acorn/Assets/Manifest.php

@@ -17,7 +17,7 @@ class Manifest implements ManifestContract
 
     protected $uri;
 
-    public function __construct(string $path, string $uri, array $assets = [], array $bundles = null)
+    public function __construct(string $path, string $uri, array $assets = [], ?array $bundles = null)
     {
         $this->path = $path;
         $this->uri = $uri;

src/Roots/Acorn/Assets/Middleware/RootsBudMiddleware.php

@@ -13,7 +13,7 @@ class RootsBudMiddleware
      */
     protected $dev_origin;
 
-    public function __construct(string $dev_origin = null)
+    public function __construct(?string $dev_origin = null)
     {
         $this->dev_origin = $dev_origin;
     }

src/Roots/Acorn/Bootloader.php

@@ -60,15 +60,15 @@ public static function setInstance(?self $bootloader)
      *
      * @return static
      */
-    public static function getInstance(ApplicationContract $app = null)
+    public static function getInstance(?ApplicationContract $app = null)
     {
         return static::$instance ??= new static($app);
     }
 
     /**
      * Create a new bootloader instance.
      */
-    public function __construct(ApplicationContract $app = null, Filesystem $files = null)
+    public function __construct(?ApplicationContract $app = null, ?Filesystem $files = null)
     {
         $this->app = $app;
         $this->files = $files ?? new Filesystem;

src/Roots/Acorn/DefaultProviders.php

@@ -25,7 +25,7 @@ class DefaultProviders extends DefaultProvidersBase
      *
      * @return void
      */
-    public function __construct(array $providers = null)
+    public function __construct(?array $providers = null)
     {
         parent::__construct($providers);
 

src/Roots/Acorn/Exceptions/SkipProviderException.php

@@ -12,7 +12,7 @@ class SkipProviderException extends InvalidArgumentException
      *
      * @return void
      */
-    public function __construct(string $message = '', int $code = 0, Throwable $previous = null, string $package = '')
+    public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null, string $package = '')
     {
         parent::__construct($message, $code, $previous);
 

src/Roots/Acorn/View/Composer.php

@@ -5,32 +5,56 @@
 use Illuminate\Support\Fluent;
 use Illuminate\Support\Str;
 use Illuminate\View\View;
+use Roots\Acorn\View\Composers\Concerns\Extractable;
 
 abstract class Composer
 {
+    use Extractable;
+
     /**
-     * List of views to receive data by this composer
+     * The list of views served by this composer.
      *
      * @var string[]
      */
     protected static $views;
 
     /**
-     * Current view
+     * The current view instance.
      *
-     * @var View
+     * @var \Illuminate\View\View
      */
     protected $view;
 
     /**
-     * Current view data
+     * The current view data.
      *
-     * @var Fluent
+     * @var \Illuminate\Support\Fluent
      */
     protected $data;
 
     /**
-     * List of views served by this composer
+     * The properties / methods that should not be exposed.
+     *
+     * @var array
+     */
+    protected $except = [];
+
+    /**
+     * The default properties / methods that should not be exposed.
+     *
+     * @var array
+     */
+    protected $defaultExcept = [
+        'cache',
+        'compose',
+        'override',
+        'toArray',
+        'views',
+        'with',
+    ];
+
+    /**
+     * The list of views served by this composer.
      *
      * @return string|string[]
      */
@@ -60,12 +84,20 @@ public function compose(View $view)
     }
 
     /**
-     * Data to be merged and passed to the view before rendering.
+     * The merged data to be passed to view before rendering.
      *
      * @return array
      */
     protected function merge()
     {
+        if (! $this->with() && ! $this->override()) {
+            return array_merge(
+                $this->extractPublicProperties(),
+                $this->extractPublicMethods(),
+                $this->view->getData()
+            );
+        }
+
         return array_merge(
             $this->with(),
             $this->view->getData(),
@@ -74,7 +106,7 @@ protected function merge()
     }
 
     /**
-     * Data to be passed to view before rendering
+     * The data passed to the view before rendering.
      *
      * @return array
      */
@@ -84,12 +116,34 @@ protected function with()
     }
 
     /**
-     * Data to be passed to view before rendering
+     * The override data passed to the view before rendering.
      *
      * @return array
      */
     protected function override()
     {
         return [];
     }
+
+    /**
+     * Determine if the given property / method should be ignored.
+     *
+     * @param  string  $name
+     * @return bool
+     */
+    protected function shouldIgnore($name)
+    {
+        return str_starts_with($name, '__') ||
+            in_array($name, $this->ignoredMethods());
+    }
+
+    /**
+     * Get the methods that should be ignored.
+     *
+     * @return array
+     */
+    protected function ignoredMethods()
+    {
+        return array_merge($this->defaultExcept, $this->except);
+    }
 }

src/Roots/Acorn/View/Composers/Concerns/Arrayable.php

@@ -6,37 +6,29 @@
 use Illuminate\Support\Str;
 use ReflectionClass;
 use ReflectionMethod;
+use Throwable;
 
 trait Arrayable
 {
     /**
-     * Ignored Methods
-     *
-     * @var string[]
-     */
-    protected $ignore = [];
-
-    /**
-     * Maps available class methods to an array.
+     * Map the public class methods to an array.
      *
      * @return array
      */
     public function toArray()
     {
         return collect((new ReflectionClass(static::class))->getMethods(ReflectionMethod::IS_PUBLIC))
-            ->filter(fn ($method) => ! in_array(
-                $method->name,
-                array_merge(
-                    $this->ignore,
-                    ['compose', 'toArray', 'with', 'views', 'override']
-                )
-            ))
-            ->filter(fn ($method) => ! Str::startsWith($method->name, ['__', 'cache']))
+            ->reject(fn ($method) => $this->shouldIgnore($method->name) || $method->isStatic())
             ->mapWithKeys(function ($method) {
-                $data = $this->{$method->name}();
+                try {
+                    $data = $this->{$method->name}();
 
-                return [Str::snake($method->name) => is_array($data) ? new Fluent($data) : $data];
+                    return [Str::snake($method->name) => is_array($data) ? new Fluent($data) : $data];
+                } catch (Throwable) {
+                    return [];
+                }
             })
+            ->filter()
             ->all();
     }
 }

src/Roots/Acorn/View/Composers/Concerns/Cacheable.php

@@ -5,8 +5,6 @@
 use BadMethodCallException;
 use Illuminate\Support\Facades\Cache;
 
-use function Roots\cache;
-
 trait Cacheable
 {
     /**