cocoapods-core 0.33.1 → 0.34.0.rc1

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

@@ -38,7 +38,6 @@ module Pod
     #       spec.source       = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
     #       spec.source_files = 'Reachability.{h,m}'
     #       spec.framework    = 'SystemConfiguration'
-    #       spec.requires_arc = true
     #     end
     #
     module DSL
@@ -179,6 +178,8 @@ module Pod
       #   Unless the source contains a file named `LICENSE.*` or `LICENCE.*`,
       #   the path of the license file **or** the integral text of the notice
       #   commonly used for the license type must be specified.
+      #   If a license file is specified, it either must be without a file
+      #   extensions or be one of `txt`, `md`, or `markdown`.
       #
       #   This information is used by CocoaPods to generate acknowledgement
       #   files (markdown and plist) which can be used in the acknowledgements
@@ -245,17 +246,12 @@ module Pod
       #   @example Specifying a Git source with a tag. This is how most OSS Podspecs work.
       #
       #     spec.source = { :git => 'https://github.com/AFNetworking/AFNetworking.git',
-      #                     :tag => 'v0.0.1' }
+      #                     :tag => spec.version.to_s }
       #
-      #   @example Using the version of the Pod to identify the Git commit and using submodules.
+      #   @example Using a tag prefixed with 'v' and submodules.
       #
-      #     spec.source = { :git => 'https://github.com/AFNetworking/AFNetworking.git',
-      #                     :commit => "v#{spec.version}", :submodules => true }
-      #
-      #   @example Using the version of the Pod to identify the Git branch.
-      #
-      #     spec.source = { :git => 'https://github.com/AFNetworking/AFNetworking.git',
-      #                     :branch => "orta_fixes"}
+      #     spec.source = { :git => 'https://github.com/typhoon-framework/Typhoon.git',
+      #                     :tag => "v#{spec.version}", :submodules => true }
       #
       #   @example Using Subversion with a tag.
       #
@@ -525,7 +521,7 @@ module Pod
       # @param    [String] args
       #           The deployment target of the platform.
       #
-      def deployment_target=(*args)
+      def deployment_target=(*_args)
         raise Informative, 'The deployment target can be declared only per ' \
           'platform.'
       end
@@ -599,24 +595,20 @@ module Pod
 
       # @!method requires_arc=(flag)
       #
-      #   Wether the library requires ARC to be compiled. If true the
+      #   Whether the library requires ARC to be compiled. If true the
       #   `-fobjc-arc` flag will be added to the compiler flags.
-      #
-      #   ---
-      #
-      #   The default value of this attribute is __transitioning__ from `false`
-      #   to `true`, and in the meanwhile this attribute is always required.
+      #   The default value of this attribute is __transitioning__ is `true`.
       #
       #   @example
       #
-      #     spec.requires_arc = true
+      #     spec.requires_arc = false
       #
       #   @param [Bool] flag
       #           whether the source files require ARC.
       #
       attribute :requires_arc,
                 :types => [TrueClass, FalseClass],
-                :default_value => false,
+                :default_value => true,
                 :inherited => true
 
       #------------------#

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

@@ -5,7 +5,7 @@ module Pod
       #
       def to_json(*a)
         require 'json'
-        to_hash.to_json(*a)
+        to_hash.to_json(*a) << "\n"
       end
 
       #-----------------------------------------------------------------------#
@@ -16,7 +16,7 @@ module Pod
       def to_hash
         hash = attributes_hash.dup
         unless subspecs.empty?
-          hash['subspecs'] = subspecs.map { |spec| spec.to_hash }
+          hash['subspecs'] = subspecs.map(&:to_hash)
         end
         hash
       end

data/lib/cocoapods-core/specification/linter/analyzer.rb

@@ -12,8 +12,8 @@ module Pod
         end
 
         def analyze
+          check_attributes
           validate_file_patterns
-          check_tmp_arc_not_nil
           check_if_spec_is_empty
         end
 
@@ -21,6 +21,46 @@ module Pod
 
         attr_reader :consumer
 
+        # Checks the attributes hash for any unknown key which might be the
+        # result of a misspelling in a JSON file.
+        #
+        # @note Sub-keys are not checked per-platform as
+        #       there is no attribute supporting this combination.
+        #
+        # @note The keys of sub-keys are not checked as they are only used by
+        #       the `source` attribute and they are subject
+        #       to change according to the support in the
+        #       `cocoapods-downloader` gem.
+        #
+        def check_attributes
+          attributes_keys = Pod::Specification::DSL.attributes.keys.map(&:to_s)
+          platform_keys = Specification::DSL::PLATFORMS.map(&:to_s)
+          valid_keys = attributes_keys + platform_keys
+          attributes_hash = consumer.spec.attributes_hash
+          keys = attributes_hash.keys
+          Specification::DSL::PLATFORMS.each do |platform|
+            if attributes_hash[platform.to_s]
+              keys += attributes_hash[platform.to_s].keys
+            end
+          end
+          unknown_keys = keys - valid_keys
+
+          unknown_keys.each do |key|
+            warning "Unrecognized `#{key}` key"
+          end
+
+          Pod::Specification::DSL.attributes.each do |_key, attribute|
+            if attribute.keys && attribute.name != :platforms
+              if attribute.root_only?
+                value = consumer.spec.send(attribute.name)
+              else
+                value = consumer.send(attribute.name)
+              end
+              validate_attribute_value(attribute, value) if value
+            end
+          end
+        end
+
         # Checks the attributes that represent file patterns.
         #
         # @todo Check the attributes hash directly.
@@ -41,25 +81,6 @@ module Pod
           end
         end
 
-        # @todo remove after the switch to true
-        #
-        def check_tmp_arc_not_nil
-          spec = consumer.spec
-          declared = false
-          loop do
-            declared = true unless spec.attributes_hash['requires_arc'].nil?
-            declared = true unless spec.attributes_hash[consumer.platform_name.to_s].nil?
-            spec = spec.parent
-            break unless spec
-          end
-
-          unless declared
-            warning '[requires_arc] A value for `requires_arc` should be' \
-            ' specified until the ' \
-            'migration to a `true` default.'
-          end
-        end
-
         # Check empty subspec attributes
         #
         def check_if_spec_is_empty
@@ -75,6 +96,54 @@ module Pod
             'or subspecs).'
           end
         end
+
+        private
+
+        # Validates the given value for the given attribute.
+        #
+        # @param  [Spec::DSL::Attribute] attribute
+        #         The attribute.
+        #
+        # @param  [Spec::DSL::Attribute] value
+        #         The value of the attribute.
+        #
+        def validate_attribute_value(attribute, value)
+          if attribute.keys.is_a?(Array)
+            validate_attribute_array_keys(attribute, value)
+          elsif attribute.keys.is_a?(Hash)
+            validate_attribute_hash_keys(attribute, value)
+          else
+          end
+        end
+
+        def validate_attribute_array_keys(attribute, value)
+          unknown_keys = value.keys.map(&:to_s) - attribute.keys.map(&:to_s)
+          unknown_keys.each do |unknown_key|
+            warning "Unrecognized `#{unknown_key}` key for " \
+              "`#{attribute.name}` attribute"
+          end
+        end
+
+        def validate_attribute_hash_keys(attribute, value)
+          major_keys = value.keys & attribute.keys.keys
+          if major_keys.count.zero?
+            warning "Missing primary key for `#{attribute.name}` " \
+              'attribute. The acceptable ones are: ' \
+              "`#{attribute.keys.keys.map(&:to_s).sort.join(', ')}`"
+          elsif major_keys.count == 1
+            acceptable = attribute.keys[major_keys.first]
+            unknown = value.keys - major_keys - acceptable
+            unless unknown.empty?
+              warning "Incompatible `#{unknown.sort.join(', ')}` key(s) " \
+                "with `#{major_keys.first}` primary key for " \
+                "`#{attribute.name}` attribute"
+            end
+          else
+            sorted_keys = major_keys.map(&:to_s).sort
+            warning "Incompatible `#{sorted_keys.join(', ')}` keys for " \
+              "`#{attribute.name}` attribute"
+          end
+        end
       end
     end
   end

data/lib/cocoapods-core/specification/linter/result.rb

@@ -58,7 +58,7 @@ module Pod
           add_result(:error, message)
         end
 
-        # Adds an warning result with the given message.
+        # Adds a warning result with the given message.
         #
         # @param  [String] message
         #         The message of the result.

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

@@ -31,7 +31,7 @@ module Pod
           @file = Pathname.new(spec_or_path)
           begin
             @spec = Specification.from_file(@file)
-          rescue Exception => e
+          rescue => e
             @spec = nil
             @raise_message = e.message
           end
@@ -166,7 +166,7 @@ module Pod
 
       # Performs validations related to the `name` attribute.
       #
-      def _validate_name(n)
+      def _validate_name(_n)
         if spec.name && file
           acceptable_names = [
             spec.root.name + '.podspec',
@@ -273,6 +273,7 @@ module Pod
       #
       def _validate_license(l)
         type = l[:type]
+        file = l[:file]
         if type.nil?
           warning '[license] Missing license type.'
         end
@@ -282,6 +283,9 @@ module Pod
         if type && type =~ /\(example\)/
           error '[license] Sample license type.'
         end
+        if file && Pathname.new(file).extname !~ /^(txt|md|markdown|)$/i
+          error '[license] Invalid file type'
+        end
       end
 
       # Performs validations related to the `source` attribute.
@@ -311,6 +315,7 @@ module Pod
         end
 
         perform_github_source_checks(s)
+        check_git_ssh_source(s)
       end
 
       # Performs validations related to github sources.
@@ -338,6 +343,18 @@ module Pod
         end
       end
 
+      # Performs validations related to SSH sources
+      #
+      def check_git_ssh_source(s)
+        if git = s[:git]
+          if git =~ /\w+\@(\w|\.)+\:(\/\w+)*/
+            warning '[source] Git SSH URLs will NOT work for people behind' \
+              'firewalls configured to only allow HTTP, therefor HTTPS is' \
+              'preferred.'
+          end
+        end
+      end
+
       # Performs validations related to the `social_media_url` attribute.
       #
       def _validate_social_media_url(s)

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

@@ -158,6 +158,13 @@ module Pod
           attributes_hash['deprecated_in_favor_of']
         end
 
+        # @return [Bool] Wether the pod is deprecated either in favor of some other
+        #         pod or simply deprecated.
+        #
+        def deprecated?
+          deprecated || !deprecated_in_favor_of.nil?
+        end
+
         #---------------------------------------------------------------------#
 
         private

data/lib/cocoapods-core/specification/set/presenter.rb

@@ -123,6 +123,28 @@ module Pod
           spec.description || spec.summary
         end
 
+        # @return [String] A string that describes the deprecation of the pod.
+        #         If the pod is deprecated in favor of another pod it will contain
+        #         information about that. If the pod is not deprecated returns nil.
+        #
+        # @example Output example
+        #
+        #          "[DEPRECATED]"
+        #          "[DEPRECATED in favor of NewAwesomePod]"
+        #
+        def deprecation_description
+          if spec.deprecated?
+            description = '[DEPRECATED'
+            if spec.deprecated_in_favor_of.nil?
+              description += ']'
+            else
+              description += " in favor of #{spec.deprecated_in_favor_of}]"
+            end
+
+            description
+          end
+        end
+
         # @return [String] the URL of the source of the Pod.
         #
         def source_url

data/lib/cocoapods-core/specification/set/statistics.rb

@@ -27,8 +27,8 @@ module Pod
         #
         # @return [Statistics] the shared statistics instance.
         #
-        def self.instance=(instance)
-          @instance = instance
+        class << self
+          attr_writer :instance
         end
 
         # @return [Pathname] the path to the optional cache file.
@@ -153,7 +153,7 @@ module Pod
         def cache
           unless @cache
             if cache_file && cache_file.exist?
-              @cache = YAMLHelper.load(cache_file.read)
+              @cache = YAMLHelper.load_string(cache_file.read)
             else
               @cache = {}
             end

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

@@ -94,7 +94,7 @@ module Pod
 
       # TODO
       #
-      def specification_path_for_version(version)
+      def specification_path_for_version(_version)
         sources = []
         versions_by_source.each do |source, source_versions|
           sources << source if source_versions.include?(required_version)

data/lib/cocoapods-core/specification.rb

@@ -120,12 +120,12 @@ module Pod
     #           pod.
     #
     def self.name_and_version_from_string(string_representation)
-      match_data = string_representation.match(/(\S*) \((.*)\)/)
+      match_data = string_representation.match(/\A(\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.'
+          "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])
@@ -563,7 +563,7 @@ module Pod
     # rubocop:disable Eval
     eval(string, nil, path.to_s)
     # rubocop:enable Eval
-  rescue Exception => e
+  rescue => e
     message = "Invalid `#{path.basename}` file: #{e.message}"
     raise DSLError.new(message, path, e.backtrace)
   end

data/lib/cocoapods-core/yaml_helper.rb

@@ -17,14 +17,14 @@ module Pod
   class YAMLHelper
     class << self
       # Returns the YAML representation of the given object. If the given object
-      # is an Hash it accepts an optional hint for sorting the keys.
+      # is a Hash, it accepts an optional hint for sorting the keys.
       #
       # @param  [String, Symbol, Array, Hash] object
       #         the object to convert
       #
       # @param  [Array] hash_keys_hint
       #         an array to use as a hint for sorting the keys of the object to
-      #         convert if it is an hash.
+      #         convert if it is a hash.
       #
       # @return [String] the YAML representation of the given object.
       #
@@ -38,18 +38,39 @@ module Pod
         result << "\n"
       end
 
-      # Load a YAML file and provide more informative error messages in special cases like merge conflict.
-      # @param A YAML string.
-      def load(yaml_string)
+      # Loads a YAML string and provide more informative
+      # error messages in special cases like merge conflict.
+      #
+      # @param [String] yaml_string
+      #        The YAML String to be loaded
+      #
+      # @param [Pathname] file_path
+      #        The (optional) file path to be used for read for the YAML file
+      #
+      # @return [Hash, Array] the Ruby YAML representaton
+      #
+      def load_string(yaml_string, file_path = nil)
         YAML.load(yaml_string)
-        rescue Exception => exception
-          if yaml_has_merge_error(yaml_string)
-            raise Informative, 'Merge conflict(s) detected'
+        rescue
+          if yaml_has_merge_error?(yaml_string)
+            raise Informative, yaml_merge_conflict_msg(yaml_string, file_path)
           else
-            raise exception
+            raise Informative, yaml_parsing_error_msg(yaml_string, file_path)
           end
       end
 
+      # Loads a YAML file and leans on the #load_string imp
+      # to do error detection
+      #
+      # @param [Pathname] file_path
+      #        The file path to be used for read for the YAML file
+      #
+      # @return [Hash, Array] the Ruby YAML representaton
+      #
+      def load_file(file_path)
+        load_string(File.read(file_path), file_path)
+      end
+
       #-----------------------------------------------------------------------#
 
       private
@@ -130,12 +151,52 @@ module Pod
       end
 
       # Check for merge errors in a YAML string.
-      # @param A YAML string.
+      #
+      # @param [String] yaml_string
+      #        A YAML string to evaluate
+      #
       # @return If a merge error was detected or not.
-      def yaml_has_merge_error(yaml_string)
+      #
+      def yaml_has_merge_error?(yaml_string)
         yaml_string.include?('<<<<<<< HEAD')
       end
 
+      # Error message describing that a merge conflict was found
+      # while parsing the YAML.
+      #
+      # @param [String] yaml
+      #        Offending YAML
+      #
+      # @param [Pathname] path
+      #        The (optional) offending path
+      #
+      # @return [String] The Error Message
+      #
+      def yaml_merge_conflict_msg(yaml, path = nil)
+        err = 'ERROR: Parsing unable to continue due '
+        err += "to merge conflicts present in:\n"
+        err += "the file located at #{path}\n" if path
+        err += "#{yaml}"
+      end
+
+      # Error message describing a general error took happened
+      # while parsing the YAML.
+      #
+      # @param [String] yaml
+      #        Offending YAML
+      #
+      # @param [Pathname] path
+      #        The (optional) offending path
+      #
+      # @return [String] The Error Message
+      #
+      def yaml_parsing_error_msg(yaml, path = nil)
+        err = 'ERROR: Parsing unable to continue due '
+        err += "to parsing error:\n"
+        err += "contained in the file located at #{path}\n" if path
+        err += "#{yaml}"
+      end
+
       #-----------------------------------------------------------------------#
 
       private

data/lib/cocoapods-core.rb

@@ -7,7 +7,7 @@ module Pod
   #
   class PlainInformative < StandardError; end
 
-  # Indicates an user error.
+  # Indicates a user error.
   #
   class Informative < PlainInformative; end