vimrunner 0.0.1 → 0.0.2

data/README.md

@@ -1,5 +1,24 @@
-## Very not ready yet, please ignore
-
 Using Vim's client/server functionality, this library exposes a way to spawn a
 Vim instance and control it programatically. Apart from being a fun party
 trick, this could be used to do integration testing on vimscript.
+
+The `vimrunner` executable opens up an irb session with `$vim` set to a running
+`gvim` instance. A few things you can try:
+
+``` ruby
+$vim.edit 'some_file_name'  # edit a file
+$vim.insert 'Hello, World!' # enter insert mode and write some text
+$vim.normal 'T,'            # go back to the nearest comma
+$vim.type 'a<cr>'           # append a newline after the comma
+$vim.write                  # write file to disk
+```
+
+For more examples of what you can do, you could take a look at the specs, they
+should be fairly readable.
+
+Note that this should work on a Linux box, but probably won't on a Mac. I'm
+assuming you'd need to change the binary to `mvim` at the very least.
+
+This is still fairly experimental, so use with caution. Any issue reports or
+contributions are very welcome on the
+[github issue tracker](https://github.com/AndrewRadev/Vimrunner/issues)

data/lib/vimrunner/runner.rb

@@ -9,8 +9,12 @@ module Vimrunner
   #
   # Use Runner#kill to manually destroy the background process.
   class Runner
+    attr_reader :servername
+
     class << self
       def start_gvim
+        servername = "VIMRUNNER#{rand.to_s.gsub '.', ''}"
+
         child_stdin,   parent_stdin = IO::pipe
         parent_stdout, child_stdout = IO::pipe
         parent_stderr, child_stderr = IO::pipe
@@ -24,21 +28,26 @@ module Vimrunner
 
           [child_stdin, child_stdout, child_stderr].each { |io| io.close }
 
-          exec 'gvim', '-f', '-u', vimrc_path, '--noplugin', '--servername', 'VIMRUNNER'
+          exec 'gvim', '-f', '-u', vimrc_path, '--noplugin', '--servername', servername
         end
 
         [child_stdin, child_stdout, child_stderr].each { |io| io.close }
 
-        new(pid)
+        new(pid, servername)
       end
 
       def vimrc_path
         File.join(File.expand_path('../../..', __FILE__), 'vim', 'vimrc')
       end
+
+      def serverlist
+        %x[vim --serverlist].strip.split "\n"
+      end
     end
 
-    def initialize(pid)
-      @pid = pid
+    def initialize(pid, servername)
+      @pid        = pid
+      @servername = servername
       wait_until_started
     end
 
@@ -59,16 +68,21 @@ module Vimrunner
       command("runtime #{entry_script}")
     end
 
+    # Invokes one of the basic actions the vim server supports, sending a key
+    # sequence. The keys are sent as-is, so it'd probably be better to use the
+    # wrapper methods, #normal, #insert and so on.
     def type(keys)
       invoke_vim '--remote-send', keys
     end
 
-    # Executes +vim_command+ in the vim instance and returns its output,
+    # Executes the given command in the vim instance and returns its output,
     # stripping all surrounding whitespace.
     def command(vim_command)
       normal
 
-      invoke_vim('--remote-expr', "VimrunnerEvaluateCommandOutput('#{vim_command.to_s}')").strip.tap do |output|
+      expression = "VimrunnerEvaluateCommandOutput('#{vim_command.to_s}')"
+
+      invoke_vim('--remote-expr', expression).strip.tap do |output|
         raise InvalidCommandError if output =~ /^Vim:E\d+:/
       end
     end
@@ -97,21 +111,23 @@ module Vimrunner
     end
 
     # Edits the file +filename+ with Vim.
+    #
+    # Note that this doesn't use the '--remote' vim flag, it simply types in
+    # the command manually. This is necessary to avoid the vim instance getting
+    # focus.
     def edit(filename)
-      invoke_vim '--remote', filename
+      command "edit #{filename}"
     end
 
     # Writes the file being edited to disk. Note that you need to set the
     # file's name first by using Runner#edit.
     def write
-      normal
-      type ':w<cr>'
+      command :write
     end
 
     # Switches vim to insert mode and types in the given text.
     def insert(text = '')
-      normal
-      type "i#{text}"
+      normal "i#{text}"
     end
 
     # Switches vim to insert mode and types in the given keys.
@@ -119,44 +135,23 @@ module Vimrunner
       type "<c-\\><c-n>#{keys}"
     end
 
-    def quit
-      normal 'ZZ'
-    end
-
     # Kills the vim instance in the background by sending it a TERM signal.
     def kill
       Shell.kill(@pid)
     end
 
-    # Ensures that vim has finished with its previous action. This is useful
-    # when a command has been sent to the vim instance that might take a little
-    # while, and we need to check the results of the command.
-    #
-    # Example:
-    #
-    #   runner.write
-    #   runner.wait_until_ready
-    #   # Provided there was no error, the file should now be written
-    #   # successfully
-    #
-    def wait_until_ready
-      command :echo
-    end
-
     private
 
-    def serverlist
-      %x[vim --serverlist].strip.split '\n'
-    end
-
     def invoke_vim(*args)
-      args = ['vim', '--servername', 'VIMRUNNER', *args]
+      args = ['vim', '--servername', @servername, *args]
       Shell.run *args
     end
 
     def wait_until_started
-      while serverlist.empty? or not serverlist.include? 'VIMRUNNER'
+      serverlist = Runner.serverlist
+      while serverlist.empty? or not serverlist.include? @servername
         sleep 0.1
+        serverlist = Runner.serverlist
       end
     end
   end

data/lib/vimrunner/version.rb

@@ -1,3 +1,3 @@
 module Vimrunner
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vimrunner
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-28 00:00:00.000000000Z
+date: 2011-10-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10798240 !ruby/object:Gem::Requirement
+  requirement: &22761920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10798240
+  version_requirements: *22761920
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &10796660 !ruby/object:Gem::Requirement
+  requirement: &22761500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10796660
+  version_requirements: *22761500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10794840 !ruby/object:Gem::Requirement
+  requirement: &22761000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *10794840
+  version_requirements: *22761000
 description: ! "    Using vim's client/server functionality, this library exposes
   a way to\n    spawn a vim instance and control it programatically. Apart from being
   a fun\n    party trick, this could be used to do integration testing on vimscript.\n"
@@ -77,7 +77,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1926415317328212253
+      hash: -4179387824099540343
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: