robot-vim 1.1.0 → 2.0.0

data/README.md

@@ -5,7 +5,9 @@ and scripts.
 
 ## Installation
 To install RobotVim run
+
     gem install robot-vim
+
 or clone this reposity and run
     rake install
 
@@ -18,12 +20,15 @@ RobotVim is developed with Vim 7.3, Ruby 1.9.2, and bundler.
 
 ### Initialization
 Create an instance that will use your user's default Vim and vimrc
+
     robot = RobotVim::Runner.new()
 
 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
@@ -32,31 +37,38 @@ Commands are passed in as a string with one command per line.
 The input file can be specified as a path to an existing input file, or as a string which RobotVim will turn into an short lived file backed buffer.
 
     commands = <<-COMMANDS
-      RunSomeCoolCommand
-      SomeOtherCoolCommand
+      :s/old/new
+      :normal! gg
+      :call setline('.', "RobotVim")
+      :call MyAwesomePluginFunction
     COMMANDS
 
 
-    buffer_text = robot.run(:input_file => "some/file.txt", :commands => commands)
+    vim_response = robot.run(:input_file => "some/file.txt", :commands => commands)
+
 
     input = <<-CONTENT
       This text will be used
       as the contents of my input file
     CONTENT
 
-    buffer_text = robot.run(:input_file => input, :commands => commands)
+    vim_response = robot.run(:input_file => input, :commands => commands)
+    buffer_text = vim_response.body
+
+### VimResponse
+
+The return value of RobotVim::Runner#run is a RobotVim::VimResponse instance with the following fields
 
+- body: The contents of the last buffer that was active when your commands completed
+- line\_number: The line number the cursor was on when your commands completed
+- column\_number: The column number the cursor was on when your commands completed
+
+**Please submit pull requests or issues if there are additional values that you want to be able to assert against**
 
 ### Making Assertions
 Use your preferred Ruby testing library to make assertions about the buffer text string returned by RobotVim::Runner#run
 
-spec/integration\_spec.rb contains examples of asserting with Rspec
-
-## TODO
-- 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(done)
+Take a look at spec/integration\_spec.rb for examples of asserting with Rspec
 
 ## Author
-RobotVim is developed by Matt Margolis | mrmargolis | matt@mattmargolis.net
+RobotVim is developed by Matt Margolis | @mrmargolis | matt@mattmargolis.net

data/lib/robot-vim.rb

@@ -3,3 +3,5 @@ require "robot-vim/runner"
 require "robot-vim/script_file"
 require "robot-vim/input_file"
 require "robot-vim/file_name_generator"
+require "robot-vim/command_generator"
+require "robot-vim/vim_response"

data/lib/robot-vim/command_generator.rb

@@ -0,0 +1,26 @@
+module RobotVim
+  class CommandGenerator
+    def self.generate(user_commands, output_file)
+      user_commands + 
+        record_location_command + 
+        write_output_file_command(output_file) +
+        vim_close_commands
+    end
+
+    def self.write_output_file_command(output_file)
+      ":w #{output_file}\n"
+    end
+
+    def self.record_location_command
+      ":let current_line = line(\".\")\n" +
+      ":let current_column = col(\".\")\n" +
+      ":normal! G\n" + 
+      ":execute \"normal! o\" . current_line\n" +
+      ":execute \"normal! o\" . current_column\n"  
+    end
+
+    def self.vim_close_commands
+      "\n:%bd!\n:q!\n"
+    end
+  end
+end

data/lib/robot-vim/runner.rb

@@ -18,7 +18,7 @@ module RobotVim
 
     def run(args={})
       output_file_name = RobotVim::FileNameGenerator.generate
-      commands = args[:commands] + output_write_command(output_file_name) + vim_close_commands
+      commands = RobotVim::CommandGenerator.generate(args[:commands], output_file_name)
 
       InputFile.path_for(args[:input_file]) do |input_file_path|
         ScriptFile.open(commands) do |script_file_path|
@@ -26,7 +26,7 @@ module RobotVim
         end
       end
 
-      return read_output_file_contents(output_file_name)
+      return RobotVim::VimResponse.new(read_output_file_contents(output_file_name))
     ensure
       File.delete(output_file_name) if File.exists?(output_file_name)
     end
@@ -37,14 +37,6 @@ module RobotVim
       Kernel.send(:`, "#{self.vim_binary} -N -n -u #{self.vimrc} -s #{script_file_path} #{input_file} 2>/dev/null")
     end
 
-    def output_write_command(output_file_name)
-      ":w #{output_file_name}"
-    end
-
-    def vim_close_commands
-      "\n:%bd!\n:q!\n"
-    end
-
     def read_output_file_contents(output_file_name)
       File.read(output_file_name)
     end

data/lib/robot-vim/version.rb

@@ -1,5 +1,5 @@
 module Robot
   module Vim
-    VERSION = "1.1.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/robot-vim/vim_response.rb

@@ -0,0 +1,12 @@
+module RobotVim
+  class VimResponse
+    attr_reader :body, :column_number, :line_number
+    def initialize(response_string)
+      @response_string = response_string
+      lines = @response_string.split("\n")
+      @column_number = lines.pop.to_i
+      @line_number = lines.pop.to_i
+      @body = lines.join("\n")
+    end
+  end
+end

data/robot-vim.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "robot-vim"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 2.5.0"
   s.add_development_dependency "autotest"
 

data/spec/integration_spec.rb

@@ -13,7 +13,7 @@ describe "Automating Vim with RobotVim" do
         COMMANDS
 
         result = runner.run(:commands => commands, :input_file => input_path)
-        result.should == unsorted_text.split("\n").sort.join("\n") + "\n"
+        result.body.should == unsorted_text.split("\n").sort.join("\n")
       end
     end
 
@@ -26,7 +26,7 @@ describe "Automating Vim with RobotVim" do
         COMMANDS
 
         result = runner.run(:commands => commands, :input_file => text_to_uppercase)
-        result.should == text_to_uppercase.upcase + "\n"
+        result.body.should == text_to_uppercase.upcase
       end
     end
   end
@@ -42,7 +42,7 @@ describe "Automating Vim with RobotVim" do
       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"
+      result.body.should == input.sub("not", "gross")
     end
   end
 
@@ -58,9 +58,28 @@ yes please
       vimrc = File.join(File.dirname(__FILE__), "fixtures", "vimrc_with_user_input")
       runner = RobotVim::Runner.new(:vimrc => vimrc)
       result = runner.run(:commands => commands, :input_file => input)
-      result.should == "yes please" + "\n"
+      result.body.should == "yes please"
     end
-
   end
 
+  describe "verifying location of cursor" do
+    it "detects the correct line and column numbers" do
+      input = "Here is some text\n" +
+              "and more on a different line\n" +
+              "behold, the lines just keep going\n" + 
+              "really?"
+
+      commands = <<-COMMANDS
+        :normal! gg
+        :normal! jj
+        :normal! 0llll
+      COMMANDS
+
+      runner = RobotVim::Runner.new()
+      result = runner.run(:commands => commands, :input_file => input)
+      puts result.body
+      result.line_number.should == 3
+      result.column_number.should == 5
+    end
+  end
 end

data/spec/robot-vim/command_generator_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe RobotVim::CommandGenerator do
+  describe ".generate" do
+    let(:output_file) { "some/file.extension" } 
+    let(:user_commands) { "some user commands" } 
+
+    let(:write_to_output_file_command) { RobotVim::CommandGenerator.write_output_file_command(output_file) }
+    let(:close_vim_commands) { RobotVim::CommandGenerator.vim_close_commands}
+    let(:record_location_command) { RobotVim::CommandGenerator.record_location_command } 
+
+    subject { RobotVim::CommandGenerator.generate(user_commands, output_file) }
+
+    it { should include(user_commands) } 
+    it { should include(write_to_output_file_command) } 
+    it { should include(record_location_command) } 
+    it { should include(close_vim_commands) } 
+  end
+end
+

data/spec/robot-vim/runner_spec.rb

@@ -37,7 +37,7 @@ describe RobotVim::Runner do
 
     before do
       Kernel.stub(:`)
-      runner.stub(:read_output_file_contents)
+      runner.stub(:read_output_file_contents).and_return("some file contents")
       RobotVim::InputFile.stub(:path_for).and_yield(input_file)
     end
 
@@ -84,8 +84,10 @@ describe RobotVim::Runner do
       run_robot
     end
 
-    it "adds a write command to the user supplied commands" do
-      RobotVim::ScriptFile.should_receive(:open).with(/\n\:w/)
+    it "generates commands for the script file based on user input" do
+      generated_commands = stub('generated commands')
+      RobotVim::CommandGenerator.stub!(:generate).with(commands, anything()).and_return(generated_commands)
+      RobotVim::ScriptFile.should_receive(:open).with(generated_commands)
       run_robot
     end
 
@@ -99,11 +101,6 @@ describe RobotVim::Runner do
       files[0].should_not == files[1]
     end
 
-    it "adds vim closing commands to the user supplied commands" do
-      RobotVim::ScriptFile.should_receive(:open).with(/:%bd!\n:q!/)
-      run_robot
-    end
-
     describe "output file management" do
       let(:output_file_name){"output_file_name"}
 
@@ -111,18 +108,18 @@ describe RobotVim::Runner do
         RobotVim::FileNameGenerator.stub(:generate).and_return(output_file_name)
       end
 
-      it "returns the contents of the output file" do
-        expected_result = "awesome buffer"
-        runner.stub(:read_output_file_contents).with(output_file_name).and_return(expected_result)
-        result = run_robot
-        result.should == expected_result
-      end
-
       it "deletes the output file" do
         run_robot
         File.exists?(output_file_name).should be_false
       end
     end
+
+    describe "return value" do
+      it "returns a VimResponse that is initialized with the output file contents" do
+        response = run_robot
+        response.should be_kind_of(RobotVim::VimResponse)
+      end
+    end
   end
 
 end

data/spec/robot-vim/vim_response_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe RobotVim::VimResponse do
+  let(:expected_body) { "hi there.  This is some stuff.\n That is in vim\n and might be awesome" } 
+  let(:expected_line) { 2 } 
+  let(:expected_column) { 4 } 
+  let(:file_contents) { expected_body + "\n" + expected_line.to_s + "\n" + expected_column.to_s }
+
+  subject { RobotVim::VimResponse.new(file_contents) }
+
+  its(:body) { should == expected_body }
+  its(:line_number) { should == expected_line }
+  its(:column_number) { should == expected_column }
+end

metadata

@@ -2,7 +2,7 @@
 name: robot-vim
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Matt Margolis
@@ -10,12 +10,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 -05:00
+date: 2011-09-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -23,40 +22,52 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
+  name: rake
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 2.5.0
   type: :development
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: autotest
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: uuid
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 2.3.1
   type: :runtime
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *id005
 description: Automate Vim with Ruby to allow for TDD/BDD of Vim plugins and scripts
 email: 
 - matt@mattmargolis.net
@@ -75,20 +86,24 @@ files:
 - README.md
 - Rakefile
 - lib/robot-vim.rb
+- lib/robot-vim/command_generator.rb
 - lib/robot-vim/file_name_generator.rb
 - lib/robot-vim/input_file.rb
 - lib/robot-vim/runner.rb
 - lib/robot-vim/script_file.rb
 - lib/robot-vim/version.rb
+- lib/robot-vim/vim_response.rb
 - robot-vim.gemspec
 - spec/fixtures/unsorted_file.txt
 - spec/fixtures/vimrc_with_not_to_gross
 - spec/fixtures/vimrc_with_user_input
 - spec/integration_spec.rb
+- spec/robot-vim/command_generator_spec.rb
 - spec/robot-vim/file_name_generator_spec.rb
 - spec/robot-vim/input_file_spec.rb
 - spec/robot-vim/runner_spec.rb
 - spec/robot-vim/script_file_spec.rb
+- spec/robot-vim/vim_response_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/mrmargolis/robot-vim
@@ -104,6 +119,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 388667503405751599
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false