Merge pull request #19 from zhaocai/master

 Improve connect behavior

lib/vimrunner.rb

@@ -60,6 +60,6 @@ def self.start_gvim(&blk)
   #
   # Returns a Client for the named server.
   def self.connect(name)
-    Server.new(:name => name).connect
+    Server.new(:name => name).connect(:spawn => true)
   end
 end

lib/vimrunner/client.rb

@@ -25,6 +25,19 @@ def add_plugin(dir, entry_script = nil)
       command("runtime #{entry_script}") if entry_script
     end
 
+    # Public: source a script in Vim server
+    #
+    # script - The Vim script to be sourced
+    #
+    # Examples
+    #
+    #   vim.source '/path/to/plugin/rails.vim'
+    #
+    # Returns nothing.
+    def source(script)
+      feedkeys(":\\<C-u>source #{filename_escape(script)}\\<CR>")
+    end
+
     # Public: Appends a directory to Vim's runtimepath
     #
     # dir - The directory added to the path
@@ -144,7 +157,7 @@ def set(setting, value = nil)
     #
     # Returns the Client instance.
     def edit(filename)
-      command "edit #{filename}"
+      command "edit #{filename_escape(filename)}"
       self
     end
 
@@ -154,7 +167,7 @@ def edit(filename)
     #
     # Returns the Client instance.
     def edit!(filename)
-      command "edit! #{filename}"
+      command "edit! #{filename_escape(filename)}"
       self
     end
 
@@ -174,6 +187,12 @@ def kill
       server.kill
     end
 
+    def filename_escape(name)
+      name.gsub(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1")
+    end
+
+
+
     private
 
     def escape(string)

lib/vimrunner/server.rb

@@ -17,8 +17,9 @@ module Vimrunner
   # to use a Server directly to invoke --remote commands on its Vim instance.
   class Server
     VIMRC = File.expand_path("../../../vim/vimrc", __FILE__)
+    VIMRUNNER_RC = File.expand_path("../../../vim/vimrunner_rc", __FILE__)
 
-    attr_reader :name, :executable
+    attr_reader :name, :executable, :vimrc
 
     # Public: Initialize a Server
     #
@@ -30,6 +31,8 @@ class Server
     def initialize(options = {})
       @executable = options.fetch(:executable) { Platform.vim }
       @name       = options.fetch(:name) { "VIMRUNNER#{rand}" }
+      @vimrc      = options.fetch(:vimrc) { VIMRC }
+      @foreground = options.fetch(:foreground, true)
     end
 
     # Public: Start a Server. This spawns a background process.
@@ -46,32 +49,34 @@ def initialize(options = {})
     # Returns a new Client instance initialized with this Server.
     # Yields a new Client instance initialized with this Server.
     def start
+      @r, @w, @pid = spawn
       if block_given?
-        spawn do |r, w, pid|
-          begin
-            @result = yield(connect)
-          ensure
-            r.close
-            w.close
-            Process.kill(9, pid) rescue Errno::ESRCH
-          end
+        begin
+          @result = yield(connect)
+        ensure
+          @r.close
+          @w.close
+          Process.kill(9, @pid) rescue Errno::ESRCH
         end
-
         @result
       else
-        @r, @w, @pid = spawn
-
         connect
       end
     end
 
     # Public: Connects to the running server by name, blocking if need be.
     #
     # Returns a new Client instance initialized with this Server.
-    def connect
+    def connect(options = {})
+      if !connected? && options[:spawn]
+        @r, @w, @pid = spawn
+      end
       wait_until_started
 
-      new_client
+      client = new_client
+      client.source(VIMRUNNER_RC)
+
+      return client
     end
 
     # Public: Checks if the server is connected to a running Vim instance.
@@ -129,12 +134,16 @@ def remote_send(keys)
 
     private
 
+    def foreground_option
+      @foreground ? '-f' : ''
+    end
+
     def execute(command)
       IO.popen(command) { |io| io.read.strip }
     end
 
-    def spawn(&blk)
-      PTY.spawn(executable, "-f", "--servername", name, "-u", VIMRC, &blk)
+    def spawn
+      PTY.spawn("#{executable} #{foreground_option} --servername #{name} -u #{vimrc}")
     end
 
     def wait_until_started

vim/vimrc

@@ -10,34 +10,4 @@ set noswapfile nobackup
 set runtimepath-=~/.vim
 set runtimepath-=~/.vim/after
 
-function! VimrunnerEvaluateCommandOutput(command)
-  let output = ''
-
-  try
-    redir => output
-    silent exe a:command
-    redir END
-
-    let output = s:StripSilencedErrors(output)
-  catch
-    let output = v:exception
-  endtry
-
-  return output
-endfunction
-
-" Remove errors from the output that have been silenced by :silent!. These are
-" visible in the captured output since all messages are captured by :redir.
-function! s:StripSilencedErrors(output)
-  let processed_output = []
-
-  for line in reverse(split(a:output, "\n"))
-    if line =~ '^E\d\+:'
-      break
-    endif
-
-    call add(processed_output, line)
-  endfor
-
-  return join(reverse(processed_output), "\n")
-endfunction
+execute "source " . expand('<sfile>:p:h') . "/vimrunner_rc"

vim/vimrunner_rc

@@ -0,0 +1,33 @@
+function! VimrunnerEvaluateCommandOutput(command)
+  let output = ''
+
+  try
+    redir => output
+    silent exe a:command
+    redir END
+
+    let output = s:StripSilencedErrors(output)
+  catch
+    let output = v:exception
+  endtry
+
+  return output
+endfunction
+
+" Remove errors from the output that have been silenced by :silent!. These are
+" visible in the captured output since all messages are captured by :redir.
+function! s:StripSilencedErrors(output)
+  let processed_output = []
+
+  for line in reverse(split(a:output, "\n"))
+    if line =~ '^E\d\+:'
+      break
+    endif
+
+    call add(processed_output, line)
+  endfor
+
+  return join(reverse(processed_output), "\n")
+endfunction
+
+" vim: set ft=vim