Feat: update format.

GoldbachAlgorithms · Oct 25, 2021 · 3c2fcfa · 3c2fcfa
1 parent bfe124a
commit 3c2fcfa
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 31 deletions.
diff --git a/Constants.php b/Constants.php
@@ -0,0 +1,22 @@
+<?php 
+
+class Constants
+{
+    /**
+     * 🇧🇷 Configurações de máscaras
+     * 🇺🇸 Mask Settings
+     * 🇮🇹 Impostazioni delle maschere
+     */
+    const CEP = '#####-###';
+    const CPF = '###.###.###-##';
+
+    /**
+     * 🇧🇷 Tamanho exato de cada tipo de informação
+     * 🇺🇸 Exact size of each type of information
+     * 🇮🇹 Dimensione esatta di ogni tipo di informazione
+     */
+    const LENGTH = [
+        'CEP' => 8,
+        'CPF' => 11
+    ];
+}
diff --git a/Mask.php b/Mask.php
@@ -2,53 +2,56 @@
 
 namespace GoldbachAlgorithms;
 
+use GoldbachAlgorithms\Mask\Constants;
+
 class Mask
 {
-    const CEP = '#####-###';
-
     public function transform(
         string $mask,
         string $value
-    ){
+    ) {
+        $value = $this->clear($value);
         $value = $this->rewrite($mask, $value);
+        $value = $this->doIt($mask, $value);
+
+        return $value;
+    }
 
-        $maskared = '';
+    public function doIt(
+        string $mask,
+        string $value
+    ): string {
+        $masked = '';
 
         $k = 0;
 
-        for($i = 0; $i <= strlen($mask)-1; $i++) {
-            if($mask[$i] == '#') {
-                if(isset($value[$k])){
-                    $maskared .= $value[$k++];
-                }                
-            } 
-            else
-            {
-                if(isset($mask[$i]))
-                {
-                    $maskared .= $mask[$i];
+        for ($i = 0; $i <= strlen($mask)-1; $i++) {
+            if ($mask[$i] == '#') {
+                if (isset($value[$k])) {
+                    $masked .= $value[$k++];
+                }
+            } else {
+                if (isset($mask[$i])) {
+                    $masked .= $mask[$i];
                 }
             }
         }
-
-        return $maskared;
-
+
+        return $masked;
     }
 
     public function rewrite(
-        $mask,
-        $value
-    )
-    {
-        if($mask == self::CEP){
-            $value = str_replace('-','',$value);
-            return str_pad($value, 8, "0", STR_PAD_LEFT);
-        }
+        string $mask,
+        string $value
+    ):string {
+        return str_pad($value, self::LENGTH[$mask], "0", STR_PAD_LEFT);
     }
 
     public function clear(
         string $unmask
-    ){
-        return $unmask;
+    ):string {
+        $unmasked = preg_replace('/[\@\.\;\-\," "]+/', '', $unmask);
+
+        return $unmasked;
     }
-}
+}
diff --git a/README.md b/README.md
@@ -1,2 +1,25 @@
-# Mask
-Mascarador de valores PHP
+# GoldMask
+
+Goldbach Algorithms Mask (fondly nicknamed GoldMask) is a PHP library developed for Symfony for apply a mask to strings.
+
+## Installation
+
+Use the composer to install:
+
+```bash
+composer require goldbach-algorithms/aig
+```
+
+## Usage
+
+```php
+
+$mask = new Mask();
+
+# returns '11025-140'
+$mask->transform(Mask::CEP, '11025140');
+
+```
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)