Parent

Included Modules

Class/Module Index [+]

Quicksearch

Gem::SourceIndex

The SourceIndex object indexes all the gems available from a particular source (e.g. a list of gem directories, or a remote source). A SourceIndex maps a gem full name to a gem specification.

NOTE

The class used to be named Cache, but that became confusing when cached source fetchers where introduced. The constant Gem::Cache is an alias for this class to allow old YAMLized source index objects to load properly.

Attributes

spec_dirs[RW]

Directories to use to refresh this SourceIndex when calling refresh!

Public Class Methods

from_gems_in(*spec_dirs) click to toggle source

Creates a new SourceIndex from the ruby format gem specifications in spec_dirs.

# File lib/yard/rubygems/backports/source_index.rb, line 81
def from_gems_in(*spec_dirs)
  source_index = new
  source_index.spec_dirs = spec_dirs
  source_index.refresh!
end
from_installed_gems(*deprecated) click to toggle source

Factory method to construct a source index instance for a given path.

deprecated

If supplied, from_installed_gems will act just like from_gems_in. This argument is deprecated and is provided just for backwards compatibility, and should not generally be used.

return

SourceIndex instance

# File lib/yard/rubygems/backports/source_index.rb, line 62
def from_installed_gems(*deprecated)
  if deprecated.empty?
    from_gems_in(*installed_spec_directories)
  else
    from_gems_in(*deprecated) # HACK warn
  end
end
installed_spec_directories() click to toggle source

Returns a list of directories from Gem.path that contain specifications.

# File lib/yard/rubygems/backports/source_index.rb, line 73
def installed_spec_directories
  Gem.path.collect { |dir| File.join(dir, "specifications") }
end
load_specification(file_name) click to toggle source

Loads a ruby-format specification from file_name and returns the loaded spec.

# File lib/yard/rubygems/backports/source_index.rb, line 91
def load_specification(file_name)
  Gem::Specification.load file_name
end
new(specifications={}) click to toggle source

Constructs a source index instance from the provided specifications, which is a Hash of gem full names and Gem::Specifications.

# File lib/yard/rubygems/backports/source_index.rb, line 104
def initialize(specifications={})
  @gems = {}
  specifications.each{ |full_name, spec| add_spec spec }
  @spec_dirs = nil
end
Also aliased as: old_initialize

Public Instance Methods

add_spec(gem_spec, name = gem_spec.full_name) click to toggle source

Add a gem specification to the source index.

# File lib/yard/rubygems/backports/source_index.rb, line 195
def add_spec(gem_spec, name = gem_spec.full_name)
  # No idea why, but the Indexer wants to insert them using original_name
  # instead of full_name. So we make it an optional arg.
  @gems[name] = gem_spec
end
add_specs(*gem_specs) click to toggle source

Add gem specifications to the source index.

# File lib/yard/rubygems/backports/source_index.rb, line 204
def add_specs(*gem_specs)
  gem_specs.each do |spec|
    add_spec spec
  end
end
all_gems() click to toggle source

TODO: remove method

# File lib/yard/rubygems/backports/source_index.rb, line 111
def all_gems
  @gems
end
dump() click to toggle source
# File lib/yard/rubygems/backports/source_index.rb, line 354
def dump
  Marshal.dump(self)
end
each() click to toggle source

Iterate over the specifications in the source index.

# File lib/yard/rubygems/backports/source_index.rb, line 220
def each(&block) # :yields: gem.full_name, gem
  @gems.each(&block)
end
find_name(gem_name, requirement = Gem::Requirement.default) click to toggle source

Find a gem by an exact match on the short name.

# File lib/yard/rubygems/backports/source_index.rb, line 258
def find_name(gem_name, requirement = Gem::Requirement.default)
  dep = Gem::Dependency.new gem_name, requirement
  search dep
end
gem_signature(gem_full_name) click to toggle source

The signature for the given gem specification.

# File lib/yard/rubygems/backports/source_index.rb, line 244
def gem_signature(gem_full_name)
  require 'digest'

  Digest::SHA256.new.hexdigest(@gems[gem_full_name].to_yaml).to_s
end
index_signature() click to toggle source

The signature for the source index. Changes in the signature indicate a change in the index.

# File lib/yard/rubygems/backports/source_index.rb, line 235
def index_signature
  require 'digest'

  Digest::SHA256.new.hexdigest(@gems.keys.sort.join(',')).to_s
end
latest_specs(include_prerelease=false) click to toggle source

Returns an Array specifications for the latest released versions of each gem in this index.

# File lib/yard/rubygems/backports/source_index.rb, line 145
def latest_specs(include_prerelease=false)
  result = Hash.new { |h,k| h[k] = [] }
  latest = {}

  sort.each do |_, spec|
    name = spec.name
    curr_ver = spec.version
    prev_ver = latest.key?(name) ? latest[name].version : nil

    next if !include_prerelease && curr_ver.prerelease?
    next unless prev_ver.nil? or curr_ver >= prev_ver or
                latest[name].platform != Gem::Platform::RUBY

    if prev_ver.nil? or
       (curr_ver > prev_ver and spec.platform == Gem::Platform::RUBY) then
      result[name].clear
      latest[name] = spec
    end

    if spec.platform != Gem::Platform::RUBY then
      result[name].delete_if do |result_spec|
        result_spec.platform == spec.platform
      end
    end

    result[name] << spec
  end

  # TODO: why is this a hash while @gems is an array? Seems like
  # structural similarity would be good.
  result.values.flatten
end
length() click to toggle source
Alias for: size
load_gems_in(*spec_dirs) click to toggle source

Reconstruct the source index from the specifications in spec_dirs.

# File lib/yard/rubygems/backports/source_index.rb, line 126
def load_gems_in(*spec_dirs)
  @gems.clear

  spec_dirs.reverse_each do |spec_dir|
    spec_files = Dir.glob File.join(spec_dir, '*.gemspec')

    spec_files.each do |spec_file|
      gemspec = Gem::Specification.load spec_file
      add_spec gemspec if gemspec
    end
  end

  self
end
old_initialize(specifications={}) click to toggle source

Undef old methods

Alias for: new
outdated() click to toggle source

Returns an Array of Gem::Specifications that are not up to date.

# File lib/yard/rubygems/backports/source_index.rb, line 332
def outdated
  outdateds = []

  latest_specs.each do |local|
    dependency = Gem::Dependency.new local.name, ">= #{local.version}"

    fetcher = Gem::SpecFetcher.fetcher
    remotes = fetcher.find_matching dependency
    remotes = remotes.map { |(_, version, _), _| version }

    latest = remotes.sort.last

    outdateds << local.name if latest and local.version < latest
  end

  outdateds
end
prerelease_gems() click to toggle source
# File lib/yard/rubygems/backports/source_index.rb, line 115
def prerelease_gems
  @gems.reject{ |name, gem| !gem.version.prerelease? }
end
prerelease_specs() click to toggle source

An array including only the prerelease gemspecs

# File lib/yard/rubygems/backports/source_index.rb, line 181
def prerelease_specs
  prerelease_gems.values
end
refresh!() click to toggle source

Replaces the gems in the source index from specifications in the directories this source index was created from. Raises an exception if this source index wasn't created from a directory (via from_gems_in or from_installed_gems, or having spec_dirs set).

# File lib/yard/rubygems/backports/source_index.rb, line 324
def refresh!
  raise 'source index not created from disk' if @spec_dirs.nil?
  load_gems_in(*@spec_dirs)
end
released_gems() click to toggle source
# File lib/yard/rubygems/backports/source_index.rb, line 119
def released_gems
  @gems.reject{ |name, gem| gem.version.prerelease? }
end
released_specs() click to toggle source

An array including only the released gemspecs

# File lib/yard/rubygems/backports/source_index.rb, line 188
def released_specs
  released_gems.values
end
remove_spec(full_name) click to toggle source

Remove a gem specification named full_name.

# File lib/yard/rubygems/backports/source_index.rb, line 213
def remove_spec(full_name)
  @gems.delete full_name
end
search(gem_pattern, platform_only = false) click to toggle source

Search for a gem by Gem::Dependency gem_pattern. If only_platform is true, only gems matching Gem::Platform.local will be returned. An Array of matching Gem::Specification objects is returned.

For backwards compatibility, a String or Regexp pattern may be passed as gem_pattern, and a Gem::Requirement for platform_only. This behavior is deprecated and will be removed.

# File lib/yard/rubygems/backports/source_index.rb, line 272
def search(gem_pattern, platform_only = false)
  requirement = nil
  only_platform = false

  # TODO - Remove support and warning for legacy arguments after 2008/11
  unless Gem::Dependency === gem_pattern
    warn "#{Gem.location_of_caller.join ':'}:Warning: Gem::SourceIndex#search support for #{gem_pattern.class} patterns is deprecated, use #find_name"
  end

  case gem_pattern
  when Regexp then
    requirement = platform_only || Gem::Requirement.default
  when Gem::Dependency then
    only_platform = platform_only
    requirement = gem_pattern.requirement

    gem_pattern = if Regexp === gem_pattern.name then
                    gem_pattern.name
                  elsif gem_pattern.name.empty? then
                    //
                  else
                    /^#{Regexp.escape gem_pattern.name}$/
                  end
  else
    requirement = platform_only || Gem::Requirement.default
    gem_pattern = /#{gem_pattern}/
  end

  unless Gem::Requirement === requirement then
    requirement = Gem::Requirement.create requirement
  end

  specs = all_gems.values.select do |spec|
    spec.name =~ gem_pattern and
      requirement.satisfied_by? spec.version
  end

  if only_platform then
    specs = specs.select do |spec|
      Gem::Platform.match spec.platform
    end
  end

  specs.sort_by { |s| s.sort_obj }
end
size() click to toggle source
# File lib/yard/rubygems/backports/source_index.rb, line 250
def size
  @gems.size
end
Also aliased as: length
specification(full_name) click to toggle source

The gem specification given a full gem spec name.

# File lib/yard/rubygems/backports/source_index.rb, line 227
def specification(full_name)
  @gems[full_name]
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.