Class: Gem::Commands::DependencyCommand

Inherits:
Gem::Command show all
Includes:
LocalRemoteOptions, VersionOption
Defined in:
lib/rubygems/commands/dependency_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=, #check_deprecated_options, common_options, #deprecate_option, extra_args, extra_args=, #get_all_gem_names, #get_all_gem_names_and_versions, #get_one_gem_name, #get_one_optional_argument, #handle_options, #handles?, #invoke, #invoke_with_build_args, #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, #verbose

Methods included from DefaultUserInteraction

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

Methods included from Text

#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text

Constructor Details

#initializeDependencyCommand

Returns a new instance of DependencyCommand.


11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# File 'lib/rubygems/commands/dependency_command.rb', line 11

def initialize
  super 'dependency',
        'Show the dependencies of an installed gem',
        :version => Gem::Requirement.default, :domain => :local

  add_version_option
  add_platform_option
  add_prerelease_option

  add_option('-R', '--[no-]reverse-dependencies',
             'Include reverse dependencies in the output') do
    |value, options|
    options[:reverse_dependencies] = value
  end

  add_option('-p', '--pipe',
             "Pipe Format (name --version ver)") do |value, options|
    options[:pipe_format] = value
  end

  add_local_remote_options
end

Instance Method Details

#argumentsObject

:nodoc:


34
35
36
# File 'lib/rubygems/commands/dependency_command.rb', line 34

def arguments # :nodoc:
  "REGEXP        show dependencies for gems whose names start with REGEXP"
end

#defaults_strObject

:nodoc:


38
39
40
# File 'lib/rubygems/commands/dependency_command.rb', line 38

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

#descriptionObject

:nodoc:


42
43
44
45
46
47
48
49
50
51
# File 'lib/rubygems/commands/dependency_command.rb', line 42

def description # :nodoc:
  <<-EOF
The dependency commands lists which other gems a given gem depends on.  For
local gems only the reverse dependencies can be shown (which gems depend on
the named gem).

The dependency list can be displayed in a format suitable for piping for
use with other commands.
  EOF
end

#display_pipe(specs) ⇒ Object

:nodoc:


92
93
94
95
96
97
98
99
100
# File 'lib/rubygems/commands/dependency_command.rb', line 92

def display_pipe(specs) # :nodoc:
  specs.each do |spec|
    unless spec.dependencies.empty?
      spec.dependencies.sort_by { |dep| dep.name }.each do |dep|
        say "#{dep.name} --version '#{dep.requirement}'"
      end
    end
  end
end

#display_readable(specs, reverse) ⇒ Object

:nodoc:


102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/rubygems/commands/dependency_command.rb', line 102

def display_readable(specs, reverse) # :nodoc:
  response = String.new

  specs.each do |spec|
    response << print_dependencies(spec)
    unless reverse[spec.full_name].empty?
      response << "  Used by\n"
      reverse[spec.full_name].each do |sp, dep|
        response << "    #{sp} (#{dep})\n"
      end
    end
    response << "\n"
  end

  say response
end

#ensure_local_only_reverse_dependenciesObject

:nodoc:


138
139
140
141
142
143
# File 'lib/rubygems/commands/dependency_command.rb', line 138

def ensure_local_only_reverse_dependencies # :nodoc:
  if options[:reverse_dependencies] and remote? and not local?
    alert_error 'Only reverse dependencies for local gems are supported.'
    terminate_interaction 1
  end
end

#ensure_specs(specs) ⇒ Object

:nodoc:


145
146
147
148
149
150
151
152
153
# File 'lib/rubygems/commands/dependency_command.rb', line 145

def ensure_specs(specs) # :nodoc:
  return unless specs.empty?

  patterns = options[:args].join ','
  say "No gems found matching #{patterns} (#{options[:version]})" if
    Gem.configuration.verbose

  terminate_interaction 1
end

#executeObject


119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/rubygems/commands/dependency_command.rb', line 119

def execute
  ensure_local_only_reverse_dependencies

  pattern = name_pattern options[:args]

  dependency =
    gem_dependency pattern, options[:version], options[:prerelease]

  specs = fetch_specs pattern, dependency

  reverse = reverse_dependencies specs

  if options[:pipe_format]
    display_pipe specs
  else
    display_readable specs, reverse
  end
end

#fetch_remote_specs(dependency) ⇒ Object

:nodoc:


57
58
59
60
61
62
63
# File 'lib/rubygems/commands/dependency_command.rb', line 57

def fetch_remote_specs(dependency) # :nodoc:
  fetcher = Gem::SpecFetcher.fetcher

  ss, = fetcher.spec_for_dependency dependency

  ss.map { |spec, _| spec }
end

#fetch_specs(name_pattern, dependency) ⇒ Object

:nodoc:


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/rubygems/commands/dependency_command.rb', line 65

def fetch_specs(name_pattern, dependency) # :nodoc:
  specs = []

  if local?
    specs.concat Gem::Specification.stubs.find_all { |spec|
      name_pattern =~ spec.name and
        dependency.requirement.satisfied_by? spec.version
    }.map(&:to_spec)
  end

  specs.concat fetch_remote_specs dependency if remote?

  ensure_specs specs

  specs.uniq.sort
end

#find_reverse_dependencies(spec) ⇒ Object

Returns an Array of [specification, dep] that are satisfied by spec.


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# File 'lib/rubygems/commands/dependency_command.rb', line 189

def find_reverse_dependencies(spec) # :nodoc:
  result = []

  Gem::Specification.each do |sp|
    sp.dependencies.each do |dep|
      dep = Gem::Dependency.new(*dep) unless Gem::Dependency === dep

      if spec.name == dep.name and
         dep.requirement.satisfied_by?(spec.version)
        result << [sp.full_name, dep]
      end
    end
  end

  result
end

#gem_dependency(pattern, version, prerelease) ⇒ Object

:nodoc:


82
83
84
85
86
87
88
89
90
# File 'lib/rubygems/commands/dependency_command.rb', line 82

def gem_dependency(pattern, version, prerelease) # :nodoc:
  dependency = Gem::Deprecate.skip_during do
    Gem::Dependency.new pattern, version
  end

  dependency.prerelease = prerelease

  dependency
end

:nodoc:


155
156
157
158
159
160
161
162
163
164
# File 'lib/rubygems/commands/dependency_command.rb', line 155

def print_dependencies(spec, level = 0) # :nodoc:
  response = String.new
  response << '  ' * level + "Gem #{spec.full_name}\n"
  unless spec.dependencies.empty?
    spec.dependencies.sort_by { |dep| dep.name }.each do |dep|
      response << '  ' * level + "  #{dep}\n"
    end
  end
  response
end

#remote_specs(dependency) ⇒ Object

:nodoc:


166
167
168
169
170
171
172
# File 'lib/rubygems/commands/dependency_command.rb', line 166

def remote_specs(dependency) # :nodoc:
  fetcher = Gem::SpecFetcher.fetcher

  ss, _ = fetcher.spec_for_dependency dependency

  ss.map { |s,o| s }
end

#reverse_dependencies(specs) ⇒ Object

:nodoc:


174
175
176
177
178
179
180
181
182
183
184
# File 'lib/rubygems/commands/dependency_command.rb', line 174

def reverse_dependencies(specs) # :nodoc:
  reverse = Hash.new { |h, k| h[k] = [] }

  return reverse unless options[:reverse_dependencies]

  specs.each do |spec|
    reverse[spec.full_name] = find_reverse_dependencies spec
  end

  reverse
end

#usageObject

:nodoc:


53
54
55
# File 'lib/rubygems/commands/dependency_command.rb', line 53

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