cocoapods-core 0.17.0.rc1

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

@@ -0,0 +1,436 @@
+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
+
+      # @return [Specification] the specification to lint.
+      #
+      attr_reader :spec
+
+      # @return [Pathname] the path of the `podspec` file where {#spec} is
+      #         defined.
+      #
+      attr_reader :file
+
+      # @param  [Specification, Pathname, String] spec_or_path
+      #         the Specification or the path of the `podspec` file to lint.
+      #
+      def initialize(spec_or_path)
+        if spec_or_path.is_a?(Specification)
+          @spec = spec_or_path
+          @file = @spec.defined_in_file
+        else
+          @file = Pathname.new(spec_or_path)
+          begin
+            @spec = Specification.from_file(@file)
+          rescue Exception => e
+            @spec = nil
+            @raise_message = e.message
+          end
+        end
+      end
+
+      # Lints the specification adding a {Result} for any failed check to the
+      # {#results} list.
+      #
+      # @return [Bool] whether the specification passed validation.
+      #
+      def lint
+        @results = []
+        if spec
+          perform_textual_analysis
+          check_required_root_attributes
+          run_root_validation_hooks
+          perform_all_specs_ananlysis
+        else
+          error "The specification defined in `#{file}` could not be loaded." \
+            "\n\n#{@raise_message}"
+        end
+        results.empty?
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # !@group Lint results
+
+      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
+        @errors ||= results.select { |r| r.type == :error }
+      end
+
+      # @return [Array<Result>] all the warnings generated by the Linter.
+      #
+      def warnings
+        @warnings ||= results.select { |r| r.type == :warning }
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # !@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
+        error "`config.ios?' and `config.osx?' are deprecated."  if text =~ /config\..?os.?/
+        error "clean_paths are deprecated (use preserve_paths)." if text =~ /clean_paths/
+        warning "Comments must be deleted." if text.scan(/^\s*#/).length > 24
+      end
+
+      # Checks that every root only attribute which is required has a value.
+      #
+      # @return [void]
+      #
+      def  check_required_root_attributes
+        attributes = DSL.attributes.values.select(&:root_only?)
+        attributes.each do |attr|
+          # if spec.respond_to?(attr.name)
+            value = spec.send(attr.name)
+            next unless attr.required?
+            unless value && (!value.respond_to?(:empty?) || !value.empty?)
+              if attr.name == :license
+                warning("Missing required attribute `#{attr.name}`.")
+              else
+                error("Missing required attribute `#{attr.name}`.")
+              end
+            end
+          end
+        # end
+      end
+
+      # Runs the validation hook for root only attributes.
+      #
+      # @return [void]
+      #
+      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
+      end
+
+      # Run validations for multi-platform attributes activating .
+      #
+      # @return [void]
+      #
+      def perform_all_specs_ananlysis
+        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)
+            run_all_specs_valudation_hooks
+            validate_file_patterns
+            check_tmp_arc_not_nil
+            check_if_spec_is_empty
+            @consumer = nil
+          end
+        end
+      end
+
+      # @return [Specification::Consumer] the current consumer.
+      #
+      attr_accessor :consumer
+
+      # Runs the validation hook for the attributes that are not root only.
+      #
+      # @return [void]
+      #
+      def run_all_specs_valudation_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
+      end
+
+      # Runs the validation hook for each attribute.
+      #
+      # @note   Hooks are called only if there is a value for the attribute as
+      #         required attributes are already checked by the
+      #         {#check_required_root_attributes} step.
+      #
+      # @return [void]
+      #
+      def run_validation_hooks(attributes)
+
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # @!group Root spec validation helpers
+
+      # Performs validations related to the `name` attribute.
+      #
+      def _validate_name(n)
+        if spec.name && file
+          names_match = (file.basename.to_s == spec.root.name + '.podspec')
+          unless names_match
+            error "The name of the spec should match the name of the file."
+          end
+        end
+      end
+
+      # Performs validations related to the `summary` attribute.
+      #
+      def _validate_summary(s)
+        warning "The summary should be short use `description` (max 140 characters)." if s.length > 140
+        warning "The summary is not meaningful." if s =~ /A short description of/
+        warning "The summary should end with proper punctuation." if s !~ /(\.|\?|!)$/
+      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 should end with proper punctuation." if d !~ /(\.|\?|!)$/
+        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
+      end
+
+      # Performs validations related to the `license` attribute.
+      #
+      def _validate_license(l)
+        type = l[:type]
+        warning "Missing license type." if type.nil?
+        warning "Sample license type."  if type && type =~ /\(example\)/
+        warning "Invalid license type." if type && type.gsub(' ', '').gsub("\n", '').empty?
+      end
+
+      # Performs validations related to the `source` attribute.
+      #
+      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
+
+          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 version == '0.0.1'
+            error 'Git sources should specify either a commit or a tag.' if commit.nil? && tag.nil?
+          else
+            warning 'Git sources should specify a tag.' if tag.nil?
+          end
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+
+      # @!group All specs validation helpers
+
+      private
+
+      # Performs validations related to the `compiler_flags` attribute.
+      #
+      def _validate_compiler_flags(flags)
+        if flags.join(' ').split(' ').any? { |flag| flag.start_with?('-Wno') }
+          warning "Warnings must not be disabled (`-Wno' compiler flags)."
+        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.is_a?(Rake::FileList)
+              error "Rake::FileList is deprecated, use `exclude_files` (#{attrb.name})."
+            else
+              if pattern.start_with?('/')
+                error "File patterns must be relative and cannot start with a slash (#{attrb.name})."
+              end
+            end
+          end
+        end
+      end
+
+      # @todo remove in 0.18 and switch the default to true.
+      #
+      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."
+        end
+      end
+
+      # Check empty subspec attributes
+      #
+      def check_if_spec_is_empty
+        methods = %w[ source_files resources preserve_paths subspecs ]
+        empty = methods.all? { |m| consumer.send(m).empty? }
+        if empty
+          error "The spec appears to be empty (no source files, resources, or preserve paths)."
+        end
+      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 { |p| Platform.string_name(p) }
+            r << " [#{platforms_names * ' - '}]" unless platforms.empty?
+          end
+          r
+        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

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

@@ -0,0 +1,152 @@
+module Pod
+  class Specification
+    module DSL
+
+      # Provides the accessors methods for the root attributes. Root attributes
+      # do not support multiplatform values and inheritance.
+      #
+      module RootAttributesAccessors
+
+        # @return [String] The name of the specification *not* including the
+        #         names of the parents, in case of ‘sub-specifications’.
+        #
+        def base_name
+          attributes_hash["name"]
+        end
+
+        # @return [String] The name of the specification including the names of
+        #         the parents, in case of ‘sub-specifications’.
+        #
+        def name
+          parent ? "#{parent.name}/#{base_name}" : base_name
+        end
+
+        # @return [Version] The version of the Pod.
+        #
+        # @todo   The version is memoized because the Resolvers sets the head
+        #         state on it. This information should be stored in the
+        #         specification instance and the lockfile should have a more
+        #         robust handling of head versions (like a dedicated section).
+        #
+        def version
+           @version ||= root? ? Version.new(attributes_hash["version"]) : root.version
+        end
+
+        # @return [Hash] a hash containing the authors as the keys and their
+        #         email address as the values.
+        #
+        # @note   The value is coherced to a hash with a nil email if needed.
+        #
+        # @example Possible values
+        #
+        #   { 'Author' => 'email@host.com' }
+        #   [ 'Author', { 'Author_2' => 'email@host.com' } ]
+        #   [ 'Author', 'Author_2' ]
+        #   'Author'
+        #
+        def authors
+          authors = attributes_hash["authors"]
+          if authors.is_a?(Hash)
+            authors
+          elsif authors.is_a?(Array)
+            result = {}
+            authors.each do |name_or_hash|
+              if name_or_hash.is_a?(String)
+                result[name_or_hash] = nil
+              else
+                result.merge!(name_or_hash)
+              end
+            end
+            result
+          elsif authors.is_a?(String)
+            { authors => nil }
+          end
+        end
+
+        # @return [Hash] A hash containing the license information of the Pod.
+        #
+        # @note   The indentation is stripped from the license text.
+        #
+        def license
+          license = attributes_hash["license"]
+          if license.is_a?(String)
+            { :type => license }
+          elsif license.is_a?(Hash)
+            license = convert_keys_to_symbol(license)
+            license[:text] = license[:text].strip_heredoc if license[:text]
+            license
+          else
+            {}
+          end
+        end
+
+        # @return [String] The URL of the homepage of the Pod.
+        #
+        def homepage
+          attributes_hash["homepage"]
+        end
+
+        # @return [Hash{Symbol=>String}] The location from where the library
+        #         should be retrieved.
+        #
+        def source
+          convert_keys_to_symbol(attributes_hash["source"])
+        end
+
+        # @return [String] A short description of the Pod.
+        #
+        def summary
+          attributes_hash["summary"]
+        end
+
+        # @return [String] A longer description of the Pod.
+        #
+        # @note   The indentation is stripped from the description.
+        #
+        def description
+          description = attributes_hash["description"]
+          description.strip_heredoc if description
+        end
+
+        # @return [Array<String>] The list of the URL for the screenshots of the
+        #         Pod.
+        #
+        # @note   The value is coherced to an array.
+        #
+        def screenshots
+          value = attributes_hash["screenshots"]
+          [*value]
+        end
+
+        # @return [Hash{Symbol=>Array<String>}] The options to pass to the
+        #         appledoc tool.
+        #
+        def documentation
+          convert_keys_to_symbol(attributes_hash["documentation"])
+        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.
+        #
+        def convert_keys_to_symbol(value)
+          return unless value
+          result = {}
+          value.each do |key, subvalue|
+            subvalue = convert_keys_to_symbol(subvalue) if subvalue.is_a?(Hash)
+            result[key.to_sym] = subvalue
+          end
+          result
+        end
+
+      end
+    end
+  end
+end