Class: Pod::Source::Manager

Inherits:
Object
  • Object
show all
Defined in:
lib/cocoapods-core/source/manager.rb

Master repo collapse

Instance Attribute Summary collapse

Master repo collapse

Instance Method Summary collapse

Constructor Details

#initialize(repos_dir) ⇒ Manager

Returns a new instance of Manager.



9
10
11
 
# File 'lib/cocoapods-core/source/manager.rb', line 9

def initialize(repos_dir)
  @repos_dir = Pathname(repos_dir).expand_path
end

Instance Attribute Details

#repos_dir ⇒ Pathname (readonly)

Returns The directory that contains the source repo directories.

Returns:

  • (Pathname) —

    The directory that contains the source repo directories.



7
8
9
 
# File 'lib/cocoapods-core/source/manager.rb', line 7

def repos_dir
  @repos_dir
end

#search_index_path ⇒ Pathname

Returns The path where the search index should be stored.

Returns:

  • (Pathname) —

    The path where the search index should be stored.



281
282
283
 
# File 'lib/cocoapods-core/source/manager.rb', line 281

def search_index_path
  @search_index_path
end

#updated_search_index ⇒ Hash{String => Hash{String => Array<String>}}

Returns the search data. If a saved search data exists, retrieves it from file and returns it. Else, creates the search data from scratch, saves it to file system, and returns it. Search data is grouped by source repos. For each source, it contains a hash where keys are words and values are the pod names containing corresponding word.

For each source, list of unique words are generated from the following spec information.

- version
- summary
- description
- authors

Returns:

  • (Hash{String => Hash{String => Array<String>}}) —

    The up to date search data.



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/cocoapods-core/source/manager.rb', line 183

def updated_search_index
  index = stored_search_index || {}
  all.each do |source|
    source_name = source.name
    unless index[source_name]
      CoreUI.print "Creating search index for spec repo '#{source_name}'.."
      index[source_name] = aggregate.generate_search_index_for_source(source)
      CoreUI.puts ' Done!'
    end
  end
  save_search_index(index)
  index
end

Instance Method Details

#aggregate ⇒ Source::Aggregate

Returns The aggregate of all the sources with the known Pods.

Returns:



23
24
25
 
# File 'lib/cocoapods-core/source/manager.rb', line 23

def aggregate
  aggregate_with_repos(source_repos)
end

#aggregate_for_dependency(dependency) ⇒ Source::Aggregate

Returns The aggregate of the sources from repos.

Parameters:

  • dependency (Dependency) —

    The dependency for which to find or build the appropriate. aggregate. If the dependency specifies a source podspec repo then only that source will be used, otherwise all sources will be used.

Returns:



35
36
37
38
39
40
41
42
 
# File 'lib/cocoapods-core/source/manager.rb', line 35

def aggregate_for_dependency(dependency)
  return aggregate if dependency.podspec_repo.nil?

  source = source_with_url(dependency.podspec_repo)
  return aggregate if source.nil?

  aggregate_with_repos([source.repo])
end

#all ⇒ Array<Source>

Returns The list of all the sources known to this installation of CocoaPods.

Returns:

  • (Array<Source>) —

    The list of all the sources known to this installation of CocoaPods.



57
58
59
 
# File 'lib/cocoapods-core/source/manager.rb', line 57

def all
  aggregate.sources
end

#master ⇒ Array<Source>

Returns The CocoaPods Master Repo source.

Returns:

  • (Array<Source>) —

    The CocoaPods Master Repo source.



63
64
65
 
# File 'lib/cocoapods-core/source/manager.rb', line 63

def master
  sources([Pod::MasterSource::MASTER_REPO_NAME]).select { |s| s.repo.directory? }
end

#master_repo_dir ⇒ Pathname

Returns The path of the master repo.

Returns:

  • (Pathname) —

    The path of the master repo.



71
72
73
 
# File 'lib/cocoapods-core/source/manager.rb', line 71

def master_repo_dir
  source_dir(Pod::MasterSource::MASTER_REPO_NAME)
end

#master_repo_functional? ⇒ Bool

Note:

Note this is used to automatically setup the master repo if needed.

Returns Checks if the master repo is usable.

Returns:

  • (Bool) —

    Checks if the master repo is usable.



80
81
82
83
 
# File 'lib/cocoapods-core/source/manager.rb', line 80

def master_repo_functional?
  return false unless master_repo = master.first
  master_repo.metadata.compatible?(CORE_VERSION)
end

#save_search_index(index) ⇒ Object

Stores given search data in the file system.

Parameters:

  • index (Hash) —

    Index to be saved in file system



267
268
269
270
271
272
273
 
# File 'lib/cocoapods-core/source/manager.rb', line 267

def save_search_index(index)
  require 'json'
  @updated_search_index = index
  search_index_path.open('w') do |io|
    io.write(@updated_search_index.to_json)
  end
end

#search(dependency) ⇒ Set?

Search the appropriate sources to match the set for the given dependency.

Returns:

  • (Set, nil) —

    a set for a given dependency including all the Pod::Source that contain the Pod. If no sources containing the Pod where found it returns nil.

Raises:

  • If no source can be found that includes the dependency.



93
94
95
 
# File 'lib/cocoapods-core/source/manager.rb', line 93

def search(dependency)
  aggregate_for_dependency(dependency).search(dependency)
end

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

Search all the sources with the given search term.

Parameters:

  • query (String) —

    The search term.

  • 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 sets that contain the search term.

Raises:

  • If no source including the set can be found.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cocoapods-core/source/manager.rb', line 111

def search_by_name(query, full_text_search = false)
  query_word_regexps = query.split.map { |word| /#{word}/i }
  if full_text_search
    query_word_results_hash = {}
    updated_search_index.each_value do |word_spec_hash|
      word_spec_hash.each_pair do |word, spec_names|
        query_word_regexps.each do |query_word_regexp|
          set = (query_word_results_hash[query_word_regexp] ||= Set.new)
          set.merge(spec_names) if word =~ query_word_regexp
        end
      end
    end
    found_set_names = query_word_results_hash.values.reduce(:&)
    found_set_names ||= []
    sets = found_set_names.map do |name|
      aggregate.representative_set(name)
    end
    # Remove nil values because representative_set return nil if no pod is found in any of the sources.
    sets.compact!
  else
    sets = aggregate.search_by_name(query, false)
  end
  if sets.empty?
    extra = ', author, summary, or description' if full_text_search
    raise Informative, "Unable to find a pod with name#{extra} " \
      "matching `#{query}`"
  end
  sorted_sets(sets, query_word_regexps)
end

#sorted_sets(sets, query_word_regexps) ⇒ Array<Set>

Returns given set array by sorting it in-place.

Parameters:

  • sets (Array<Set>) —

    Array of sets to be sorted.

  • query_word_regexps (Array<Regexp>) —

    Array of regexp objects for user query.

Returns:

  • (Array<Set>) —

    Given sets parameter itself after sorting it in-place.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/cocoapods-core/source/manager.rb', line 151

def sorted_sets(sets, query_word_regexps)
  sets.sort_by! do |set|
    pre_match_length = nil
    found_query_index = nil
    found_query_count = 0
    query_word_regexps.each_with_index do |q, idx|
      if (m = set.name.match(/#{q}/i))
        pre_match_length ||= m.pre_match.length
        found_query_index ||= idx
        found_query_count += 1
      end
    end
    pre_match_length ||= 1000
    found_query_index ||= 1000
    [-found_query_count, pre_match_length, found_query_index, set.name.downcase]
  end
  sets
end

#source_repos ⇒ Array<Pathname>

Returns The source repo directories.

Returns:

  • (Array<Pathname>) —

    The source repo directories.



15
16
17
18
 
# File 'lib/cocoapods-core/source/manager.rb', line 15

def source_repos
  return [] unless repos_dir.exist?
  repos_dir.children.select(&:directory?).sort_by { |d| d.basename.to_s.downcase }
end

#sources(names) ⇒ Array<Source>

Returns The list of the sources with the given names.

Parameters:

  • names (Array<#to_s>) —

    The names of the sources.

Returns:

  • (Array<Source>) —

    The list of the sources with the given names.



49
50
51
52
 
# File 'lib/cocoapods-core/source/manager.rb', line 49

def sources(names)
  dirs = names.map { |name| source_dir(name) }
  dirs.map { |repo| source_from_path(repo) }
end

#stored_search_index ⇒ Object

Returns the search data stored in the file system. If existing data in the file system is not valid, returns nil.



248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/cocoapods-core/source/manager.rb', line 248

def stored_search_index
  @updated_search_index ||= begin
    if search_index_path.exist?
      require 'json'
      begin
        index = JSON.parse(search_index_path.read)
        index if index.is_a?(Hash) # TODO: should we also check if hash has correct hierarchy?
      rescue JSON::ParserError
        search_index_path.delete
        nil
      end
    end
  end
end

#update_search_index_if_needed(changed_spec_paths) ⇒ Object

Updates the stored search index if there are changes in spec repos while updating them. Update is performed incrementally. Only the changed pods’ search data is re-generated and updated.

Parameters:

  • changed_spec_paths (Hash{Source => Array<String>}) —

    A hash containing changed specification paths for each source.



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
 
# File 'lib/cocoapods-core/source/manager.rb', line 202

def update_search_index_if_needed(changed_spec_paths)
  search_index = stored_search_index
  return unless search_index
  changed_spec_paths.each_pair do |source, spec_paths|
    index_for_source = search_index[source.name]
    next unless index_for_source && !spec_paths.empty?
    updated_pods = source.pods_for_specification_paths(spec_paths)

    new_index = aggregate.generate_search_index_for_changes_in_source(source, spec_paths)
    # First traverse search_index and update existing words
    # Remove traversed words from new_index after adding to search_index,
    # so that only non existing words will remain in new_index after enumeration completes.
    index_for_source.each_pair do |word, _|
      if new_index[word]
        index_for_source[word] |= new_index[word]
        new_index.delete(word)
      else
        index_for_source[word] -= updated_pods
      end
    end

    # Now add non existing words remained in new_index to search_index
    index_for_source.merge!(new_index)
  end
  save_search_index(search_index)
end

#update_search_index_if_needed_in_background(changed_spec_paths) ⇒ Object

Updates search index for changed pods in background

Parameters:

  • changed_spec_paths (Hash{Source => Array<String>}) —

    A hash containing changed specification paths for each source.



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/cocoapods-core/source/manager.rb', line 233

def update_search_index_if_needed_in_background(changed_spec_paths)
  if Gem.win_platform?
    update_search_index_if_needed(changed_spec_paths)
    return
  end
  Process.fork do
    Process.daemon
    update_search_index_if_needed(changed_spec_paths)
    exit
  end
end