Added "unbreakable punctuation" & "hellip" base typographic rules.

Author: toonvandenbos

src/ServiceProvider.php

@@ -3,6 +3,8 @@
 namespace Whitecube\Strings;
 
 use Illuminate\Support\ServiceProvider as Provider;
+use Illuminate\Support\Str;
+use Illuminate\Support\Stringable;
 
 class ServiceProvider extends Provider
 {
@@ -11,12 +13,28 @@ class ServiceProvider extends Provider
      */
     public function register()
     {
+        Typography::rule(
+            key: 'unbreakable-punctuation',
+            regex: '/(?:(?: )|\s)+([:!?;])/',
+            callback: fn(array $matches) => ' '.$matches[1],
+        );
+        Typography::rule(
+            key: 'hellip',
+            regex: '/(?:(?:\&\#8230\;)|(?:\&\#x2026\;)|(?:\.\.\.)|\…)/',
+            callback: fn(array $matches) => '…',
+        );
     }
 
     /**
      * Bootstrap the application services.
      */
     public function boot()
     {
+        Str::macro('typography', function (string $value) {
+            return (new Typography($value))->handle();
+        });
+        Stringable::macro('typography', function () {
+            return new static(Str::typography($this->value));
+        });
     }
 }

src/Typography.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Whitecube\Strings;
+
+use Closure;
+
+class Typography
+{
+    /**
+     * The provided string to transform.
+     */
+    protected string $value;
+
+    /**
+     * The provided string to transform.
+     */
+    protected static array $handlers = [];
+
+    /**
+     * Add a typographic rule handler.
+     */
+    static public function rule(string $key, string $regex, Closure $callback): void
+    {
+        static::$handlers[$key] = [$regex, $callback];
+    }
+
+    /**
+     * Remove a typographic rule handler.
+     */
+    static public function remove(string $key): void
+    {
+        if(isset(static::$handlers[$key])) {
+            unset(static::$handlers[$key]);
+        }
+    }
+
+    /**
+     * Remove a typographic rule handler.
+     */
+    static protected function getHandlers(): array
+    {
+        return array_reduce(static::$handlers, function($all, $handler) {
+            [$regex, $callback] = $handler;
+            $all[$regex] = $callback;
+            return $all;
+        }, []);
+    }
+
+    /**
+     * Create a new Typography transformer instance
+     */
+    public function __construct(string $value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * Run the value transformations.
+     */
+    public function handle(): string
+    {
+        return preg_replace_callback_array(
+            static::getHandlers(),
+            $this->value
+        );
+    }
+}

tests/Feature/TypographyTest.php

@@ -0,0 +1,42 @@
+<?php
+
+use Whitecube\Strings\ServiceProvider;
+
+it('can load ServiceProvider correctly', function() {
+    expect(app()->providerIsLoaded(ServiceProvider::class))->toBeTrue();
+});
+
+it('can replace breakable spaces in front of punctuation marks', function() {
+    $cases = [
+        '<p>This string contains a breakable exclamation ! And an unbreakable one too! Even a weird one &nbsp; ! Foo.</p>',
+        '<p>This string contains a breakable question ? And an unbreakable one too? Even a weird one &nbsp; ? Foo.</p>',
+        '<p>This string contains a breakable colon : And an unbreakable one too: Even a weird one &nbsp; : Foo.</p>',
+        '<p>This string contains a breakable semicolon ; And an unbreakable one too; Even a weird one &nbsp; ; Foo.</p>',
+    ];
+
+    $expectations = [
+        '<p>This string contains a breakable exclamation&nbsp;! And an unbreakable one too! Even a weird one&nbsp;! Foo.</p>',
+        '<p>This string contains a breakable question&nbsp;? And an unbreakable one too? Even a weird one&nbsp;? Foo.</p>',
+        '<p>This string contains a breakable colon&nbsp;: And an unbreakable one too: Even a weird one&nbsp;: Foo.</p>',
+        '<p>This string contains a breakable semicolon&nbsp;; And an unbreakable one too; Even a weird one&nbsp;; Foo.</p>',
+    ];
+
+    foreach ($cases as $i => $value) {
+        expect((string) str($value)->typography())->toBe($expectations[$i]);
+    }
+});
+
+it('can replace horizontal ellipsises with according HTML entity', function() {
+    $cases = [
+        '<p>This string&#8230; contains an &#8230; ellipsis &#8230;at multiple locations&#8230;</p>',
+        '<p>This string&#x2026; contains an &#x2026; ellipsis &#x2026;at multiple locations&#x2026;</p>',
+        '<p>This string... contains an ... ellipsis ...at multiple locations...</p>',
+        '<p>This string… contains an … ellipsis …at multiple locations…</p>',
+    ];
+
+    $expectation = '<p>This string&hellip; contains an &hellip; ellipsis &hellip;at multiple locations&hellip;</p>';
+
+    foreach ($cases as $value) {
+        expect((string) str($value)->typography())->toBe($expectation);
+    }
+});

tests/Pest.php

@@ -11,7 +11,7 @@
 |
 */
 
-uses(\Whitecube\Strings\Tests\TestCase::class)->in('Unit');
+uses(\Whitecube\Strings\Tests\TestCase::class)->in('Feature');
 
 /*
 |--------------------------------------------------------------------------