command-t 1.6.1 → 1.7

data/ruby/command-t/match_window.rb

@@ -1,4 +1,4 @@
-# Copyright 2010-2013 Wincent Colaiuta. All rights reserved.
+# Copyright 2010-2014 Wincent Colaiuta. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -47,17 +47,16 @@ module CommandT
                                    :width   => ::VIM::Window[i].width)
       end
 
-      # global settings (must manually save and restore)
-      @settings = Settings.new
-      ::VIM::set_option 'timeout'         # ensure mappings timeout
-      ::VIM::set_option 'timeoutlen=0'    # respond immediately to mappings
-      ::VIM::set_option 'nohlsearch'      # don't highlight search strings
-      ::VIM::set_option 'noinsertmode'    # don't make Insert mode the default
-      ::VIM::set_option 'noshowcmd'       # don't show command info on last line
-      ::VIM::set_option 'report=9999'     # don't show "X lines changed" reports
-      ::VIM::set_option 'sidescroll=0'    # don't sidescroll in jumps
-      ::VIM::set_option 'sidescrolloff=0' # don't sidescroll automatically
-      ::VIM::set_option 'noequalalways'   # don't auto-balance window sizes
+      set 'timeout', true        # ensure mappings timeout
+      set 'hlsearch', false      # don't highlight search strings
+      set 'insertmode', false    # don't make Insert mode the default
+      set 'showcmd', false       # don't show command info on last line
+      set 'equalalways', false   # don't auto-balance window sizes
+      set 'timeoutlen', 0        # respond immediately to mappings
+      set 'report', 9999         # don't show "X lines changed" reports
+      set 'sidescroll', 0        # don't sidescroll in jumps
+      set 'sidescrolloff', 0     # don't sidescroll automatically
+      set 'updatetime', options[:debounce_interval]
 
       # show match window
       split_location = options[:match_window_at_top] ? 'topleft' : 'botright'
@@ -66,29 +65,26 @@ module CommandT
         raise "Can't re-open GoToFile buffer" unless $curbuf.number == @@buffer.number
         $curwin.height = 1
       else        # creating match window for first time and set it up
-        split_command = "silent! #{split_location} 1split GoToFile"
-        [
-          split_command,
-          'setlocal bufhidden=unload',  # unload buf when no longer displayed
-          'setlocal buftype=nofile',    # buffer is not related to any file
-          'setlocal nomodifiable',      # prevent manual edits
-          'setlocal noswapfile',        # don't create a swapfile
-          'setlocal nowrap',            # don't soft-wrap
-          'setlocal nonumber',          # don't show line numbers
-          'setlocal nolist',            # don't use List mode (visible tabs etc)
-          'setlocal foldcolumn=0',      # don't show a fold column at side
-          'setlocal foldlevel=99',      # don't fold anything
-          'setlocal nocursorline',      # don't highlight line cursor is on
-          'setlocal nospell',           # spell-checking off
-          'setlocal nobuflisted',       # don't show up in the buffer list
-          'setlocal textwidth=0'        # don't hard-wrap (break long lines)
-        ].each { |command| ::VIM::command command }
+        ::VIM::command "silent! #{split_location} 1split GoToFile"
+        set 'bufhidden', 'unload' # unload buf when no longer displayed
+        set 'buftype', 'nofile'   # buffer is not related to any file
+        set 'modifiable', false   # prevent manual edits
+        set 'swapfile', false     # don't create a swapfile
+        set 'wrap', false         # don't soft-wrap
+        set 'number', false       # don't show line numbers
+        set 'list', false         # don't use List mode (visible tabs etc)
+        set 'foldcolumn', 0       # don't show a fold column at side
+        set 'foldlevel', 99       # don't fold anything
+        set 'cursorline', false   # don't highlight line cursor is on
+        set 'spell', false        # spell-checking off
+        set 'buflisted', false    # don't show up in the buffer list
+        set 'textwidth', 0        # don't hard-wrap (break long lines)
 
         # don't show the color column
-        ::VIM::command 'setlocal colorcolumn=0' if VIM::exists?('+colorcolumn')
+        set 'colorcolumn', 0 if VIM::exists?('+colorcolumn')
 
         # don't show relative line numbers
-        ::VIM::command 'setlocal norelativenumber' if VIM::exists?('+relativenumber')
+        set 'relativenumber', false if VIM::exists?('+relativenumber')
 
         # sanity check: make sure the buffer really was created
         raise "Can't find GoToFile buffer" unless $curbuf.name.match /GoToFile\z/
@@ -100,11 +96,11 @@ module CommandT
         ::VIM::command "syntax match CommandTSelection \"^#{SELECTION_MARKER}.\\+$\""
         ::VIM::command 'syntax match CommandTNoEntries "^-- NO MATCHES --$"'
         ::VIM::command 'syntax match CommandTNoEntries "^-- NO SUCH FILE OR DIRECTORY --$"'
-        ::VIM::command 'setlocal synmaxcol=9999'
+        set 'synmaxcol', 9999
 
         if VIM::has_conceal?
-          ::VIM::command 'setlocal conceallevel=2'
-          ::VIM::command 'setlocal concealcursor=nvic'
+          set 'conceallevel', 2
+          set 'concealcursor', 'nvic'
           ::VIM::command 'syntax region CommandTCharMatched ' \
                          "matchgroup=CommandTCharMatched start=+#{MH_START}+ " \
                          "matchgroup=CommandTCharMatchedEnd end=+#{MH_END}+ concealends"
@@ -115,7 +111,6 @@ module CommandT
 
         ::VIM::command "highlight link CommandTSelection #{@highlight_color}"
         ::VIM::command 'highlight link CommandTNoEntries Error'
-        ::VIM::evaluate 'clearmatches()'
 
         # hide cursor
         @cursor_highlight = get_cursor_highlight
@@ -266,6 +261,11 @@ module CommandT
 
   private
 
+    def set(setting, value)
+      @settings ||= Settings.new
+      @settings.set(setting, value)
+    end
+
     def move_cursor_to_selected_line
       # on some non-GUI terminals, the cursor doesn't hide properly
       # so we move the cursor to prevent it from blinking away in the
@@ -436,11 +436,11 @@ module CommandT
     end
 
     def lock
-      ::VIM::command 'setlocal nomodifiable'
+      set 'modifiable', false
     end
 
     def unlock
-      ::VIM::command 'setlocal modifiable'
+      set 'modifiable', true
     end
   end
 end

data/ruby/command-t/scanner/file_scanner.rb

@@ -1,4 +1,4 @@
-# Copyright 2010-2013 Wincent Colaiuta. All rights reserved.
+# Copyright 2010-2014 Wincent Colaiuta. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions are met:
@@ -26,11 +26,15 @@ require 'command-t/scanner'
 
 module CommandT
   # Reads the current directory recursively for the paths to all regular files.
+  #
+  # This is an abstract superclass; the real work is done by subclasses which
+  # obtain file listings via different strategies (for examples, see the
+  # RubyFileScanner and FindFileScanner subclasses).
   class FileScanner < Scanner
     class FileLimitExceeded < ::RuntimeError; end
     attr_accessor :path
 
-    def initialize path = Dir.pwd, options = {}
+    def initialize(path = Dir.pwd, options = {})
       @paths                = {}
       @paths_keys           = []
       @path                 = path
@@ -43,20 +47,11 @@ module CommandT
     end
 
     def paths
-      return @paths[@path] if @paths.has_key?(@path)
-      begin
+      @paths[@path] || begin
         ensure_cache_under_limit
-        @paths[@path] = []
-        @depth        = 0
-        @files        = 0
-        @prefix_len   = @path.chomp('/').length
-        set_wild_ignore(@wild_ignore)
-        add_paths_for_directory @path, @paths[@path]
-      rescue FileLimitExceeded
-      ensure
-        set_wild_ignore(@base_wild_ignore)
+        @prefix_len = @path.chomp('/').length
+        nil
       end
-      @paths[@path]
     end
 
     def flush
@@ -74,45 +69,15 @@ module CommandT
       @paths_keys << @path
     end
 
-    def path_excluded? path
+    def path_excluded?(path)
       # first strip common prefix (@path) from path to match VIM's behavior
       path = path[(@prefix_len + 1)..-1]
       path = VIM::escape_for_single_quotes path
       ::VIM::evaluate("empty(expand(fnameescape('#{path}')))").to_i == 1
     end
 
-    def looped_symlink? path
-      if File.symlink?(path)
-        target = File.expand_path(File.readlink(path), File.dirname(path))
-        target.include?(@path) || @path.include?(target)
-      end
-    end
-
     def set_wild_ignore(ignore)
       ::VIM::command("set wildignore=#{ignore}") if @wild_ignore
     end
-
-    def add_paths_for_directory dir, accumulator
-      Dir.foreach(dir) do |entry|
-        next if ['.', '..'].include?(entry)
-        path = File.join(dir, entry)
-        unless path_excluded?(path)
-          if File.file?(path)
-            @files += 1
-            raise FileLimitExceeded if @files > @max_files
-            accumulator << path[@prefix_len + 1..-1]
-          elsif File.directory?(path)
-            next if @depth >= @max_depth
-            next if (entry.match(/\A\./) && !@scan_dot_directories)
-            next if looped_symlink?(path)
-            @depth += 1
-            add_paths_for_directory path, accumulator
-            @depth -= 1
-          end
-        end
-      end
-    rescue Errno::EACCES
-      # skip over directories for which we don't have access
-    end
   end # class FileScanner
 end # module CommandT

data/ruby/command-t/scanner/file_scanner/find_file_scanner.rb

@@ -0,0 +1,77 @@
+# Copyright 2014 Wincent Colaiuta. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'open3'
+require 'command-t/vim'
+require 'command-t/vim/path_utilities'
+require 'command-t/scanner/file_scanner'
+
+module CommandT
+  class FileScanner
+    # A FileScanner which shells out to the `find` executable in order to scan.
+    class FindFileScanner < FileScanner
+      include VIM::PathUtilities
+
+      def paths
+        super || begin
+          set_wild_ignore(@wild_ignore)
+
+          # temporarily set field separator to NUL byte; this setting is
+          # respected by both `readlines` and `chomp!` below, and makes it easier
+          # to parse the output of `find -print0`
+          separator = $/
+          $/ = "\x00"
+
+          unless @scan_dot_directories
+            dot_directory_filter = [
+              '-not', '-path', "#{@path}/.*/*",           # top-level dot dir
+              '-and', '-not', '-path', "#{@path}/*/.*/*"  # lower-level dot dir
+            ]
+          end
+
+          Open3.popen3(*([
+            'find', '-L',                 # follow symlinks
+            @path,                        # anchor search here
+            '-maxdepth', @max_depth.to_s, # limit depth of DFS
+            '-type', 'f',                 # only show regular files (not dirs etc)
+            dot_directory_filter,         # possibly skip out dot directories
+            '-print0'                     # NUL-terminate results
+          ].flatten.compact)) do |stdin, stdout, stderr|
+            counter = 1
+            paths = []
+            stdout.readlines.each do |line|
+              next if path_excluded?(line.chomp!)
+              paths << line[@prefix_len + 1..-1]
+              break if (counter += 1) > @max_files
+            end
+            @paths[@path] = paths
+          end
+        ensure
+          $/ = separator
+          set_wild_ignore(@base_wild_ignore)
+        end
+        @paths[@path]
+      end
+    end # class FindFileScanner
+  end # class FileScanner
+end # module CommandT

data/ruby/command-t/scanner/file_scanner/ruby_file_scanner.rb

@@ -0,0 +1,78 @@
+# Copyright 2010-2014 Wincent Colaiuta. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'command-t/vim'
+require 'command-t/scanner/file_scanner'
+
+module CommandT
+  class FileScanner
+    # Pure Ruby implementation of a file scanner.
+    class RubyFileScanner < FileScanner
+      def paths
+        super || begin
+          @paths[@path] = []
+          @depth        = 0
+          @files        = 0
+          set_wild_ignore(@wild_ignore)
+          add_paths_for_directory @path, @paths[@path]
+        rescue FileLimitExceeded
+        ensure
+          set_wild_ignore(@base_wild_ignore)
+        end
+        @paths[@path]
+      end
+
+    private
+
+      def looped_symlink? path
+        if File.symlink?(path)
+          target = File.expand_path(File.readlink(path), File.dirname(path))
+          target.include?(@path) || @path.include?(target)
+        end
+      end
+
+      def add_paths_for_directory dir, accumulator
+        Dir.foreach(dir) do |entry|
+          next if ['.', '..'].include?(entry)
+          path = File.join(dir, entry)
+          unless path_excluded?(path)
+            if File.file?(path)
+              @files += 1
+              raise FileLimitExceeded if @files > @max_files
+              accumulator << path[@prefix_len + 1..-1]
+            elsif File.directory?(path)
+              next if @depth >= @max_depth
+              next if (entry.match(/\A\./) && !@scan_dot_directories)
+              next if looped_symlink?(path)
+              @depth += 1
+              add_paths_for_directory path, accumulator
+              @depth -= 1
+            end
+          end
+        end
+      rescue Errno::EACCES
+        # skip over directories for which we don't have access
+      end
+    end # class RubyFileScanner
+  end # class FileScanner
+end # module CommandT

data/ruby/command-t/scanner/file_scanner/watchman_file_scanner.rb

@@ -0,0 +1,79 @@
+# Copyright 2014 Wincent Colaiuta. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'json'
+require 'socket'
+require 'command-t/vim'
+require 'command-t/vim/path_utilities'
+require 'command-t/scanner/file_scanner'
+require 'command-t/scanner/file_scanner/find_file_scanner'
+
+module CommandT
+  class FileScanner
+    # A FileScanner which delegates the heavy lifting to Watchman
+    # (https://github.com/facebook/watchman); useful for very large hierarchies.
+    #
+    # Inherits from FindFileScanner so that it can fall back to it in the event
+    # that Watchman isn't available or able to fulfil the request.
+    class WatchmanFileScanner < FindFileScanner
+      # Exception raised when Watchman is unavailable or unable to process the
+      # requested path.
+      class WatchmanUnavailable < RuntimeError; end
+
+      def paths
+        @paths[@path] ||= begin
+          ensure_cache_under_limit
+          sockname = JSON[%x{watchman get-sockname}]['sockname']
+          raise WatchmanUnavailable unless $?.exitstatus.zero?
+          socket = UNIXSocket.open(sockname) do |s|
+            root = File.realpath(File.expand_path(@path))
+            s.puts JSON.generate(['watch-list'])
+            if !JSON[s.gets]['roots'].include?(root)
+              # this path isn't being watched yet; try to set up watch
+              s.puts JSON.generate(['watch', root])
+
+              # root_restrict_files setting may prevent Watchman from working
+              raise WatchmanUnavailable if JSON[s.gets].has_key?('error')
+            end
+
+            s.puts JSON.generate(['query', root, {
+              'expression' => ['type', 'f'],
+              'fields'     => ['name'],
+            }])
+            paths = JSON[s.gets]
+
+            # could return error if watch is removed
+            raise WatchmanUnavailable if paths.has_key?('error')
+
+            @paths[@path] = paths['files']
+          end
+        end
+
+        @paths[@path]
+      rescue Errno::ENOENT, WatchmanUnavailable
+        # watchman executable not present, or unable to fulfil request
+        super
+      end
+    end # class WatchmanFileScanner
+  end # class FileScanner
+end # module CommandT