Class: Gem::Commands::DependencyCommand
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::Gem::Command
|
|
Instance Chain:
|
|
Inherits: |
Gem::Command
|
Defined in: | lib/rubygems/commands/dependency_command.rb |
Constant Summary
::Gem::Command
- Inherited
Class Attribute Summary
::Gem::Command
- Inherited
.build_args | Arguments used when building gems. |
.build_args=, .extra_args, .extra_args= |
Class Method Summary
- .new ⇒ DependencyCommand constructor
::Gem::Command
- Inherited
.add_common_option, | |
.add_specific_extra_args | Add a list of extra arguments for the given command. |
.common_options, | |
.new | Initializes a generic gem command named |
.specific_extra_args | Return an array of extra arguments for the command. |
.specific_extra_args_hash | Accessor for the specific extra args hash (self initializing). |
Instance Attribute Summary
::Gem::LocalRemoteOptions
- Included
#both? | Is fetching of local and remote information enabled? |
#local? | Is local fetching enabled? |
#remote? | Is remote fetching enabled? |
::Gem::Command
- Inherited
#command | The name of the command. |
#defaults | The default options for the command. |
#options | The options for the command. |
#program_name | The name of the command for command-line invocation. |
#summary | A short description of the command. |
::Gem::DefaultUserInteraction
- Included
Instance Method Summary
- #execute
- #name_pattern(args) private
- #arguments Internal use only
- #defaults_str Internal use only
- #description Internal use only
- #display_pipe(specs) Internal use only
- #display_readable(specs, reverse) Internal use only
- #ensure_local_only_reverse_dependencies Internal use only
- #ensure_specs(specs) Internal use only
- #fetch_remote_specs(dependency) Internal use only
- #fetch_specs(name_pattern, dependency) Internal use only
-
#find_reverse_dependencies(spec)
Internal use only
Returns an Array of [specification, dep] that are satisfied by
spec
. - #gem_dependency(pattern, version, prerelease) Internal use only
- #print_dependencies(spec, level = 0) Internal use only
- #remote_specs(dependency) Internal use only
- #reverse_dependencies(specs) Internal use only
- #usage Internal use only
::Gem::VersionOption
- Included
#add_platform_option | Add the –platform option to the option parser. |
#add_prerelease_option | Add the –prerelease option to the option parser. |
#add_version_option | Add the –version option to the option parser. |
::Gem::LocalRemoteOptions
- Included
#accept_uri_http | Allows OptionParser to handle HTTP URIs. |
#add_bulk_threshold_option | Add the –bulk-threshold option. |
#add_clear_sources_option | Add the –clear-sources option. |
#add_local_remote_options | Add local/remote options to the command line parser. |
#add_proxy_option | Add the –http-proxy option. |
#add_source_option | Add the –source option. |
#add_update_sources_option | Add the –update-sources option. |
::Gem::Command
- Inherited
#add_extra_args | Adds extra args from ~/.gemrc. |
#add_option | Add a command-line option and handler to the command. |
#arguments | Override to provide details of the arguments a command takes. |
#begins? | True if |
#check_deprecated_options, | |
#defaults_str | Override to display the default values of the command options. |
#deprecate_option | Mark a command-line option as deprecated, and optionally specify a deprecation horizon. |
#description | Override to display a longer description of what this command does. |
#execute | Override to provide command handling. |
#get_all_gem_names | Get all gem names from the command line. |
#get_all_gem_names_and_versions | Get all [gem, version] from the command line. |
#get_one_gem_name | Get a single gem name from the command line. |
#get_one_optional_argument | Get a single optional argument from the command line. |
#handle_options | Handle the given list of arguments by parsing them and recording the results. |
#handles? | True if the command handles the given argument list. |
#invoke | Invoke the command with the given list of arguments. |
#invoke_with_build_args | Invoke the command with the given list of normal arguments and additional build arguments. |
#merge_options | Merge a set of command options with the set of default options (without modifying the default option hash). |
#remove_option | Remove previously defined command-line argument |
#show_help | Display the help message for the command. |
#show_lookup_failure | Display to the user that a gem couldn’t be found and reasons why –. |
#usage | Override to display the usage for an individual gem command. |
#when_invoked | Call the given block when invoked. |
#add_parser_run_info | Adds a section with |
#configure_options, | |
#create_option_parser | Creates an option parser and fills it in with the help info for the command. |
#option_is_deprecated?, | |
#parser | Create on demand parser. |
#wrap | Wraps |
#add_parser_description, #add_parser_options, #add_parser_summary |
::Gem::UserInteraction
- Included
#alert | Displays an alert |
#alert_error | Displays an error |
#alert_warning | Displays a warning |
#ask | Asks a |
#ask_for_password | Asks for a password with a |
#ask_yes_no | Asks a yes or no |
#choose_from_list | Asks the user to answer |
#say | Displays the given |
#terminate_interaction | Terminates the RubyGems process with the given |
#verbose | Calls |
::Gem::DefaultUserInteraction
- Included
::Gem::Text
- Included
#clean_text | Remove any non-printable characters and make the text suitable for printing. |
#format_text | Wraps |
#levenshtein_distance | This code is based directly on the |
#truncate_text, #min3 |
Constructor Details
.new ⇒ DependencyCommand
# File 'lib/rubygems/commands/dependency_command.rb', line 11
def initialize super 'dependency', 'Show the dependencies of an installed gem', :version => Gem::Requirement.default, :domain => :local add_version_option add_platform_option add_prerelease_option add_option('-R', '--[no-]reverse-dependencies', 'Include reverse dependencies in the output') do |value, | [:reverse_dependencies] = value end add_option('-p', '--pipe', "Pipe Format (name --version ver)") do |value, | [:pipe_format] = value end end
Instance Method Details
#arguments
# File 'lib/rubygems/commands/dependency_command.rb', line 34
def arguments # :nodoc: "REGEXP show dependencies for gems whose names start with REGEXP" end
#defaults_str
# File 'lib/rubygems/commands/dependency_command.rb', line 38
def defaults_str # :nodoc: "--local --version '#{Gem::Requirement.default}' --no-reverse-dependencies" end
#description
# File 'lib/rubygems/commands/dependency_command.rb', line 42
def description # :nodoc: <<-EOF The dependency commands lists which other gems a given gem depends on. For local gems only the reverse dependencies can be shown (which gems depend on the named gem). The dependency list can be displayed in a format suitable for piping for use with other commands. EOF end
#display_pipe(specs)
# File 'lib/rubygems/commands/dependency_command.rb', line 92
def display_pipe(specs) # :nodoc: specs.each do |spec| unless spec.dependencies.empty? spec.dependencies.sort_by { |dep| dep.name }.each do |dep| say "#{dep.name} --version '#{dep.requirement}'" end end end end
#display_readable(specs, reverse)
# File 'lib/rubygems/commands/dependency_command.rb', line 102
def display_readable(specs, reverse) # :nodoc: response = String.new specs.each do |spec| response << print_dependencies(spec) unless reverse[spec.full_name].empty? response << " Used by\n" reverse[spec.full_name].each do |sp, dep| response << " #{sp} (#{dep})\n" end end response << "\n" end say response end
#ensure_local_only_reverse_dependencies
# File 'lib/rubygems/commands/dependency_command.rb', line 138
def ensure_local_only_reverse_dependencies # :nodoc: if [:reverse_dependencies] and remote? and not local? alert_error 'Only reverse dependencies for local gems are supported.' terminate_interaction 1 end end
#ensure_specs(specs)
# File 'lib/rubygems/commands/dependency_command.rb', line 145
def ensure_specs(specs) # :nodoc: return unless specs.empty? patterns = [:args].join ',' say "No gems found matching #{patterns} (#{ [:version]})" if Gem.configuration.verbose terminate_interaction 1 end
#execute
[ GitHub ]# File 'lib/rubygems/commands/dependency_command.rb', line 119
def execute ensure_local_only_reverse_dependencies pattern = name_pattern [:args] dependency = gem_dependency pattern, [:version], [:prerelease] specs = fetch_specs pattern, dependency reverse = reverse_dependencies specs if [:pipe_format] display_pipe specs else display_readable specs, reverse end end
#fetch_remote_specs(dependency)
# File 'lib/rubygems/commands/dependency_command.rb', line 57
def fetch_remote_specs(dependency) # :nodoc: fetcher = Gem::SpecFetcher.fetcher ss, = fetcher.spec_for_dependency dependency ss.map { |spec, _| spec } end
#fetch_specs(name_pattern, dependency)
# File 'lib/rubygems/commands/dependency_command.rb', line 65
def fetch_specs(name_pattern, dependency) # :nodoc: specs = [] if local? specs.concat Gem::Specification.stubs.find_all { |spec| name_pattern =~ spec.name and dependency.requirement.satisfied_by? spec.version }.map(&:to_spec) end specs.concat fetch_remote_specs dependency if remote? ensure_specs specs specs.uniq.sort end
#find_reverse_dependencies(spec)
Returns an Array of [specification, dep] that are satisfied by spec
.
# File 'lib/rubygems/commands/dependency_command.rb', line 189
def find_reverse_dependencies(spec) # :nodoc: result = [] Gem::Specification.each do |sp| sp.dependencies.each do |dep| dep = Gem::Dependency.new(*dep) unless Gem::Dependency === dep if spec.name == dep.name and dep.requirement.satisfied_by?(spec.version) result << [sp.full_name, dep] end end end result end
#gem_dependency(pattern, version, prerelease)
# File 'lib/rubygems/commands/dependency_command.rb', line 82
def gem_dependency(pattern, version, prerelease) # :nodoc: dependency = Gem::Deprecate.skip_during do Gem::Dependency.new pattern, version end dependency.prerelease = prerelease dependency end
#name_pattern(args) (private)
[ GitHub ]# File 'lib/rubygems/commands/dependency_command.rb', line 208
def name_pattern(args) args << '' if args.empty? if args.length == 1 and args.first =~ /\A(.*)(i)?\z/m flags = $2 ? Regexp::IGNORECASE : nil Regexp.new $1, flags else /\A#{Regexp.union(*args)}/ end end
#print_dependencies(spec, level = 0)
# File 'lib/rubygems/commands/dependency_command.rb', line 155
def print_dependencies(spec, level = 0) # :nodoc: response = String.new response << ' ' * level + "Gem #{spec.full_name}\n" unless spec.dependencies.empty? spec.dependencies.sort_by { |dep| dep.name }.each do |dep| response << ' ' * level + " #{dep}\n" end end response end
#remote_specs(dependency)
# File 'lib/rubygems/commands/dependency_command.rb', line 166
def remote_specs(dependency) # :nodoc: fetcher = Gem::SpecFetcher.fetcher ss, _ = fetcher.spec_for_dependency dependency ss.map { |s,o| s } end
#reverse_dependencies(specs)
# File 'lib/rubygems/commands/dependency_command.rb', line 174
def reverse_dependencies(specs) # :nodoc: reverse = Hash.new { |h, k| h[k] = [] } return reverse unless [:reverse_dependencies] specs.each do |spec| reverse[spec.full_name] = find_reverse_dependencies spec end reverse end
#usage
# File 'lib/rubygems/commands/dependency_command.rb', line 53
def usage # :nodoc: "#{program_name} REGEXP" end