Class: Gem::Commands::ContentsCommand

Inherits:
Gem::Command show all
Includes:
VersionOption
Defined in:
lib/rubygems/commands/contents_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 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 ⇒ ContentsCommand

Returns a new instance of ContentsCommand.



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

def initialize
  super 'contents', 'Display the contents of the installed gems',
        :specdirs => [], :lib_only => false, :prefix => true

  add_version_option

  add_option(      '--all',
             "Contents for all gems") do |all, options|
    options[:all] = all
  end

  add_option('-s', '--spec-dir a,b,c', Array,
             "Search for gems under specific paths") do |spec_dirs, options|
    options[:specdirs] = spec_dirs
  end

  add_option('-l', '--[no-]lib-only',
             "Only return files in the Gem's lib_dirs") do |lib_only, options|
    options[:lib_only] = lib_only
  end

  add_option(      '--[no-]prefix',
             "Don't include installed path prefix") do |prefix, options|
    options[:prefix] = prefix
  end
end

Instance Method Details

#arguments ⇒ Object

:nodoc:



35
36
37
 
# File 'lib/rubygems/commands/contents_command.rb', line 35

def arguments # :nodoc:
  "GEMNAME       name of gem to list contents for"
end

#defaults_str ⇒ Object

:nodoc:



39
40
41
 
# File 'lib/rubygems/commands/contents_command.rb', line 39

def defaults_str # :nodoc:
  "--no-lib-only --prefix"
end

#execute ⇒ Object 



47
48
49
50
51
52
53
54
55
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
 
# File 'lib/rubygems/commands/contents_command.rb', line 47

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

  spec_dirs = options[:specdirs].map do |i|
    [i, File.join(i, "specifications")]
  end.flatten

  path_kind = if spec_dirs.empty? then
                spec_dirs = Gem::Specification.dirs
                "default gem paths"
              else
                "specified path"
              end

  gem_names = if options[:all] then
                Gem::Specification.map(&:name)
              else
                get_all_gem_names
              end

  gem_names.each do |name|
    # HACK: find_by_name fails for some reason... ARGH
    # How many places must we embed our resolve logic?
    spec = Gem::Specification.find_all_by_name(name, version).last

    unless spec then
      say "Unable to find gem '#{name}' in #{path_kind}"

      if Gem.configuration.verbose then
        say "\nDirectories searched:"
        spec_dirs.each { |dir| say dir }
      end

      terminate_interaction 1 if gem_names.length == 1
    end

    gem_path = spec.full_gem_path
    extra    = "/{#{spec.require_paths.join ','}}" if options[:lib_only]
    glob     = "#{gem_path}#{extra}/**/*"
    files    = Dir[glob]

    gem_path = File.join gem_path, '' # add trailing / if missing

    files.sort.each do |file|
      next if File.directory? file

      file = file.sub gem_path, '' unless options[:prefix]

      say file
    end
  end
end

#usage ⇒ Object

:nodoc:



43
44
45
 
# File 'lib/rubygems/commands/contents_command.rb', line 43

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