Class: Gem::SpecFetcher
- Includes:
- Text, UserInteraction
- Defined in:
- lib/rubygems/spec_fetcher.rb
Overview
SpecFetcher handles metadata updates from remote gem repositories.
Instance Attribute Summary collapse
-
#latest_specs ⇒ Object
readonly
Cache of latest specs.
-
#prerelease_specs ⇒ Object
readonly
Cache of prerelease specs.
-
#sources ⇒ Object
readonly
Sources for this SpecFetcher.
-
#specs ⇒ Object
readonly
Cache of all released specs.
Class Method Summary collapse
-
.fetcher ⇒ Object
Default fetcher instance.
-
.fetcher=(fetcher) ⇒ Object
:nodoc:.
Instance Method Summary collapse
-
#available_specs(type) ⇒ Object
Returns a list of gems available for each source in Gem::sources.
-
#detect(type = :complete) ⇒ Object
Return all gem name tuples who’s names match
obj
. -
#initialize(sources = nil) ⇒ SpecFetcher
constructor
Creates a new SpecFetcher.
-
#search_for_dependency(dependency, matching_platform = true) ⇒ Object
Find and fetch gem name tuples that match
dependency
. -
#spec_for_dependency(dependency, matching_platform = true) ⇒ Object
Find and fetch specs that match
dependency
. -
#suggest_gems_from_name(gem_name, type = :latest, num_results = 5) ⇒ Object
Suggests gems based on the supplied
gem_name
. -
#tuples_for(source, type, gracefully_ignore = false) ⇒ Object
Retrieves NameTuples from
source
of the giventype
(:prerelease, etc.).
Methods included from Text
#clean_text, #format_text, #levenshtein_distance, #min3, #truncate_text
Methods included from UserInteraction
#alert, #alert_error, #alert_warning, #ask, #ask_for_password, #ask_yes_no, #choose_from_list, #say, #terminate_interaction, #verbose
Methods included from DefaultUserInteraction
ui, #ui, ui=, #ui=, use_ui, #use_ui
Constructor Details
#initialize(sources = nil) ⇒ SpecFetcher
Creates a new SpecFetcher. Ordinarily you want to use the default fetcher from Gem::SpecFetcher::fetcher which uses the Gem.sources.
If you need to retrieve specifications from a different source
, you can send it as an argument.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/rubygems/spec_fetcher.rb', line 56 def initialize(sources = nil) @sources = sources || Gem.sources @update_cache = begin File.stat(Gem.user_home).uid == Process.uid rescue Errno::EACCES, Errno::ENOENT false end @specs = {} @latest_specs = {} @prerelease_specs = {} @caches = { :latest => @latest_specs, :prerelease => @prerelease_specs, :released => @specs, } @fetcher = Gem::RemoteFetcher.fetcher end |
Instance Attribute Details
#latest_specs ⇒ Object (readonly)
Cache of latest specs
18 19 20 |
# File 'lib/rubygems/spec_fetcher.rb', line 18 def latest_specs @latest_specs end |
#prerelease_specs ⇒ Object (readonly)
Cache of prerelease specs
33 34 35 |
# File 'lib/rubygems/spec_fetcher.rb', line 33 def prerelease_specs @prerelease_specs end |
#sources ⇒ Object (readonly)
Sources for this SpecFetcher
23 24 25 |
# File 'lib/rubygems/spec_fetcher.rb', line 23 def sources @sources end |
#specs ⇒ Object (readonly)
Cache of all released specs
28 29 30 |
# File 'lib/rubygems/spec_fetcher.rb', line 28 def specs @specs end |
Class Method Details
.fetcher ⇒ Object
Default fetcher instance. Use this instead of ::new to reduce object allocation.
41 42 43 |
# File 'lib/rubygems/spec_fetcher.rb', line 41 def self.fetcher @fetcher ||= new end |
.fetcher=(fetcher) ⇒ Object
:nodoc:
45 46 47 |
# File 'lib/rubygems/spec_fetcher.rb', line 45 def self.fetcher=(fetcher) # :nodoc: @fetcher = fetcher end |
Instance Method Details
#available_specs(type) ⇒ Object
Returns a list of gems available for each source in Gem::sources.
type
can be one of 3 values: :released => Return the list of all released specs :complete => Return the list of all specs :latest => Return the list of only the highest version of each gem :prerelease => Return the list of all prerelease only specs
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/rubygems/spec_fetcher.rb', line 212 def available_specs(type) errors = [] list = {} @sources.each_source do |source| begin names = case type when :latest tuples_for source, :latest when :released tuples_for source, :released when :complete names = tuples_for(source, :prerelease, true) + tuples_for(source, :released) names.sort when :abs_latest names = tuples_for(source, :prerelease, true) + tuples_for(source, :latest) names.sort when :prerelease tuples_for(source, :prerelease) else raise Gem::Exception, "Unknown type - :#{type}" end rescue Gem::RemoteFetcher::FetchError => e errors << Gem::SourceFetchProblem.new(source, e) else list[source] = names end end [list, errors] end |
#detect(type = :complete) ⇒ Object
Return all gem name tuples who’s names match obj
132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/rubygems/spec_fetcher.rb', line 132 def detect(type=:complete) tuples = [] list, _ = available_specs(type) list.each do |source, specs| specs.each do |tup| if yield(tup) tuples << [tup, source] end end end tuples end |
#search_for_dependency(dependency, matching_platform = true) ⇒ Object
Find and fetch gem name tuples that match dependency
.
If matching_platform
is false, gems for all platforms are returned.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/rubygems/spec_fetcher.rb', line 85 def search_for_dependency(dependency, matching_platform=true) found = {} rejected_specs = {} list, errors = available_specs(dependency.identity) list.each do |source, specs| if dependency.name.is_a?(String) && specs.respond_to?(:bsearch) start_index = (0 ... specs.length).bsearch{|i| specs[i].name >= dependency.name } end_index = (0 ... specs.length).bsearch{|i| specs[i].name > dependency.name } specs = specs[start_index ... end_index] if start_index && end_index end found[source] = specs.select do |tup| if dependency.match?(tup) if matching_platform and !Gem::Platform.match_gem?(tup.platform, tup.name) pm = ( rejected_specs[dependency] ||= \ Gem::PlatformMismatch.new(tup.name, tup.version)) pm.add_platform tup.platform false else true end end end end errors += rejected_specs.values tuples = [] found.each do |source, specs| specs.each do |s| tuples << [s, source] end end tuples = tuples.sort_by {|x| x[0] } return [tuples, errors] end |
#spec_for_dependency(dependency, matching_platform = true) ⇒ Object
Find and fetch specs that match dependency
.
If matching_platform
is false, gems for all platforms are returned.
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 |
# File 'lib/rubygems/spec_fetcher.rb', line 152 def spec_for_dependency(dependency, matching_platform=true) tuples, errors = search_for_dependency(dependency, matching_platform) specs = [] tuples.each do |tup, source| begin spec = source.fetch_spec(tup) rescue Gem::RemoteFetcher::FetchError => e errors << Gem::SourceFetchProblem.new(source, e) else specs << [spec, source] end end return [specs, errors] end |
#suggest_gems_from_name(gem_name, type = :latest, num_results = 5) ⇒ Object
Suggests gems based on the supplied gem_name
. Returns an array of alternative gem names.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/rubygems/spec_fetcher.rb', line 173 def suggest_gems_from_name(gem_name, type = :latest, num_results = 5) gem_name = gem_name.downcase.tr('_-', '') max = gem_name.size / 2 names = available_specs(type).first.values.flatten(1) matches = names.map do |n| next unless n.match_platform? [n.name, 0] if n.name.downcase.tr('_-', '').include?(gem_name) end.compact if matches.length < num_results matches += names.map do |n| next unless n.match_platform? distance = levenshtein_distance gem_name, n.name.downcase.tr('_-', '') next if distance >= max return [n.name] if distance == 0 [n.name, distance] end.compact end matches = if matches.empty? && type != :prerelease suggest_gems_from_name gem_name, :prerelease else matches.uniq.sort_by {|name, dist| dist } end matches.map {|name, dist| name }.uniq.first(num_results) end |
#tuples_for(source, type, gracefully_ignore = false) ⇒ Object
Retrieves NameTuples from source
of the given type
(:prerelease, etc.). If gracefully_ignore
is true, errors are ignored.
254 255 256 257 258 259 260 |
# File 'lib/rubygems/spec_fetcher.rb', line 254 def tuples_for(source, type, gracefully_ignore=false) # :nodoc: @caches[type][source.uri] ||= source.load_specs(type).sort_by {|tup| tup.name } rescue Gem::RemoteFetcher::FetchError raise unless gracefully_ignore [] end |