commandeer 0.0.1 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
data/README.md ADDED
@@ -0,0 +1,209 @@
1
+ # Commandeer
2
+ Commandeer is a simple (and rather ghetto) implementation of a class-based CLI builder.
3
+
4
+ ## Needs/Goals
5
+ - Easily create git-style subcommands
6
+ - Be option parser agnostic
7
+ - Not be a framework
8
+
9
+ The idea is simply that you can expose any class as a git-style CLI option. Your bin script can then simply call `Commandeer.parse!(ARGV)`.
10
+
11
+ This came about when trying to create a simple all-in-one CLI application. I wanted to be able to do:
12
+
13
+ - `myapp log search [options here]`
14
+ - `myapp log tail [options here]`
15
+ - `myapp deploy appname`
16
+ - `myapp someother command [options here]`
17
+
18
+ However I didn't want to maintain a single option parser. The cli app was modular and I just wanted to keep the options for a command in the class that handled it.
19
+ In this way, I didn't have to remember to go update the option parser defintion/bin script when I added new functionality.
20
+
21
+ ### Simple example
22
+
23
+ ```ruby
24
+ # test-app.rb
25
+ require 'commandeer'
26
+
27
+ class Foo
28
+ include Commandeer
29
+ command "run"
30
+
31
+ def self.parse(opts)
32
+ puts opts
33
+ end
34
+ end
35
+
36
+ Commandeer.parse!(ARGV, __FILE__)
37
+ ```
38
+
39
+ Without any options:
40
+
41
+ ```
42
+ Usage: ./test-app.rb [command options] or [command subcommand options]
43
+
44
+ run
45
+ ```
46
+
47
+ Once you add a known subcommand to the arguments, everything is passed off to the class' parse method. In the above example, it simply prints the passed args to output.
48
+ What this means is that you can use ANY option parser (or none at all) that you like. You could conceivably use `slop`, `optparse` and custom stuff all in the same codebase.
49
+ Commandeer is like honey badger. It just doesn't give a damn.
50
+
51
+ The only "requirement" is that the parser for the class be a class method.
52
+
53
+ By default, Commandeer will look for a class method called `parse` but most everything is overrideable:
54
+
55
+ - method name: _You can call a method other than parse_
56
+ - class: _You can call another class' parse method_
57
+ - parent: _You can set the command to be a subcommand by giving it a parent. The parent can, but doesn't have to be, a real command._
58
+
59
+ ### Complex example
60
+
61
+ ```ruby
62
+ # override-all-the-things
63
+ class Override
64
+ def self.zing(args)
65
+ puts "I am overriding all the things:"
66
+ puts args
67
+ end
68
+ end
69
+
70
+ class AllTheThings
71
+ include Commandeer
72
+
73
+ command "all-the-things", :parent => 'override', :klass => "Override", :parser => "zing"
74
+ end
75
+
76
+ Commandeer.parse!(ARGV)
77
+ ```
78
+
79
+ Output:
80
+
81
+ ```
82
+ $ test-app.rb
83
+ Usage: ./test-app.rb [command options] or [command subcommand options]
84
+
85
+ override Subcommands: all-the-things
86
+
87
+ $ test-app.rb override
88
+ `override` has the following registered subcommands:
89
+ all-the-things
90
+
91
+ $ ./test-app.rb override all-the-things for-great-justice
92
+ I am overriding all the things:
93
+ for-great-justice
94
+ ```
95
+
96
+ ### Mixing command options and subcommands
97
+ You can even add a subcommand to a top-level command that has its own parser (but you'll get a nasty warning about it).
98
+
99
+ ```ruby
100
+ require 'commandeer'
101
+ require 'optparse'
102
+
103
+ class Parent
104
+ include Commandeer
105
+
106
+ command "parent"
107
+
108
+ def self.parse(args)
109
+ options = {}
110
+ opts = OptionParser.new do |opts|
111
+ opts.banner = "parent [options]"
112
+
113
+ opts.on("-p", "--parent PARENTTHING", "The option for parent") do |f|
114
+ options[:f] = f
115
+ end
116
+ opts.on_tail("-h", "--help", "parent help") do
117
+ puts opts
118
+ exit(1)
119
+ end
120
+ end
121
+ begin
122
+ opts.parse!(args)
123
+ rescue OptionParser::InvalidOption => e
124
+ puts e
125
+ puts opts
126
+ end
127
+ end
128
+ end
129
+
130
+ class Child
131
+ include Commandeer
132
+
133
+ command "child", :parent => 'parent'
134
+
135
+ def self.parse(args)
136
+ options = {}
137
+ opts = OptionParser.new do |opts|
138
+ opts.banner = "child [options]"
139
+
140
+ opts.on("-c", "--child CHILDTHING", "The option for child") do |f|
141
+ options[:f] = f
142
+ end
143
+ opts.on_tail("-h", "--help", "child help") do
144
+ puts opts
145
+ exit(1)
146
+ end
147
+ end
148
+ begin
149
+ opts.parse!(args)
150
+ rescue OptionParser::InvalidOption => e
151
+ puts e
152
+ puts opts
153
+ end
154
+ end
155
+ end
156
+
157
+ Commandeer.parse!(ARGV,__FILE__)
158
+ ```
159
+
160
+ Output:
161
+
162
+ ```
163
+ $ ./test-app.rb
164
+ Usage: ./test-app.rb [command options] or [command subcommand options]
165
+
166
+ parent Subcommands: child
167
+
168
+ $ ./test-app.rb parent
169
+ `parent` has the following registered subcommands:
170
+ child
171
+
172
+ $ ./test-app.rb parent --help
173
+ parent [options]
174
+ -p, --parent PARENTTHING The option for parent
175
+ -h, --help parent help
176
+ exit
177
+
178
+ $ ./test-app.rb parent child
179
+ Warning! `child` is a registered subcommand for `parent` but `parent` also takes options.
180
+ This can cause unexpected results if `parent` has an option named `child`
181
+
182
+ $ ./test-app.rb parent child --help
183
+ Warning! `child` is a registered subcommand for `parent` but `parent` also takes options.
184
+ This can cause unexpected results if `parent` has an option named `child`
185
+ child [options]
186
+ -c, --child CHILDTHING The option for child
187
+ -h, --help child help
188
+ ```
189
+
190
+ # Contributing
191
+
192
+ * Fork
193
+ * New branch
194
+ * Pull Request
195
+ * Collect eternal gratitude
196
+
197
+
198
+ # Fun fact of the day
199
+ I really wanted to call this "cylon" so you could do this:
200
+
201
+ ```ruby
202
+ class Foo
203
+ include Cylon
204
+
205
+ by_your_command "kill_humans"
206
+ end
207
+ ```
208
+
209
+ Oh well.
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ #!/usr/bin/env rake
2
+ require "bundler/gem_tasks"
3
+ require "rake/testtask"
4
+
5
+
6
+ desc "Run all tests"
7
+ task :test do
8
+ tests = Dir.glob('test/test_*.rb')
9
+ tests.shuffle.each do |test|
10
+ sh %{/usr/bin/env ruby #{test}}
11
+ end
12
+ end
data/lib/commandeer.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module Commandeer
2
- VERSION = "0.0.1"
2
+ VERSION = "0.1.0"
3
3
 
4
4
  @commands = {}
5
5
 
@@ -40,18 +40,19 @@ module Commandeer
40
40
 
41
41
  # No args. Let's show what we have registered
42
42
  if (args.size == 0) || (args[0] =~ /^-/)
43
- puts "Usage: #{@script_name} [command options] or [command subcommand options]\n\n"
44
- puts "Registered commands\n"
43
+ output = ''
44
+ output << "Usage: #{@script_name} [command options] or [command subcommand options]\n\n"
45
45
  @commands.each do |command, options|
46
46
  next if (command==:klass || command==:parser)
47
- puts " #{command}"
47
+ output << "\t#{command}\t"
48
48
  unless options["subcommands"].nil?
49
- puts " subcommands:"
49
+ output << "Subcommands:"
50
50
  options["subcommands"].each do |sub, opts|
51
- puts " #{sub}"
51
+ output << " #{sub}"
52
52
  end
53
53
  end
54
54
  end
55
+ puts output
55
56
  exit
56
57
  end
57
58
 
@@ -64,29 +65,28 @@ module Commandeer
64
65
 
65
66
  subcommands = command["subcommands"]
66
67
 
67
- if subcommands
68
+ if subcommands && args.size == 0
68
69
  output = ''
69
70
  output << "`#{scope}` has the following registered subcommands:\n"
70
71
  subcommands.keys.each {|x| output << "\t#{x}" }
71
72
  puts output
72
- end if args.size == 0
73
+ end
73
74
 
74
- if command.has_key?(:parser)
75
- output = ''
76
- output << "\n`#{scope}` also takes options"
77
- output << "\ntry running '#{@script_name} #{scope} --help'"
78
- puts output
79
- end if args.size == 0
75
+ if command.has_key?(:parser) && args.size == 0
76
+ # We should just pass this straight to the parser and be done
77
+ parser = command[:parser]
78
+ klass = command[:klass]
79
+ end
80
80
 
81
81
  if args.size > 0
82
- if subcommands.has_key?(args[0])
82
+ if subcommands && subcommands.has_key?(args[0])
83
83
  # Okay so the next arg is a registered subcommand. Let's shift args
84
84
  new_scope = args.shift
85
85
  warning =<<-EOF
86
86
  Warning! `#{new_scope}` is a registered subcommand for `#{scope}` but `#{scope}` also takes options.
87
87
  This can cause unexpected results if `#{scope}` has an option named `#{new_scope}`
88
88
  EOF
89
- puts warning
89
+ puts warning if command.has_key?(:parser)
90
90
 
91
91
  parser = subcommands[new_scope][:parser]
92
92
  klass = subcommands[new_scope][:klass]
@@ -1,4 +1,7 @@
1
1
  $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
2
2
  $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "test")))
3
- require 'commandeer'
3
+ gem 'minitest'
4
+ require 'minitest/pride'
4
5
  require 'minitest/autorun'
6
+ require 'commandeer'
7
+ Commandeer.reset!
@@ -1,6 +1,6 @@
1
1
  class Foo
2
2
  def self.zing(args)
3
- puts args
3
+ puts *args
4
4
  end
5
5
  end
6
6
 
@@ -6,6 +6,7 @@ module Name
6
6
 
7
7
  def self.parse(args)
8
8
  puts args
9
+ exit
9
10
  end
10
11
  end
11
12
  end
@@ -0,0 +1,58 @@
1
+ require "#{File.expand_path(File.join(File.dirname(__FILE__), "helper.rb"))}"
2
+
3
+ class TestOverrideAll < MiniTest::Unit::TestCase
4
+ def setup
5
+ require 'helpers/all_override'
6
+ @commands = Commandeer.commands
7
+ end
8
+
9
+ def test_has_command
10
+ assert_includes(@commands.keys, "override")
11
+ end
12
+
13
+ def test_has_subcommands
14
+ assert_includes(@commands['override'].keys, 'subcommands')
15
+ end
16
+
17
+ def test_has_subcommand
18
+ assert_includes(@commands['override']['subcommands'].keys, 'random')
19
+ end
20
+
21
+ def test_subcommand_has_parser
22
+ assert(@commands['override']['subcommands']['random'][:parser], "zing")
23
+ end
24
+
25
+ def test_subcommand_has_klass
26
+ assert(@commands['override']['subcommands']['random'][:klass], "Foo")
27
+ end
28
+
29
+ def test_output_noopts
30
+ out, err = capture_io do
31
+ begin
32
+ Commandeer.parse! ''
33
+ rescue SystemExit
34
+ end
35
+ end
36
+ assert_match(out, /^.*Usage.*\n\n\t.*override\tSubcommands: random.*$/)
37
+ end
38
+
39
+ def test_output_override
40
+ out, err = capture_io do
41
+ begin
42
+ Commandeer.parse! %w{override}
43
+ rescue SystemExit
44
+ end
45
+ end
46
+ assert_match(out, /`override` has the following registered subcommands:\n\trandom.*$/)
47
+ end
48
+
49
+ def test_output_random_options
50
+ out, err = capture_io do
51
+ begin
52
+ Commandeer.parse! %w{override random foo bar baz}
53
+ rescue SystemExit
54
+ end
55
+ end
56
+ assert_match(out, /^foo\nbar\nbaz\n*$/)
57
+ end
58
+ end
@@ -0,0 +1,42 @@
1
+ require "#{File.expand_path(File.join(File.dirname(__FILE__), "helper.rb"))}"
2
+
3
+ class TestCommand < MiniTest::Unit::TestCase
4
+ def setup
5
+ require 'helpers/command.rb'
6
+ @commands = Commandeer.commands
7
+ end
8
+
9
+ def test_has_command
10
+ assert_includes(@commands.keys, "foo")
11
+ end
12
+
13
+ def test_has_parser
14
+ assert(@commands['foo'][:parser], "parse")
15
+ end
16
+
17
+ def test_has_klass
18
+ assert(@commands['foo'][:klass], "PrimaryCommand")
19
+ end
20
+
21
+ def test_output_noopts
22
+ out, err = capture_io do
23
+ begin
24
+ Commandeer.parse! ''
25
+ rescue SystemExit
26
+ end
27
+ end
28
+
29
+ assert_match(out, /^.*\tfoo.*$/)
30
+ end
31
+
32
+ def test_output_foo
33
+ out, err = capture_io do
34
+ begin
35
+ Commandeer.parse! %w{foo --help}
36
+ rescue SystemExit
37
+ end
38
+ end
39
+
40
+ assert_match(out, /^foo \[options\]*$/)
41
+ end
42
+ end
@@ -0,0 +1,28 @@
1
+ require "#{File.expand_path(File.join(File.dirname(__FILE__), "helper.rb"))}"
2
+
3
+ class TestMethods < MiniTest::Unit::TestCase
4
+ def setup
5
+ @commands = Commandeer.commands
6
+ end
7
+
8
+ def test_commands_is_hash
9
+ assert_kind_of(Hash, @commands)
10
+ end
11
+
12
+ def test_respond_to_reset
13
+ assert_respond_to(Commandeer, :reset!)
14
+ end
15
+
16
+ def test_respond_to_add_command
17
+ assert_respond_to(Commandeer, :add_command)
18
+ end
19
+
20
+ def test_respond_to_parse
21
+ assert_respond_to(Commandeer, :parse!)
22
+ end
23
+
24
+ def test_respond_to_constantize
25
+ assert_respond_to(Commandeer, :constantize)
26
+ end
27
+
28
+ end
@@ -0,0 +1,41 @@
1
+ require "#{File.expand_path(File.join(File.dirname(__FILE__), "helper.rb"))}"
2
+
3
+ class TestNameSpaced < MiniTest::Unit::TestCase
4
+ def setup
5
+ require 'helpers/namespaced.rb'
6
+ @commands = Commandeer.commands
7
+ end
8
+
9
+ def test_has_command
10
+ assert_includes(@commands.keys, "namespaced")
11
+ end
12
+
13
+ def test_namespaced_has_parser
14
+ assert(@commands['namespaced'][:parser], "parse")
15
+ end
16
+
17
+ def test_has_klass
18
+ assert(@commands['namespaced'][:klass], "Name::Spaced")
19
+ end
20
+
21
+ def test_output_noopts
22
+ out, err = capture_io do
23
+ begin
24
+ Commandeer.parse! ''
25
+ rescue SystemExit
26
+ end
27
+ end
28
+ assert_match(out, /^.*Usage.*\n\n\t.*namespaced.*$/)
29
+ end
30
+
31
+ def test_output_namespaced
32
+ out, err = capture_io do
33
+ begin
34
+ Commandeer.parse! %w{namespaced an_opt}
35
+ rescue SystemExit
36
+ end
37
+ end
38
+ assert_match(out, /an_opt/)
39
+ end
40
+
41
+ end
@@ -0,0 +1,86 @@
1
+ require "#{File.expand_path(File.join(File.dirname(__FILE__), "helper.rb"))}"
2
+
3
+ class TestSubOfRealCommand < MiniTest::Unit::TestCase
4
+ def setup
5
+ require 'helpers/sub_of_real_command.rb'
6
+ @commands = Commandeer.commands
7
+ end
8
+
9
+ def test_has_command
10
+ assert_includes(@commands.keys, "parent")
11
+ end
12
+
13
+ def test_command_has_parser
14
+ assert(@commands['parent'][:parser], "parse")
15
+ end
16
+
17
+ def test_command_has_class
18
+ assert(@commands['parent'][:klass], "Parent")
19
+ end
20
+
21
+ def test_has_subcommands
22
+ assert_includes(@commands['parent'].keys, 'subcommands')
23
+ end
24
+
25
+ def test_has_subcommand
26
+ assert_includes(@commands['parent']['subcommands'].keys, 'child')
27
+ end
28
+
29
+ def test_subcommand_has_parser
30
+ assert(@commands['parent']['subcommands']['child'][:parser], "parse")
31
+ end
32
+
33
+ def test_subcommand_has_klass
34
+ assert(@commands['parent']['subcommands']['child'][:klass], "Child")
35
+ end
36
+
37
+ def test_output_noopts
38
+ out, err = capture_io do
39
+ begin
40
+ Commandeer.parse! ''
41
+ rescue SystemExit
42
+ end
43
+ end
44
+ assert_match(out, /^.*Usage.*\n\n\t.*parent\tSubcommands: child.*$/)
45
+ end
46
+
47
+ def test_output_parent
48
+ out, err = capture_io do
49
+ begin
50
+ Commandeer.parse! %w{parent}
51
+ rescue SystemExit
52
+ end
53
+ end
54
+ assert_match(out, /`parent` has the following registered subcommands:\n\tchild.*$/)
55
+ end
56
+
57
+ def test_output_parent_options
58
+ out, err = capture_io do
59
+ begin
60
+ Commandeer.parse! %w{parent --help}
61
+ rescue SystemExit
62
+ end
63
+ end
64
+ assert_match(out, /^parent \[options\]*$/)
65
+ end
66
+
67
+ def test_output_child_with_warning
68
+ out, err = capture_io do
69
+ begin
70
+ Commandeer.parse! %w{parent child}
71
+ rescue SystemExit
72
+ end
73
+ end
74
+ assert_match(out, /^.*Warning! `child` is a registered subcommand for `parent` but `parent` also takes options.*$/)
75
+ end
76
+
77
+ def test_output_child_options
78
+ out, err = capture_io do
79
+ begin
80
+ Commandeer.parse! %w{parent child --help}
81
+ rescue SystemExit
82
+ end
83
+ end
84
+ assert_match(out, /^.*\nchild \[options\]*$/)
85
+ end
86
+ end
@@ -0,0 +1,58 @@
1
+ require "#{File.expand_path(File.join(File.dirname(__FILE__), "helper.rb"))}"
2
+
3
+ class TestSubCommand < MiniTest::Unit::TestCase
4
+ def setup
5
+ require 'helpers/subcommand.rb'
6
+ @commands = Commandeer.commands
7
+ end
8
+
9
+ def test_has_command
10
+ assert_includes(@commands.keys, "fakeparent")
11
+ end
12
+
13
+ def test_has_subcommands
14
+ assert_includes(@commands['fakeparent'].keys, 'subcommands')
15
+ end
16
+
17
+ def test_has_subcommand
18
+ assert_includes(@commands['fakeparent']['subcommands'].keys, 'bar')
19
+ end
20
+
21
+ def test_subcommand_has_parser
22
+ assert(@commands['fakeparent']['subcommands']['bar'][:parser], "parse")
23
+ end
24
+
25
+ def test_has_klass
26
+ assert(@commands['fakeparent']['subcommands']['bar'][:klass], "SubCommand")
27
+ end
28
+
29
+ def test_output_noopts
30
+ out, err = capture_io do
31
+ begin
32
+ Commandeer.parse! ''
33
+ rescue SystemExit
34
+ end
35
+ end
36
+ assert_match(out, /^.*Usage.*\n\n\t.*fakeparent\tSubcommands: bar.*$/)
37
+ end
38
+
39
+ def test_output_fakeparent
40
+ out, err = capture_io do
41
+ begin
42
+ Commandeer.parse! %w{fakeparent}
43
+ rescue SystemExit
44
+ end
45
+ end
46
+ assert_match(out, /`fakeparent` has the following registered subcommands:\n\tbar.*$/)
47
+ end
48
+
49
+ def test_output_bar_options
50
+ out, err = capture_io do
51
+ begin
52
+ Commandeer.parse! %w{fakeparent bar --help}
53
+ rescue SystemExit
54
+ end
55
+ end
56
+ assert_match(out, /^bar \[options\]*$/)
57
+ end
58
+ end
metadata CHANGED
@@ -2,7 +2,7 @@
2
2
  name: commandeer
3
3
  version: !ruby/object:Gem::Version
4
4
  prerelease:
5
- version: 0.0.1
5
+ version: 0.1.0
6
6
  platform: ruby
7
7
  authors:
8
8
  - John E. Vincent
@@ -10,7 +10,7 @@ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
12
 
13
- date: 2011-11-28 00:00:00 Z
13
+ date: 2011-12-05 00:00:00 Z
14
14
  dependencies: []
15
15
 
16
16
  description: Class-based CLI utility
@@ -25,16 +25,23 @@ extra_rdoc_files: []
25
25
  files:
26
26
  - .gitignore
27
27
  - Gemfile
28
+ - LICENSE
29
+ - README.md
30
+ - Rakefile
28
31
  - commandeer.gemspec
29
32
  - lib/commandeer.rb
33
+ - test/helper.rb
30
34
  - test/helpers/all_override.rb
31
35
  - test/helpers/command.rb
32
36
  - test/helpers/namespaced.rb
33
37
  - test/helpers/sub_of_real_command.rb
34
38
  - test/helpers/subcommand.rb
35
- - test/test_commands.rb
36
- - test/test_helper.rb
37
- - test/test_output.rb
39
+ - test/test_all_override.rb
40
+ - test/test_command.rb
41
+ - test/test_methods.rb
42
+ - test/test_namespaced.rb
43
+ - test/test_sub_of_real.rb
44
+ - test/test_subcommand.rb
38
45
  homepage: https://github.com/lusis/commandeer
39
46
  licenses: []
40
47
 
File without changes
data/test/test_output.rb DELETED
File without changes