123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::OpenCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Gem::Command
Instance Chain:
self, ::Gem::VersionOption, ::Gem::Command, ::Gem::UserInteraction, ::Gem::DefaultUserInteraction
Inherits: Gem::Command
Defined in: lib/rubygems/commands/open_command.rb

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::Command - Inherited

#defaults

The default options for the command.
#program_name

The name of the command for command-line invocation.
#summary

A short description of the command.
#command

The name of the command.
#options

The options for the command.

::Gem::DefaultUserInteraction - Included

#ui

See DefaultUserInteraction.ui
#ui=

See DefaultUserInteraction.ui=

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.

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

Override to display the default values of the command options.
#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.
#parser

Create on demand parser.
#wrap

Wraps text to width

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

Constructor Details

.new ⇒ OpenCommand

[ GitHub ] 

  


# File 'lib/rubygems/commands/open_command.rb', line 11



def initialize
  super 'open', 'Open gem sources in editor'

  add_option('-e', '--editor EDITOR', String,
             "Opens gem sources in EDITOR") do |editor, options|
    options[:editor] = editor || get_env_editor
  end
end


  







Instance Method Details



  

    #execute  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/open_command.rb', line 48



def execute
  @version = options[:version] || Gem::Requirement.default
  @editor  = options[:editor] || get_env_editor

  found = open_gem(get_one_gem_name)

  terminate_interaction 1 unless found
end


  








  

    #get_env_editor  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/open_command.rb', line 41



def get_env_editor
  ENV['GEM_EDITOR'] ||
    ENV['VISUAL'] ||
    ENV['EDITOR'] ||
    'vi'
end


  








  

    #open_editor(path)  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/open_command.rb', line 64



def open_editor path
  Dir.chdir(path) do
    system(*@editor.split(/\s+/) + [path])
  end
end


  








  

    #open_gem(name)  
  

  [ GitHub ]


  

  


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



def open_gem name
  spec = spec_for name
  return false unless spec

  open_editor(spec.full_gem_path)
end


  








  

    #spec_for(name)  
  

  [ GitHub ]


  

  


# File 'lib/rubygems/commands/open_command.rb', line 70



def spec_for name
  spec = Gem::Specification.find_all_by_name(name, @version).last

  return spec if spec

  say "Unable to find gem '#{name}'"
end