cocoapods-core 0.31.1 → 0.32.0

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

@@ -0,0 +1,113 @@
+module Pod
+  class Specification
+    class Linter
+      class Result
+        # @return [Symbol] the type of result.
+        #
+        attr_reader :type
+
+        # @return [String] the message associated with result.
+        #
+        attr_reader :message
+
+        # @param [Symbol] type    @see type
+        # @param [String] message @see message
+        #
+        def initialize(type, message)
+          @type    = type
+          @message = message
+          @platforms = []
+        end
+
+        # @return [Array<Platform>] the platforms where this result was
+        #         generated.
+        #
+        attr_reader :platforms
+
+        # @return [String] a string representation suitable for UI output.
+        #
+        def to_s
+          r = "[#{type.to_s.upcase}] #{message}"
+          if platforms != Specification::PLATFORMS
+            platforms_names = platforms.uniq.map do |p|
+              Platform.string_name(p)
+            end
+            r << " [#{platforms_names * ' - '}]" unless platforms.empty?
+          end
+          r
+        end
+      end
+
+      module ResultHelpers
+        public
+
+        # @return [Array<Result>] all of the generated results.
+        #
+        attr_reader :results
+
+        private
+
+        # Adds an error result with the given message.
+        #
+        # @param  [String] message
+        #         The message of the result.
+        #
+        # @return [void]
+        #
+        def error(message)
+          add_result(:error, message)
+        end
+
+        # Adds an warning result with the given message.
+        #
+        # @param  [String] message
+        #         The message of the result.
+        #
+        # @return [void]
+        #
+        def warning(message)
+          add_result(:warning, message)
+        end
+
+        # Merges results passed in with the current results
+        #
+        # @param  [Array<Result>] results
+        #         The results to be merged.
+        #
+        # @return [void]
+        #
+        def add_results(results)
+          results.each do |result|
+            if result.type == :warning
+              warning(result.message)
+            else
+              error(result.message)
+            end
+          end
+        end
+
+        # Adds a result of the given type with the given message. If there is a
+        # current platform it is added to the result. If a result with the same
+        # type and the same message is already available the current platform is
+        # added to the existing result.
+        #
+        # @param  [Symbol] type
+        #         The type of the result (`:error`, `:warning`).
+        #
+        # @param  [String] message
+        #         The message of the result.
+        #
+        # @return [void]
+        #
+        def add_result(type, message)
+          result = results.find { |r| r.type == type && r.message == message }
+          unless result
+            result = Result.new(type, message)
+            results << result
+          end
+          result.platforms << consumer.platform_name if consumer
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,15 @@
+require 'cocoapods-core/specification/linter/result'
+require 'cocoapods-core/specification/linter/analyzer'
+
 module Pod
   class Specification
-
     # The Linter check specifications for errors and warnings.
     #
     # It is designed not only to guarantee the formal functionality of a
     # specification, but also to support the maintenance of sources.
     #
     class Linter
+      include ResultHelpers
 
       # @return [Specification] the specification to lint.
       #
@@ -43,7 +46,6 @@ module Pod
       def lint
         @results = []
         if spec
-          perform_textual_analysis
           check_required_root_attributes
           run_root_validation_hooks
           perform_all_specs_analysis
@@ -60,10 +62,6 @@ module Pod
 
       public
 
-      # @return [Array<Result>] all the results generated by the Linter.
-      #
-      attr_reader :results
-
       # @return [Array<Result>] all the errors generated by the Linter.
       #
       def errors
@@ -82,33 +80,6 @@ module Pod
 
       # !@group Lint steps
 
-      # It reads a podspec file and checks for strings corresponding
-      # to features that are or will be deprecated
-      #
-      # @return [void]
-      #
-      def perform_textual_analysis
-        return unless @file
-        text = @file.read
-        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)
-        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.
       #
       # @return [void]
@@ -134,13 +105,7 @@ module Pod
       #
       def run_root_validation_hooks
         attributes = DSL.attributes.values.select(&:root_only?)
-        attributes.each do |attr|
-          validation_hook = "_validate_#{attr.name}"
-          next unless respond_to?(validation_hook, true)
-          value = spec.send(attr.name)
-          next unless value
-          send(validation_hook, value)
-        end
+        run_validation_hooks(attributes, spec)
       end
 
       # Run validations for multi-platform attributes activating .
@@ -153,10 +118,9 @@ module Pod
           current_spec.available_platforms.each do |platform|
             @consumer = Specification::Consumer.new(current_spec, platform)
             run_all_specs_validation_hooks
-            validate_file_patterns
-            check_tmp_arc_not_nil
-            check_if_spec_is_empty
-            check_install_hooks
+            analyzer = Analyzer.new(@consumer)
+            analyzer.analyze
+            add_results(analyzer.results)
             @consumer = nil
           end
         end
@@ -172,13 +136,7 @@ module Pod
       #
       def run_all_specs_validation_hooks
         attributes = DSL.attributes.values.reject(&:root_only?)
-        attributes.each do |attr|
-          validation_hook = "_validate_#{attr.name}"
-          next unless respond_to?(validation_hook, true)
-          value = consumer.send(attr.name)
-          next unless value
-          send(validation_hook, value)
-        end
+        run_validation_hooks(attributes, consumer)
       end
 
       # Runs the validation hook for each attribute.
@@ -189,9 +147,15 @@ module Pod
       #
       # @return [void]
       #
-      # def run_validation_hooks(attributes)
-      #
-      # end
+      def run_validation_hooks(attributes, target)
+        attributes.each do |attr|
+          validation_hook = "_validate_#{attr.name}"
+          next unless respond_to?(validation_hook, true)
+          value = target.send(attr.name)
+          next unless value
+          send(validation_hook, value)
+        end
+      end
 
       #-----------------------------------------------------------------------#
 
@@ -209,20 +173,24 @@ module Pod
           ]
           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."
+            error 'The name of the spec should match the name of the file.'
           end
 
           if spec.root.name =~ /\s/
-            error "The name of a spec should not contain whitespace."
+            error 'The name of a spec should not contain whitespace.'
+          end
+
+          if spec.root.name[0, 1] == '.'
+            error 'The name of a spec should not begin with a period.'
           end
         end
       end
 
       def _validate_version(v)
         if v.to_s.empty?
-          error "A version is required."
+          error 'A version is required.'
         elsif v <= Version::ZERO
-          error "The version of the spec should be higher than 0."
+          error 'The version of the spec should be higher than 0.'
         end
       end
 
@@ -234,7 +202,7 @@ module Pod
             "(max 140 characters)."
         end
         if s =~ /A short description of/
-          warning "The summary is not meaningful."
+          warning 'The summary is not meaningful.'
         end
       end
 
@@ -242,13 +210,13 @@ module Pod
       #
       def _validate_description(d)
         if d =~ /An optional longer description of/
-          warning "The description is not meaningful."
+          warning 'The description is not meaningful.'
         end
         if d == spec.summary
-          warning "The description is equal to the summary."
+          warning 'The description is equal to the summary.'
         end
         if d.length < spec.summary.length
-          warning "The description is shorter than the summary."
+          warning 'The description is shorter than the summary.'
         end
       end
 
@@ -256,7 +224,7 @@ module Pod
       #
       def _validate_homepage(h)
         if h =~ %r{http://EXAMPLE}
-          warning "The homepage has not been updated from default"
+          warning 'The homepage has not been updated from default'
         end
       end
 
@@ -264,7 +232,7 @@ module Pod
       #
       def _validate_frameworks(frameworks)
         if frameworks_invalid?(frameworks)
-          error "A framework should only be specified by its name"
+          error 'A framework should only be specified by its name'
         end
       end
 
@@ -272,15 +240,26 @@ module Pod
       #
       def _validate_weak_frameworks(frameworks)
         if frameworks_invalid?(frameworks)
-          error "A weak framework should only be specified by its name"
+          error 'A weak framework should only be specified by its name'
         end
       end
 
       # Performs validations related to the `libraries` attribute.
       #
       def _validate_libraries(libs)
-        if libraries_invalid?(libs)
-          error "A library should only be specified by its name"
+        libs.each do |lib|
+          lib = lib.downcase
+          if lib.end_with?('.a') || lib.end_with?('.dylib')
+            error "Libraries should not include the extension (`#{lib}`)"
+          end
+
+          if lib.start_with?('lib')
+            error "Libraries should omit the `lib` prefix (`#{lib}`)"
+          end
+
+          if lib.include?(',')
+            error "Libraries should not include comas (`#{lib}`)"
+          end
         end
       end
 
@@ -289,13 +268,13 @@ module Pod
       def _validate_license(l)
         type = l[:type]
         if type.nil?
-          warning "Missing license type."
+          warning 'Missing license type.'
         end
         if type && type.gsub(' ', '').gsub("\n", '').empty?
-          warning "Invalid license type."
+          warning 'Invalid license type.'
         end
         if type && type =~ /\(example\)/
-          error "Sample license type."
+          error 'Sample license type.'
         end
       end
 
@@ -307,7 +286,7 @@ module Pod
           version = spec.version.to_s
 
           if git =~ %r{http://EXAMPLE}
-            error "The Git source still contains the example URL."
+            error 'The Git source still contains the example URL.'
           end
           if commit && commit.downcase =~ /head/
             error 'The commit of a Git source cannot be `HEAD`.'
@@ -337,15 +316,23 @@ module Pod
           git_uri = URI.parse(git)
           if git_uri.host == 'github.com' || git_uri.host == 'gist.github.com'
             unless git.end_with?('.git')
-              warning "Github repositories should end in `.git`."
+              warning 'Github repositories should end in `.git`.'
             end
             unless git_uri.scheme == 'https'
-              warning "Github repositories should use `https` link."
+              warning 'Github repositories should use `https` link.'
             end
           end
         end
       end
 
+      # Performs validations related to the `social_media_url` attribute.
+      #
+      def _validate_social_media_url(s)
+        if s =~ %r{https://twitter.com/EXAMPLE}
+          warning 'The social media URL has not been updated from default'
+        end
+      end
+
       #-----------------------------------------------------------------------#
 
       # @!group All specs validation helpers
@@ -360,219 +347,20 @@ module Pod
         end
       end
 
-      # 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 in 0.18 and switch the default to true.
-      #
-      def check_tmp_arc_not_nil
-        if consumer.spec.attributes_hash["requires_arc"].nil?
-          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 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, 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 of the specification DSL 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 of the specification DSL has been " \
-            "deprecated, use the `resource_bundles` or the " \
-              " `prepare_command` attributes."
-        end
-      end
-
       # Returns whether the frameworks are valid
       #
-      # @params frameworks [Array<String>]
+      # @param frameworks [Array<String>]
       # The frameworks to be validated
       #
-      # @return [Boolean] true if a framework ends in `.framework`
+      # @return [Boolean] true if a framework contains any
+      # non-alphanumeric character or includes an extension.
       #
       def frameworks_invalid?(frameworks)
-        frameworks.any? { |framework| framework.end_with?('.framework') }
-      end
-
-      # Returns whether the libraries are valid
-      #
-      # @params libs [Array<String>]
-      # The libraries to be validated
-      #
-      # @return [Boolean] true if a library ends with `.a`, `.dylib`, or
-      # starts with `lib`.
-      def libraries_invalid?(libs)
-        libs.any? { |lib| lib.end_with?('.a', '.dylib') || lib.start_with?('lib') }
-      end
-
-      #-----------------------------------------------------------------------#
-
-      # !@group Result Helpers
-
-      private
-
-      # Adds an error result with the given message.
-      #
-      # @param  [String] message
-      #         The message of the result.
-      #
-      # @return [void]
-      #
-      def error(message)
-        add_result(:error, message)
-      end
-
-      # Adds an warning result with the given message.
-      #
-      # @param  [String] message
-      #         The message of the result.
-      #
-      # @return [void]
-      #
-      def warning(message)
-        add_result(:warning, message)
-      end
-
-      # Adds a result of the given type with the given message. If there is a
-      # current platform it is added to the result. If a result with the same
-      # type and the same message is already available the current platform is
-      # added to the existing result.
-      #
-      # @param  [Symbol] type
-      #         The type of the result (`:error`, `:warning`).
-      #
-      # @param  [String] message
-      #         The message of the result.
-      #
-      # @return [void]
-      #
-      def add_result(type, message)
-        result = results.find { |r| r.type == type && r.message == message }
-        unless result
-          result = Result.new(type, message)
-          results << result
-        end
-        result.platforms << consumer.platform_name if consumer
-      end
-
-      #-----------------------------------------------------------------------#
-
-      class Result
-
-        # @return [Symbol] the type of result.
-        #
-        attr_reader :type
-
-        # @return [String] the message associated with result.
-        #
-        attr_reader :message
-
-        # @param [Symbol] type    @see type
-        # @param [String] message @see message
-        #
-        def initialize(type, message)
-          @type    = type
-          @message = message
-          @platforms = []
-        end
-
-        # @return [Array<Platform>] the platforms where this result was
-        #         generated.
-        #
-        attr_reader :platforms
-
-        # @return [String] a string representation suitable for UI output.
-        #
-        def to_s
-          r = "[#{type.to_s.upcase}] #{message}"
-          if platforms != Specification::PLATFORMS
-            platforms_names = platforms.uniq.map do |p|
-              Platform.string_name(p)
-            end
-            r << " [#{platforms_names * ' - '}]" unless platforms.empty?
-          end
-          r
+        frameworks.any? do |framework|
+          framework_regex = /[^\w\-\+]/
+          framework =~ framework_regex
         end
       end
-
-      #-----------------------------------------------------------------------#
-
     end
   end
 end
-
-      # # TODO
-      # # Converts the resources file patterns to a hash defaulting to the
-      # # resource key if they are defined as an Array or a String.
-      # #
-      # # @param  [String, Array, Hash] value.
-      # #         The value of the attribute as specified by the user.
-      # #
-      # # @return [Hash] the resources.
-      # #
-      # def _prepare_deployment_target(deployment_target)
-      #   unless @define_for_platforms.count == 1
-      #     raise StandardError, "The deployment target must be defined per platform like `s.ios.deployment_target = '5.0'`."
-      #   end
-      #   Version.new(deployment_target)
-      # end
-
-      # # TODO
-      # # Converts the resources file patterns to a hash defaulting to the
-      # # resource key if they are defined as an Array or a String.
-      # #
-      # # @param  [String, Array, Hash] value.
-      # #         The value of the attribute as specified by the user.
-      # #
-      # # @return [Hash] the resources.
-      # #
-      # def _prepare_platform(name_and_deployment_target)
-      #   return nil if name_and_deployment_target.nil?
-      #   if name_and_deployment_target.is_a?(Array)
-      #     name = name_and_deployment_target.first
-      #     deployment_target = name_and_deployment_target.last
-      #   else
-      #     name = name_and_deployment_target
-      #     deployment_target = nil
-      #   end
-      #   unless PLATFORMS.include?(name)
-      #     raise StandardError, "Unsupported platform `#{name}`. The available " \
-      #       "names are `#{PLATFORMS.inspect}`"
-      #   end
-      #   Platform.new(name, deployment_target)
-      # end