cocoapods-core 0.30.0 → 1.15.2

data/lib/cocoapods-core/specification/consumer.rb

@@ -1,8 +1,7 @@
-require 'active_support/core_ext/string/strip.rb'
+require 'cocoapods-core/specification/root_attribute_accessors'
 
 module Pod
   class Specification
-
     # Allows to conveniently access a Specification programmatically.
     #
     # It takes care of:
@@ -10,6 +9,7 @@ module Pod
     # - standardizing the attributes
     # - handling multi-platform values
     # - handle default values
+    # - handle automatic container wrapping of values
     # - handle inherited values
     #
     # This class allows to store the values of the attributes in the
@@ -18,7 +18,6 @@ module Pod
     # serializing a specification back exactly as defined in a file.
     #
     class Consumer
-
       # @return [Specification] The specification to consume.
       #
       attr_reader :spec
@@ -55,11 +54,21 @@ module Pod
         end
       end
 
+      DSL::RootAttributesAccessors.instance_methods.each do |root_accessor|
+        define_method(root_accessor) do
+          spec.root.send(root_accessor)
+        end
+      end
+
       #-----------------------------------------------------------------------#
 
       # @!group Regular attributes
 
-      # @return [Bool] Whether the source files of the specification require to
+      # @return [String] The name of the specification.
+      #
+      spec_attr_accessor :name
+
+      # @return [Boolean] Whether the source files of the specification require to
       #         be compiled with ARC.
       #
       spec_attr_accessor :requires_arc
@@ -86,9 +95,24 @@ module Pod
       spec_attr_accessor :compiler_flags
 
       # @return [Hash{String => String}] the xcconfig flags for the current
-      #         specification.
+      #         specification for the pod target.
+      #
+      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
+
+      # @return [Hash{String => String}] the xcconfig flags for the current
+      #         specification for the user target.
+      #
+      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
+
+      # @return [Hash{String => String}] the Info.plist values for the current specification
       #
-      spec_attr_accessor :xcconfig
+      spec_attr_accessor :info_plist
 
       # @return [String] The contents of the prefix header.
       #
@@ -98,6 +122,14 @@ module Pod
       #
       spec_attr_accessor :prefix_header_file
 
+      # @return [String] the module name.
+      #
+      spec_attr_accessor :module_name
+
+      # @return [String] the path of the module map file.
+      #
+      spec_attr_accessor :module_map
+
       # @return [String] the headers directory.
       #
       spec_attr_accessor :header_dir
@@ -109,6 +141,23 @@ module Pod
 
       #-----------------------------------------------------------------------#
 
+      # @!group Test Support
+
+      # @return [Boolean] Whether this test specification requires an app host.
+      #
+      spec_attr_accessor :requires_app_host
+      alias_method :requires_app_host?, :requires_app_host
+
+      # @return [String] Name of the app host this spec requires
+      #
+      spec_attr_accessor :app_host_name
+
+      # @return [Symbol] the test type supported by this specification.
+      #
+      spec_attr_accessor :test_type
+
+      #-----------------------------------------------------------------------#
+
       # @!group File patterns
 
       # @return [Array<String>] the source files of the Pod.
@@ -119,6 +168,10 @@ module Pod
       #
       spec_attr_accessor :public_header_files
 
+      # @return [Array<String>] the project headers of the Pod.
+      #
+      spec_attr_accessor :project_header_files
+
       # @return [Array<String>] the private headers of the Pod.
       #
       spec_attr_accessor :private_header_files
@@ -133,12 +186,27 @@ module Pod
       #
       spec_attr_accessor :vendored_libraries
 
-      # @return [Hash{String=>String}]]  hash where the keys are the names of
+      # @return [Hash{String => Array<String>}] hash where the keys are the tags of
+      #         the on demand resources and the values are their relative file
+      #         patterns.
+      #
+      spec_attr_accessor :on_demand_resources
+
+      # @return [Hash{String=>String}]] hash where the keys are the names of
       #         the resource bundles and the values are their relative file
       #         patterns.
       #
       spec_attr_accessor :resource_bundles
 
+      # @return [Array<Hash{Symbol=>String}>] An array of hashes where each hash
+      #         represents a script phase.
+      #
+      spec_attr_accessor :script_phases
+
+      # @return [Hash] A hash that contains the scheme configuration.
+      #
+      spec_attr_accessor :scheme
+
       # @return [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.
@@ -157,8 +225,6 @@ module Pod
 
       #-----------------------------------------------------------------------#
 
-      # @!group Dependencies
-
       # @return [Array<Dependency>] the dependencies on other Pods.
       #
       def dependencies
@@ -168,10 +234,10 @@ module Pod
         end
       end
 
+      # Raw values need to be prepared as soon as they are read so they can be
+      # safely merged to support multi platform attributes and inheritance
       #-----------------------------------------------------------------------#
 
-      private
-
       # Returns the value for the attribute with the given name for the
       # specification. It takes into account inheritance, multi-platform
       # attributes and default values.
@@ -184,8 +250,8 @@ module Pod
       def value_for_attribute(attr_name)
         attr = Specification::DSL.attributes[attr_name]
         value = value_with_inheritance(spec, attr)
-        value ||= attr.default(platform_name)
-        value ||= attr.container.new if attr.container
+        value = attr.default(platform_name) if value.nil?
+        value = attr.container.new if value.nil? && attr.container
         value
       end
 
@@ -261,12 +327,7 @@ module Pod
           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
+            merge_hash_value(attr, old, new)
           end
         else
           new_value
@@ -285,49 +346,53 @@ module Pod
       #         prepare hook was defined.
       #
       def prepare_value(attr, value)
-        if attr.container ==  Array
-          value = [*value].compact
+        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)
-          value = send(hook_name, value)
+          send(hook_name, value)
         else
           value
         end
       end
 
-      #-----------------------------------------------------------------------#
-
       private
 
-      # Converts the keys of the given hash to a string.
+      # Merges two values in a hash together based on the needs of the attribute
       #
-      # @todo   Removed if not used by `resources_bundle`
+      # @param  [Specification::DSL::Attribute] attr
+      #         the attribute for which that value is needed.
       #
-      # @param  [Object] value
-      #         the value that needs to be stripped from the Symbols.
+      # @param  [Object] old the value from the original hash
       #
-      # @return [Hash] the hash with the strings instead of the keys.
+      # @param  [Object] new the value from the new hash
       #
-      # def convert_keys_to_symbol(value)
-      #   return unless value
-      #   result = {}
-      #   value.each do |key, subvalue|
-      #     subvalue = convert_keys_to_symbol(subvalue) if subvalue.is_a?(Hash)
-      #     result[key.to_sym] = subvalue
-      #   end
-      #   result
-      # end
-
-      #-----------------------------------------------------------------------#
-
-      private
+      # @return [Object] the merged value
+      #
+      def merge_hash_value(attr, old, new)
+        case attr.name
+        when :info_plist
+          new
+        when ->(name) { spec.non_library_specification? && [:pod_target_xcconfig, :user_target_xcconfig, :xcconfig].include?(name) }
+          new
+        else
+          if new.is_a?(Array) || old.is_a?(Array)
+            r = Array(old) + Array(new)
+            r.compact
+          else
+            old + ' ' + new
+          end
+        end
+      end
 
       # @!group Preparing Values
-      #
-      # Raw values need to be prepared as soon as they are read so they can be
-      # safely merged to support multi platform attributes and inheritance
+      #-----------------------------------------------------------------------#
 
       # @return [String] the name of the prepare hook for this attribute.
       #
@@ -347,7 +412,83 @@ module Pod
       # @return [String] the prefix header.
       #
       def _prepare_prefix_header_contents(value)
-        value.is_a?(Array) ? value * "\n" : value
+        if value
+          value = value.join("\n") if value.is_a?(Array)
+          value.strip_heredoc.chomp
+        end
+      end
+
+      # Converts the test type value from a string to a symbol.
+      #
+      # @param  [String, Symbol] value.
+      #         The value of the test type attributed as specified by the user.
+      #
+      # @return [Symbol] the test type as a symbol.
+      #
+      def _prepare_test_type(value)
+        if value
+          value.to_sym
+        end
+      end
+
+      # Converts the array of hashes (script phases) where keys are strings into symbols.
+      #
+      # @param  [Array<Hash{String=>String}>] value.
+      #         The value of the attribute as specified by the user.
+      #
+      # @return [Array<Hash{Symbol=>String}>] the script phases array with symbols for each hash instead of strings.
+      #
+      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
+
+      # Converts the a scheme where keys are strings into symbols.
+      #
+      # @param  [Hash] value.
+      #         The value of the attribute as specified by the user.
+      #
+      # @return [Hash] the scheme with symbols as keys instead of strings or `nil` if the value is not a hash.
+      #
+      def _prepare_scheme(value)
+        Specification.convert_keys_to_symbol(value, :recursive => false) if value && value.is_a?(Hash)
+      end
+
+      # Ensures that the file patterns of the on demand resources are contained in
+      # an array.
+      #
+      # @param  [String, Array, Hash] value.
+      #         The value of the attribute as specified by the user.
+      #
+      # @return [Hash] the on demand resources.
+      #
+      def _prepare_on_demand_resources(value)
+        result = {}
+        if value
+          value.each do |key, patterns|
+            case patterns
+            when String, Array
+              result[key] = { :paths => [*patterns].compact, :category => :download_on_demand }
+            when Hash
+              patterns = Specification.convert_keys_to_symbol(patterns, :recursive => false)
+              result[key] = { :paths => [*patterns[:paths]].compact, :category => patterns.fetch(:category, :download_on_demand).to_sym }
+            else
+              raise StandardError, "Unknown on demand resource value type `#{patterns}`."
+            end
+          end
+        end
+        result
       end
 
       # Ensures that the file patterns of the resource bundles are contained in
@@ -369,7 +510,6 @@ module Pod
       end
 
       #-----------------------------------------------------------------------#
-
     end
   end
 end

data/lib/cocoapods-core/specification/dsl/attribute.rb

@@ -1,14 +1,16 @@
 module Pod
   class Specification
     module DSL
-
       # A Specification attribute stores the information of an attribute. It
       # also provides logic to implement any required logic.
       #
       class Attribute
-
         require 'active_support/inflector/inflections'
 
+        # Spec types currently supported.
+        #
+        SUPPORTED_SPEC_TYPES = [:library, :app, :test].freeze
+
         # @return [Symbol] the name of the attribute.
         #
         attr_reader :name
@@ -31,22 +33,26 @@ module Pod
         def initialize(name, options)
           @name = name
 
-          @multi_platform = options.delete(:multi_platform) { true      }
-          @inherited      = options.delete(:inherited)      { false     }
-          @root_only      = options.delete(:root_only)      { false     }
-          @required       = options.delete(:required)       { false     }
-          @singularize    = options.delete(:singularize)    { false     }
-          @file_patterns  = options.delete(:file_patterns)  { false     }
-          @container      = options.delete(:container)      { nil       }
-          @keys           = options.delete(:keys)           { nil       }
-          @default_value  = options.delete(:default_value)  { nil       }
-          @ios_default    = options.delete(:ios_default)    { nil       }
-          @osx_default    = options.delete(:osx_default)    { nil       }
-          @types          = options.delete(:types)          { [String] }
+          @multi_platform = options.delete(:multi_platform) { true       }
+          @root_only      = options.delete(:root_only)      { false      }
+          @spec_types     = options.delete(:spec_types)     { SUPPORTED_SPEC_TYPES }
+          @inherited      = options.delete(:inherited)      { @root_only }
+          @required       = options.delete(:required)       { false      }
+          @singularize    = options.delete(:singularize)    { false      }
+          @file_patterns  = options.delete(:file_patterns)  { false      }
+          @container      = options.delete(:container)      { nil        }
+          @keys           = options.delete(:keys)           { nil        }
+          @default_value  = options.delete(:default_value)  { nil        }
+          @ios_default    = options.delete(:ios_default)    { nil        }
+          @osx_default    = options.delete(:osx_default)    { nil        }
+          @types          = options.delete(:types)          { [String]   }
 
           unless options.empty?
             raise StandardError, "Unrecognized options: #{options} for #{self}"
           end
+          unless (@spec_types - SUPPORTED_SPEC_TYPES).empty?
+            raise StandardError, "Unrecognized spec type option: #{@spec_types} for #{self}"
+          end
         end
 
         # @return [String] A string representation suitable for UI.
@@ -109,39 +115,56 @@ module Pod
         #
         attr_reader :osx_default
 
-        # @return [Bool] whether the specification should be considered invalid
+        # @return [Boolean] whether the specification should be considered invalid
         #         if a value for the attribute is not specified.
         #
-        def required?; @required; end
+        def required?
+          @required
+        end
 
-        # @return [Bool] whether the attribute should be specified only on the
+        # @return [Boolean] whether the attribute should be specified only on the
         #         root specification.
         #
-        def root_only?; @root_only; end
+        def root_only?
+          @root_only
+        end
+
+        # @return [Boolean] whether the attribute should be specified only on
+        #         test specifications.
+        #
+        def test_only?
+          @spec_types == [:test]
+        end
 
-        # @return [Bool] whether the attribute is multi-platform and should
+        # @return [Boolean] whether the attribute is multi-platform and should
         #         work in conjunction with #{PlatformProxy}.
         #
-        def multi_platform?; @multi_platform; end
+        def multi_platform?
+          @multi_platform
+        end
 
-        # @return [Bool] whether there should be a singular alias for the
+        # @return [Boolean] whether there should be a singular alias for the
         #         attribute writer.
         #
-        def singularize?; @singularize; end
+        def singularize?
+          @singularize
+        end
 
-        # @return [Bool] whether the attribute describes file patterns.
+        # @return [Boolean] whether the attribute describes file patterns.
         #
         # @note   This is mostly used by the linter.
         #
-        def file_patterns?; @file_patterns; end
+        def file_patterns?
+          @file_patterns
+        end
 
-        # @return [Bool] defines whether the attribute reader should join the
+        # @return [Boolean] defines whether the attribute reader should join the
         # values with the parent.
         #
         # @note   Attributes stored in wrappers are always inherited.
         #
         def inherited?
-          !root_only? && @inherited
+          @inherited
         end
 
         #---------------------------------------------------------------------#
@@ -177,66 +200,7 @@ module Pod
         def writer_singular_form
           "#{name.to_s.singularize}=" if singularize?
         end
-
-        #---------------------------------------------------------------------#
-
-        # @!group Values validation
-
-        # Validates the value for an attribute. This validation should be
-        # performed before the value is prepared or wrapped.
-        #
-        # @note   The this is called before preparing the value.
-        #
-        # @raise  If the type is not in the allowed list.
-        #
-        # @return [void]
-        #
-        def validate_type(value)
-          return if value.nil?
-          unless supported_types.any? { |klass| value.class == klass }
-            raise StandardError, "Non acceptable type `#{value.class}` for "\
-              "#{self}. Allowed values: `#{types.inspect}`"
-          end
-        end
-
-        # Validates a value before storing.
-        #
-        # @raise If a root only attribute is set in a subspec.
-        #
-        # @raise If a unknown key is added to a hash.
-        #
-        # @return [void]
-        #
-        def validate_for_writing(spec, value)
-          if root_only? && !spec.root?
-            raise StandardError, "Can't set `#{name}` attribute for " \
-              "subspecs (in `#{spec.name}`)."
-          end
-
-          if keys
-            value.keys.each do |key|
-              unless allowed_keys.include?(key)
-                raise StandardError, "Unknown key `#{key}` for "\
-                  "#{self}. Allowed keys: `#{allowed_keys.inspect}`"
-              end
-            end
-          end
-
-          # @return [Array] the flattened list of the allowed keys for the
-          # hash of a given specification.
-          #
-          def allowed_keys
-            if keys.is_a?(Hash)
-              keys.keys.concat(keys.values.flatten.compact)
-            else
-              keys
-            end
-          end
-        end
       end
-
-      #-----------------------------------------------------------------------#
-
     end
   end
 end

data/lib/cocoapods-core/specification/dsl/attribute_support.rb

@@ -1,25 +1,23 @@
 module Pod
   class Specification
     module DSL
-
       # @return [Array<Attribute>] The attributes of the class.
       #
-      def self.attributes
-        @attributes
+      class << self
+        attr_reader :attributes
       end
 
       # This module provides support for storing the runtime information of the
       # {Specification} DSL.
       #
       module AttributeSupport
-
         # Defines a root attribute for the extended class.
         #
         # Root attributes make sense only in root specification, they never are
-        # multiplatform, they don't have inheritance, and they never have a
+        # multi-platform, they don't have inheritance, and they never have a
         # default value.
         #
-        # @param  [String] name
+        # @param  [Symbol, String] name
         #         The name of the attribute.
         #
         # @param  [Hash] options
@@ -35,10 +33,10 @@ module Pod
 
         # Defines an attribute for the extended class.
         #
-        # Regular attributes in general support inheritance and multi platform
+        # Regular attributes in general support inheritance and multi-platform
         # values, so resolving them for a given specification is not trivial.
         #
-        # @param  [String] name
+        # @param  [Symbol, String] name
         #         The name of the attribute.
         #
         # @param  [Hash] options