Class: Pod::Source

Inherits:
Object
  • Object
show all
Defined in:
lib/cocoapods-core/source.rb,
lib/cocoapods-core/source/manager.rb,
lib/cocoapods-core/source/acceptor.rb,
lib/cocoapods-core/source/metadata.rb,
lib/cocoapods-core/source/aggregate.rb,
lib/cocoapods-core/source/health_reporter.rb

Overview

The Source class is responsible to manage a collection of podspecs.

The backing store of the podspecs collection is an implementation detail abstracted from the rest of CocoaPods.

The default implementation uses a git repo as a backing store, where the podspecs are namespaced as:

"#{SPEC_NAME}/#{VERSION}/#{SPEC_NAME}.podspec"

Direct Known Subclasses

MasterSource

Defined Under Namespace

Classes: Acceptor, Aggregate, HealthReporter, Manager, Metadata

Paths collapse

Instance Attribute Summary collapse

Paths collapse

Querying the source collapse

Searching the source collapse

Updating the source collapse

Representations collapse

Instance Method Summary collapse

Constructor Details

#initialize(repo) ⇒ Source

Returns a new instance of Source.

Parameters:

  • repo (Pathname, String) —

    @see #repo.



25
26
27
28
 
# File 'lib/cocoapods-core/source.rb', line 25

def initialize(repo)
  @repo = Pathname(repo).expand_path
  refresh_metadata
end

Instance Attribute Details

#metadata ⇒ Pod::Source::Metadata (readonly)

Returns The metadata for this source.

Returns:



21
22
23
 
# File 'lib/cocoapods-core/source.rb', line 21

def metadata
  @metadata
end

#repo ⇒ Pathname (readonly)

Returns The path where the source is stored.

Returns:

  • (Pathname) —

    The path where the source is stored.



82
83
84
 
# File 'lib/cocoapods-core/source.rb', line 82

def repo
  @repo
end

Instance Method Details

#<=>(other) ⇒ Integer

Note:

Source are compared by the alphabetical order of their name, and this convention should be used in any case where sources need to be disambiguated.

Returns compares a source with another one for sorting purposes.

Returns:

  • (Integer) —

    compares a source with another one for sorting purposes.



67
68
69
 
# File 'lib/cocoapods-core/source.rb', line 67

def <=>(other)
  name <=> other.name
end

#all_specs ⇒ Array<Specification>

Returns all the specifications contained by the source.

Returns:

  • (Array<Specification>) —

    all the specifications contained by the source.



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/cocoapods-core/source.rb', line 211

def all_specs
  glob = specs_dir.join('*/' * metadata.prefix_lengths.size, '*', '*', '*.podspec{.json,}')
  specs = Pathname.glob(glob).map do |path|
    begin
      Specification.from_file(path)
    rescue
      CoreUI.warn "Skipping `#{path.relative_path_from(repo)}` because the " \
                  'podspec contains errors.'
      next
    end
  end
  specs.compact
end

#fuzzy_search(query) ⇒ Set, Nil

Returns the set of the Pod whose name fuzzily matches the given query.

Parameters:

  • query (String) —

    The query to search for.

Returns:

  • (Set) —

    The name of the Pod.

  • (Nil) —

    If no Pod with a suitable name was found.



314
315
316
317
318
319
320
 
# File 'lib/cocoapods-core/source.rb', line 314

def fuzzy_search(query)
  require 'fuzzy_match'
  pod_name = FuzzyMatch.new(pods).find(query)
  if pod_name
    search(pod_name)
  end
end

#git? ⇒ Boolean

Returns:

  • (Boolean) 


345
346
347
 
# File 'lib/cocoapods-core/source.rb', line 345

def git?
  !repo_git(%w(rev-parse HEAD)).empty?
end

#inspect ⇒ String

Returns A description suitable for debugging.

Returns:

  • (String) —

    A description suitable for debugging.



73
74
75
 
# File 'lib/cocoapods-core/source.rb', line 73

def inspect
  "#<#{self.class} name:#{name} type:#{type}>"
end

#metadata_path ⇒ Pathname

Returns The path at which source metadata is stored.

Returns:

  • (Pathname) —

    The path at which source metadata is stored.



113
114
115
 
# File 'lib/cocoapods-core/source.rb', line 113

def metadata_path
  repo + 'CocoaPods-version.yml'
end

#name ⇒ String Also known as: to_s

Returns The name of the source.

Returns:

  • (String) —

    The name of the source.



32
33
34
 
# File 'lib/cocoapods-core/source.rb', line 32

def name
  repo.basename.to_s
end

#pod_path(name) ⇒ Pathname

Returns The path at which the specs for the given pod are stored.

Parameters:

  • name (String) —

    The name of the pod.

Returns:

  • (Pathname) —

    The path at which the specs for the given pod are stored.



107
108
109
 
# File 'lib/cocoapods-core/source.rb', line 107

def pod_path(name)
  specs_dir.join(*metadata.path_fragment(name))
end

#pod_sets ⇒ Array<Sets>

Returns the sets of all the Pods.

Returns:

  • (Array<Sets>) —

    the sets of all the Pods.



238
239
240
 
# File 'lib/cocoapods-core/source.rb', line 238

def pod_sets
  pods.map { |pod_name| set(pod_name) }
end

#pods ⇒ Array<String>

Returns the list of the name of all the Pods.

Returns:

  • (Array<String>) —

    the list of the name of all the Pods.



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/cocoapods-core/source.rb', line 125

def pods
  unless specs_dir
    raise Informative, "Unable to find a source named: `#{name}`"
  end
  glob = specs_dir.join('*/' * metadata.prefix_lengths.size, '*')
  Pathname.glob(glob).reduce([]) do |pods, entry|
    pods << entry.basename.to_s if entry.directory?
    pods
  end.sort
end

#pods_for_specification_paths(spec_paths) ⇒ Array<String>

Returns pod names for given array of specification paths.

Parameters:

  • spec_paths (Array<String>) —

    Array of file path names for specifications. Path strings should be relative to the source path.

Returns:

  • (Array<String>) —

    the list of the name of Pods corresponding to specification paths.



143
144
145
146
147
148
149
150
 
# File 'lib/cocoapods-core/source.rb', line 143

def pods_for_specification_paths(spec_paths)
  spec_paths.map do |path|
    absolute_path = repo + path
    relative_path = absolute_path.relative_path_from(specs_dir)
    # The first file name returned by 'each_filename' is the pod name
    relative_path.each_filename.first
  end
end

#search(query) ⇒ Set

TODO:

Rename to #load_set

Note:

This method is optimized for fast lookups by name, i.e. it does not require iterating through #pod_sets

Returns a set for a given dependency. The set is identified by the name of the dependency and takes into account subspecs.

Returns:

  • (Set) —

    a set for a given dependency. The set is identified by the name of the dependency and takes into account subspecs.



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/cocoapods-core/source.rb', line 255

def search(query)
  unless specs_dir
    raise Informative, "Unable to find a source named: `#{name}`"
  end
  if query.is_a?(Dependency)
    query = query.root_name
  end
  found = Pathname.glob(pod_path(query)).map { |path| path.basename.to_s }
  if [query] == found
    set = set(query)
    set if set.specification.name == query
  end
end

#search_by_name(query, full_text_search = false) ⇒ Array<Set>

TODO:

Rename to #search

Note:

full text search requires to load the specification for each pod, hence is considerably slower.

Returns The list of the sets that contain the search term.

Parameters:

  • query (String) —

    the search term. Can be a regular expression.

  • full_text_search (Bool) (defaults to: false) —

    whether the search should be limited to the name of the Pod or should include also the author, the summary, and the description.

Returns:

  • (Array<Set>) —

    The list of the sets that contain the search term.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/cocoapods-core/source.rb', line 283

def search_by_name(query, full_text_search = false)
  regexp_query = /#{query}/i
  if full_text_search
    pod_sets.reject do |set|
      texts = []
      begin
        s = set.specification
        texts << s.name
        texts += s.authors.keys
        texts << s.summary
        texts << s.description
      rescue
        CoreUI.warn "Skipping `#{set.name}` because the podspec " \
          'contains errors.'
      end
      texts.grep(regexp_query).empty?
    end
  else
    names = pods.grep(regexp_query)
    names.map { |pod_name| set(pod_name) }
  end
end

#set(pod_name) ⇒ Sets

Returns the set for the Pod with the given name.

Parameters:

  • pod_name (String) —

    The name of the Pod.

Returns:

  • (Sets) —

    the set.



232
233
234
 
# File 'lib/cocoapods-core/source.rb', line 232

def set(pod_name)
  Specification::Set.new(pod_name, self)
end

#specification(name, version) ⇒ Specification

Returns the specification for a given version of Pod.

Parameters:

  • @see —

    specification_path

Returns:

  • (Specification) —

    the specification for a given version of Pod.



179
180
181
 
# File 'lib/cocoapods-core/source.rb', line 179

def specification(name, version)
  Specification.from_file(specification_path(name, version))
end

#specification_path(name, version) ⇒ Pathname

Returns the path of the specification with the given name and version.

Parameters:

  • name (String) —

    the name of the Pod.

  • version (Version, String) —

    the version for the specification.

Returns:

  • (Pathname) —

    The path of the specification.

Raises:

  • (ArgumentError) 


193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/cocoapods-core/source.rb', line 193

def specification_path(name, version)
  raise ArgumentError, 'No name' unless name
  raise ArgumentError, 'No version' unless version
  path = pod_path(name) + version.to_s
  specification_path = path + "#{name}.podspec.json"
  unless specification_path.exist?
    specification_path = path + "#{name}.podspec"
  end
  unless specification_path.exist?
    raise StandardError, "Unable to find the specification #{name} " \
      "(#{version}) in the #{self.name} source."
  end
  specification_path
end

#specs_dir ⇒ Pathname

Note:

In previous versions of CocoaPods they used to be stored in the root of the repo. This lead to issues, especially with the GitHub interface and now they are stored in a dedicated folder.

Returns The directory where the specs are stored.

Returns:

  • (Pathname) —

    The directory where the specs are stored.



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/cocoapods-core/source.rb', line 91

def specs_dir
  @specs_dir ||= begin
    specs_sub_dir = repo + 'Specs'
    if specs_sub_dir.exist?
      specs_sub_dir
    elsif repo.exist?
      repo
    end
  end
end

#to_hash ⇒ Hash{String=>{String=>Specification}}

Returns the static representation of all the specifications grouped first by name and then by version.

Returns:

  • (Hash{String=>{String=>Specification}}) —

    the static representation of all the specifications grouped first by name and then by version.



371
372
373
374
375
376
377
378
 
# File 'lib/cocoapods-core/source.rb', line 371

def to_hash
  hash = {}
  all_specs.each do |spec|
    hash[spec.name] ||= {}
    hash[spec.name][spec.version.version] = spec.to_hash
  end
  hash
end

#to_yaml ⇒ String

Returns the YAML encoded #to_hash representation.

Returns:

  • (String) —

    the YAML encoded #to_hash representation.



382
383
384
385
 
# File 'lib/cocoapods-core/source.rb', line 382

def to_yaml
  require 'yaml'
  to_hash.to_yaml
end

#type ⇒ String

Returns The type of the source.

Returns:

  • (String) —

    The type of the source.



54
55
56
 
# File 'lib/cocoapods-core/source.rb', line 54

def type
  'file system'
end

#update(show_output) ⇒ Array<String>

Updates the local clone of the source repo.

Parameters:

  • show_output (Bool)

Returns:

  • (Array<String>) —

    changed_spec_paths Returns the list of changed spec paths.



332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/cocoapods-core/source.rb', line 332

def update(show_output)
  prev_commit_hash = git_commit_hash
  update_git_repo(show_output)
  refresh_metadata
  if version = metadata.last_compatible_version(Version.new(CORE_VERSION))
    tag = "v#{version}"
    CoreUI.warn "Using the `#{tag}` tag of the `#{name}` source because " \
      "it is the last version compatible with CocoaPods #{CORE_VERSION}."
    repo_git(['checkout', tag])
  end
  diff_until_commit_hash(prev_commit_hash)
end

#url ⇒ String

Note:

In the past we had used ‘git ls-remote –get-url`, but this could lead to an issue when finding a source based on its URL when `git` is configured to rewrite URLs with the `url.<base>.insteadOf` option. See github.com/CocoaPods/CocoaPods/issues/2724.

Returns The URL of the source.

Returns:

  • (String) —

    The URL of the source.



43
44
45
46
47
48
49
50
 
# File 'lib/cocoapods-core/source.rb', line 43

def url
  remote = repo_git(%w(config --get remote.origin.url))
  if !remote.empty?
    remote
  elsif (repo + '.git').exist?
    "file://#{repo}/.git"
  end
end

#verify_compatibility! ⇒ Object

Raises:



349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/cocoapods-core/source.rb', line 349

def verify_compatibility!
  return if metadata.compatible?(CORE_VERSION)

  version_msg = if metadata.minimum_cocoapods_version == metadata.maximum_cocoapods_version
                  metadata.minimum_cocoapods_version
                else
                  "#{metadata.minimum_cocoapods_version} - #{metadata.maximum_cocoapods_version}"
                end
  raise Informative, "The `#{name}` repo requires " \
    "CocoaPods #{version_msg} (currently using #{CORE_VERSION})\n" \
    'Update CocoaPods, or checkout the appropriate tag in the repo.'
end

#versions(name) ⇒ Array<Version>

Returns all the available versions for the Pod, sorted from highest to lowest.

Parameters:

  • name (String) —

    the name of the Pod.

Returns:

  • (Array<Version>) —

    all the available versions for the Pod, sorted from highest to lowest.

Raises:

  • (ArgumentError) 


158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/cocoapods-core/source.rb', line 158

def versions(name)
  return nil unless specs_dir
  raise ArgumentError, 'No name' unless name
  pod_dir = pod_path(name)
  return unless pod_dir.exist?
  pod_dir.children.map do |v|
    basename = v.basename.to_s
    begin
      Version.new(basename) if v.directory? && basename[0, 1] != '.'
    rescue ArgumentError
      raise Informative, 'An unexpected version directory ' \
       "`#{basename}` was encountered for the " \
       "`#{pod_dir}` Pod in the `#{name}` repository."
    end
  end.compact.sort.reverse
end