Utility and TextSanitizer class added

Author: tamedevelopers

README.md

@@ -81,7 +81,24 @@ Support Package For PHP and Laravel
     * [last](#last)
 * [TextSanitizer](#TextSanitizer)
     * [Usage](#sanitizer-usage)
-    * [phone](#phone)
+    * [phoneInt](#phoneInt)
+    * [phoneWords](#phoneWords)
+    * [url](#sanitize-url)
+    * [email](#sanitize-email)
+    * [mention](#sanitize-mention)
+    * [hastag](#sanitize-hastag)
+    * [sanitize](#sanitize)
+    * [findPhoneWords](#findPhoneWords)
+* [Utility](#Utility)
+    * [Usage](#utility-usage)
+    * [phoneInt](#phoneInt)
+    * [phoneWords](#phoneWords)
+    * [url](#sanitize-url)
+    * [email](#sanitize-email)
+    * [mention](#sanitize-mention)
+    * [hastag](#sanitize-hastag)
+    * [sanitize](#sanitize)
+    * [findPhoneWords](#findPhoneWords)
 * [Country](#country)
     * [Usage](#country-usage)
     * [iso3](#country-iso3)
@@ -609,6 +626,91 @@ Str::encrypt('secret');                            // encrypted
 Str::decrypt('...');                               // original
 ```
 
+## TextSanitizer
+- The Core Class For String Sanitizer
+    - It's helper class can be called, using -- `TameSanitizer()`
+
+### Sanitizer Usage
+```php
+use Tamedevelopers\Support\TextSanitizer;
+
+$text = "My number is 0812300089 and another is zero eight one two three four five six seven.
+Visit https://x.com google.com or mail me at [email protected] +23400000209
+I love #coding with @friends. I also have two cats. 11092092-3";
+
+$text2 = "I'm a beautiful zero nine zero and sweet in seven five seven eight available from ";
+$text3 = "Reach me on zero eight one double two 555 nine or 0812220000";
+$text4 = "Visit https://x.com google.com or mail me at [email protected] @username.com. +23400";
+
+
+$sanitizer->phoneInt($text);        // 
+$sanitizer->phoneWords($text2);     // I'm a beautiful [phone] available from 
+$sanitizer->phoneWords($text3);     // Reach me on [phone]
+$sanitizer->url($text4);            // Visit [url] [url] or mail me at [email protected] @username.com. +23400
+$sanitizer->email($text4);          // Visit https://x.com google.com or mail me at [email] @username.com. +23400
+$sanitizer->mention($text4);        // Visit https://x.com google.com or mail me at [email protected] [username]. +23400
+$sanitizer->findPhoneWords($text);  // Collect all numbers both in words as return as int in array
+// array [
+//   0 => "0812300089"
+//   1 => "081234567"
+//   2 => "23400000209"
+//   3 => "2110920923"
+// ]
+
+$sanitizer->sanitize($text);        // sanitize all in a go!
+// My number is [phone] and another is [phone].
+// Visit [url] [url] or mail me at [email]. +[phone]
+// I love [hastag] with [mention]. I also have two cats. [phone]-3
+
+// sanitize(
+//     string $text,
+//     array $rules = [
+//         'phoneInt' => '[phone]',
+//         'phoneWords' => '[phone]',
+//         'url' => '[url]',
+//         'email' => '[email]',
+//         'mention' => '[mention]',
+//         'hastag' => '[hastag]',
+//     ]
+// );
+```
+
+## Utility
+- The Core Class For Email and String manipulations analysiss
+    - It's helper class can be called, using -- `TameUtility()`
+
+### Utility Usage
+```php
+use Tamedevelopers\Support\Utility;
+
+$text = "
+The Christ the Redeemer Sanctuary, located in the heart of Rio de Janeiro, is the world’s 
+first open-air sanctuary, offering a sacred space welcoming people of all cultures, 
+beliefs, and backgrounds.";
+
+$email = "[email protected]";
+$email2 = "[email protected]";
+$email3 = "[email protected]";
+
+$util = Utility::text($text);
+
+$util->readingTime();                   // 10 seconds
+$util->wordCount();                     // 32
+$util->charCount();                     // 207
+$util->sentenceCount();                 // 1
+$util->reverse();                       // used to reverse the text words
+Utility::text('This is a new text')->readingTime(); // 2 seconds
+Utility::text("A man, a plan, a canal: Panama")->isPalindrome(); //true
+
+
+$util->maskEmail($email);               // *********[email protected]
+Utility::normalizeEmail($email);        // [email protected]
+Utility::normalizeEmail($email2);       // [email protected]
+Utility::normalizeEmail($email3);       // [email protected]
+Utility::isGmail($email2);              // true
+Utility::validateEmail($email);         // true
+```
+
 ## Country
 - Country data and helpers
     - Class: `Tamedevelopers\Support\Country`

src/TextSanitizer.php

@@ -197,7 +197,9 @@ public static function email(string $text, string $replacer = "[email]")
      */
     public static function mention(string $text, string $replacer = "[username]")
     {
-        $pattern = '/@\w{3,}/';
+        // Negative lookbehind ensures @ is not part of an email (no word or dot before it)
+        $pattern = '/(?<![\w.])@([A-Za-z0-9_.]{3,})\b/';
+
         return preg_replace($pattern, $replacer, $text);
     }
 

src/Utility.php

@@ -93,4 +93,28 @@ public function __toString()
     {
         return $this->getText();
     }
+
+    /**
+     * Magic: customize what is displayed during var-dump/dd().
+     * Provides a pretty, safe snapshot of the current class.
+     *
+     * - text: the text input
+     * - readingTime: reading time using 200 words per minute
+     * - wordCount: Count words in text.
+     * - charCount: Count words in text.
+     * - sentenceCount: Count text sentences (approximate) by splitting on punctuation.
+     *
+     * @return array
+     */
+    public function __debugInfo(): array
+    {
+        return [
+            'text'          => $this->getText(),
+            'readingTime'   => $this->readingTime(),
+            'wordCount'     => $this->wordCount(),
+            'charCount'     => $this->charCount(),
+            'sentenceCount' => $this->sentenceCount(),
+        ];
+    }
+
 }

src/helpers.php

@@ -13,8 +13,10 @@
 use Tamedevelopers\Support\Cookie;
 use Tamedevelopers\Support\Server;
 use Tamedevelopers\Support\Country;
+use Tamedevelopers\Support\Utility;
 use Tamedevelopers\Support\Translator;
 use Tamedevelopers\Support\NumberToWords;
+use Tamedevelopers\Support\TextSanitizer;
 use Tamedevelopers\Support\Capsule\Manager;
 use Tamedevelopers\Support\Process\Session;
 use Tamedevelopers\Support\AutoloadRegister;
@@ -156,6 +158,31 @@ function TameStr()
     }
 }
 
+if (! function_exists('TameSanitizer')) {
+    /**
+     * Tame Sanitizer
+     * 
+     * @return \Tamedevelopers\Support\TextSanitizer
+     */
+    function TameSanitizer()
+    {
+        return new TextSanitizer();
+    }
+}
+
+if (! function_exists('TameUtility')) {
+    /**
+     * Tame Utility
+     * 
+     * @param string|null $text
+     * @return \Tamedevelopers\Support\Utility
+     */
+    function TameUtility($text = null)
+    {
+        return new Utility($text);
+    }
+}
+
 if (! function_exists('TameCountry')) {
     /**
      * Country Class

tests/textsanitizer.php

@@ -6,18 +6,22 @@
 
 $sanitizer = new TextSanitizer();
 
-$text = "My number is 08123456789 and another is zero eight one two three four five six seven.
-Visit https://example.com google.com or mail me at [email protected]. +23409109209
+$text = "My number is 0812300089 and another is zero eight one two three four five six seven.
+Visit https://x.com google.com or mail me at [email protected]. +23400000209
 I love #coding with @friends. I also have two cats. 11092092-3";
 
 $text2 = "I'm a beautiful zero nine zero and sweet in seven five seven eight available from ";
-$text3 = "Reach me on zero eight one double two 555 nine or 0812225559";
+$text3 = "Reach me on zero eight one double two 555 nine or 0812220000";
+$text4 = "Visit https://x.com google.com or mail me at [email protected] @username.com. +23400";
 
 dd(
     $sanitizer->phoneInt($text),
     $sanitizer->phoneWords($text2),
     $sanitizer->phoneWords($text3),
-    $sanitizer->url($text),
+    $sanitizer->url($text4),
+    $sanitizer->email($text4),
+    $sanitizer->mention($text4),
+    $sanitizer->hastag($text4),
     $sanitizer->sanitize($text),
     $sanitizer->findPhoneWords($text),
 );

tests/utility.php

@@ -8,10 +8,13 @@
 // --------------------------
 // Example usage
 // --------------------------
+
 $text = "
-The Christ the Redeemer Sanctuary, located in the heart of Rio de Janeiro, is the world’s first open-air sanctuary, 
-offering a sacred space welcoming people of all cultures, beliefs, and backgrounds. 
-More than just a monument, it is a symbol of faith, hope, and hospitality, inviting millions of visitors each year 
+The Christ the Redeemer Sanctuary, located in the heart of Rio de Janeiro, is the world’s 
+first open-air sanctuary, offering a sacred space welcoming people of all cultures, 
+beliefs, and backgrounds.";
+
+$text2 = $text . "More than just a monument, it is a symbol of faith, hope, and hospitality, inviting millions of visitors each year 
 for moments of reflection, spirituality, and connection with nature.
 
 Built atop Corcovado Mountain at 710 meters above sea level, Christ the Redeemer is one of the Seven Wonders of the Modern World. 
@@ -24,29 +27,32 @@
 
 
 $util = Utility::text($text);
-$email = "maxwell+freeman@xd.org";
-$email2 = "maxwell.freeman@gmail.com";
-$email3 = "freeman[email protected]";
+$email = "maxwell+example@xd.org";
+$email2 = "maxwell.example@gmail.com";
+$email3 = "example[email protected]";
 
 // echo($util)  . PHP_EOL;
 
 dump(
-    Utility::maskEmail($email),
+    $util->maskEmail($email),
     [
         Utility::normalizeEmail($email),
         Utility::normalizeEmail($email2),
         Utility::normalizeEmail($email3),
         "isGmail: " . (Utility::isGmail($email2) ? 'yes' : 'no'),
+        Utility::equalsEmail($email, $email),
     ],
-    Utility::equalsEmail($email, $email, true),
-    // Utility::validateEmail($email, true, true),
 
+    [
+        Utility::text('This is a new text')->readingTime(),
+        $util->readingTime(),
+        $util->wordCount(),
+        $util->charCount(),
+        $util->sentenceCount(),
+        Utility::text("A man, a plan, a canal: Panama")->isPalindrome()
+    ],
+    $util,
+    // Utility::validateEmail($email, true, true),
     // $util->getText(),
-    Utility::text('This is a new text')->readingTime(),
-    $util->readingTime(),
-    $util->wordCount(),
-    $util->charCount(),
-    $util->sentenceCount(),
-    Utility::text("A man, a plan, a canal: Panama")->isPalindrome(),
     // $util->reverse(),
 );