Merge pull request #158 from radish-bdd/bugfix/match-longer-sentence

Correctly match "matching" sentences which do not match perfectly

Author: timofurrer

radish/matcher.py

@@ -88,6 +88,7 @@ def match_step(sentence, steps):
         :returns: the arguments and the func which were matched
         :rtype: tuple
     """
+    potentional_matches = []
     for pattern, func in steps.items():
         if isinstance(pattern, re._pattern_type):  # pylint: disable=protected-access
             match = pattern.search(sentence)
@@ -110,8 +111,18 @@ def match_step(sentence, steps):
                 longest_group = 0
 
         if match:
+            step_match = StepMatch(argument_match=argument_match, func=func)
             if len(sentence) == longest_group:
-                return StepMatch(argument_match=argument_match, func=func)
+                # if perfect match can be made we return it no
+                # matter of the other potentional matches
+                return step_match
+
+            distance_to_perfect = abs(len(sentence) - longest_group)
+            potentional_matches.append((step_match, distance_to_perfect))
+
+    if potentional_matches:
+        # get best match
+        return min(potentional_matches, key=lambda x: x[1])[0]
 
     return None
 

tests/functional/basic/radish/steps.py

@@ -1,16 +1,22 @@
 # -*- coding: utf-8 -*-
 
+import re
+
 from radish.stepregistry import step
 from radish import given, when, then
 
+
+# @step(re.compile(r"I have the number (\d+)"))
 @step("I have the number {number:g}")
 def have_number(step, number):
-    step.context.numbers.append(number)
+    step.context.numbers.append(int(number))
+
 
 @when("I sum them")
 def sum_numbers(step):
     step.context.result = sum(step.context.numbers)
 
+
 @then("I expect the result to be {result:g}")
 def expect_result(step, result):
     assert step.context.result == result

tests/unit/test_matcher.py

@@ -142,3 +142,20 @@ def test_merge_non_existing_step(self):
         feature.scenarios.append(scenario)
 
         merge_steps.when.called_with([feature], steps).should.throw(StepDefinitionNotFoundError)
+
+    def test_match_longer_sentence(self):
+        """
+            Test matching steps with a longer sentence
+        """
+        steps = {"This is a short sentence": "some_func",
+                 "a short example sentence": "some_other_func"}
+
+        match, func = match_step("This is a short sentence to test something", steps)
+        arguments, keyword_arguments = match.evaluate()
+        keyword_arguments.should.be.equal({})
+        func.should.be.equal("some_func")
+
+        match, func = match_step("I see a short example sentence to test", steps)
+        arguments, keyword_arguments = match.evaluate()
+        keyword_arguments.should.be.equal({})
+        func.should.be.equal("some_other_func")