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 19

def initialize
  @sources = []
  @cache = {}
  @specs = {}
  @duplicates = {}
end

Class Method Details

.build {|i| ... }

Yields:

  • (i)
[ GitHub ]

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

def self.build
  i = new
  yield i
  i
end

Instance Attribute Details

#duplicates (readonly, protected)

[ GitHub ]

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

attr_reader :specs, :duplicates, :sources

#empty?Boolean (readonly)

[ GitHub ]

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

def empty?
  each { return false }
  true
end

#sources (readonly)

[ GitHub ]

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

attr_reader :specs, :duplicates, :sources

#specs (readonly, protected)

[ GitHub ]

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

attr_reader :specs, :duplicates, :sources

Instance Method Details

#<<(spec)

Alias for #add.

[ GitHub ]

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

alias_method :<<, :add

#[](query)

Alias for #search.

[ GitHub ]

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

alias_method :[], :search

#add(spec) Also known as: #<<

[ GitHub ]

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

def add(spec)
  (@specs[spec.name] ||= {}).store(spec.full_name, spec)
end

#add_duplicate(spec) (private)

[ GitHub ]

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

def add_duplicate(spec)
  (@duplicates[spec.name] ||= []) << spec
end

#add_source(index)

Raises:

  • (ArgumentError)
[ GitHub ]

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

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 155

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

#dependency_names

[ GitHub ]

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

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 86

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

#exist?(spec) ⇒ Boolean (private)

[ GitHub ]

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

def exist?(spec)
  @specs[spec.name]&.key?(spec.full_name)
end

#find_by_spec(spec) (private)

[ GitHub ]

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

def find_by_spec(spec)
  @specs[spec.name]&.fetch(spec.full_name, nil)
end

#initialize_copy(o)

[ GitHub ]

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

def initialize_copy(o)
  @sources = o.sources.dup
  @cache = {}
  @specs = {}
  @duplicates = {}

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

#inspect

[ GitHub ]

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

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

#local_search(query)

[ GitHub ]

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

def local_search(query)
  case query
  when Gem::Specification, RemoteSpecification, LazySpecification, EndpointSpecification then search_by_spec(query)
  when String then specs_by_name(query)
  when Array then specs_by_name_and_version(*query)
  else
    raise "You can't search for a #{query.inspect}."
  end
end

#merge!(other)

Combines indexes proritizing specs from other, like Hash#merge! Duplicate specs found in self are saved in @duplicates.

[ GitHub ]

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

def merge!(other)
  return unless other
  other.each do |spec|
    if existing = find_by_spec(spec)
      add_duplicate(existing)
    end
    add spec
  end
  self
end

#safe_concat(a, b) (private)

[ GitHub ]

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

def safe_concat(a, b)
  return a if b.empty?
  return b if a.empty?
  a.concat(b)
end

#search(query) 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 58

def search(query)
  results = local_search(query)
  return results unless @sources.any?

  @sources.each do |source|
    results = safe_concat(results, source.search(query))
  end
  results.uniq!(&:full_name) unless results.empty? # avoid modifying frozen EMPTY_SEARCH
  results
end

#search_all(name, &blk)

[ GitHub ]

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

def search_all(name, &blk)
  return enum_for(:search_all, name) unless blk
  specs_by_name(name).each(&blk)
  @duplicates[name]&.each(&blk)
  @sources.each {|source| source.search_all(name, &blk) }
end

#search_by_spec(spec) (private)

[ GitHub ]

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

def search_by_spec(spec)
  spec = find_by_spec(spec)
  spec ? [spec] : EMPTY_SEARCH
end

#size

[ GitHub ]

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

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

#spec_names

[ GitHub ]

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

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 186

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

#specs_by_name_and_version(name, version) (private)

[ GitHub ]

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

def specs_by_name_and_version(name, version)
  results = @specs[name]&.values
  return EMPTY_SEARCH unless results
  results.select! {|spec| spec.version == version }
  results
end

#subset?(other) ⇒ Boolean

Whether all the specs in self are in other

[ GitHub ]

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

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

#unmet_dependency_names

[ GitHub ]

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

def unmet_dependency_names
  dependency_names.select do |name|
    search(name).empty?
  end
end

#use(other)

Combines indexes proritizing existing specs, like Hash#reverse_merge! Duplicate specs found in other are stored in @duplicates.

[ GitHub ]

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

def use(other)
  return unless other
  other.each do |spec|
    exist?(spec) ? add_duplicate(spec) : add(spec)
  end
  self
end