carat 1.9.9.pre1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (184) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +16 -0
  3. data/.rspec +3 -0
  4. data/.travis.yml +24 -0
  5. data/CHANGELOG.md +2006 -0
  6. data/CODE_OF_CONDUCT.md +40 -0
  7. data/CONTRIBUTING.md +23 -0
  8. data/DEVELOPMENT.md +119 -0
  9. data/ISSUES.md +96 -0
  10. data/LICENSE.md +23 -0
  11. data/README.md +32 -0
  12. data/Rakefile +308 -0
  13. data/bin/carat +21 -0
  14. data/bin/carat_ruby +56 -0
  15. data/carat.gemspec +32 -0
  16. data/lib/carat.rb +446 -0
  17. data/lib/carat/anonymizable_uri.rb +32 -0
  18. data/lib/carat/capistrano.rb +16 -0
  19. data/lib/carat/cli.rb +407 -0
  20. data/lib/carat/cli/binstubs.rb +38 -0
  21. data/lib/carat/cli/cache.rb +35 -0
  22. data/lib/carat/cli/check.rb +35 -0
  23. data/lib/carat/cli/clean.rb +26 -0
  24. data/lib/carat/cli/common.rb +56 -0
  25. data/lib/carat/cli/config.rb +84 -0
  26. data/lib/carat/cli/console.rb +38 -0
  27. data/lib/carat/cli/exec.rb +44 -0
  28. data/lib/carat/cli/gem.rb +195 -0
  29. data/lib/carat/cli/init.rb +33 -0
  30. data/lib/carat/cli/inject.rb +33 -0
  31. data/lib/carat/cli/install.rb +156 -0
  32. data/lib/carat/cli/open.rb +23 -0
  33. data/lib/carat/cli/outdated.rb +80 -0
  34. data/lib/carat/cli/package.rb +45 -0
  35. data/lib/carat/cli/platform.rb +43 -0
  36. data/lib/carat/cli/show.rb +74 -0
  37. data/lib/carat/cli/update.rb +73 -0
  38. data/lib/carat/cli/viz.rb +27 -0
  39. data/lib/carat/constants.rb +5 -0
  40. data/lib/carat/current_ruby.rb +183 -0
  41. data/lib/carat/definition.rb +628 -0
  42. data/lib/carat/dep_proxy.rb +43 -0
  43. data/lib/carat/dependency.rb +110 -0
  44. data/lib/carat/deployment.rb +59 -0
  45. data/lib/carat/deprecate.rb +15 -0
  46. data/lib/carat/dsl.rb +331 -0
  47. data/lib/carat/endpoint_specification.rb +76 -0
  48. data/lib/carat/env.rb +75 -0
  49. data/lib/carat/environment.rb +42 -0
  50. data/lib/carat/fetcher.rb +423 -0
  51. data/lib/carat/friendly_errors.rb +85 -0
  52. data/lib/carat/gem_helper.rb +180 -0
  53. data/lib/carat/gem_helpers.rb +26 -0
  54. data/lib/carat/gem_installer.rb +9 -0
  55. data/lib/carat/gem_path_manipulation.rb +8 -0
  56. data/lib/carat/gem_tasks.rb +2 -0
  57. data/lib/carat/graph.rb +169 -0
  58. data/lib/carat/index.rb +197 -0
  59. data/lib/carat/injector.rb +64 -0
  60. data/lib/carat/installer.rb +339 -0
  61. data/lib/carat/lazy_specification.rb +83 -0
  62. data/lib/carat/lockfile_parser.rb +167 -0
  63. data/lib/carat/match_platform.rb +13 -0
  64. data/lib/carat/psyched_yaml.rb +26 -0
  65. data/lib/carat/remote_specification.rb +57 -0
  66. data/lib/carat/resolver.rb +334 -0
  67. data/lib/carat/retry.rb +60 -0
  68. data/lib/carat/ruby_dsl.rb +11 -0
  69. data/lib/carat/ruby_version.rb +117 -0
  70. data/lib/carat/rubygems_ext.rb +170 -0
  71. data/lib/carat/rubygems_integration.rb +619 -0
  72. data/lib/carat/runtime.rb +289 -0
  73. data/lib/carat/settings.rb +208 -0
  74. data/lib/carat/setup.rb +24 -0
  75. data/lib/carat/shared_helpers.rb +149 -0
  76. data/lib/carat/similarity_detector.rb +63 -0
  77. data/lib/carat/source.rb +46 -0
  78. data/lib/carat/source/git.rb +294 -0
  79. data/lib/carat/source/git/git_proxy.rb +162 -0
  80. data/lib/carat/source/path.rb +226 -0
  81. data/lib/carat/source/path/installer.rb +43 -0
  82. data/lib/carat/source/rubygems.rb +381 -0
  83. data/lib/carat/source_list.rb +101 -0
  84. data/lib/carat/spec_set.rb +154 -0
  85. data/lib/carat/ssl_certs/.document +1 -0
  86. data/lib/carat/ssl_certs/AddTrustExternalCARoot-2048.pem +25 -0
  87. data/lib/carat/ssl_certs/AddTrustExternalCARoot.pem +32 -0
  88. data/lib/carat/ssl_certs/Class3PublicPrimaryCertificationAuthority.pem +14 -0
  89. data/lib/carat/ssl_certs/DigiCertHighAssuranceEVRootCA.pem +23 -0
  90. data/lib/carat/ssl_certs/EntrustnetSecureServerCertificationAuthority.pem +28 -0
  91. data/lib/carat/ssl_certs/GeoTrustGlobalCA.pem +20 -0
  92. data/lib/carat/ssl_certs/certificate_manager.rb +66 -0
  93. data/lib/carat/ssl_certs/index.rubygems.org/GlobalSignRootCA.pem +21 -0
  94. data/lib/carat/ssl_certs/rubygems.global.ssl.fastly.net/DigiCertHighAssuranceEVRootCA.pem +23 -0
  95. data/lib/carat/ssl_certs/rubygems.org/AddTrustExternalCARoot.pem +25 -0
  96. data/lib/carat/templates/Executable +16 -0
  97. data/lib/carat/templates/Executable.standalone +12 -0
  98. data/lib/carat/templates/Gemfile +4 -0
  99. data/lib/carat/templates/newgem/.travis.yml.tt +3 -0
  100. data/lib/carat/templates/newgem/CODE_OF_CONDUCT.md.tt +13 -0
  101. data/lib/carat/templates/newgem/Gemfile.tt +4 -0
  102. data/lib/carat/templates/newgem/LICENSE.txt.tt +21 -0
  103. data/lib/carat/templates/newgem/README.md.tt +39 -0
  104. data/lib/carat/templates/newgem/Rakefile.tt +25 -0
  105. data/lib/carat/templates/newgem/bin/console.tt +14 -0
  106. data/lib/carat/templates/newgem/bin/setup.tt +7 -0
  107. data/lib/carat/templates/newgem/exe/newgem.tt +3 -0
  108. data/lib/carat/templates/newgem/ext/newgem/extconf.rb.tt +3 -0
  109. data/lib/carat/templates/newgem/ext/newgem/newgem.c.tt +9 -0
  110. data/lib/carat/templates/newgem/ext/newgem/newgem.h.tt +6 -0
  111. data/lib/carat/templates/newgem/gitignore.tt +16 -0
  112. data/lib/carat/templates/newgem/lib/newgem.rb.tt +12 -0
  113. data/lib/carat/templates/newgem/lib/newgem/version.rb.tt +7 -0
  114. data/lib/carat/templates/newgem/newgem.gemspec.tt +43 -0
  115. data/lib/carat/templates/newgem/rspec.tt +2 -0
  116. data/lib/carat/templates/newgem/spec/newgem_spec.rb.tt +11 -0
  117. data/lib/carat/templates/newgem/spec/spec_helper.rb.tt +2 -0
  118. data/lib/carat/templates/newgem/test/minitest_helper.rb.tt +4 -0
  119. data/lib/carat/templates/newgem/test/test_newgem.rb.tt +11 -0
  120. data/lib/carat/ui.rb +7 -0
  121. data/lib/carat/ui/rg_proxy.rb +21 -0
  122. data/lib/carat/ui/shell.rb +103 -0
  123. data/lib/carat/ui/silent.rb +44 -0
  124. data/lib/carat/vendor/molinillo/lib/molinillo.rb +5 -0
  125. data/lib/carat/vendor/molinillo/lib/molinillo/dependency_graph.rb +266 -0
  126. data/lib/carat/vendor/molinillo/lib/molinillo/errors.rb +69 -0
  127. data/lib/carat/vendor/molinillo/lib/molinillo/gem_metadata.rb +3 -0
  128. data/lib/carat/vendor/molinillo/lib/molinillo/modules/specification_provider.rb +90 -0
  129. data/lib/carat/vendor/molinillo/lib/molinillo/modules/ui.rb +63 -0
  130. data/lib/carat/vendor/molinillo/lib/molinillo/resolution.rb +415 -0
  131. data/lib/carat/vendor/molinillo/lib/molinillo/resolver.rb +43 -0
  132. data/lib/carat/vendor/molinillo/lib/molinillo/state.rb +43 -0
  133. data/lib/carat/vendor/net/http/faster.rb +26 -0
  134. data/lib/carat/vendor/net/http/persistent.rb +1230 -0
  135. data/lib/carat/vendor/net/http/persistent/ssl_reuse.rb +128 -0
  136. data/lib/carat/vendor/thor/lib/thor.rb +484 -0
  137. data/lib/carat/vendor/thor/lib/thor/actions.rb +319 -0
  138. data/lib/carat/vendor/thor/lib/thor/actions/create_file.rb +103 -0
  139. data/lib/carat/vendor/thor/lib/thor/actions/create_link.rb +59 -0
  140. data/lib/carat/vendor/thor/lib/thor/actions/directory.rb +118 -0
  141. data/lib/carat/vendor/thor/lib/thor/actions/empty_directory.rb +135 -0
  142. data/lib/carat/vendor/thor/lib/thor/actions/file_manipulation.rb +316 -0
  143. data/lib/carat/vendor/thor/lib/thor/actions/inject_into_file.rb +107 -0
  144. data/lib/carat/vendor/thor/lib/thor/base.rb +656 -0
  145. data/lib/carat/vendor/thor/lib/thor/command.rb +133 -0
  146. data/lib/carat/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb +77 -0
  147. data/lib/carat/vendor/thor/lib/thor/core_ext/io_binary_read.rb +10 -0
  148. data/lib/carat/vendor/thor/lib/thor/core_ext/ordered_hash.rb +98 -0
  149. data/lib/carat/vendor/thor/lib/thor/error.rb +32 -0
  150. data/lib/carat/vendor/thor/lib/thor/group.rb +281 -0
  151. data/lib/carat/vendor/thor/lib/thor/invocation.rb +178 -0
  152. data/lib/carat/vendor/thor/lib/thor/line_editor.rb +17 -0
  153. data/lib/carat/vendor/thor/lib/thor/line_editor/basic.rb +35 -0
  154. data/lib/carat/vendor/thor/lib/thor/line_editor/readline.rb +88 -0
  155. data/lib/carat/vendor/thor/lib/thor/parser.rb +4 -0
  156. data/lib/carat/vendor/thor/lib/thor/parser/argument.rb +73 -0
  157. data/lib/carat/vendor/thor/lib/thor/parser/arguments.rb +175 -0
  158. data/lib/carat/vendor/thor/lib/thor/parser/option.rb +125 -0
  159. data/lib/carat/vendor/thor/lib/thor/parser/options.rb +218 -0
  160. data/lib/carat/vendor/thor/lib/thor/rake_compat.rb +71 -0
  161. data/lib/carat/vendor/thor/lib/thor/runner.rb +322 -0
  162. data/lib/carat/vendor/thor/lib/thor/shell.rb +81 -0
  163. data/lib/carat/vendor/thor/lib/thor/shell/basic.rb +421 -0
  164. data/lib/carat/vendor/thor/lib/thor/shell/color.rb +149 -0
  165. data/lib/carat/vendor/thor/lib/thor/shell/html.rb +126 -0
  166. data/lib/carat/vendor/thor/lib/thor/util.rb +267 -0
  167. data/lib/carat/vendor/thor/lib/thor/version.rb +3 -0
  168. data/lib/carat/vendored_fileutils.rb +9 -0
  169. data/lib/carat/vendored_molinillo.rb +2 -0
  170. data/lib/carat/vendored_persistent.rb +11 -0
  171. data/lib/carat/vendored_thor.rb +3 -0
  172. data/lib/carat/version.rb +6 -0
  173. data/lib/carat/vlad.rb +11 -0
  174. data/lib/carat/worker.rb +73 -0
  175. data/man/carat-config.ronn +178 -0
  176. data/man/carat-exec.ronn +136 -0
  177. data/man/carat-install.ronn +383 -0
  178. data/man/carat-package.ronn +66 -0
  179. data/man/carat-platform.ronn +42 -0
  180. data/man/carat-update.ronn +188 -0
  181. data/man/carat.ronn +98 -0
  182. data/man/gemfile.5.ronn +473 -0
  183. data/man/index.txt +7 -0
  184. metadata +321 -0
@@ -0,0 +1,128 @@
1
+ ##
2
+ # This Net::HTTP subclass adds SSL session reuse and Server Name Indication
3
+ # (SNI) RFC 3546.
4
+ #
5
+ # DO NOT DEPEND UPON THIS CLASS
6
+ #
7
+ # This class is an implementation detail and is subject to change or removal
8
+ # at any time.
9
+
10
+ class Net::HTTP::Persistent::SSLReuse < Net::HTTP
11
+
12
+ @is_proxy_class = false
13
+ @proxy_addr = nil
14
+ @proxy_port = nil
15
+ @proxy_user = nil
16
+ @proxy_pass = nil
17
+
18
+ def initialize address, port = nil # :nodoc:
19
+ super
20
+
21
+ @ssl_session = nil
22
+ end
23
+
24
+ ##
25
+ # From ruby trunk r33086 including http://redmine.ruby-lang.org/issues/5341
26
+
27
+ def connect # :nodoc:
28
+ D "opening connection to #{conn_address()}..."
29
+ s = timeout(@open_timeout) { TCPSocket.open(conn_address(), conn_port()) }
30
+ D "opened"
31
+ if use_ssl?
32
+ ssl_parameters = Hash.new
33
+ iv_list = instance_variables
34
+ SSL_ATTRIBUTES.each do |name|
35
+ ivname = "@#{name}".intern
36
+ if iv_list.include?(ivname) and
37
+ value = instance_variable_get(ivname)
38
+ ssl_parameters[name] = value
39
+ end
40
+ end
41
+ unless @ssl_context then
42
+ @ssl_context = OpenSSL::SSL::SSLContext.new
43
+ @ssl_context.set_params(ssl_parameters)
44
+ end
45
+ s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context)
46
+ s.sync_close = true
47
+ end
48
+ @socket = Net::BufferedIO.new(s)
49
+ @socket.read_timeout = @read_timeout
50
+ @socket.continue_timeout = @continue_timeout if
51
+ @socket.respond_to? :continue_timeout
52
+ @socket.debug_output = @debug_output
53
+ if use_ssl?
54
+ begin
55
+ if proxy?
56
+ @socket.writeline sprintf('CONNECT %s:%s HTTP/%s',
57
+ @address, @port, HTTPVersion)
58
+ @socket.writeline "Host: #{@address}:#{@port}"
59
+ if proxy_user
60
+ credential = ["#{proxy_user}:#{proxy_pass}"].pack('m')
61
+ credential.delete!("\r\n")
62
+ @socket.writeline "Proxy-Authorization: Basic #{credential}"
63
+ end
64
+ @socket.writeline ''
65
+ Net::HTTPResponse.read_new(@socket).value
66
+ end
67
+ s.session = @ssl_session if @ssl_session
68
+ # Server Name Indication (SNI) RFC 3546
69
+ s.hostname = @address if s.respond_to? :hostname=
70
+ timeout(@open_timeout) { s.connect }
71
+ if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
72
+ s.post_connection_check(@address)
73
+ end
74
+ @ssl_session = s.session
75
+ rescue => exception
76
+ D "Conn close because of connect error #{exception}"
77
+ @socket.close if @socket and not @socket.closed?
78
+ raise exception
79
+ end
80
+ end
81
+ on_connect
82
+ end if RUBY_VERSION > '1.9'
83
+
84
+ ##
85
+ # From ruby_1_8_7 branch r29865 including a modified
86
+ # http://redmine.ruby-lang.org/issues/5341
87
+
88
+ def connect # :nodoc:
89
+ D "opening connection to #{conn_address()}..."
90
+ s = timeout(@open_timeout) { TCPSocket.open(conn_address(), conn_port()) }
91
+ D "opened"
92
+ if use_ssl?
93
+ unless @ssl_context.verify_mode
94
+ warn "warning: peer certificate won't be verified in this SSL session"
95
+ @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
96
+ end
97
+ s = OpenSSL::SSL::SSLSocket.new(s, @ssl_context)
98
+ s.sync_close = true
99
+ end
100
+ @socket = Net::BufferedIO.new(s)
101
+ @socket.read_timeout = @read_timeout
102
+ @socket.debug_output = @debug_output
103
+ if use_ssl?
104
+ if proxy?
105
+ @socket.writeline sprintf('CONNECT %s:%s HTTP/%s',
106
+ @address, @port, HTTPVersion)
107
+ @socket.writeline "Host: #{@address}:#{@port}"
108
+ if proxy_user
109
+ credential = ["#{proxy_user}:#{proxy_pass}"].pack('m')
110
+ credential.delete!("\r\n")
111
+ @socket.writeline "Proxy-Authorization: Basic #{credential}"
112
+ end
113
+ @socket.writeline ''
114
+ Net::HTTPResponse.read_new(@socket).value
115
+ end
116
+ s.session = @ssl_session if @ssl_session
117
+ s.connect
118
+ if @ssl_context.verify_mode != OpenSSL::SSL::VERIFY_NONE
119
+ s.post_connection_check(@address)
120
+ end
121
+ @ssl_session = s.session
122
+ end
123
+ on_connect
124
+ end if RUBY_VERSION < '1.9'
125
+
126
+ private :connect
127
+
128
+ end
@@ -0,0 +1,484 @@
1
+ require "set"
2
+ require "carat/vendor/thor/lib/thor/base"
3
+
4
+ class Carat::Thor # rubocop:disable ClassLength
5
+ class << self
6
+ # Allows for custom "Command" package naming.
7
+ #
8
+ # === Parameters
9
+ # name<String>
10
+ # options<Hash>
11
+ #
12
+ def package_name(name, options = {})
13
+ @package_name = name.nil? || name == "" ? nil : name
14
+ end
15
+
16
+ # Sets the default command when thor is executed without an explicit command to be called.
17
+ #
18
+ # ==== Parameters
19
+ # meth<Symbol>:: name of the default command
20
+ #
21
+ def default_command(meth = nil)
22
+ if meth
23
+ @default_command = meth == :none ? "help" : meth.to_s
24
+ else
25
+ @default_command ||= from_superclass(:default_command, "help")
26
+ end
27
+ end
28
+ alias_method :default_task, :default_command
29
+
30
+ # Registers another Carat::Thor subclass as a command.
31
+ #
32
+ # ==== Parameters
33
+ # klass<Class>:: Carat::Thor subclass to register
34
+ # command<String>:: Subcommand name to use
35
+ # usage<String>:: Short usage for the subcommand
36
+ # description<String>:: Description for the subcommand
37
+ def register(klass, subcommand_name, usage, description, options = {})
38
+ if klass <= Carat::Thor::Group
39
+ desc usage, description, options
40
+ define_method(subcommand_name) { |*args| invoke(klass, args) }
41
+ else
42
+ desc usage, description, options
43
+ subcommand subcommand_name, klass
44
+ end
45
+ end
46
+
47
+ # Defines the usage and the description of the next command.
48
+ #
49
+ # ==== Parameters
50
+ # usage<String>
51
+ # description<String>
52
+ # options<String>
53
+ #
54
+ def desc(usage, description, options = {})
55
+ if options[:for]
56
+ command = find_and_refresh_command(options[:for])
57
+ command.usage = usage if usage
58
+ command.description = description if description
59
+ else
60
+ @usage, @desc, @hide = usage, description, options[:hide] || false
61
+ end
62
+ end
63
+
64
+ # Defines the long description of the next command.
65
+ #
66
+ # ==== Parameters
67
+ # long description<String>
68
+ #
69
+ def long_desc(long_description, options = {})
70
+ if options[:for]
71
+ command = find_and_refresh_command(options[:for])
72
+ command.long_description = long_description if long_description
73
+ else
74
+ @long_desc = long_description
75
+ end
76
+ end
77
+
78
+ # Maps an input to a command. If you define:
79
+ #
80
+ # map "-T" => "list"
81
+ #
82
+ # Running:
83
+ #
84
+ # thor -T
85
+ #
86
+ # Will invoke the list command.
87
+ #
88
+ # ==== Parameters
89
+ # Hash[String|Array => Symbol]:: Maps the string or the strings in the array to the given command.
90
+ #
91
+ def map(mappings = nil)
92
+ @map ||= from_superclass(:map, {})
93
+
94
+ if mappings
95
+ mappings.each do |key, value|
96
+ if key.respond_to?(:each)
97
+ key.each { |subkey| @map[subkey] = value }
98
+ else
99
+ @map[key] = value
100
+ end
101
+ end
102
+ end
103
+
104
+ @map
105
+ end
106
+
107
+ # Declares the options for the next command to be declared.
108
+ #
109
+ # ==== Parameters
110
+ # Hash[Symbol => Object]:: The hash key is the name of the option and the value
111
+ # is the type of the option. Can be :string, :array, :hash, :boolean, :numeric
112
+ # or :required (string). If you give a value, the type of the value is used.
113
+ #
114
+ def method_options(options = nil)
115
+ @method_options ||= {}
116
+ build_options(options, @method_options) if options
117
+ @method_options
118
+ end
119
+
120
+ alias_method :options, :method_options
121
+
122
+ # Adds an option to the set of method options. If :for is given as option,
123
+ # it allows you to change the options from a previous defined command.
124
+ #
125
+ # def previous_command
126
+ # # magic
127
+ # end
128
+ #
129
+ # method_option :foo => :bar, :for => :previous_command
130
+ #
131
+ # def next_command
132
+ # # magic
133
+ # end
134
+ #
135
+ # ==== Parameters
136
+ # name<Symbol>:: The name of the argument.
137
+ # options<Hash>:: Described below.
138
+ #
139
+ # ==== Options
140
+ # :desc - Description for the argument.
141
+ # :required - If the argument is required or not.
142
+ # :default - Default value for this argument. It cannot be required and have default values.
143
+ # :aliases - Aliases for this option.
144
+ # :type - The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
145
+ # :banner - String to show on usage notes.
146
+ # :hide - If you want to hide this option from the help.
147
+ #
148
+ def method_option(name, options = {})
149
+ scope = if options[:for]
150
+ find_and_refresh_command(options[:for]).options
151
+ else
152
+ method_options
153
+ end
154
+
155
+ build_option(name, options, scope)
156
+ end
157
+ alias_method :option, :method_option
158
+
159
+ # Prints help information for the given command.
160
+ #
161
+ # ==== Parameters
162
+ # shell<Carat::Thor::Shell>
163
+ # command_name<String>
164
+ #
165
+ def command_help(shell, command_name)
166
+ meth = normalize_command_name(command_name)
167
+ command = all_commands[meth]
168
+ handle_no_command_error(meth) unless command
169
+
170
+ shell.say "Usage:"
171
+ shell.say " #{banner(command)}"
172
+ shell.say
173
+ class_options_help(shell, nil => command.options.map { |_, o| o })
174
+ if command.long_description
175
+ shell.say "Description:"
176
+ shell.print_wrapped(command.long_description, :indent => 2)
177
+ else
178
+ shell.say command.description
179
+ end
180
+ end
181
+ alias_method :task_help, :command_help
182
+
183
+ # Prints help information for this class.
184
+ #
185
+ # ==== Parameters
186
+ # shell<Carat::Thor::Shell>
187
+ #
188
+ def help(shell, subcommand = false)
189
+ list = printable_commands(true, subcommand)
190
+ Carat::Thor::Util.thor_classes_in(self).each do |klass|
191
+ list += klass.printable_commands(false)
192
+ end
193
+ list.sort! { |a, b| a[0] <=> b[0] }
194
+
195
+ if defined?(@package_name) && @package_name
196
+ shell.say "#{@package_name} commands:"
197
+ else
198
+ shell.say "Commands:"
199
+ end
200
+
201
+ shell.print_table(list, :indent => 2, :truncate => true)
202
+ shell.say
203
+ class_options_help(shell)
204
+ end
205
+
206
+ # Returns commands ready to be printed.
207
+ def printable_commands(all = true, subcommand = false)
208
+ (all ? all_commands : commands).map do |_, command|
209
+ next if command.hidden?
210
+ item = []
211
+ item << banner(command, false, subcommand)
212
+ item << (command.description ? "# #{command.description.gsub(/\s+/m, ' ')}" : "")
213
+ item
214
+ end.compact
215
+ end
216
+ alias_method :printable_tasks, :printable_commands
217
+
218
+ def subcommands
219
+ @subcommands ||= from_superclass(:subcommands, [])
220
+ end
221
+ alias_method :subtasks, :subcommands
222
+
223
+ def subcommand_classes
224
+ @subcommand_classes ||= {}
225
+ end
226
+
227
+ def subcommand(subcommand, subcommand_class)
228
+ subcommands << subcommand.to_s
229
+ subcommand_class.subcommand_help subcommand
230
+ subcommand_classes[subcommand.to_s] = subcommand_class
231
+
232
+ define_method(subcommand) do |*args|
233
+ args, opts = Carat::Thor::Arguments.split(args)
234
+ args.unshift("help") if opts.include? "--help" or opts.include? "-h"
235
+ invoke subcommand_class, args, opts, :invoked_via_subcommand => true, :class_options => options
236
+ end
237
+ end
238
+ alias_method :subtask, :subcommand
239
+
240
+ # Extend check unknown options to accept a hash of conditions.
241
+ #
242
+ # === Parameters
243
+ # options<Hash>: A hash containing :only and/or :except keys
244
+ def check_unknown_options!(options = {})
245
+ @check_unknown_options ||= {}
246
+ options.each do |key, value|
247
+ if value
248
+ @check_unknown_options[key] = Array(value)
249
+ else
250
+ @check_unknown_options.delete(key)
251
+ end
252
+ end
253
+ @check_unknown_options
254
+ end
255
+
256
+ # Overwrite check_unknown_options? to take subcommands and options into account.
257
+ def check_unknown_options?(config) #:nodoc:
258
+ options = check_unknown_options
259
+ return false unless options
260
+
261
+ command = config[:current_command]
262
+ return true unless command
263
+
264
+ name = command.name
265
+
266
+ if subcommands.include?(name)
267
+ false
268
+ elsif options[:except]
269
+ !options[:except].include?(name.to_sym)
270
+ elsif options[:only]
271
+ options[:only].include?(name.to_sym)
272
+ else
273
+ true
274
+ end
275
+ end
276
+
277
+ # Stop parsing of options as soon as an unknown option or a regular
278
+ # argument is encountered. All remaining arguments are passed to the command.
279
+ # This is useful if you have a command that can receive arbitrary additional
280
+ # options, and where those additional options should not be handled by
281
+ # Carat::Thor.
282
+ #
283
+ # ==== Example
284
+ #
285
+ # To better understand how this is useful, let's consider a command that calls
286
+ # an external command. A user may want to pass arbitrary options and
287
+ # arguments to that command. The command itself also accepts some options,
288
+ # which should be handled by Carat::Thor.
289
+ #
290
+ # class_option "verbose", :type => :boolean
291
+ # stop_on_unknown_option! :exec
292
+ # check_unknown_options! :except => :exec
293
+ #
294
+ # desc "exec", "Run a shell command"
295
+ # def exec(*args)
296
+ # puts "diagnostic output" if options[:verbose]
297
+ # Kernel.exec(*args)
298
+ # end
299
+ #
300
+ # Here +exec+ can be called with +--verbose+ to get diagnostic output,
301
+ # e.g.:
302
+ #
303
+ # $ thor exec --verbose echo foo
304
+ # diagnostic output
305
+ # foo
306
+ #
307
+ # But if +--verbose+ is given after +echo+, it is passed to +echo+ instead:
308
+ #
309
+ # $ thor exec echo --verbose foo
310
+ # --verbose foo
311
+ #
312
+ # ==== Parameters
313
+ # Symbol ...:: A list of commands that should be affected.
314
+ def stop_on_unknown_option!(*command_names)
315
+ stop_on_unknown_option.merge(command_names)
316
+ end
317
+
318
+ def stop_on_unknown_option?(command) #:nodoc:
319
+ command && stop_on_unknown_option.include?(command.name.to_sym)
320
+ end
321
+
322
+ protected
323
+ def stop_on_unknown_option #:nodoc:
324
+ @stop_on_unknown_option ||= Set.new
325
+ end
326
+
327
+ # The method responsible for dispatching given the args.
328
+ def dispatch(meth, given_args, given_opts, config) #:nodoc: # rubocop:disable MethodLength
329
+ meth ||= retrieve_command_name(given_args)
330
+ command = all_commands[normalize_command_name(meth)]
331
+
332
+ if !command && config[:invoked_via_subcommand]
333
+ # We're a subcommand and our first argument didn't match any of our
334
+ # commands. So we put it back and call our default command.
335
+ given_args.unshift(meth)
336
+ command = all_commands[normalize_command_name(default_command)]
337
+ end
338
+
339
+ if command
340
+ args, opts = Carat::Thor::Options.split(given_args)
341
+ if stop_on_unknown_option?(command) && !args.empty?
342
+ # given_args starts with a non-option, so we treat everything as
343
+ # ordinary arguments
344
+ args.concat opts
345
+ opts.clear
346
+ end
347
+ else
348
+ args, opts = given_args, nil
349
+ command = dynamic_command_class.new(meth)
350
+ end
351
+
352
+ opts = given_opts || opts || []
353
+ config.merge!(:current_command => command, :command_options => command.options)
354
+
355
+ instance = new(args, opts, config)
356
+ yield instance if block_given?
357
+ args = instance.args
358
+ trailing = args[Range.new(arguments.size, -1)]
359
+ instance.invoke_command(command, trailing || [])
360
+ end
361
+
362
+ # The banner for this class. You can customize it if you are invoking the
363
+ # thor class by another ways which is not the Carat::Thor::Runner. It receives
364
+ # the command that is going to be invoked and a boolean which indicates if
365
+ # the namespace should be displayed as arguments.
366
+ #
367
+ def banner(command, namespace = nil, subcommand = false)
368
+ "#{basename} #{command.formatted_usage(self, $thor_runner, subcommand)}"
369
+ end
370
+
371
+ def baseclass #:nodoc:
372
+ Carat::Thor
373
+ end
374
+
375
+ def dynamic_command_class #:nodoc:
376
+ Carat::Thor::DynamicCommand
377
+ end
378
+
379
+ def create_command(meth) #:nodoc:
380
+ @usage ||= nil
381
+ @desc ||= nil
382
+ @long_desc ||= nil
383
+
384
+ if @usage && @desc
385
+ base_class = @hide ? Carat::Thor::HiddenCommand : Carat::Thor::Command
386
+ commands[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options)
387
+ @usage, @desc, @long_desc, @method_options, @hide = nil
388
+ true
389
+ elsif all_commands[meth] || meth == "method_missing"
390
+ true
391
+ else
392
+ puts "[WARNING] Attempted to create command #{meth.inspect} without usage or description. " <<
393
+ "Call desc if you want this method to be available as command or declare it inside a " <<
394
+ "no_commands{} block. Invoked from #{caller[1].inspect}."
395
+ false
396
+ end
397
+ end
398
+ alias_method :create_task, :create_command
399
+
400
+ def initialize_added #:nodoc:
401
+ class_options.merge!(method_options)
402
+ @method_options = nil
403
+ end
404
+
405
+ # Retrieve the command name from given args.
406
+ def retrieve_command_name(args) #:nodoc:
407
+ meth = args.first.to_s unless args.empty?
408
+ if meth && (map[meth] || meth !~ /^\-/)
409
+ args.shift
410
+ else
411
+ nil
412
+ end
413
+ end
414
+ alias_method :retrieve_task_name, :retrieve_command_name
415
+
416
+ # receives a (possibly nil) command name and returns a name that is in
417
+ # the commands hash. In addition to normalizing aliases, this logic
418
+ # will determine if a shortened command is an unambiguous substring of
419
+ # a command or alias.
420
+ #
421
+ # +normalize_command_name+ also converts names like +animal-prison+
422
+ # into +animal_prison+.
423
+ def normalize_command_name(meth) #:nodoc:
424
+ return default_command.to_s.gsub("-", "_") unless meth
425
+
426
+ possibilities = find_command_possibilities(meth)
427
+ if possibilities.size > 1
428
+ fail AmbiguousTaskError, "Ambiguous command #{meth} matches [#{possibilities.join(', ')}]"
429
+ elsif possibilities.size < 1
430
+ meth = meth || default_command
431
+ elsif map[meth]
432
+ meth = map[meth]
433
+ else
434
+ meth = possibilities.first
435
+ end
436
+
437
+ meth.to_s.gsub("-", "_") # treat foo-bar as foo_bar
438
+ end
439
+ alias_method :normalize_task_name, :normalize_command_name
440
+
441
+ # this is the logic that takes the command name passed in by the user
442
+ # and determines whether it is an unambiguous substrings of a command or
443
+ # alias name.
444
+ def find_command_possibilities(meth)
445
+ len = meth.to_s.length
446
+ possibilities = all_commands.merge(map).keys.select { |n| meth == n[0, len] }.sort
447
+ unique_possibilities = possibilities.map { |k| map[k] || k }.uniq
448
+
449
+ if possibilities.include?(meth)
450
+ [meth]
451
+ elsif unique_possibilities.size == 1
452
+ unique_possibilities
453
+ else
454
+ possibilities
455
+ end
456
+ end
457
+ alias_method :find_task_possibilities, :find_command_possibilities
458
+
459
+ def subcommand_help(cmd)
460
+ desc "help [COMMAND]", "Describe subcommands or one specific subcommand"
461
+ class_eval "
462
+ def help(command = nil, subcommand = true); super; end
463
+ "
464
+ end
465
+ alias_method :subtask_help, :subcommand_help
466
+ end
467
+
468
+ include Carat::Thor::Base
469
+
470
+ map HELP_MAPPINGS => :help
471
+
472
+ desc "help [COMMAND]", "Describe available commands or one specific command"
473
+ def help(command = nil, subcommand = false)
474
+ if command
475
+ if self.class.subcommands.include? command
476
+ self.class.subcommand_classes[command].help(shell, true)
477
+ else
478
+ self.class.command_help(shell, command)
479
+ end
480
+ else
481
+ self.class.help(shell, subcommand)
482
+ end
483
+ end
484
+ end