Class: Pod::Sandbox::FileAccessor

Inherits:
Object
  • Object
show all
Defined in:
lib/cocoapods/sandbox/file_accessor.rb

Overview

Note:

The FileAccessor always returns absolute paths.

Resolves the file patterns of a specification against its root directory, taking into account any exclude pattern and the default extensions to use for directories.

Constant Summary collapse

HEADER_EXTENSIONS = 
Xcodeproj::Constants::HEADER_FILES_EXTENSIONS
SOURCE_FILE_EXTENSIONS = 
(%w(.m .mm .i .c .cc .cxx .cpp .c++ .swift) + HEADER_EXTENSIONS).uniq.freeze
GLOB_PATTERNS = 
{
  :readme              => 'readme{*,.*}'.freeze,
  :license             => 'licen{c,s}e{*,.*}'.freeze,
  :source_files        => "*{#{SOURCE_FILE_EXTENSIONS.join(',')}}".freeze,
  :public_header_files => "*{#{HEADER_EXTENSIONS.join(',')}}".freeze,
  :podspecs            => '*.{podspec,podspec.json}'.freeze,
  :docs                => 'doc{s}{*,.*}/**/*'.freeze,
}.freeze

Instance Attribute Summary collapse

Paths collapse

Private paths collapse

Private helpers collapse

Instance Method Summary collapse

Constructor Details

#initialize(path_list, spec_consumer) ⇒ FileAccessor

Initialize a new instance

Parameters:

  • path_list (Sandbox::PathList, Pathname) —

    @see #path_list

  • spec_consumer (Specification::Consumer) —

    @see #spec_consumer


39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 39

def initialize(path_list, spec_consumer)
  if path_list.is_a?(PathList)
    @path_list = path_list
  else
    @path_list = PathList.new(path_list)
  end
  @spec_consumer = spec_consumer

  unless @spec_consumer
    raise Informative, 'Attempt to initialize File Accessor without a specification consumer.'
  end
end

Instance Attribute Details

#path_list ⇒ Sandbox::PathList (readonly)

Returns the directory where the source of the Pod is located.

Returns:


27
28
29
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 27

def path_list
  @path_list
end

#spec_consumer ⇒ Specification::Consumer (readonly)

Returns the consumer of the specification for which the file patterns should be resolved.

Returns:

  • (Specification::Consumer) —

    the consumer of the specification for which the file patterns should be resolved.


32
33
34
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 32

def spec_consumer
  @spec_consumer
end

Class Method Details

.all_files(file_accessors) ⇒ Array<String>

Returns The list of all file accessors that a target will integrate into the project.

Parameters:

  • file_accessors (Array<FileAccessor>) —

    The list of all file accessors to compute.

Returns:

  • (Array<String>) —

    The list of all file accessors that a target will integrate into the project.


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 196

def self.all_files(file_accessors)
  files = [
    file_accessors.map(&:vendored_frameworks),
    file_accessors.map(&:vendored_libraries),
    file_accessors.map(&:resource_bundle_files),
    file_accessors.map(&:license),
    file_accessors.map(&:prefix_header),
    file_accessors.map(&:preserve_paths),
    file_accessors.map(&:readme),
    file_accessors.map(&:resources),
    file_accessors.map(&:source_files),
    file_accessors.map(&:module_map),
  ]
  files.flatten.compact.map(&:to_s).uniq
end

.vendored_frameworks_headers(framework) ⇒ Array<Pathname>

Returns The paths of the headers included in the vendored framework.

Parameters:

  • framework (Pathname) —

    The vendored framework to search into.

Returns:

  • (Array<Pathname>) —

    The paths of the headers included in the vendored framework.


227
228
229
230
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 227

def self.vendored_frameworks_headers(framework)
  headers_dir = vendored_frameworks_headers_dir(framework)
  Pathname.glob(headers_dir + '**/' + GLOB_PATTERNS[:public_header_files])
end

.vendored_frameworks_headers_dir(framework) ⇒ Pathname

Returns The path of the header directory of the vendored framework.

Parameters:

  • framework (Pathname) —

    The vendored framework to search into.

Returns:

  • (Pathname) —

    The path of the header directory of the vendored framework.


217
218
219
220
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 217

def self.vendored_frameworks_headers_dir(framework)
  dir = framework + 'Headers'
  dir.directory? ? dir.realpath : dir
end

.vendored_xcframework_headers(framework) ⇒ Array<Pathname>

Returns The paths to all the headers included in the vendored xcframework.

Parameters:

  • framework (Pathname) —

    The path to the .xcframework

Returns:

  • (Array<Pathname>) —

    The paths to all the headers included in the vendored xcframework


238
239
240
241
242
243
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 238

def self.vendored_xcframework_headers(framework)
  xcframework = Xcode::XCFramework.new(framework)
  xcframework.slices.flat_map do |slice|
    vendored_frameworks_headers(slice.path)
  end
end

Instance Method Details

#arc_source_files ⇒ Array<Pathname>

Returns the source files of the specification that use ARC.

Returns:

  • (Array<Pathname>) —

    the source files of the specification that use ARC.


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

def arc_source_files
  case spec_consumer.requires_arc
  when TrueClass
    source_files
  when FalseClass
    []
  else
    paths_for_attribute(:requires_arc) & source_files
  end
end

#developer_files ⇒ Array<Pathname>

Returns Paths to include for local pods to assist in development.

Returns:

  • (Array<Pathname>) —

    Paths to include for local pods to assist in development


370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 370

def developer_files
  podspecs = specs
  result = [module_map, prefix_header]

  if license_path = spec_consumer.license[:file]
    license_path = root + license_path
    unless File.exist?(license_path)
      UI.warn "A license was specified in podspec `#{spec.name}` but the file does not exist - #{license_path}"
    end
  end

  if podspecs.size <= 1
    result += [license, readme, podspecs, docs]
  else
    # Manually add non-globbing files since there are multiple podspecs in the same folder
    result << podspec_file
    if license_file = spec_license
      absolute_path = root + license_file
      result << absolute_path if File.exist?(absolute_path)
    end
  end
  result.compact.flatten.sort
end

#docs ⇒ Array<Pathname>

Returns The paths of auto-detected docs.

Returns:

  • (Array<Pathname>) —

    The paths of auto-detected docs


354
355
356
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 354

def docs
  path_list.glob([GLOB_PATTERNS[:docs]])
end

#expanded_paths(patterns, options = {}) ⇒ Array<Pathname> (private)

Matches the given patterns to the file present in the root of the path list.

Parameters:

  • patterns (Array<String>) —

    The patterns to expand.

  • options (Hash) (defaults to: {}) —

    The options to use to expand the patterns to file paths.

Options Hash (options):

  • :dir_pattern (String) —

    The pattern to add to directories.

  • :exclude_patterns (Array<String>) —

    The exclude patterns to pass to the PathList.

  • :include_dirs (Bool) —

    Whether directories should be also included or just plain files.

Returns:

  • (Array<Pathname>) —

    A list of the paths.

Raises:


468
469
470
471
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 468

def expanded_paths(patterns, options = {})
  return [] if patterns.empty?
  path_list.glob(patterns, options).flatten.compact.uniq
end

#headers ⇒ Array<Pathname>

Returns the headers of the specification.

Returns:

  • (Array<Pathname>) —

    the headers of the specification.


118
119
120
121
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 118

def headers
  extensions = HEADER_EXTENSIONS
  source_files.select { |f| extensions.include?(f.extname) }
end

#inspect ⇒ String

Returns A string suitable for debugging.

Returns:

  • (String) —

    A string suitable for debugging.


72
73
74
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 72

def inspect
  "<#{self.class} spec=#{spec.name} platform=#{platform_name} root=#{root}>"
end

#license ⇒ Pathname

Returns The path of the license file as indicated in the specification or auto-detected.

Returns:

  • (Pathname) —

    The path of the license file as indicated in the specification or auto-detected.


334
335
336
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 334

def license
  spec_license || path_list.glob([GLOB_PATTERNS[:license]]).first
end

#module_map ⇒ Pathname, Nil

Returns The path of the custom module map file of the specification, if specified.

Returns:

  • (Pathname, Nil) —

    The path of the custom module map file of the specification, if specified.


340
341
342
343
344
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 340

def module_map
  if module_map = spec_consumer.module_map
    path_list.root + module_map
  end
end

#non_arc_source_files ⇒ Array<Pathname>

Returns the source files of the specification that do not use ARC.

Returns:

  • (Array<Pathname>) —

    the source files of the specification that do not use ARC.


105
106
107
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 105

def non_arc_source_files
  source_files - arc_source_files
end

#other_source_files ⇒ Array<Pathname] the source files that do not match any of the recognized file extensions

Returns Array<Pathname] the source files that do not match any of the recognized file extensions.

Returns:

  • (Array<Pathname] the source files that do not match any of the recognized file extensions) —

    Array<Pathname] the source files that do not match any of the recognized file extensions


111
112
113
114
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 111

def other_source_files
  extensions = SOURCE_FILE_EXTENSIONS
  source_files.reject { |f| extensions.include?(f.extname) }
end

#paths_for_attribute(attribute, include_dirs = false) ⇒ Array<Pathname> (private)

Returns the list of the paths founds in the file system for the attribute with given name. It takes into account any dir pattern and any file excluded in the specification.

Parameters:

  • attribute (Symbol) —

    the name of the attribute.

Returns:

  • (Array<Pathname>) —

    the paths.


435
436
437
438
439
440
441
442
443
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 435

def paths_for_attribute(attribute, include_dirs = false)
  file_patterns = spec_consumer.send(attribute)
  options = {
    :exclude_patterns => spec_consumer.exclude_files,
    :dir_pattern => GLOB_PATTERNS[attribute],
    :include_dirs => include_dirs,
  }
  expanded_paths(file_patterns, options)
end

#platform_name ⇒ Specification

Returns the platform used to consume the specification.

Returns:

  • (Specification) —

    the platform used to consume the specification.


66
67
68
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 66

def platform_name
  spec_consumer.platform_name
end

#podspec_file ⇒ Pathname (private)

Returns The path of the podspec matching @spec.

Returns:

  • (Pathname) —

    The path of the podspec matching @spec


416
417
418
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 416

def podspec_file
  specs.lazy.select { |p| File.basename(p.to_s, '.*') == spec.name }.first
end

#prefix_header ⇒ Pathname

Returns The of the prefix header file of the specification.

Returns:

  • (Pathname) —

    The of the prefix header file of the specification.


319
320
321
322
323
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 319

def prefix_header
  if file = spec_consumer.prefix_header_file
    path_list.root + file
  end
end

#preserve_paths ⇒ Array<Pathname>

Returns the files of the specification to preserve.

Returns:

  • (Array<Pathname>) —

    the files of the specification to preserve.


155
156
157
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 155

def preserve_paths
  paths_for_attribute(:preserve_paths, true)
end

#private_header_files ⇒ Array<Pathname> (private)

Returns The paths of the user-specified public header files.

Returns:

  • (Array<Pathname>) —

    The paths of the user-specified public header files.


410
411
412
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 410

def private_header_files
  paths_for_attribute(:private_header_files)
end

#private_headers ⇒ Array<Pathname>

Returns The private headers of the specification.

Returns:

  • (Array<Pathname>) —

    The private headers of the specification.


143
144
145
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 143

def private_headers
  private_header_files
end

#public_header_files ⇒ Array<Pathname> (private)

Returns The paths of the user-specified public header files.

Returns:

  • (Array<Pathname>) —

    The paths of the user-specified public header files.


403
404
405
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 403

def public_header_files
  paths_for_attribute(:public_header_files)
end

#public_headers(include_frameworks = false) ⇒ Array<Pathname>

Returns the public headers of the specification.

Parameters:

  • include_frameworks (Boolean) (defaults to: false) —

    Whether or not to include the headers of the vendored frameworks. Defaults to not include them.

Returns:

  • (Array<Pathname>) —

    the public headers of the specification.


129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 129

def public_headers(include_frameworks = false)
  public_headers = public_header_files
  private_headers = private_header_files
  if public_headers.nil? || public_headers.empty?
    header_files = headers
  else
    header_files = public_headers
  end
  header_files += vendored_frameworks_headers if include_frameworks
  header_files - private_headers
end

#readme ⇒ Pathname

Returns The path of the auto-detected README file.

Returns:

  • (Pathname) —

    The path of the auto-detected README file.


327
328
329
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 327

def readme
  path_list.glob([GLOB_PATTERNS[:readme]]).first
end

#resource_bundle_files ⇒ Array<Pathname>

Returns The paths of the files which should be included in resources bundles by the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the files which should be included in resources bundles by the Pod.


313
314
315
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 313

def resource_bundle_files
  resource_bundles.values.flatten
end

#resource_bundles ⇒ Hash{String => Array<Pathname>}

Returns A hash that describes the resource bundles of the Pod. The keys represent the name of the bundle while the values the path of the resources.

Returns:

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

    A hash that describes the resource bundles of the Pod. The keys represent the name of the bundle while the values the path of the resources.


299
300
301
302
303
304
305
306
307
308
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 299

def resource_bundles
  result = {}
  spec_consumer.resource_bundles.each do |name, file_patterns|
    paths = expanded_paths(file_patterns,
                           :exclude_patterns => spec_consumer.exclude_files,
                           :include_dirs => true)
    result[name] = paths
  end
  result
end

#resources ⇒ Array<Pathname>

Returns the resources of the specification.

Returns:

  • (Array<Pathname>) —

    the resources of the specification.


149
150
151
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 149

def resources
  paths_for_attribute(:resources, true)
end

#root ⇒ Pathname

Returns the directory which contains the files of the Pod.

Returns:

  • (Pathname) —

    the directory which contains the files of the Pod.


54
55
56
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 54

def root
  path_list.root if path_list
end

#source_files ⇒ Array<Pathname>

Returns the source files of the specification.

Returns:

  • (Array<Pathname>) —

    the source files of the specification.


84
85
86
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 84

def source_files
  paths_for_attribute(:source_files)
end

#spec ⇒ Specification

Returns the specification.

Returns:


60
61
62
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 60

def spec
  spec_consumer.spec
end

#spec_license ⇒ Pathname

Returns The path of the license file specified in the specification, if it exists.

Returns:

  • (Pathname) —

    The path of the license file specified in the specification, if it exists


361
362
363
364
365
366
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 361

def spec_license
  if file = spec_consumer.license[:file]
    absolute_path = root + file
    absolute_path if File.exist?(absolute_path)
  end
end

#specs ⇒ Array<Pathname>

Returns The paths of auto-detected podspecs.

Returns:

  • (Array<Pathname>) —

    The paths of auto-detected podspecs


348
349
350
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 348

def specs
  path_list.glob([GLOB_PATTERNS[:podspecs]])
end

#vendored_dynamic_artifacts ⇒ Array<Pathname>

Returns The paths of the dynamic binary artifacts that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the dynamic binary artifacts that come shipped with the Pod.


284
285
286
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 284

def vendored_dynamic_artifacts
  vendored_dynamic_libraries + vendored_dynamic_frameworks
end

#vendored_dynamic_frameworks ⇒ Array<Pathname>

Returns The paths of the dynamic framework bundles that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the dynamic framework bundles that come shipped with the Pod.


169
170
171
172
173
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 169

def vendored_dynamic_frameworks
  (vendored_frameworks - vendored_xcframeworks).select do |framework|
    Xcode::LinkageAnalyzer.dynamic_binary?(framework + framework.basename('.*'))
  end
end

#vendored_dynamic_libraries ⇒ Array<Pathname>

Returns The paths of the dynamic libraries that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the dynamic libraries that come shipped with the Pod.


268
269
270
271
272
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 268

def vendored_dynamic_libraries
  vendored_libraries.select do |library|
    Xcode::LinkageAnalyzer.dynamic_binary?(library)
  end
end

#vendored_frameworks ⇒ Array<Pathname>

Returns The paths of the framework bundles that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the framework bundles that come shipped with the Pod.


162
163
164
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 162

def vendored_frameworks
  paths_for_attribute(:vendored_frameworks, true)
end

#vendored_frameworks_headers ⇒ Array<Pathname>

Returns The paths of the framework headers that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the framework headers that come shipped with the Pod.


248
249
250
251
252
253
254
255
256
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 248

def vendored_frameworks_headers
  paths = (vendored_frameworks - vendored_xcframeworks).flat_map do |framework|
    self.class.vendored_frameworks_headers(framework)
  end.uniq
  paths.concat Array.new(vendored_xcframeworks.flat_map do |framework|
    self.class.vendored_xcframework_headers(framework)
  end)
  paths
end

#vendored_libraries ⇒ Array<Pathname>

Returns The paths of the library bundles that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the library bundles that come shipped with the Pod.


261
262
263
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 261

def vendored_libraries
  paths_for_attribute(:vendored_libraries)
end

#vendored_static_artifacts ⇒ Array<Pathname>

Returns The paths of the static binary artifacts that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the static binary artifacts that come shipped with the Pod.


291
292
293
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 291

def vendored_static_artifacts
  vendored_static_libraries + vendored_static_frameworks
end

#vendored_static_frameworks ⇒ Array<Pathname>

Returns The paths of the static (fake) framework bundles that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the static (fake) framework bundles that come shipped with the Pod.


178
179
180
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 178

def vendored_static_frameworks
  vendored_frameworks - vendored_dynamic_frameworks - vendored_xcframeworks
end

#vendored_static_libraries ⇒ Array<Pathname>

Returns The paths of the static libraries that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of the static libraries that come shipped with the Pod.


277
278
279
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 277

def vendored_static_libraries
  vendored_libraries - vendored_dynamic_libraries
end

#vendored_xcframeworks ⇒ Array<Pathname>

Returns The paths of vendored .xcframework bundles that come shipped with the Pod.

Returns:

  • (Array<Pathname>) —

    The paths of vendored .xcframework bundles that come shipped with the Pod.


185
186
187
188
189
 
# File 'lib/cocoapods/sandbox/file_accessor.rb', line 185

def vendored_xcframeworks
  vendored_frameworks.select do |framework|
    File.extname(framework) == '.xcframework'
  end
end