cocoapods-core 0.27.1 → 0.28.0

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

@@ -224,10 +224,12 @@ module Pod
         value = the_spec.attributes_hash[attr.name.to_s]
         value = prepare_value(attr, value)
 
-        if attr.multi_platform? && the_spec.attributes_hash[platform_name.to_s]
-          platform_value = the_spec.attributes_hash[platform_name.to_s][attr.name.to_s]
-          platform_value = prepare_value(attr, platform_value)
-          value = merge_values(attr, value, platform_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
@@ -258,7 +260,7 @@ module Pod
           r = [*existing_value] + [*new_value]
           r.compact
         elsif attr.container == Hash
-          existing_value = existing_value.merge(new_value) do |_, old, new|
+          existing_value.merge(new_value) do |_, old, new|
             if new.is_a?(Array) || old.is_a?(Array)
               r = [*old] + [*new]
               r.compact
@@ -289,7 +291,7 @@ module Pod
 
         hook_name = prepare_hook_name(attr)
         if self.respond_to?(hook_name, true)
-          value = self.send(hook_name, value)
+          value = send(hook_name, value)
         else
           value
         end

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

@@ -105,7 +105,8 @@ module Pod
 
       # @!method authors=(authors)
       #
-      #   The name and email address of each of the library’s the authors.
+      #   The name and email addresses of the library maintainers, not the
+      #   Podspec maintainer.
       #
       #   @example
       #
@@ -124,7 +125,7 @@ module Pod
       #           the list of the authors of the library and their emails.
       #
       root_attribute :authors, {
-        :types       => [ String, Array, Hash ],
+        :types       => [String, Array, Hash],
         :container   => Hash,
         :required    => true,
         :singularize => true,
@@ -132,9 +133,34 @@ module Pod
 
       #------------------#
 
+      # @!method social_media_url=(social_media_url)
+      #
+      #   The URL for the social media contact of the Pod, CocoaPods web
+      #   services can use this.
+      #
+      #   For example, the @CocoaPodsFeed notifications will include the
+      #   Twitter handle (shortening the description) if the URL is relative to
+      #   Twitter. This does **not** necessarily have to be a Twitter URL, but
+      #   only those are included in the Twitter @CocoaPodsFeed notifications.
+      #
+      #   @example
+      #
+      #     spec.social_media_url = 'https://twitter.com/cocoapods'
+      #
+      #   @example
+      #
+      #     spec.social_media_url = 'https://groups.google.com/forum/#!forum/cocoapods'
+      #
+      #   @param  [String] social_media_url
+      #           the social media URL.
+      #
+      root_attribute :social_media_url
+
+      #------------------#
+
       # The keys accepted by the license attribute.
       #
-      LICENSE_KEYS = [ :type, :file, :text ].freeze
+      LICENSE_KEYS = [:type, :file, :text].freeze
 
       # @!method license=(license)
       #
@@ -210,15 +236,32 @@ module Pod
       #
       #   The location from where the library should be retrieved.
       #
-      #   @example Specifying a Git source with a tag.
+      #   @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' }
       #
-      #   @example Using the version of the Pod to identify the Git tag.
+      #   @example Using the version of the Pod to identify the Git commit and using submodules.
       #
       #     spec.source = { :git => 'https://github.com/AFNetworking/AFNetworking.git',
-      #                     :tag => "v#{spec.version}" }
+      #                     :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"}
+      #
+      #   @example Using Subversion with a tag.
+      #
+      #     spec.source = { :svn => "http://svn.code.sf.net/p/polyclipping/code", :tag => '4.8.8' }
+      #
+      #   @example Using Mercurial with the same revision as the spec's semantic version string.
+      #
+      #     spec.source = { :hg => "https://bitbucket.org/dcutting/hyperbek", :revision => "#{s.version}" }
+      #
+      #   @example Using HTTP to download a compressed file of the code. It supports zip, tgz, bz2 and tar.
+      #
+      #     spec.source = { :http => "http://dev.wechatapp.com/download/sdk/WeChat_SDK_iOS_en.zip" }
       #
       #   @param  [Hash{Symbol=>String}] source
       #           The location from where the library should be retrieved.
@@ -304,8 +347,9 @@ module Pod
 
       # @!method documentation_url=(documentation_url)
       #
-      #   An URL for the documentation of the Pod which will be honored by
-      #   CocoaPods web properties.
+      #   An optional URL for the documentation of the Pod which will be honored by
+      #   CocoaPods web properties. Leaving it blank will default to a CocoaDocs
+      #   generated URL for your library.
       #
       #   @example
       #
@@ -396,9 +440,7 @@ 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"] = {}
         end
@@ -451,7 +493,8 @@ module Pod
       #           The deployment target of the platform.
       #
       def deployment_target=(*args)
-        raise Informative, "The deployment target can be declared only per platform."
+        raise Informative, "The deployment target can be declared only per " \
+          "platform."
       end
 
       #-----------------------------------------------------------------------#
@@ -497,19 +540,25 @@ module Pod
       #
       def dependency(*args)
         name, *version_requirements = args
-        raise Informative, "A specification can't require itself as a subspec" if name == self.name
+        if name == self.name
+          raise Informative, "A specification can't require itself as a " \
+            "subspec"
+        end
         if @parent
           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"
-              break
+              raise Informative, "A subspec can't require one of its " \
+                "parents specifications"
+            else
+              composed_name << "/"
             end
-            composed_name << "/"
           end
         end
-        raise Informative, "Unsupported version requirements" unless version_requirements.all? { |req| req.is_a?(String) }
+        unless version_requirements.all? { |req| req.is_a?(String) }
+          raise Informative, "Unsupported version requirements"
+        end
         attributes_hash["dependencies"] ||= {}
         attributes_hash["dependencies"][name] = version_requirements
       end
@@ -694,7 +743,6 @@ module Pod
         :inherited => true
       }
 
-
       #------------------#
 
       # @!method header_dir=(dir)

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

@@ -42,7 +42,7 @@ module Pod
           @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 ] }
+          @types          = options.delete(:types)          { [String] }
 
           unless options.empty?
             raise StandardError, "Unrecognized options: #{options} for #{to_s}"
@@ -58,8 +58,8 @@ module Pod
         # @return [String] A string representation suitable for debugging.
         #
         def inspect
-          "<#{self.class} name=#{self.name} types=#{types} " \
-          "multi_platform=#{multi_platform?}>"
+          "<#{self.class} name=#{name} types=#{types} " \
+            "multi_platform=#{multi_platform?}>"
         end
 
         #---------------------------------------------------------------------#
@@ -209,7 +209,8 @@ module Pod
         #
         def validate_for_writing(spec, value)
           if root_only? && !spec.root?
-            raise StandardError, "Can't set `#{name}` attribute for subspecs (in `#{spec.name}`)."
+            raise StandardError, "Can't set `#{name}` attribute for " \
+              "subspecs (in `#{spec.name}`)."
           end
 
           if keys

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

@@ -8,59 +8,73 @@ module Pod
 
         def preferred_dependency=(name)
           self.default_subspec = name
-          CoreUI.warn "[#{to_s}] `preferred_dependency` has been renamed to `default_subspec`."
+          CoreUI.warn "[#{to_s}] `preferred_dependency` has been renamed "\
+            "to `default_subspec`."
         end
 
         def singleton_method_added(method)
           if method == :pre_install
-            CoreUI.warn "[#{to_s}] The use of `#{method}` by overriding the method is deprecated."
+            CoreUI.warn "[#{to_s}] The use of `#{method}` by overriding " \
+              "the method is deprecated."
             @pre_install_callback = Proc.new do |pod, target_definition|
-              self.pre_install(pod, target_definition)
+              pre_install(pod, target_definition)
             end
 
           elsif method == :post_install
-            CoreUI.warn "[#{to_s}] The use of `#{method}` by overriding the method is deprecated."
+            CoreUI.warn "[#{to_s}] The use of `#{method}` by overriding the " \
+              "method is deprecated."
             @post_install_callback = Proc.new do |target_installer|
-              self.post_install(target_installer)
+              post_install(target_installer)
             end
 
           elsif method == :header_mappings
-            raise Informative, "[#{to_s}] The use of the `header_mappings` hook has been deprecated.\n" \
-              "Use the `header_dir` and the `header_mappings_dir` attributes."
+            raise Informative, "[#{to_s}] The use of the `header_mappings` " \
+              "hook has been deprecated.\n Use the `header_dir` and the " \
+                "`header_mappings_dir` attributes."
 
           elsif method == :copy_header_mapping
-            raise Informative, "[#{to_s}] The use of the `copy_header_mapping` hook has been deprecated.\n" \
-              "Use the `header_dir` and the `header_mappings_dir` attributes."
+            raise Informative, "[#{to_s}] The use of the " \
+              "`copy_header_mapping` hook has been deprecated.\nUse" \
+                "the `header_dir` and the `header_mappings_dir` attributes."
           end
         end
 
         def documentation=(value)
-          CoreUI.warn "[#{to_s}] The `documentation` DSL directive of the podspec format has been deprecated."
+          CoreUI.warn "[#{to_s}] The `documentation` DSL directive of the " \
+            "podspec format has been deprecated."
         end
 
         def clean_paths=(value)
-          raise Informative, "[#{to_s}] Clean paths are deprecated. CocoaPods now " \
-            "cleans unused files by default. Use the `preserve_paths` attribute if needed."
+          raise Informative, "[#{to_s}] Clean paths are deprecated. " \
+            "CocoaPods now cleans unused files by default. Use the " \
+              "`preserve_paths` attribute if needed."
         end
 
-        [ :part_of_dependency=, :part_of=, :exclude_header_search_paths= ].each do |method|
+        DEPRECATED_METHODS = [
+          :part_of_dependency=,
+          :part_of=,
+          :exclude_header_search_paths=
+        ]
+
+        DEPRECATED_METHODS.each do |method|
           define_method method do |value|
-            raise Informative, "[#{to_s}] Attribute `#{method.to_s[0..-2]}` has been deprecated."
+            raise Informative, "[#{to_s}] Attribute "\
+              "`#{method.to_s[0..-2]}` has been deprecated."
           end
         end
 
         # @!group Hooks
         #
-        #   The specification class provides hooks which are called by CocoaPods
-        #   when a Pod is installed.
+        #   The specification class provides hooks which are called by
+        #   CocoaPods when a Pod is installed.
 
         #-----------------------------------------------------------------------#
 
-        # This is a convenience method which gets called after all pods have been
-        # downloaded but before they have been installed, and the Xcode project
-        # and related files have been generated. Note that this hook is called
-        # for each Pods library and only for installations where the Pod is
-        # installed.
+        # This is a convenience method which gets called after all pods have
+        # been downloaded but before they have been installed, and the Xcode
+        # project and related files have been generated. Note that this hook is
+        # called for each Pods library and only for installations where the Pod
+        # is installed.
         #
         # This hook should be used to generate and modify the files of the Pod.
         #
@@ -117,9 +131,7 @@ module Pod
 
         #-----------------------------------------------------------------------#
 
-
       end
-
     end
   end
 end

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

@@ -11,8 +11,8 @@ module Pod
         #
         attr_accessor :spec
 
-        # @return [Symbol] the platform described by this proxy. Can be either `:ios` or
-        #         `:osx`.
+        # @return [Symbol] the platform described by this proxy. Can be either
+        #         `:ios` or `:osx`.
         #
         attr_accessor :platform
 
@@ -23,18 +23,22 @@ module Pod
           @spec, @platform = spec, platform
         end
 
-        # Defines a setter method for each attribute of the specification class,
-        # that forwards the message to the {#specification} using the
+        # Defines a setter method for each attribute of the specification
+        # class, that forwards the message to the {#specification} using the
         # {Specification#on_platform} method.
         #
         # @return [void]
         #
         def method_missing(meth, *args, &block)
-          attr = Specification::DSL.attributes.values.find do |attr|
-            attr.writer_name.to_sym == meth || (attr.writer_singular_form && attr.writer_singular_form.to_sym == meth)
+          attribute = Specification::DSL.attributes.values.find do |attr|
+            if attr.writer_name.to_sym == meth
+              true
+            elsif attr.writer_singular_form
+              attr.writer_singular_form.to_sym == meth
+            end
           end
-          if attr && attr.multi_platform?
-            spec.store_attribute(attr.name, args.first, platform)
+          if attribute && attribute.multi_platform?
+            spec.store_attribute(attribute.name, args.first, platform)
           else
             super
           end
@@ -47,9 +51,10 @@ module Pod
         def dependency(*args)
           name, *version_requirements = args
           platform_name = platform.to_s
-          spec.attributes_hash[platform_name] ||= {}
-          spec.attributes_hash[platform_name]["dependencies"] ||= {}
-          spec.attributes_hash[platform_name]["dependencies"][name] = version_requirements
+          platform_hash = spec.attributes_hash[platform_name] || {}
+          platform_hash["dependencies"] ||= {}
+          platform_hash["dependencies"][name] = version_requirements
+          spec.attributes_hash[platform_name] = platform_hash
         end
 
         # Allows to set the deployment target for the platform.

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

@@ -90,13 +90,23 @@ module Pod
       def perform_textual_analysis
         return unless @file
         text = @file.read
-        error "`config.ios?` and `config.osx?` are deprecated."  if text =~ /config\..?os.?/
-        error "clean_paths are deprecated (use preserve_paths)." if text =~ /clean_paths/
+        if text =~ /config\..?os.?/
+          error "`config.ios?` and `config.osx?` are deprecated."
+        end
+        if text =~ /clean_paths/
+          error "clean_paths are deprecated (use preserve_paths)."
+        end
+
         all_lines_count = text.lines.count
         comments_lines_count = text.scan(/^\s*#\s+/).length
         comments_ratio = comments_lines_count.fdiv(all_lines_count)
-        warning "Comments must be deleted." if comments_lines_count > 20 && comments_ratio > 0.2
-        warning "Comments placed at the top of the specification must be deleted." if text.lines.first =~ /^\s*#\s+/
+        if comments_lines_count > 20 && comments_ratio > 0.2
+          warning "Comments must be deleted."
+        end
+        if text.lines.first =~ /^\s*#\s+/
+          warning "Comments placed at the top of the specification must be " \
+            "deleted."
+        end
       end
 
       # Checks that every root only attribute which is required has a value.
@@ -138,7 +148,7 @@ module Pod
       # @return [void]
       #
       def perform_all_specs_analysis
-        all_specs = [ spec, *spec.recursive_subspecs ]
+        all_specs = [spec, *spec.recursive_subspecs]
         all_specs.each do |current_spec|
           current_spec.available_platforms.each do |platform|
             @consumer = Specification::Consumer.new(current_spec, platform)
@@ -193,7 +203,11 @@ module Pod
       #
       def _validate_name(n)
         if spec.name && file
-          names_match = (file.basename.to_s == spec.root.name + '.podspec') || (file.basename.to_s == spec.root.name + '.podspec.yaml')
+          acceptable_names = [
+            spec.root.name + '.podspec',
+            spec.root.name + '.podspec.yaml'
+          ]
+          names_match = acceptable_names.include?(file.basename.to_s)
           unless names_match
             error "The name of the spec should match the name of the file."
           end
@@ -203,37 +217,56 @@ module Pod
       def _validate_version(v)
         if v.to_s.empty?
           error "A version is required."
-        else
-          error "The version of the spec should be higher than 0." unless v > Version::ZERO
+        elsif v <= Version::ZERO
+          error "The version of the spec should be higher than 0."
         end
       end
 
       # Performs validations related to the `summary` attribute.
       #
       def _validate_summary(s)
-        warning "The summary should be a short version of `description` (max 140 characters)." if s.length > 140
-        warning "The summary is not meaningful." if s =~ /A short description of/
+        if s.length > 140
+          warning "The summary should be a short version of `description` " \
+            "(max 140 characters)."
+        end
+        if s =~ /A short description of/
+          warning "The summary is not meaningful."
+        end
       end
 
       # Performs validations related to the `description` attribute.
       #
       def _validate_description(d)
-        warning "The description is not meaningful." if d =~ /An optional longer description of/
-        warning "The description is equal to the summary." if d == spec.summary
-        warning "The description is shorter than the summary." if d.length < spec.summary.length
+        if d =~ /An optional longer description of/
+          warning "The description is not meaningful."
+        end
+        if d == spec.summary
+          warning "The description is equal to the summary."
+        end
+        if d.length < spec.summary.length
+          warning "The description is shorter than the summary."
+        end
       end
 
       def _validate_homepage(h)
-        warning "The homepage has not been updated from default" if h =~ /http:\/\/EXAMPLE/
+        if h =~ %r[http://EXAMPLE]
+          warning "The homepage has not been updated from default"
+        end
       end
 
       # Performs validations related to the `license` attribute.
       #
       def _validate_license(l)
         type = l[:type]
-        warning "Missing license type." if type.nil?
-        warning "Invalid license type." if type && type.gsub(' ', '').gsub("\n", '').empty?
-        error   "Sample license type."  if type && type =~ /\(example\)/
+        if type.nil?
+          warning "Missing license type."
+        end
+        if type && type.gsub(' ', '').gsub("\n", '').empty?
+          warning "Invalid license type."
+        end
+        if type && type =~ /\(example\)/
+          error "Sample license type."
+        end
       end
 
       # Performs validations related to the `source` attribute.
@@ -241,21 +274,49 @@ module Pod
       def _validate_source(s)
         if git = s[:git]
           tag, commit = s.values_at(:tag, :commit)
-          github      = git.include?('github.com')
-          version     = spec.version.to_s
+          version = spec.version.to_s
 
-          error "Example source." if git =~ /http:\/\/EXAMPLE/
-          error 'The commit of a Git source cannot be `HEAD`.'    if commit && commit.downcase =~ /head/
-          warning 'The version should be included in the Git tag.' if tag && !tag.include?(version)
-          warning "Github repositories should end in `.git`."      if github && !git.end_with?('.git')
-          warning "Github repositories should use `https` link."   if github && !git.start_with?('https://github.com') && !git.start_with?('git://gist.github.com')
+          if git =~ %r[http://EXAMPLE]
+            error "Example source."
+          end
+          if commit && commit.downcase =~ /head/
+            error 'The commit of a Git source cannot be `HEAD`.'
+          end
+          if tag && !tag.include?(version)
+            warning 'The version should be included in the Git tag.'
+          end
 
           if version == '0.0.1'
-            error 'Git sources should specify either a commit or a tag.' if commit.nil? && tag.nil?
+            if commit.nil? && tag.nil?
+              error 'Git sources should specify either a commit or a tag.'
+            end
           else
             warning 'Git sources should specify a tag.' if tag.nil?
           end
         end
+
+        perform_github_source_checks(s)
+      end
+
+      # Performs validations related to github sources.
+      #
+      def perform_github_source_checks(s)
+        supported_domains = [
+          'https://github.com',
+          'https://gist.github.com',
+        ]
+
+        if git = s[:git]
+          is_github = git.include?('github.com')
+          if is_github
+            unless git.end_with?('.git')
+              warning "Github repositories should end in `.git`."
+            end
+            unless supported_domains.find { |domain| git.start_with?(domain) }
+              warning "Github repositories should use `https` link."
+            end
+          end
+        end
       end
 
       #-----------------------------------------------------------------------#
@@ -285,7 +346,8 @@ module Pod
           end
           patterns.each do |pattern|
             if pattern.start_with?('/')
-              error "File patterns must be relative and cannot start with a slash (#{attrb.name})."
+              error "File patterns must be relative and cannot start with a " \
+                "slash (#{attrb.name})."
             end
           end
         end
@@ -295,31 +357,38 @@ module Pod
       #
       def check_tmp_arc_not_nil
         if consumer.requires_arc.nil?
-          warning "A value for `requires_arc` should be specified until the migration to a `true` default."
+          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 preserve_paths dependencies ]
+        methods = %w[ source_files resources 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, preserve paths, dependencies or subspecs)."
+          error "The #{consumer.spec} spec is empty (no source files, " \
+            "resources, preserve paths, , vendored_libraries, " \
+              "vendored_frameworks dependencies or subspecs)."
         end
       end
 
       # Check the hooks
       #
       def check_install_hooks
-        warning "The pre install hook of the specification DSL has been " \
-          "deprecated, use the `resource_bundles` or the `prepare_command` " \
-          "attributes." unless consumer.spec.pre_install_callback.nil?
+        unless consumer.spec.pre_install_callback.nil?
+          warning "The pre install hook of the specification DSL has been " \
+            "deprecated, use the `resource_bundles` or the " \
+              "`prepare_command` attributes."
+        end
 
-        warning "The post install hook of the specification DSL has been " \
-          "deprecated, use the `resource_bundles` or the `prepare_command` " \
-          "attributes." unless consumer.spec.post_install_callback.nil?
+        unless consumer.spec.post_install_callback.nil?
+          warning "The post install hook of the specification DSL has been " \
+            "deprecated, use the `resource_bundles` or the " \
+              " `prepare_command` attributes."
+        end
       end
 
       #-----------------------------------------------------------------------#
@@ -403,7 +472,9 @@ module Pod
         def to_s
           r = "[#{type.to_s.upcase}] #{message}"
           if platforms != Specification::PLATFORMS
-            platforms_names = platforms.uniq.map { |p| Platform.string_name(p) }
+            platforms_names = platforms.uniq.map do |p|
+              Platform.string_name(p)
+            end
             r << " [#{platforms_names * ' - '}]" unless platforms.empty?
           end
           r