Add docblocks & minor cleanup

src/Illuminate/Testing/Fluent/Assert.php

@@ -19,19 +19,39 @@ class Assert implements Arrayable
         Macroable,
         Tappable;
 
-    /** @var array */
+    /**
+     * The properties in the current scope.
+     *
+     * @var array
+     */
     private $props;
 
-    /** @var string */
+    /**
+     * The "dot" path to the current scope.
+     *
+     * @var string|null
+     */
     private $path;
 
+    /**
+     * Create a new Assert instance.
+     *
+     * @param  array  $props
+     * @param  string|null  $path
+     */
     protected function __construct(array $props, string $path = null)
     {
         $this->path = $path;
         $this->props = $props;
     }
 
-    protected function dotPath($key): string
+    /**
+     * Compose the absolute "dot" path to the given key.
+     *
+     * @param  string  $key
+     * @return string
+     */
+    protected function dotPath(string $key): string
     {
         if (is_null($this->path)) {
             return $key;
@@ -40,12 +60,25 @@ protected function dotPath($key): string
         return implode('.', [$this->path, $key]);
     }
 
+    /**
+     * Retrieve a prop within the current scope using "dot" notation.
+     *
+     * @param  string|null  $key
+     * @return mixed
+     */
     protected function prop(string $key = null)
     {
         return Arr::get($this->props, $key);
     }
 
-    protected function scope($key, Closure $callback): self
+    /**
+     * Instantiate a new "scope" at the path of the given key.
+     *
+     * @param  string  $key
+     * @param  Closure  $callback
+     * @return $this
+     */
+    protected function scope(string $key, Closure $callback): self
     {
         $props = $this->prop($key);
         $path = $this->dotPath($key);
@@ -59,16 +92,33 @@ protected function scope($key, Closure $callback): self
         return $this;
     }
 
+    /**
+     * Create a new instance from an array.
+     *
+     * @param  array  $data
+     * @return static
+     */
     public static function fromArray(array $data): self
     {
         return new self($data);
     }
 
+    /**
+     * Create a new instance from a AssertableJsonString.
+     *
+     * @param  AssertableJsonString  $json
+     * @return static
+     */
     public static function fromAssertableJsonString(AssertableJsonString $json): self
     {
         return self::fromArray($json->json());
     }
 
+    /**
+     * Get the instance as an array.
+     *
+     * @return array
+     */
     public function toArray()
     {
         return $this->props;

src/Illuminate/Testing/Fluent/Concerns/Debugging.php

@@ -4,17 +4,35 @@
 
 trait Debugging
 {
+    /**
+     * Dumps the given props.
+     *
+     * @param  string|null  $prop
+     * @return $this
+     */
     public function dump(string $prop = null): self
     {
         dump($this->prop($prop));
 
         return $this;
     }
 
+    /**
+     * Dumps the given props and exits.
+     *
+     * @param  string|null  $prop
+     * @return void
+     */
     public function dd(string $prop = null): void
     {
         dd($this->prop($prop));
     }
 
+    /**
+     * Retrieve a prop within the current scope using "dot" notation.
+     *
+     * @param  string|null  $key
+     * @return mixed
+     */
     abstract protected function prop(string $key = null);
 }

src/Illuminate/Testing/Fluent/Concerns/Has.php

@@ -8,7 +8,14 @@
 
 trait Has
 {
-    protected function count(string $key, $length): self
+    /**
+     * Assert that the prop is of the expected size.
+     *
+     * @param  string  $key
+     * @param  int  $length
+     * @return $this
+     */
+    protected function count(string $key, int $length): self
     {
         PHPUnit::assertCount(
             $length,
@@ -19,21 +26,14 @@ protected function count(string $key, $length): self
         return $this;
     }
 
-    public function hasAll($key): self
-    {
-        $keys = is_array($key) ? $key : func_get_args();
-
-        foreach ($keys as $prop => $count) {
-            if (is_int($prop)) {
-                $this->has($count);
-            } else {
-                $this->has($prop, $count);
-            }
-        }
-
-        return $this;
-    }
-
+    /**
+     * Ensure that the given prop exists.
+     *
+     * @param  string  $key
+     * @param  null  $value
+     * @param  Closure|null  $scope
+     * @return $this
+     */
     public function has(string $key, $value = null, Closure $scope = null): self
     {
         $prop = $this->prop();
@@ -69,6 +69,33 @@ public function has(string $key, $value = null, Closure $scope = null): self
         return $this;
     }
 
+    /**
+     * Assert that all of the given props exist.
+     *
+     * @param  array|string $key
+     * @return $this
+     */
+    public function hasAll($key): self
+    {
+        $keys = is_array($key) ? $key : func_get_args();
+
+        foreach ($keys as $prop => $count) {
+            if (is_int($prop)) {
+                $this->has($count);
+            } else {
+                $this->has($prop, $count);
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * Assert that none of the given props exist.
+     *
+     * @param  array|string $key
+     * @return $this
+     */
     public function missingAll($key): self
     {
         $keys = is_array($key) ? $key : func_get_args();
@@ -80,6 +107,12 @@ public function missingAll($key): self
         return $this;
     }
 
+    /**
+     * Assert that the given prop does not exist.
+     *
+     * @param  string  $key
+     * @return $this
+     */
     public function missing(string $key): self
     {
         PHPUnit::assertNotTrue(
@@ -90,11 +123,36 @@ public function missing(string $key): self
         return $this;
     }
 
-    abstract protected function prop(string $key = null);
-
-    abstract protected function dotPath($key): string;
-
+    /**
+     * Compose the absolute "dot" path to the given key.
+     *
+     * @param  string  $key
+     * @return string
+     */
+    abstract protected function dotPath(string $key): string;
+
+    /**
+     * Marks the property as interacted.
+     *
+     * @param  string  $key
+     * @return void
+     */
     abstract protected function interactsWith(string $key): void;
 
-    abstract protected function scope($key, Closure $callback);
+    /**
+     * Retrieve a prop within the current scope using "dot" notation.
+     *
+     * @param  string|null  $key
+     * @return mixed
+     */
+    abstract protected function prop(string $key = null);
+
+    /**
+     * Instantiate a new "scope" at the path of the given key.
+     *
+     * @param  string  $key
+     * @param  Closure  $callback
+     * @return $this
+     */
+    abstract protected function scope(string $key, Closure $callback);
 }

src/Illuminate/Testing/Fluent/Concerns/Interaction.php

@@ -7,9 +7,19 @@
 
 trait Interaction
 {
-    /** @var array */
+    /**
+     * The list of interacted properties.
+     *
+     * @var array
+     */
     protected $interacted = [];
 
+    /**
+     * Marks the property as interacted.
+     *
+     * @param  string  $key
+     * @return void
+     */
     protected function interactsWith(string $key): void
     {
         $prop = Str::before($key, '.');
@@ -19,6 +29,11 @@ protected function interactsWith(string $key): void
         }
     }
 
+    /**
+     * Asserts that all properties have been interacted with.
+     *
+     * @return void
+     */
     public function interacted(): void
     {
         PHPUnit::assertSame(
@@ -30,12 +45,23 @@ public function interacted(): void
         );
     }
 
+    /**
+     * Disables the interaction check.
+     *
+     * @return $this
+     */
     public function etc(): self
     {
         $this->interacted = array_keys($this->prop());
 
         return $this;
     }
 
+    /**
+     * Retrieve a prop within the current scope using "dot" notation.
+     *
+     * @param  string|null  $key
+     * @return mixed
+     */
     abstract protected function prop(string $key = null);
 }