cocoapods-core 0.30.0 → 1.15.2

data/lib/cocoapods-core/specification.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/string/strip.rb'
+
 require 'cocoapods-core/specification/consumer'
 require 'cocoapods-core/specification/dsl'
 require 'cocoapods-core/specification/linter'
@@ -6,7 +8,6 @@ require 'cocoapods-core/specification/set'
 require 'cocoapods-core/specification/json'
 
 module Pod
-
   # The Specification provides a DSL to describe a Pod. A pod is defined as a
   # library originating from a source. A specification can support detailed
   # attributes for modules of code  through subspecs.
@@ -14,7 +15,6 @@ module Pod
   # Usually it is stored in files with `podspec` extension.
   #
   class Specification
-
     include Pod::Specification::DSL
     include Pod::Specification::DSL::Deprecations
     include Pod::Specification::RootAttributesAccessors
@@ -25,21 +25,46 @@ module Pod
     #
     attr_reader :parent
 
+    # @return [Integer] the cached hash value for this spec.
+    #
+    attr_reader :hash_value
+
     # @param  [Specification] parent @see parent
     #
     # @param  [String] name
     #         the name of the specification.
     #
-    def initialize(parent = nil, name = nil)
+    # @param [Boolean] test_specification
+    #        Whether the specification is a test specification
+    #
+    # @param [Boolean] app_specification
+    #        Whether the specification is an app specification
+    #
+    def initialize(parent = nil, name = nil, test_specification = false, app_specification: false)
+      raise StandardError, "#{self} can not be both an app and test specification." if test_specification && app_specification
       @attributes_hash = {}
       @subspecs = []
       @consumers = {}
       @parent = parent
+      @hash_value = nil
+      @test_specification = test_specification
+      @app_specification = app_specification
       attributes_hash['name'] = name
+      attributes_hash['test_type'] = :unit if test_specification
 
       yield self if block_given?
     end
 
+    def initialize_copy(other)
+      super
+
+      @subspecs = @subspecs.map do |subspec|
+        subspec = subspec.dup
+        subspec.instance_variable_set :@parent, self
+        subspec
+      end
+    end
+
     # @return [Hash] the hash that stores the information of the attributes of
     #         the specification.
     #
@@ -49,6 +74,16 @@ module Pod
     #
     attr_accessor :subspecs
 
+    # @return [Boolean] If this specification is a test specification.
+    #
+    attr_accessor :test_specification
+    alias_method :test_specification?, :test_specification
+
+    # @return [Boolean] If this specification is an app specification.
+    #
+    attr_accessor :app_specification
+    alias_method :app_specification?, :app_specification
+
     # Checks if a specification is equal to the given one according its name
     # and to its version.
     #
@@ -59,23 +94,15 @@ module Pod
     #         go. This is used by the installer to group specifications by root
     #         spec.
     #
-    # @return [Bool] Whether the specifications are equal.
+    # @return [Boolean] Whether the specifications are equal.
     #
     def ==(other)
-      # TODO
-      # self.class === other &&
-      #   attributes_hash == other.attributes_hash &&
-      #   subspecs == other.subspecs &&
-      #   pre_install_callback == other.pre_install_callback &&
-      #   post_install_callback == other.post_install_callback
-      to_s == other.to_s
+      other.is_a?(self.class) &&
+        name == other.name &&
+        version == other.version
     end
 
-    # @see ==
-    #
-    def eql?(other)
-      self == other
-    end
+    alias_method :eql?, :==
 
     # Return the hash value for this specification according to its attributes
     # hash.
@@ -88,19 +115,23 @@ module Pod
     # @return [Fixnum] The hash value.
     #
     def hash
-      to_s.hash
+      if @hash_value.nil?
+        @hash_value = (name.hash * 53) ^ version.hash
+      end
+      @hash_value
     end
 
     # @return [String] A string suitable for representing the specification in
     #         clients.
     #
     def to_s
-      if name && !version.version.empty?
-        "#{name} (#{version})"
+      specified_version = raw_version || ''
+      if name && !specified_version.empty?
+        "#{name} (#{specified_version})"
       elsif name
         name
       else
-        "No-name"
+        'No-name'
       end
     end
 
@@ -117,19 +148,18 @@ module Pod
     # @example  Input examples
     #
     #           "libPusher (1.0)"
-    #           "libPusher (HEAD based on 1.0)"
     #           "RestKit/JSON (1.0)"
     #
     # @return   [Array<String, Version>] the name and the version of a
     #           pod.
     #
     def self.name_and_version_from_string(string_representation)
-      match_data = string_representation.match(/(\S*) \((.*)\)/)
+      match_data = string_representation.match(/\A((?:\s?[^\s(])+)(?: \((.+)\))?\Z/)
       unless match_data
-        raise Informative, "Invalid string representation for a " \
-          "Specification: `#{string_representation}`." \
-          "String representation should include the name and " \
-          "the version of a pod."
+        raise Informative, 'Invalid string representation for a ' \
+          "specification: `#{string_representation}`. " \
+          'The string representation should include the name and ' \
+          'optionally the version of the Pod.'
       end
       name = match_data[1]
       vers = Version.new(match_data[2])
@@ -143,7 +173,46 @@ module Pod
     # @return [String] the root name
     #
     def self.root_name(full_name)
-      full_name.split('/').first
+      if index = full_name.index('/')
+        full_name.slice(0, index)
+      else
+        full_name
+      end
+    end
+
+    # Returns the module name of a specification
+    #
+    # @return [String] the module name
+    #
+    def module_name
+      attributes_hash['module_name'] ||
+        c99ext_identifier(attributes_hash['header_dir']) ||
+        c99ext_identifier(attributes_hash['name'])
+    end
+
+    private
+
+    # Transforms the given string into a valid +identifier+ after C99ext
+    # standard, so that it can be used in source code where escaping of
+    # ambiguous characters is not applicable.
+    #
+    # @param  [String] name
+    #         any name, which may contain leading numbers, spaces or invalid
+    #         characters.
+    #
+    # @return [String]
+    #
+    def c99ext_identifier(name)
+      return nil if name.nil?
+      I18n.transliterate(name).gsub(/^([0-9])/, '_\1').
+        gsub(/[^a-zA-Z0-9_]/, '_').gsub(/_+/, '_')
+    end
+
+    # @return [Object, Nil]
+    #         the raw value specified for the version attribute, or nil
+    #
+    def raw_version
+      root.attributes_hash['version']
     end
 
     #-------------------------------------------------------------------------#
@@ -158,13 +227,13 @@ module Pod
       parent ? parent.root : self
     end
 
-    # @return [Bool] whether the specification is root.
+    # @return [Boolean] whether the specification is root.
     #
     def root?
       parent.nil?
     end
 
-    # @return [Bool] whether the specification is a subspec.
+    # @return [Boolean] whether the specification is a subspec.
     #
     def subspec?
       !parent.nil?
@@ -174,9 +243,63 @@ module Pod
 
     public
 
+    # @return [Symbol] Spec type of the current spec.
+    #
+    # @note see Attribute#SUPPORTED_SPEC_TYPES for the list of available spec_types.
+    #
+    def spec_type
+      return :app if app_specification?
+      return :test if test_specification?
+
+      :library
+    end
+
     # @!group Dependencies & Subspecs
 
-    # @return [Array<Specifications>] the recursive list of all the subspecs of
+    # @return [Boolean] If this specification is a library specification.
+    #
+    # @note a library specification is a specification that is not of type app or test.
+    #
+    def library_specification?
+      !app_specification? && !test_specification?
+    end
+
+    # @return [Boolean] If this specification is not a library specification.
+    #
+    # @note see #library_specification?
+    #
+    def non_library_specification?
+      !library_specification?
+    end
+
+    # @return [Symbol] the test type supported if this is a test specification.
+    #
+    def test_type
+      attributes_hash['test_type'].to_sym
+    end
+
+    # @return [Array<Specification>] the list of all the test subspecs of
+    #         a specification.
+    #
+    def test_specs
+      subspecs.select(&:test_specification?)
+    end
+
+    # @return [Array<Specification>] the list of all the app subspecs of
+    #         a specification.
+    #
+    def app_specs
+      subspecs.select(&:app_specification?)
+    end
+
+    # @return [Array<Specification>] the list of all the non libary (app or test) subspecs of
+    #         a specification.
+    #
+    def non_library_specs
+      subspecs.select(&:non_library_specification?)
+    end
+
+    # @return [Array<Specification>] the recursive list of all the subspecs of
     #         a specification.
     #
     def recursive_subspecs
@@ -195,58 +318,89 @@ module Pod
     #           the relative name of the subspecs starting from the receiver
     #           including the name of the receiver.
     #
+    # @param    [Boolean] raise_if_missing
+    #           whether an exception should be raised if no specification named
+    #           `relative_name` is found.
+    #
     # @example  Retrieving a subspec
     #
     #           s.subspec_by_name('Pod/subspec').name #=> 'subspec'
     #
     # @return   [Specification] the subspec with the given name or self.
     #
-    def subspec_by_name(relative_name)
+    def subspec_by_name(relative_name, raise_if_missing = true, include_non_library_specifications = false)
       if relative_name.nil? || relative_name == base_name
         self
+      elsif base_name.nil?
+        if raise_if_missing
+          raise Informative, "Trying to access a `#{relative_name}` " \
+          "specification from `#{defined_in_file}`, which has no contents."
+        else
+          return nil
+        end
+      elsif relative_name.downcase == base_name.downcase
+        raise Informative, "Trying to access a `#{relative_name}` " \
+          "specification from `#{base_name}`, which has a different case."
       else
         remainder = relative_name[base_name.size + 1..-1]
         subspec_name = remainder.split('/').shift
-        subspec = subspecs.find { |s| s.name == "#{name}/#{subspec_name}" }
+        subspec = subspecs.find { |s| s.base_name == subspec_name && (include_non_library_specifications || !s.non_library_specification?) }
         unless subspec
-          raise Informative, "Unable to find a specification named " \
-            "`#{relative_name}` in `#{name} (#{version})`."
+          if raise_if_missing
+            raise Informative, 'Unable to find a specification named ' \
+              "`#{relative_name}` in `#{name} (#{version})`."
+          else
+            return nil
+          end
         end
-        subspec.subspec_by_name(remainder)
+        subspec.subspec_by_name(remainder, raise_if_missing, include_non_library_specifications)
       end
     end
 
-    # @return [String] the name of the default subspec if provided.
+    # @return [Array<String>, Symbol] the name(s) of the default subspecs if provided or :none for no default subspecs.
     #
-    def default_subspec
-      attributes_hash["default_subspec"]
+    def default_subspecs
+      # TODO: remove singular form and update the JSON specs.
+      value = Array(attributes_hash['default_subspecs'] || attributes_hash['default_subspec'])
+      first = value.first
+      if first == :none || first == 'none'
+        first.to_sym
+      else
+        value
+      end
     end
 
     # Returns the dependencies on subspecs.
     #
     # @note   A specification has a dependency on either the
-    #         {#default_subspec} or each of its children subspecs that are
+    #         {#default_subspecs} or each of its children subspecs that are
     #         compatible with its platform.
     #
+    # @param  [Platform] platform
+    #         return only dependencies supported on the given platform.
+    #
     # @return [Array<Dependency>] the dependencies on subspecs.
     #
     def subspec_dependencies(platform = nil)
-      if default_subspec
-        specs = [subspec_by_name("#{name}/#{default_subspec}")]
-      else
-        specs = subspecs.compact
-      end
+      specs = if default_subspecs.empty?
+                subspecs.compact.reject(&:non_library_specification?)
+              elsif default_subspecs == :none
+                []
+              else
+                default_subspecs.map do |subspec_name|
+                  root.subspec_by_name("#{name}/#{subspec_name}")
+                end
+              end
       if platform
         specs = specs.select { |s| s.supported_on_platform?(platform) }
       end
-      specs.map { |s| Dependency.new(s.name) }
+      specs.map { |s| Dependency.new(s.name, version) }
     end
 
     # Returns the dependencies on other Pods or subspecs of other Pods.
     #
-    # @param  [Bool] all_platforms
-    #         whether the dependencies should be returned for all platforms
-    #         instead of the active one.
+    # @param  [Platform] platform
+    #         return only dependencies supported on the given platform.
     #
     # @note   External dependencies are inherited by subspecs
     #
@@ -268,10 +422,29 @@ module Pod
       dependencies(platform) + subspec_dependencies(platform)
     end
 
+    # Returns whether a dependency is whitelisted for the given configuration.
+    #
+    # @param  [Pod::Dependency] dependency
+    #         the dependency verify.
+    #
+    # @param  [Symbol, String] configuration
+    #         the configuration to check against.
+    #
+    # @return [Boolean] whether the dependency is whitelisted or not.
+    #
+    def dependency_whitelisted_for_configuration?(dependency, configuration)
+      inherited = -> { root? ? true : parent.dependency_whitelisted_for_configuration?(dependency, configuration) }
+
+      return inherited[] unless configuration_whitelist = attributes_hash['configuration_pod_whitelist']
+      return inherited[] unless whitelist_for_pod = configuration_whitelist[dependency.name]
+
+      whitelist_for_pod.include?(configuration.to_s.downcase)
+    end
+
     # Returns a consumer to access the multi-platform attributes.
     #
     # @param  [String, Symbol, Platform] platform
-    #         he platform of the consumer
+    #         the platform of the consumer
     #
     # @return [Specification::Consumer] the consumer for the given platform
     #
@@ -280,20 +453,61 @@ module Pod
       @consumers[platform] ||= Consumer.new(self, platform)
     end
 
+    # @return [Bool, String] The prefix_header_file value.
+    #
+    def prefix_header_file
+      attributes_hash['prefix_header_file']
+    end
+
+    # @return [Array<Hash{Symbol=>String}>] The script_phases value.
+    #
+    def script_phases
+      script_phases = attributes_hash['script_phases'] || []
+      script_phases.map do |script_phase|
+        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
+
+    # @return [Hash] The on demand resources value.
+    #
+    def on_demand_resources
+      attributes_hash['on_demand_resources'] || {}
+    end
+
+    # @return [Hash] The scheme value.
+    #
+    def scheme
+      value = attributes_hash['scheme'] || {}
+      Specification.convert_keys_to_symbol(value, :recursive => false)
+    end
+
+    # @return [Hash] The Info.plist value.
+    #
+    def info_plist
+      attributes_hash['info_plist'] || {}
+    end
+
     #-------------------------------------------------------------------------#
 
     public
 
     # @!group DSL helpers
 
-    # @return [Bool] whether the specification should use a directory as it
+    # @return [Boolean] whether the specification should use a directory as its
     #         source.
     #
     def local?
-      !(source[:path] || source[:local]).nil? rescue false
+      return true if source[:path]
+      false
     end
 
-    # @return     [Bool] whether the specification is supported in the given
+    # @return     [Boolean] whether the specification is supported in the given
     #             platform.
     #
     # @overload   supported_on_platform?(platform)
@@ -303,11 +517,6 @@ module Pod
     #
     # @overload   supported_on_platform?(symbolic_name, deployment_target)
     #
-    #   @param    [Symbol] symbolic_name
-    #             the name of the platform which is checked for support.
-    #
-    #   @param    [String] deployment_target
-    #             the deployment target which is checked for support.
     #
     def supported_on_platform?(*platform)
       platform = Platform.new(*platform)
@@ -359,7 +568,7 @@ module Pod
     #         information.
     #
     def platform_hash
-      case value = attributes_hash["platforms"]
+      case value = attributes_hash['platforms']
       when String
         { value => nil }
       when Array
@@ -377,55 +586,8 @@ module Pod
 
     public
 
-    # @!group Deprecated Hooks support
     #-------------------------------------------------------------------------#
 
-    # @return [Proc] the pre install callback if defined.
-    #
-    attr_reader :pre_install_callback
-
-    # @return [Proc] the post install callback if defined.
-    #
-    attr_reader :post_install_callback
-
-    # Calls the pre install callback if defined.
-    #
-    # @param  [Pod::LocalPod] pod
-    #         the local pod instance that manages the files described by this
-    #         specification.
-    #
-    # @param  [Podfile::TargetDefinition] target_definition
-    #         the target definition that required this specification as a
-    #         dependency.
-    #
-    # @return [Bool] whether a pre install callback was specified and it was
-    #         called.
-    #
-    def pre_install!(pod, target_definition)
-      return false unless @pre_install_callback
-      @pre_install_callback.call(pod, target_definition)
-      true
-    end
-
-    # Calls the post install callback if defined.
-    #
-    # @param  [Pod::TargetInstaller] target_installer
-    #         the target installer that is performing the installation of the
-    #         pod.
-    #
-    # @return [Bool] whether a post install callback was specified and it was
-    #         called.
-    #
-    def post_install!(target_installer)
-      return false unless @post_install_callback
-      @post_install_callback.call(target_installer)
-      true
-    end
-
-    #-------------------------------------------------------------------------#
-
-    public
-
     # @!group DSL attribute writers
 
     # Sets the value for the attribute with the given name.
@@ -436,7 +598,7 @@ module Pod
     # @param  [Object] value
     #         the value to store.
     #
-    # @param  [Symbol] platform.
+    # @param  [Symbol] platform_name
     #         If provided the attribute is stored only for the given platform.
     #
     # @note   If the provides value is Hash the keys are converted to a string.
@@ -445,7 +607,8 @@ module Pod
     #
     def store_attribute(name, value, platform_name = nil)
       name = name.to_s
-      value = convert_keys_to_string(value) if value.is_a?(Hash)
+      value = Specification.convert_keys_to_string(value) if value.is_a?(Hash)
+      value = value.strip_heredoc.strip if value.respond_to?(:strip_heredoc)
       if platform_name
         platform_name = platform_name.to_s
         attributes_hash[platform_name] ||= {}
@@ -468,25 +631,46 @@ module Pod
       end
     end
 
-    private
-
     # Converts the keys of the given hash to a string.
     #
     # @param  [Object] value
     #         the value that needs to be stripped from the Symbols.
     #
-    # @return [Hash] the hash with the strings instead of the keys.
+    # @param  [Boolean] recursive
+    #         whether to convert keys of nested hashes.
     #
-    def convert_keys_to_string(value)
+    # @return [Hash] the hash with the keys as strings instead of symbols.
+    #
+    def self.convert_keys_to_string(value, recursive: true)
       return unless value
       result = {}
       value.each do |key, subvalue|
-        subvalue = convert_keys_to_string(subvalue) if subvalue.is_a?(Hash)
+        subvalue = Specification.convert_keys_to_string(subvalue) if recursive && subvalue.is_a?(Hash)
         result[key.to_s] = subvalue
       end
       result
     end
 
+    # Converts the keys of the given hash to a symbol.
+    #
+    # @param  [Object] value
+    #         the value that needs to be stripped from the Strings.
+    #
+    # @param  [Boolean] recursive
+    #         whether to convert keys of nested hashes.
+    #
+    # @return [Hash] the hash with the keys as symbols instead of strings.
+    #
+    def self.convert_keys_to_symbol(value, recursive: true)
+      return unless value
+      result = {}
+      value.each do |key, subvalue|
+        subvalue = Specification.convert_keys_to_symbol(subvalue) if recursive && subvalue.is_a?(Hash)
+        result[key.to_sym] = subvalue
+      end
+      result
+    end
+
     #-------------------------------------------------------------------------#
 
     public
@@ -499,11 +683,17 @@ module Pod
     # @return [Nil] If the specification is not defined in a file.
     #
     def checksum
-      require 'digest'
-      unless defined_in_file.nil?
-        checksum = Digest::SHA1.hexdigest(File.read(defined_in_file))
-        checksum = checksum.encode('UTF-8') if checksum.respond_to?(:encode)
-        checksum
+      @checksum ||= begin
+        if root?
+          unless defined_in_file.nil?
+            require 'digest'
+            checksum = Digest::SHA1.hexdigest(File.read(defined_in_file))
+            checksum = checksum.encode('UTF-8') if checksum.respond_to?(:encode)
+            checksum
+          end
+        else
+          root.checksum
+        end
       end
     end
 
@@ -534,9 +724,9 @@ module Pod
         raise Informative, "No podspec exists at path `#{path}`."
       end
 
-      string = File.open(path, 'r:utf-8') { |f| f.read }
+      string = File.open(path, 'r:utf-8', &:read)
       # Work around for Rubinius incomplete encoding in 1.9 mode
-      if string.respond_to?(:encoding) && string.encoding.name != "UTF-8"
+      if string.respond_to?(:encoding) && string.encoding.name != 'UTF-8'
         string.encode!('UTF-8')
       end
 
@@ -544,6 +734,7 @@ module Pod
     end
 
     # Loads a specification with the given string.
+    # The specification is evaluated in the context of `path`.
     #
     # @param  [String] spec_contents
     #         A string describing a specification.
@@ -554,21 +745,24 @@ module Pod
     # @return [Specification] the specification
     #
     def self.from_string(spec_contents, path, subspec_name = nil)
-      path = Pathname.new(path)
+      path = Pathname.new(path).expand_path
+      spec = nil
       case path.extname
       when '.podspec'
-        spec = ::Pod._eval_podspec(spec_contents, path)
-        unless spec.is_a?(Specification)
-          raise Informative, "Invalid podspec file at path `#{path}`."
+        Dir.chdir(path.parent.directory? ? path.parent : Dir.pwd) do
+          spec = ::Pod._eval_podspec(spec_contents, path)
+          unless spec.is_a?(Specification)
+            raise Informative, "Invalid podspec file at path `#{path}`."
+          end
         end
       when '.json'
-        spec = Specification.from_json(spec_contents)
+        spec = Specification.from_json(spec_contents, path)
       else
-        raise Informative, "Unsupported specification format `#{path.extname}`."
+        raise Informative, "Unsupported specification format `#{path.extname}` for spec at `#{path}`."
       end
 
       spec.defined_in_file = path
-      spec.subspec_by_name(subspec_name)
+      spec.subspec_by_name(subspec_name, true)
     end
 
     # Sets the path of the `podspec` file used to load the specification.
@@ -582,10 +776,51 @@ module Pod
     #
     def defined_in_file=(file)
       unless root?
-        raise StandardError, "Defined in file can be set only for root specs."
+        raise StandardError, 'Defined in file can be set only for root specs.'
       end
       @defined_in_file = file
     end
+
+    # Sets the name of the `podspec`.
+    #
+    # @param  [String] name
+    #         the `podspec` name.
+    #
+    # @return [void]
+    #
+    # @visibility private
+    #
+    def name=(name)
+      @hash_value = nil
+      attributes_hash['name'] = name
+    end
+
+    # Sets the version of the `podspec`.
+    #
+    # @param  [String] version
+    #         the `podspec` version.
+    #
+    # @return [void]
+    #
+    # @visibility private
+    #
+    def version=(version)
+      @hash_value = nil
+      store_attribute(:version, version)
+      @version = nil
+    end
+
+    # @!group Validation
+
+    # Validates the cocoapods_version in the specification against the current version of Core.
+    # It will raise an Informative error if the version is not satisfied.
+    #
+    def validate_cocoapods_version
+      unless cocoapods_version.satisfied_by?(Version.create(CORE_VERSION))
+        raise Informative, "`#{name}` requires CocoaPods version `#{cocoapods_version}`, " \
+                           "which is not satisfied by your current version, `#{CORE_VERSION}`."
+      end
+    end
   end
 
   #---------------------------------------------------------------------------#
@@ -606,11 +841,14 @@ module Pod
   #
   #
   def self._eval_podspec(string, path)
-    # rubocop:disable Eval
+    # rubocop:disable Security/Eval
     eval(string, nil, path.to_s)
-    # rubocop:enable Eval
+    # rubocop:enable Security/Eval
+
+    # rubocop:disable Lint/RescueException
   rescue Exception => e
+    # rubocop:enable Lint/RescueException
     message = "Invalid `#{path.basename}` file: #{e.message}"
-    raise DSLError.new(message, path, e.backtrace)
+    raise DSLError.new(message, path, e, string)
   end
 end