Rename Item to Pipe

Author: sebastiaanluca

README.md

@@ -17,14 +17,14 @@
 
 - [Requirements](#requirements)
 - [How to install](#how-to-install)
-- [What does it solve?](#what-does-it-solve)
-    - [A simple example](#a-simple-example)
-    - [Another way of writing](#another-way-of-writing)
-    - [More examples of the issue at hand](#more-examples-of-the-issue-at-hand)
 - [How to use](#how-to-use)
     - [The basics](#the-basics)
     - [Using closures](#using-closures)
     - [Using class methods](#using-class-methods)
+- [What does it solve?](#what-does-it-solve)
+    - [A simple example](#a-simple-example)
+    - [Another way of writing](#another-way-of-writing)
+    - [More examples of the issue at hand](#more-examples-of-the-issue-at-hand)
 - [Notes](#notes)
 - [License](#license)
 - [Change log](#change-log)
@@ -46,45 +46,6 @@ Via Composer:
 composer require sebastiaanluca/php-pipe-operator
 ```
 
-## What does it solve?
-
-This package is based on the [pipe operator RFC by Sara Golemon (2016)](https://wiki.php.net/rfc/pipe-operator), who explains the problem as:
-
->A common PHP OOP pattern is the use of method chaining, or what is also known as “Fluent Expressions”. […] This works well enough for OOP classes which were designed for fluent calling, however it is impossible, or at least unnecessarily arduous, to adapt non-fluent classes to this usage style, harder still for functional interfaces.
-
-Coming across the proposal, I also [blogged about it](https://blog.sebastiaanluca.com/enabling-php-method-chaining-with-a-makeshift-pipe-operator).
-
-### A simple example
-
-Say you want to get the subdomain from a URL, you end up with something like this:
-
-```php
-$subdomain = 'https://blog.sebastiaanluca.com/';
-$subdomain = parse_url($subdomain, PHP_URL_HOST);
-$subdomain = explode('.', $subdomain);
-$subdomain = reset($subdomain);
-
-// "blog"
-```
-
-This works, of course, but it's quite verbose and repetitive.
-
-### Another way of writing
-
-Same result, different style:
-
-```php
-$subdomain = explode('.', parse_url('https://blog.sebastiaanluca.com/', PHP_URL_HOST))[0];
-
-// "blog"
-```
-
-This might be the worst of all solutions, as it requires you to start reading from the center, work your way towards the outer methods, and keep switching back and forth. The more methods and variants, the more difficult to get a sense of what's going on.
-
-### More examples of the issue at hand
-
-See [Sara's RFC](https://wiki.php.net/rfc/pipe-operator#introduction) for more complex and real-world examples.
-
 ## How to use
 
 ### The basics
@@ -230,6 +191,45 @@ class MyClass
 }
 ```
 
+## What does it solve?
+
+This package is based on the [pipe operator RFC by Sara Golemon (2016)](https://wiki.php.net/rfc/pipe-operator), who explains the problem as:
+
+>A common PHP OOP pattern is the use of method chaining, or what is also known as “Fluent Expressions”. […] This works well enough for OOP classes which were designed for fluent calling, however it is impossible, or at least unnecessarily arduous, to adapt non-fluent classes to this usage style, harder still for functional interfaces.
+
+Coming across the proposal, I also [blogged about it](https://sebastiaanluca.com/blog/enabling-php-method-chaining-with-a-makeshift-pipe-operator).
+
+### A simple example
+
+Say you want to get the subdomain from a URL, you end up with something like this:
+
+```php
+$subdomain = 'https://blog.sebastiaanluca.com/';
+$subdomain = parse_url($subdomain, PHP_URL_HOST);
+$subdomain = explode('.', $subdomain);
+$subdomain = reset($subdomain);
+
+// "blog"
+```
+
+This works, of course, but it's quite verbose and repetitive.
+
+### Another way of writing
+
+Same result, different style:
+
+```php
+$subdomain = explode('.', parse_url('https://blog.sebastiaanluca.com/', PHP_URL_HOST))[0];
+
+// "blog"
+```
+
+This might be the worst of all solutions, as it requires you to start reading from the center, work your way towards the outer methods, and keep switching back and forth. The more methods and variants, the more difficult to get a sense of what's going on.
+
+### More examples of the issue at hand
+
+See [Sara's RFC](https://wiki.php.net/rfc/pipe-operator#introduction) for more complex and real-world examples.
+
 ## Notes
 
 While this packages makes a good attempt at bringing the pipe operator to PHP, it unfortunately does not offer autocompletion on chained methods. For that to work we need the real deal, so make some noise and get the people in charge to vote *for* Sara's RFC!

src/Item.php src/Pipe.phpsrc/Item.php renamed to src/Pipe.php

@@ -2,7 +2,7 @@
 
 namespace SebastiaanLuca\PipeOperator;
 
-class Item
+class Pipe
 {
     protected mixed $value;
 

src/PipeProxy.php

@@ -6,16 +6,16 @@
 
 class PipeProxy
 {
-    protected Item $item;
+    protected Pipe $item;
     protected object $object;
 
-    public function __construct(Item $item, object $object)
+    public function __construct(Pipe $item, object $object)
     {
         $this->item = $item;
         $this->object = $object;
     }
 
-    public function __call(string $method, array $arguments): Item
+    public function __call(string $method, array $arguments): Pipe
     {
         $callback = Closure::bind(function (...$arguments) use ($method) {
             return $this->{$method}(...$arguments);

src/functions.php

@@ -1,13 +1,13 @@
 <?php
 
-use SebastiaanLuca\PipeOperator\Item;
+use SebastiaanLuca\PipeOperator\Pipe;
 
 if (! function_exists('take')) {
     /**
      * Create a new piped item from a given value.
      */
-    function take(mixed $value): Item
+    function take(mixed $value): Pipe
     {
-        return new Item($value);
+        return new Pipe($value);
     }
 }

tests/Unit/MethodsTest.php

@@ -4,7 +4,7 @@
 
 use Closure;
 use PHPUnit\Framework\TestCase;
-use SebastiaanLuca\PipeOperator\Item;
+use SebastiaanLuca\PipeOperator\Pipe;
 
 class MethodsTest extends TestCase
 {
@@ -13,7 +13,7 @@ class MethodsTest extends TestCase
      */
     public function it can transform using the static constructor(): void
     {
-        $result = Item::from('https://blog.github.com')
+        $result = Pipe::from('https://blog.github.com')
             ->parse_url()
             ->end()
             ->explode('.', PIPED_VALUE)

tests/Unit/ObjectTest.php

@@ -3,7 +3,7 @@
 namespace SebastiaanLuca\PipeOperator\Tests\Unit\Classes;
 
 use PHPUnit\Framework\TestCase;
-use SebastiaanLuca\PipeOperator\Item;
+use SebastiaanLuca\PipeOperator\Pipe;
 
 class ObjectTest extends TestCase
 {
@@ -13,7 +13,7 @@ class ObjectTest extends TestCase
     public function it returns an item object when get has not been called yet(): void
     {
         $this->assertInstanceOf(
-            Item::class,
+            Pipe::class,
             take('string')->pipe('strtoupper')
         );
     }
@@ -24,7 +24,7 @@ public function it returns an item object when get has not been called
     public function it returns an item object when get has not been called yet using the method directly(): void
     {
         $this->assertInstanceOf(
-            Item::class,
+            Pipe::class,
             take('string')->strtoupper()
         );
     }