robot-vim 0.1.1 → 0.9.0

data/README.md

@@ -31,14 +31,17 @@ Commands are passed in as a string with one command per line.
       SomeOtherCoolCommand
     COMMANDS
 
-    robot.run(:input_file => "some/file.txt", :commands => commands)
+    buffer_text = robot.run(:input_file => "some/file.txt", :commands => commands)
 
-See spec/integration\_spec.rb for an example of sorting a file and saving the output.
 
+### Making Assertions
+Use your preferred Ruby testing library to make assertions about the buffer text string returned by RobotVim::Runner#run
+
+See spec/integration\_spec.rb for an example of sorting a file and making an assertion.
 
 ## TODO
-- automatically save buffer to an output file after running the last command
-- automatically close Vim after running the last command
+- 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
 - figure out if there is a way to specify a .vimrc file without disabling the normal Vim initialization process
 

data/lib/robot-vim.rb

@@ -1,3 +1,3 @@
-require 'tempfile'
+require 'uuid'
 require "robot-vim/runner"
 require "robot-vim/script_file"

data/lib/robot-vim/runner.rb

@@ -11,8 +11,20 @@ module RobotVim
     end
 
     def run(args={})
-      ScriptFile.open(args[:commands]) do |script_file_path|
-        Kernel.send(:`, "#{self.vim_binary} -n -s #{script_file_path} #{args[:input_file]}")
+      output_file_name = UUID.new.generate(:compact)
+      commands = args[:commands] + ":w #{output_file_name}"
+      commands = commands + "\n:%bd!\n:q!\n"
+      invoke_vim(commands, args[:input_file])
+      return File.read(output_file_name)
+    ensure
+      File.delete(output_file_name) if File.exists?(output_file_name)
+    end
+
+    private
+    
+    def invoke_vim(commands, input_file)
+      ScriptFile.open(commands) do |script_file_path|
+        Kernel.send(:`, "#{self.vim_binary} -n -s #{script_file_path} #{input_file}")
       end
     end
   end

data/lib/robot-vim/script_file.rb

@@ -2,11 +2,14 @@ module RobotVim
   class ScriptFile
 
     def self.open(commands)
-      Tempfile.open('script_file') do |temp_file|
-        temp_file << commands
-        temp_file.flush
-        yield temp_file.path
-      end
+      file_name = UUID.new.generate(:compact)
+      script_file = File.new(file_name, "w")
+      script_file << commands
+      script_file.flush
+      script_file.close
+      yield file_name
+    ensure
+      File.delete(file_name) if File.exists?(file_name)
     end
 
   end

data/lib/robot-vim/version.rb

@@ -1,5 +1,5 @@
 module Robot
   module Vim
-    VERSION = "0.1.1"
+    VERSION = "0.9.0"
   end
 end

data/robot-vim.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Matt Margolis"]
   s.email       = ["matt@mattmargolis.net"]
-  s.homepage    = "http://rubygems.org/gems/robot-vim"
+  s.homepage    = "https://github.com/mrmargolis/robot-vim"
   s.summary     = "Vim automation with Ruby"
-  s.description = "Invoke Vim from inside of Ruby to allow for TDD/BDD of Vim plugins and scripts"
+  s.description = "Automate Vim with Ruby to allow for TDD/BDD of Vim plugins and scripts"
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "robot-vim"
@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rspec", "~> 2.5.0"
   s.add_development_dependency "autotest"
 
+  s.add_dependency "uuid", "~> 2.3.1"
+
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
   s.require_path = 'lib'

data/spec/integration_spec.rb

@@ -5,19 +5,12 @@ describe "Automating Vim with RobotVim" do
     input_path = File.join(File.dirname(__FILE__), "fixtures", "unsorted_file.txt")
     unsorted_text = File.read(input_path)
 
-    output_file = "output.txt"
-
     commands = <<-COMMANDS
       :%!sort
-      :w #{output_file}
-      :%bd!
-      :q!
     COMMANDS
 
     runner = RobotVim::Runner.new
-    runner.run(:commands => commands, :input_file => input_path)
-    result = File.read(output_file)
+    result = runner.run(:commands => commands, :input_file => input_path)
     result.should eql(unsorted_text.split("\n").sort.join("\n") + "\n")
-    File.delete(output_file)
   end
 end

data/spec/robot-vim/runner_spec.rb

@@ -19,8 +19,14 @@ describe RobotVim::Runner do
   describe "running commands in vim" do
     let(:vim_path){"/usr/local/bin/vim"}
     let(:runner){RobotVim::Runner.new(:vim => vim_path)}
-    let(:commands){"some vim commands"}
+    let(:commands){"some vim commands\n"}
     let(:input_file){"some/path/to/a/file"}
+    let(:output_file_name){"output_file_name"}
+
+    before do
+      Kernel.stub(:`)
+      File.stub(:read)
+    end
 
     def run_robot
       runner.run(:commands => commands, :input_file => input_file)
@@ -47,6 +53,41 @@ describe RobotVim::Runner do
       Kernel.should_receive(:`).with(/-s #{script_file_path}/)
       run_robot
     end
+
+    it "adds a write command to the user supplied commands" do
+      RobotVim::ScriptFile.should_receive(:open).with(/\n\:w/)
+      run_robot
+    end
+
+    it "generates a unique filename for the output file on each run" do
+      files = []
+      RobotVim::ScriptFile.should_receive(:open) do |msg|
+        files <<  msg.match(/:w (.*)/)[1]
+      end.twice
+      run_robot
+      run_robot
+      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
+    
+    it "returns the contents of the output file" do
+      UUID.stub_chain(:new, :generate => output_file_name)
+      expected_result = "awesome buffer"
+      File.stub(:read).with(output_file_name).and_return(expected_result)
+      result = run_robot
+      result.should == expected_result
+    end
+
+    it "deletes the output file" do
+      output_file_name = "somefile" 
+      UUID.stub_chain(:new, :generate => output_file_name)
+      run_robot
+      File.exists?(output_file_name).should be_false
+    end
   end
 
 end

data/spec/robot-vim/script_file_spec.rb

@@ -6,8 +6,9 @@ describe RobotVim::ScriptFile do
 
     it "yields the path of the script file" do
       expected_path = "/some/path/somewhere"
-      tempfile = stub("tempfile", :path => expected_path).as_null_object
-      Tempfile.stub(:open).and_yield(tempfile)
+      UUID.stub_chain(:new, :generate => expected_path)
+      file = stub("file").as_null_object
+      File.stub(:new).and_return(file)
 
       RobotVim::ScriptFile.open(commands_string) do |file_path|
         file_path.should == expected_path
@@ -20,5 +21,13 @@ describe RobotVim::ScriptFile do
       end
     end
 
+    it "deletes the file after we are done using it" do
+      file_name = "somefile" 
+      UUID.stub_chain(:new, :generate => file_name)
+      RobotVim::ScriptFile.open(commands_string) do |file_path|
+      end
+      File.exists?(file_name).should be_false
+    end
+
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: robot-vim
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.9.0
 platform: ruby
 authors: 
 - Matt Margolis
@@ -46,7 +46,18 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Invoke Vim from inside of Ruby to allow for TDD/BDD of Vim plugins and scripts
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.1
+  type: :runtime
+  version_requirements: *id004
+description: Automate Vim with Ruby to allow for TDD/BDD of Vim plugins and scripts
 email: 
 - matt@mattmargolis.net
 executables: []
@@ -74,7 +85,7 @@ files:
 - spec/robot-vim/script_file_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://rubygems.org/gems/robot-vim
+homepage: https://github.com/mrmargolis/robot-vim
 licenses: []
 
 post_install_message: