123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::DependencyCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: Gem::Command
Defined in: lib/rubygems/commands/dependency_command.rb

Constant Summary

::Gem::Command - Inherited

HELP

Class Attribute Summary

::Gem::Command - Inherited

.build_args

Arguments used when building gems.

.build_args=, .extra_args, .extra_args=

Class Method Summary

::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 command.

.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.

#deprecated?,
#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

::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.

#get_platform_from_requirements

Extract platform given on the command line.

::Gem::LocalRemoteOptions - Included

#accept_uri_http

Allows ::Gem::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 long begins with the characters from short.

#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 name.

#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 title and content to the parser help view.

#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 text to width

#extract_gem_name_and_version, #add_parser_description, #add_parser_options, #add_parser_summary

::Gem::UserInteraction - Included

#alert

Displays an alert statement.

#alert_error

Displays an error statement to the error output location.

#alert_warning

Displays a warning statement to the warning output location.

#ask

Asks a question and returns the answer.

#ask_for_password

Asks for a password with a prompt

#ask_yes_no

Asks a yes or no question.

#choose_from_list

Asks the user to answer question with an answer from the given list.

#say

Displays the given statement on the standard output (or equivalent).

#terminate_interaction

Terminates the RubyGems process with the given exit_code

#verbose

Calls say with msg or the results of the block if really_verbose is true.

::Gem::DefaultUserInteraction - Included

::Gem::Text - Included

#clean_text

Remove any non-printable characters and make the text suitable for printing.

#format_text

Wraps text to wrap characters and optionally indents by indent characters.

#levenshtein_distance

Returns a value representing the “cost” of transforming str1 into str2 Vendored version of DidYouMean::Levenshtein.distance from the ruby/did_you_mean gem @ 1.4.0 github.com/ruby/did_you_mean/blob/2ddf39b874808685965dbc47d344cf6c7651807c/lib/did_you_mean/levenshtein.rb#L7-L37.

#truncate_text, #min3

Constructor Details

.newDependencyCommand

[ GitHub ]

  
# 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, options|
    options[:reverse_dependencies] = value
  end

  add_option("-p", "--pipe",
             "Pipe Format (name --version ver)") do |value, options|
    options[:pipe_format] = value
  end

  add_local_remote_options
end

Instance Method Details

#arguments

This method is for internal use only.
[ GitHub ]

  
# 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

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 38

def defaults_str # :nodoc:
  "--local --version '#{Gem::Requirement.default}' --no-reverse-dependencies"
end

#description

This method is for internal use only.
[ GitHub ]

  
# 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)

This method is for internal use only.
[ GitHub ]

  
# 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)

This method is for internal use only.
[ GitHub ]

  
# 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

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 136

def ensure_local_only_reverse_dependencies # :nodoc:
  if options[:reverse_dependencies] && remote? && !local?
    alert_error "Only reverse dependencies for local gems are supported."
    terminate_interaction 1
  end
end

#ensure_specs(specs)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 143

def ensure_specs(specs) # :nodoc:
  return unless specs.empty?

  patterns = options[:args].join ","
  say "No gems found matching #{patterns} (#{options[: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 options[:args]
  requirement = Gem::Requirement.new options[:version]

  specs = fetch_specs pattern, requirement, options[:prerelease]

  reverse = reverse_dependencies specs

  if options[:pipe_format]
    display_pipe specs
  else
    display_readable specs, reverse
  end
end

#fetch_remote_specs(name, requirement, prerelease)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 57

def fetch_remote_specs(name, requirement, prerelease) # :nodoc:
  fetcher = Gem::SpecFetcher.fetcher

  specs_type = prerelease ? :complete : :released

  ss = if name.nil?
    fetcher.detect(specs_type) { true }
  else
    fetcher.detect(specs_type) do |name_tuple|
      name === name_tuple.name && requirement.satisfied_by?(name_tuple.version)
    end
  end

  ss.map {|tuple, source| source.fetch_spec(tuple) }
end

#fetch_specs(name_pattern, requirement, prerelease)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 73

def fetch_specs(name_pattern, requirement, prerelease) # :nodoc:
  specs = []

  if local?
    specs.concat Gem::Specification.stubs.find_all {|spec|
      name_matches = name_pattern ? name_pattern =~ spec.name : true
      version_matches = requirement.satisfied_by?(spec.version)

      name_matches && version_matches
    }.map(&:to_spec)
  end

  specs.concat fetch_remote_specs name_pattern, requirement, prerelease if remote?

  ensure_specs specs

  specs.uniq.sort
end

#find_reverse_dependencies(spec)

This method is for internal use only.

Returns an Array of [specification, dep] that are satisfied by spec.

[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 179

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 &&
         dep.requirement.satisfied_by?(spec.version)
        result << [sp.full_name, dep]
      end
    end
  end

  result
end

#name_pattern(args) (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 198

def name_pattern(args)
  return if args.empty?

  if args.length == 1 && args.first =~ /\A(.*)(i)?\z/m
    flags = $2 ? Regexp::IGNORECASE : nil
    Regexp.new $1, flags
  else
    /\A#{Regexp.union(*args)}/
  end
end

#reverse_dependencies(specs)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 164

def reverse_dependencies(specs) # :nodoc:
  reverse = Hash.new {|h, k| h[k] = [] }

  return reverse unless options[:reverse_dependencies]

  specs.each do |spec|
    reverse[spec.full_name] = find_reverse_dependencies spec
  end

  reverse
end

#usage

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/dependency_command.rb', line 53

def usage # :nodoc:
  "#{program_name} REGEXP"
end