cocoapods 0.10.0 → 0.11.0

data/CHANGELOG.md

@@ -1,4 +1,21 @@
-## 0.10.0 (Unreleased)
+## 0.11.0
+
+[CocoaPods](https://github.com/CocoaPods/CocoaPods/compare/0.10.0...master)
+
+###### Enhancements
+
+- Added support for public headers. [#440]
+- Added `pod repo lint`. [#423]
+- Improved support for `:head` option and svn repositories.
+- When integrating Pods with a project without "Frameworks" group in root of the project, raise an informative message. [#431](https://github.com/CocoaPods/CocoaPods/pull/431)
+- Dropped support for legacy `config.ios?` and `config.osx?`
+
+###### Bug fixes
+
+- Version message now correctly terminates with a 0 exit status.
+- Resolved an issue that lead to git error messages in the error report.
+
+## 0.10.0
 
 [CocoaPods](http://git.io/4i75YA)
 

data/lib/cocoapods.rb

@@ -13,7 +13,7 @@ unless Gem::Version::Requirement.new('>= 1.4.0').satisfied_by?(Gem::Version.new(
 end
 
 module Pod
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 
   class PlainInformative < StandardError
   end

data/lib/cocoapods/command.rb

@@ -5,6 +5,7 @@ module Pod
     autoload :ErrorReport, 'cocoapods/command/error_report'
     autoload :Install,     'cocoapods/command/install'
     autoload :List,        'cocoapods/command/list'
+    autoload :Linter,      'cocoapods/command/linter'
     autoload :Presenter,   'cocoapods/command/presenter'
     autoload :Push,        'cocoapods/command/push'
     autoload :Repo,        'cocoapods/command/repo'
@@ -86,7 +87,10 @@ module Pod
 
     def self.parse(*argv)
       argv = ARGV.new(argv)
-      raise PlainInformative, VERSION if argv.option('--version')
+      if argv.option('--version')
+        puts VERSION
+        exit!(0)
+      end
 
       show_help = argv.option('--help')
       Config.instance.silent = argv.option('--silent')

data/lib/cocoapods/command/error_report.rb

@@ -10,7 +10,7 @@ module Pod
         def report(error)
           return <<-EOS
 
-#{'――― MARKDOWN TEMPLATE ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――'.reversed}
+          #{'――― MARKDOWN TEMPLATE ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――'.reversed}
 
 ### Report
 
@@ -59,14 +59,14 @@ EOS
 
         def markdown_podfile
           return '' unless Config.instance.project_podfile && Config.instance.project_podfile.exist?
-<<-EOS
+          <<-EOS
 
 ### Podfile
 
 ```ruby
-#{Config.instance.project_podfile.read.strip}
+          #{Config.instance.project_podfile.read.strip}
 ```
-EOS
+          EOS
         end
 
         def error_from_podfile(error)
@@ -89,8 +89,8 @@ EOS
           Pod::Source.all.map do |source|
             repo = source.repo
             Dir.chdir(repo) do
-              url = `git config --get remote.origin.url`.strip
-              sha = `git rev-parse HEAD`.strip
+              url = `git config --get remote.origin.url 2>&1`.strip
+              sha = `git rev-parse HEAD 2>&1`.strip
               "#{repo.basename} - #{url} @ #{sha}"
             end
           end

data/lib/cocoapods/command/linter.rb

@@ -0,0 +1,292 @@
+module Pod
+  class Command
+    class Linter
+      include Config::Mixin
+
+      # TODO: Add check to ensure that attributes inherited by subspecs are not duplicated ?
+
+      attr_accessor :quick, :no_clean, :repo_path
+      attr_reader   :spec, :file
+      attr_reader   :errors, :warnings, :notes
+
+      def initialize(podspec)
+        @file = podspec
+      end
+
+      def spec_name
+        name = file.basename('.*').to_s
+        if @spec
+          name << " (#{spec.version})"
+        elsif @repo_path
+          name << " (#{file.dirname.basename})"
+        end
+        name
+      end
+
+      # Takes an array of podspec files and lints them all
+      #
+      # It returns true if the spec passed validation
+      #
+      def lint
+        @errors, @warnings, @notes = [], [], []
+        @platform_errors, @platform_warnings, @platform_notes = {}, {}, {}
+
+        if !deprecation_errors.empty?
+          @errors = deprecation_errors
+          @errors << "#{spec_name} [!] Fatal errors found skipping the rest of the validation"
+        else
+          @spec = Specification.from_file(file)
+          platforms = spec.available_platforms
+
+          if @repo_path
+            expected_path = "#{@spec.name}/#{@spec.version}/#{@spec.name}.podspec"
+            path = file.relative_path_from(@repo_path).to_s
+            @errors << "Incorrect path, the path is `#{file}` and should be `#{expected_path}`" unless path.end_with?(expected_path)
+          end
+
+          platforms.each do |platform|
+            @platform_errors[platform], @platform_warnings[platform], @platform_notes[platform] = [], [], []
+
+            spec.activate_platform(platform)
+            @platform = platform
+            puts "\n\n#{spec} - Analyzing on #{platform} platform.".green.reversed if config.verbose? && !@quick
+
+            # Skip validation if there are errors in the podspec as it would result in a crash
+            if !podspec_errors.empty?
+              @platform_errors[platform]   += podspec_errors
+              @platform_notes[platform]    << "#{platform.name} [!] Fatal errors found skipping the rest of the validation"
+            else
+              @platform_warnings[platform] += podspec_warnings
+              peform_extensive_analysis unless quick
+            end
+          end
+
+          # Get common messages
+          @errors   += @platform_errors.values.reduce(:&)
+          @warnings += @platform_warnings.values.reduce(:&)
+          @notes    += @platform_notes.values.reduce(:&)
+
+          platforms.each do |platform|
+            # Mark platform specific messages
+            @errors   += (@platform_errors[platform] - @errors).map {|m| "[#{platform}] #{m}"}
+            @warnings += (@platform_warnings[platform] - @warnings).map {|m| "[#{platform}] #{m}"}
+            @notes    += (@platform_notes[platform] - @notes).map {|m| "[#{platform}] #{m}"}
+          end
+        end
+      end
+
+      def result_type
+        return :error   unless errors.empty?
+        return :warning unless warnings.empty?
+        return :note    unless notes.empty?
+        :success
+      end
+
+      # Performs platform specific analysis.
+      # It requires to download the source at each iteration
+      #
+      def peform_extensive_analysis
+        set_up_lint_environment
+        install_pod
+        if `which xcodebuild`.strip.empty?
+          puts "Skipping compilation with `xcodebuild' because it can't be found.\n".yellow if config.verbose?
+        else
+          puts "Building with xcodebuild.\n".yellow if config.verbose?
+          # treat xcodebuild warnings as notes because the spec maintainer might not be the author of the library
+          xcodebuild_output.each { |msg| ( msg.include?('error: ') ? @platform_errors[@platform] : @platform_notes[@platform] ) << msg }
+        end
+        @platform_errors[@platform]   += file_patterns_errors
+        @platform_warnings[@platform] += file_patterns_warnings
+        tear_down_lint_environment
+      end
+
+      def install_pod
+        podfile = podfile_from_spec
+        config.verbose
+        installer = Installer.new(podfile)
+        installer.install!
+        @pod = installer.pods.find { |pod| pod.top_specification == spec }
+        config.silent
+      end
+
+      def podfile_from_spec
+        name     = spec.name
+        podspec  = file.realpath.to_s
+        platform = @platform
+        podfile  = Pod::Podfile.new do
+          platform(platform.to_sym, platform.deployment_target)
+          pod name, :podspec => podspec
+        end
+        podfile
+      end
+
+      def set_up_lint_environment
+        tmp_dir.rmtree if tmp_dir.exist?
+        tmp_dir.mkpath
+        @original_config = Config.instance.clone
+        config.project_root      = tmp_dir
+        config.project_pods_root = tmp_dir + 'Pods'
+        config.silent            = !config.verbose
+        config.integrate_targets = false
+        config.generate_docs     = false
+      end
+
+      def tear_down_lint_environment
+        tmp_dir.rmtree unless no_clean
+        Config.instance = @original_config
+      end
+
+      def tmp_dir
+        Pathname.new('/tmp/CocoaPods/Lint')
+      end
+
+      def pod_dir
+        tmp_dir + 'Pods' + spec.name
+      end
+
+      # It reads a podspec file and checks for strings corresponding
+      # to features that are or will be deprecated
+      #
+      # @return [Array<String>]
+      #
+      def deprecation_errors
+        text = @file.read
+        deprecations = []
+        deprecations << "`config.ios?' and `config.osx?' are deprecated"              if text. =~ /config\..?os.?/
+        deprecations << "clean_paths are deprecated and ignored (use preserve_paths)" if text. =~ /clean_paths/
+        deprecations
+      end
+
+      # @return [Array<String>] List of the fatal defects detected in a podspec
+      def podspec_errors
+        messages = []
+        messages << "The name of the spec should match the name of the file" unless names_match?
+        messages << "Unrecognized platfrom" unless platform_valid?
+        messages << "Missing name"          unless spec.name
+        messages << "Missing version"       unless spec.version
+        messages << "Missing summary"       unless spec.summary
+        messages << "Missing homepage"      unless spec.homepage
+        messages << "Missing author(s)"     unless spec.authors
+        messages << "Missing or invalid source: #{spec.source}" unless source_valid?
+
+        # attributes with multiplatform values
+        return messages unless platform_valid?
+        messages << "The spec appears to be empty (no source files, resources, or preserve paths)" if spec.source_files.empty? && spec.subspecs.empty? && spec.resources.empty? && spec.preserve_paths.empty?
+        messages += paths_starting_with_a_slash_errors
+        messages += deprecation_errors
+        messages
+      end
+
+      def names_match?
+        return true unless spec.name
+        root_name = spec.name.match(/[^\/]*/)[0]
+        file.basename.to_s == root_name + '.podspec'
+      end
+
+      def platform_valid?
+        !spec.platform || [:ios, :osx].include?(spec.platform.name)
+      end
+
+      def source_valid?
+        spec.source && !(spec.source =~ /http:\/\/EXAMPLE/)
+      end
+
+      def paths_starting_with_a_slash_errors
+        messages = []
+        %w[source_files public_header_files resources clean_paths].each do |accessor|
+          patterns = spec.send(accessor.to_sym)
+          # Some values are multiplaform
+          patterns = patterns.is_a?(Hash) ? patterns.values.flatten(1) : patterns
+          patterns = patterns.compact # some patterns may be nil (public_header_files, for instance)
+          patterns.each do |pattern|
+            # Skip FileList that would otherwise be resolved from the working directory resulting
+            # in a potentially very expensi operation
+            next if pattern.is_a?(FileList)
+            invalid = pattern.is_a?(Array) ? pattern.any? { |path| path.start_with?('/') } : pattern.start_with?('/')
+            if invalid
+              messages << "Paths cannot start with a slash (#{accessor})"
+              break
+            end
+          end
+        end
+        messages
+      end
+
+      # @return [Array<String>] List of the **non** fatal defects detected in a podspec
+      def podspec_warnings
+        license  = spec.license || {}
+        source   = spec.source  || {}
+        text     = @file.read
+        messages = []
+        messages << "Missing license type"                                unless license[:type]
+        messages << "Sample license type"                                 if license[:type] && license[:type] =~ /\(example\)/
+        messages << "Invalid license type"                                if license[:type] && license[:type] =~ /\n/
+        messages << "The summary is not meaningful"                       if spec.summary =~ /A short description of/
+        messages << "The description is not meaningful"                   if spec.description && spec.description =~ /An optional longer description of/
+        messages << "The summary should end with a dot"                   if spec.summary !~ /.*\./
+        messages << "The description should end with a dot"               if spec.description !~ /.*\./ && spec.description != spec.summary
+        messages << "Git sources should specify either a tag or a commit" if source[:git] && !source[:commit] && !source[:tag]
+        messages << "Github repositories should end in `.git'"            if github_source? && source[:git] !~ /.*\.git/
+        messages << "Github repositories should use `https' link"         if github_source? && source[:git] !~ /https:\/\/github.com/
+        messages << "Comments must be deleted"                            if text.scan(/^\s*#/).length > 24
+        messages
+      end
+
+      def github_source?
+        spec.source && spec.source[:git] =~ /github.com/
+      end
+
+      # It creates a podfile in memory and builds a library containing
+      # the pod for all available platfroms with xcodebuild.
+      #
+      # @return [Array<String>]
+      #
+      def xcodebuild_output
+        return [] if `which xcodebuild`.strip.empty?
+        messages      = []
+        output        = Dir.chdir(config.project_pods_root) { `xcodebuild clean build 2>&1` }
+        clean_output  = process_xcode_build_output(output)
+        messages     += clean_output
+        puts(output) if config.verbose?
+        messages
+      end
+
+      def process_xcode_build_output(output)
+        output_by_line = output.split("\n")
+        selected_lines = output_by_line.select do |l|
+          l.include?('error: ') && (l !~ /errors? generated\./) && (l !~ /error: \(null\)/)\
+            || l.include?('warning: ') && (l !~ /warnings? generated\./)\
+            || l.include?('note: ') && (l !~ /expanded from macro/)
+        end
+        selected_lines.map do |l|
+          new = l.gsub(/\/tmp\/CocoaPods\/Lint\/Pods\//,'') # Remove the unnecessary tmp path
+          new.gsub!(/^ */,' ')                              # Remove indentation
+          "XCODEBUILD > " << new                            # Mark
+        end
+      end
+
+      # It checks that every file pattern specified in a spec yields
+      # at least one file. It requires the pods to be alredy present
+      # in the current working directory under Pods/spec.name.
+      #
+      # @return [Array<String>]
+      #
+      def file_patterns_errors
+        messages = []
+        messages << "The sources did not match any file"                     if !spec.source_files.empty? && @pod.source_files.empty?
+        messages << "The resources did not match any file"                   if !spec.resources.empty? && @pod.resource_files.empty?
+        messages << "The preserve_paths did not match any file"              if !spec.preserve_paths.empty? && @pod.preserve_files.empty?
+        messages << "The exclude_header_search_paths did not match any file" if !spec.exclude_header_search_paths.empty? && @pod.headers_excluded_from_search_paths.empty?
+        messages
+      end
+
+      def file_patterns_warnings
+        messages = []
+        unless @pod.license_file || spec.license && ( spec.license[:type] == 'Public Domain' || spec.license[:text] )
+          messages << "Unable to find a license file"
+        end
+        messages
+      end
+    end
+  end
+end

data/lib/cocoapods/command/push.rb

@@ -8,9 +8,10 @@ module Pod
 
   $ pod push REPO [NAME.podspec]
 
-    Validates NAME.podspec or `*.podspec' in the current working dir, updates
-    the local copy of the repository named REPO, adds the specifications
-    to the REPO, and finally it pushes REPO to its remote.}
+    Validates NAME.podspec or `*.podspec' in the current working dir, creates
+    a directory and version folder for the pod in the local copy of 
+    REPO (~/.cocoapods/[REPO]), copies the podspec file into the version directory,
+    and finally it pushes REPO to its remote.}
       end
 
       def self.options

data/lib/cocoapods/command/repo.rb

@@ -11,10 +11,20 @@ module Pod
       Clones `URL' in the local spec-repos directory at `~/.cocoapods'. The
       remote can later be referred to by `NAME'.
 
-    $ pod repo update NAME
+    $ pod repo update [NAME]
 
       Updates the local clone of the spec-repo `NAME'. If `NAME' is omitted
-      this will update all spec-repos in `~/.cocoapods'.}
+      this will update all spec-repos in `~/.cocoapods'.
+
+    $ pod repo update [NAME | DIRECTORY]
+
+      Lints the spec-repo `NAME'. If a directory is provided it is assumed
+      to be the root of a repo. Finally, if NAME is not provided this will
+      lint all the spec-repos known to CocoaPods.}
+      end
+
+      def self.options
+        [["--only-errors", "Lint presents only the errors"]].concat(super)
       end
 
       extend Executable
@@ -29,6 +39,9 @@ module Pod
           @branch = argv.arguments[3]
         when 'update'
           @name = argv.arguments[1]
+        when 'lint'
+          @name = argv.arguments[1]
+          @only_errors = argv.option('--only-errors')
         else
           super
         end
@@ -66,6 +79,60 @@ module Pod
         end
       end
 
+      def lint
+        if @name
+          dirs = File.exists?(@name) ? [ Pathname.new(@name) ] : [ dir ]
+        else
+          dirs = config.repos_dir.children.select {|c| c.directory?}
+        end
+        dirs.each do |dir|
+          check_versions(dir)
+          puts "\nLinting spec repo `#{dir.realpath.basename}'\n".yellow
+          podspecs = dir.glob('**/*.podspec')
+          invalid_count = 0
+
+          podspecs.each do |podspec|
+            linter = Linter.new(podspec)
+            linter.quick     = true
+            linter.repo_path = dir
+
+            linter.lint
+
+            case linter.result_type
+            when :error
+              invalid_count += 1
+              color = :red
+              should_display = true
+            when :warning
+              color = :yellow
+              should_display = !@only_errors
+            end
+
+            if should_display
+              puts " -> ".send(color) << linter.spec_name
+              print_messages('ERROR', linter.errors)
+              unless @only_errors
+                print_messages('WARN',  linter.warnings)
+                print_messages('NOTE',  linter.notes)
+              end
+              puts unless config.silent?
+            end
+          end
+          puts "Analyzed #{podspecs.count} podspecs files.\n\n" unless config.silent?
+
+          if invalid_count == 0
+            puts "All the specs passed validation.".green << "\n\n" unless config.silent?
+          else
+            raise Informative, "#{invalid_count} podspecs failed validation."
+          end
+        end
+      end
+
+      def print_messages(type, messages)
+        return if config.silent?
+        messages.each {|msg| puts "    - #{type.ljust(5)} | #{msg}"}
+      end
+
       def check_versions(dir)
         versions = versions(dir)
         unless is_compatilbe(versions)