Class: Gem::SpecFetcher

Inherits:
Object
  • Object
show all
Includes:
Text, UserInteraction
Defined in:
lib/rubygems/spec_fetcher.rb

Overview

SpecFetcher handles metadata updates from remote gem repositories.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rubygems/spec_fetcher.rb', line 57

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



19
20
21
 
# File 'lib/rubygems/spec_fetcher.rb', line 19

def latest_specs
  @latest_specs
end

#prerelease_specs ⇒ Object (readonly)

Cache of prerelease specs



34
35
36
 
# File 'lib/rubygems/spec_fetcher.rb', line 34

def prerelease_specs
  @prerelease_specs
end

#sources ⇒ Object (readonly)

Sources for this SpecFetcher



24
25
26
 
# File 'lib/rubygems/spec_fetcher.rb', line 24

def sources
  @sources
end

#specs ⇒ Object (readonly)

Cache of all released specs



29
30
31
 
# File 'lib/rubygems/spec_fetcher.rb', line 29

def specs
  @specs
end

Class Method Details

.fetcher ⇒ Object

Default fetcher instance. Use this instead of ::new to reduce object allocation.



42
43
44
 
# File 'lib/rubygems/spec_fetcher.rb', line 42

def self.fetcher
  @fetcher ||= new
end

.fetcher=(fetcher) ⇒ Object

:nodoc:



46
47
48
 
# File 'lib/rubygems/spec_fetcher.rb', line 46

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/rubygems/spec_fetcher.rb', line 243

def available_specs(type)
  errors = []
  list = {}

  @sources.each_source do |source|
    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

  [list, errors]
end

#detect(type = :complete) ⇒ Object

Return all gem name tuples who’s names match obj



133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/rubygems/spec_fetcher.rb', line 133

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.



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
128
 
# File 'lib/rubygems/spec_fetcher.rb', line 86

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 && !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].version }

  [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.



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/rubygems/spec_fetcher.rb', line 153

def spec_for_dependency(dependency, matching_platform=true)
  tuples, errors = search_for_dependency(dependency, matching_platform)

  specs = []
  tuples.each do |tup, source|
    spec = source.fetch_spec(tup)
  rescue Gem::RemoteFetcher::FetchError => e
    errors << Gem::SourceFetchProblem.new(source, e)
  else
    specs << [spec, source]
  end

  [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.



172
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/rubygems/spec_fetcher.rb', line 172

def suggest_gems_from_name(gem_name, type = :latest, num_results = 5)
  gem_name = gem_name.downcase.tr("_-", "")

  # All results for 3-character-or-shorter (minus hyphens/underscores) gem
  # names get rejected, so we just return an empty array immediately instead.
  return [] if gem_name.length <= 3

  max   = gem_name.size / 2
  names = available_specs(type).first.values.flatten(1)

  min_length = gem_name.length - max
  max_length = gem_name.length + max

  gem_name_with_postfix = "#{gem_name}ruby"
  gem_name_with_prefix = "ruby#{gem_name}"

  matches = names.filter_map do |n|
    len = n.name.length
    # If the gem doesn't support the current platform, bail early.
    next unless n.match_platform?

    # If the length is min_length or shorter, we've done `max` deletions.
    # This would be rejected later, so we skip it for performance.
    next if len <= min_length

    # The candidate name, normalized the same as gem_name.
    normalized_name = n.name.downcase
    normalized_name.tr!("_-", "")

    # If the gem is "{NAME}-ruby" and "ruby-{NAME}", we want to return it.
    # But we already removed hyphens, so we check "{NAME}ruby" and "ruby{NAME}".
    next [n.name, 0] if normalized_name == gem_name_with_postfix
    next [n.name, 0] if normalized_name == gem_name_with_prefix

    # If the length is max_length or longer, we've done `max` insertions.
    # This would be rejected later, so we skip it for performance.
    next if len >= max_length

    # If we found an exact match (after stripping underscores and hyphens),
    # that's our most likely candidate.
    # Return it immediately, and skip the rest of the loop.
    return [n.name] if normalized_name == gem_name

    distance = levenshtein_distance gem_name, normalized_name

    # Skip current candidate, if the edit distance is greater than allowed.
    next if distance >= max

    # If all else fails, return the name and the calculated distance.
    [n.name, distance]
  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.



283
284
285
286
287
288
289
 
# File 'lib/rubygems/spec_fetcher.rb', line 283

def tuples_for(source, type, gracefully_ignore=false) # :nodoc:
  @caches[type][source.uri] ||=
    source.load_specs(type).sort_by(&:name)
rescue Gem::RemoteFetcher::FetchError
  raise unless gracefully_ignore
  []
end