vimrunner 0.0.1

data/LICENSE

@@ -0,0 +1,5 @@
+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 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

@@ -0,0 +1,5 @@
+## 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.

data/bin/vimrunner

@@ -0,0 +1,10 @@
+#! /usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'irb'
+require 'vimrunner'
+
+$vim = Vimrunner::Runner.start_gvim
+
+IRB.start

data/lib/vimrunner/errors.rb

@@ -0,0 +1,3 @@
+module Vimrunner
+  class InvalidCommandError < RuntimeError; end
+end

data/lib/vimrunner/runner.rb

@@ -0,0 +1,163 @@
+require 'vimrunner/shell'
+require 'vimrunner/errors'
+
+module Vimrunner
+
+  # The Runner class acts as the actual proxy to a vim instance. Upon
+  # initialization, a vim process is started in the background. The Runner
+  # instance's public methods correspond to actions the instance will perform.
+  #
+  # Use Runner#kill to manually destroy the background process.
+  class Runner
+    class << self
+      def start_gvim
+        child_stdin,   parent_stdin = IO::pipe
+        parent_stdout, child_stdout = IO::pipe
+        parent_stderr, child_stderr = IO::pipe
+
+        pid = Kernel.fork do
+          [parent_stdin, parent_stdout, parent_stderr].each { |io| io.close }
+
+          STDIN.reopen(child_stdin)
+          STDOUT.reopen(child_stdout)
+          STDERR.reopen(child_stderr)
+
+          [child_stdin, child_stdout, child_stderr].each { |io| io.close }
+
+          exec 'gvim', '-f', '-u', vimrc_path, '--noplugin', '--servername', 'VIMRUNNER'
+        end
+
+        [child_stdin, child_stdout, child_stderr].each { |io| io.close }
+
+        new(pid)
+      end
+
+      def vimrc_path
+        File.join(File.expand_path('../../..', __FILE__), 'vim', 'vimrc')
+      end
+    end
+
+    def initialize(pid)
+      @pid = pid
+      wait_until_started
+    end
+
+    # Adds a plugin to Vim's runtime. Initially, Vim is started without
+    # sourcing any plugins to ensure a clean state. This method can be used to
+    # populate the instance's environment.
+    #
+    # dir          - The base directory of the plugin, the one that contains
+    #                its autoload, plugin, ftplugin, etc. directories.
+    # entry_script - The vim script that's runtime'd to initialize the plugin.
+    #
+    # Example:
+    #
+    #   vim.add_plugin 'rails', 'plugin/rails.vim'
+    #
+    def add_plugin(dir, entry_script)
+      command("set runtimepath+=#{dir}")
+      command("runtime #{entry_script}")
+    end
+
+    def type(keys)
+      invoke_vim '--remote-send', keys
+    end
+
+    # Executes +vim_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|
+        raise InvalidCommandError if output =~ /^Vim:E\d+:/
+      end
+    end
+
+    # Starts a search in vim for the given text. The result is that the cursor
+    # is positioned on its first occurrence.
+    def search(text)
+      normal
+      type "/#{text}<cr>"
+    end
+
+    # Sets a setting in vim. If +value+ is nil, the setting is considered to be
+    # a boolean.
+    #
+    # Examples:
+    #
+    #   vim.set 'expandtab'  # invokes ":set expandtab"
+    #   vim.set 'tabstop', 3 # invokes ":set tabstop=3"
+    #
+    def set(setting, value = nil)
+      if value
+        command "set #{setting}=#{value}"
+      else
+        command "set #{setting}"
+      end
+    end
+
+    # Edits the file +filename+ with Vim.
+    def edit(filename)
+      invoke_vim '--remote', 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>'
+    end
+
+    # Switches vim to insert mode and types in the given text.
+    def insert(text = '')
+      normal
+      type "i#{text}"
+    end
+
+    # Switches vim to insert mode and types in the given keys.
+    def normal(keys = '')
+      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]
+      Shell.run *args
+    end
+
+    def wait_until_started
+      while serverlist.empty? or not serverlist.include? 'VIMRUNNER'
+        sleep 0.1
+      end
+    end
+  end
+end

data/lib/vimrunner/shell.rb

@@ -0,0 +1,32 @@
+module Vimrunner
+
+  # The Shell module contains functions that interact directly with the shell.
+  # They're general utilities that help with some of the specific use cases
+  # that pop up with the vim runner.
+  module Shell
+    extend self
+
+    # Executes a shell command, waits until it's finished, and returns the
+    # output
+    def run(*command)
+      IO.popen(command) { |io| io.read.strip }
+    end
+
+    # Sends a TERM signal to the given PID if it corresponds to a running
+    # process.
+    def kill(pid)
+      Process.kill(Signal.list['TERM'], pid) if running?(pid)
+    end
+
+    private
+
+    # Checks if the given PID corresponds to a running process
+    def running?(pid)
+      return false if pid.nil?
+      Process.getpgid(pid)
+      true
+    rescue Errno::ESRCH
+      false
+    end
+  end
+end

data/lib/vimrunner/version.rb

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

data/lib/vimrunner.rb

@@ -0,0 +1 @@
+require 'vimrunner/runner'

data/vim/vimrc

@@ -0,0 +1,19 @@
+set nocompatible
+
+filetype plugin on
+filetype indent on
+syntax on
+
+function! VimrunnerEvaluateCommandOutput(command)
+  let base_command = split(a:command, '\s\+')[0]
+
+  if !exists(':'.base_command)
+    let output = 'Vim:E492: Not an editor command: '.base_command
+  else
+    redir => output
+    silent exe a:command
+    redir END
+  endif
+
+  return output
+endfunction

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: vimrunner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Radev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &10798240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10798240
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &10796660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *10796660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &10794840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *10794840
+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"
+email:
+- andrey.radev@gmail.com
+executables:
+- vimrunner
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/vimrunner/shell.rb
+- lib/vimrunner/version.rb
+- lib/vimrunner/runner.rb
+- lib/vimrunner/errors.rb
+- lib/vimrunner.rb
+- vim/vimrc
+- bin/vimrunner
+- LICENSE
+- README.md
+homepage: http://github.com/AndrewRadev/vimrunner
+licenses: []
+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: -1926415317328212253
+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.11
+signing_key: 
+specification_version: 3
+summary: Lets you control a vim instance through ruby
+test_files: []