robot-vim 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +3 -0
- data/Gemfile +4 -0
- data/License.txt +21 -0
- data/README.md +60 -0
- data/Rakefile +2 -0
- data/lib/robot-vim.rb +5 -0
- data/lib/robot-vim/version.rb +5 -0
- data/robot-vim.gemspec +22 -0
- metadata +88 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/License.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License
|
2
|
+
|
3
|
+
Copyright (c) 2011 Matt Margolis
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,60 @@
|
|
1
|
+
# RobotVim - Easy Vim Automation
|
2
|
+
RobotVim is a Ruby gem that allows you to invoke Vim from inside of Ruby
|
3
|
+
programs. It was designed to allow Vim developers to TDD/BDD their Vim plugins
|
4
|
+
and scripts.
|
5
|
+
|
6
|
+
## Important
|
7
|
+
Right now there is no real code to this project. It's just this README. Code is coming soon.
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
To install RobotVim run
|
11
|
+
gem install robot-vim
|
12
|
+
or clone this reposity and run
|
13
|
+
rake install
|
14
|
+
|
15
|
+
## Dependencies
|
16
|
+
RobotVim is developed with Ruby 1.9.2 and bundler. It has not been tested with older versions of Ruby.
|
17
|
+
|
18
|
+
## Example Usage
|
19
|
+
|
20
|
+
### Initialization
|
21
|
+
Create an instance that will use your user's default Vim and vimrc file
|
22
|
+
robot = RobotVim.new()
|
23
|
+
|
24
|
+
Or create an instance with a specific Vim and/or vimrc file
|
25
|
+
robot = RobotVim.new(:vim_path => "~/bin/vim",
|
26
|
+
:vimrc_path => "examples/vimrc_with_weird_bindings")
|
27
|
+
|
28
|
+
### Running commands
|
29
|
+
Commands are passed in as a string with one command per line.
|
30
|
+
|
31
|
+
Run commands against inline input
|
32
|
+
commands = <<-COMMANDS
|
33
|
+
RunSomeCoolCommand
|
34
|
+
SomeOtherCoolCommand
|
35
|
+
COMMANDS
|
36
|
+
|
37
|
+
input = <<-INPUT
|
38
|
+
This is a some sample
|
39
|
+
text that I can pass in as input.
|
40
|
+
I could also use a file fixture as my input.
|
41
|
+
See the examples folder for more examples.
|
42
|
+
INPUT
|
43
|
+
|
44
|
+
result = robot.run(:input_text => input, :commands => commands)
|
45
|
+
puts result.buffer_text
|
46
|
+
|
47
|
+
Run a command against a test input file
|
48
|
+
command = "normal G|iTyping some text at the bottom of the buffer"
|
49
|
+
result = robot.run(:input_file => "examples/input1.txt", :commands => commands)
|
50
|
+
puts result.buffer_text
|
51
|
+
|
52
|
+
## The result object
|
53
|
+
The result of the RobotVim#run method has the following attributes
|
54
|
+
|
55
|
+
- buffer\_text: the text of the buffer after the last command (not yet implemented)
|
56
|
+
- buffer\_name: the name of the buffer after the last command (not yet implemented)
|
57
|
+
- cursor\_location: the curson location after the last command(not yet implemented)
|
58
|
+
|
59
|
+
## Author
|
60
|
+
RobotVim is developed by Matt Margolis | mrmargolis | matt@mattmargolis.net
|
data/Rakefile
ADDED
data/lib/robot-vim.rb
ADDED
data/robot-vim.gemspec
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
require File.expand_path("../lib/robot-vim/version", __FILE__)
|
3
|
+
|
4
|
+
Gem::Specification.new do |s|
|
5
|
+
s.name = "robot-vim"
|
6
|
+
s.version = Robot::Vim::VERSION
|
7
|
+
s.platform = Gem::Platform::RUBY
|
8
|
+
s.authors = ["Matt Margolis"]
|
9
|
+
s.email = ["matt@mattmargolis.net"]
|
10
|
+
s.homepage = "http://rubygems.org/gems/robot-vim"
|
11
|
+
s.summary = "Vim automation with Ruby"
|
12
|
+
s.description = "Invoke Vim from inside of Ruby to allow for TDD/BDD of Vim plugins and scripts"
|
13
|
+
|
14
|
+
s.required_rubygems_version = ">= 1.3.6"
|
15
|
+
s.rubyforge_project = "robot-vim"
|
16
|
+
|
17
|
+
s.add_development_dependency "bundler", ">= 1.0.0"
|
18
|
+
|
19
|
+
s.files = `git ls-files`.split("\n")
|
20
|
+
s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
|
21
|
+
s.require_path = 'lib'
|
22
|
+
end
|
metadata
ADDED
@@ -0,0 +1,88 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: robot-vim
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
prerelease: false
|
5
|
+
segments:
|
6
|
+
- 0
|
7
|
+
- 0
|
8
|
+
- 1
|
9
|
+
version: 0.0.1
|
10
|
+
platform: ruby
|
11
|
+
authors:
|
12
|
+
- Matt Margolis
|
13
|
+
autorequire:
|
14
|
+
bindir: bin
|
15
|
+
cert_chain: []
|
16
|
+
|
17
|
+
date: 2011-03-20 00:00:00 -05:00
|
18
|
+
default_executable:
|
19
|
+
dependencies:
|
20
|
+
- !ruby/object:Gem::Dependency
|
21
|
+
name: bundler
|
22
|
+
prerelease: false
|
23
|
+
requirement: &id001 !ruby/object:Gem::Requirement
|
24
|
+
none: false
|
25
|
+
requirements:
|
26
|
+
- - ">="
|
27
|
+
- !ruby/object:Gem::Version
|
28
|
+
segments:
|
29
|
+
- 1
|
30
|
+
- 0
|
31
|
+
- 0
|
32
|
+
version: 1.0.0
|
33
|
+
type: :development
|
34
|
+
version_requirements: *id001
|
35
|
+
description: Invoke Vim from inside of Ruby to allow for TDD/BDD of Vim plugins and scripts
|
36
|
+
email:
|
37
|
+
- matt@mattmargolis.net
|
38
|
+
executables: []
|
39
|
+
|
40
|
+
extensions: []
|
41
|
+
|
42
|
+
extra_rdoc_files: []
|
43
|
+
|
44
|
+
files:
|
45
|
+
- .gitignore
|
46
|
+
- Gemfile
|
47
|
+
- License.txt
|
48
|
+
- README.md
|
49
|
+
- Rakefile
|
50
|
+
- lib/robot-vim.rb
|
51
|
+
- lib/robot-vim/version.rb
|
52
|
+
- robot-vim.gemspec
|
53
|
+
has_rdoc: true
|
54
|
+
homepage: http://rubygems.org/gems/robot-vim
|
55
|
+
licenses: []
|
56
|
+
|
57
|
+
post_install_message:
|
58
|
+
rdoc_options: []
|
59
|
+
|
60
|
+
require_paths:
|
61
|
+
- lib
|
62
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
63
|
+
none: false
|
64
|
+
requirements:
|
65
|
+
- - ">="
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
segments:
|
68
|
+
- 0
|
69
|
+
version: "0"
|
70
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
71
|
+
none: false
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
segments:
|
76
|
+
- 1
|
77
|
+
- 3
|
78
|
+
- 6
|
79
|
+
version: 1.3.6
|
80
|
+
requirements: []
|
81
|
+
|
82
|
+
rubyforge_project: robot-vim
|
83
|
+
rubygems_version: 1.3.7
|
84
|
+
signing_key:
|
85
|
+
specification_version: 3
|
86
|
+
summary: Vim automation with Ruby
|
87
|
+
test_files: []
|
88
|
+
|