Update progress

utPLSQL · jgebal · Feb 4, 2022 · Jun 1, 2020 · Jun 2, 2020 · Jun 2, 2020
commit e3fb2d7f15062b91a81570973f56209be8f89cb3
diff --git a/docs/userguide/expectations.md b/docs/userguide/expectations.md
@@ -334,7 +334,7 @@ The matrix below illustrates the data types supported by different matchers.
 |      **be_empty**       |  X   |         |  X   |      |        |           |                               |                                        |          |                                 |                                 |   X    |              X              |        |  X   |
 |     **have_count**      |      |         |      |      |        |           |                               |                                        |          |                                 |                                 |   X    |              X              |        |  X   |
 | **be_within().of_()**   |      |         |      |   x  |   x    |           |                               |                                        |          |                                 |                                 |        |                             |        |      |
-
+| **be_within_pct().of()**|      |         |      |      |   x    |           |                               |                                        |          |                                 |                                 |        |                             |        |      |              
 
 # Expecting exceptions
 
@@ -1118,14 +1118,6 @@ end;
 
 **Example 2.**
 ```sql
-begin
-  ut.expect(9).to_be_within_pct(10).of_(10);
-end;
-/
-```
-
-**Example 3.**
-```sql
 begin
   ut.expect(3).to_be_within(1).of_(5);
 end;
@@ -1142,7 +1134,7 @@ Failures:
       at "UT3_DEVELOP.TEST_BETWNSTR.WIHTIN_TEST", line 5
 ```
 
-**Example 4.**
+**Example 3.**
 ```sql
 begin
   ut.expect(sysdate).to_be_within(interval '1' day).of_(sysdate+2);
@@ -1160,6 +1152,30 @@ Failures:
       at "UT3_DEVELOP.TEST_BETWNSTR.WIHTIN_TEST", line 5
 ```
 
+
+## to_be_within_pct of
+
+This matcher is created to determine wheter expected value is approximately equal or "close" to another value within percentage value of expected.
+
+Matcher will allow to compare numbers.
+
+When comparing a number the tolerance / distance can be expressed as another postive number or a percentage.
+
+When comparing a two dates tolerance can be expressed in interval time either Day-To-Second or Year-To-Month.
+
+Matcher for numbers will calculate a absolute distance between expected and actual and check whether that value is within a tolerance.
+
+When comparing a date a distance is measured in interval, the check is done that actual value is within date range of expected taking into account interval plus and minus.
+
+**Example 1.**
+```sql
+begin
+  ut.expect(9).to_be_within_pct(10).of_(10);
+end;
+/
+```
+
+
 ## Comparing cursors, object types, nested tables and varrays 
 
 utPLSQL is capable of comparing compound data-types including:

diff --git a/source/expectations/matchers/ut_be_within.tpb b/source/expectations/matchers/ut_be_within.tpb
@@ -103,26 +103,14 @@ create or replace type body ut_be_within as
   end;
 
   overriding member function failure_message(a_actual ut_data_value) return varchar2 is
-    l_distance_from_expected varchar2(32767);
-  begin
-    l_distance_from_expected := case 
-                    when self.distance_from_expected is of (ut_data_value_number) then
-                      treat(self.distance_from_expected as ut_data_value_number).to_string
-                    when self.distance_from_expected is of (ut_data_value_yminterval) then
-                      treat(self.distance_from_expected as ut_data_value_yminterval).to_string 
-                    when self.distance_from_expected is of (ut_data_value_dsinterval) then
-                      treat(self.distance_from_expected as ut_data_value_dsinterval).to_string 
-                    else
-                      null
-                    end;
-
-    return (self as ut_matcher).failure_message(a_actual) || ' '||l_distance_from_expected ||' of '|| expected.to_string_report();
+  begin                
+    return (self as ut_matcher).failure_message(a_actual) || ' '||self.distance_from_expected.to_string ||' of '|| expected.to_string_report();
   end;
 
   overriding member function failure_message_when_negated(a_actual ut_data_value) return varchar2 is
     l_result varchar2(32767);
-  begin
-    return (self as ut_matcher).failure_message_when_negated(a_actual) || ': '|| expected.to_string_report();
+  begin 
+    return (self as ut_matcher).failure_message_when_negated(a_actual) || ' '||self.distance_from_expected.to_string ||' of '|| expected.to_string_report();
   end;  
 
 end;

diff --git a/source/expectations/ut_expectation.tpb b/source/expectations/ut_expectation.tpb
@@ -695,43 +695,43 @@ create or replace type body ut_expectation as
   end;
 
   member function to_be_within(a_dist natural) return ut_be_within is
-    l_result ut_matcher;
+    l_result ut_be_within;
   begin
     l_result := ut_be_within(a_dist);
     l_result.expectation := self;
-    return treat(l_result as ut_be_within);
+    return l_result;
   end;  
 
   member function to_be_within(a_dist dsinterval_unconstrained) return ut_be_within is
-    l_result ut_matcher;
+    l_result ut_be_within;
   begin
     l_result := ut_be_within(a_dist);
     l_result.expectation := self;
-    return treat(l_result as ut_be_within);
+    return l_result;
   end;  
 
   member function to_be_within(a_dist yminterval_unconstrained) return ut_be_within is
-    l_result ut_matcher;
+    l_result ut_be_within;
   begin
     l_result := ut_be_within(a_dist);
     l_result.expectation := self;
-    return treat(l_result as ut_be_within);
+    return l_result;
   end;  
 
  member function to_be_within_pct(a_dist natural) return ut_be_within_pct is
-   l_result ut_matcher;
+   l_result ut_be_within_pct;
  begin
    l_result := ut_be_within_pct(a_dist);
    l_result.expectation := self;
-   return treat(l_result as ut_be_within_pct);
+   return  l_result;
   end;  
 
   member function not_to_be_within(a_dist natural) return ut_be_within is
     l_result ut_matcher;
   begin
     l_result := ut_be_within(a_dist).negated();
     l_result.expectation := self;
-    return treat(l_result as ut_be_within);
+    return  treat(l_result as ut_be_within);
   end;
 
   member function not_to_be_within(a_dist dsinterval_unconstrained) return ut_be_within is

diff --git a/test/ut3_user/expectations/binary/test_to_be_within.pkb b/test/ut3_user/expectations/binary/test_to_be_within.pkb
@@ -192,5 +192,20 @@ create or replace package body test_to_be_within is
     ut.expect(l_actual_message).to_be_like(l_expected_message);
   end;      
 
+  procedure fail_msg_when_not_within is
+    l_actual_message   varchar2(32767);
+    l_expected_message varchar2(32767);
+  begin
+    --Arrange
+    --Act
+    ut3_develop.ut.expect(1).to_be_within(3).of_(12);
+    --Assert
+    l_expected_message := q'[Actual: 1 (number) was expected to be within 3 of 12 (number)]';
+    l_actual_message := ut3_tester_helper.main_helper.get_failed_expectations(1);
+    --Assert
+    ut.expect(l_actual_message).to_be_like(l_expected_message);
+ end;
+
+
 end;
 /
diff --git a/test/ut3_user/expectations/binary/test_to_be_within.pks b/test/ut3_user/expectations/binary/test_to_be_within.pks
@@ -12,20 +12,23 @@ create or replace package test_to_be_within is
   --%test(gives failure when number is not within distance)
   procedure failed_tests;
 
-  --%test(Check failure message for number not within)
+  --%test(check failure message for number not within)
   procedure fail_for_number_not_within;
 
-  --%test(Check failure message for inteval of 1 sec not within)
+  --%test(check failure message for inteval of 1 sec not within)
   procedure fail_for_ds_int_not_within;  
 
-  --%test(Check failure message for custom ds interval not within)
+  --%test(check failure message for custom ds interval not within)
   procedure fail_for_custom_ds_int;    
 
-  --%test(Check failure message for inteval of 1 month not within)
+  --%test(check failure message for inteval of 1 month not within)
   procedure fail_for_ym_int_not_within;  
 
-  --%test(Check failure message for custom ym interval not within)
+  --%test(check failure message for custom ym interval not within)
   procedure fail_for_custom_ym_int;   
-
+
+  --%test(check failure message for simple within)
+  procedure fail_msg_when_not_within;  
+
 end;
 /