Add support for initials detection

bin/autojump

@@ -50,6 +50,7 @@ from autojump_data import save
 from autojump_match import match_anywhere
 from autojump_match import match_consecutive
 from autojump_match import match_fuzzy
+from autojump_match import match_initials
 from autojump_utils import first
 from autojump_utils import get_pwd
 from autojump_utils import get_tab_entry_info
@@ -200,6 +201,7 @@ def find_matches(entries, needles, check_entries=True):
             match_consecutive(needles, data, ignore_case),
             match_fuzzy(needles, data, ignore_case),
             match_anywhere(needles, data, ignore_case),
+            match_initials(needles, data, ignore_case),
         ),
     )
 

bin/autojump_match.py

@@ -127,3 +127,32 @@ def match_fuzzy(needles, haystack, ignore_case=False, threshold=0.6):
         ).ratio()
     meets_threshold = lambda entry: match_percent(entry) >= threshold
     return ifilter(meets_threshold, haystack)
+
+
+def match_initials(needles, haystack, ignore_case=False):
+    """
+    Performs a match of initials anywhere in the path as long as they're in the same (but
+    not necessary consecutive) order.
+
+    For example:
+        needles = ['foo', 'baz']
+        haystack = [
+            (path='/f-o-o/b-a-r/b-a-z', weight=10),
+            (path='/b_a_z/f_o_o/b_a_r', weight=10),
+            (path='/f-o-o/b_a_z', weight=10),
+        ]
+
+        result = [
+            (path='/f-o-o/b-a-r/b-a-z', weight=10),
+            (path='/f-o-o/b_a_z', weight=10),
+        ]
+    """
+    wildcard_needles = imap(lambda n: '.*'.join(list(re.escape(n))), needles)
+    regex_needle = '.*' + '.*'.join(wildcard_needles) + '.*'
+    regex_flags = re.IGNORECASE | re.UNICODE if ignore_case else re.UNICODE
+    found = lambda entry: re.search(
+        regex_needle,
+        entry.path,
+        flags=regex_flags,
+    )
+    return ifilter(found, haystack)

tests/unit/autojump_match_test.py

@@ -9,6 +9,7 @@
 from autojump_data import Entry
 from autojump_match import match_anywhere
 from autojump_match import match_consecutive
+from autojump_match import match_initials
 
 
 class TestMatchAnywhere(object):
@@ -129,3 +130,59 @@ def test_thing(self, windows_haystack):
     def test_wildcard_in_needle(self, haystack):
         assert list(match_consecutive(['*', 'this'], haystack)) == []
         assert list(match_consecutive(['*', 'edge', 'case'], haystack)) == [self.entry6]
+
+
+class TestMatchInitials(object):
+
+    entry1 = Entry('/f-o-o/b-a-r/b-a-z', 10)
+    entry2 = Entry('/b_a_z/f_o_o/b_a_r', 10)
+    entry3 = Entry('/f-o-o/b-a-z', 10)
+    entry4 = Entry('/中/zhong/国/guo', 10)
+    entry5 = Entry('/CamelCaseFolder/SubFolder', 10)
+    win_entry1 = Entry('C:\\f-o-o\\b-a-r\\b-a-z', 10)
+    win_entry2 = Entry('D:\Program Files (x86)\GIMP', 10)
+    win_entry3 = Entry('C:\Windows\System32', 10)
+
+    @pytest.fixture
+    def haystack(self):
+        return [
+            self.entry1,
+            self.entry2,
+            self.entry3,
+            self.entry4,
+            self.entry5,
+        ]
+
+    @pytest.fixture
+    def windows_haystack(self):
+        return [self.win_entry1, self.win_entry2, self.win_entry3]
+
+    def test_single_needle(self, haystack):
+        assert list(match_initials(['bar'], haystack)) == [self.entry1, self.entry2]
+
+    def test_consecutive(self, haystack):
+        assert list(match_initials(['foo', 'bar'], haystack)) \
+            == [self.entry1, self.entry2]
+        assert list(match_initials(['bar', 'foo'], haystack)) == []
+
+    def test_skip(self, haystack):
+        assert list(match_initials(['baz', 'bar'], haystack)) == [self.entry2]
+        assert list(match_initials(['zng', 'g'], haystack)) == [self.entry4]
+
+    def test_ignore_case(self, haystack):
+        assert list(match_initials(['bAz', 'bAR'], haystack, ignore_case=True)) \
+            == [self.entry2]
+
+    def test_backslashes_for_windows_paths(self, windows_haystack):
+        # https://github.com/wting/autojump/issues/281
+        assert list(match_initials(['foo', 'baz'], windows_haystack)) \
+            == [self.win_entry1]
+        assert list(match_initials(['pgm', 'gmp'], windows_haystack, True)) \
+            == [self.win_entry2]
+        assert list(match_initials(['wndw', 'stm'], windows_haystack, True)) \
+            == [self.win_entry3]
+
+    def test_camel_case_initials(self, haystack):
+        assert list(match_initials(['ccf'], haystack, ignore_case=True)) == [self.entry5]
+        assert list(match_initials(['sf'], haystack, ignore_case=True)) == [self.entry5]
+        assert list(match_initials(['ccf', 'sf'], haystack, ignore_case=True)) == [self.entry5]