wijet-thor 0.14.6
Sign up to get free protection for your applications and to get access to all the features.
- data/CHANGELOG.rdoc +103 -0
- data/LICENSE +20 -0
- data/README.md +307 -0
- data/Thorfile +24 -0
- data/bin/rake2thor +86 -0
- data/bin/thor +6 -0
- data/lib/thor.rb +334 -0
- data/lib/thor/actions.rb +314 -0
- data/lib/thor/actions/create_file.rb +105 -0
- data/lib/thor/actions/create_link.rb +57 -0
- data/lib/thor/actions/directory.rb +93 -0
- data/lib/thor/actions/empty_directory.rb +134 -0
- data/lib/thor/actions/file_manipulation.rb +270 -0
- data/lib/thor/actions/inject_into_file.rb +109 -0
- data/lib/thor/base.rb +579 -0
- data/lib/thor/core_ext/file_binary_read.rb +9 -0
- data/lib/thor/core_ext/hash_with_indifferent_access.rb +75 -0
- data/lib/thor/core_ext/ordered_hash.rb +100 -0
- data/lib/thor/error.rb +30 -0
- data/lib/thor/group.rb +273 -0
- data/lib/thor/invocation.rb +168 -0
- data/lib/thor/parser.rb +4 -0
- data/lib/thor/parser/argument.rb +67 -0
- data/lib/thor/parser/arguments.rb +161 -0
- data/lib/thor/parser/option.rb +120 -0
- data/lib/thor/parser/options.rb +173 -0
- data/lib/thor/rake_compat.rb +66 -0
- data/lib/thor/runner.rb +309 -0
- data/lib/thor/shell.rb +88 -0
- data/lib/thor/shell/basic.rb +290 -0
- data/lib/thor/shell/color.rb +108 -0
- data/lib/thor/shell/html.rb +121 -0
- data/lib/thor/task.rb +114 -0
- data/lib/thor/util.rb +229 -0
- data/lib/thor/version.rb +3 -0
- data/spec/actions/create_file_spec.rb +170 -0
- data/spec/actions/directory_spec.rb +136 -0
- data/spec/actions/empty_directory_spec.rb +98 -0
- data/spec/actions/file_manipulation_spec.rb +310 -0
- data/spec/actions/inject_into_file_spec.rb +135 -0
- data/spec/actions_spec.rb +322 -0
- data/spec/base_spec.rb +269 -0
- data/spec/core_ext/hash_with_indifferent_access_spec.rb +43 -0
- data/spec/core_ext/ordered_hash_spec.rb +115 -0
- data/spec/fixtures/application.rb +2 -0
- data/spec/fixtures/bundle/execute.rb +6 -0
- data/spec/fixtures/bundle/main.thor +1 -0
- data/spec/fixtures/doc/%file_name%.rb.tt +1 -0
- data/spec/fixtures/doc/README +3 -0
- data/spec/fixtures/doc/block_helper.rb +3 -0
- data/spec/fixtures/doc/components/.empty_directory +0 -0
- data/spec/fixtures/doc/config.rb +1 -0
- data/spec/fixtures/group.thor +114 -0
- data/spec/fixtures/invoke.thor +112 -0
- data/spec/fixtures/path with spaces b/data/spec/fixtures/path with → spaces +0 -0
- data/spec/fixtures/script.thor +184 -0
- data/spec/fixtures/task.thor +10 -0
- data/spec/group_spec.rb +178 -0
- data/spec/invocation_spec.rb +100 -0
- data/spec/parser/argument_spec.rb +47 -0
- data/spec/parser/arguments_spec.rb +64 -0
- data/spec/parser/option_spec.rb +202 -0
- data/spec/parser/options_spec.rb +319 -0
- data/spec/rake_compat_spec.rb +68 -0
- data/spec/register_spec.rb +104 -0
- data/spec/runner_spec.rb +210 -0
- data/spec/shell/basic_spec.rb +223 -0
- data/spec/shell/color_spec.rb +41 -0
- data/spec/shell/html_spec.rb +27 -0
- data/spec/shell_spec.rb +47 -0
- data/spec/spec_helper.rb +54 -0
- data/spec/task_spec.rb +74 -0
- data/spec/thor_spec.rb +334 -0
- data/spec/util_spec.rb +163 -0
- metadata +193 -0
data/spec/base_spec.rb
ADDED
@@ -0,0 +1,269 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
|
2
|
+
require 'thor/base'
|
3
|
+
|
4
|
+
class Amazing
|
5
|
+
desc "hello", "say hello"
|
6
|
+
def hello
|
7
|
+
puts "Hello"
|
8
|
+
end
|
9
|
+
end
|
10
|
+
|
11
|
+
describe Thor::Base do
|
12
|
+
describe "#initialize" do
|
13
|
+
it "sets arguments array" do
|
14
|
+
base = MyCounter.new [1, 2]
|
15
|
+
base.first.should == 1
|
16
|
+
base.second.should == 2
|
17
|
+
end
|
18
|
+
|
19
|
+
it "sets arguments default values" do
|
20
|
+
base = MyCounter.new [1]
|
21
|
+
base.second.should == 2
|
22
|
+
end
|
23
|
+
|
24
|
+
it "sets options default values" do
|
25
|
+
base = MyCounter.new [1, 2]
|
26
|
+
base.options[:third].should == 3
|
27
|
+
end
|
28
|
+
|
29
|
+
it "allows options to be given as symbols or strings" do
|
30
|
+
base = MyCounter.new [1, 2], :third => 4
|
31
|
+
base.options[:third].should == 4
|
32
|
+
|
33
|
+
base = MyCounter.new [1, 2], "third" => 4
|
34
|
+
base.options[:third].should == 4
|
35
|
+
end
|
36
|
+
|
37
|
+
it "creates options with indifferent access" do
|
38
|
+
base = MyCounter.new [1, 2], :third => 3
|
39
|
+
base.options['third'].should == 3
|
40
|
+
end
|
41
|
+
|
42
|
+
it "creates options with magic predicates" do
|
43
|
+
base = MyCounter.new [1, 2], :third => 3
|
44
|
+
base.options.third.should == 3
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
describe "#no_tasks" do
|
49
|
+
it "avoids methods being added as tasks" do
|
50
|
+
MyScript.tasks.keys.should include("animal")
|
51
|
+
MyScript.tasks.keys.should_not include("this_is_not_a_task")
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
describe "#argument" do
|
56
|
+
it "sets a value as required and creates an accessor for it" do
|
57
|
+
MyCounter.start(["1", "2", "--third", "3"])[0].should == 1
|
58
|
+
Scripts::MyScript.start(["zoo", "my_special_param", "--param=normal_param"]).should == "my_special_param"
|
59
|
+
end
|
60
|
+
|
61
|
+
it "does not set a value in the options hash" do
|
62
|
+
BrokenCounter.start(["1", "2", "--third", "3"])[0].should be_nil
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
describe "#arguments" do
|
67
|
+
it "returns the arguments for the class" do
|
68
|
+
MyCounter.arguments.should have(2).items
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
describe "#class_option" do
|
73
|
+
it "sets options class wise" do
|
74
|
+
MyCounter.start(["1", "2", "--third", "3"])[2].should == 3
|
75
|
+
end
|
76
|
+
|
77
|
+
it "does not create an accessor for it" do
|
78
|
+
BrokenCounter.start(["1", "2", "--third", "3"])[3].should be_false
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
describe "#class_options" do
|
83
|
+
it "sets default options overwriting superclass definitions" do
|
84
|
+
options = Scripts::MyScript.class_options
|
85
|
+
options[:force].should_not be_required
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
describe "#remove_argument" do
|
90
|
+
it "removes previous defined arguments from class" do
|
91
|
+
ClearCounter.arguments.should be_empty
|
92
|
+
end
|
93
|
+
|
94
|
+
it "undefine accessors if required" do
|
95
|
+
ClearCounter.new.should_not respond_to(:first)
|
96
|
+
ClearCounter.new.should_not respond_to(:second)
|
97
|
+
end
|
98
|
+
end
|
99
|
+
|
100
|
+
describe "#remove_class_option" do
|
101
|
+
it "removes previous defined class option" do
|
102
|
+
ClearCounter.class_options[:third].should be_nil
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
describe "#class_options_help" do
|
107
|
+
before(:each) do
|
108
|
+
@content = capture(:stdout) { MyCounter.help(Thor::Base.shell.new) }
|
109
|
+
end
|
110
|
+
|
111
|
+
it "shows options description" do
|
112
|
+
@content.should =~ /# The third argument/
|
113
|
+
end
|
114
|
+
|
115
|
+
it "shows usage with banner content" do
|
116
|
+
@content.should =~ /\[\-\-third=THREE\]/
|
117
|
+
end
|
118
|
+
|
119
|
+
it "shows default values below description" do
|
120
|
+
@content.should =~ /# Default: 3/
|
121
|
+
end
|
122
|
+
|
123
|
+
it "shows options in different groups" do
|
124
|
+
@content.should =~ /Options\:/
|
125
|
+
@content.should =~ /Runtime options\:/
|
126
|
+
@content.should =~ /\-p, \[\-\-pretend\]/
|
127
|
+
end
|
128
|
+
|
129
|
+
it "use padding in options that does not have aliases" do
|
130
|
+
@content.should =~ /^ -t, \[--third/
|
131
|
+
@content.should =~ /^ \[--fourth/
|
132
|
+
end
|
133
|
+
|
134
|
+
it "allows extra options to be given" do
|
135
|
+
hash = { "Foo" => B.class_options.values }
|
136
|
+
|
137
|
+
content = capture(:stdout) { MyCounter.send(:class_options_help, Thor::Base.shell.new, hash) }
|
138
|
+
content.should =~ /Foo options\:/
|
139
|
+
content.should =~ /--last-name=LAST_NAME/
|
140
|
+
end
|
141
|
+
end
|
142
|
+
|
143
|
+
describe "#namespace" do
|
144
|
+
it "returns the default class namespace" do
|
145
|
+
Scripts::MyScript.namespace.should == "scripts:my_script"
|
146
|
+
end
|
147
|
+
|
148
|
+
it "sets a namespace to the class" do
|
149
|
+
Scripts::MyDefaults.namespace.should == "default"
|
150
|
+
end
|
151
|
+
end
|
152
|
+
|
153
|
+
describe "#group" do
|
154
|
+
it "sets a group" do
|
155
|
+
MyScript.group.should == "script"
|
156
|
+
end
|
157
|
+
|
158
|
+
it "inherits the group from parent" do
|
159
|
+
MyChildScript.group.should == "script"
|
160
|
+
end
|
161
|
+
|
162
|
+
it "defaults to standard if no group is given" do
|
163
|
+
Amazing.group.should == "standard"
|
164
|
+
end
|
165
|
+
end
|
166
|
+
|
167
|
+
describe "#subclasses" do
|
168
|
+
it "tracks its subclasses in an Array" do
|
169
|
+
Thor::Base.subclasses.should include(MyScript)
|
170
|
+
Thor::Base.subclasses.should include(MyChildScript)
|
171
|
+
Thor::Base.subclasses.should include(Scripts::MyScript)
|
172
|
+
end
|
173
|
+
end
|
174
|
+
|
175
|
+
describe "#subclass_files" do
|
176
|
+
it "returns tracked subclasses, grouped by the files they come from" do
|
177
|
+
thorfile = File.join(File.dirname(__FILE__), "fixtures", "script.thor")
|
178
|
+
Thor::Base.subclass_files[File.expand_path(thorfile)].should == [
|
179
|
+
MyScript, MyScript::AnotherScript, MyChildScript, Barn,
|
180
|
+
Scripts::MyScript, Scripts::MyDefaults, Scripts::ChildDefault
|
181
|
+
]
|
182
|
+
end
|
183
|
+
|
184
|
+
it "tracks a single subclass across multiple files" do
|
185
|
+
thorfile = File.join(File.dirname(__FILE__), "fixtures", "task.thor")
|
186
|
+
Thor::Base.subclass_files[File.expand_path(thorfile)].should include(Amazing)
|
187
|
+
Thor::Base.subclass_files[File.expand_path(__FILE__)].should include(Amazing)
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
describe "#tasks" do
|
192
|
+
it "returns a list with all tasks defined in this class" do
|
193
|
+
MyChildScript.new.should respond_to("animal")
|
194
|
+
MyChildScript.tasks.keys.should include("animal")
|
195
|
+
end
|
196
|
+
|
197
|
+
it "raises an error if a task with reserved word is defined" do
|
198
|
+
lambda {
|
199
|
+
klass = Class.new(Thor::Group)
|
200
|
+
klass.class_eval "def shell; end"
|
201
|
+
}.should raise_error(RuntimeError, /"shell" is a Thor reserved word and cannot be defined as task/)
|
202
|
+
end
|
203
|
+
end
|
204
|
+
|
205
|
+
describe "#all_tasks" do
|
206
|
+
it "returns a list with all tasks defined in this class plus superclasses" do
|
207
|
+
MyChildScript.new.should respond_to("foo")
|
208
|
+
MyChildScript.all_tasks.keys.should include("foo")
|
209
|
+
end
|
210
|
+
end
|
211
|
+
|
212
|
+
describe "#remove_task" do
|
213
|
+
it "removes the task from its tasks hash" do
|
214
|
+
MyChildScript.tasks.keys.should_not include("bar")
|
215
|
+
MyChildScript.tasks.keys.should_not include("boom")
|
216
|
+
end
|
217
|
+
|
218
|
+
it "undefines the method if desired" do
|
219
|
+
MyChildScript.new.should_not respond_to("boom")
|
220
|
+
end
|
221
|
+
end
|
222
|
+
|
223
|
+
describe "#from_superclass" do
|
224
|
+
it "does not send a method to the superclass if the superclass does not respond to it" do
|
225
|
+
MyCounter.get_from_super.should == 13
|
226
|
+
end
|
227
|
+
end
|
228
|
+
|
229
|
+
describe "#start" do
|
230
|
+
it "raises an error instead of rescueing if --debug is given" do
|
231
|
+
lambda {
|
232
|
+
MyScript.start ["what", "--debug"]
|
233
|
+
}.should raise_error(Thor::UndefinedTaskError, 'Could not find task "what" in "my_script" namespace.')
|
234
|
+
end
|
235
|
+
|
236
|
+
it "does not steal args" do
|
237
|
+
args = ["foo", "bar", "--force", "true"]
|
238
|
+
MyScript.start(args)
|
239
|
+
args.should == ["foo", "bar", "--force", "true"]
|
240
|
+
end
|
241
|
+
|
242
|
+
it "checks unknown options" do
|
243
|
+
capture(:stderr) {
|
244
|
+
MyScript.start(["foo", "bar", "--force", "true", "--unknown", "baz"])
|
245
|
+
}.strip.should == "Unknown switches '--unknown'"
|
246
|
+
end
|
247
|
+
|
248
|
+
it "checks unknown options except specified" do
|
249
|
+
capture(:stderr) {
|
250
|
+
MyScript.start(["with_optional", "NAME", "--omg", "--invalid"]).should == ["NAME", {}]
|
251
|
+
}.strip.should be_empty
|
252
|
+
end
|
253
|
+
end
|
254
|
+
|
255
|
+
describe "attr_*" do
|
256
|
+
it "should not add attr_reader as a task" do
|
257
|
+
capture(:stderr){ MyScript.start(["another_attribute"]) }.should =~ /Could not find/
|
258
|
+
end
|
259
|
+
|
260
|
+
it "should not add attr_writer as a task" do
|
261
|
+
capture(:stderr){ MyScript.start(["another_attribute=", "foo"]) }.should =~ /Could not find/
|
262
|
+
end
|
263
|
+
|
264
|
+
it "should not add attr_accessor as a task" do
|
265
|
+
capture(:stderr){ MyScript.start(["some_attribute"]) }.should =~ /Could not find/
|
266
|
+
capture(:stderr){ MyScript.start(["some_attribute=", "foo"]) }.should =~ /Could not find/
|
267
|
+
end
|
268
|
+
end
|
269
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
|
2
|
+
require 'thor/core_ext/hash_with_indifferent_access'
|
3
|
+
|
4
|
+
describe Thor::CoreExt::HashWithIndifferentAccess do
|
5
|
+
before(:each) do
|
6
|
+
@hash = Thor::CoreExt::HashWithIndifferentAccess.new :foo => 'bar', 'baz' => 'bee', :force => true
|
7
|
+
end
|
8
|
+
|
9
|
+
it "has values accessible by either strings or symbols" do
|
10
|
+
@hash['foo'].should == 'bar'
|
11
|
+
@hash[:foo].should == 'bar'
|
12
|
+
|
13
|
+
@hash.values_at(:foo, :baz).should == ['bar', 'bee']
|
14
|
+
@hash.delete(:foo).should == 'bar'
|
15
|
+
end
|
16
|
+
|
17
|
+
it "handles magic boolean predicates" do
|
18
|
+
@hash.force?.should be_true
|
19
|
+
@hash.foo?.should be_true
|
20
|
+
@hash.nothing?.should be_false
|
21
|
+
end
|
22
|
+
|
23
|
+
it "handles magic comparisions" do
|
24
|
+
@hash.foo?('bar').should be_true
|
25
|
+
@hash.foo?('bee').should be_false
|
26
|
+
end
|
27
|
+
|
28
|
+
it "maps methods to keys" do
|
29
|
+
@hash.foo.should == @hash['foo']
|
30
|
+
end
|
31
|
+
|
32
|
+
it "merges keys independent if they are symbols or strings" do
|
33
|
+
@hash.merge!('force' => false, :baz => "boom")
|
34
|
+
@hash[:force].should == false
|
35
|
+
@hash[:baz].should == "boom"
|
36
|
+
end
|
37
|
+
|
38
|
+
it "creates a new hash by merging keys independent if they are symbols or strings" do
|
39
|
+
other = @hash.merge('force' => false, :baz => "boom")
|
40
|
+
other[:force].should == false
|
41
|
+
other[:baz].should == "boom"
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,115 @@
|
|
1
|
+
require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
|
2
|
+
require 'thor/core_ext/ordered_hash'
|
3
|
+
|
4
|
+
describe Thor::CoreExt::OrderedHash do
|
5
|
+
before :each do
|
6
|
+
@hash = Thor::CoreExt::OrderedHash.new
|
7
|
+
end
|
8
|
+
|
9
|
+
describe "without any items" do
|
10
|
+
it "returns nil for an undefined key" do
|
11
|
+
@hash["foo"].should be_nil
|
12
|
+
end
|
13
|
+
|
14
|
+
it "doesn't iterate through any items" do
|
15
|
+
@hash.each { fail }
|
16
|
+
end
|
17
|
+
|
18
|
+
it "has an empty key and values list" do
|
19
|
+
@hash.keys.should be_empty
|
20
|
+
@hash.values.should be_empty
|
21
|
+
end
|
22
|
+
|
23
|
+
it "must be empty" do
|
24
|
+
@hash.should be_empty
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
describe "with several items" do
|
29
|
+
before :each do
|
30
|
+
@hash[:foo] = "Foo!"
|
31
|
+
@hash[:bar] = "Bar!"
|
32
|
+
@hash[:baz] = "Baz!"
|
33
|
+
@hash[:bop] = "Bop!"
|
34
|
+
@hash[:bat] = "Bat!"
|
35
|
+
end
|
36
|
+
|
37
|
+
it "returns nil for an undefined key" do
|
38
|
+
@hash[:boom].should be_nil
|
39
|
+
end
|
40
|
+
|
41
|
+
it "returns the value for each key" do
|
42
|
+
@hash[:foo].should == "Foo!"
|
43
|
+
@hash[:bar].should == "Bar!"
|
44
|
+
@hash[:baz].should == "Baz!"
|
45
|
+
@hash[:bop].should == "Bop!"
|
46
|
+
@hash[:bat].should == "Bat!"
|
47
|
+
end
|
48
|
+
|
49
|
+
it "iterates through the keys and values in order of assignment" do
|
50
|
+
arr = []
|
51
|
+
@hash.each do |key, value|
|
52
|
+
arr << [key, value]
|
53
|
+
end
|
54
|
+
arr.should == [[:foo, "Foo!"], [:bar, "Bar!"], [:baz, "Baz!"],
|
55
|
+
[:bop, "Bop!"], [:bat, "Bat!"]]
|
56
|
+
end
|
57
|
+
|
58
|
+
it "returns the keys in order of insertion" do
|
59
|
+
@hash.keys.should == [:foo, :bar, :baz, :bop, :bat]
|
60
|
+
end
|
61
|
+
|
62
|
+
it "returns the values in order of insertion" do
|
63
|
+
@hash.values.should == ["Foo!", "Bar!", "Baz!", "Bop!", "Bat!"]
|
64
|
+
end
|
65
|
+
|
66
|
+
it "does not move an overwritten node to the end of the ordering" do
|
67
|
+
@hash[:baz] = "Bip!"
|
68
|
+
@hash.values.should == ["Foo!", "Bar!", "Bip!", "Bop!", "Bat!"]
|
69
|
+
|
70
|
+
@hash[:foo] = "Bip!"
|
71
|
+
@hash.values.should == ["Bip!", "Bar!", "Bip!", "Bop!", "Bat!"]
|
72
|
+
|
73
|
+
@hash[:bat] = "Bip!"
|
74
|
+
@hash.values.should == ["Bip!", "Bar!", "Bip!", "Bop!", "Bip!"]
|
75
|
+
end
|
76
|
+
|
77
|
+
it "appends another ordered hash while preserving ordering" do
|
78
|
+
other_hash = Thor::CoreExt::OrderedHash.new
|
79
|
+
other_hash[1] = "one"
|
80
|
+
other_hash[2] = "two"
|
81
|
+
other_hash[3] = "three"
|
82
|
+
@hash.merge(other_hash).values.should == ["Foo!", "Bar!", "Baz!", "Bop!", "Bat!", "one", "two", "three"]
|
83
|
+
end
|
84
|
+
|
85
|
+
it "overwrites hash keys with matching appended keys" do
|
86
|
+
other_hash = Thor::CoreExt::OrderedHash.new
|
87
|
+
other_hash[:bar] = "bar"
|
88
|
+
@hash.merge(other_hash)[:bar].should == "bar"
|
89
|
+
@hash[:bar].should == "Bar!"
|
90
|
+
end
|
91
|
+
|
92
|
+
it "converts to an array" do
|
93
|
+
@hash.to_a.should == [[:foo, "Foo!"], [:bar, "Bar!"], [:baz, "Baz!"], [:bop, "Bop!"], [:bat, "Bat!"]]
|
94
|
+
end
|
95
|
+
|
96
|
+
it "must not be empty" do
|
97
|
+
@hash.should_not be_empty
|
98
|
+
end
|
99
|
+
|
100
|
+
it "deletes values from hash" do
|
101
|
+
@hash.delete(:baz).should == "Baz!"
|
102
|
+
@hash.values.should == ["Foo!", "Bar!", "Bop!", "Bat!"]
|
103
|
+
|
104
|
+
@hash.delete(:foo).should == "Foo!"
|
105
|
+
@hash.values.should == ["Bar!", "Bop!", "Bat!"]
|
106
|
+
|
107
|
+
@hash.delete(:bat).should == "Bat!"
|
108
|
+
@hash.values.should == ["Bar!", "Bop!"]
|
109
|
+
end
|
110
|
+
|
111
|
+
it "returns nil if the value to be deleted can't be found" do
|
112
|
+
@hash.delete(:nothing).should be_nil
|
113
|
+
end
|
114
|
+
end
|
115
|
+
end
|
@@ -0,0 +1 @@
|
|
1
|
+
require File.join(File.dirname(__FILE__), 'execute')
|
@@ -0,0 +1 @@
|
|
1
|
+
FOO = <%= "FOO" %>
|