vimrunner 0.1.0 → 0.1.1

data/LICENSE

@@ -1,5 +1,17 @@
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -34,9 +34,9 @@ vim.kill
 ```
 
 Vimrunner will attempt to start up the most suitable version of Vim available,
-meaning:
+meaning one of the following:
 
-* `vim` if it supports headlessly creating servers;
+* `vim` if it supports headlessly creating servers (see [Requirements](#requirements) below for more information);
 * `mvim` if you are on Mac OS X;
 * `gvim`.
 
@@ -63,7 +63,7 @@ examples.)
 
 Calling `start` (or `start_gvim`) will return a `Client` instance with which
 you can control Vim. For a full list of methods you can invoke on the remote
-vim instance, check out the [`Client`
+Vim instance, check out the [`Client`
 documentation](http://rubydoc.info/gems/vimrunner/Vimrunner/Client).
 
 ## Requirements
@@ -78,7 +78,7 @@ manual](http://vimdoc.sourceforge.net/htmldoc/remote.html#x11-clientserver).
 The client/server functionality (regrettably) needs a running X server to
 function, even without a GUI. This means that if you're using it for
 automated tests on a remote server, you'll probably need to start it with
-xvfb.
+Xvfb.
 
 If you are using MacVim, note that you will need the `mvim` binary in your
 `PATH` in order to start and communicate with Vim servers.

data/lib/vimrunner/client.rb

@@ -21,30 +21,53 @@ module Vimrunner
     #
     # Returns nothing.
     def add_plugin(dir, entry_script = nil)
-      command("set runtimepath+=#{dir}")
+      append_runtimepath(dir)
       command("runtime #{entry_script}") if entry_script
     end
 
-    # Public: Switches Vim to normal mode and types in the given keys.
+    # Public: Appends a directory to Vim's runtimepath
+    #
+    # dir - The directory added to the path
+    #
+    # Returns nothing.
+    def append_runtimepath(dir)
+      command("set runtimepath+=#{dir}")
+    end
+
+    # Public: Prepends a directory to Vim's runtimepath. Use this instead of
+    # #append_runtimepath to give the directory higher priority when Vim
+    # runtime's a file.
+    #
+    # dir - The directory added to the path
     #
     # Returns nothing.
+    def prepend_runtimepath(dir)
+      runtimepath = echo '&runtimepath'
+      command("set runtimepath=#{dir},#{runtimepath}")
+    end
+
+    # Public: Switches Vim to normal mode and types in the given keys.
+    #
+    # Returns the Client instance.
     def normal(keys = "")
       server.remote_send("<C-\\><C-n>#{keys}")
+      self
     end
 
     # Public: 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.
     #
-    # Returns nothing.
+    # Returns the Client instance.
     def type(keys)
       server.remote_send(keys)
+      self
     end
 
     # Public: Starts a search in Vim for the given text. The result is that
     # the cursor is positioned on its first occurrence.
     #
-    # Returns nothing.
+    # Returns the Client instance.
     def search(text)
       normal
       type "/#{text}<CR>"
@@ -52,15 +75,18 @@ module Vimrunner
 
     # Public: Switches Vim to insert mode and types in the given text.
     #
-    # Returns nothing.
+    # Returns the Client instance.
     def insert(text)
       normal "i#{text}"
     end
 
     # Public: Writes the file being edited to disk. Note that you probably
     # want to set the file's name first by using Runner#edit.
+    #
+    # Returns the Client instance.
     def write
       command :write
+      self
     end
 
     # Public: Echo each expression with a space in between.
@@ -78,12 +104,14 @@ module Vimrunner
     #   vim.set 'expandtab'  # invokes ":set expandtab"
     #   vim.set 'tabstop', 3 # invokes ":set tabstop=3"
     #
+    # Returns the Client instance
     def set(setting, value = nil)
       if value
         command "set #{setting}=#{value}"
       else
         command "set #{setting}"
       end
+      self
     end
 
     # Public: Edits the file +filename+ with Vim.
@@ -92,21 +120,32 @@ module Vimrunner
     # the command manually. This is necessary to avoid the Vim instance
     # getting focus.
     #
-    # Returns nothing.
+    # Returns the Client instance.
     def edit(filename)
       command "edit #{filename}"
+      self
+    end
+
+    # Public: Edits the file +filename+ with Vim using edit!.
+    #
+    # Similar to #edit, only discards any changes to the current buffer.
+    #
+    # Returns the Client instance.
+    def edit!(filename)
+      command "edit! #{filename}"
+      self
     end
 
     # Public: Executes the given command in the Vim instance and returns its
     # output, stripping all surrounding whitespace.
     #
-    # Returns the string output.
+    # Returns the String output.
     # Raises InvalidCommandError if the command is not recognised by vim.
     def command(commands)
       expression = "VimrunnerEvaluateCommandOutput('#{escape(commands)}')"
 
       server.remote_expr(expression).tap do |output|
-        raise InvalidCommandError if output =~ /^Vim:E\d+:/
+        raise InvalidCommandError.new(output) if output =~ /^Vim:E\d+:/
       end
     end
 

data/lib/vimrunner/server.rb

@@ -46,6 +46,7 @@ module Vimrunner
           ensure
             r.close
             w.close
+            Process.kill(9, pid) rescue Errno::ESRCH
           end
         end
 
@@ -64,7 +65,7 @@ module Vimrunner
     def kill
       @r.close
       @w.close
-      Process.detach(@pid)
+      Process.kill(9, @pid) rescue Errno::ESRCH
 
       self
     end

data/lib/vimrunner/version.rb

@@ -1,3 +1,3 @@
 module Vimrunner
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/vim/vimrc

@@ -4,8 +4,11 @@ filetype plugin on
 filetype indent on
 syntax on
 
+set noswapfile nobackup
+
 function! VimrunnerEvaluateCommandOutput(command)
   let base_command = split(a:command, '\s\+')[0]
+  let base_command = substitute(base_command, '!$', '', '')
 
   if !exists(':'.base_command)
     let output = 'Vim:E492: Not an editor command: '.base_command

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vimrunner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000 Z
+date: 2012-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19072460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19072460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &19071860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19071860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &19071280 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19071280
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19069980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *19069980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 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 can be used to integration test Vim script.\n"
@@ -65,12 +85,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/vimrunner.rb
-- lib/vimrunner/errors.rb
 - lib/vimrunner/server.rb
 - lib/vimrunner/platform.rb
 - lib/vimrunner/version.rb
 - lib/vimrunner/client.rb
+- lib/vimrunner/errors.rb
+- lib/vimrunner.rb
 - vim/vimrc
 - bin/vimrunner
 - LICENSE
@@ -89,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3979564230760095821
+      hash: 1355458872230700164
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -98,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: vimrunner
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Lets you control a Vim instance through Ruby