Merge pull request #1573 from HelioGuilherme66/CleanUP_PR17

This is a review for PR#17 by @SimonElfvingElekta dated nov. 2013.

Author: yanne

src/robotide/controller/macrocontrollers.py

@@ -232,7 +232,7 @@ def create_keyword(self, name, argstr):
 
     def _remove_bdd_prefix(self, name):
         matcher = name.lower()
-        for match in ['given ', 'when ', 'then ', 'and ']:
+        for match in ['given ', 'when ', 'then ', 'and ', 'but ']:
             if matcher.startswith(match):
                 return name[len(match):]
         return name

src/robotide/controller/stepcontrollers.py

@@ -24,7 +24,8 @@
 
 class StepController(_BaseController):
 
-    _GIVEN_WHEN_THEN_MATCHER = re.compile(r'^(given|when|then|and)\s*', re.I)
+    _GIVEN_WHEN_THEN_MATCHER = re.compile(r'^(given|when|then|and|but)\s*',
+                                          re.I)
 
     def __init__(self, parent, step):
         self._init(parent, step)

src/robotide/editor/contentassist.py

@@ -37,6 +37,8 @@ def __init__(self, suggestion_source):
         self.Bind(wx.EVT_MOVE, self.OnFocusLost)
         self._showing_content_assist = False
         self._row = None
+        self.gherkin_prefix = ''  # Store gherkin prefix from input to add \
+        # later after search is performed
 
     def set_row(self, row):
         self._row = row
@@ -48,7 +50,7 @@ def OnChar(self, event):
         if keycode == wx.WXK_SPACE and event.ControlDown():
             self.show_content_assist()
             return
-        if keycode in [wx.WXK_UP, wx.WXK_DOWN, wx.WXK_PAGEUP, wx.WXK_PAGEDOWN] \
+        if keycode in [wx.WXK_UP, wx.WXK_DOWN, wx.WXK_PAGEUP, wx.WXK_PAGEDOWN]\
                 and self._popup.is_shown():
             self._popup.select_and_scroll(keycode)
             return
@@ -62,14 +64,16 @@ def OnChar(self, event):
             return
         elif self._popup.is_shown() and keycode < 256:
             self._populate_content_assist(event)
-        elif keycode in (ord('1'), ord('2')) and event.ControlDown() and not event.AltDown():
-            self.execute_variable_creator(list_variable=(keycode==ord('2')))
+        elif keycode in (ord('1'), ord('2')) and event.ControlDown() and not \
+                event.AltDown():
+            self.execute_variable_creator(list_variable=(keycode == ord('2')))
         event.Skip()
 
     def execute_variable_creator(self, list_variable=False):
         from_, to_ = self.GetSelection()
         symbol = '@' if list_variable else '$'
-        self.SetValue(self._variable_creator_value(self.Value, symbol, from_, to_))
+        self.SetValue(self._variable_creator_value(
+            self.Value, symbol, from_, to_))
         if from_ == to_:
             self.SetInsertionPoint(from_ + 2)
         else:
@@ -81,7 +85,7 @@ def _variable_creator_value(self, value, symbol, from_, to_):
     def OnFocusLost(self, event, set_value=True):
         if not self._popup.is_shown():
             return
-        value = self._popup.get_value()
+        value = self.gherkin_prefix + self._popup.get_value()
         if set_value and value:
             self.SetValue(value)
             self.SetInsertionPoint(len(self.Value))
@@ -113,26 +117,41 @@ def _populate_content_assist(self, event=None):
                 return False
             else:
                 value += unichr(event.GetRawKeyCode())
+        (self.gherkin_prefix, value) = self._remove_bdd_prefix(value)
         return self._popup.content_assist_for(value, row=self._row)
 
+    def _remove_bdd_prefix(self, name):
+        for match in ['given ', 'when ', 'then ', 'and ', 'but ']:
+            if name.lower().startswith(match):
+                return (name[:len(match)], name[len(match):])
+        return ('', name)
+
     def _show_content_assist(self):
         height = self.GetSizeTuple()[1]
         x, y = self.ClientToScreenXY(0, 0)
         self._popup.show(x, y, height)
 
     def content_assist_value(self):
-        return self._popup.content_assist_value(self.Value)
+        suggestion = self._popup.content_assist_value(self.Value)
+        if suggestion is None:
+            return suggestion
+        else:
+            return self.gherkin_prefix + suggestion
 
     def hide(self):
         self._popup.hide()
         self._showing_content_assist = False
 
 
-class ExpandingContentAssistTextCtrl(_ContentAssistTextCtrlBase, ExpandoTextCtrl):
+class ExpandingContentAssistTextCtrl(_ContentAssistTextCtrlBase,
+                                     ExpandoTextCtrl):
 
     def __init__(self, parent, plugin, controller):
-        ExpandoTextCtrl.__init__(self, parent, size=wx.DefaultSize, style=wx.WANTS_CHARS)
-        _ContentAssistTextCtrlBase.__init__(self, SuggestionSource(plugin, controller))
+        ExpandoTextCtrl.__init__(self, parent, size=wx.DefaultSize,
+                                 style=wx.WANTS_CHARS)
+        _ContentAssistTextCtrlBase.__init__(self,
+                                            SuggestionSource(plugin,
+                                                             controller))
 
 
 class ContentAssistTextCtrl(_ContentAssistTextCtrlBase, wx.TextCtrl):
@@ -144,10 +163,11 @@ def __init__(self, parent, suggestion_source, size=wx.DefaultSize):
 
 class ContentAssistFileButton(_ContentAssistTextCtrlBase, FileBrowseButton):
 
-    def __init__(self, parent, suggestion_source, label, controller, size=wx.DefaultSize):
+    def __init__(self, parent, suggestion_source, label, controller,
+                 size=wx.DefaultSize):
         FileBrowseButton.__init__(self, parent, labelText=label,
-            size=size, fileMask="*",
-            changeCallback=self.OnFileChanged)
+                                  size=size, fileMask="*",
+                                  changeCallback=self.OnFileChanged)
         self._parent = parent
         self._controller = controller
         self._browsed = False
@@ -183,10 +203,11 @@ def SelectAll(self):
     def _relative_path(self, value):
         src = self._controller.datafile.source
         if utils.is_same_drive(src, value):
-            path =  relpath(value, src if isdir(src) else dirname(src))
+            path = relpath(value, src if isdir(src) else dirname(src))
         else:
             path = value
-        return path.replace('\\', '/') if context.IS_WINDOWS else path.replace('\\', '\\\\')
+        return path.replace('\\', '/') if context.IS_WINDOWS else\
+            path.replace('\\', '\\\\')
 
 
 class Suggestions(object):
@@ -199,7 +220,7 @@ def __init__(self, suggestion_source):
     def get_for(self, value, row=None):
         self._previous_choices = self._get_choices(value, row)
         self._previous_value = value
-        return [k for k,_ in self._previous_choices]
+        return [k for k, _ in self._previous_choices]
 
     def get_item(self, name):
         for k, v in self._previous_choices:
@@ -210,7 +231,7 @@ def get_item(self, name):
     def _get_choices(self, value, row):
         if self._previous_value and value.startswith(self._previous_value):
             return [(key, val) for key, val in self._previous_choices
-                                    if utils.normalize(key).startswith(utils.normalize(value))]
+                    if utils.normalize(key).startswith(utils.normalize(value))]
         choices = self._suggestion_source.get_suggestions(value, row)
         duplicate_names = self._get_duplicate_names(choices)
         return self._format_choices(choices, value, duplicate_names)
@@ -225,15 +246,18 @@ def _get_duplicate_names(self, choices):
         return results
 
     def _format_choices(self, choices, prefix, duplicate_names):
-        return [(self._format(val, prefix, duplicate_names), val) for val in choices]
+        return [(self._format(val, prefix, duplicate_names), val) for val in
+                choices]
 
     def _format(self, choice, prefix, duplicate_names):
-        return choice.name if self._matches_unique_shortname(choice, prefix, duplicate_names) else choice.longname
+        return choice.name if self._matches_unique_shortname(
+            choice, prefix, duplicate_names) else choice.longname
 
     def _matches_unique_shortname(self, choice, prefix, duplicate_names):
         if isinstance(choice, VariableInfo):
             return True
-        if not utils.normalize(choice.name).startswith(utils.normalize(prefix)):
+        if not utils.normalize(choice.name).startswith(
+                utils.normalize(prefix)):
             return False
         if utils.normalize(choice.name) in duplicate_names:
             return False
@@ -247,15 +271,17 @@ def __init__(self, parent, suggestion_source):
         self._main_popup = RidePopupWindow(parent, _PREFERRED_POPUP_SIZE)
         self._details_popup = HtmlPopupWindow(parent, _PREFERRED_POPUP_SIZE)
         self._selection = -1
-        self._list = ContentAssistList(self._main_popup, self.OnListItemSelected,
+        self._list = ContentAssistList(self._main_popup,
+                                       self.OnListItemSelected,
                                        self.OnListItemActivated)
         self._suggestions = Suggestions(suggestion_source)
 
     def reset(self):
         self._selection = -1
 
     def get_value(self):
-        return self._selection != -1 and self._list.get_text(self._selection) or None
+        return self._selection != -1 and self._list.get_text(
+            self._selection) or None
 
     def content_assist_for(self, value, row=None):
         self._choices = self._suggestions.get_for(value, row=row)
@@ -275,9 +301,12 @@ def content_assist_value(self, value):
         return None
 
     def show(self, xcoord, ycoord, cell_height):
-        self._main_popup.SetPosition((xcoord, self._move_y_where_room(ycoord, cell_height)))
+        self._main_popup.SetPosition((xcoord,
+                                      self._move_y_where_room(ycoord,
+                                                              cell_height)))
         self._details_popup.SetPosition((self._move_x_where_room(xcoord),
-                                         self._move_y_where_room(ycoord, cell_height)))
+                                         self._move_y_where_room(ycoord,
+                                                                 cell_height)))
         self._main_popup.Show()
         self._list.SetFocus()
 
@@ -303,13 +332,13 @@ def is_shown(self):
 
     def select_and_scroll(self, keycode):
         sel = self._list.GetFirstSelected()
-        if keycode == wx.WXK_DOWN :
+        if keycode == wx.WXK_DOWN:
             if sel < (self._list.GetItemCount() - 1):
                 self._select_and_scroll(sel + 1)
             else:
                 self._select_and_scroll(0)
         elif keycode == wx.WXK_UP:
-            if sel > 0 :
+            if sel > 0:
                 self._select_and_scroll(sel - 1)
             else:
                 self._select_and_scroll(self._list.GetItemCount() - 1)

src/robotide/editor/robotframeworklexer.py

@@ -275,7 +275,7 @@ def _tokenize(self, value, index):
 
 
 class GherkinTokenizer(object):
-    _gherkin_prefix = re.compile('^(Given|When|Then|And) ', re.IGNORECASE)
+    _gherkin_prefix = re.compile('^(Given|When|Then|And|But) ', re.IGNORECASE)
 
     def tokenize(self, value, token):
         match = self._gherkin_prefix.match(value)
@@ -321,7 +321,7 @@ def tokenize(self, value, index):
 
     def _continues(self, value, index):
         return value == '...' and all(self._is_empty(t)
-            for t in self._prev_values_on_row)
+                                      for t in self._prev_values_on_row)
 
     def _is_empty(self, value):
         return value in ('', '\\')
@@ -367,8 +367,8 @@ class TestCaseTable(_Table):
 
     @property
     def _tokenizer_class(self):
-        if self._test_template or (self._default_template and
-                                           self._test_template is not False):
+        if self._test_template or (self._default_template
+                                   and self._test_template is not False):
             return TemplatedKeywordCall
         return KeywordCall
 
@@ -470,7 +470,7 @@ def _split(self, string):
                 self._state(char, index)
             except StopIteration:
                 return
-            if index  == max_index and not self._scanning_list_variable_index():
+            if index == max_index and not self._scanning_list_variable_index():
                 return
 
     def _scanning_list_variable_index(self):

src/robotide/namespace/namespace.py

@@ -521,7 +521,7 @@ def _add_resource(self, res, ctx, items):
 
 class _Keywords(object):
 
-    regexp = re.compile("\s*(given|when|then|and)\s*(.*)", re.IGNORECASE)
+    regexp = re.compile("\s*(given|when|then|and|but)\s*(.*)", re.IGNORECASE)
 
     def __init__(self, keywords):
         self.keywords = robotapi.NormalizedDict(ignore=['_'])

utest/controller/test_macro_commands.py

@@ -3,8 +3,9 @@
 
 from robotide.robotapi import TestCaseFile
 from robotide.controller.filecontrollers import TestCaseFileController
-from robotide.publish.messages import RideUserKeywordAdded, RideUserKeywordRemoved,\
-    RideTestCaseAdded, RideTestCaseRemoved, RideItemNameChanged
+from robotide.publish.messages import RideUserKeywordAdded,\
+    RideUserKeywordRemoved, RideTestCaseAdded, RideTestCaseRemoved,\
+    RideItemNameChanged
 from robotide.controller.commands import AddKeyword, RemoveMacro, Undo,\
     AddTestCase, AddKeywordFromCells, RenameTest
 from robotide.publish import PUBLISHER
@@ -16,7 +17,8 @@ class _TestMacroCommands(object):
 
     def setUp(self):
         for listener, topic in [(self._on_keyword_added, RideUserKeywordAdded),
-                                (self._on_keyword_deleted, RideUserKeywordRemoved),
+                                (self._on_keyword_deleted,
+                                 RideUserKeywordRemoved),
                                 (self._on_test_added, RideTestCaseAdded),
                                 (self._on_test_deleted, RideTestCaseRemoved)]:
             PUBLISHER.subscribe(listener, topic)
@@ -99,7 +101,8 @@ def test_add_keyword_with_bdd_given(self):
 
     def _bdd_test(self, prefix, new_kw_name):
         self._exec(AddKeyword(prefix + ' ' + new_kw_name))
-        assert_equals(self._new_keyword.name, self._bdd_name(prefix, new_kw_name))
+        assert_equals(self._new_keyword.name, self._bdd_name(prefix,
+                                                             new_kw_name))
         assert_equals(self._new_keyword.arguments.value, '')
 
     def test_add_keyword_with_bdd_when(self):
@@ -114,7 +117,13 @@ def test_add_keyword_with_bdd_and(self):
         self._bdd_test('And', 'the end')
         self._bdd_test('and', 'really no more')
 
-class TestMacroCommandsInTestCaseContext(_TestMacroCommands, unittest.TestCase):
+    def test_add_keyword_with_bdd_but(self):
+        self._bdd_test('But', 'george awakes')
+        self._bdd_test('but', 'steve says bye')
+
+
+class TestMacroCommandsInTestCaseContext(_TestMacroCommands,
+                                         unittest.TestCase):
 
     def setUp(self):
         _TestMacroCommands.setUp(self)
@@ -124,7 +133,8 @@ def _bdd_name(self, prefix, name):
         return name
 
 
-class TestMacroCommandsInDataFileContext(_TestMacroCommands, unittest.TestCase):
+class TestMacroCommandsInDataFileContext(_TestMacroCommands,
+                                         unittest.TestCase):
 
     def setUp(self):
         _TestMacroCommands.setUp(self)