Class | Gem::SourceIndex |
In: |
lib/rubygems/source_index.rb
|
Parent: | Object |
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. |
spec_dirs | [RW] | Directories to use to refresh this SourceIndex when calling refresh! |
Creates a new SourceIndex from the ruby format gem specifications in spec_dirs.
# File lib/rubygems/source_index.rb, line 75 75: def from_gems_in(*spec_dirs) 76: source_index = new 77: source_index.spec_dirs = spec_dirs 78: source_index.refresh! 79: end
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/rubygems/source_index.rb, line 56 56: def from_installed_gems(*deprecated) 57: if deprecated.empty? 58: from_gems_in(*installed_spec_directories) 59: else 60: from_gems_in(*deprecated) # HACK warn 61: end 62: end
Loads a ruby-format specification from file_name and returns the loaded spec.
# File lib/rubygems/source_index.rb, line 85 85: def load_specification(file_name) 86: return nil unless file_name and File.exist? file_name 87: 88: spec_code = if defined? Encoding then 89: File.read file_name, :encoding => 'UTF-8' 90: else 91: File.read file_name 92: end.untaint 93: 94: begin 95: gemspec = eval spec_code, binding, file_name 96: 97: if gemspec.is_a?(Gem::Specification) 98: gemspec.loaded_from = file_name 99: return gemspec 100: end 101: alert_warning "File '#{file_name}' does not evaluate to a gem specification" 102: rescue SignalException, SystemExit 103: raise 104: rescue SyntaxError => e 105: alert_warning e 106: alert_warning spec_code 107: rescue Exception => e 108: alert_warning "#{e.inspect}\n#{spec_code}" 109: alert_warning "Invalid .gemspec format in '#{file_name}'" 110: end 111: 112: return nil 113: end
Constructs a source index instance from the provided specifications, which is a Hash of gem full names and Gem::Specifications.
# File lib/rubygems/source_index.rb, line 124 124: def initialize(specifications={}) 125: @gems = {} 126: specifications.each{ |full_name, spec| add_spec spec } 127: @spec_dirs = nil 128: end
Add a gem specification to the source index.
# File lib/rubygems/source_index.rb, line 215 215: def add_spec(gem_spec, name = gem_spec.full_name) 216: # No idea why, but the Indexer wants to insert them using original_name 217: # instead of full_name. So we make it an optional arg. 218: @gems[name] = gem_spec 219: end
Add gem specifications to the source index.
# File lib/rubygems/source_index.rb, line 224 224: def add_specs(*gem_specs) 225: gem_specs.each do |spec| 226: add_spec spec 227: end 228: end
TODO: remove method
# File lib/rubygems/source_index.rb, line 131 131: def all_gems 132: @gems 133: end
Iterate over the specifications in the source index.
# File lib/rubygems/source_index.rb, line 240 240: def each(&block) # :yields: gem.full_name, gem 241: @gems.each(&block) 242: end
Find a gem by an exact match on the short name.
# File lib/rubygems/source_index.rb, line 278 278: def find_name(gem_name, version_requirement = Gem::Requirement.default) 279: dep = Gem::Dependency.new gem_name, version_requirement 280: search dep 281: end
The signature for the given gem specification.
# File lib/rubygems/source_index.rb, line 264 264: def gem_signature(gem_full_name) 265: require 'digest' 266: 267: Digest::SHA256.new.hexdigest(@gems[gem_full_name].to_yaml).to_s 268: end
The signature for the source index. Changes in the signature indicate a change in the index.
# File lib/rubygems/source_index.rb, line 255 255: def index_signature 256: require 'digest' 257: 258: Digest::SHA256.new.hexdigest(@gems.keys.sort.join(',')).to_s 259: end
Returns an Array specifications for the latest released versions of each gem in this index.
# File lib/rubygems/source_index.rb, line 165 165: def latest_specs 166: result = Hash.new { |h,k| h[k] = [] } 167: latest = {} 168: 169: sort.each do |_, spec| 170: name = spec.name 171: curr_ver = spec.version 172: prev_ver = latest.key?(name) ? latest[name].version : nil 173: 174: next if curr_ver.prerelease? 175: next unless prev_ver.nil? or curr_ver >= prev_ver or 176: latest[name].platform != Gem::Platform::RUBY 177: 178: if prev_ver.nil? or 179: (curr_ver > prev_ver and spec.platform == Gem::Platform::RUBY) then 180: result[name].clear 181: latest[name] = spec 182: end 183: 184: if spec.platform != Gem::Platform::RUBY then 185: result[name].delete_if do |result_spec| 186: result_spec.platform == spec.platform 187: end 188: end 189: 190: result[name] << spec 191: end 192: 193: # TODO: why is this a hash while @gems is an array? Seems like 194: # structural similarity would be good. 195: result.values.flatten 196: end
Reconstruct the source index from the specifications in spec_dirs.
# File lib/rubygems/source_index.rb, line 146 146: def load_gems_in(*spec_dirs) 147: @gems.clear 148: 149: spec_dirs.reverse_each do |spec_dir| 150: spec_files = Dir.glob File.join(spec_dir, '*.gemspec') 151: 152: spec_files.each do |spec_file| 153: gemspec = self.class.load_specification spec_file.untaint 154: add_spec gemspec if gemspec 155: end 156: end 157: 158: self 159: end
Returns an Array of Gem::Specifications that are not up to date.
# File lib/rubygems/source_index.rb, line 351 351: def outdated 352: outdateds = [] 353: 354: latest_specs.each do |local| 355: dependency = Gem::Dependency.new local.name, ">= #{local.version}" 356: 357: begin 358: fetcher = Gem::SpecFetcher.fetcher 359: remotes = fetcher.find_matching dependency 360: remotes = remotes.map { |(name, version,_),_| version } 361: rescue Gem::RemoteFetcher::FetchError => e 362: raise unless fetcher.warn_legacy e do 363: require 'rubygems/source_info_cache' 364: 365: specs = Gem::SourceInfoCache.search_with_source dependency, true 366: 367: remotes = specs.map { |spec,| spec.version } 368: end 369: end 370: 371: latest = remotes.sort.last 372: 373: outdateds << local.name if latest and local.version < latest 374: end 375: 376: outdateds 377: end
# File lib/rubygems/source_index.rb, line 135 135: def prerelease_gems 136: @gems.reject{ |name, gem| !gem.version.prerelease? } 137: end
An array including only the prerelease gemspecs
# File lib/rubygems/source_index.rb, line 201 201: def prerelease_specs 202: prerelease_gems.values 203: end
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/rubygems/source_index.rb, line 343 343: def refresh! 344: raise 'source index not created from disk' if @spec_dirs.nil? 345: load_gems_in(*@spec_dirs) 346: end
# File lib/rubygems/source_index.rb, line 139 139: def released_gems 140: @gems.reject{ |name, gem| gem.version.prerelease? } 141: end
An array including only the released gemspecs
# File lib/rubygems/source_index.rb, line 208 208: def released_specs 209: released_gems.values 210: end
Remove a gem specification named full_name.
# File lib/rubygems/source_index.rb, line 233 233: def remove_spec(full_name) 234: @gems.delete full_name 235: end
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/rubygems/source_index.rb, line 292 292: def search(gem_pattern, platform_only = false) 293: version_requirement = nil 294: only_platform = false 295: 296: # TODO - Remove support and warning for legacy arguments after 2008/11 297: unless Gem::Dependency === gem_pattern 298: warn "#{Gem.location_of_caller.join ':'}:Warning: Gem::SourceIndex#search support for #{gem_pattern.class} patterns is deprecated, use #find_name" 299: end 300: 301: case gem_pattern 302: when Regexp then 303: version_requirement = platform_only || Gem::Requirement.default 304: when Gem::Dependency then 305: only_platform = platform_only 306: version_requirement = gem_pattern.requirement 307: gem_pattern = if Regexp === gem_pattern.name then 308: gem_pattern.name 309: elsif gem_pattern.name.empty? then 310: // 311: else 312: /^#{Regexp.escape gem_pattern.name}$/ 313: end 314: else 315: version_requirement = platform_only || Gem::Requirement.default 316: gem_pattern = /^#{gem_pattern}/i 317: end 318: 319: unless Gem::Requirement === version_requirement then 320: version_requirement = Gem::Requirement.create version_requirement 321: end 322: 323: specs = all_gems.values.select do |spec| 324: spec.name =~ gem_pattern and 325: version_requirement.satisfied_by? spec.version 326: end 327: 328: if only_platform then 329: specs = specs.select do |spec| 330: Gem::Platform.match spec.platform 331: end 332: end 333: 334: specs.sort_by { |s| s.sort_obj } 335: end
The gem specification given a full gem spec name.
# File lib/rubygems/source_index.rb, line 247 247: def specification(full_name) 248: @gems[full_name] 249: end
Updates this SourceIndex from source_uri. If all is false, only the latest gems are fetched.
# File lib/rubygems/source_index.rb, line 383 383: def update(source_uri, all) 384: source_uri = URI.parse source_uri unless URI::Generic === source_uri 385: source_uri.path += '/' unless source_uri.path =~ /\/$/ 386: 387: use_incremental = false 388: 389: begin 390: gem_names = fetch_quick_index source_uri, all 391: remove_extra gem_names 392: missing_gems = find_missing gem_names 393: 394: return false if missing_gems.size.zero? 395: 396: say "Missing metadata for #{missing_gems.size} gems" if 397: missing_gems.size > 0 and Gem.configuration.really_verbose 398: 399: use_incremental = missing_gems.size <= Gem.configuration.bulk_threshold 400: rescue Gem::OperationNotSupportedError => ex 401: alert_error "Falling back to bulk fetch: #{ex.message}" if 402: Gem.configuration.really_verbose 403: use_incremental = false 404: end 405: 406: if use_incremental then 407: update_with_missing(source_uri, missing_gems) 408: else 409: new_index = fetch_bulk_index(source_uri) 410: @gems.replace(new_index.gems) 411: end 412: 413: true 414: end