Class: Gem::Commands::LockCommand

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::LockCommand
Defined in:	lib/rubygems/commands/lock_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 ⇒ LockCommand 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

#complain(message)
#execute
#spec_path(gem_full_name)
#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	This code is based directly on the `::Gem::Text` gem implementation Returns a value representing the “cost” of transforming str1 into str2.
#truncate_text, #min3

Constructor Details

.new ⇒ `LockCommand`

[ GitHub ]

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


def initialize
  super 'lock', 'Generate a lockdown list of gems',
        :strict => false

  add_option '-s', '--[no-]strict',
             'fail if unable to satisfy a dependency' do |strict, options|
    options[:strict] = strict
  end
end

Instance Method Details

#arguments

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/lock_command.rb', line 15


def arguments # :nodoc:
  "GEMNAME       name of gem to lock\nVERSION       version of gem to lock"
end

#complain(message)

[ GitHub ]

# File 'lib/rubygems/commands/lock_command.rb', line 60


def complain(message)
  if options[:strict]
    raise Gem::Exception, message
  else
    say "# #{message}"
  end
end

#defaults_str

This method is for internal use only.

[ GitHub ]

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


def defaults_str # :nodoc:
  "--no-strict"
end

#description

This method is for internal use only.

[ GitHub ]

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


def description # :nodoc:
  <<-EOF
The lock command will generate a list of gem statements that will lock down
the versions for the gem given in the command line.  It will specify exact
versions in the requirements list to ensure that the gems loaded will always
be consistent.  A full recursive search of all effected gems will be
generated.

Example:

gem lock rails-1.0.0 > lockdown.rb

will produce in lockdown.rb:

require "rubygems"
gem 'rails', '= 1.0.0'
gem 'rake', '= 0.7.0.1'
gem 'activesupport', '= 1.2.5'
gem 'activerecord', '= 1.13.2'
gem 'actionpack', '= 1.11.2'
gem 'actionmailer', '= 1.1.5'
gem 'actionwebservice', '= 1.0.0'

Just load lockdown.rb from your application to ensure that the current
versions are loaded.  Make sure that lockdown.rb is loaded *before* any
other require statements.

Notice that rails 1.0.0 only requires that rake 0.6.2 or better be used.
Rake-0.7.0.1 is the most recent version installed that satisfies that, so we
lock it down to the exact version.
  EOF
end

#execute

[ GitHub ]

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


def execute
  say "require 'rubygems'"

  locked = {}

  pending = options[:args]

  until pending.empty? do
    full_name = pending.shift

    spec = Gem::Specification.load spec_path(full_name)

    if spec.nil?
      complain "Could not find gem #{full_name}, try using the full name"
      next
    end

    say "gem '#{spec.name}', '= #{spec.version}'" unless locked[spec.name]
    locked[spec.name] = true

    spec.runtime_dependencies.each do |dep|
      next if locked[dep.name]
      candidates = dep.matching_specs

      if candidates.empty?
        complain "Unable to satisfy '#{dep}' from currently installed gems"
      else
        pending << candidates.last.full_name
      end
    end
  end
end

#spec_path(gem_full_name)

[ GitHub ]

# File 'lib/rubygems/commands/lock_command.rb', line 101


def spec_path(gem_full_name)
  gemspecs = Gem.path.map do |path|
    File.join path, "specifications", "#{gem_full_name}.gemspec"
  end

  gemspecs.find {|path| File.exist? path }
end

#usage

This method is for internal use only.

[ GitHub ]

# File 'lib/rubygems/commands/lock_command.rb', line 56


def usage # :nodoc:
  "#{program_name} GEMNAME-VERSION [GEMNAME-VERSION ...]"
end

Class: Gem::Commands::LockCommand

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 ⇒ LockCommand

Instance Method Details

#arguments

#complain(message)

#defaults_str

#description

#execute

#spec_path(gem_full_name)

#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 ⇒ `LockCommand`