Parent

Included Modules

Class 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/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
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/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
installed_spec_directories() click to toggle source

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

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

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
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/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

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/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_specs(*gem_specs) click to toggle source

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
all_gems() click to toggle source

TODO: remove method

     # File lib/rubygems/source_index.rb, line 131
131:   def all_gems
132:     @gems
133:   end
dump() click to toggle source
     # File lib/rubygems/source_index.rb, line 420
420:   def dump
421:     Marshal.dump(self)
422:   end
each() click to toggle source

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_name(gem_name, version_requirement = Gem::Requirement.default) click to toggle source

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
gem_signature(gem_full_name) click to toggle source

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
index_signature() click to toggle source

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
latest_specs() click to toggle source

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
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/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
outdated() click to toggle source

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
prerelease_gems() click to toggle source
     # File lib/rubygems/source_index.rb, line 135
135:   def prerelease_gems
136:     @gems.reject{ |name, gem| !gem.version.prerelease? }
137:   end
prerelease_specs() click to toggle source

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
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/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
released_gems() click to toggle source
     # File lib/rubygems/source_index.rb, line 139
139:   def released_gems
140:     @gems.reject{ |name, gem| gem.version.prerelease? }
141:   end
released_specs() click to toggle source

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_spec(full_name) click to toggle source

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(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/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}/
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
size() click to toggle source
     # File lib/rubygems/source_index.rb, line 270
270:   def size
271:     @gems.size
272:   end
Also aliased as: length
specification(full_name) click to toggle source

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
update(source_uri, all) click to toggle source

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

Private Instance Methods

fetch_bulk_index(source_uri) click to toggle source
     # File lib/rubygems/source_index.rb, line 466
466:   def fetch_bulk_index(source_uri)
467:     say "Bulk updating Gem source index for: #{source_uri}" if
468:       Gem.configuration.verbose
469: 
470:     index = fetch_index_from(source_uri)
471:     if index.nil? then
472:       raise Gem::RemoteSourceException,
473:               "Error fetching remote gem cache: #{@fetch_error}"
474:     end
475:     @fetch_error = nil
476:     index
477:   end
fetch_index_from(source_uri) click to toggle source
     # File lib/rubygems/source_index.rb, line 432
432:   def fetch_index_from(source_uri)
433:     @fetch_error = nil
434: 
435:     indexes = ]
436:         Marshal.#{Gem.marshal_version}.Z
437:         Marshal.#{Gem.marshal_version}
438:         yaml.Z
439:         yaml
440:       ]
441: 
442:     indexes.each do |name|
443:       spec_data = nil
444:       index = source_uri + name
445:       begin
446:         spec_data = fetcher.fetch_path index
447:         spec_data = unzip(spec_data) if name =~ /\.Z$/
448: 
449:         if name =~ /Marshal/ then
450:           return Marshal.load(spec_data)
451:         else
452:           return YAML.load(spec_data)
453:         end
454:       rescue => e
455:         if Gem.configuration.really_verbose then
456:           alert_error "Unable to fetch #{name}: #{e.message}"
457:         end
458: 
459:         @fetch_error = e
460:       end
461:     end
462: 
463:     nil
464:   end
fetch_quick_index(source_uri, all) click to toggle source

Get the quick index needed for incremental updates.

     # File lib/rubygems/source_index.rb, line 482
482:   def fetch_quick_index(source_uri, all)
483:     index = all ? 'index' : 'latest_index'
484: 
485:     zipped_index = fetcher.fetch_path source_uri + "quick/#{index}.rz"
486: 
487:     unzip(zipped_index).split("\n")
488:   rescue ::Exception => e
489:     unless all then
490:       say "Latest index not found, using quick index" if
491:         Gem.configuration.really_verbose
492: 
493:       fetch_quick_index source_uri, true
494:     else
495:       raise Gem::OperationNotSupportedError,
496:             "No quick index found: #{e.message}"
497:     end
498:   end
fetch_single_spec(source_uri, spec_name) click to toggle source

Tries to fetch Marshal representation first, then YAML

     # File lib/rubygems/source_index.rb, line 534
534:   def fetch_single_spec(source_uri, spec_name)
535:     @fetch_error = nil
536: 
537:     begin
538:       marshal_uri = source_uri + "quick/Marshal.#{Gem.marshal_version}/#{spec_name}.gemspec.rz"
539:       zipped = fetcher.fetch_path marshal_uri
540:       return Marshal.load(unzip(zipped))
541:     rescue => ex
542:       @fetch_error = ex
543: 
544:       if Gem.configuration.really_verbose then
545:         say "unable to fetch marshal gemspec #{marshal_uri}: #{ex.class} - #{ex}"
546:       end
547:     end
548: 
549:     begin
550:       yaml_uri = source_uri + "quick/#{spec_name}.gemspec.rz"
551:       zipped = fetcher.fetch_path yaml_uri
552:       return YAML.load(unzip(zipped))
553:     rescue => ex
554:       @fetch_error = ex
555:       if Gem.configuration.really_verbose then
556:         say "unable to fetch YAML gemspec #{yaml_uri}: #{ex.class} - #{ex}"
557:       end
558:     end
559: 
560:     nil
561:   end
fetcher() click to toggle source
     # File lib/rubygems/source_index.rb, line 426
426:   def fetcher
427:     require 'rubygems/remote_fetcher'
428: 
429:     Gem::RemoteFetcher.fetcher
430:   end
find_missing(spec_names) click to toggle source

Make a list of full names for all the missing gemspecs.

     # File lib/rubygems/source_index.rb, line 503
503:   def find_missing(spec_names)
504:     unless defined? @originals then
505:       @originals = {}
506:       each do |full_name, spec|
507:         @originals[spec.original_name] = spec
508:       end
509:     end
510: 
511:     spec_names.find_all { |full_name|
512:       @originals[full_name].nil?
513:     }
514:   end
remove_extra(spec_names) click to toggle source
     # File lib/rubygems/source_index.rb, line 516
516:   def remove_extra(spec_names)
517:     dictionary = spec_names.inject({}) { |h, k| h[k] = true; h }
518:     each do |name, spec|
519:       remove_spec name unless dictionary.include? spec.original_name
520:     end
521:   end
unzip(string) click to toggle source

Unzip the given string.

     # File lib/rubygems/source_index.rb, line 526
526:   def unzip(string)
527:     require 'zlib'
528:     Gem.inflate string
529:   end
update_with_missing(source_uri, missing_names) click to toggle source

Update the cached source index with the missing names.

     # File lib/rubygems/source_index.rb, line 566
566:   def update_with_missing(source_uri, missing_names)
567:     progress = ui.progress_reporter(missing_names.size,
568:         "Updating metadata for #{missing_names.size} gems from #{source_uri}")
569:     missing_names.each do |spec_name|
570:       gemspec = fetch_single_spec(source_uri, spec_name)
571:       if gemspec.nil? then
572:         ui.say "Failed to download spec #{spec_name} from #{source_uri}:\n"                   "\t#{@fetch_error.message}"
573:       else
574:         add_spec gemspec
575:         progress.updated spec_name
576:       end
577:       @fetch_error = nil
578:     end
579:     progress.done
580:     progress.count
581:   end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.