Class: Pod::Specification::Consumer

Inherits:
Object
  • Object
show all
Defined in:
lib/cocoapods-core/specification/consumer.rb

Overview

Allows to conveniently access a Specification programmatically.

It takes care of:

  • standardizing the attributes

  • handling multi-platform values

  • handle default values

  • handle inherited values

This class allows to store the values of the attributes in the Specification as specified in the DSL. The benefits is reduced reliance on meta programming to access the attributes and the possibility of serializing a specification back exactly as defined in a file.

Instance Attribute Summary collapse

Regular attributes collapse

Test Support collapse

File patterns collapse

Preparing Values collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(spec, platform) ⇒ Consumer

Returns a new instance of Consumer.

Parameters:

  • spec (Specification) —

    @see spec

  • platform (Symbol, Platform) —

    The platform for which the specification needs to be consumed.



33
34
35
36
37
38
39
40
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 33

def initialize(spec, platform)
  @spec = spec
  @platform_name = platform.is_a?(Symbol) ? platform : platform.name

  unless spec.supported_on_platform?(platform)
    raise StandardError, "#{self} is not compatible with #{platform}."
  end
end

Instance Attribute Details

#platform_name ⇒ Symbol (readonly)

Returns The name of the platform for which the specification needs to be consumed.

Returns:

  • (Symbol) —

    The name of the platform for which the specification needs to be consumed.



27
28
29
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 27

def platform_name
  @platform_name
end

#spec ⇒ Specification (readonly)

Returns The specification to consume.

Returns:



22
23
24
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 22

def spec
  @spec
end

Class Method Details

.spec_attr_accessor(name) ⇒ Object

Creates a method to access the contents of the attribute.

Parameters:

  • name (Symbol) —

    the name of the attribute.



50
51
52
53
54
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 50

def self.spec_attr_accessor(name)
  define_method(name) do
    value_for_attribute(name)
  end
end

Instance Method Details

#_prepare_prefix_header_contents(value) ⇒ String

Converts the prefix header to a string if specified as an array.

Parameters:

  • value. (String, Array) —

    The value of the attribute as specified by the user.

Returns:

  • (String) —

    the prefix header.



367
368
369
370
371
372
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 367

def _prepare_prefix_header_contents(value)
  if value
    value = value.join("\n") if value.is_a?(Array)
    value.strip_heredoc.chomp
  end
end

#_prepare_resource_bundles(value) ⇒ Hash

Ensures that the file patterns of the resource bundles are contained in an array.

Parameters:

  • value. (String, Array, Hash) —

    The value of the attribute as specified by the user.

Returns:

  • (Hash) —

    the resources.



405
406
407
408
409
410
411
412
413
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 405

def _prepare_resource_bundles(value)
  result = {}
  if value
    value.each do |key, patterns|
      result[key] = [*patterns].compact
    end
  end
  result
end

#_prepare_script_phases(value) ⇒ Array<Hash{Symbol=>String}>

Converts the array of hashes (script phases) where keys are strings into symbols.

Parameters:

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

    The value of the attribute as specified by the user.

Returns:

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

    the script phases array with symbols for each hash instead of strings.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 381

def _prepare_script_phases(value)
  if value
    value.map do |script_phase|
      if script_phase.is_a?(Hash)
        phase = Specification.convert_keys_to_symbol(script_phase)
        phase[:execution_position] = if phase.key?(:execution_position)
                                       phase[:execution_position].to_sym
                                     else
                                       :any
                                     end
        phase
      end
    end.compact
  end
end

#compiler_flags ⇒ Array<String>

Returns the list of compiler flags needed by the specification files.

Returns:

  • (Array<String>) —

    the list of compiler flags needed by the specification files.



94
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 94

spec_attr_accessor :compiler_flags

#dependencies ⇒ Array<Dependency>

Returns the dependencies on other Pods.

Returns:

  • (Array<Dependency>) —

    the dependencies on other Pods.



207
208
209
210
211
212
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 207

def dependencies
  value = value_for_attribute(:dependencies)
  value.map do |name, requirements|
    Dependency.new(name, requirements)
  end
end

#exclude_files ⇒ Array<String>

Returns The file patterns that the Pod should ignore.

Returns:

  • (Array<String>) —

    The file patterns that the Pod should ignore.



196
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 196

spec_attr_accessor :exclude_files

#frameworks ⇒ Array<String>

Returns A list of frameworks that the user’s target needs to link against.

Returns:

  • (Array<String>) —

    A list of frameworks that the user’s target needs to link against



79
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 79

spec_attr_accessor :frameworks

#header_dir ⇒ String

Returns the headers directory.

Returns:

  • (String) —

    the headers directory.



130
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 130

spec_attr_accessor :header_dir

#header_mappings_dir ⇒ String

Returns the directory from where to preserve the headers namespacing.

Returns:

  • (String) —

    the directory from where to preserve the headers namespacing.



135
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 135

spec_attr_accessor :header_mappings_dir

#libraries ⇒ Array<String>

Returns A list of libraries that the user’s target needs to link against.

Returns:

  • (Array<String>) —

    A list of libraries that the user’s target needs to link against



89
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 89

spec_attr_accessor :libraries

#merge_values(attr, existing_value, new_value) ⇒ String, ...

Merges the values of an attribute, either because the attribute is multi platform or because it is inherited.

Parameters:

  • attr (Specification::DSL::Attribute) —

    the attribute for which that value is needed.

  • existing_value (String, Array, Hash) —

    the current value (the value of the parent or non-multiplatform value).

  • new_value (String, Array, Hash) —

    the value to append (the value of the spec or the multi-platform value).

Returns:

  • (String, Array, Hash) —

    The merged value.



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 296

def merge_values(attr, existing_value, new_value)
  return existing_value if new_value.nil?
  return new_value if existing_value.nil?

  if attr.types.include?(TrueClass)
    new_value.nil? ? existing_value : new_value
  elsif attr.container == Array
    r = [*existing_value] + [*new_value]
    r.compact
  elsif attr.container == Hash
    existing_value.merge(new_value) do |_, old, new|
      if new.is_a?(Array) || old.is_a?(Array)
        r = [*old] + [*new]
        r.compact
      else
        old + ' ' + new
      end
    end
  else
    new_value
  end
end

#module_map ⇒ String

Returns the path of the module map file.

Returns:

  • (String) —

    the path of the module map file.



126
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 126

spec_attr_accessor :module_map

#module_name ⇒ String

Returns the module name.

Returns:

  • (String) —

    the module name.



122
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 122

spec_attr_accessor :module_name

#name ⇒ String

Returns The name of the specification.

Returns:

  • (String) —

    The name of the specification.



68
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 68

spec_attr_accessor :name

#pod_target_xcconfig ⇒ Hash{String => String}

Returns the xcconfig flags for the current specification for the pod target.

Returns:

  • (Hash{String => String}) —

    the xcconfig flags for the current specification for the pod target.



99
100
101
102
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 99

def pod_target_xcconfig
  attr = Specification::DSL.attributes[:pod_target_xcconfig]
  merge_values(attr, value_for_attribute(:xcconfig), value_for_attribute(:pod_target_xcconfig))
end

#prefix_header_contents ⇒ String

Returns The contents of the prefix header.

Returns:

  • (String) —

    The contents of the prefix header.



114
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 114

spec_attr_accessor :prefix_header_contents

#prefix_header_file ⇒ String

Returns The path of the prefix header file.

Returns:

  • (String) —

    The path of the prefix header file.



118
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 118

spec_attr_accessor :prefix_header_file

#prepare_hook_name(attr) ⇒ String

Note:

The hook is called after the value has been wrapped in an array (if needed according to the container) but before validation.

Returns the name of the prepare hook for this attribute.

Returns:

  • (String) —

    the name of the prepare hook for this attribute.



356
357
358
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 356

def prepare_hook_name(attr)
  "_prepare_#{attr.name}"
end

#prepare_value(attr, value) ⇒ Object

Note:

Only array containers are wrapped. To automatically wrap values for attributes with hash containers a prepare hook should be used.

Wraps a value in an Array if needed and calls the prepare hook to allow further customization of a value before storing it in the instance variable.

Returns:

  • (Object) —

    the customized value of the original one if no prepare hook was defined.



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 330

def prepare_value(attr, value)
  if attr.container == Array
    value = if value.is_a?(Hash)
              [value]
            else
              [*value].compact
            end
  end

  hook_name = prepare_hook_name(attr)
  if self.respond_to?(hook_name, true)
    send(hook_name, value)
  else
    value
  end
end

#preserve_paths ⇒ Array<String>

Returns The paths that should be not cleaned.

Returns:

  • (Array<String>) —

    The paths that should be not cleaned.



201
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 201

spec_attr_accessor :preserve_paths

#private_header_files ⇒ Array<String>

Returns the private headers of the Pod.

Returns:

  • (Array<String>) —

    the private headers of the Pod.



164
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 164

spec_attr_accessor :private_header_files

#public_header_files ⇒ Array<String>

Returns the public headers of the Pod.

Returns:

  • (Array<String>) —

    the public headers of the Pod.



160
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 160

spec_attr_accessor :public_header_files

#raw_value_for_attribute(the_spec, attr) ⇒ String, ...

Returns the value of a given attribute taking into account multi platform values.

Parameters:

Returns:

  • (String, Array, Hash) —

    The value for an attribute.



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 266

def raw_value_for_attribute(the_spec, attr)
  value = the_spec.attributes_hash[attr.name.to_s]
  value = prepare_value(attr, value)

  if attr.multi_platform?
    if platform_hash = the_spec.attributes_hash[platform_name.to_s]
      platform_value = platform_hash[attr.name.to_s]
      platform_value = prepare_value(attr, platform_value)
      value = merge_values(attr, value, platform_value)
    end
  end
  value
end

#requires_app_host ⇒ Bool Also known as: requires_app_host?

Returns Whether this test specification requires an app host.

Returns:

  • (Bool) —

    Whether this test specification requires an app host.



143
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 143

spec_attr_accessor :requires_app_host

#requires_arc ⇒ Bool Also known as: requires_arc?

Returns Whether the source files of the specification require to be compiled with ARC.

Returns:

  • (Bool) —

    Whether the source files of the specification require to be compiled with ARC.



73
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 73

spec_attr_accessor :requires_arc

#resource_bundles ⇒ Hash{String=>String}

Returns ] hash where the keys are the names of the resource bundles and the values are their relative file patterns.

Returns:

  • (Hash{String=>String}) —

    ] hash where the keys are the names of the resource bundles and the values are their relative file patterns.



180
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 180

spec_attr_accessor :resource_bundles

#resources ⇒ Array<String>

Returns A hash where the key represents the paths of the resources to copy and the values the paths of the resources that should be copied.

Returns:

  • (Array<String>) —

    A hash where the key represents the paths of the resources to copy and the values the paths of the resources that should be copied.



191
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 191

spec_attr_accessor :resources

#script_phases ⇒ Array<Hash{Symbol=>String}>

Returns An array of hashes where each hash represents a script phase.

Returns:

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

    An array of hashes where each hash represents a script phase.



185
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 185

spec_attr_accessor :script_phases

#source_files ⇒ Array<String>

Returns the source files of the Pod.

Returns:

  • (Array<String>) —

    the source files of the Pod.



156
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 156

spec_attr_accessor :source_files

#test_type ⇒ Symbol

Returns the test type supported by this specification.

Returns:

  • (Symbol) —

    the test type supported by this specification.



148
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 148

spec_attr_accessor :test_type

#user_target_xcconfig ⇒ Hash{String => String}

Returns the xcconfig flags for the current specification for the user target.

Returns:

  • (Hash{String => String}) —

    the xcconfig flags for the current specification for the user target.



107
108
109
110
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 107

def user_target_xcconfig
  attr = Specification::DSL.attributes[:user_target_xcconfig]
  merge_values(attr, value_for_attribute(:xcconfig), value_for_attribute(:user_target_xcconfig))
end

#value_for_attribute(attr_name) ⇒ String, ...

Returns the value for the attribute with the given name for the specification. It takes into account inheritance, multi-platform attributes and default values.

Parameters:

  • attr_name (Symbol) —

    The name of the attribute.

Returns:

  • (String, Array, Hash) —

    the value for the attribute.



227
228
229
230
231
232
233
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 227

def value_for_attribute(attr_name)
  attr = Specification::DSL.attributes[attr_name]
  value = value_with_inheritance(spec, attr)
  value = attr.default(platform_name) if value.nil?
  value = attr.container.new if value.nil? && attr.container
  value
end

#value_with_inheritance(the_spec, attr) ⇒ String, ...

Returns the value of a given attribute taking into account inheritance.

Parameters:

Returns:

  • (String, Array, Hash) —

    the value for the attribute.



245
246
247
248
249
250
251
252
253
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 245

def value_with_inheritance(the_spec, attr)
  value = raw_value_for_attribute(the_spec, attr)
  if the_spec.root? || !attr.inherited?
    return value
  end

  parent_value = value_with_inheritance(the_spec.parent, attr)
  merge_values(attr, parent_value, value)
end

#vendored_frameworks ⇒ Array<String>

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

Returns:

  • (Array<String>) —

    The paths of the framework bundles shipped with the Pod.



169
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 169

spec_attr_accessor :vendored_frameworks

#vendored_libraries ⇒ Array<String>

Returns The paths of the libraries shipped with the Pod.

Returns:

  • (Array<String>) —

    The paths of the libraries shipped with the Pod.



174
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 174

spec_attr_accessor :vendored_libraries

#weak_frameworks ⇒ Array<String>

Returns A list of frameworks that the user’s target needs to weakly link against.

Returns:

  • (Array<String>) —

    A list of frameworks that the user’s target needs to weakly link against



84
 
# File 'lib/cocoapods-core/specification/consumer.rb', line 84

spec_attr_accessor :weak_frameworks