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
-
EMPTY_SEARCH =
# File 'lib/bundler/index.rb', line 190[].freeze
-
NULL =
# File 'lib/bundler/index.rb', line 17"\0"
-
RUBY =
# File 'lib/bundler/index.rb', line 16"ruby"
Class Method Summary
- .build {|i| ... }
- .new ⇒ Index constructor
Instance Attribute Summary
- #empty? ⇒ Boolean readonly
- #sources readonly
- #duplicates readonly protected
- #specs readonly protected
Instance Method Summary
-
#<<(spec)
Alias for #add.
-
#[](query)
Alias for #search.
- #add(spec) (also: #<<)
- #add_source(index)
- #dependencies_eql?(spec, other_spec) ⇒ Boolean
- #dependency_names
- #each(&blk)
- #initialize_copy(o)
- #inspect
- #local_search(query)
-
#merge!(other)
Combines indexes proritizing specs from
other
, likeHash#merge!
Duplicate specs found inself
are saved in@duplicates
. -
#search(query)
(also: #[])
Search this index’s specs, and any source indexes that this index knows about, returning all of the results.
- #search_all(name, &blk)
- #size
- #spec_names
-
#subset?(other) ⇒ Boolean
Whether all the specs in self are in other.
- #unmet_dependency_names
-
#use(other)
Combines indexes proritizing existing specs, like
Hash#reverse_merge!
Duplicate specs found inother
are stored in@duplicates
. - #add_duplicate(spec) private
- #exist?(spec) ⇒ Boolean private
- #find_by_spec(spec) private
- #safe_concat(a, b) private
- #search_by_spec(spec) private
- #specs_by_name(name) private
- #specs_by_name_and_version(name, version) private
Constructor Details
.new ⇒ Index
# File 'lib/bundler/index.rb', line 19
def initialize @sources = [] @cache = {} @specs = {} @duplicates = {} end
Class Method Details
.build {|i| ... }
# File 'lib/bundler/index.rb', line 7
def self.build i = new yield i i end
Instance Attribute Details
#duplicates (readonly, protected)
[ GitHub ]
#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.
# File 'lib/bundler/index.rb', line 84
alias_method :<<, :add
#[](query)
Alias for #search.
# 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)
# 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
# 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 ]#each(&blk)
[ GitHub ]
#exist?(spec) ⇒ Boolean
(private)
# 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 ]#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
.
# 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 ]#search(query) Also known as: #[]
Search this index’s specs, and any source indexes that this index knows about, returning all of the results.
# 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 ]#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
# 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
.
# 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