Module: Gem::QueryUtils
| Relationships & Source Files | |
| Extension / Inclusion / Inheritance Descendants | |
|
Included In:
| |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Instance Chain:
|
|
| Defined in: | lib/rubygems/query_utils.rb |
Instance Attribute Summary
- #check_installed_gems? ⇒ Boolean readonly private
- #gem_name? ⇒ Boolean readonly private
- #show_prereleases? ⇒ Boolean readonly private
LocalRemoteOptions - Included
Instance Method Summary
- #add_query_options
- #execute
- #args private
- #check_installed_gems(gem_names) readonly private
- #display_header(type) private
- #entry_details(entry, detail_tuple, specs, platforms, platform_ruby_abis) private
- #entry_versions(entry, name_tuples, platforms, platform_ruby_abis, specs) private
-
#installed?(name, req = Gem::Requirement.default) ⇒ Boolean
private
Check if gem
nameversionversionis installed. - #make_entry(entry_tuples, platforms, platform_ruby_abis) private
- #output_query_results(spec_tuples) private
- #output_versions(output, versions) private
- #prerelease private
- #ruby_abi_metadata?(platform_ruby_abis) ⇒ Boolean private
-
#show_gems(name)
private
Guts of original execute.
- #show_local_gems(name, req = Gem::Requirement.default) private
- #show_remote_gems(name) private
- #spec_authors(entry, spec) private
- #spec_homepage(entry, spec) private
- #spec_license(entry, spec) private
- #spec_loaded_from(entry, spec, specs) private
- #spec_platform_ruby_abis(entry, platforms, platform_ruby_abis) private
- #spec_platforms(entry, platforms) private
- #spec_summary(entry, spec) private
- #specs_type private
- #version_label(version, specs) private
- #version_platform_labels(version, platforms, platform_ruby_abis, label_platform: false) private
- #defaults_str Internal use only
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_ruby_abi_option | Add the --ruby-abi 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. |
LocalRemoteOptions - Included
| #accept_uri_http | Allows |
| #add_bulk_threshold_option | Add the --bulk-threshold option. |
| #add_clear_sources_option | Add the --clear-sources option. |
| #add_local_remote_options | Add local/remote options to the command line parser. |
| #add_proxy_option | Add the --http-proxy option. |
| #add_source_option | Add the --source option. |
| #add_update_sources_option | Add the --update-sources option. |
Text - Included
| #clean_text | Remove any non-printable characters and make the text suitable for printing. |
| #format_text | Wraps |
| #levenshtein_distance | Returns a value representing the "cost" of transforming str1 into str2 Vendored version of |
| #truncate_text, #min3 | |
Instance Attribute Details
#check_installed_gems? ⇒ Boolean (readonly, private)
[ GitHub ]
# File 'lib/rubygems/query_utils.rb', line 93
def check_installed_gems? ![:installed].nil? end
#gem_name? ⇒ Boolean (readonly, private)
[ GitHub ]
# File 'lib/rubygems/query_utils.rb', line 97
def gem_name? ![:name].nil? end
#show_prereleases? ⇒ Boolean (readonly, private)
[ GitHub ]
# File 'lib/rubygems/query_utils.rb', line 105
def show_prereleases? prerelease.nil? || prerelease end
Instance Method Details
#add_query_options
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 13
def add_option("-i", "--[no-]installed", "Check for installed gem") do |value, | [:installed] = value end add_option("-I", "Equivalent to --no-installed") do |_value, | [:installed] = false end add_version_option command, "for use with --installed" add_option("-d", "--[no-]details", "Display detailed information of gem(s)") do |value, | [:details] = value end add_option("--[no-]versions", "Display only gem names") do |value, | [:versions] = value [:details] = false unless value end add_option("-a", "--all", "Display all gem versions") do |value, | [:all] = value end add_option("-e", "--exact", "Name of gem(s) to query on matches the", "provided STRING") do |value, | [:exact] = value end add_option("--[no-]prerelease", "Display prerelease versions") do |value, | [:prerelease] = value end end
#args (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 109
def args [:args].to_a end
#check_installed_gems(gem_names) (readonly, private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 73
def check_installed_gems(gem_names) exit_code = 0 if args.empty? && !gem_name? alert_error "You must specify a gem name" exit_code = 4 elsif gem_names.count > 1 alert_error "You must specify only ONE gem!" exit_code = 4 else installed = installed?(gem_names.first, [:version]) installed = !installed unless [:installed] say(installed) exit_code = 1 unless installed end exit_code end
#defaults_str
# File 'lib/rubygems/query_utils.rb', line 55
def defaults_str # :nodoc: "--local --no-details --versions --no-installed" end
#display_header(type) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 113
def display_header(type) if (ui.outs.tty? && Gem.configuration.verbose) || both? say say "*** #{type} GEMS ***" say end end
#entry_details(entry, detail_tuple, specs, platforms, platform_ruby_abis) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 231
def entry_details(entry, detail_tuple, specs, platforms, platform_ruby_abis) return unless [:details] name_tuple, spec = detail_tuple spec = spec.fetch_spec(name_tuple)if spec.respond_to?(:fetch_spec) entry << "\n" if (platform_ruby_abis) spec_platform_ruby_abis entry, platforms, platform_ruby_abis else spec_platforms entry, platforms end entry, spec spec_homepage entry, spec spec_license entry, spec spec_loaded_from entry, spec, specs spec_summary entry, spec end
#entry_versions(entry, name_tuples, platforms, platform_ruby_abis, specs) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 252
def entry_versions(entry, name_tuples, platforms, platform_ruby_abis, specs) return unless [:versions] list = if platforms.empty? || [:details] name_tuples.map(&:version).uniq elsif (platform_ruby_abis) platforms.sort.reverse.flat_map do |version, pls| out = version_label(version, specs) labels = version_platform_labels(version, pls, platform_ruby_abis, label_platform: true) labels.empty? ? [out] : labels.map {|label| "#{out} #{label}" } end else platforms.sort.reverse.map do |version, pls| out = version_label(version, specs) labels = version_platform_labels(version, pls, platform_ruby_abis) labels.empty? ? out : "#{out} #{labels.join(" ")}" end end use_multiline_separator = ![:details] && (platform_ruby_abis) && list.length > 1 separator = use_multiline_separator ? "\n#{" " * (entry.first.length + 2)}" : ", " entry << " (#{list.join separator})" end
#execute
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 59
def execute gem_names = if args.empty? [[:name]] else [:exact] ? args.map {|arg| /\A#{Regexp.escape(arg)}\Z/ } : args.map {|arg| /#{arg}/i } end terminate_interaction(check_installed_gems(gem_names)) if check_installed_gems? gem_names.each {|n| show_gems(n) } end
#installed?(name, req = Gem::Requirement.default) ⇒ Boolean (private)
Check if gem name version version is installed.
# File 'lib/rubygems/query_utils.rb', line 183
def installed?(name, req = Gem::Requirement.default) Gem::Specification.any? {|s| s.name =~ name && req =~ s.version } end
#make_entry(entry_tuples, platforms, platform_ruby_abis) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 308
def make_entry(entry_tuples, platforms, platform_ruby_abis) detail_tuple = entry_tuples.first name_tuples, specs = entry_tuples.flatten.partition do |item| Gem::NameTuple === item end entry = [name_tuples.first.name] entry_versions(entry, name_tuples, platforms, platform_ruby_abis, specs) entry_details(entry, detail_tuple, specs, platforms, platform_ruby_abis) entry.join end
#output_query_results(spec_tuples) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 187
def output_query_results(spec_tuples) output = [] versions = Hash.new {|h,name| h[name] = [] } spec_tuples.each do |spec_tuple, source| versions[spec_tuple.name] << [spec_tuple, source] end versions = versions.sort_by do |(n,_),_| n.downcase end output_versions output, versions say output.join([:details] ? "\n\n" : "\n") end
#output_versions(output, versions) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 204
def output_versions(output, versions) versions.each do |_gem_name, matching_tuples| matching_tuples = matching_tuples.sort_by {|n,_| n.version }.reverse platforms = Hash.new {|h,version| h[version] = [] } platform_ruby_abis = Hash.new {|h,version| h[version] = Hash.new {|hh,platform| hh[platform] = [] } } matching_tuples.each do |n, _| platforms[n.version] << n.platform if n.platform platform_ruby_abis[n.version][n.platform] << n.ruby_abi if n.ruby_abi end seen = {} matching_tuples.delete_if do |n,_| if seen[n.version] true else seen[n.version] = true false end end output << clean_text(make_entry(matching_tuples, platforms, platform_ruby_abis)) end end
#prerelease (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 101
def prerelease [:prerelease] end
#ruby_abi_metadata?(platform_ruby_abis) ⇒ Boolean (private)
# File 'lib/rubygems/query_utils.rb', line 287
def (platform_ruby_abis) platform_ruby_abis.values.any? do |ruby_abis_by_platform| ruby_abis_by_platform.values.any?(&:any?) end end
#show_gems(name) (private)
Guts of original execute
# File 'lib/rubygems/query_utils.rb', line 122
def show_gems(name) show_local_gems(name) if local? show_remote_gems(name) if remote? end
#show_local_gems(name, req = Gem::Requirement.default) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 127
def show_local_gems(name, req = Gem::Requirement.default) display_header("LOCAL") specs = Gem::Specification.find_all do |s| name_matches = name ? s.name =~ name : true version_matches = show_prereleases? || !s.version.prerelease? name_matches && version_matches end.uniq(&:full_name) spec_tuples = specs.map do |spec| [spec.name_tuple, spec] end output_query_results(spec_tuples) end
#show_remote_gems(name) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 144
def show_remote_gems(name) display_header("REMOTE") fetcher = Gem::SpecFetcher.fetcher spec_tuples = if name.nil? fetcher.detect(specs_type) { true } else matching_tuples = fetcher.detect(specs_type) do |name_tuple| name === name_tuple.name && [:version].satisfied_by?(name_tuple.version) end if args.empty? matching_tuples else fetcher.decode_content_addressable_tuples(matching_tuples, latest: specs_type == :latest) end end output_query_results(spec_tuples) end
#spec_authors(entry, spec) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 323
def (entry, spec) = "Author#{spec..length > 1 ? "s" : ""}: ".dup << spec..join(", ") entry << format_text(, 68, 4) end
#spec_homepage(entry, spec) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 329
def spec_homepage(entry, spec) return if spec.homepage.nil? || spec.homepage.empty? entry << "\n" << format_text("Homepage: #{spec.homepage}", 68, 4) end
#spec_license(entry, spec) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 335
def spec_license(entry, spec) return if spec.license.nil? || spec.license.empty? licenses = "License#{spec.licenses.length > 1 ? "s" : ""}: ".dup licenses << spec.licenses.join(", ") entry << "\n" << format_text(licenses, 68, 4) end
#spec_loaded_from(entry, spec, specs) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 343
def spec_loaded_from(entry, spec, specs) return unless spec.loaded_from if specs.length == 1 default = spec.default_gem? ? " (default)" : nil entry << "\n" << " Installed at#{default}: #{spec.base_dir}" else label = "Installed at" specs.each do |s| version = s.version.to_s default = s.default_gem? ? ", default" : "" entry << "\n" << " #{label} (#{version}#{default}): #{s.base_dir}" label = " " * label.length end end end
#spec_platform_ruby_abis(entry, platforms, platform_ruby_abis) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 385
def spec_platform_ruby_abis(entry, platforms, platform_ruby_abis) entry << " Platforms:\n" platforms.sort.each do |version, pls| labels = version_platform_labels(version, pls, platform_ruby_abis) next if labels.empty? if platforms.length == 1 labels.each do |label| entry << " #{label}\n" end else label = " #{version}: " data = format_text labels.join(", "), 68, label.length data[0, label.length] = label entry << data << "\n" end end end
#spec_platforms(entry, platforms) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 360
def spec_platforms(entry, platforms) platforms = platforms.transform_values(&:uniq) non_ruby = platforms.any? do |_, pls| pls.any? {|pl| pl != Gem::Platform::RUBY } end return unless non_ruby if platforms.length == 1 title = platforms.values.first.length == 1 ? "Platform" : "Platforms" entry << " #{title}: #{platforms.values.sort.join(", ")}\n" else entry << " Platforms:\n" sorted_platforms = platforms.sort sorted_platforms.each do |version, pls| label = " #{version}: " data = format_text pls.sort.join(", "), 68, label.length data[0, label.length] = label entry << data << "\n" end end end
#spec_summary(entry, spec) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 405
def spec_summary(entry, spec) summary = truncate_text(spec.summary, "the summary for #{spec.full_name}") entry << "\n\n" << format_text(summary, 68, 4) end
#specs_type (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 166
def specs_type if [:all] || [:version].specific? if [:prerelease] :complete else :released end elsif [:prerelease] :prerelease else :latest end end
#version_label(version, specs) (private)
[ GitHub ]#version_platform_labels(version, platforms, platform_ruby_abis, label_platform: false) (private)
[ GitHub ]# File 'lib/rubygems/query_utils.rb', line 293
def version_platform_labels(version, platforms, platform_ruby_abis, label_platform: false) platforms = platforms.uniq return [] if platforms == [Gem::Platform::RUBY] platforms = [platforms.delete(Gem::Platform::RUBY), *platforms.sort].compact platforms.map do |platform| ruby_abis = platform_ruby_abis[version][platform].uniq.sort platform_label = label_platform ? "Platform: #{platform}" : platform next platform_label if ruby_abis.empty? separator = label_platform ? ", " : " " "#{platform_label}#{separator}Ruby ABI: #{ruby_abis.join(", ")}" end end