bundler-prehistoric 1.6.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/.rspec +3 -0
- data/.travis.yml +100 -0
- data/CHANGELOG.md +1640 -0
- data/CONTRIBUTING.md +32 -0
- data/DEVELOPMENT.md +117 -0
- data/Gemfile +3 -0
- data/ISSUES.md +96 -0
- data/LICENSE.md +23 -0
- data/README.md +46 -0
- data/Rakefile +256 -0
- data/UPGRADING.md +103 -0
- data/bin/bundle +21 -0
- data/bin/bundle_ruby +56 -0
- data/bin/bundler +21 -0
- data/bundler.gemspec +33 -0
- data/lib/bundler.rb +442 -0
- data/lib/bundler/backports/time.rb +7 -0
- data/lib/bundler/capistrano.rb +16 -0
- data/lib/bundler/cli.rb +395 -0
- data/lib/bundler/cli/binstubs.rb +38 -0
- data/lib/bundler/cli/cache.rb +34 -0
- data/lib/bundler/cli/check.rb +35 -0
- data/lib/bundler/cli/clean.rb +19 -0
- data/lib/bundler/cli/common.rb +54 -0
- data/lib/bundler/cli/config.rb +84 -0
- data/lib/bundler/cli/console.rb +39 -0
- data/lib/bundler/cli/exec.rb +37 -0
- data/lib/bundler/cli/gem.rb +101 -0
- data/lib/bundler/cli/init.rb +33 -0
- data/lib/bundler/cli/inject.rb +33 -0
- data/lib/bundler/cli/install.rb +133 -0
- data/lib/bundler/cli/open.rb +23 -0
- data/lib/bundler/cli/outdated.rb +80 -0
- data/lib/bundler/cli/package.rb +36 -0
- data/lib/bundler/cli/platform.rb +43 -0
- data/lib/bundler/cli/show.rb +48 -0
- data/lib/bundler/cli/update.rb +73 -0
- data/lib/bundler/cli/viz.rb +27 -0
- data/lib/bundler/constants.rb +5 -0
- data/lib/bundler/current_ruby.rb +155 -0
- data/lib/bundler/definition.rb +604 -0
- data/lib/bundler/dep_proxy.rb +43 -0
- data/lib/bundler/dependency.rb +106 -0
- data/lib/bundler/deployment.rb +59 -0
- data/lib/bundler/deprecate.rb +15 -0
- data/lib/bundler/dsl.rb +305 -0
- data/lib/bundler/endpoint_specification.rb +76 -0
- data/lib/bundler/env.rb +56 -0
- data/lib/bundler/environment.rb +42 -0
- data/lib/bundler/fetcher.rb +396 -0
- data/lib/bundler/friendly_errors.rb +42 -0
- data/lib/bundler/gem_helper.rb +169 -0
- data/lib/bundler/gem_helpers.rb +25 -0
- data/lib/bundler/gem_installer.rb +9 -0
- data/lib/bundler/gem_path_manipulation.rb +8 -0
- data/lib/bundler/gem_tasks.rb +2 -0
- data/lib/bundler/graph.rb +169 -0
- data/lib/bundler/index.rb +184 -0
- data/lib/bundler/injector.rb +64 -0
- data/lib/bundler/installer.rb +332 -0
- data/lib/bundler/lazy_specification.rb +83 -0
- data/lib/bundler/lockfile_parser.rb +146 -0
- data/lib/bundler/match_platform.rb +13 -0
- data/lib/bundler/parallel_workers.rb +18 -0
- data/lib/bundler/parallel_workers/thread_worker.rb +30 -0
- data/lib/bundler/parallel_workers/unix_worker.rb +101 -0
- data/lib/bundler/parallel_workers/worker.rb +69 -0
- data/lib/bundler/psyched_yaml.rb +26 -0
- data/lib/bundler/remote_specification.rb +57 -0
- data/lib/bundler/resolver.rb +534 -0
- data/lib/bundler/retry.rb +60 -0
- data/lib/bundler/ruby_dsl.rb +11 -0
- data/lib/bundler/ruby_version.rb +117 -0
- data/lib/bundler/rubygems_ext.rb +171 -0
- data/lib/bundler/rubygems_integration.rb +578 -0
- data/lib/bundler/runtime.rb +310 -0
- data/lib/bundler/settings.rb +176 -0
- data/lib/bundler/setup.rb +23 -0
- data/lib/bundler/shared_helpers.rb +110 -0
- data/lib/bundler/similarity_detector.rb +63 -0
- data/lib/bundler/source.rb +29 -0
- data/lib/bundler/source/git.rb +289 -0
- data/lib/bundler/source/git/git_proxy.rb +158 -0
- data/lib/bundler/source/path.rb +225 -0
- data/lib/bundler/source/path/installer.rb +38 -0
- data/lib/bundler/source/rubygems.rb +334 -0
- data/lib/bundler/source/svn.rb +260 -0
- data/lib/bundler/source/svn/svn_proxy.rb +110 -0
- data/lib/bundler/spec_set.rb +154 -0
- data/lib/bundler/ssl_certs/.document +1 -0
- data/lib/bundler/ssl_certs/Class3PublicPrimaryCertificationAuthority.pem +14 -0
- data/lib/bundler/ssl_certs/DigiCertHighAssuranceEVRootCA.pem +23 -0
- data/lib/bundler/ssl_certs/EntrustnetSecureServerCertificationAuthority.pem +28 -0
- data/lib/bundler/ssl_certs/GeoTrustGlobalCA.pem +20 -0
- data/lib/bundler/ssl_certs/certificate_manager.rb +41 -0
- data/lib/bundler/templates/Executable +16 -0
- data/lib/bundler/templates/Executable.standalone +12 -0
- data/lib/bundler/templates/Gemfile +4 -0
- data/lib/bundler/templates/newgem/.travis.yml.tt +3 -0
- data/lib/bundler/templates/newgem/Gemfile.tt +4 -0
- data/lib/bundler/templates/newgem/LICENSE.txt.tt +22 -0
- data/lib/bundler/templates/newgem/README.md.tt +31 -0
- data/lib/bundler/templates/newgem/Rakefile.tt +26 -0
- data/lib/bundler/templates/newgem/bin/newgem.tt +3 -0
- data/lib/bundler/templates/newgem/consolerc.tt +3 -0
- data/lib/bundler/templates/newgem/ext/newgem/extconf.rb.tt +3 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem.c.tt +9 -0
- data/lib/bundler/templates/newgem/ext/newgem/newgem.h.tt +6 -0
- data/lib/bundler/templates/newgem/gitignore.tt +16 -0
- data/lib/bundler/templates/newgem/lib/newgem.rb.tt +12 -0
- data/lib/bundler/templates/newgem/lib/newgem/version.rb.tt +7 -0
- data/lib/bundler/templates/newgem/newgem.gemspec.tt +38 -0
- data/lib/bundler/templates/newgem/rspec.tt +2 -0
- data/lib/bundler/templates/newgem/spec/newgem_spec.rb.tt +11 -0
- data/lib/bundler/templates/newgem/spec/spec_helper.rb.tt +2 -0
- data/lib/bundler/templates/newgem/test/minitest_helper.rb.tt +4 -0
- data/lib/bundler/templates/newgem/test/test_newgem.rb.tt +11 -0
- data/lib/bundler/ui.rb +7 -0
- data/lib/bundler/ui/rg_proxy.rb +21 -0
- data/lib/bundler/ui/shell.rb +98 -0
- data/lib/bundler/ui/silent.rb +44 -0
- data/lib/bundler/vendor/.document +0 -0
- data/lib/bundler/vendor/net/http/faster.rb +26 -0
- data/lib/bundler/vendor/net/http/persistent.rb +1230 -0
- data/lib/bundler/vendor/net/http/persistent/ssl_reuse.rb +128 -0
- data/lib/bundler/vendor/thor.rb +480 -0
- data/lib/bundler/vendor/thor/actions.rb +319 -0
- data/lib/bundler/vendor/thor/actions/create_file.rb +103 -0
- data/lib/bundler/vendor/thor/actions/create_link.rb +59 -0
- data/lib/bundler/vendor/thor/actions/directory.rb +118 -0
- data/lib/bundler/vendor/thor/actions/empty_directory.rb +135 -0
- data/lib/bundler/vendor/thor/actions/file_manipulation.rb +316 -0
- data/lib/bundler/vendor/thor/actions/inject_into_file.rb +107 -0
- data/lib/bundler/vendor/thor/base.rb +656 -0
- data/lib/bundler/vendor/thor/command.rb +133 -0
- data/lib/bundler/vendor/thor/core_ext/hash_with_indifferent_access.rb +77 -0
- data/lib/bundler/vendor/thor/core_ext/io_binary_read.rb +10 -0
- data/lib/bundler/vendor/thor/core_ext/ordered_hash.rb +98 -0
- data/lib/bundler/vendor/thor/error.rb +32 -0
- data/lib/bundler/vendor/thor/group.rb +281 -0
- data/lib/bundler/vendor/thor/invocation.rb +173 -0
- data/lib/bundler/vendor/thor/line_editor.rb +17 -0
- data/lib/bundler/vendor/thor/line_editor/basic.rb +35 -0
- data/lib/bundler/vendor/thor/line_editor/readline.rb +88 -0
- data/lib/bundler/vendor/thor/parser.rb +4 -0
- data/lib/bundler/vendor/thor/parser/argument.rb +73 -0
- data/lib/bundler/vendor/thor/parser/arguments.rb +175 -0
- data/lib/bundler/vendor/thor/parser/option.rb +121 -0
- data/lib/bundler/vendor/thor/parser/options.rb +218 -0
- data/lib/bundler/vendor/thor/rake_compat.rb +71 -0
- data/lib/bundler/vendor/thor/runner.rb +322 -0
- data/lib/bundler/vendor/thor/shell.rb +81 -0
- data/lib/bundler/vendor/thor/shell/basic.rb +420 -0
- data/lib/bundler/vendor/thor/shell/color.rb +149 -0
- data/lib/bundler/vendor/thor/shell/html.rb +126 -0
- data/lib/bundler/vendor/thor/util.rb +267 -0
- data/lib/bundler/vendor/thor/version.rb +3 -0
- data/lib/bundler/vendored_persistent.rb +3 -0
- data/lib/bundler/vendored_thor.rb +8 -0
- data/lib/bundler/version.rb +6 -0
- data/lib/bundler/vlad.rb +11 -0
- data/man/bundle-config.ronn +155 -0
- data/man/bundle-exec.ronn +136 -0
- data/man/bundle-install.ronn +372 -0
- data/man/bundle-package.ronn +59 -0
- data/man/bundle-platform.ronn +42 -0
- data/man/bundle-update.ronn +179 -0
- data/man/bundle.ronn +92 -0
- data/man/gemfile.5.ronn +369 -0
- data/man/index.txt +7 -0
- data/spec/bundler/bundler_spec.rb +74 -0
- data/spec/bundler/cli_spec.rb +16 -0
- data/spec/bundler/definition_spec.rb +21 -0
- data/spec/bundler/dsl_spec.rb +108 -0
- data/spec/bundler/friendly_errors_spec.rb +13 -0
- data/spec/bundler/gem_helper_spec.rb +225 -0
- data/spec/bundler/psyched_yaml_spec.rb +8 -0
- data/spec/bundler/retry_spec.rb +59 -0
- data/spec/bundler/settings_spec.rb +13 -0
- data/spec/bundler/source_spec.rb +25 -0
- data/spec/cache/gems_spec.rb +316 -0
- data/spec/cache/git_spec.rb +188 -0
- data/spec/cache/path_spec.rb +121 -0
- data/spec/cache/platform_spec.rb +53 -0
- data/spec/cache/svn_spec.rb +82 -0
- data/spec/commands/binstubs_spec.rb +246 -0
- data/spec/commands/check_spec.rb +278 -0
- data/spec/commands/clean_spec.rb +652 -0
- data/spec/commands/config_spec.rb +227 -0
- data/spec/commands/console_spec.rb +102 -0
- data/spec/commands/exec_spec.rb +367 -0
- data/spec/commands/help_spec.rb +39 -0
- data/spec/commands/init_spec.rb +39 -0
- data/spec/commands/inject_spec.rb +78 -0
- data/spec/commands/licenses_spec.rb +31 -0
- data/spec/commands/newgem_spec.rb +451 -0
- data/spec/commands/open_spec.rb +80 -0
- data/spec/commands/outdated_spec.rb +168 -0
- data/spec/commands/package_spec.rb +128 -0
- data/spec/commands/show_spec.rb +152 -0
- data/spec/install/binstubs_spec.rb +24 -0
- data/spec/install/bundler_spec.rb +146 -0
- data/spec/install/deploy_spec.rb +237 -0
- data/spec/install/gemfile/gemspec_spec.rb +170 -0
- data/spec/install/gemfile/git_spec.rb +967 -0
- data/spec/install/gemfile/path_spec.rb +480 -0
- data/spec/install/gemfile/svn_spec.rb +582 -0
- data/spec/install/gemfile_spec.rb +44 -0
- data/spec/install/gems/c_ext_spec.rb +48 -0
- data/spec/install/gems/dependency_api_spec.rb +580 -0
- data/spec/install/gems/env_spec.rb +107 -0
- data/spec/install/gems/flex_spec.rb +314 -0
- data/spec/install/gems/groups_spec.rb +308 -0
- data/spec/install/gems/mirror_spec.rb +39 -0
- data/spec/install/gems/platform_spec.rb +221 -0
- data/spec/install/gems/post_install_spec.rb +121 -0
- data/spec/install/gems/resolving_spec.rb +124 -0
- data/spec/install/gems/simple_case_spec.rb +386 -0
- data/spec/install/gems/standalone_spec.rb +260 -0
- data/spec/install/gems/sudo_spec.rb +136 -0
- data/spec/install/gems/win32_spec.rb +26 -0
- data/spec/install/gemspecs_spec.rb +50 -0
- data/spec/install/path_spec.rb +150 -0
- data/spec/install/post_bundle_message_spec.rb +142 -0
- data/spec/install/prereleases_spec.rb +43 -0
- data/spec/install/security_policy_spec.rb +77 -0
- data/spec/install/upgrade_spec.rb +26 -0
- data/spec/lock/git_spec.rb +34 -0
- data/spec/lock/lockfile_spec.rb +912 -0
- data/spec/lock/svn_spec.rb +35 -0
- data/spec/other/bundle_ruby_spec.rb +142 -0
- data/spec/other/cli_dispatch_spec.rb +21 -0
- data/spec/other/ext_spec.rb +60 -0
- data/spec/other/platform_spec.rb +1285 -0
- data/spec/other/ssl_cert_spec.rb +10 -0
- data/spec/quality_spec.rb +88 -0
- data/spec/realworld/dependency_api_spec.rb +60 -0
- data/spec/realworld/edgecases_spec.rb +177 -0
- data/spec/realworld/parallel_spec.rb +69 -0
- data/spec/resolver/basic_spec.rb +66 -0
- data/spec/resolver/platform_spec.rb +88 -0
- data/spec/runtime/executable_spec.rb +149 -0
- data/spec/runtime/load_spec.rb +107 -0
- data/spec/runtime/platform_spec.rb +90 -0
- data/spec/runtime/require_spec.rb +332 -0
- data/spec/runtime/setup_spec.rb +856 -0
- data/spec/runtime/with_clean_env_spec.rb +91 -0
- data/spec/spec_helper.rb +114 -0
- data/spec/support/artifice/endopint_marshal_fail_basic_authentication.rb +13 -0
- data/spec/support/artifice/endpoint.rb +71 -0
- data/spec/support/artifice/endpoint_500.rb +37 -0
- data/spec/support/artifice/endpoint_api_missing.rb +16 -0
- data/spec/support/artifice/endpoint_basic_authentication.rb +13 -0
- data/spec/support/artifice/endpoint_creds_diff_host.rb +38 -0
- data/spec/support/artifice/endpoint_extra.rb +31 -0
- data/spec/support/artifice/endpoint_extra_missing.rb +15 -0
- data/spec/support/artifice/endpoint_fallback.rb +17 -0
- data/spec/support/artifice/endpoint_host_redirect.rb +15 -0
- data/spec/support/artifice/endpoint_marshal_fail.rb +11 -0
- data/spec/support/artifice/endpoint_redirect.rb +15 -0
- data/spec/support/artifice/endpoint_strict_basic_authentication.rb +18 -0
- data/spec/support/artifice/endpoint_timeout.rb +13 -0
- data/spec/support/builders.rb +748 -0
- data/spec/support/fakeweb/rack-1.0.0.marshal +2 -0
- data/spec/support/fakeweb/windows.rb +23 -0
- data/spec/support/hax.rb +22 -0
- data/spec/support/helpers.rb +348 -0
- data/spec/support/indexes.rb +280 -0
- data/spec/support/less_than_proc.rb +14 -0
- data/spec/support/matchers.rb +77 -0
- data/spec/support/path.rb +81 -0
- data/spec/support/permissions.rb +10 -0
- data/spec/support/platforms.rb +94 -0
- data/spec/support/ruby_ext.rb +20 -0
- data/spec/support/rubygems_ext.rb +39 -0
- data/spec/support/streams.rb +13 -0
- data/spec/support/sudo.rb +16 -0
- data/spec/update/gems_spec.rb +201 -0
- data/spec/update/git_spec.rb +236 -0
- data/spec/update/source_spec.rb +63 -0
- data/spec/update/svn_spec.rb +100 -0
- metadata +486 -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,480 @@
|
|
1
|
+
require 'set'
|
2
|
+
require 'thor/base'
|
3
|
+
|
4
|
+
class 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 Thor subclass as a command.
|
31
|
+
#
|
32
|
+
# ==== Parameters
|
33
|
+
# klass<Class>:: 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 <= 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<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<Thor::Shell>
|
187
|
+
#
|
188
|
+
def help(shell, subcommand = false)
|
189
|
+
list = printable_commands(true, subcommand)
|
190
|
+
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(subcommand, subcommand_class)
|
224
|
+
subcommands << subcommand.to_s
|
225
|
+
subcommand_class.subcommand_help subcommand
|
226
|
+
|
227
|
+
define_method(subcommand) do |*args|
|
228
|
+
args, opts = Thor::Arguments.split(args)
|
229
|
+
args.unshift("help") if opts.include? "--help" or opts.include? "-h"
|
230
|
+
invoke subcommand_class, args, opts, :invoked_via_subcommand => true, :class_options => options
|
231
|
+
end
|
232
|
+
end
|
233
|
+
alias_method :subtask, :subcommand
|
234
|
+
|
235
|
+
# Extend check unknown options to accept a hash of conditions.
|
236
|
+
#
|
237
|
+
# === Parameters
|
238
|
+
# options<Hash>: A hash containing :only and/or :except keys
|
239
|
+
def check_unknown_options!(options = {})
|
240
|
+
@check_unknown_options ||= {}
|
241
|
+
options.each do |key, value|
|
242
|
+
if value
|
243
|
+
@check_unknown_options[key] = Array(value)
|
244
|
+
else
|
245
|
+
@check_unknown_options.delete(key)
|
246
|
+
end
|
247
|
+
end
|
248
|
+
@check_unknown_options
|
249
|
+
end
|
250
|
+
|
251
|
+
# Overwrite check_unknown_options? to take subcommands and options into account.
|
252
|
+
def check_unknown_options?(config) #:nodoc:
|
253
|
+
options = check_unknown_options
|
254
|
+
return false unless options
|
255
|
+
|
256
|
+
command = config[:current_command]
|
257
|
+
return true unless command
|
258
|
+
|
259
|
+
name = command.name
|
260
|
+
|
261
|
+
if subcommands.include?(name)
|
262
|
+
false
|
263
|
+
elsif options[:except]
|
264
|
+
!options[:except].include?(name.to_sym)
|
265
|
+
elsif options[:only]
|
266
|
+
options[:only].include?(name.to_sym)
|
267
|
+
else
|
268
|
+
true
|
269
|
+
end
|
270
|
+
end
|
271
|
+
|
272
|
+
# Stop parsing of options as soon as an unknown option or a regular
|
273
|
+
# argument is encountered. All remaining arguments are passed to the command.
|
274
|
+
# This is useful if you have a command that can receive arbitrary additional
|
275
|
+
# options, and where those additional options should not be handled by
|
276
|
+
# Thor.
|
277
|
+
#
|
278
|
+
# ==== Example
|
279
|
+
#
|
280
|
+
# To better understand how this is useful, let's consider a command that calls
|
281
|
+
# an external command. A user may want to pass arbitrary options and
|
282
|
+
# arguments to that command. The command itself also accepts some options,
|
283
|
+
# which should be handled by Thor.
|
284
|
+
#
|
285
|
+
# class_option "verbose", :type => :boolean
|
286
|
+
# stop_on_unknown_option! :exec
|
287
|
+
# check_unknown_options! :except => :exec
|
288
|
+
#
|
289
|
+
# desc "exec", "Run a shell command"
|
290
|
+
# def exec(*args)
|
291
|
+
# puts "diagnostic output" if options[:verbose]
|
292
|
+
# Kernel.exec(*args)
|
293
|
+
# end
|
294
|
+
#
|
295
|
+
# Here +exec+ can be called with +--verbose+ to get diagnostic output,
|
296
|
+
# e.g.:
|
297
|
+
#
|
298
|
+
# $ thor exec --verbose echo foo
|
299
|
+
# diagnostic output
|
300
|
+
# foo
|
301
|
+
#
|
302
|
+
# But if +--verbose+ is given after +echo+, it is passed to +echo+ instead:
|
303
|
+
#
|
304
|
+
# $ thor exec echo --verbose foo
|
305
|
+
# --verbose foo
|
306
|
+
#
|
307
|
+
# ==== Parameters
|
308
|
+
# Symbol ...:: A list of commands that should be affected.
|
309
|
+
def stop_on_unknown_option!(*command_names)
|
310
|
+
stop_on_unknown_option.merge(command_names)
|
311
|
+
end
|
312
|
+
|
313
|
+
def stop_on_unknown_option?(command) #:nodoc:
|
314
|
+
command && stop_on_unknown_option.include?(command.name.to_sym)
|
315
|
+
end
|
316
|
+
|
317
|
+
protected
|
318
|
+
def stop_on_unknown_option #:nodoc:
|
319
|
+
@stop_on_unknown_option ||= Set.new
|
320
|
+
end
|
321
|
+
|
322
|
+
# The method responsible for dispatching given the args.
|
323
|
+
def dispatch(meth, given_args, given_opts, config) #:nodoc: # rubocop:disable MethodLength
|
324
|
+
# There is an edge case when dispatching from a subcommand.
|
325
|
+
# A problem occurs invoking the default command. This case occurs
|
326
|
+
# when arguments are passed and a default command is defined, and
|
327
|
+
# the first given_args does not match the default command.
|
328
|
+
# Thor use "help" by default so we skip that case.
|
329
|
+
# Note the call to retrieve_command_name. It's called with
|
330
|
+
# given_args.dup since that method calls args.shift. Then lookup
|
331
|
+
# the command normally. If the first item in given_args is not
|
332
|
+
# a command then use the default command. The given_args will be
|
333
|
+
# intact later since dup was used.
|
334
|
+
if config[:invoked_via_subcommand] && given_args.size >= 1 && default_command != 'help' && given_args.first != default_command
|
335
|
+
meth ||= retrieve_command_name(given_args.dup)
|
336
|
+
command = all_commands[normalize_command_name(meth)]
|
337
|
+
command ||= all_commands[normalize_command_name(default_command)]
|
338
|
+
else
|
339
|
+
meth ||= retrieve_command_name(given_args)
|
340
|
+
command = all_commands[normalize_command_name(meth)]
|
341
|
+
end
|
342
|
+
|
343
|
+
if command
|
344
|
+
args, opts = Thor::Options.split(given_args)
|
345
|
+
if stop_on_unknown_option?(command) && !args.empty?
|
346
|
+
# given_args starts with a non-option, so we treat everything as
|
347
|
+
# ordinary arguments
|
348
|
+
args.concat opts
|
349
|
+
opts.clear
|
350
|
+
end
|
351
|
+
else
|
352
|
+
args, opts = given_args, nil
|
353
|
+
command = dynamic_command_class.new(meth)
|
354
|
+
end
|
355
|
+
|
356
|
+
opts = given_opts || opts || []
|
357
|
+
config.merge!(:current_command => command, :command_options => command.options)
|
358
|
+
|
359
|
+
instance = new(args, opts, config)
|
360
|
+
yield instance if block_given?
|
361
|
+
args = instance.args
|
362
|
+
trailing = args[Range.new(arguments.size, -1)]
|
363
|
+
instance.invoke_command(command, trailing || [])
|
364
|
+
end
|
365
|
+
|
366
|
+
# The banner for this class. You can customize it if you are invoking the
|
367
|
+
# thor class by another ways which is not the Thor::Runner. It receives
|
368
|
+
# the command that is going to be invoked and a boolean which indicates if
|
369
|
+
# the namespace should be displayed as arguments.
|
370
|
+
#
|
371
|
+
def banner(command, namespace = nil, subcommand = false)
|
372
|
+
"#{basename} #{command.formatted_usage(self, $thor_runner, subcommand)}"
|
373
|
+
end
|
374
|
+
|
375
|
+
def baseclass #:nodoc:
|
376
|
+
Thor
|
377
|
+
end
|
378
|
+
|
379
|
+
def dynamic_command_class #:nodoc:
|
380
|
+
Thor::DynamicCommand
|
381
|
+
end
|
382
|
+
|
383
|
+
def create_command(meth) #:nodoc:
|
384
|
+
@usage ||= nil
|
385
|
+
@desc ||= nil
|
386
|
+
@long_desc ||= nil
|
387
|
+
|
388
|
+
if @usage && @desc
|
389
|
+
base_class = @hide ? Thor::HiddenCommand : Thor::Command
|
390
|
+
commands[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options)
|
391
|
+
@usage, @desc, @long_desc, @method_options, @hide = nil
|
392
|
+
true
|
393
|
+
elsif all_commands[meth] || meth == 'method_missing'
|
394
|
+
true
|
395
|
+
else
|
396
|
+
puts "[WARNING] Attempted to create command #{meth.inspect} without usage or description. " <<
|
397
|
+
'Call desc if you want this method to be available as command or declare it inside a ' <<
|
398
|
+
"no_commands{} block. Invoked from #{caller[1].inspect}."
|
399
|
+
false
|
400
|
+
end
|
401
|
+
end
|
402
|
+
alias_method :create_task, :create_command
|
403
|
+
|
404
|
+
def initialize_added #:nodoc:
|
405
|
+
class_options.merge!(method_options)
|
406
|
+
@method_options = nil
|
407
|
+
end
|
408
|
+
|
409
|
+
# Retrieve the command name from given args.
|
410
|
+
def retrieve_command_name(args) #:nodoc:
|
411
|
+
meth = args.first.to_s unless args.empty?
|
412
|
+
if meth && (map[meth] || meth !~ /^\-/)
|
413
|
+
args.shift
|
414
|
+
else
|
415
|
+
nil
|
416
|
+
end
|
417
|
+
end
|
418
|
+
alias_method :retrieve_task_name, :retrieve_command_name
|
419
|
+
|
420
|
+
# receives a (possibly nil) command name and returns a name that is in
|
421
|
+
# the commands hash. In addition to normalizing aliases, this logic
|
422
|
+
# will determine if a shortened command is an unambiguous substring of
|
423
|
+
# a command or alias.
|
424
|
+
#
|
425
|
+
# +normalize_command_name+ also converts names like +animal-prison+
|
426
|
+
# into +animal_prison+.
|
427
|
+
def normalize_command_name(meth) #:nodoc:
|
428
|
+
return default_command.to_s.gsub('-', '_') unless meth
|
429
|
+
|
430
|
+
possibilities = find_command_possibilities(meth)
|
431
|
+
if possibilities.size > 1
|
432
|
+
fail AmbiguousTaskError, "Ambiguous command #{meth} matches [#{possibilities.join(', ')}]"
|
433
|
+
elsif possibilities.size < 1
|
434
|
+
meth = meth || default_command
|
435
|
+
elsif map[meth]
|
436
|
+
meth = map[meth]
|
437
|
+
else
|
438
|
+
meth = possibilities.first
|
439
|
+
end
|
440
|
+
|
441
|
+
meth.to_s.gsub('-', '_') # treat foo-bar as foo_bar
|
442
|
+
end
|
443
|
+
alias_method :normalize_task_name, :normalize_command_name
|
444
|
+
|
445
|
+
# this is the logic that takes the command name passed in by the user
|
446
|
+
# and determines whether it is an unambiguous substrings of a command or
|
447
|
+
# alias name.
|
448
|
+
def find_command_possibilities(meth)
|
449
|
+
len = meth.to_s.length
|
450
|
+
possibilities = all_commands.merge(map).keys.select { |n| meth == n[0, len] }.sort
|
451
|
+
unique_possibilities = possibilities.map { |k| map[k] || k }.uniq
|
452
|
+
|
453
|
+
if possibilities.include?(meth)
|
454
|
+
[meth]
|
455
|
+
elsif unique_possibilities.size == 1
|
456
|
+
unique_possibilities
|
457
|
+
else
|
458
|
+
possibilities
|
459
|
+
end
|
460
|
+
end
|
461
|
+
alias_method :find_task_possibilities, :find_command_possibilities
|
462
|
+
|
463
|
+
def subcommand_help(cmd)
|
464
|
+
desc 'help [COMMAND]', 'Describe subcommands or one specific subcommand'
|
465
|
+
class_eval "
|
466
|
+
def help(command = nil, subcommand = true); super; end
|
467
|
+
"
|
468
|
+
end
|
469
|
+
alias_method :subtask_help, :subcommand_help
|
470
|
+
end
|
471
|
+
|
472
|
+
include Thor::Base
|
473
|
+
|
474
|
+
map HELP_MAPPINGS => :help
|
475
|
+
|
476
|
+
desc 'help [COMMAND]', 'Describe available commands or one specific command'
|
477
|
+
def help(command = nil, subcommand = false)
|
478
|
+
command ? self.class.command_help(shell, command) : self.class.help(shell, subcommand)
|
479
|
+
end
|
480
|
+
end
|