robot-vim 0.10.0 → 1.0.0

data/README.md

@@ -17,12 +17,15 @@ RobotVim is developed with Vim 7.3, Ruby 1.9.2, and bundler.
 ## Example Usage
 
 ### Initialization
-Create an instance that will use your user's default Vim
+Create an instance that will use your user's default Vim and vimrc
     robot = RobotVim::Runner.new()
 
-Or create an instance with a specific Vim
+Create an instance with a specific Vim
     robot = RobotVim::Runner.new(:vim => "/bin/vim")
 
+Create an instance with a specific vimrc
+    robot = RobotVim::Runner.new(:vimrc => "something/vimrc")
+
 ### Running commands
 Commands are passed in as a string with one command per line.
 
@@ -53,7 +56,7 @@ spec/integration\_spec.rb contains examples of asserting with Rspec
 - automatically save buffer to an output file after running the last command(done)
 - automatically close Vim after running the last command(done)
 - take a string for input and write out a temporary file that Vim will run against(done)
-- figure out if there is a way to specify a .vimrc file without disabling the normal Vim initialization process
+- figure out if there is a way to specify a .vimrc file without disabling the normal Vim initialization process(done)
 
 ## Author
 RobotVim is developed by Matt Margolis | mrmargolis | matt@mattmargolis.net

data/lib/robot-vim/runner.rb

@@ -1,15 +1,21 @@
 module RobotVim
   class Runner
     DEFAULT_VIM_BINARY = "vim"
+    DEFAULT_VIMRC = File.join(File.expand_path("~"), ".vimrc")
 
     def initialize(args={})
       @vim_binary = args[:vim]
+      @vimrc = args[:vimrc]
     end
 
     def vim_binary
       @vim_binary || DEFAULT_VIM_BINARY
     end
 
+    def vimrc
+      @vimrc || DEFAULT_VIMRC
+    end
+
     def run(args={})
       output_file_name = RobotVim::FileNameGenerator.generate
       commands = args[:commands] + output_write_command(output_file_name) + vim_close_commands
@@ -28,7 +34,7 @@ module RobotVim
     private
 
     def invoke_vim(script_file_path, input_file)
-      Kernel.send(:`, "#{self.vim_binary} -n -s #{script_file_path} #{input_file}")
+      Kernel.send(:`, "#{self.vim_binary} -N -n -u #{self.vimrc} -s #{script_file_path} #{input_file}")
     end
 
     def output_write_command(output_file_name)

data/lib/robot-vim/version.rb

@@ -1,5 +1,5 @@
 module Robot
   module Vim
-    VERSION = "0.10.0"
+    VERSION = "1.0.0"
   end
 end

data/spec/fixtures/vimrc_with_not_to_gross

@@ -0,0 +1,3 @@
+function! ConvertNotToGross(...)
+  :s/not/gross
+endfunction

data/spec/integration_spec.rb

@@ -1,32 +1,48 @@
 require 'spec_helper'
 
 describe "Automating Vim with RobotVim" do
-  let(:runner){RobotVim::Runner.new}
+  describe "Input files" do
+    let(:runner){RobotVim::Runner.new}
+    context "When using an existing input file" do
+      it "can sort a file using vim" do
+        input_path = File.join(File.dirname(__FILE__), "fixtures", "unsorted_file.txt")
+        unsorted_text = File.read(input_path)
+
+        commands = <<-COMMANDS
+      :%!sort
+        COMMANDS
 
-  context "When using an existing input file" do
-    it "can sort a file using vim" do
-      input_path = File.join(File.dirname(__FILE__), "fixtures", "unsorted_file.txt")
-      unsorted_text = File.read(input_path)
+        result = runner.run(:commands => commands, :input_file => input_path)
+        result.should == unsorted_text.split("\n").sort.join("\n") + "\n"
+      end
+    end
 
-      commands = <<-COMMANDS
-      :%!sort
-      COMMANDS
+    context "When using a string for input" do
+      it "can uppercase the first line" do
+        text_to_uppercase = "this line should be uppercased"
+
+        commands = <<-COMMANDS
+        :normal 0|gU$
+        COMMANDS
 
-      result = runner.run(:commands => commands, :input_file => input_path)
-      result.should == unsorted_text.split("\n").sort.join("\n") + "\n"
+        result = runner.run(:commands => commands, :input_file => text_to_uppercase)
+        result.should == text_to_uppercase.upcase + "\n"
+      end
     end
   end
 
-  context "When using a string for input" do
-    it "can uppercase the first line" do
-      text_to_uppercase = "this line should be uppercased"
+  describe "Specifying a vimrc" do
+    it "can run a little function defined in a vimrc" do
+      input = "Beer bread is delicious.  Beard bread is not"
 
       commands = <<-COMMANDS
-        :normal 0|gU$
+        :call ConvertNotToGross()
       COMMANDS
 
-      result = runner.run(:commands => commands, :input_file => text_to_uppercase)
-      result.should == text_to_uppercase.upcase + "\n"
+      vimrc = File.join(File.dirname(__FILE__), "fixtures", "vimrc_with_not_to_gross")
+      runner = RobotVim::Runner.new(:vimrc => vimrc)
+      result = runner.run(:commands => commands, :input_file => input)
+      result.should == input.sub("not", "gross") + "\n"
     end
   end
 

data/spec/robot-vim/runner_spec.rb

@@ -16,6 +16,19 @@ describe RobotVim::Runner do
     end
   end
 
+  describe "specifying which vimrc to use" do
+    it "uses the vimrc passed in during initialization if provided" do
+      vimrc = "/testing/vimrc"
+      runner = RobotVim::Runner.new(:vimrc => vimrc)
+      runner.vimrc.should == vimrc
+    end
+
+    it "defaults to vimrc in user's path" do
+      runner = RobotVim::Runner.new()
+      runner.vimrc.should == RobotVim::Runner::DEFAULT_VIMRC
+    end
+  end
+
   describe "running commands in vim" do
     let(:vim_path){"/usr/local/bin/vim"}
     let(:runner){RobotVim::Runner.new(:vim => vim_path)}
@@ -47,6 +60,11 @@ describe RobotVim::Runner do
       run_robot
     end
 
+    it "runs vim in No-compatible mode so vim properly loads vimrcs and plugins" do
+      Kernel.should_receive(:`).with(/-N/)
+      run_robot
+    end
+
     it "invokes vim with a script file" do
       script_file_path = "path/to/script/file"
       RobotVim::ScriptFile.stub(:open).and_yield(script_file_path)
@@ -54,6 +72,13 @@ describe RobotVim::Runner do
       run_robot
     end
 
+    it "invokes vim with a vimrc" do
+      vimrc = "some/vimrc"
+      runner.stub(:vimrc).and_return(vimrc)
+      Kernel.should_receive(:`).with(/-u #{vimrc}/)
+      run_robot
+    end
+
     it "adds a write command to the user supplied commands" do
       RobotVim::ScriptFile.should_receive(:open).with(/\n\:w/)
       run_robot

metadata

@@ -2,7 +2,7 @@
 name: robot-vim
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.10.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Matt Margolis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-27 00:00:00 -05:00
+date: 2011-03-28 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,7 @@ files:
 - lib/robot-vim/version.rb
 - robot-vim.gemspec
 - spec/fixtures/unsorted_file.txt
+- spec/fixtures/vimrc_with_not_to_gross
 - spec/integration_spec.rb
 - spec/robot-vim/file_name_generator_spec.rb
 - spec/robot-vim/input_file_spec.rb