From d7365d1bb0a16dabf609756b4dd64ce2b9eaeb6b Mon Sep 17 00:00:00 2001
From: Marco Raddatz <marco@empuxa.com>
Date: Mon, 22 Apr 2024 11:07:37 +0200
Subject: [PATCH] Rename methods and variables

---
 resources/views/code.blade.php         | 26 +++++++++++++-------------
 resources/views/notification.blade.php |  2 +-
 src/Controllers/HandleCodeRequest.php  |  2 +-
 src/Jobs/CreateAndSendLoginCode.php    |  4 ++--
 src/Notifications/LoginCode.php        |  2 +-
 src/Requests/CodeRequest.php           |  8 ++++----
 6 files changed, 22 insertions(+), 22 deletions(-)
diff --git a/resources/views/code.blade.php b/resources/views/code.blade.php
index 2e4173e..0290619 100644
--- a/resources/views/code.blade.php
+++ b/resources/views/code.blade.php
@@ -11,7 +11,7 @@
     <script src="https://cdn.tailwindcss.com"></script>
 
     <script>
-        const code_length = {{ config('totp-login.code.length') }};
+        const totp_code_length = {{ config('totp-login.code.length') }};
     </script>
 </head>
 <body class="antialiased">
@@ -50,7 +50,7 @@
 
                 {{-- Code inputs --}}
                 <div class="flex justify-center" x-data="code()">
-                    <template x-for="(l,i) in code_length" :key="`code_field_${i}`">
+                    <template x-for="(l,i) in totp_code_length" :key="`code_field_${i}`">
                         <input :id="`code_field_${i}`"
                                :autofocus="i === 0"
                                :aria-label="`Code Element ${i + 1}`"
@@ -127,12 +127,12 @@ class="bg-transparent cursor-pointer text-light dark:text-gray-200 hover:underli
 
                     paste = paste.replace(/\s+/g, '');
 
-                    if (isNaN(parseInt(paste)) || paste.length !== pin_length) {
+                    if (isNaN(parseInt(paste)) || paste.length !== totp_code_length) {
                         return;
                     }
 
                     for (let i = 0; i < paste.length; i++) {
-                        document.getElementById(`pin_field_${i}`).value = paste[i];
+                        document.getElementById(`code_field_${i}`).value = paste[i];
                     }
 
                     document.getElementById(`submit`).focus();
@@ -143,27 +143,27 @@ class="bg-transparent cursor-pointer text-light dark:text-gray-200 hover:underli
             function code() {
                 return {
                     resetValue(i) {
-                        for (let x = 0; x < pin_length; x++) {
-                            if (x >= i) document.getElementById(`pin_field_${x}`).value = '';
+                        for (let x = 0; x < totp_code_length; x++) {
+                            if (x >= i) document.getElementById(`code_field_${x}`).value = '';
                         }
                     },
 
                     stepForward(i) {
                         // Last input has been filled; there is no next input
-                        if (document.getElementById(`pin_field_${i}`).value && i === pin_length - 1) {
+                        if (document.getElementById(`code_field_${i}`).value && i === totp_code_length - 1) {
                             document.getElementById(`submit`).focus();
                             return;
                         }
 
                         // Return if the next input is already filled (conflict with paste)
-                        if (document.getElementById(`pin_field_${i + 1}`).value) {
+                        if (document.getElementById(`code_field_${i + 1}`).value) {
                             return;
                         }
 
                         // Next input is empty
-                        if (document.getElementById(`pin_field_${i}`).value && i !== pin_length - 1) {
-                            document.getElementById(`pin_field_${i + 1}`).focus();
-                            document.getElementById(`pin_field_${i + 1}`).value = '';
+                        if (document.getElementById(`code_field_${i}`).value && i !== totp_code_length - 1) {
+                            document.getElementById(`code_field_${i + 1}`).focus();
+                            document.getElementById(`code_field_${i + 1}`).value = '';
                         }
                     },
 
@@ -172,8 +172,8 @@ function code() {
                             return;
                         }
 
-                        document.getElementById(`pin_field_${i - 1}`).focus();
-                        document.getElementById(`pin_field_${i - 1}`).value = '';
+                        document.getElementById(`code_field_${i - 1}`).focus();
+                        document.getElementById(`code_field_${i - 1}`).value = '';
                     }
                 }
             }
diff --git a/resources/views/notification.blade.php b/resources/views/notification.blade.php
index 27c89d9..07f5b5a 100644
--- a/resources/views/notification.blade.php
+++ b/resources/views/notification.blade.php
@@ -6,7 +6,7 @@
 {!! $introLines[0] !!}
 
 <div style="text-align:center;width:100%;margin:50px 0">
-    @foreach($pin as $digit)
+    @foreach($code as $digit)
         <strong style="border:1px solid blue;padding:15px;font-size:20px;border-radius:5px;margin:0 2px">{{ $digit }}</strong>
     @endforeach
 </div>
diff --git a/src/Controllers/HandleCodeRequest.php b/src/Controllers/HandleCodeRequest.php
index 2e7457b..777bcf0 100644
--- a/src/Controllers/HandleCodeRequest.php
+++ b/src/Controllers/HandleCodeRequest.php
@@ -11,7 +11,7 @@
 
 class HandleCodeRequest extends Controller
 {
-    protected ?string $pin = null;
+    protected ?string $code = null;
 
     /**
      * @var \Illuminate\Database\Eloquent\Model
diff --git a/src/Jobs/CreateAndSendLoginCode.php b/src/Jobs/CreateAndSendLoginCode.php
index 1c4b799..51f2a39 100644
--- a/src/Jobs/CreateAndSendLoginCode.php
+++ b/src/Jobs/CreateAndSendLoginCode.php
@@ -22,7 +22,7 @@ public function handle(): void
     {
         $columns = config('totp-login.columns');
         $notification = config('totp-login.notification');
-        $code = self::createPin();
+        $code = self::createCode();
 
         $this->user->{$columns['code']} = Hash::make($code);
         $this->user->{$columns['code_valid_until']} = now()->addSeconds(config('totp-login.code.expires_in'));
@@ -34,7 +34,7 @@ public function handle(): void
     /**
      * @throws \Exception
      */
-    public static function createPin(): string
+    public static function createCode(): string
     {
         return str_pad(
             (string) random_int(0, (int) str_repeat('9', config('totp-login.code.length'))),
diff --git a/src/Notifications/LoginCode.php b/src/Notifications/LoginCode.php
index 98f30c3..a509369 100644
--- a/src/Notifications/LoginCode.php
+++ b/src/Notifications/LoginCode.php
@@ -10,7 +10,7 @@
  */
 class LoginCode extends Notification
 {
-    public function __construct(protected readonly string $pin, protected readonly string $ip)
+    public function __construct(protected readonly string $code, protected readonly string $ip)
     {
     }
 
diff --git a/src/Requests/CodeRequest.php b/src/Requests/CodeRequest.php
index 9f12784..2ba36a8 100644
--- a/src/Requests/CodeRequest.php
+++ b/src/Requests/CodeRequest.php
@@ -50,8 +50,8 @@ public function authenticate(): void
         }
 
         $this->ensureIsNotRateLimited();
-        $this->ensurePinIsNotExpired();
-        $this->validatePin();
+        $this->ensureCodeIsNotExpired();
+        $this->validateCode();
 
         RateLimiter::clear($this->throttleKey());
     }
@@ -88,7 +88,7 @@ public function ensureIsNotRateLimited(): void
     /**
      * @throws \Illuminate\Validation\ValidationException
      */
-    public function ensurePinIsNotExpired(): void
+    public function ensureCodeIsNotExpired(): void
     {
         if (now() < $this->user->{config('totp-login.columns.code_valid_until')}) {
             return;
@@ -105,7 +105,7 @@ public function ensurePinIsNotExpired(): void
     /**
      * @throws \Illuminate\Validation\ValidationException
      */
-    public function validatePin(): void
+    public function validateCode(): void
     {
         $this->formatCode();
 
