Feature: Access named counter values

docs/usage/framework-agnostic-php-project.md

@@ -151,6 +151,18 @@ foreach (range(1, 4) as $i) {
 }
 ```
 
+You may access the value of a named counter using the  `counterValue` function.
+
+```php
+foreach (range(1, 4) as $i) {
+    ray()->count('first');
+
+    if (ray()->counterValue('first') === 2) {
+        echo "counter value is two!";
+    }
+}
+```
+
 This is how that looks like in Ray.
 
 ![screenshot](/docs/ray/v1/images/named-count.png)

docs/usage/reference.md

@@ -38,6 +38,7 @@ To display something in Ray use the `ray()` function. It accepts everything: str
 | `ray()->clearScreen()` | Clear current screen |
 | `ray()->clearAll()` | Clear current and all previous screens |
 | `ray()->count()` | Count how many times a piece of code is called |
+| `ray()->counterValue(name)` | Return the value of a named counter |
 | `ray(…)->die()` or `rd(…)` | Stop the PHP process |
 | `ray()->disable()` | Disable sending stuff to Ray |
 | `ray()->disabled()` | Check if Ray is disabled |

src/Ray.php

@@ -414,6 +414,11 @@ public function clearCounters(): self
         return $this;
     }
 
+    public function counterValue(string $name): int
+    {
+        return self::$counters->get($name);
+    }
+
     public function pause(): self
     {
         $lockName = md5(time());

tests/RayTest.php

@@ -760,6 +760,20 @@ public function it_clears_all_counters()
         $this->assertEquals(0, Ray::$counters->get('first'));
     }
 
+    /** @test */
+    public function it_returns_the_value_of_a_named_counter()
+    {
+        $this->assertEquals(0, ray()->counterValue('first'));
+
+        ray()->count('first');
+
+        $this->assertEquals(1, ray()->counterValue('first'));
+
+        ray()->count('first');
+
+        $this->assertEquals(2, ray()->counterValue('first'));
+    }
+
     /** @test */
     public function it_will_respect_the_raw_values_config_setting()
     {