Class: Gem::Commands::WhichCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::Gem::Command`
Instance Chain: self, `::Gem::Command`, `::Gem::UserInteraction`, `::Gem::DefaultUserInteraction`, `::Gem::Text`
Inherits:	Gem::Command Object Gem::Command Gem::Commands::WhichCommand
Defined in:	lib/rubygems/commands/which_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

.new ⇒ WhichCommand 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 `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::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

#ui	See DefaultUserInteraction.ui
#ui=	See DefaultUserInteraction.ui=

Instance Method Summary

#execute
#find_paths(package_name, dirs)
#arguments Internal use only
#defaults_str Internal use only
#description Internal use only
#usage Internal use only

`::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`
#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

#use_ui

See DefaultUserInteraction.use_ui

`::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 git.io/JJgZI.
#truncate_text, #min3

Constructor Details

.new ⇒ `WhichCommand`

[ GitHub ]

# File 'lib/rubygems/commands/which_command.rb', line 5


def initialize
  super "which", "Find the location of a library file you can require",
        :search_gems_first => false, :show_all => false

  add_option "-a", "--[no-]all", "show all matching files" do |show_all, options|
    options[:show_all] = show_all
  end

  add_option "-g", "--[no-]gems-first",
             "search gems before non-gems" do |gems_first, options|
    options[:search_gems_first] = gems_first
  end
end

Instance Method Details

#arguments

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/which_command.rb', line 19


def arguments # :nodoc:
  "FILE          name of file to find"
end

#defaults_str

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/which_command.rb', line 23


def defaults_str # :nodoc:
  "--no-gems-first --no-all"
end

#description

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/which_command.rb', line 27


def description # :nodoc:
  <<-EOF
The which command is like the shell which command and shows you where
the file you wish to require lives.

You can use the which command to help determine why you are requiring a
version you did not expect or to look at the content of a file you are
requiring to see why it does not behave as you expect.
  EOF
end

#execute

[ GitHub ]

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


def execute
  found = true

  options[:args].each do |arg|
    arg = arg.sub(/#{Regexp.union(*Gem.suffixes)}$/, "")
    dirs = $LOAD_PATH

    spec = Gem::Specification.find_by_path arg

    if spec
      if options[:search_gems_first]
        dirs = spec.full_require_paths + $LOAD_PATH
      else
        dirs = $LOAD_PATH + spec.full_require_paths
      end
    end

    paths = find_paths arg, dirs

    if paths.empty?
      alert_error "Can't find Ruby library file or shared library #{arg}"
      found = false
    else
      say paths
    end
  end

  terminate_interaction 1 unless found
end

#find_paths(package_name, dirs)

[ GitHub ]

# File 'lib/rubygems/commands/which_command.rb', line 68


def find_paths(package_name, dirs)
  result = []

  dirs.each do |dir|
    Gem.suffixes.each do |ext|
      full_path = File.join dir, "#{package_name}#{ext}"
      if File.exist?(full_path) && !File.directory?(full_path)
        result << full_path
        return result unless options[:show_all]
      end
    end
  end

  result
end

#usage

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/which_command.rb', line 84


def usage # :nodoc:
  "#{program_name} FILE [FILE ...]"
end

Class: Gem::Commands::WhichCommand

Constant Summary

::Gem::Command - Inherited

Class Attribute Summary

::Gem::Command - Inherited

Class Method Summary

::Gem::Command - Inherited

Instance Attribute Summary

::Gem::Command - Inherited

::Gem::DefaultUserInteraction - Included

Instance Method Summary

::Gem::Command - Inherited

::Gem::UserInteraction - Included

::Gem::DefaultUserInteraction - Included

::Gem::Text - Included

Constructor Details

.new ⇒ WhichCommand

Instance Method Details

#arguments

#defaults_str

#description

#execute

#find_paths(package_name, dirs)

#usage

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::Command` - Inherited

`::Gem::DefaultUserInteraction` - Included

`::Gem::Command` - Inherited

`::Gem::UserInteraction` - Included

`::Gem::DefaultUserInteraction` - Included

`::Gem::Text` - Included

.new ⇒ `WhichCommand`