123456789_123456789_123456789_123456789_123456789_

Class: Gem::Commands::BuildCommand

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
Instance Chain:
Inherits: Gem::Command
Defined in: lib/rubygems/commands/build_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::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::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

.newBuildCommand

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 10

def initialize
  super "build", "Build a gem from a gemspec"

  add_platform_option

  add_option "--force", "skip validation of the spec" do |value, options|
    options[:force] = true
  end

  add_option "--strict", "consider warnings as errors when validating the spec" do |value, options|
    options[:strict] = true
  end

  add_option "-o", "--output FILE", "output gem with the given filename" do |value, options|
    options[:output] = value
  end

  add_option "-C PATH", "Run as if gem build was started in <PATH> instead of the current working directory." do |value, options|
    options[:build_path] = value
  end
  deprecate_option "-C",
                   version: "4.0",
                   extra_msg: "-C is a global flag now. Use `gem -C PATH build GEMSPEC_FILE [options]` instead"
end

Instance Method Details

#arguments

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 35

def arguments # :nodoc:
  "GEMSPEC_FILE  gemspec file name to build a gem for"
end

#build_gem (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 89

def build_gem
  gemspec = resolve_gem_name

  if gemspec
    build_package(gemspec)
  else
    alert_error error_message
    terminate_interaction(1)
  end
end

#build_package(gemspec) (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 100

def build_package(gemspec)
  spec = Gem::Specification.load(gemspec)
  if spec
    Gem::Package.build(
      spec,
      options[:force],
      options[:strict],
      options[:output]
    )
  else
    alert_error "Error loading gemspec. Aborting."
    terminate_interaction 1
  end
end

#description

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 39

def description # :nodoc:
  <<-EOF
The build command allows you to create a gem from a ruby gemspec.

The best way to build a gem is to use a Rakefile and the Gem::PackageTask
which ships with RubyGems.

The gemspec can either be created by hand or extracted from an existing gem
with gem spec:

$ gem unpack my_gem-1.0.gem
Unpacked gem: '.../my_gem-1.0'
$ gem spec my_gem-1.0.gem --ruby > my_gem-1.0/my_gem-1.0.gemspec
$ cd my_gem-1.0
[edit gem contents]
$ gem build my_gem-1.0.gemspec

Gems can be saved to a specified filename with the output option:

$ gem build my_gem-1.0.gemspec --output=release.gem

  EOF
end

#error_message (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 125

def error_message
  if gem_name
    "Couldn't find a gemspec file matching '#{gem_name}' in #{Dir.pwd}"
  else
    "Couldn't find a gemspec file in #{Dir.pwd}"
  end
end

#execute

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 67

def execute
  if build_path = options[:build_path]
    Dir.chdir(build_path) { build_gem }
    return
  end

  build_gem
end

#find_gemspec(glob = "*.gemspec") (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 78

def find_gemspec(glob = "*.gemspec")
  gemspecs = Dir.glob(glob).sort

  if gemspecs.size > 1
    alert_error "Multiple gemspecs found: #{gemspecs}, please specify one"
    terminate_interaction(1)
  end

  gemspecs.first
end

#gem_name (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 133

def gem_name
  get_one_optional_argument
end

#resolve_gem_name (private)

[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 115

def resolve_gem_name
  return find_gemspec unless gem_name

  if File.exist?(gem_name)
    gem_name
  else
    find_gemspec("#{gem_name}.gemspec") || find_gemspec(gem_name)
  end
end

#usage

This method is for internal use only.
[ GitHub ]

  
# File 'lib/rubygems/commands/build_command.rb', line 63

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