From 8d8d80859d50e04d879bd90bb2b7cb2d4e9d3c78 Mon Sep 17 00:00:00 2001
From: Mark <mtownsend5512@gmail.com>
Date: Mon, 21 Sep 2020 14:08:04 -0500
Subject: [PATCH] Standardized result key names

Changed steps_completed to steps_complete to standardize its word usage among the other keys.
---
 README.md              |  2 +-
 src/Progress.php       |  2 +-
 tests/ProgressTest.php | 10 +++++-----
 3 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 86abfdb..74e1510 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,7 @@ $progress = (new Progress(
   "total_steps" => 1
   "percentage_complete" => 100.0
   "percentage_incomplete" => 0.0
-  "steps_completed" => 1
+  "steps_complete" => 1
   "steps_incomplete" => 0
   "complete_step_names" => [
     0 => "Age"
diff --git a/src/Progress.php b/src/Progress.php
index ceed6cb..878e029 100644
--- a/src/Progress.php
+++ b/src/Progress.php
@@ -111,7 +111,7 @@ protected function evaluate(): array
             'total_steps' => $this->countSteps(),
             'percentage_complete' => $this->percentageComplete(),
             'percentage_incomplete' => max(100 - $this->percentageComplete(), 0),
-            'steps_completed' => $this->countStepsPassed(),
+            'steps_complete' => $this->countStepsPassed(),
             'steps_incomplete' => $this->countSteps() - $this->countStepsPassed(),
             'complete_step_names' => $this->passedStepNames(),
             'incomplete_step_names' => $this->failedStepNames()
diff --git a/tests/ProgressTest.php b/tests/ProgressTest.php
index 5017238..2620111 100644
--- a/tests/ProgressTest.php
+++ b/tests/ProgressTest.php
@@ -25,7 +25,7 @@ public function step_fails()
     public function progress_can_receive_single_step()
     {
         $result = new Progress((new Step(31, 'Age'))->integer());
-        $this->assertEquals($result->get()['steps_completed'], 1);
+        $this->assertEquals($result->get()['steps_complete'], 1);
     }
 
     /** @test */
@@ -35,7 +35,7 @@ public function progress_can_receive_multiple_steps()
             (new Step(31, 'Age'))->integer(),
             (new Step('John Smith', 'Name'))->string()->notEmpty()
         );
-        $this->assertEquals($result->get()['steps_completed'], 2);
+        $this->assertEquals($result->get()['steps_complete'], 2);
     }
 
     /** @test */
@@ -47,7 +47,7 @@ public function progress_can_receive_array_of_steps()
             (new Step(true, 'Premier Member'))->boolean(),
         ];
         $result = new Progress($steps);
-        $this->assertEquals($result->get()['steps_completed'], 3);
+        $this->assertEquals($result->get()['steps_complete'], 3);
     }
 
     /** @test */
@@ -82,7 +82,7 @@ public function can_retrieve_result_key_from_magic_property()
         $progress = new Progress($steps);
         $progress->get();
 
-        $this->assertEquals($progress->steps_completed, 3);
+        $this->assertEquals($progress->steps_complete, 3);
     }
 
     /** @test */
@@ -104,7 +104,7 @@ public function progress_outputs_json()
             (new Step(null, 'List Your First Item For Sale'))->notEmpty()->integer(),
         ];
         $result = (new Progress($steps))->toJson();
-        $json = '{"total_steps":5,"percentage_complete":60,"percentage_incomplete":40,"steps_completed":3,"steps_incomplete":2,"complete_step_names":["Age","Confirmed Email","Connect Your Facebook"],"incomplete_step_names":{"3":"Connect Your PayPal","4":"List Your First Item For Sale"}}';
+        $json = '{"total_steps":5,"percentage_complete":60,"percentage_incomplete":40,"steps_complete":3,"steps_incomplete":2,"complete_step_names":["Age","Confirmed Email","Connect Your Facebook"],"incomplete_step_names":{"3":"Connect Your PayPal","4":"List Your First Item For Sale"}}';
 
         $this->assertEquals($result, $json);
     }