Class: Gem::Commands::SpecificationCommand

Inherits:
Gem::Command show all
Includes:
LocalRemoteOptions, VersionOption
Defined in:
lib/rubygems/commands/specification_command.rb

Instance Attribute Summary

Attributes inherited from Gem::Command

#command, #defaults, #options, #program_name, #summary

Instance Method Summary collapse

Methods included from VersionOption

#add_platform_option, #add_prerelease_option, #add_version_option

Methods included from LocalRemoteOptions

#accept_uri_http, #add_bulk_threshold_option, #add_clear_sources_option, #add_local_remote_options, #add_proxy_option, #add_source_option, #add_update_sources_option, #both?, #local?, #remote?

Methods inherited from Gem::Command

add_common_option, #add_extra_args, #add_option, add_specific_extra_args, #begins?, build_args, build_args=, common_options, #description, extra_args, extra_args=, #get_all_gem_names, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #merge_options, #remove_option, #show_help, #show_lookup_failure, specific_extra_args, specific_extra_args_hash, #when_invoked

Methods included from UserInteraction

#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction

Methods included from DefaultUserInteraction

ui, #ui, ui=, #ui=, use_ui, #use_ui

Constructor Details

#initialize ⇒ SpecificationCommand

Returns a new instance of SpecificationCommand.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/rubygems/commands/specification_command.rb', line 11

def initialize
  Gem.load_yaml

  super 'specification', 'Display gem specification (in yaml)',
        :domain => :local, :version => Gem::Requirement.default,
        :format => :yaml

  add_version_option('examine')
  add_platform_option

  add_option('--all', 'Output specifications for all versions of',
             'the gem') do |value, options|
    options[:all] = true
  end

  add_option('--ruby', 'Output ruby format') do |value, options|
    options[:format] = :ruby
  end

  add_option('--yaml', 'Output RUBY format') do |value, options|
    options[:format] = :yaml
  end

  add_option('--marshal', 'Output Marshal format') do |value, options|
    options[:format] = :marshal
  end

  add_local_remote_options
end

Instance Method Details

#arguments ⇒ Object

:nodoc:



41
42
43
44
45
46
 
# File 'lib/rubygems/commands/specification_command.rb', line 41

def arguments # :nodoc:
  <<-ARGS
GEMFILE       name of gem to show the gemspec for
FIELD         name of gemspec field to show
  ARGS
end

#defaults_str ⇒ Object

:nodoc:



48
49
50
 
# File 'lib/rubygems/commands/specification_command.rb', line 48

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

#execute ⇒ Object

Raises:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/rubygems/commands/specification_command.rb', line 56

def execute
  specs = []
  gem = options[:args].shift

  unless gem then
    raise Gem::CommandLineError,
          "Please specify a gem name or file on the command line"
  end

  case options[:version]
  when String
    req = Gem::Requirement.parse options[:version]
  when Gem::Requirement
    req = options[:version]
  else
    raise Gem::CommandLineError, "Unsupported version type: #{options[:version]}"
  end

  if !req.none? and options[:all]
    alert_error "Specify --all or -v, not both"
    terminate_interaction 1
  end

  if options[:all]
    dep = Gem::Dependency.new gem
  else
    dep = Gem::Dependency.new gem, options[:version]
  end

  field = get_one_optional_argument

  raise Gem::CommandLineError, "--ruby and FIELD are mutually exclusive" if
    field and options[:format] == :ruby

  if local? then
    if File.exist? gem then
      specs << Gem::Format.from_file_by_path(gem).spec rescue nil
    end

    if specs.empty? then
      specs.push(*dep.matching_specs)
    end
  end

  if remote? then
    found = Gem::SpecFetcher.fetcher.fetch dep, true

    if dep.prerelease? or options[:prerelease]
      found += Gem::SpecFetcher.fetcher.fetch dep, false, true, true
    end

    specs.push(*found.map { |spec,| spec })
  end

  if specs.empty? then
    alert_error "Unknown gem '#{gem}'"
    terminate_interaction 1
  end

  unless options[:all] then
    specs = [specs.sort_by { |s| s.version }.last]
  end

  specs.each do |s|
    s = s.send field if field

    say case options[:format]
        when :ruby then s.to_ruby
        when :marshal then Marshal.dump s
        else s.to_yaml
        end

    say "\n"
  end
end

#usage ⇒ Object

:nodoc:



52
53
54
 
# File 'lib/rubygems/commands/specification_command.rb', line 52

def usage # :nodoc:
  "#{program_name} [GEMFILE] [FIELD]"
end