cocoapods-core 0.31.1 → 0.32.0

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

@@ -5,7 +5,6 @@ require 'cocoapods-core/specification/dsl/deprecations'
 
 module Pod
   class Specification
-
     #- NOTE ------------------------------------------------------------------#
     # The of the methods defined in this file and the order of the methods is
     # relevant for the documentation generated on the
@@ -35,7 +34,7 @@ module Pod
     #       spec.license      = { :type => 'BSD' }
     #       spec.homepage     = 'https://github.com/tonymillion/Reachability'
     #       spec.authors      = { 'Tony Million' => 'tonymillion@gmail.com' }
-    #       spec.summary      = 'ARC and GCD Compatible Reachability Class for iOS and OS X. Drop in replacement for Apple Reachability.'
+    #       spec.summary      = 'ARC and GCD Compatible Reachability Class for iOS and OS X.'
     #       spec.source       = { :git => 'https://github.com/tonymillion/Reachability.git', :tag => 'v3.1.0' }
     #       spec.source_files = 'Reachability.{h,m}'
     #       spec.framework    = 'SystemConfiguration'
@@ -43,7 +42,6 @@ module Pod
     #     end
     #
     module DSL
-
       extend Pod::Specification::DSL::AttributeSupport
 
       #-----------------------------------------------------------------------#
@@ -79,9 +77,8 @@ module Pod
       #   @param  [String] name
       #           the name of the pod.
       #
-      root_attribute :name, {
-        :required => true,
-      }
+      root_attribute :name,
+                     :required => true
 
       #------------------#
 
@@ -97,9 +94,8 @@ module Pod
       #   @param  [String] version
       #           the version of the Pod.
       #
-      root_attribute :version, {
-        :required => true,
-      }
+      root_attribute :version,
+                     :required => true
 
       #------------------#
 
@@ -124,12 +120,11 @@ module Pod
       #   @param  [String, Hash{String=>String}] authors
       #           the list of the authors of the library and their emails.
       #
-      root_attribute :authors, {
-        :types       => [String, Array, Hash],
-        :container   => Hash,
-        :required    => true,
-        :singularize => true,
-      }
+      root_attribute :authors,
+                     :types       => [String, Array, Hash],
+                     :container   => Hash,
+                     :required    => true,
+                     :singularize => true
 
       #------------------#
 
@@ -210,11 +205,10 @@ module Pod
       #           allows to use the library (or the relative path to the file
       #           that contains it).
       #
-      root_attribute :license, {
-        :container => Hash,
-        :keys      => LICENSE_KEYS,
-        :required  => true,
-      }
+      root_attribute :license,
+                     :container => Hash,
+                     :keys      => LICENSE_KEYS,
+                     :required  => true
 
       #------------------#
 
@@ -224,14 +218,13 @@ module Pod
       #
       #   @example
       #
-      #     spec.homepage = 'www.example.com'
+      #     spec.homepage = 'http://www.example.com'
       #
       #   @param  [String] homepage
       #           the URL of the homepage of the Pod.
       #
-      root_attribute :homepage, {
-        :required => true,
-      }
+      root_attribute :homepage,
+                     :required => true
 
       #------------------#
 
@@ -279,11 +272,10 @@ module Pod
       #   @param  [Hash{Symbol=>String}] source
       #           The location from where the library should be retrieved.
       #
-      root_attribute :source, {
-        :container => Hash,
-        :keys      => SOURCE_KEYS,
-        :required  => true,
-      }
+      root_attribute :source,
+                     :container => Hash,
+                     :keys      => SOURCE_KEYS,
+                     :required  => true
 
       #------------------#
 
@@ -307,9 +299,8 @@ module Pod
       #   @param  [String] summary
       #           A short description of the Pod.
       #
-      root_attribute :summary, {
-        :required => true,
-      }
+      root_attribute :summary,
+                     :required => true
 
       #------------------#
 
@@ -337,7 +328,7 @@ module Pod
       # @!method screenshots=(screenshots)
       #
       #   A list of URLs to images showcasing the Pod. Intended for UI oriented
-      #   libraries.
+      #   libraries. CocoaPods recommends the usage of the `gif` format.
       #
       #   @example
       #
@@ -351,10 +342,9 @@ module Pod
       #   @param  [String] screenshots
       #           An URL for the screenshot of the Pod.
       #
-      root_attribute :screenshots, {
-        :singularize    => true,
-        :container      => Array,
-      }
+      root_attribute :screenshots,
+                     :singularize    => true,
+                     :container      => Array
 
       #------------------#
 
@@ -366,7 +356,7 @@ module Pod
       #
       #   @example
       #
-      #     spec.documentation_url = 'www.example.com/docs.html'
+      #     spec.documentation_url = 'http://www.example.com/docs.html'
       #
       #   @param  [String] documentation_url
       #           The link of the web documentation of the Pod.
@@ -405,6 +395,37 @@ module Pod
       #
       root_attribute :prepare_command
 
+      #------------------#
+
+      # @!method deprecated=(flag)
+      #
+      #   Whether the library has been deprecated.
+      #
+      #   @example
+      #
+      #     spec.deprecated = true
+      #
+      #   @param [Bool] flag
+      #           whether the library has been deprecated.
+      #
+      root_attribute :deprecated,
+                     :types => [TrueClass, FalseClass],
+                     :default_value => false
+
+      # @!method deprecated_in_favor_of=(deprecated_in_favor_of)
+      #
+      #   The name of the Pod that this one has been deprecated in favor of.
+      #
+      #   @example
+      #
+      #     spec.deprecated_in_favor_of = 'NewMoreAwesomePod'
+      #
+      #   @param  [String] deprecated_in_favor_of
+      #           the name of the Pod that this one has been deprecated in
+      #           favor of.
+      #
+      root_attribute :deprecated_in_favor_of
+
       #-----------------------------------------------------------------------#
 
       # @!group Platform
@@ -423,12 +444,11 @@ module Pod
 
       # @todo This currently is not used in the Ruby DSL.
       #
-      attribute :platforms, {
-        :container => Hash,
-        :keys => PLATFORMS,
-        :multi_platform => false,
-        :inherited => true,
-      }
+      attribute :platforms,
+                :container => Hash,
+                :keys => PLATFORMS,
+                :multi_platform => false,
+                :inherited => true
 
       # The platform on which this Pod is supported. Leaving this blank
       # means the Pod is supported on all platforms.
@@ -453,9 +473,9 @@ module Pod
       def platform=(args)
         name, deployment_target = args
         if name
-          attributes_hash["platforms"] = { name.to_s => deployment_target }
+          attributes_hash['platforms'] = { name.to_s => deployment_target }
         else
-          attributes_hash["platforms"] = {}
+          attributes_hash['platforms'] = {}
         end
       end
 
@@ -524,10 +544,9 @@ module Pod
 
       # @todo This currently is not used in the Ruby DSL.
       #
-      attribute :dependencies, {
-        :container => Hash,
-        :inherited => true,
-      }
+      attribute :dependencies,
+                :container => Hash,
+                :inherited => true
 
       # Any dependency on other Pods or to a ‘sub-specification’.
       #
@@ -558,22 +577,22 @@ module Pod
             "subspec"
         end
         if @parent
-          composed_name = ""
-          @parent.name.split("/").each do |component|
+          composed_name = ''
+          @parent.name.split('/').each do |component|
             composed_name << component
             if name == composed_name
               raise Informative, "A subspec can't require one of its " \
                 "parents specifications"
             else
-              composed_name << "/"
+              composed_name << '/'
             end
           end
         end
         unless version_requirements.all? { |req| req.is_a?(String) }
-          raise Informative, "Unsupported version requirements"
+          raise Informative, 'Unsupported version requirements'
         end
-        attributes_hash["dependencies"] ||= {}
-        attributes_hash["dependencies"][name] = version_requirements
+        attributes_hash['dependencies'] ||= {}
+        attributes_hash['dependencies'][name] = version_requirements
       end
 
       #------------------#
@@ -595,11 +614,10 @@ module Pod
       #   @param [Bool] flag
       #           whether the source files require ARC.
       #
-      attribute :requires_arc, {
-        :types => [TrueClass, FalseClass],
-        :default_value => false,
-        :inherited => true,
-      }
+      attribute :requires_arc,
+                :types => [TrueClass, FalseClass],
+                :default_value => false,
+                :inherited => true
 
       #------------------#
 
@@ -619,11 +637,10 @@ module Pod
       #   @param  [String, Array<String>] frameworks
       #           A list of framework names.
       #
-      attribute :frameworks, {
-        :container   => Array,
-        :singularize => true,
-        :inherited => true,
-      }
+      attribute :frameworks,
+                :container   => Array,
+                :singularize => true,
+                :inherited => true
 
       #------------------#
 
@@ -639,11 +656,10 @@ module Pod
       #   @param  [String, Array<String>] weak_frameworks
       #           A list of frameworks names.
       #
-      attribute :weak_frameworks, {
-        :container   => Array,
-        :singularize => true,
-        :inherited => true,
-      }
+      attribute :weak_frameworks,
+                :container   => Array,
+                :singularize => true,
+                :inherited => true
 
       #------------------#
 
@@ -663,11 +679,10 @@ module Pod
       #   @param  [String, Array<String>] libraries
       #           A list of library names.
       #
-      attribute :libraries, {
-        :container   => Array,
-        :singularize => true,
-        :inherited => true,
-      }
+      attribute :libraries,
+                :container   => Array,
+                :singularize => true,
+                :inherited => true
 
       #------------------#
 
@@ -682,11 +697,10 @@ module Pod
       #   @param  [String, Array<String>] flags
       #           A list of flags.
       #
-      attribute :compiler_flags, {
-        :container   => Array,
-        :singularize => true,
-        :inherited => true,
-      }
+      attribute :compiler_flags,
+                :container   => Array,
+                :singularize => true,
+                :inherited => true
 
       #------------------#
 
@@ -701,10 +715,9 @@ module Pod
       #   @param  [Hash{String => String}] value
       #           A representing an xcconfig.
       #
-      attribute :xcconfig, {
-        :container => Hash,
-        :inherited => true,
-      }
+      attribute :xcconfig,
+                :container => Hash,
+                :inherited => true
 
       #------------------#
 
@@ -728,10 +741,9 @@ module Pod
       #   @param  [String] content
       #           The contents of the prefix header.
       #
-      attribute :prefix_header_contents, {
-        :types => [Array, String],
-        :inherited => true,
-      }
+      attribute :prefix_header_contents,
+                :types => [Array, String],
+                :inherited => true
 
       #------------------#
 
@@ -752,9 +764,8 @@ module Pod
       #   @param  [String] path
       #           The path to the prefix header file.
       #
-      attribute :prefix_header_file, {
-        :inherited => true,
-      }
+      attribute :prefix_header_file,
+                :inherited => true
 
       #------------------#
 
@@ -770,9 +781,8 @@ module Pod
       #   @param  [String] dir
       #           the headers directory.
       #
-      attribute :header_dir, {
-        :inherited => true,
-      }
+      attribute :header_dir,
+                :inherited => true
 
       #------------------#
 
@@ -788,9 +798,8 @@ module Pod
       #   @param  [String] dir
       #           the directory from where to preserve the headers namespacing.
       #
-      attribute :header_mappings_dir, {
-        :inherited => true,
-      }
+      attribute :header_mappings_dir,
+                :inherited => true
 
       #-----------------------------------------------------------------------#
 
@@ -887,10 +896,9 @@ module Pod
       #   @param  [String, Array<String>] source_files
       #           the source files of the Pod.
       #
-      attribute :source_files, {
-        :container     => Array,
-        :file_patterns => true,
-      }
+      attribute :source_files,
+                :container     => Array,
+                :file_patterns => true
 
       #------------------#
 
@@ -911,10 +919,9 @@ module Pod
       #   @param  [String, Array<String>] public_header_files
       #           the public headers of the Pod.
       #
-      attribute :public_header_files, {
-        :container => Array,
-        :file_patterns => true,
-      }
+      attribute :public_header_files,
+                :container => Array,
+                :file_patterns => true
 
       #------------------#
 
@@ -936,10 +943,9 @@ module Pod
       #   @param  [String, Array<String>] private_header_files
       #           the private headers of the Pod.
       #
-      attribute :private_header_files, {
-        :container => Array,
-        :file_patterns => true,
-      }
+      attribute :private_header_files,
+                :container => Array,
+                :file_patterns => true
 
       #------------------#
 
@@ -958,11 +964,10 @@ module Pod
       #   @param  [String, Array<String>] vendored_frameworks
       #           A list of framework bundles paths.
       #
-      attribute :vendored_frameworks, {
-        :container => Array,
-        :file_patterns => true,
-        :singularize => true,
-      }
+      attribute :vendored_frameworks,
+                :container => Array,
+                :file_patterns => true,
+                :singularize => true
 
       #------------------#
 
@@ -981,11 +986,10 @@ module Pod
       #   @param  [String, Array<String>] vendored_libraries
       #           A list of library paths.
       #
-      attribute :vendored_libraries, {
-        :container => Array,
-        :file_patterns => true,
-        :singularize => true,
-      }
+      attribute :vendored_libraries,
+                :container => Array,
+                :file_patterns => true,
+                :singularize => true
 
       #------------------#
 
@@ -1012,18 +1016,20 @@ module Pod
       #
       #   @example
       #
-      #     spec.resource_bundles = { 'MapBox' => ['MapView/Map/Resources/*.png'], 'OtherResources' => ['MapView/Map/OtherResources/*.png'] }
+      #     spec.resource_bundles = {
+      #         'MapBox' => ['MapView/Map/Resources/*.png'],
+      #         'OtherResources' => ['MapView/Map/OtherResources/*.png']
+      #       }
       #
       #   @param  [Hash{String=>String}] resource_bundles
       #           A hash where the keys are the names of the resource bundles
       #           and the values are their relative file patterns.
       #
-      attribute :resource_bundles, {
-        :types => [String, Array],
-        :container => Hash,
-        :file_patterns => true,
-        :singularize => true,
-      }
+      attribute :resource_bundles,
+                :types => [String, Array],
+                :container => Hash,
+                :file_patterns => true,
+                :singularize => true
 
       #------------------#
 
@@ -1048,11 +1054,10 @@ module Pod
       #   @param  [String, Array<String>] resources
       #           The resources shipped with the Pod.
       #
-      attribute :resources, {
-        :container     => Array,
-        :file_patterns => true,
-        :singularize   => true,
-      }
+      attribute :resources,
+                :container     => Array,
+                :file_patterns => true,
+                :singularize   => true
 
       #------------------#
 
@@ -1072,10 +1077,9 @@ module Pod
       #   @param  [String, Array<String>] exclude_files
       #           the file patterns that the Pod should ignore.
       #
-      attribute :exclude_files, {
-        :container     => Array,
-        :file_patterns => true,
-      }
+      attribute :exclude_files,
+                :container     => Array,
+                :file_patterns => true
 
       #------------------#
 
@@ -1099,11 +1103,10 @@ module Pod
       #   @param  [String, Array<String>] preserve_paths
       #           the paths that should be not cleaned.
       #
-      attribute :preserve_paths, {
-        :container     => Array,
-        :file_patterns => true,
-        :singularize   => true,
-      }
+      attribute :preserve_paths,
+                :container     => Array,
+                :file_patterns => true,
+                :singularize   => true
 
       #-----------------------------------------------------------------------#
 
@@ -1212,9 +1215,8 @@ module Pod
       #           the name of the subspec that should be inherited as
       #           dependency.
       #
-      attribute :default_subspec, {
-        :multi_platform => false,
-      }
+      attribute :default_subspec,
+                :multi_platform => false
 
       #-----------------------------------------------------------------------#
 

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

@@ -1,7 +1,6 @@
 module Pod
   class Specification
     module JSONSupport
-
       # @return [String] the json representation of the specification.
       #
       def to_json(*a)
@@ -17,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 { |spec| spec.to_hash }
         end
         hash
       end
@@ -65,6 +64,5 @@ module Pod
     end
 
     #-----------------------------------------------------------------------#
-
   end
 end

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

@@ -0,0 +1,93 @@
+require 'cocoapods-core/specification/linter/result'
+
+module Pod
+  class Specification
+    class Linter
+      class Analyzer
+        include Linter::ResultHelpers
+
+        def initialize(consumer)
+          @consumer = consumer
+          @results = []
+        end
+
+        def analyze
+          validate_file_patterns
+          check_tmp_arc_not_nil
+          check_if_spec_is_empty
+          check_install_hooks
+        end
+
+        private
+
+        attr_reader :consumer
+
+        # Checks the attributes that represent file patterns.
+        #
+        # @todo Check the attributes hash directly.
+        #
+        def validate_file_patterns
+          attributes = DSL.attributes.values.select(&:file_patterns?)
+          attributes.each do |attrb|
+            patterns = consumer.send(attrb.name)
+            if patterns.is_a?(Hash)
+              patterns = patterns.values.flatten(1)
+            end
+            patterns.each do |pattern|
+              if pattern.start_with?('/')
+                error "File patterns must be relative and cannot start with a " \
+                "slash (#{attrb.name})."
+              end
+            end
+          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 "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
+          methods = %w( source_files resources resource_bundles preserve_paths dependencies
+                        vendored_libraries vendored_frameworks )
+          empty_patterns = methods.all? { |m| consumer.send(m).empty? }
+          empty = empty_patterns && consumer.spec.subspecs.empty?
+          if empty
+            error "The #{consumer.spec} spec is empty (no source files, " \
+            "resources, resource_bundles, preserve paths, vendored_libraries, " \
+              "vendored_frameworks dependencies or subspecs)."
+          end
+        end
+
+        # Check the hooks
+        #
+        def check_install_hooks
+          unless consumer.spec.pre_install_callback.nil?
+            warning "The pre install hook has been deprecated, " \
+            "use the `resource_bundles` or the  `prepare_command` attributes."
+          end
+
+          unless consumer.spec.post_install_callback.nil?
+            warning "The post install hook has been deprecated, " \
+            "use the `resource_bundles` or the  `prepare_command` attributes."
+          end
+        end
+      end
+    end
+  end
+end