amqp-daemon-kit 0.1.8.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +5 -0
- data/Configuration.txt +110 -0
- data/Deployment.txt +113 -0
- data/History.txt +131 -0
- data/Logging.txt +96 -0
- data/PostInstall.txt +6 -0
- data/README.rdoc +132 -0
- data/Rakefile +29 -0
- data/RuoteParticipants.txt +113 -0
- data/TODO.txt +27 -0
- data/bin/daemon-kit +18 -0
- data/config/website.yml +2 -0
- data/daemon-kit.gemspec +265 -0
- data/lib/daemon_kit.rb +60 -0
- data/lib/daemon_kit/abstract_logger.rb +249 -0
- data/lib/daemon_kit/application.rb +230 -0
- data/lib/daemon_kit/arguments.rb +165 -0
- data/lib/daemon_kit/commands/console.rb +38 -0
- data/lib/daemon_kit/commands/destroy.rb +10 -0
- data/lib/daemon_kit/commands/generate.rb +10 -0
- data/lib/daemon_kit/config.rb +113 -0
- data/lib/daemon_kit/console_daemon.rb +2 -0
- data/lib/daemon_kit/core_ext.rb +1 -0
- data/lib/daemon_kit/core_ext/configurable.rb +96 -0
- data/lib/daemon_kit/core_ext/string.rb +22 -0
- data/lib/daemon_kit/cron.rb +67 -0
- data/lib/daemon_kit/cucumber/world.rb +38 -0
- data/lib/daemon_kit/deployment/capistrano.rb +516 -0
- data/lib/daemon_kit/dk_amqp.rb +39 -0
- data/lib/daemon_kit/em.rb +43 -0
- data/lib/daemon_kit/error_handlers/base.rb +32 -0
- data/lib/daemon_kit/error_handlers/hoptoad.rb +180 -0
- data/lib/daemon_kit/exceptions.rb +15 -0
- data/lib/daemon_kit/generators.rb +67 -0
- data/lib/daemon_kit/generators/base.rb +60 -0
- data/lib/daemon_kit/initializer.rb +449 -0
- data/lib/daemon_kit/jabber.rb +171 -0
- data/lib/daemon_kit/nanite.rb +7 -0
- data/lib/daemon_kit/nanite/agent.rb +77 -0
- data/lib/daemon_kit/pid_file.rb +61 -0
- data/lib/daemon_kit/ruote_participants.rb +125 -0
- data/lib/daemon_kit/ruote_pseudo_participant.rb +68 -0
- data/lib/daemon_kit/ruote_workitem.rb +187 -0
- data/lib/daemon_kit/safety.rb +84 -0
- data/lib/daemon_kit/tasks.rb +2 -0
- data/lib/daemon_kit/tasks/environment.rake +11 -0
- data/lib/daemon_kit/tasks/framework.rake +123 -0
- data/lib/daemon_kit/tasks/god.rake +62 -0
- data/lib/daemon_kit/tasks/log.rake +8 -0
- data/lib/daemon_kit/tasks/monit.rake +29 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/CHANGELOG.rdoc +89 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/LICENSE +20 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/README.rdoc +297 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/Thorfile +69 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor.rb +244 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/actions.rb +296 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/actions/create_file.rb +103 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/actions/directory.rb +91 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/actions/empty_directory.rb +134 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/actions/file_manipulation.rb +223 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/actions/inject_into_file.rb +104 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/base.rb +540 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/core_ext/file_binary_read.rb +9 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/core_ext/hash_with_indifferent_access.rb +75 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/core_ext/ordered_hash.rb +100 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/error.rb +30 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/group.rb +271 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/invocation.rb +180 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/parser.rb +4 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/parser/argument.rb +67 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/parser/arguments.rb +150 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/parser/option.rb +128 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/parser/options.rb +169 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/rake_compat.rb +66 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/runner.rb +314 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/shell.rb +83 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/shell/basic.rb +239 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/shell/color.rb +108 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/task.rb +102 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/util.rb +224 -0
- data/lib/daemon_kit/vendor/thor-0.13.6/lib/thor/version.rb +3 -0
- data/lib/daemon_kit/xmpp.rb +100 -0
- data/lib/generators/daemon_kit/amqp/USAGE +5 -0
- data/lib/generators/daemon_kit/amqp/amqp_generator.rb +24 -0
- data/lib/generators/daemon_kit/amqp/templates/config/amqp.yml +28 -0
- data/lib/generators/daemon_kit/amqp/templates/config/pre-daemonize/amqp.rb +7 -0
- data/lib/generators/daemon_kit/amqp/templates/libexec/%app_name%-daemon.rb +37 -0
- data/lib/generators/daemon_kit/app/USAGE +7 -0
- data/lib/generators/daemon_kit/app/app_generator.rb +140 -0
- data/lib/generators/daemon_kit/app/templates/Gemfile +12 -0
- data/lib/generators/daemon_kit/app/templates/README.tt +58 -0
- data/lib/generators/daemon_kit/app/templates/Rakefile +6 -0
- data/lib/generators/daemon_kit/app/templates/bin/daemon.tt +7 -0
- data/lib/generators/daemon_kit/app/templates/config/arguments.rb +12 -0
- data/lib/generators/daemon_kit/app/templates/config/boot.rb +70 -0
- data/lib/generators/daemon_kit/app/templates/config/environment.rb.tt +26 -0
- data/lib/generators/daemon_kit/app/templates/config/environments/development.rb +2 -0
- data/lib/generators/daemon_kit/app/templates/config/environments/production.rb +5 -0
- data/lib/generators/daemon_kit/app/templates/config/environments/test.rb +2 -0
- data/lib/generators/daemon_kit/app/templates/config/post-daemonize/readme +5 -0
- data/lib/generators/daemon_kit/app/templates/config/pre-daemonize/readme +12 -0
- data/lib/generators/daemon_kit/app/templates/lib/%app_name%.rb +2 -0
- data/lib/generators/daemon_kit/app/templates/libexec/%app_name%-daemon.rb +18 -0
- data/lib/generators/daemon_kit/app/templates/script/console +3 -0
- data/lib/generators/daemon_kit/app/templates/script/destroy +3 -0
- data/lib/generators/daemon_kit/app/templates/script/generate +3 -0
- data/lib/generators/daemon_kit/capistrano/capistrano_generator.rb +26 -0
- data/lib/generators/daemon_kit/capistrano/templates/Capfile +10 -0
- data/lib/generators/daemon_kit/capistrano/templates/USAGE +10 -0
- data/lib/generators/daemon_kit/capistrano/templates/config/deploy.rb.tt +67 -0
- data/lib/generators/daemon_kit/capistrano/templates/config/deploy/logrotate.erb +13 -0
- data/lib/generators/daemon_kit/capistrano/templates/config/deploy/production.rb.tt +6 -0
- data/lib/generators/daemon_kit/capistrano/templates/config/deploy/staging.rb.tt +6 -0
- data/lib/generators/daemon_kit/capistrano/templates/config/environments/staging.rb +0 -0
- data/lib/generators/daemon_kit/cron/USAGE +5 -0
- data/lib/generators/daemon_kit/cron/cron_generator.rb +24 -0
- data/lib/generators/daemon_kit/cron/templates/config/pre-daemonize/cron.rb +11 -0
- data/lib/generators/daemon_kit/cron/templates/libexec/%app_name%-daemon.rb +48 -0
- data/lib/generators/daemon_kit/cucumber/USAGE +11 -0
- data/lib/generators/daemon_kit/cucumber/cucumber_generator.rb +45 -0
- data/lib/generators/daemon_kit/cucumber/templates/config/environments/cucumber.rb +2 -0
- data/lib/generators/daemon_kit/cucumber/templates/features/step_definitions/.empty_directory +0 -0
- data/lib/generators/daemon_kit/cucumber/templates/features/support/env.rb +7 -0
- data/lib/generators/daemon_kit/cucumber/templates/script/cucumber +7 -0
- data/lib/generators/daemon_kit/cucumber/templates/tasks/cucumber.rake +13 -0
- data/lib/generators/daemon_kit/nanite_agent/USAGE +5 -0
- data/lib/generators/daemon_kit/nanite_agent/nanite_agent_generator.rb +29 -0
- data/lib/generators/daemon_kit/nanite_agent/templates/config/nanite.yml +35 -0
- data/lib/generators/daemon_kit/nanite_agent/templates/config/pre-daemonize/nanite_agent.rb +6 -0
- data/lib/generators/daemon_kit/nanite_agent/templates/lib/actors/sample.rb +11 -0
- data/lib/generators/daemon_kit/nanite_agent/templates/libexec/%app_name%-daemon.rb +31 -0
- data/lib/generators/daemon_kit/rspec/USAGE +5 -0
- data/lib/generators/daemon_kit/rspec/rspec_generator.rb +20 -0
- data/lib/generators/daemon_kit/rspec/templates/spec/%app_name%_spec.rb +11 -0
- data/lib/generators/daemon_kit/rspec/templates/spec/spec.opts +1 -0
- data/lib/generators/daemon_kit/rspec/templates/spec/spec_helper.rb +23 -0
- data/lib/generators/daemon_kit/rspec/templates/tasks/rspec.rake +21 -0
- data/lib/generators/daemon_kit/ruote/USAGE +5 -0
- data/lib/generators/daemon_kit/ruote/ruote_generator.rb +29 -0
- data/lib/generators/daemon_kit/ruote/templates/config/amqp.yml +30 -0
- data/lib/generators/daemon_kit/ruote/templates/config/pre-daemonize/ruote.rb +13 -0
- data/lib/generators/daemon_kit/ruote/templates/config/ruote.yml +23 -0
- data/lib/generators/daemon_kit/ruote/templates/lib/%app_name%.rb +4 -0
- data/lib/generators/daemon_kit/ruote/templates/lib/sample.rb +26 -0
- data/lib/generators/daemon_kit/ruote/templates/libexec/%app_name%-daemon.rb +33 -0
- data/lib/generators/daemon_kit/test_unit/USAGE +5 -0
- data/lib/generators/daemon_kit/test_unit/templates/tasks/test_unit.rake +7 -0
- data/lib/generators/daemon_kit/test_unit/templates/test/%app_name%_test.rb.tt +9 -0
- data/lib/generators/daemon_kit/test_unit/templates/test/test_helper.rb +6 -0
- data/lib/generators/daemon_kit/test_unit/test_unit_generator.rb +20 -0
- data/lib/generators/daemon_kit/xmpp/templates/config/pre-daemonize/xmpp.rb +6 -0
- data/lib/generators/daemon_kit/xmpp/templates/config/xmpp.yml +29 -0
- data/lib/generators/daemon_kit/xmpp/templates/libexec/%app_name%-daemon.rb +27 -0
- data/lib/generators/daemon_kit/xmpp/xmpp_generator.rb +24 -0
- data/script/console +10 -0
- data/script/destroy +14 -0
- data/script/generate +14 -0
- data/script/txt2html +71 -0
- data/spec/abstract_logger_spec.rb +126 -0
- data/spec/argument_spec.rb +70 -0
- data/spec/config_spec.rb +83 -0
- data/spec/configurable_spec.rb +56 -0
- data/spec/daemon_kit_spec.rb +7 -0
- data/spec/error_handlers_spec.rb +23 -0
- data/spec/fixtures/env.yml +15 -0
- data/spec/fixtures/noenv.yml +4 -0
- data/spec/initializer_spec.rb +26 -0
- data/spec/spec.opts +1 -0
- data/spec/spec_helper.rb +27 -0
- data/tasks/cucumber.rake +13 -0
- data/tasks/rspec.rake +20 -0
- data/tasks/tests.rake +6 -0
- data/templates/god/god.erb +69 -0
- data/templates/monit/monit.erb +14 -0
- data/test/test_amqp_generator.rb +48 -0
- data/test/test_cron_generator.rb +45 -0
- data/test/test_daemon-kit_generator.rb +84 -0
- data/test/test_daemon_kit_config.rb +28 -0
- data/test/test_deploy_capistrano_generator.rb +48 -0
- data/test/test_generator_helper.rb +29 -0
- data/test/test_helper.rb +7 -0
- data/test/test_nanite_agent_generator.rb +49 -0
- data/test/test_ruote_generator.rb +51 -0
- data/test/test_test_unit_generator.rb +46 -0
- metadata +302 -0
@@ -0,0 +1,180 @@
|
|
1
|
+
class Thor
|
2
|
+
module Invocation
|
3
|
+
def self.included(base) #:nodoc:
|
4
|
+
base.extend ClassMethods
|
5
|
+
end
|
6
|
+
|
7
|
+
module ClassMethods
|
8
|
+
# This method is responsible for receiving a name and find the proper
|
9
|
+
# class and task for it. The key is an optional parameter which is
|
10
|
+
# available only in class methods invocations (i.e. in Thor::Group).
|
11
|
+
def prepare_for_invocation(key, name) #:nodoc:
|
12
|
+
case name
|
13
|
+
when Symbol, String
|
14
|
+
Thor::Util.find_class_and_task_by_namespace(name.to_s, !key)
|
15
|
+
else
|
16
|
+
name
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
# Make initializer aware of invocations and the initialization args.
|
22
|
+
def initialize(args=[], options={}, config={}, &block) #:nodoc:
|
23
|
+
@_invocations = config[:invocations] || Hash.new { |h,k| h[k] = [] }
|
24
|
+
@_initializer = [ args, options, config ]
|
25
|
+
super
|
26
|
+
end
|
27
|
+
|
28
|
+
# Receives a name and invokes it. The name can be a string (either "task" or
|
29
|
+
# "namespace:task"), a Thor::Task, a Class or a Thor instance. If the task
|
30
|
+
# cannot be guessed by name, it can also be supplied as second argument.
|
31
|
+
#
|
32
|
+
# You can also supply the arguments, options and configuration values for
|
33
|
+
# the task to be invoked, if none is given, the same values used to
|
34
|
+
# initialize the invoker are used to initialize the invoked.
|
35
|
+
#
|
36
|
+
# When no name is given, it will invoke the default task of the current class.
|
37
|
+
#
|
38
|
+
# ==== Examples
|
39
|
+
#
|
40
|
+
# class A < Thor
|
41
|
+
# def foo
|
42
|
+
# invoke :bar
|
43
|
+
# invoke "b:hello", ["José"]
|
44
|
+
# end
|
45
|
+
#
|
46
|
+
# def bar
|
47
|
+
# invoke "b:hello", ["José"]
|
48
|
+
# end
|
49
|
+
# end
|
50
|
+
#
|
51
|
+
# class B < Thor
|
52
|
+
# def hello(name)
|
53
|
+
# puts "hello #{name}"
|
54
|
+
# end
|
55
|
+
# end
|
56
|
+
#
|
57
|
+
# You can notice that the method "foo" above invokes two tasks: "bar",
|
58
|
+
# which belongs to the same class and "hello" which belongs to the class B.
|
59
|
+
#
|
60
|
+
# By using an invocation system you ensure that a task is invoked only once.
|
61
|
+
# In the example above, invoking "foo" will invoke "b:hello" just once, even
|
62
|
+
# if it's invoked later by "bar" method.
|
63
|
+
#
|
64
|
+
# When class A invokes class B, all arguments used on A initialization are
|
65
|
+
# supplied to B. This allows lazy parse of options. Let's suppose you have
|
66
|
+
# some rspec tasks:
|
67
|
+
#
|
68
|
+
# class Rspec < Thor::Group
|
69
|
+
# class_option :mock_framework, :type => :string, :default => :rr
|
70
|
+
#
|
71
|
+
# def invoke_mock_framework
|
72
|
+
# invoke "rspec:#{options[:mock_framework]}"
|
73
|
+
# end
|
74
|
+
# end
|
75
|
+
#
|
76
|
+
# As you noticed, it invokes the given mock framework, which might have its
|
77
|
+
# own options:
|
78
|
+
#
|
79
|
+
# class Rspec::RR < Thor::Group
|
80
|
+
# class_option :style, :type => :string, :default => :mock
|
81
|
+
# end
|
82
|
+
#
|
83
|
+
# Since it's not rspec concern to parse mock framework options, when RR
|
84
|
+
# is invoked all options are parsed again, so RR can extract only the options
|
85
|
+
# that it's going to use.
|
86
|
+
#
|
87
|
+
# If you want Rspec::RR to be initialized with its own set of options, you
|
88
|
+
# have to do that explicitely:
|
89
|
+
#
|
90
|
+
# invoke "rspec:rr", [], :style => :foo
|
91
|
+
#
|
92
|
+
# Besides giving an instance, you can also give a class to invoke:
|
93
|
+
#
|
94
|
+
# invoke Rspec::RR, [], :style => :foo
|
95
|
+
#
|
96
|
+
def invoke(name=nil, *args)
|
97
|
+
args.unshift(nil) if Array === args.first || NilClass === args.first
|
98
|
+
task, args, opts, config = args
|
99
|
+
|
100
|
+
object, task = _prepare_for_invocation(name, task)
|
101
|
+
klass, instance = _initialize_klass_with_initializer(object, args, opts, config)
|
102
|
+
|
103
|
+
method_args = []
|
104
|
+
current = @_invocations[klass]
|
105
|
+
|
106
|
+
iterator = proc do |_, task|
|
107
|
+
unless current.include?(task.name)
|
108
|
+
current << task.name
|
109
|
+
task.run(instance, method_args)
|
110
|
+
end
|
111
|
+
end
|
112
|
+
|
113
|
+
if task
|
114
|
+
args ||= []
|
115
|
+
method_args = args[Range.new(klass.arguments.size, -1)] || []
|
116
|
+
iterator.call(nil, task)
|
117
|
+
else
|
118
|
+
klass.all_tasks.map(&iterator)
|
119
|
+
end
|
120
|
+
end
|
121
|
+
|
122
|
+
# Invokes using shell padding.
|
123
|
+
def invoke_with_padding(*args)
|
124
|
+
with_padding { invoke(*args) }
|
125
|
+
end
|
126
|
+
|
127
|
+
protected
|
128
|
+
|
129
|
+
# Configuration values that are shared between invocations.
|
130
|
+
def _shared_configuration #:nodoc:
|
131
|
+
{ :invocations => @_invocations }
|
132
|
+
end
|
133
|
+
|
134
|
+
# This method can receive several different types of arguments and it's then
|
135
|
+
# responsible to normalize them by returning the object where the task should
|
136
|
+
# be invoked and a Thor::Task object.
|
137
|
+
def _prepare_for_invocation(name, sent_task=nil) #:nodoc:
|
138
|
+
if name.is_a?(Thor::Task)
|
139
|
+
task = name
|
140
|
+
elsif task = self.class.all_tasks[name.to_s]
|
141
|
+
object = self
|
142
|
+
else
|
143
|
+
object, task = self.class.prepare_for_invocation(nil, name)
|
144
|
+
task ||= sent_task
|
145
|
+
end
|
146
|
+
|
147
|
+
# If the object was not set, use self and use the name as task.
|
148
|
+
object, task = self, name unless object
|
149
|
+
return object, _validate_task(object, task)
|
150
|
+
end
|
151
|
+
|
152
|
+
# Check if the object given is a Thor class object and get a task object
|
153
|
+
# for it.
|
154
|
+
def _validate_task(object, task) #:nodoc:
|
155
|
+
klass = object.is_a?(Class) ? object : object.class
|
156
|
+
raise "Expected Thor class, got #{klass}" unless klass <= Thor::Base
|
157
|
+
|
158
|
+
task ||= klass.default_task if klass.respond_to?(:default_task)
|
159
|
+
task = klass.all_tasks[task.to_s] || Thor::Task::Dynamic.new(task) if task && !task.is_a?(Thor::Task)
|
160
|
+
task
|
161
|
+
end
|
162
|
+
|
163
|
+
# Initialize klass using values stored in the @_initializer.
|
164
|
+
def _initialize_klass_with_initializer(object, args, opts, config) #:nodoc:
|
165
|
+
if object.is_a?(Class)
|
166
|
+
klass = object
|
167
|
+
|
168
|
+
stored_args, stored_opts, stored_config = @_initializer
|
169
|
+
args ||= stored_args.dup
|
170
|
+
opts ||= stored_opts.dup
|
171
|
+
|
172
|
+
config ||= {}
|
173
|
+
config = stored_config.merge(_shared_configuration).merge!(config)
|
174
|
+
[ klass, klass.new(args, opts, config) ]
|
175
|
+
else
|
176
|
+
[ object.class, object ]
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
@@ -0,0 +1,67 @@
|
|
1
|
+
class Thor
|
2
|
+
class Argument #:nodoc:
|
3
|
+
VALID_TYPES = [ :numeric, :hash, :array, :string ]
|
4
|
+
|
5
|
+
attr_reader :name, :description, :required, :type, :default, :banner
|
6
|
+
alias :human_name :name
|
7
|
+
|
8
|
+
def initialize(name, description=nil, required=true, type=:string, default=nil, banner=nil)
|
9
|
+
class_name = self.class.name.split("::").last
|
10
|
+
|
11
|
+
raise ArgumentError, "#{class_name} name can't be nil." if name.nil?
|
12
|
+
raise ArgumentError, "Type :#{type} is not valid for #{class_name.downcase}s." if type && !valid_type?(type)
|
13
|
+
|
14
|
+
@name = name.to_s
|
15
|
+
@description = description
|
16
|
+
@required = required || false
|
17
|
+
@type = (type || :string).to_sym
|
18
|
+
@default = default
|
19
|
+
@banner = banner || default_banner
|
20
|
+
|
21
|
+
validate! # Trigger specific validations
|
22
|
+
end
|
23
|
+
|
24
|
+
def usage
|
25
|
+
required? ? banner : "[#{banner}]"
|
26
|
+
end
|
27
|
+
|
28
|
+
def required?
|
29
|
+
required
|
30
|
+
end
|
31
|
+
|
32
|
+
def show_default?
|
33
|
+
case default
|
34
|
+
when Array, String, Hash
|
35
|
+
!default.empty?
|
36
|
+
else
|
37
|
+
default
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
protected
|
42
|
+
|
43
|
+
def validate!
|
44
|
+
raise ArgumentError, "An argument cannot be required and have default value." if required? && !default.nil?
|
45
|
+
end
|
46
|
+
|
47
|
+
def valid_type?(type)
|
48
|
+
VALID_TYPES.include?(type.to_sym)
|
49
|
+
end
|
50
|
+
|
51
|
+
def default_banner
|
52
|
+
case type
|
53
|
+
when :boolean
|
54
|
+
nil
|
55
|
+
when :string, :default
|
56
|
+
human_name.upcase
|
57
|
+
when :numeric
|
58
|
+
"N"
|
59
|
+
when :hash
|
60
|
+
"key:value"
|
61
|
+
when :array
|
62
|
+
"one two three"
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
end
|
67
|
+
end
|
@@ -0,0 +1,150 @@
|
|
1
|
+
class Thor
|
2
|
+
class Arguments #:nodoc:
|
3
|
+
NUMERIC = /(\d*\.\d+|\d+)/
|
4
|
+
|
5
|
+
# Receives an array of args and returns two arrays, one with arguments
|
6
|
+
# and one with switches.
|
7
|
+
#
|
8
|
+
def self.split(args)
|
9
|
+
arguments = []
|
10
|
+
|
11
|
+
args.each do |item|
|
12
|
+
break if item =~ /^-/
|
13
|
+
arguments << item
|
14
|
+
end
|
15
|
+
|
16
|
+
return arguments, args[Range.new(arguments.size, -1)]
|
17
|
+
end
|
18
|
+
|
19
|
+
def self.parse(*args)
|
20
|
+
to_parse = args.pop
|
21
|
+
new(*args).parse(to_parse)
|
22
|
+
end
|
23
|
+
|
24
|
+
# Takes an array of Thor::Argument objects.
|
25
|
+
#
|
26
|
+
def initialize(arguments=[])
|
27
|
+
@assigns, @non_assigned_required = {}, []
|
28
|
+
@switches = arguments
|
29
|
+
|
30
|
+
arguments.each do |argument|
|
31
|
+
if argument.default
|
32
|
+
@assigns[argument.human_name] = argument.default
|
33
|
+
elsif argument.required?
|
34
|
+
@non_assigned_required << argument
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
def parse(args)
|
40
|
+
@pile = args.dup
|
41
|
+
|
42
|
+
@switches.each do |argument|
|
43
|
+
break unless peek
|
44
|
+
@non_assigned_required.delete(argument)
|
45
|
+
@assigns[argument.human_name] = send(:"parse_#{argument.type}", argument.human_name)
|
46
|
+
end
|
47
|
+
|
48
|
+
check_requirement!
|
49
|
+
@assigns
|
50
|
+
end
|
51
|
+
|
52
|
+
private
|
53
|
+
|
54
|
+
def last?
|
55
|
+
@pile.empty?
|
56
|
+
end
|
57
|
+
|
58
|
+
def peek
|
59
|
+
@pile.first
|
60
|
+
end
|
61
|
+
|
62
|
+
def shift
|
63
|
+
@pile.shift
|
64
|
+
end
|
65
|
+
|
66
|
+
def unshift(arg)
|
67
|
+
unless arg.kind_of?(Array)
|
68
|
+
@pile.unshift(arg)
|
69
|
+
else
|
70
|
+
@pile = arg + @pile
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
def current_is_value?
|
75
|
+
peek && peek.to_s !~ /^-/
|
76
|
+
end
|
77
|
+
|
78
|
+
# Runs through the argument array getting strings that contains ":" and
|
79
|
+
# mark it as a hash:
|
80
|
+
#
|
81
|
+
# [ "name:string", "age:integer" ]
|
82
|
+
#
|
83
|
+
# Becomes:
|
84
|
+
#
|
85
|
+
# { "name" => "string", "age" => "integer" }
|
86
|
+
#
|
87
|
+
def parse_hash(name)
|
88
|
+
return shift if peek.is_a?(Hash)
|
89
|
+
hash = {}
|
90
|
+
|
91
|
+
while current_is_value? && peek.include?(?:)
|
92
|
+
key, value = shift.split(':')
|
93
|
+
hash[key] = value
|
94
|
+
end
|
95
|
+
hash
|
96
|
+
end
|
97
|
+
|
98
|
+
# Runs through the argument array getting all strings until no string is
|
99
|
+
# found or a switch is found.
|
100
|
+
#
|
101
|
+
# ["a", "b", "c"]
|
102
|
+
#
|
103
|
+
# And returns it as an array:
|
104
|
+
#
|
105
|
+
# ["a", "b", "c"]
|
106
|
+
#
|
107
|
+
def parse_array(name)
|
108
|
+
return shift if peek.is_a?(Array)
|
109
|
+
array = []
|
110
|
+
|
111
|
+
while current_is_value?
|
112
|
+
array << shift
|
113
|
+
end
|
114
|
+
array
|
115
|
+
end
|
116
|
+
|
117
|
+
# Check if the peel is numeric ofrmat and return a Float or Integer.
|
118
|
+
# Otherwise raises an error.
|
119
|
+
#
|
120
|
+
def parse_numeric(name)
|
121
|
+
return shift if peek.is_a?(Numeric)
|
122
|
+
|
123
|
+
unless peek =~ NUMERIC && $& == peek
|
124
|
+
raise MalformattedArgumentError, "Expected numeric value for '#{name}'; got #{peek.inspect}"
|
125
|
+
end
|
126
|
+
|
127
|
+
$&.index('.') ? shift.to_f : shift.to_i
|
128
|
+
end
|
129
|
+
|
130
|
+
# Parse string, i.e., just return the current value in the pile.
|
131
|
+
#
|
132
|
+
def parse_string(name)
|
133
|
+
shift
|
134
|
+
end
|
135
|
+
|
136
|
+
# Raises an error if @non_assigned_required array is not empty.
|
137
|
+
#
|
138
|
+
def check_requirement!
|
139
|
+
unless @non_assigned_required.empty?
|
140
|
+
names = @non_assigned_required.map do |o|
|
141
|
+
o.respond_to?(:switch_name) ? o.switch_name : o.human_name
|
142
|
+
end.join("', '")
|
143
|
+
|
144
|
+
class_name = self.class.name.split('::').last.downcase
|
145
|
+
raise RequiredArgumentMissingError, "No value provided for required #{class_name} '#{names}'"
|
146
|
+
end
|
147
|
+
end
|
148
|
+
|
149
|
+
end
|
150
|
+
end
|
@@ -0,0 +1,128 @@
|
|
1
|
+
class Thor
|
2
|
+
class Option < Argument #:nodoc:
|
3
|
+
attr_reader :aliases, :group
|
4
|
+
|
5
|
+
VALID_TYPES = [:boolean, :numeric, :hash, :array, :string]
|
6
|
+
|
7
|
+
def initialize(name, description=nil, required=nil, type=nil, default=nil, banner=nil, group=nil, aliases=nil)
|
8
|
+
super(name, description, required, type, default, banner)
|
9
|
+
@aliases = [*aliases].compact
|
10
|
+
@group = group.to_s.capitalize if group
|
11
|
+
end
|
12
|
+
|
13
|
+
# This parse quick options given as method_options. It makes several
|
14
|
+
# assumptions, but you can be more specific using the option method.
|
15
|
+
#
|
16
|
+
# parse :foo => "bar"
|
17
|
+
# #=> Option foo with default value bar
|
18
|
+
#
|
19
|
+
# parse [:foo, :baz] => "bar"
|
20
|
+
# #=> Option foo with default value bar and alias :baz
|
21
|
+
#
|
22
|
+
# parse :foo => :required
|
23
|
+
# #=> Required option foo without default value
|
24
|
+
#
|
25
|
+
# parse :foo => 2
|
26
|
+
# #=> Option foo with default value 2 and type numeric
|
27
|
+
#
|
28
|
+
# parse :foo => :numeric
|
29
|
+
# #=> Option foo without default value and type numeric
|
30
|
+
#
|
31
|
+
# parse :foo => true
|
32
|
+
# #=> Option foo with default value true and type boolean
|
33
|
+
#
|
34
|
+
# The valid types are :boolean, :numeric, :hash, :array and :string. If none
|
35
|
+
# is given a default type is assumed. This default type accepts arguments as
|
36
|
+
# string (--foo=value) or booleans (just --foo).
|
37
|
+
#
|
38
|
+
# By default all options are optional, unless :required is given.
|
39
|
+
#
|
40
|
+
def self.parse(key, value)
|
41
|
+
if key.is_a?(Array)
|
42
|
+
name, *aliases = key
|
43
|
+
else
|
44
|
+
name, aliases = key, []
|
45
|
+
end
|
46
|
+
|
47
|
+
name = name.to_s
|
48
|
+
default = value
|
49
|
+
|
50
|
+
type = case value
|
51
|
+
when Symbol
|
52
|
+
default = nil
|
53
|
+
|
54
|
+
if VALID_TYPES.include?(value)
|
55
|
+
value
|
56
|
+
elsif required = (value == :required)
|
57
|
+
:string
|
58
|
+
end
|
59
|
+
when TrueClass, FalseClass
|
60
|
+
:boolean
|
61
|
+
when Numeric
|
62
|
+
:numeric
|
63
|
+
when Hash, Array, String
|
64
|
+
value.class.name.downcase.to_sym
|
65
|
+
end
|
66
|
+
|
67
|
+
self.new(name.to_s, nil, required, type, default, nil, nil, aliases)
|
68
|
+
end
|
69
|
+
|
70
|
+
def switch_name
|
71
|
+
@switch_name ||= dasherized? ? name : dasherize(name)
|
72
|
+
end
|
73
|
+
|
74
|
+
def human_name
|
75
|
+
@human_name ||= dasherized? ? undasherize(name) : name
|
76
|
+
end
|
77
|
+
|
78
|
+
def usage(padding=0)
|
79
|
+
sample = if banner && !banner.to_s.empty?
|
80
|
+
"#{switch_name}=#{banner}"
|
81
|
+
else
|
82
|
+
switch_name
|
83
|
+
end
|
84
|
+
|
85
|
+
sample = "[#{sample}]" unless required?
|
86
|
+
|
87
|
+
if aliases.empty?
|
88
|
+
(" " * padding) << sample
|
89
|
+
else
|
90
|
+
"#{aliases.join(', ')}, #{sample}"
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
94
|
+
# Allow some type predicates as: boolean?, string? and etc.
|
95
|
+
#
|
96
|
+
def method_missing(method, *args, &block)
|
97
|
+
given = method.to_s.sub(/\?$/, '').to_sym
|
98
|
+
if valid_type?(given)
|
99
|
+
self.type == given
|
100
|
+
else
|
101
|
+
super
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
protected
|
106
|
+
|
107
|
+
def validate!
|
108
|
+
raise ArgumentError, "An option cannot be boolean and required." if boolean? && required?
|
109
|
+
end
|
110
|
+
|
111
|
+
def valid_type?(type)
|
112
|
+
VALID_TYPES.include?(type.to_sym)
|
113
|
+
end
|
114
|
+
|
115
|
+
def dasherized?
|
116
|
+
name.index('-') == 0
|
117
|
+
end
|
118
|
+
|
119
|
+
def undasherize(str)
|
120
|
+
str.sub(/^-{1,2}/, '')
|
121
|
+
end
|
122
|
+
|
123
|
+
def dasherize(str)
|
124
|
+
(str.length > 1 ? "--" : "-") + str.gsub('_', '-')
|
125
|
+
end
|
126
|
+
|
127
|
+
end
|
128
|
+
end
|