vimrunner 0.1.1 → 0.2.0

data/README.md

@@ -66,6 +66,55 @@ 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).
 
+## Testing
+
+If you're using Vimrunner for testing vim plugins, take a look at the
+documentation for the
+[Vimrunner::Testing](http://rubydoc.info/gems/vimrunner/Vimrunner/Testing)
+module. It contains a few simple helpers that may make it a bit easier to write
+regression tests in rspec. With them, it could work something like this:
+
+``` ruby
+require 'spec_helper'
+require 'vimrunner/testing'
+
+describe "My Vim plugin" do
+  let(:vim) { some_instance_of_vim }
+
+  around :each do |example|
+    # needed only once for any Vim instance:
+    vim.add_plugin(File.expand_path('../my_plugin_path'), 'plugin/my_plugin.vim')
+
+    # ensure a clean temporary directory for each test:
+    Vimrunner::Testing.tmpdir(vim) do
+      example.call
+    end
+  end
+
+  specify "some behaviour" do
+    Vimrunner::Testing.write_file('test.rb', <<-EOF)
+      def foo
+        bar
+      end
+    EOF
+
+    vim.edit 'test.rb'
+    do_plugin_related_stuff_with(vim)
+    vim.write
+
+    IO.read('test.rb').should eq Vimrunner::Testing.normalize_string_indent(<<-EOF)
+      def bar
+        foo
+      end
+    EOF
+  end
+end
+```
+
+It's possible to make this a lot more concise by including
+`Vimrunner::Testing`, by making your own helper methods that wrap common
+behaviour, by extracting some code to `spec_helper.rb`, and so on.
+
 ## Requirements
 
 Vim needs to be compiled with `+clientserver`. This should be available with

data/lib/vimrunner/testing.rb

@@ -0,0 +1,80 @@
+require 'tmpdir'
+
+module Vimrunner
+
+  # Public: Provides some utility helpers to assist in using Vimrunner for
+  # testing purposes.
+  module Testing
+
+    # Public: Within the given block, switches to a temporary directory for
+    # isolation purposes.
+    #
+    # Example:
+    #
+    #   tmpdir(vim) do
+    #     puts vim.command('pwd')
+    #   end
+    #
+    # vim - a Vimrunner::Client instance
+    #
+    # Returns nothing.
+    # Yields nothing.
+    def tmpdir(vim)
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          vim.command("cd #{dir}")
+          yield
+        end
+      end
+    end
+
+    # Public: Writes the given string to the file identified by "filename".
+    #
+    # Uses #normalize_string_indent to ensure consistent indentation when given
+    # a heredoc, and takes care to write it in the same way that Vim would.
+    #
+    # filename - a String, the name of the file to write
+    # string   - a String, the contents of the file
+    #
+    # Returns nothing.
+    def write_file(filename, string)
+      string = normalize_string_indent(string)
+      File.open(filename, 'w') { |f| f.write(string + "\n") }
+    end
+
+    # Public: Normalizes a string's indentation whitespace, so that heredocs
+    # can be used more easily for testing.
+    #
+    # Example
+    #
+    #   foo = normalize_string_indent(<<-EOF)
+    #     def foo
+    #       bar
+    #     end
+    #   EOF
+    #
+    # In this case, the raw string would have a large chunk of indentation in
+    # the beginning due to its location within the code. The helper removes all
+    # whitespace in the beginning by taking the one of the first line.
+    #
+    # Note: #scan and #chop are being used instead of #split to avoid
+    # discarding empty lines.
+    #
+    # string - a String, usually defined using a heredoc
+    #
+    # Returns a String with reduced indentation.
+    def normalize_string_indent(string)
+      if string.end_with?("\n")
+        lines      = string.scan(/.*\n/).map(&:chop)
+        whitespace = lines.grep(/\S/).first.scan(/^\s*/).first
+      else
+        lines      = [string]
+        whitespace = string.scan(/^\s*/).first
+      end
+
+      lines.map do |line|
+        line.gsub(/^#{whitespace}/, '') if line =~ /\S/
+      end.join("\n")
+    end
+  end
+end

data/lib/vimrunner/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vimrunner
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-06 00:00:00.000000000 Z
+date: 2012-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -85,12 +85,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/vimrunner/server.rb
-- lib/vimrunner/platform.rb
-- lib/vimrunner/version.rb
+- lib/vimrunner.rb
 - lib/vimrunner/client.rb
+- lib/vimrunner/testing.rb
 - lib/vimrunner/errors.rb
-- lib/vimrunner.rb
+- lib/vimrunner/version.rb
+- lib/vimrunner/server.rb
+- lib/vimrunner/platform.rb
 - vim/vimrc
 - bin/vimrunner
 - LICENSE
@@ -109,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1355458872230700164
+      hash: 1021095784452390189
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: