123456789_123456789_123456789_123456789_123456789_

Class: Bundler::Index

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Enumerable
Inherits: Object
Defined in: lib/bundler/index.rb

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.newIndex

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 21

def initialize
  @sources = []
  @cache = {}
  @specs = Hash.new {|h, k| h[k] = {} }
  @all_specs = Hash.new {|h, k| h[k] = EMPTY_SEARCH }
end

Class Method Details

.build {|i| ... }

Yields:

  • (i)
[ GitHub ]

  
# File 'lib/bundler/index.rb', line 9

def self.build
  i = new
  yield i
  i
end

.sort_specs(specs)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 80

def self.sort_specs(specs)
  specs.sort_by do |s|
    platform_string = s.platform.to_s
    [s.version, platform_string == RUBY ? NULL : platform_string]
  end
end

Instance Attribute Details

#all_specs (readonly, protected)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 15

attr_reader :specs, :all_specs, :sources

#empty?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 46

def empty?
  each { return false }
  true
end

#sources (readonly)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 15

attr_reader :specs, :all_specs, :sources

#specs (readonly, protected)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 15

attr_reader :specs, :all_specs, :sources

Instance Method Details

#<<(spec)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 104

def <<(spec)
  @specs[spec.name][spec.full_name] = spec
  spec
end

#==(other)

Whether all the specs in self are in other TODO: rename to #include?

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 163

def ==(other)
  all? do |spec|
    other_spec = other[spec].first
    other_spec && dependencies_eql?(spec, other_spec) && spec.source == other_spec.source
  end
end

#[](query, base = nil)

Alias for #search.

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 102

alias_method :[], :search

#add_source(index)

Raises:

  • (ArgumentError)
[ GitHub ]

  
# File 'lib/bundler/index.rb', line 176

def add_source(index)
  raise ArgumentError, "Source must be an index, not #{index.class}" unless index.is_a?(Index)
  @sources << index
  @sources.uniq! # need to use uniq! here instead of checking for the item before adding
end

#dependencies_eql?(spec, other_spec) ⇒ Boolean

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 170

def dependencies_eql?(spec, other_spec)
  deps       = spec.dependencies.select {|d| d.type != :development }
  other_deps = other_spec.dependencies.select {|d| d.type != :development }
  Set.new(deps) == Set.new(other_deps)
end

#dependency_names

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 131

def dependency_names
  names = []
  each do |spec|
    spec.dependencies.each do |dep|
      next if dep.type == :development
      names << dep.name
    end
  end
  names.uniq
end

#each(&blk)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 109

def each(&blk)
  return enum_for(:each) unless blk
  specs.values.each do |spec_sets|
    spec_sets.values.each(&blk)
  end
  sources.each {|s| s.each(&blk) }
  self
end

#initialize_copy(o)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 28

def initialize_copy(o)
  @sources = o.sources.dup
  @cache = {}
  @specs = Hash.new {|h, k| h[k] = {} }
  @all_specs = Hash.new {|h, k| h[k] = EMPTY_SEARCH }

  o.specs.each do |name, hash|
    @specs[name] = hash.dup
  end
  o.all_specs.each do |name, array|
    @all_specs[name] = array.dup
  end
end

#inspect

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 42

def inspect
  "#<#{self.class}:0x#{object_id} sources=#{sources.map(&:inspect)} specs.size=#{specs.size}>"
end

#local_search(query, base = nil)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 91

def local_search(query, base = nil)
  case query
  when Gem::Specification, RemoteSpecification, LazySpecification, EndpointSpecification then search_by_spec(query)
  when String then specs_by_name(query)
  when Gem::Dependency then search_by_dependency(query, base)
  when DepProxy then search_by_dependency(query.dep, base)
  else
    raise "You can't search for a #{query.inspect}."
  end
end

#search(query, base = nil) Also known as: #[]

Search this index’s specs, and any source indexes that this index knows about, returning all of the results.

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 61

def search(query, base = nil)
  sort_specs(unsorted_search(query, base))
end

#search_all(name)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 51

def search_all(name)
  all_matches = local_search(name) + @all_specs[name]
  @sources.each do |source|
    all_matches.concat(source.search_all(name))
  end
  all_matches
end

#search_by_dependency(dependency, base = nil) (private)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 188

def search_by_dependency(dependency, base = nil)
  @cache[base || false] ||= {}
  @cache[base || false][dependency] ||= begin
    specs = specs_by_name(dependency.name)
    specs += base if base
    found = specs.select do |spec|
      next true if spec.source.is_a?(Source::Gemspec)
      if base # allow all platforms when searching from a lockfile
        dependency.matches_spec?(spec)
      else
        dependency.matches_spec?(spec) && Gem::Platform.match(spec.platform)
      end
    end

    found
  end
end

#search_by_spec(spec) (private)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 208

def search_by_spec(spec)
  spec = @specs[spec.name][spec.full_name]
  spec ? [spec] : EMPTY_SEARCH
end

#size

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 155

def size
  @sources.inject(@specs.size) do |size, source|
    size += source.size
  end
end

#sort_specs(specs)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 87

def sort_specs(specs)
  self.class.sort_specs(specs)
end

#spec_names

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 118

def spec_names
  names = specs.keys + sources.map(&:spec_names)
  names.uniq!
  names
end

#specs_by_name(name) (private)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 184

def specs_by_name(name)
  @specs[name].values
end

#unmet_dependency_names

returns a list of the dependencies

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 125

def unmet_dependency_names
  dependency_names.select do |name|
    name != "bundler" && search(name).empty?
  end
end

#unsorted_search(query, base) (protected)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 65

def unsorted_search(query, base)
  results = local_search(query, base)

  seen = results.map(&:full_name).to_set unless @sources.empty?

  @sources.each do |source|
    source.unsorted_search(query, base).each do |spec|
      results << spec if seen.add?(spec.full_name)
    end
  end

  results
end

#use(other, override_dupes = false)

[ GitHub ]

  
# File 'lib/bundler/index.rb', line 142

def use(other, override_dupes = false)
  return unless other
  other.each do |s|
    if (dupes = search_by_spec(s)) && !dupes.empty?
      # safe to << since it's a new array when it has contents
      @all_specs[s.name] = dupes << s
      next unless override_dupes
    end
    self << s
  end
  self
end