plain_option_parser 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.document +5 -0
- data/.gitignore +21 -0
- data/LICENSE +20 -0
- data/README.rdoc +18 -0
- data/Rakefile +45 -0
- data/VERSION +1 -0
- data/lib/plain_option_parser.rb +100 -0
- data/spec/plain_option_parser_spec.rb +31 -0
- data/spec/spec_helper.rb +9 -0
- metadata +74 -0
data/.document
ADDED
data/.gitignore
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
Copyright (c) 2009 Kyle Maxwell
|
2
|
+
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
4
|
+
a copy of this software and associated documentation files (the
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
9
|
+
the following conditions:
|
10
|
+
|
11
|
+
The above copyright notice and this permission notice shall be
|
12
|
+
included in all copies or substantial portions of the Software.
|
13
|
+
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.rdoc
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
= plain_option_parser
|
2
|
+
|
3
|
+
Simple heroku-style option parser for ruby.
|
4
|
+
|
5
|
+
== Note on Patches/Pull Requests
|
6
|
+
|
7
|
+
* Fork the project.
|
8
|
+
* Make your feature addition or bug fix.
|
9
|
+
* Add tests for it. This is important so I don't break it in a
|
10
|
+
future version unintentionally.
|
11
|
+
* Commit, do not mess with rakefile, version, or history.
|
12
|
+
(if you want to have your own version, that is fine but
|
13
|
+
bump version in a commit by itself I can ignore when I pull)
|
14
|
+
* Send me a pull request. Bonus points for topic branches.
|
15
|
+
|
16
|
+
== Copyright
|
17
|
+
|
18
|
+
Copyright (c) 2010 Kyle Maxwell. See LICENSE for details.
|
data/Rakefile
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
require 'rubygems'
|
2
|
+
require 'rake'
|
3
|
+
|
4
|
+
begin
|
5
|
+
require 'jeweler'
|
6
|
+
Jeweler::Tasks.new do |gem|
|
7
|
+
gem.name = "plain_option_parser"
|
8
|
+
gem.summary = %Q{a heroku-like option parser}
|
9
|
+
gem.description = %Q{Parse command-line options in style}
|
10
|
+
gem.email = "kyle@kylemaxwell.com"
|
11
|
+
gem.homepage = "http://github.com/fizx/plain_option_parser"
|
12
|
+
gem.authors = ["Kyle Maxwell"]
|
13
|
+
gem.add_development_dependency "rspec", ">= 0"
|
14
|
+
# gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
|
15
|
+
end
|
16
|
+
Jeweler::GemcutterTasks.new
|
17
|
+
rescue LoadError
|
18
|
+
puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
|
19
|
+
end
|
20
|
+
|
21
|
+
require 'spec/rake/spectask'
|
22
|
+
Spec::Rake::SpecTask.new(:spec) do |spec|
|
23
|
+
spec.libs << 'lib' << 'spec'
|
24
|
+
spec.spec_files = FileList['spec/**/*_spec.rb']
|
25
|
+
end
|
26
|
+
|
27
|
+
Spec::Rake::SpecTask.new(:rcov) do |spec|
|
28
|
+
spec.libs << 'lib' << 'spec'
|
29
|
+
spec.pattern = 'spec/**/*_spec.rb'
|
30
|
+
spec.rcov = true
|
31
|
+
end
|
32
|
+
|
33
|
+
task :spec => :check_dependencies
|
34
|
+
|
35
|
+
task :default => :spec
|
36
|
+
|
37
|
+
require 'rake/rdoctask'
|
38
|
+
Rake::RDocTask.new do |rdoc|
|
39
|
+
version = File.exist?('VERSION') ? File.read('VERSION') : ""
|
40
|
+
|
41
|
+
rdoc.rdoc_dir = 'rdoc'
|
42
|
+
rdoc.title = "plain_option_parser #{version}"
|
43
|
+
rdoc.rdoc_files.include('README*')
|
44
|
+
rdoc.rdoc_files.include('lib/**/*.rb')
|
45
|
+
end
|
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
0.1.0
|
@@ -0,0 +1,100 @@
|
|
1
|
+
class PlainOptionParser
|
2
|
+
attr_reader :flags
|
3
|
+
|
4
|
+
def initialize(&block)
|
5
|
+
@commands = []
|
6
|
+
desc "Prints help text for your command"
|
7
|
+
cmd "help" do
|
8
|
+
viable, remaining = commands_for_args(args[1, args.length])
|
9
|
+
if viable.length == 0
|
10
|
+
no_match
|
11
|
+
else
|
12
|
+
pretty_print viable
|
13
|
+
end
|
14
|
+
end
|
15
|
+
instance_eval(&block)
|
16
|
+
end
|
17
|
+
|
18
|
+
def start(args)
|
19
|
+
viable, remaining = commands_for_args(args)
|
20
|
+
if viable.length == 1
|
21
|
+
viable[0].last.call(*remaining)
|
22
|
+
elsif viable.length == 0
|
23
|
+
no_match
|
24
|
+
else
|
25
|
+
usage
|
26
|
+
pretty_print viable
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
def desc(string)
|
31
|
+
@desc = string
|
32
|
+
end
|
33
|
+
|
34
|
+
def cmd(name, additional = "", &block)
|
35
|
+
@commands << [name.split(/\s+/), @desc, additional, block]
|
36
|
+
@desc = nil
|
37
|
+
end
|
38
|
+
|
39
|
+
def pretty_print(cmds)
|
40
|
+
mapped = cmds.map do |cmd|
|
41
|
+
name, desc, additional, block = cmd
|
42
|
+
[" #{File.basename($0)} " + name.join(" ") + " #{additional}", " -- #{desc}"]
|
43
|
+
end
|
44
|
+
max = mapped.inject(0) do |memo, entry|
|
45
|
+
memo > entry.first.length ? memo : entry.first.length
|
46
|
+
end
|
47
|
+
mapped.each do |entry|
|
48
|
+
puts entry.first + (" " * (max - entry.first.length)) + entry.last
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
private
|
53
|
+
|
54
|
+
def usage
|
55
|
+
puts "COMMANDS: "
|
56
|
+
end
|
57
|
+
|
58
|
+
|
59
|
+
KV_FLAG = /--(.*)=(.*)/
|
60
|
+
K_FLAG = /--(.*)/
|
61
|
+
def strip_flags(args)
|
62
|
+
@flags ||= {}
|
63
|
+
@prev = nil
|
64
|
+
args.map do |arg|
|
65
|
+
if arg =~ KV_FLAG
|
66
|
+
@flags[$1] = $2
|
67
|
+
nil
|
68
|
+
elsif @prev
|
69
|
+
@flags[@prev] = arg
|
70
|
+
@prev = nil
|
71
|
+
elsif @prev = arg[K_FLAG, 1]
|
72
|
+
nil
|
73
|
+
else
|
74
|
+
arg
|
75
|
+
end
|
76
|
+
end.compact
|
77
|
+
end
|
78
|
+
|
79
|
+
def commands_for_args(args)
|
80
|
+
args = strip_flags(args)
|
81
|
+
viable = @commands.dup
|
82
|
+
args.each_with_index do |arg, i|
|
83
|
+
@commands.each do |cmd|
|
84
|
+
name, desc, additional, block = cmd
|
85
|
+
viable.delete(cmd) if name[i] != arg
|
86
|
+
end
|
87
|
+
if viable.length == 1
|
88
|
+
return [viable, args[viable[0][0].length, args.length]]
|
89
|
+
end
|
90
|
+
end
|
91
|
+
return [viable, []]
|
92
|
+
end
|
93
|
+
|
94
|
+
def no_match
|
95
|
+
puts "No matching command found."
|
96
|
+
puts
|
97
|
+
usage
|
98
|
+
pretty_print @commands
|
99
|
+
end
|
100
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
|
2
|
+
|
3
|
+
$pop = PlainOptionParser.new do
|
4
|
+
desc "set abc"
|
5
|
+
cmd "test set abc" do |value|
|
6
|
+
$abc = value
|
7
|
+
$abc += flags["app"] if flags["app"]
|
8
|
+
end
|
9
|
+
|
10
|
+
desc "unset abc"
|
11
|
+
cmd "test unset abc" do
|
12
|
+
$abc = false
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
describe "PlainOptionParser" do
|
17
|
+
it "should set abc" do
|
18
|
+
$pop.start %w[test set abc 123]
|
19
|
+
$abc.should == "123"
|
20
|
+
end
|
21
|
+
|
22
|
+
it "should unset abc" do
|
23
|
+
$pop.start %w[test unset abc]
|
24
|
+
$abc.should be_false
|
25
|
+
end
|
26
|
+
|
27
|
+
it "should take a flag" do
|
28
|
+
$pop.start %w[test set abc 123 --app foo]
|
29
|
+
$abc.should == "123foo"
|
30
|
+
end
|
31
|
+
end
|
data/spec/spec_helper.rb
ADDED
metadata
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: plain_option_parser
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kyle Maxwell
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
|
12
|
+
date: 2010-01-25 00:00:00 -08:00
|
13
|
+
default_executable:
|
14
|
+
dependencies:
|
15
|
+
- !ruby/object:Gem::Dependency
|
16
|
+
name: rspec
|
17
|
+
type: :development
|
18
|
+
version_requirement:
|
19
|
+
version_requirements: !ruby/object:Gem::Requirement
|
20
|
+
requirements:
|
21
|
+
- - ">="
|
22
|
+
- !ruby/object:Gem::Version
|
23
|
+
version: "0"
|
24
|
+
version:
|
25
|
+
description: Parse command-line options in style
|
26
|
+
email: kyle@kylemaxwell.com
|
27
|
+
executables: []
|
28
|
+
|
29
|
+
extensions: []
|
30
|
+
|
31
|
+
extra_rdoc_files:
|
32
|
+
- LICENSE
|
33
|
+
- README.rdoc
|
34
|
+
files:
|
35
|
+
- .document
|
36
|
+
- .gitignore
|
37
|
+
- LICENSE
|
38
|
+
- README.rdoc
|
39
|
+
- Rakefile
|
40
|
+
- VERSION
|
41
|
+
- lib/plain_option_parser.rb
|
42
|
+
- spec/plain_option_parser_spec.rb
|
43
|
+
- spec/spec_helper.rb
|
44
|
+
has_rdoc: true
|
45
|
+
homepage: http://github.com/fizx/plain_option_parser
|
46
|
+
licenses: []
|
47
|
+
|
48
|
+
post_install_message:
|
49
|
+
rdoc_options:
|
50
|
+
- --charset=UTF-8
|
51
|
+
require_paths:
|
52
|
+
- lib
|
53
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
54
|
+
requirements:
|
55
|
+
- - ">="
|
56
|
+
- !ruby/object:Gem::Version
|
57
|
+
version: "0"
|
58
|
+
version:
|
59
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
60
|
+
requirements:
|
61
|
+
- - ">="
|
62
|
+
- !ruby/object:Gem::Version
|
63
|
+
version: "0"
|
64
|
+
version:
|
65
|
+
requirements: []
|
66
|
+
|
67
|
+
rubyforge_project:
|
68
|
+
rubygems_version: 1.3.5
|
69
|
+
signing_key:
|
70
|
+
specification_version: 3
|
71
|
+
summary: a heroku-like option parser
|
72
|
+
test_files:
|
73
|
+
- spec/plain_option_parser_spec.rb
|
74
|
+
- spec/spec_helper.rb
|