honeybadger 5.0.2 → 5.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +713 -701
  3. data/LICENSE +19 -19
  4. data/README.md +57 -57
  5. data/TROUBLESHOOTING.md +3 -3
  6. data/bin/honeybadger +5 -5
  7. data/lib/honeybadger/agent.rb +488 -488
  8. data/lib/honeybadger/backend/base.rb +116 -116
  9. data/lib/honeybadger/backend/debug.rb +22 -22
  10. data/lib/honeybadger/backend/null.rb +29 -29
  11. data/lib/honeybadger/backend/server.rb +62 -62
  12. data/lib/honeybadger/backend/test.rb +46 -46
  13. data/lib/honeybadger/backend.rb +27 -27
  14. data/lib/honeybadger/backtrace.rb +181 -181
  15. data/lib/honeybadger/breadcrumbs/active_support.rb +119 -119
  16. data/lib/honeybadger/breadcrumbs/breadcrumb.rb +53 -53
  17. data/lib/honeybadger/breadcrumbs/collector.rb +82 -82
  18. data/lib/honeybadger/breadcrumbs/logging.rb +51 -51
  19. data/lib/honeybadger/breadcrumbs/ring_buffer.rb +44 -44
  20. data/lib/honeybadger/breadcrumbs.rb +8 -8
  21. data/lib/honeybadger/cli/deploy.rb +43 -43
  22. data/lib/honeybadger/cli/exec.rb +143 -143
  23. data/lib/honeybadger/cli/helpers.rb +28 -28
  24. data/lib/honeybadger/cli/heroku.rb +129 -129
  25. data/lib/honeybadger/cli/install.rb +101 -101
  26. data/lib/honeybadger/cli/main.rb +237 -237
  27. data/lib/honeybadger/cli/notify.rb +67 -67
  28. data/lib/honeybadger/cli/test.rb +267 -267
  29. data/lib/honeybadger/cli.rb +14 -14
  30. data/lib/honeybadger/config/defaults.rb +336 -333
  31. data/lib/honeybadger/config/env.rb +42 -42
  32. data/lib/honeybadger/config/ruby.rb +146 -146
  33. data/lib/honeybadger/config/yaml.rb +76 -76
  34. data/lib/honeybadger/config.rb +413 -413
  35. data/lib/honeybadger/const.rb +20 -20
  36. data/lib/honeybadger/context_manager.rb +55 -55
  37. data/lib/honeybadger/conversions.rb +16 -16
  38. data/lib/honeybadger/init/rails.rb +38 -38
  39. data/lib/honeybadger/init/rake.rb +66 -66
  40. data/lib/honeybadger/init/ruby.rb +11 -11
  41. data/lib/honeybadger/init/sinatra.rb +51 -51
  42. data/lib/honeybadger/logging.rb +177 -177
  43. data/lib/honeybadger/notice.rb +579 -568
  44. data/lib/honeybadger/plugin.rb +210 -210
  45. data/lib/honeybadger/plugins/breadcrumbs.rb +111 -111
  46. data/lib/honeybadger/plugins/delayed_job/plugin.rb +56 -56
  47. data/lib/honeybadger/plugins/delayed_job.rb +22 -22
  48. data/lib/honeybadger/plugins/faktory.rb +52 -52
  49. data/lib/honeybadger/plugins/lambda.rb +71 -71
  50. data/lib/honeybadger/plugins/local_variables.rb +44 -44
  51. data/lib/honeybadger/plugins/passenger.rb +23 -23
  52. data/lib/honeybadger/plugins/rails.rb +72 -63
  53. data/lib/honeybadger/plugins/resque.rb +72 -72
  54. data/lib/honeybadger/plugins/shoryuken.rb +52 -52
  55. data/lib/honeybadger/plugins/sidekiq.rb +71 -62
  56. data/lib/honeybadger/plugins/sucker_punch.rb +18 -18
  57. data/lib/honeybadger/plugins/thor.rb +32 -32
  58. data/lib/honeybadger/plugins/warden.rb +19 -19
  59. data/lib/honeybadger/rack/error_notifier.rb +92 -92
  60. data/lib/honeybadger/rack/user_feedback.rb +88 -88
  61. data/lib/honeybadger/rack/user_informer.rb +45 -45
  62. data/lib/honeybadger/ruby.rb +2 -2
  63. data/lib/honeybadger/singleton.rb +103 -103
  64. data/lib/honeybadger/tasks.rb +22 -22
  65. data/lib/honeybadger/templates/feedback_form.erb +84 -84
  66. data/lib/honeybadger/util/http.rb +92 -92
  67. data/lib/honeybadger/util/lambda.rb +32 -32
  68. data/lib/honeybadger/util/request_hash.rb +73 -73
  69. data/lib/honeybadger/util/request_payload.rb +41 -41
  70. data/lib/honeybadger/util/revision.rb +39 -39
  71. data/lib/honeybadger/util/sanitizer.rb +214 -214
  72. data/lib/honeybadger/util/sql.rb +34 -34
  73. data/lib/honeybadger/util/stats.rb +50 -50
  74. data/lib/honeybadger/version.rb +4 -4
  75. data/lib/honeybadger/worker.rb +253 -253
  76. data/lib/honeybadger.rb +11 -11
  77. data/resources/ca-bundle.crt +3376 -3376
  78. data/vendor/capistrano-honeybadger/lib/capistrano/honeybadger.rb +5 -5
  79. data/vendor/capistrano-honeybadger/lib/capistrano/tasks/deploy.cap +89 -89
  80. data/vendor/capistrano-honeybadger/lib/honeybadger/capistrano/legacy.rb +47 -47
  81. data/vendor/capistrano-honeybadger/lib/honeybadger/capistrano.rb +2 -2
  82. data/vendor/cli/inifile.rb +628 -628
  83. data/vendor/cli/thor/actions/create_file.rb +103 -103
  84. data/vendor/cli/thor/actions/create_link.rb +59 -59
  85. data/vendor/cli/thor/actions/directory.rb +118 -118
  86. data/vendor/cli/thor/actions/empty_directory.rb +135 -135
  87. data/vendor/cli/thor/actions/file_manipulation.rb +316 -316
  88. data/vendor/cli/thor/actions/inject_into_file.rb +107 -107
  89. data/vendor/cli/thor/actions.rb +319 -319
  90. data/vendor/cli/thor/base.rb +656 -656
  91. data/vendor/cli/thor/command.rb +133 -133
  92. data/vendor/cli/thor/core_ext/hash_with_indifferent_access.rb +77 -77
  93. data/vendor/cli/thor/core_ext/io_binary_read.rb +10 -10
  94. data/vendor/cli/thor/core_ext/ordered_hash.rb +98 -98
  95. data/vendor/cli/thor/error.rb +32 -32
  96. data/vendor/cli/thor/group.rb +281 -281
  97. data/vendor/cli/thor/invocation.rb +178 -178
  98. data/vendor/cli/thor/line_editor/basic.rb +35 -35
  99. data/vendor/cli/thor/line_editor/readline.rb +88 -88
  100. data/vendor/cli/thor/line_editor.rb +17 -17
  101. data/vendor/cli/thor/parser/argument.rb +73 -73
  102. data/vendor/cli/thor/parser/arguments.rb +175 -175
  103. data/vendor/cli/thor/parser/option.rb +125 -125
  104. data/vendor/cli/thor/parser/options.rb +218 -218
  105. data/vendor/cli/thor/parser.rb +4 -4
  106. data/vendor/cli/thor/rake_compat.rb +71 -71
  107. data/vendor/cli/thor/runner.rb +322 -322
  108. data/vendor/cli/thor/shell/basic.rb +421 -421
  109. data/vendor/cli/thor/shell/color.rb +149 -149
  110. data/vendor/cli/thor/shell/html.rb +126 -126
  111. data/vendor/cli/thor/shell.rb +81 -81
  112. data/vendor/cli/thor/util.rb +267 -267
  113. data/vendor/cli/thor/version.rb +3 -3
  114. data/vendor/cli/thor.rb +484 -484
  115. metadata +10 -5
@@ -1,32 +1,32 @@
1
- class Thor
2
- # Thor::Error is raised when it's caused by wrong usage of thor classes. Those
3
- # errors have their backtrace suppressed and are nicely shown to the user.
4
- #
5
- # Errors that are caused by the developer, like declaring a method which
6
- # overwrites a thor keyword, it SHOULD NOT raise a Thor::Error. This way, we
7
- # ensure that developer errors are shown with full backtrace.
8
- class Error < StandardError
9
- end
10
-
11
- # Raised when a command was not found.
12
- class UndefinedCommandError < Error
13
- end
14
- UndefinedTaskError = UndefinedCommandError # rubocop:disable ConstantName
15
-
16
- class AmbiguousCommandError < Error
17
- end
18
- AmbiguousTaskError = AmbiguousCommandError # rubocop:disable ConstantName
19
-
20
- # Raised when a command was found, but not invoked properly.
21
- class InvocationError < Error
22
- end
23
-
24
- class UnknownArgumentError < Error
25
- end
26
-
27
- class RequiredArgumentMissingError < InvocationError
28
- end
29
-
30
- class MalformattedArgumentError < InvocationError
31
- end
32
- end
1
+ class Thor
2
+ # Thor::Error is raised when it's caused by wrong usage of thor classes. Those
3
+ # errors have their backtrace suppressed and are nicely shown to the user.
4
+ #
5
+ # Errors that are caused by the developer, like declaring a method which
6
+ # overwrites a thor keyword, it SHOULD NOT raise a Thor::Error. This way, we
7
+ # ensure that developer errors are shown with full backtrace.
8
+ class Error < StandardError
9
+ end
10
+
11
+ # Raised when a command was not found.
12
+ class UndefinedCommandError < Error
13
+ end
14
+ UndefinedTaskError = UndefinedCommandError # rubocop:disable ConstantName
15
+
16
+ class AmbiguousCommandError < Error
17
+ end
18
+ AmbiguousTaskError = AmbiguousCommandError # rubocop:disable ConstantName
19
+
20
+ # Raised when a command was found, but not invoked properly.
21
+ class InvocationError < Error
22
+ end
23
+
24
+ class UnknownArgumentError < Error
25
+ end
26
+
27
+ class RequiredArgumentMissingError < InvocationError
28
+ end
29
+
30
+ class MalformattedArgumentError < InvocationError
31
+ end
32
+ end
@@ -1,281 +1,281 @@
1
- require "thor/base"
2
-
3
- # Thor has a special class called Thor::Group. The main difference to Thor class
4
- # is that it invokes all commands at once. It also include some methods that allows
5
- # invocations to be done at the class method, which are not available to Thor
6
- # commands.
7
- class Thor::Group # rubocop:disable ClassLength
8
- class << self
9
- # The description for this Thor::Group. If none is provided, but a source root
10
- # exists, tries to find the USAGE one folder above it, otherwise searches
11
- # in the superclass.
12
- #
13
- # ==== Parameters
14
- # description<String>:: The description for this Thor::Group.
15
- #
16
- def desc(description = nil)
17
- if description
18
- @desc = description
19
- else
20
- @desc ||= from_superclass(:desc, nil)
21
- end
22
- end
23
-
24
- # Prints help information.
25
- #
26
- # ==== Options
27
- # short:: When true, shows only usage.
28
- #
29
- def help(shell)
30
- shell.say "Usage:"
31
- shell.say " #{banner}\n"
32
- shell.say
33
- class_options_help(shell)
34
- shell.say desc if desc
35
- end
36
-
37
- # Stores invocations for this class merging with superclass values.
38
- #
39
- def invocations #:nodoc:
40
- @invocations ||= from_superclass(:invocations, {})
41
- end
42
-
43
- # Stores invocation blocks used on invoke_from_option.
44
- #
45
- def invocation_blocks #:nodoc:
46
- @invocation_blocks ||= from_superclass(:invocation_blocks, {})
47
- end
48
-
49
- # Invoke the given namespace or class given. It adds an instance
50
- # method that will invoke the klass and command. You can give a block to
51
- # configure how it will be invoked.
52
- #
53
- # The namespace/class given will have its options showed on the help
54
- # usage. Check invoke_from_option for more information.
55
- #
56
- def invoke(*names, &block) # rubocop:disable MethodLength
57
- options = names.last.is_a?(Hash) ? names.pop : {}
58
- verbose = options.fetch(:verbose, true)
59
-
60
- names.each do |name|
61
- invocations[name] = false
62
- invocation_blocks[name] = block if block_given?
63
-
64
- class_eval <<-METHOD, __FILE__, __LINE__
65
- def _invoke_#{name.to_s.gsub(/\W/, "_")}
66
- klass, command = self.class.prepare_for_invocation(nil, #{name.inspect})
67
-
68
- if klass
69
- say_status :invoke, #{name.inspect}, #{verbose.inspect}
70
- block = self.class.invocation_blocks[#{name.inspect}]
71
- _invoke_for_class_method klass, command, &block
72
- else
73
- say_status :error, %(#{name.inspect} [not found]), :red
74
- end
75
- end
76
- METHOD
77
- end
78
- end
79
-
80
- # Invoke a thor class based on the value supplied by the user to the
81
- # given option named "name". A class option must be created before this
82
- # method is invoked for each name given.
83
- #
84
- # ==== Examples
85
- #
86
- # class GemGenerator < Thor::Group
87
- # class_option :test_framework, :type => :string
88
- # invoke_from_option :test_framework
89
- # end
90
- #
91
- # ==== Boolean options
92
- #
93
- # In some cases, you want to invoke a thor class if some option is true or
94
- # false. This is automatically handled by invoke_from_option. Then the
95
- # option name is used to invoke the generator.
96
- #
97
- # ==== Preparing for invocation
98
- #
99
- # In some cases you want to customize how a specified hook is going to be
100
- # invoked. You can do that by overwriting the class method
101
- # prepare_for_invocation. The class method must necessarily return a klass
102
- # and an optional command.
103
- #
104
- # ==== Custom invocations
105
- #
106
- # You can also supply a block to customize how the option is going to be
107
- # invoked. The block receives two parameters, an instance of the current
108
- # class and the klass to be invoked.
109
- #
110
- def invoke_from_option(*names, &block) # rubocop:disable MethodLength
111
- options = names.last.is_a?(Hash) ? names.pop : {}
112
- verbose = options.fetch(:verbose, :white)
113
-
114
- names.each do |name|
115
- unless class_options.key?(name)
116
- fail ArgumentError, "You have to define the option #{name.inspect} " <<
117
- "before setting invoke_from_option."
118
- end
119
-
120
- invocations[name] = true
121
- invocation_blocks[name] = block if block_given?
122
-
123
- class_eval <<-METHOD, __FILE__, __LINE__
124
- def _invoke_from_option_#{name.to_s.gsub(/\W/, "_")}
125
- return unless options[#{name.inspect}]
126
-
127
- value = options[#{name.inspect}]
128
- value = #{name.inspect} if TrueClass === value
129
- klass, command = self.class.prepare_for_invocation(#{name.inspect}, value)
130
-
131
- if klass
132
- say_status :invoke, value, #{verbose.inspect}
133
- block = self.class.invocation_blocks[#{name.inspect}]
134
- _invoke_for_class_method klass, command, &block
135
- else
136
- say_status :error, %(\#{value} [not found]), :red
137
- end
138
- end
139
- METHOD
140
- end
141
- end
142
-
143
- # Remove a previously added invocation.
144
- #
145
- # ==== Examples
146
- #
147
- # remove_invocation :test_framework
148
- #
149
- def remove_invocation(*names)
150
- names.each do |name|
151
- remove_command(name)
152
- remove_class_option(name)
153
- invocations.delete(name)
154
- invocation_blocks.delete(name)
155
- end
156
- end
157
-
158
- # Overwrite class options help to allow invoked generators options to be
159
- # shown recursively when invoking a generator.
160
- #
161
- def class_options_help(shell, groups = {}) #:nodoc:
162
- get_options_from_invocations(groups, class_options) do |klass|
163
- klass.send(:get_options_from_invocations, groups, class_options)
164
- end
165
- super(shell, groups)
166
- end
167
-
168
- # Get invocations array and merge options from invocations. Those
169
- # options are added to group_options hash. Options that already exists
170
- # in base_options are not added twice.
171
- #
172
- def get_options_from_invocations(group_options, base_options) #:nodoc: # rubocop:disable MethodLength
173
- invocations.each do |name, from_option|
174
- value = if from_option
175
- option = class_options[name]
176
- option.type == :boolean ? name : option.default
177
- else
178
- name
179
- end
180
- next unless value
181
-
182
- klass, _ = prepare_for_invocation(name, value)
183
- next unless klass && klass.respond_to?(:class_options)
184
-
185
- value = value.to_s
186
- human_name = value.respond_to?(:classify) ? value.classify : value
187
-
188
- group_options[human_name] ||= []
189
- group_options[human_name] += klass.class_options.values.select do |class_option|
190
- base_options[class_option.name.to_sym].nil? && class_option.group.nil? &&
191
- !group_options.values.flatten.any? { |i| i.name == class_option.name }
192
- end
193
-
194
- yield klass if block_given?
195
- end
196
- end
197
-
198
- # Returns commands ready to be printed.
199
- def printable_commands(*)
200
- item = []
201
- item << banner
202
- item << (desc ? "# #{desc.gsub(/\s+/m, ' ')}" : "")
203
- [item]
204
- end
205
- alias_method :printable_tasks, :printable_commands
206
-
207
- def handle_argument_error(command, error, args, arity) #:nodoc:
208
- msg = "#{basename} #{command.name} takes #{arity} argument"
209
- msg << "s" if arity > 1
210
- msg << ", but it should not."
211
- fail error, msg
212
- end
213
-
214
- protected
215
-
216
- # The method responsible for dispatching given the args.
217
- def dispatch(command, given_args, given_opts, config) #:nodoc:
218
- if Thor::HELP_MAPPINGS.include?(given_args.first)
219
- help(config[:shell])
220
- return
221
- end
222
-
223
- args, opts = Thor::Options.split(given_args)
224
- opts = given_opts || opts
225
-
226
- instance = new(args, opts, config)
227
- yield instance if block_given?
228
-
229
- if command
230
- instance.invoke_command(all_commands[command])
231
- else
232
- instance.invoke_all
233
- end
234
- end
235
-
236
- # The banner for this class. You can customize it if you are invoking the
237
- # thor class by another ways which is not the Thor::Runner.
238
- def banner
239
- "#{basename} #{self_command.formatted_usage(self, false)}"
240
- end
241
-
242
- # Represents the whole class as a command.
243
- def self_command #:nodoc:
244
- Thor::DynamicCommand.new(namespace, class_options)
245
- end
246
- alias_method :self_task, :self_command
247
-
248
- def baseclass #:nodoc:
249
- Thor::Group
250
- end
251
-
252
- def create_command(meth) #:nodoc:
253
- commands[meth.to_s] = Thor::Command.new(meth, nil, nil, nil, nil)
254
- true
255
- end
256
- alias_method :create_task, :create_command
257
- end
258
-
259
- include Thor::Base
260
-
261
- protected
262
-
263
- # Shortcut to invoke with padding and block handling. Use internally by
264
- # invoke and invoke_from_option class methods.
265
- def _invoke_for_class_method(klass, command = nil, *args, &block) #:nodoc:
266
- with_padding do
267
- if block
268
- case block.arity
269
- when 3
270
- block.call(self, klass, command)
271
- when 2
272
- block.call(self, klass)
273
- when 1
274
- instance_exec(klass, &block)
275
- end
276
- else
277
- invoke klass, command, *args
278
- end
279
- end
280
- end
281
- end
1
+ require "thor/base"
2
+
3
+ # Thor has a special class called Thor::Group. The main difference to Thor class
4
+ # is that it invokes all commands at once. It also include some methods that allows
5
+ # invocations to be done at the class method, which are not available to Thor
6
+ # commands.
7
+ class Thor::Group # rubocop:disable ClassLength
8
+ class << self
9
+ # The description for this Thor::Group. If none is provided, but a source root
10
+ # exists, tries to find the USAGE one folder above it, otherwise searches
11
+ # in the superclass.
12
+ #
13
+ # ==== Parameters
14
+ # description<String>:: The description for this Thor::Group.
15
+ #
16
+ def desc(description = nil)
17
+ if description
18
+ @desc = description
19
+ else
20
+ @desc ||= from_superclass(:desc, nil)
21
+ end
22
+ end
23
+
24
+ # Prints help information.
25
+ #
26
+ # ==== Options
27
+ # short:: When true, shows only usage.
28
+ #
29
+ def help(shell)
30
+ shell.say "Usage:"
31
+ shell.say " #{banner}\n"
32
+ shell.say
33
+ class_options_help(shell)
34
+ shell.say desc if desc
35
+ end
36
+
37
+ # Stores invocations for this class merging with superclass values.
38
+ #
39
+ def invocations #:nodoc:
40
+ @invocations ||= from_superclass(:invocations, {})
41
+ end
42
+
43
+ # Stores invocation blocks used on invoke_from_option.
44
+ #
45
+ def invocation_blocks #:nodoc:
46
+ @invocation_blocks ||= from_superclass(:invocation_blocks, {})
47
+ end
48
+
49
+ # Invoke the given namespace or class given. It adds an instance
50
+ # method that will invoke the klass and command. You can give a block to
51
+ # configure how it will be invoked.
52
+ #
53
+ # The namespace/class given will have its options showed on the help
54
+ # usage. Check invoke_from_option for more information.
55
+ #
56
+ def invoke(*names, &block) # rubocop:disable MethodLength
57
+ options = names.last.is_a?(Hash) ? names.pop : {}
58
+ verbose = options.fetch(:verbose, true)
59
+
60
+ names.each do |name|
61
+ invocations[name] = false
62
+ invocation_blocks[name] = block if block_given?
63
+
64
+ class_eval <<-METHOD, __FILE__, __LINE__
65
+ def _invoke_#{name.to_s.gsub(/\W/, "_")}
66
+ klass, command = self.class.prepare_for_invocation(nil, #{name.inspect})
67
+
68
+ if klass
69
+ say_status :invoke, #{name.inspect}, #{verbose.inspect}
70
+ block = self.class.invocation_blocks[#{name.inspect}]
71
+ _invoke_for_class_method klass, command, &block
72
+ else
73
+ say_status :error, %(#{name.inspect} [not found]), :red
74
+ end
75
+ end
76
+ METHOD
77
+ end
78
+ end
79
+
80
+ # Invoke a thor class based on the value supplied by the user to the
81
+ # given option named "name". A class option must be created before this
82
+ # method is invoked for each name given.
83
+ #
84
+ # ==== Examples
85
+ #
86
+ # class GemGenerator < Thor::Group
87
+ # class_option :test_framework, :type => :string
88
+ # invoke_from_option :test_framework
89
+ # end
90
+ #
91
+ # ==== Boolean options
92
+ #
93
+ # In some cases, you want to invoke a thor class if some option is true or
94
+ # false. This is automatically handled by invoke_from_option. Then the
95
+ # option name is used to invoke the generator.
96
+ #
97
+ # ==== Preparing for invocation
98
+ #
99
+ # In some cases you want to customize how a specified hook is going to be
100
+ # invoked. You can do that by overwriting the class method
101
+ # prepare_for_invocation. The class method must necessarily return a klass
102
+ # and an optional command.
103
+ #
104
+ # ==== Custom invocations
105
+ #
106
+ # You can also supply a block to customize how the option is going to be
107
+ # invoked. The block receives two parameters, an instance of the current
108
+ # class and the klass to be invoked.
109
+ #
110
+ def invoke_from_option(*names, &block) # rubocop:disable MethodLength
111
+ options = names.last.is_a?(Hash) ? names.pop : {}
112
+ verbose = options.fetch(:verbose, :white)
113
+
114
+ names.each do |name|
115
+ unless class_options.key?(name)
116
+ fail ArgumentError, "You have to define the option #{name.inspect} " <<
117
+ "before setting invoke_from_option."
118
+ end
119
+
120
+ invocations[name] = true
121
+ invocation_blocks[name] = block if block_given?
122
+
123
+ class_eval <<-METHOD, __FILE__, __LINE__
124
+ def _invoke_from_option_#{name.to_s.gsub(/\W/, "_")}
125
+ return unless options[#{name.inspect}]
126
+
127
+ value = options[#{name.inspect}]
128
+ value = #{name.inspect} if TrueClass === value
129
+ klass, command = self.class.prepare_for_invocation(#{name.inspect}, value)
130
+
131
+ if klass
132
+ say_status :invoke, value, #{verbose.inspect}
133
+ block = self.class.invocation_blocks[#{name.inspect}]
134
+ _invoke_for_class_method klass, command, &block
135
+ else
136
+ say_status :error, %(\#{value} [not found]), :red
137
+ end
138
+ end
139
+ METHOD
140
+ end
141
+ end
142
+
143
+ # Remove a previously added invocation.
144
+ #
145
+ # ==== Examples
146
+ #
147
+ # remove_invocation :test_framework
148
+ #
149
+ def remove_invocation(*names)
150
+ names.each do |name|
151
+ remove_command(name)
152
+ remove_class_option(name)
153
+ invocations.delete(name)
154
+ invocation_blocks.delete(name)
155
+ end
156
+ end
157
+
158
+ # Overwrite class options help to allow invoked generators options to be
159
+ # shown recursively when invoking a generator.
160
+ #
161
+ def class_options_help(shell, groups = {}) #:nodoc:
162
+ get_options_from_invocations(groups, class_options) do |klass|
163
+ klass.send(:get_options_from_invocations, groups, class_options)
164
+ end
165
+ super(shell, groups)
166
+ end
167
+
168
+ # Get invocations array and merge options from invocations. Those
169
+ # options are added to group_options hash. Options that already exists
170
+ # in base_options are not added twice.
171
+ #
172
+ def get_options_from_invocations(group_options, base_options) #:nodoc: # rubocop:disable MethodLength
173
+ invocations.each do |name, from_option|
174
+ value = if from_option
175
+ option = class_options[name]
176
+ option.type == :boolean ? name : option.default
177
+ else
178
+ name
179
+ end
180
+ next unless value
181
+
182
+ klass, _ = prepare_for_invocation(name, value)
183
+ next unless klass && klass.respond_to?(:class_options)
184
+
185
+ value = value.to_s
186
+ human_name = value.respond_to?(:classify) ? value.classify : value
187
+
188
+ group_options[human_name] ||= []
189
+ group_options[human_name] += klass.class_options.values.select do |class_option|
190
+ base_options[class_option.name.to_sym].nil? && class_option.group.nil? &&
191
+ !group_options.values.flatten.any? { |i| i.name == class_option.name }
192
+ end
193
+
194
+ yield klass if block_given?
195
+ end
196
+ end
197
+
198
+ # Returns commands ready to be printed.
199
+ def printable_commands(*)
200
+ item = []
201
+ item << banner
202
+ item << (desc ? "# #{desc.gsub(/\s+/m, ' ')}" : "")
203
+ [item]
204
+ end
205
+ alias_method :printable_tasks, :printable_commands
206
+
207
+ def handle_argument_error(command, error, args, arity) #:nodoc:
208
+ msg = "#{basename} #{command.name} takes #{arity} argument"
209
+ msg << "s" if arity > 1
210
+ msg << ", but it should not."
211
+ fail error, msg
212
+ end
213
+
214
+ protected
215
+
216
+ # The method responsible for dispatching given the args.
217
+ def dispatch(command, given_args, given_opts, config) #:nodoc:
218
+ if Thor::HELP_MAPPINGS.include?(given_args.first)
219
+ help(config[:shell])
220
+ return
221
+ end
222
+
223
+ args, opts = Thor::Options.split(given_args)
224
+ opts = given_opts || opts
225
+
226
+ instance = new(args, opts, config)
227
+ yield instance if block_given?
228
+
229
+ if command
230
+ instance.invoke_command(all_commands[command])
231
+ else
232
+ instance.invoke_all
233
+ end
234
+ end
235
+
236
+ # The banner for this class. You can customize it if you are invoking the
237
+ # thor class by another ways which is not the Thor::Runner.
238
+ def banner
239
+ "#{basename} #{self_command.formatted_usage(self, false)}"
240
+ end
241
+
242
+ # Represents the whole class as a command.
243
+ def self_command #:nodoc:
244
+ Thor::DynamicCommand.new(namespace, class_options)
245
+ end
246
+ alias_method :self_task, :self_command
247
+
248
+ def baseclass #:nodoc:
249
+ Thor::Group
250
+ end
251
+
252
+ def create_command(meth) #:nodoc:
253
+ commands[meth.to_s] = Thor::Command.new(meth, nil, nil, nil, nil)
254
+ true
255
+ end
256
+ alias_method :create_task, :create_command
257
+ end
258
+
259
+ include Thor::Base
260
+
261
+ protected
262
+
263
+ # Shortcut to invoke with padding and block handling. Use internally by
264
+ # invoke and invoke_from_option class methods.
265
+ def _invoke_for_class_method(klass, command = nil, *args, &block) #:nodoc:
266
+ with_padding do
267
+ if block
268
+ case block.arity
269
+ when 3
270
+ block.call(self, klass, command)
271
+ when 2
272
+ block.call(self, klass)
273
+ when 1
274
+ instance_exec(klass, &block)
275
+ end
276
+ else
277
+ invoke klass, command, *args
278
+ end
279
+ end
280
+ end
281
+ end