Merge lp:~ryan.wooden/ultisnips/ultisnips-fixes into lp:~sirver/ultisnips/trunk

[Ryan Wooden]

Applied patch from allait with a fix for bug #774911, but reordered the snippets before returning them so that they arrive in the order expected in the tests.

Added tests and my own fix for bug #774917. I added a function I used in one of my own little plugins to safely convert Python dicts, lists, and strings to be returned to vim. I replaced the _vim_quote() function with mine, and quoted the list returned in _ask_snippets().

All tests currently pass.

[lp:~ryan.wooden/ultisnips/ultisnips-fixes]

293. By Ryan Wooden on 2011-05-02

Added tests and a fix for bug #774923.

[Ryan Wooden (ryan.wooden)]

I added tests and fix for bug #774923. The problem was caused by the fact that the mapping for <BS> takes vim out of SELECT mode, but the method being called tries to press <BS> anyway. To solve it, the method instead presses "gvc" to reselect the region and replace it, which simulates what would happen normally when pressing BS in select mode.

[SirVer (sirver)]

Great work! Merged in r 288.

=== modified file 'plugin/UltiSnips/Util.py'
--- plugin/UltiSnips/Util.py	2010-11-18 18:00:36 +0000
+++ plugin/UltiSnips/Util.py	2011-05-02 19:24:32 +0000
@@ -4,6 +4,21 @@
 import vim
 import os
 
+def vim_string(inp):
+    """ Creates a vim-friendly string from a group of
+    dicts, lists and strings.
+    """
+    def conv(obj):
+        if isinstance(obj, list):
+            return u'[' + u",".join([conv(o) for o in obj]) + u']'
+        elif isinstance(obj, dict):
+            return u'{' + u','.join([
+                u"%s:%s" % (conv(key), conv(value))
+                for key, value in obj.iteritems()]) + u'}'
+        else:
+            return u'"%s"' % str(obj).replace(u'"', u'\\"')
+    return conv(inp)
+
 class IndentUtil(object):
     """ Utility class for dealing properly with indentation. """
 

=== modified file 'plugin/UltiSnips/__init__.py'
--- plugin/UltiSnips/__init__.py	2011-04-28 06:23:01 +0000
+++ plugin/UltiSnips/__init__.py	2011-05-02 19:24:32 +0000
@@ -14,7 +14,7 @@
 from UltiSnips.Geometry import Position
 from UltiSnips.TextObjects import *
 from UltiSnips.Buffer import VimBuffer
-from UltiSnips.Util import IndentUtil
+from UltiSnips.Util import IndentUtil, vim_string
 from UltiSnips.Langmap import LangMapTranslator
 
 # The following lines silence DeprecationWarnings. They are raised
@@ -51,17 +51,13 @@
             _to_scratch_buffer(s)
     return wrapper
 
-def _vim_quote(s):
-    """Quote string s as Vim literal string."""
-    return "'" + s.replace("'", "''") + "'"
-
 def feedkeys(s, mode='n'):
     """Wrapper around vim's feedkeys function. Mainly for convenience."""
     vim.command(r'call feedkeys("%s", "%s")' % (s, mode))
 
 def echom(mes, *args):
     mes = mes % args
-    vim.command('echom "%s"' % mes.replace('"', '\\"'))
+    vim.command('echom %s' % vim_string(mes))
 
 class _SnippetDictionary(object):
     def __init__(self, *args, **kwargs):
@@ -151,7 +147,7 @@
         self._idx = 0
 
     def _error(self, msg):
-        fn = vim.eval("""fnamemodify(%s, ":~:.")""" % _vim_quote(self._fn))
+        fn = vim.eval("""fnamemodify(%s, ":~:.")""" % vim_string(self._fn))
         self._sm._error("%s in %s(%d)" % (msg, fn, self._idx + 1))
 
     def _line(self):
@@ -755,7 +751,9 @@
             feedkeys(r"i")
             self._chars_entered('')
         else:
-            feedkeys(r"\<BS>")
+            # We can't just pass <BS> through, because we took vim
+            # out of SELECT mode, so instead we reselect and replace
+            feedkeys(r"gvc")
 
     @err_to_scratch_buffer
     def cursor_moved(self):
@@ -831,7 +829,7 @@
     # Private/Protect Functions Below #
     ###################################
     def _error(self, msg):
-        msg = _vim_quote("UltiSnips: " + msg)
+        msg = vim_string("UltiSnips: " + msg)
         if self._test_error:
             msg = msg.replace('"', r'\"')
             msg = msg.replace('|', r'\|')
@@ -945,11 +943,17 @@
             found_snippets += self._find_snippets(ft, before, possible)
 
         # Search if any of the snippets overwrites the previous
-        snippets = []
+        # Dictionary allows O(1) access for easy overwrites
+        snippets = {}
         for s in found_snippets:
-            if s.overwrites_previous:
-                snippets = []
-            snippets.append(s)
+            if (s.trigger not in snippets) or s.overwrites_previous:
+                snippets[s.trigger] = []
+            snippets[s.trigger].append(s)
+
+        # Transform dictionary into flat list of snippets
+        selected_snippets = set([item for sublist in snippets.values() for item in sublist])
+        # Return snippets to their original order
+        snippets = [snip for snip in found_snippets if snip in selected_snippets]
 
         return snippets
 
@@ -964,7 +968,7 @@
         )
 
         try:
-            rv = vim.eval("inputlist(%s)" % display)
+            rv = vim.eval("inputlist([%s])" % vim_string(display))
             if rv is None or rv == '0':
                 return None
             rv = int(rv)

=== modified file 'test.py'
--- test.py	2011-04-28 02:41:30 +0000
+++ test.py	2011-05-02 19:24:32 +0000
@@ -1786,7 +1786,6 @@
     keys = "abc test test" + EX
     wanted = "abc test Expand me!"
 
-
 #######################
 # MULTI-WORD SNIPPETS #
 #######################
@@ -1856,6 +1855,44 @@
     keys = "a-test it" + EX
     wanted = "a-Expand me!"
 
+# Test for Bug #774917
+def _snip_quote(qt):
+    return (
+            ("te" + qt + "st", "Expand me" + qt + "!", "test: "+qt),
+            ("te", "Bad", ""),
+            )
+
+class Snippet_With_SingleQuote(_VimTest):
+    snippets = _snip_quote("'")
+    keys = "te'st" + EX
+    wanted = "Expand me'!"
+
+class Snippet_With_SingleQuote_List(_VimTest):
+    snippets = _snip_quote("'")
+    keys = "te" + LS + "1\n"
+    wanted = "Expand me'!"
+
+class Snippet_With_DoubleQuote(_VimTest):
+    snippets = _snip_quote('"')
+    keys = 'te"st' + EX
+    wanted = "Expand me\"!"
+
+class Snippet_With_DoubleQuote_List(_VimTest):
+    snippets = _snip_quote('"')
+    keys = "te" + LS + "1\n"
+    wanted = "Expand me\"!"
+
+# Test for Bug #774917
+class Backspace_TabStop_Zero(_VimTest):
+    snippets = ("test", "A${1:C} ${0:DDD}", "This is Case 1")
+    keys = "test" + EX + "A" + JF + BS + "BBB"
+    wanted = "AA BBB"
+
+class Backspace_TabStop_NotZero(_VimTest):
+    snippets = ("test", "A${1:C} ${2:DDD}", "This is Case 1")
+    keys = "test" + EX + "A" + JF + BS + "BBB"
+    wanted = "AA BBB"
+
 ######################
 # SELECTING MULTIPLE #
 ######################