vimrunner 0.3.0 → 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 909bbbe33a49a9bab23bc10ac3dd7be7a651e45a
+  data.tar.gz: 481ed70f35cb0553c30cd640bd35b8219c2b2ac6
+SHA512:
+  metadata.gz: db74708c88bbf8469fec2208ce52fc2dff56a032e4c38c8ab3f1577875047de6b02f2b997d062eb68de1c0e7290b9b457194f6cdfb33322bf6217c4579cf71fd
+  data.tar.gz: ab74da6d7d93ad25a30ddcdf16da44e58a10c48b3ad1bf4bad6262801d855646d47b1f23a792cb7ccbfee279242088f47af4d30b4f758a90d603cbeb43d14f49

data/README.md

@@ -6,6 +6,9 @@ functionality, this library exposes a way to spawn a Vim instance and control
 it programatically. Apart from being a fun party trick, this can be used to do
 integration testing on Vimscript.
 
+The latest stable documentation can be found
+[on rubydoc.info](http://rubydoc.info/gems/vimrunner/frames).
+
 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).
@@ -64,8 +67,8 @@ 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`
-documentation](http://rubydoc.info/gems/vimrunner/Vimrunner/Client).
+Vim instance, check out the `Client`
+[documentation](http://rubydoc.info/gems/vimrunner/Vimrunner/Client).
 
 If you already have a remote-capable Vim server running, you can connect
 Vimrunner to it directly by using `Vimrunner.connect` or `Vimrunner.connect!`
@@ -110,7 +113,7 @@ Vimrunner::RSpec.configure do |config|
     # vim = Vimrunner.start_gvim
 
     # Setup your plugin in the Vim instance
-    plugin_path = File.expand_path('.')
+    plugin_path = File.expand_path('../..', __FILE__)
     vim.add_plugin(plugin_path, 'plugin/my_plugin.vim')
 
     # The returned value is the Client available in the tests.

data/lib/vimrunner/client.rb

@@ -1,3 +1,6 @@
+require "vimrunner/path"
+require "vimrunner/command"
+
 module Vimrunner
   class Client
     attr_reader :server
@@ -22,7 +25,10 @@ module Vimrunner
     # Returns nothing.
     def add_plugin(dir, entry_script = nil)
       append_runtimepath(dir)
-      command("runtime #{entry_script}") if entry_script
+      if entry_script
+        entry_script_path = Path.new(entry_script)
+        command("runtime #{entry_script_path}")
+      end
     end
 
     # Public: source a script in Vim server
@@ -35,7 +41,8 @@ module Vimrunner
     #
     # Returns nothing.
     def source(script)
-      feedkeys(":\\<C-u>source #{escape_filename(script)}\\<CR>")
+      script_path = Path.new(script)
+      feedkeys(":\\<C-u>source #{script_path}\\<CR>")
     end
 
     # Public: Appends a directory to Vim's runtimepath
@@ -44,7 +51,8 @@ module Vimrunner
     #
     # Returns nothing.
     def append_runtimepath(dir)
-      command("set runtimepath+=#{dir}")
+      dir_path = Path.new(dir)
+      command("set runtimepath+=#{dir_path}")
     end
 
     # Public: Prepends a directory to Vim's runtimepath. Use this instead of
@@ -55,8 +63,9 @@ module Vimrunner
     #
     # Returns nothing.
     def prepend_runtimepath(dir)
-      runtimepath = echo '&runtimepath'
-      command("set runtimepath=#{dir},#{runtimepath}")
+      dir_path = Path.new(dir)
+      runtimepath = Path.new(echo('&runtimepath'))
+      command("set runtimepath=#{dir_path},#{runtimepath}")
     end
 
     # Public: Switches Vim to normal mode and types in the given keys.
@@ -157,7 +166,8 @@ module Vimrunner
     #
     # Returns the Client instance.
     def edit(filename)
-      command "edit #{escape_filename(filename)}"
+      file_path = Path.new(filename)
+      command "edit #{file_path}"
       self
     end
 
@@ -167,7 +177,8 @@ module Vimrunner
     #
     # Returns the Client instance.
     def edit!(filename)
-      command "edit! #{escape_filename(filename)}"
+      file_path = Path.new(filename)
+      command "edit! #{file_path}"
       self
     end
 
@@ -177,8 +188,9 @@ module Vimrunner
     # Returns the String output.
     # Raises InvalidCommandError if the command is not recognised by vim.
     def command(commands)
-      server.remote_expr("VimrunnerEvaluateCommandOutput('#{escape_single_quote(commands)}')").tap do |output|
-        raise InvalidCommandError.new(output) if output =~ /^Vim:E\d+:/
+      command = Command.new(commands)
+      server.remote_expr("VimrunnerEvaluateCommandOutput('#{command}')").tap do |output|
+        raise InvalidCommandError.new(output) if output =~ /^Vim(\(call\))?:E\d+:/
       end
     end
 
@@ -187,14 +199,9 @@ module Vimrunner
       server.kill
     end
 
-    private
-
-    def escape_filename(name)
-      name.gsub(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1")
-    end
-
-    def escape_single_quote(string)
-      string.to_s.gsub("'", "''")
+    # Bring the server to foreground
+    def foreground
+      server.remote_expr("foreground()")
     end
   end
 end

data/lib/vimrunner/command.rb

@@ -0,0 +1,11 @@
+module Vimrunner
+  class Command
+    def initialize(command)
+      @command = command
+    end
+
+    def to_s
+      @command.to_s.gsub("'", "''")
+    end
+  end
+end

data/lib/vimrunner/path.rb

@@ -0,0 +1,11 @@
+module Vimrunner
+  class Path
+    def initialize(path)
+      @path = path
+    end
+
+    def to_s
+      @path.to_s.gsub(/([^A-Za-z0-9_\-.,:\/@\n])/, "\\\\\\1")
+    end
+  end
+end

data/lib/vimrunner/server.rb

@@ -13,13 +13,13 @@ module Vimrunner
   # an existing Vim instance, it can control that instance without the need to
   # start a new process.
   #
-  # A Client would be necessary as there's a ctual interface, though it is possible
+  # A Client would be necessary as an actual interface, though it is possible
   # 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, :vimrc
+    attr_reader :name, :executable, :vimrc, :gvimrc
 
     # Public: Initialize a Server
     #
@@ -35,8 +35,9 @@ module Vimrunner
     #
     def initialize(options = {})
       @executable = options.fetch(:executable) { Platform.vim }
-      @name       = options.fetch(:name) { "VIMRUNNER#{rand}" }
+      @name       = options.fetch(:name) { "VIMRUNNER#{rand}" }.upcase
       @vimrc      = options.fetch(:vimrc) { VIMRC }
+      @gvimrc     = options.fetch(:gvimrc) { "NONE" }
       @foreground = options.fetch(:foreground, true)
     end
 
@@ -149,7 +150,7 @@ module Vimrunner
     end
 
     # Public: Sends the given keys
-    # A wrapper around --remote-expr.
+    # A wrapper around --remote-send.
     #
     # keys - a String with a sequence of Vim-compatible keystrokes.
     #
@@ -169,7 +170,9 @@ module Vimrunner
     end
 
     def spawn
-      PTY.spawn("#{executable} #{foreground_option} --servername #{name} -u #{vimrc}")
+      PTY.spawn(executable, *%W[
+        #{foreground_option} --servername #{name} -u #{vimrc} -U #{gvimrc}
+      ])
     end
 
     def wait_until_running(seconds)

data/lib/vimrunner/version.rb

@@ -1,3 +1,3 @@
 module Vimrunner
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/vim/vimrc

@@ -9,5 +9,3 @@ set noswapfile nobackup
 " remove default ~/.vim directories to avoid loading plugins
 set runtimepath-=~/.vim
 set runtimepath-=~/.vim/after
-
-execute "source " . expand('<sfile>:p:h') . "/vimrunner_rc"

data/vim/vimrunner_rc

@@ -24,6 +24,7 @@ else
   function! VimrunnerEvaluateCommandOutput(command)
     let base_command = split(a:command, '\s\+')[0]
     let base_command = substitute(base_command, '!$', '', '')
+    let base_command = substitute(base_command, '^\d\+', '', '')
 
     if !exists(':'.base_command)
       let output = 'Vim:E492: Not an editor command: '.base_command

metadata

@@ -1,83 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: vimrunner
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Radev
+- Paul Mucur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-21 00:00:00.000000000 Z
+date: 2014-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.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"
+description: |2
+      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 can be used to integration test Vim script.
 email:
 - andrey.radev@gmail.com
 executables:
@@ -85,44 +78,42 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
+- README.md
+- bin/vimrunner
 - lib/vimrunner.rb
 - lib/vimrunner/client.rb
-- lib/vimrunner/testing.rb
-- lib/vimrunner/rspec.rb
+- lib/vimrunner/command.rb
 - lib/vimrunner/errors.rb
-- lib/vimrunner/version.rb
-- lib/vimrunner/server.rb
+- lib/vimrunner/path.rb
 - lib/vimrunner/platform.rb
-- vim/vimrunner_rc
+- lib/vimrunner/rspec.rb
+- lib/vimrunner/server.rb
+- lib/vimrunner/testing.rb
+- lib/vimrunner/version.rb
 - vim/vimrc
-- bin/vimrunner
-- LICENSE
-- README.md
+- vim/vimrunner_rc
 homepage: http://github.com/AndrewRadev/vimrunner
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1164770989909868074
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: vimrunner
-rubygems_version: 1.8.24
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Lets you control a Vim instance through Ruby
 test_files: []