robot-vim 0.0.1 → 0.1.0

data/.autotest

@@ -0,0 +1 @@
+require "autotest/bundler"

data/.gitignore

@@ -1,3 +1,5 @@
 pkg/*
 *.gem
 .bundle
+.rvmrc
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -3,58 +3,44 @@ RobotVim is a Ruby gem that allows you to invoke Vim from inside of Ruby
 programs.  It was designed to allow Vim developers to TDD/BDD their Vim plugins
 and scripts.
 
-## Important
-Right now there is no real code to this project.  It's just this README.  Code is coming soon.
-
 ## Installation
 To install RobotVim run
     gem install robot-vim
 or clone this reposity and run
     rake install
 
+
 ## Dependencies
-RobotVim is developed with Ruby 1.9.2 and bundler.  It has not been tested with older versions of Ruby.
+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 and vimrc file
-    robot = RobotVim.new()
+Create an instance that will use your user's default Vim
+    robot = RobotVim::Runner.new()
 
-Or create an instance with a specific Vim and/or vimrc file
-    robot = RobotVim.new(:vim_path => "~/bin/vim",
-                         :vimrc_path => "examples/vimrc_with_weird_bindings")
+Or create an instance with a specific Vim
+    robot = RobotVim::Runner.new(:vim => "/bin/vim")
 
 ### Running commands
 Commands are passed in as a string with one command per line.
 
-Run commands against inline input
     commands = <<-COMMANDS
       RunSomeCoolCommand
       SomeOtherCoolCommand
     COMMANDS
 
-    input = <<-INPUT
-      This is a some sample
-      text that I can pass in as input.
-      I could also use a file fixture as my input.
-      See the examples folder for more examples.
-    INPUT
-
-    result = robot.run(:input_text => input, :commands => commands)
-    puts result.buffer_text
+    robot.run(:input_file => "some/file.txt", :commands => commands)
 
-Run a command against a test input file
-    command = "normal G|iTyping some text at the bottom of the buffer"
-    result = robot.run(:input_file => "examples/input1.txt", :commands => commands)
-    puts result.buffer_text
+See spec/integration\_spec.rb for an example of sorting a file and saving the output.
 
-## The result object
-The result of the RobotVim#run method has the following attributes
 
--  buffer\_text:  the text of the buffer after the last command (not yet implemented)
--  buffer\_name:  the name of the buffer after the last command (not yet implemented)
--  cursor\_location:  the curson location after the last command(not yet implemented)
+## TODO
+- automatically save buffer to an output file after running the last command
+- automatically close Vim after running the last command
+- 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
 
 ## Author
 RobotVim is developed by Matt Margolis | mrmargolis | matt@mattmargolis.net

data/lib/robot-vim/runner.rb

@@ -0,0 +1,19 @@
+module RobotVim
+  class Runner
+    DEFAULT_VIM_BINARY = "vim"
+
+    def initialize(args={})
+      @vim_binary = args[:vim]
+    end
+
+    def vim_binary
+      @vim_binary || DEFAULT_VIM_BINARY
+    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]}")
+      end
+    end
+  end
+end

data/lib/robot-vim/script_file.rb

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

data/lib/robot-vim/version.rb

@@ -1,5 +1,5 @@
 module Robot
   module Vim
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/robot-vim.rb

@@ -1,5 +1,3 @@
-module Robot
-  module Vim
-    # Your code goes here...
-  end
-end
+require 'tempfile'
+require "robot-vim/runner"
+require "robot-vim/script_file"

data/output.txt

@@ -0,0 +1,3 @@
+A first line
+Middle line
+This line should be last

data/robot-vim.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "robot-vim"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", "~> 2.5.0"
+  s.add_development_dependency "autotest"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

data/spec/fixtures/unsorted_file.txt

@@ -0,0 +1,3 @@
+This line should be last
+A first line
+Middle line

data/spec/integration_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe "Automating Vim with RobotVim" 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)
+
+    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.should eql(unsorted_text.split("\n").sort.join("\n") + "\n")
+  end
+end

data/spec/robot-vim/runner_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe RobotVim::Runner do
+
+  describe "specifying which vim to use" do
+    it "uses the vim passed in during initialization if provided" do
+      vim = "/usr/local/bin/vim"
+      runner = RobotVim::Runner.new(:vim => vim)
+      runner.vim_binary.should == vim
+    end
+
+    it "defaults to vim in user's path" do
+      vim = "vim"
+      runner = RobotVim::Runner.new()
+      runner.vim_binary.should == vim
+    end
+  end
+
+  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(:input_file){"some/path/to/a/file"}
+
+    def run_robot
+      runner.run(:commands => commands, :input_file => input_file)
+    end
+
+    it "invokes the correct vim" do
+      Kernel.should_receive(:`).with(/#{vim_path}/)
+      run_robot
+    end
+
+    it "runs against the requested input file" do
+      Kernel.should_receive(:`).with(/#{input_file}$/)
+      run_robot
+    end
+
+    it "runs vim without swap files so vim doesn't show swap warnings" 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)
+      Kernel.should_receive(:`).with(/-s #{script_file_path}/)
+      run_robot
+    end
+  end
+
+end

data/spec/robot-vim/script_file_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe RobotVim::ScriptFile do
+  describe "when creating a script file from a string" do
+    let(:commands_string){"some string of vim commands"}
+
+    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)
+
+      RobotVim::ScriptFile.open(commands_string) do |file_path|
+        file_path.should == expected_path
+      end
+    end
+
+    it "writes the commands out to the script file" do
+      RobotVim::ScriptFile.open(commands_string) do |file_path|
+        File.read(file_path).should == commands_string
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), '/../lib/robot-vim.rb')
+
+Rspec.configure do |c|
+  c.mock_with :rspec
+end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: robot-vim
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors: 
 - Matt Margolis
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-20 00:00:00 -05:00
+date: 2011-03-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,13 +21,31 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
 description: Invoke Vim from inside of Ruby to allow for TDD/BDD of Vim plugins and scripts
 email: 
 - matt@mattmargolis.net
@@ -42,14 +56,24 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .autotest
 - .gitignore
+- .rspec
 - Gemfile
 - License.txt
 - README.md
 - Rakefile
 - lib/robot-vim.rb
+- lib/robot-vim/runner.rb
+- lib/robot-vim/script_file.rb
 - lib/robot-vim/version.rb
+- output.txt
 - robot-vim.gemspec
+- spec/fixtures/unsorted_file.txt
+- spec/integration_spec.rb
+- spec/robot-vim/runner_spec.rb
+- spec/robot-vim/script_file_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/robot-vim
 licenses: []
@@ -64,23 +88,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: robot-vim
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Vim automation with Ruby