cocoapods 0.16.4 → 0.17.0.rc1

data/lib/cocoapods/command/search.rb

@@ -1,15 +1,15 @@
 module Pod
   class Command
     class Search < Command
-      def self.banner
-%{Search pods:
+      self.summary = 'Search pods'
 
-    $ pod search [QUERY]
+      self.description = <<-DESC
+        Searches for pods, ignoring case, whose name matches `QUERY'. If the
+        `--full' option is specified, this will also search in the summary and
+        description of the pods.
+      DESC
 
-      Searches for pods, ignoring case, whose name matches `QUERY'. If the
-      `--full' option is specified, this will also search in the summary and
-      description of the pods.}
-      end
+      self.arguments = '[QUERY]'
 
       def self.options
         [[
@@ -19,15 +19,26 @@ module Pod
       end
 
       def initialize(argv)
-        @full_text_search = argv.option('--full')
-        @stats = argv.option('--stats')
+        @full_text_search = argv.flag?('full')
+        @stats = argv.flag?('stats')
         @query = argv.shift_argument
-        super unless argv.empty? && @query
+        super
+      end
+
+      def validate!
+        super
+        help! "A search query is required." unless @query
       end
 
       def run
-        sets = Source.search_by_name(@query.strip, @full_text_search)
-        sets.each { |set| UI.pod(set, (@stats ? :stats : :normal)) }
+        sets = SourcesManager.search_by_name(@query.strip, @full_text_search)
+        sets.each do |set|
+          begin
+            UI.pod(set, (@stats ? :stats : :normal))
+          rescue DSLError => e
+            UI.warn "Skipping `#{set.name}` because the podspec contains errors."
+          end
+        end
       end
     end
   end

data/lib/cocoapods/command/setup.rb

@@ -1,18 +1,16 @@
 module Pod
   class Command
     class Setup < Command
-      def self.banner
-%{Setup CocoaPods environment:
+      self.summary = 'Setup the CocoaPods environment'
 
-    $ pod setup
+      self.description = <<-DESC
+        Creates a directory at `~/.cocoapods` which will hold your spec-repos.
+        This is where it will create a clone of the public `master` spec-repo from:
 
-      Creates a directory at `~/.cocoapods' which will hold your spec-repos.
-      This is where it will create a clone of the public `master' spec-repo from:
+            https://github.com/CocoaPods/Specs
 
-          https://github.com/CocoaPods/Specs
-
-      If the clone already exists, it will ensure that it is up-to-date.}
-      end
+        If the clone already exists, it will ensure that it is up-to-date.
+      DESC
 
       def self.options
         [["--push", "Use this option to enable push access once granted"]].concat(super)
@@ -22,89 +20,130 @@ module Pod
       executable :git
 
       def initialize(argv)
-        @push_option  = argv.option('--push')
-        super unless argv.empty?
+        @push_option  = argv.flag?('push')
+        super
       end
 
-      def dir
-        config.repos_dir + 'master'
-      end
+      def run
+        UI.section "Setting up CocoaPods master repo" do
+          if master_repo_dir.exist?
+            set_master_repo_url
+            set_master_repo_branch
+            update_master_repo
+          else
+            add_master_repo
+          end
+          enable_pre_commit_hooks
+        end
 
-      def read_only_url
-        'https://github.com/CocoaPods/Specs.git'
+        access_type = push? ? "push" : "read-only"
+        UI.puts "Setup completed (#{access_type} access)".green
       end
 
-      def read_write_url
-        'git@github.com:CocoaPods/Specs.git'
-      end
+      #--------------------------------------#
 
-      def url
-        if push?
-          read_write_url
-        else
-          read_only_url
-        end
-      end
+      # @!group Setup steps
 
-      def origin_url_read_only?
-        read_master_repo_url.chomp == read_only_url
+      # Sets the url of the master repo according to whether it is push.
+      #
+      # @return [void]
+      #
+      def set_master_repo_url
+        Dir.chdir(master_repo_dir) do
+          git("remote set-url origin '#{url}'")
+        end
       end
 
-      def origin_url_push?
-        read_master_repo_url.chomp == read_write_url
+      # Adds the master repo from the remote.
+      #
+      # @return [void]
+      #
+      def add_master_repo
+        @command ||= Repo::Add.parse(['master', url, 'master']).run
       end
 
-      def push?
-        @push_option || (dir.exist? && origin_url_push?)
+      # Updates the master repo against the remote.
+      #
+      # @return [void]
+      #
+      def update_master_repo
+        SourcesManager.update('master', true)
       end
 
-      def read_master_repo_url
-        Dir.chdir(dir) do
-          origin_url = git('config --get remote.origin.url')
+      # Sets the repo to the master branch.
+      #
+      # @note   This is not needed anymore as it was used for CocoaPods 0.6
+      #         release candidates.
+      #
+      # @return [void]
+      #
+      def set_master_repo_branch
+        Dir.chdir(master_repo_dir) do
+          git("checkout master")
         end
       end
 
-      def set_master_repo_url
-        Dir.chdir(dir) do
-          git("remote set-url origin '#{url}'")
+      # Enables the pre-commit hook of the master repo.
+      #
+      # @note   The hook is enabled in this way because the specs run with the
+      #         master repo as a submodule.
+      #
+      # @return [void]
+      #
+      def enable_pre_commit_hooks
+        if (master_repo_dir + '.git/hooks').exist?
+          hook = master_repo_dir + '.git/hooks/pre-commit'
+          hook.open('w') { |f| f << "#!/bin/sh\nrake lint" }
+          `chmod +x '#{hook}'`
         end
       end
 
-      def add_master_repo
-        @command ||= Repo.new(ARGV.new(['add', 'master', url, 'master'])).run
+      #--------------------------------------#
+
+      # @!group Private helpers
+
+      # @return [String] the url to use according to whether push mode should
+      #         be enabled.
+      #
+      def url
+        url = (push?) ? read_write_url : read_only_url
       end
 
-      def update_master_repo
-        Repo.new(ARGV.new(['update', 'master'])).run
+      # @return [String] the read only url of the master repo.
+      #
+      def read_only_url
+        'https://github.com/CocoaPods/Specs.git'
       end
 
-      def set_master_repo_branch
-        Dir.chdir(dir) do
-          git("checkout master")
-        end
+      # @return [String] the read-write url of the master repo.
+      #
+      def read_write_url
+        'git@github.com:CocoaPods/Specs.git'
       end
 
-      def run_if_needed
-        run unless dir.exist? && Repo.compatible?('master')
+      # Checks if the user asked to setup the master repo in push mode or if
+      # the repo was already in push mode.
+      #
+      # @return [String] whether the master repo should be set up in push mode.
+      #
+      def push?
+        @push ||= (@push_option || master_repo_is_push?)
       end
 
-      def run
-        UI.section "Setting up CocoaPods master repo" do
-          if dir.exist?
-            set_master_repo_url
-            set_master_repo_branch
-            update_master_repo
-          else
-            add_master_repo
-          end
-          # Mainly so the specs run with submodule repos
-          if (dir + '.git/hooks').exist?
-            hook = dir + '.git/hooks/pre-commit'
-            hook.open('w') { |f| f << "#!/bin/sh\nrake lint" }
-            `chmod +x '#{hook}'`
-          end
+      # @return [Bool] if the master repo is already configured in push mode.
+      #
+      def master_repo_is_push?
+        return false unless master_repo_dir.exist?
+        Dir.chdir(master_repo_dir) do
+          url = git('config --get remote.origin.url')
+          url.chomp == read_write_url
         end
-        UI.puts "Setup completed (#{push? ? "push" : "read-only"} access)".green
+      end
+
+      # @return [Pathname] the directory of the master repo.
+      #
+      def master_repo_dir
+        SourcesManager.master_repo_dir
       end
     end
   end

data/lib/cocoapods/command/spec.rb

@@ -5,123 +5,356 @@ require 'active_support/core_ext/string/inflections'
 module Pod
   class Command
     class Spec < Command
-      def self.banner
-%{Managing PodSpec files:
+      self.abstract_command = true
+      self.summary = 'Manage pod specs'
 
-    $ pod spec create [ NAME | https://github.com/USER/REPO ]
+      #-----------------------------------------------------------------------#
 
-      Creates a PodSpec, in the current working dir, called `NAME.podspec'.
-      If a GitHub url is passed the spec is prepopulated.
+      class Create < Spec
+        self.summary = 'Create spec file stub.'
 
-    $ pod spec lint [ NAME.podspec | DIRECTORY | http://PATH/NAME.podspec, ... ]
+        self.description = <<-DESC
+          Creates a PodSpec, in the current working dir, called `NAME.podspec'.
+          If a GitHub url is passed the spec is prepopulated.
+        DESC
 
-      Validates `NAME.podspec'. If a directory is provided it validates
-      the podspec files found, including subfolders. In case
-      the argument is omitted, it defaults to the current working dir.}
-      end
+        self.arguments = '[ NAME | https://github.com/USER/REPO ]'
+
+        def initialize(argv)
+          @name_or_url, @url = argv.shift_argument, argv.shift_argument
+          super
+        end
+
+        def validate!
+          super
+          help! "A pod name or repo URL is required." unless @name_or_url
+        end
 
-      def self.options
-        [ ["--quick",       "Lint skips checks that would require to download and build the spec"],
-          ["--local",       "Lint a podspec against the local files contained in its directory"],
-          ["--only-errors", "Lint validates even if warnings are present"],
-          ["--no-clean",    "Lint leaves the build directory intact for inspection"] ].concat(super)
+        def run
+          if repo_id_match = (@url || @name_or_url).match(/github.com\/([^\/\.]*\/[^\/\.]*)\.*/)
+            # This is to make sure Faraday doesn't warn the user about the `system_timer` gem missing.
+            old_warn, $-w = $-w, nil
+            begin
+              require 'faraday'
+            ensure
+              $-w = old_warn
+            end
+            require 'octokit'
+
+            repo_id = repo_id_match[1]
+            data = github_data_for_template(repo_id)
+            data[:name] = @name_or_url if @url
+            UI.puts semantic_versioning_notice(repo_id, data[:name]) if data[:version] == '0.0.1'
+          else
+            data = default_data_for_template(@name_or_url)
+          end
+          spec = spec_template(data)
+          (Pathname.pwd + "#{data[:name]}.podspec").open('w') { |f| f << spec }
+          UI.puts "\nSpecification created at #{data[:name]}.podspec".green
+        end
       end
 
-      def initialize(argv)
-        @action = argv.shift_argument
-        if @action == 'create'
-          @name_or_url     = argv.shift_argument
-          @url             = argv.shift_argument
-          super if @name_or_url.nil?
-          super unless argv.empty?
-        elsif @action == 'lint'
-          @quick       =  argv.option('--quick')
-          @local       =  argv.option('--local')
-          @only_errors =  argv.option('--only-errors')
-          @no_clean    =  argv.option('--no-clean')
-          @podspecs_paths = argv
-        else
+      #-----------------------------------------------------------------------#
+
+      class Lint < Spec
+        self.summary = 'Validates a spec file.'
+
+        self.description = <<-DESC
+          Validates `NAME.podspec'. If a directory is provided it validates
+          the podspec files found, including subfolders. In case
+          the argument is omitted, it defaults to the current working dir.
+        DESC
+
+        self.arguments = '[ NAME.podspec | DIRECTORY | http://PATH/NAME.podspec, ... ]'
+
+        def self.options
+          [ ["--quick",       "Lint skips checks that would require to download and build the spec"],
+            ["--local",       "Lint a podspec against the local files contained in its directory"],
+            ["--only-errors", "Lint validates even if warnings are present"],
+            ["--no-clean",    "Lint leaves the build directory intact for inspection"] ].concat(super)
+        end
+
+        def initialize(argv)
+          @quick       =  argv.flag?('quick')
+          @local       =  argv.flag?('local')
+          @only_errors =  argv.flag?('only-errors')
+          @clean       =  argv.flag?('clean', true)
+          @podspecs_paths = argv.arguments!
           super
         end
+
+        def run
+          UI.puts
+          invalid_count = 0
+          podspecs_to_lint.each do |podspec|
+            validator             = Validator.new(podspec)
+            validator.quick       = @quick
+            validator.local       = @local
+            validator.no_clean    = !@clean
+            validator.only_errors = @only_errors
+            validator.validate
+            invalid_count += 1 unless validator.validated?
+
+            unless @clean
+              UI.puts "Pods project available at `#{validator.validation_dir}/Pods/Pods.xcodeproj` for inspection."
+              UI.puts
+            end
+          end
+
+          count = podspecs_to_lint.count
+          UI.puts "Analyzed #{count} #{'podspec'.pluralize(count)}.\n\n"
+          if invalid_count == 0
+            lint_passed_message = count == 1 ? "#{podspecs_to_lint.first.basename} passed validation." : "All the specs passed validation."
+            UI.puts lint_passed_message.green << "\n\n"
+          else
+            raise Informative, count == 1 ? "The spec did not pass validation." : "#{invalid_count} out of #{count} specs failed validation."
+          end
+          podspecs_tmp_dir.rmtree if podspecs_tmp_dir.exist?
+        end
       end
 
-      def run
-        send @action
+      #-----------------------------------------------------------------------#
+
+      class Which < Spec
+        self.summary = 'Prints the path of the given spec.'
+
+        self.description = <<-DESC
+          Prints the path of 'NAME.podspec'
+        DESC
+
+        self.arguments = '[ NAME ]'
+
+        def self.options
+          [["--show-all", "Print all versions of the given podspec"]].concat(super)
+        end
+
+        def initialize(argv)
+          @show_all = argv.flag?('show-all')
+          @spec = argv.shift_argument
+          @spec = @spec.gsub('.podspec', '') unless @spec.nil?
+          super
+        end
+
+        def validate!
+          super
+          help! "A podspec name is required." unless @spec
+        end
+
+        def run
+          UI.puts get_path_of_spec(@spec, @show_all)
+        end
       end
 
-      def create
-        if repo_id_match = (@url || @name_or_url).match(/github.com\/([^\/\.]*\/[^\/\.]*)\.*/)
-          # This is to make sure Faraday doesn't warn the user about the `system_timer` gem missing.
-          old_warn, $-w = $-w, nil
-          begin
-            require 'faraday'
-          ensure
-            $-w = old_warn
+      #-----------------------------------------------------------------------#
+
+      class Cat < Spec
+        self.summary = 'Prints a spec file.'
+
+        self.description = <<-DESC
+          Prints 'NAME.podspec' to standard output.
+        DESC
+
+        self.arguments = '[ NAME ]'
+
+        def self.options
+          [["--show-all", "Pick from all versions of the given podspec"]].concat(super)
+        end
+
+        def initialize(argv)
+          @show_all = argv.flag?('show-all')
+          @spec = argv.shift_argument
+          @spec = @spec.gsub('.podspec', '') unless @spec.nil?
+          super
+        end
+
+        def validate!
+          super
+          help! "A podspec name is required." unless @spec
+        end
+
+        def run
+          filepath = if @show_all
+            specs = get_path_of_spec(@spec, @show_all).split(/\n/)
+            index = choose_from_array(specs, "Which spec would you like to print [1-#{ specs.count }]? ")
+            specs[index]
+          else
+            get_path_of_spec(@spec)
           end
-          require 'octokit'
 
-          repo_id = repo_id_match[1]
-          data = github_data_for_template(repo_id)
-          data[:name] = @name_or_url if @url
-          UI.puts semantic_versioning_notice(repo_id, data[:name]) if data[:version] == '0.0.1'
-        else
-          data = default_data_for_template(@name_or_url)
+          UI.puts File.open(filepath).read
         end
-        spec = spec_template(data)
-        (Pathname.pwd + "#{data[:name]}.podspec").open('w') { |f| f << spec }
-        UI.puts "\nSpecification created at #{data[:name]}.podspec".green
       end
 
-      def lint
-        UI.puts
-        invalid_count = 0
-        podspecs_to_lint.each do |podspec|
-          linter       = Linter.new(podspec)
-          linter.quick = @quick
-          linter.local = @local
-          linter.no_clean = @no_clean
-
-          # Show immediatly which pod is being processed.
-          print " -> #{linter.spec_name}\r" unless config.silent?
-          $stdout.flush
-          linter.lint
-
-          case linter.result_type
-          when :error
-            invalid_count += 1
-            color = :red
-          when :warning
-            invalid_count  += 1 unless @only_errors
-            color = :yellow
+      #-----------------------------------------------------------------------#
+
+      class Edit < Spec
+        self.summary = 'Edit a spec file.'
+
+        self.description = <<-DESC
+          Opens 'NAME.podspec' to be edited.
+        DESC
+
+        self.arguments = '[ NAME ]'
+
+        def self.options
+          [["--show-all", "Pick which spec to edit from all avaliable versions of the given podspec"]].concat(super)
+        end
+
+        def initialize(argv)
+          @show_all = argv.flag?('show-all')
+          @spec = argv.shift_argument
+          @spec = @spec.gsub('.podspec', '') unless @spec.nil?
+          super
+        end
+
+        def validate!
+          super
+          help! "A podspec name is required." unless @spec
+        end
+
+        def run
+          filepath = if @show_all
+            specs = get_path_of_spec(@spec, @show_all).split(/\n/)
+            index = choose_from_array(specs, "Which spec would you like to edit [1-#{ specs.count }]? ")
+            specs[index]
           else
-            color = :green
+            get_path_of_spec(@spec)
           end
 
-          # This overwrites the previously printed text
-          UI.puts " -> ".send(color) << linter.spec_name unless config.silent?
-          print_messages('ERROR', linter.errors)
-          print_messages('WARN',  linter.warnings)
-          print_messages('NOTE',  linter.notes)
+          exec_editor(filepath.to_s) if File.exists? filepath
+          raise Informative, "#{ filepath } doesn't exist."
+        end
 
-          UI.puts unless config.silent?
+        # Thank you homebrew
+        def which(cmd)
+          dir = ENV['PATH'].split(':').find { |p| File.executable? File.join(p, cmd) }
+          Pathname.new(File.join(dir, cmd)) unless dir.nil?
         end
 
-        count = podspecs_to_lint.count
-        UI.puts "Analyzed #{count} #{'podspec'.pluralize(count)}.\n\n" unless config.silent?
-        if invalid_count == 0
-          lint_passed_message = count == 1 ? "#{podspecs_to_lint.first.basename} passed validation." : "All the specs passed validation."
-          UI.puts lint_passed_message.green << "\n\n" unless config.silent?
-        else
-          raise Informative, count == 1 ? "The spec did not pass validation." : "#{invalid_count} out of #{count} specs failed validation."
+        def which_editor
+          editor = ENV['EDITOR']
+          # If an editor wasn't set, try to pick a sane default
+          return editor unless editor.nil?
+
+          # Find Sublime Text 2
+          return 'subl' if which 'subl'
+          # Find Textmate
+          return 'mate' if which 'mate'
+          # Find # BBEdit / TextWrangler
+          return 'edit' if which 'edit'
+          # Default to vim
+          return 'vim' if which 'vim'
+
+          raise Informative, "Failed to open editor. Set your 'EDITOR' environment variable."
+        end
+
+        def exec_editor *args
+          return if args.to_s.empty?
+          safe_exec(which_editor, *args)
+        end
+
+        def safe_exec(cmd, *args)
+          # This buys us proper argument quoting and evaluation
+          # of environment variables in the cmd parameter.
+          exec "/bin/sh", "-i", "-c", cmd + ' "$@"', "--", *args
         end
-        podspecs_tmp_dir.rmtree if podspecs_tmp_dir.exist?
       end
 
+      #-----------------------------------------------------------------------#
+
+      # @todo some of the following methods can probably move to one of the
+      #       subclasses.
+
       private
 
-      def print_messages(type, messages)
-        return if config.silent?
-        messages.each {|msg| UI.puts "    - #{type.ljust(5)} | #{msg}"}
+      # @return [Fixnum] the index of the chosen array item
+      #
+      def choose_from_array(array, message)
+        array.each_with_index do |item, index|
+          UI.puts "#{ index + 1 }: #{ item }"
+        end
+
+        print message
+
+        index = STDIN.gets.chomp.to_i - 1
+        if index < 0 || index > array.count
+          raise Informative, "#{ index + 1 } is invalid [1-#{ array.count }]"
+        else
+          index
+        end
+      end
+
+      # @param  [String] spec
+      #         The name of the specification.
+      #
+      # @param  [Bool] show_all
+      #         Whether the paths for all the versions should be returned or
+      #         only the one for the last version.
+      #
+      # @return [Pathname] the absolute path or paths of the given podspec
+      #
+      def get_path_of_spec(spec, show_all = false)
+        sets = SourcesManager.search_by_name(spec)
+
+        if sets.count == 1
+          set = sets.first
+        elsif sets.map(&:name).include?(spec)
+          set = sets.find { |s| s.name == spec }
+        else
+          names = sets.collect(&:name) * ', '
+          raise Informative, "More than one spec found for '#{ spec }':\n#{ names }"
+        end
+
+        unless show_all
+          best_spec, spec_source = spec_and_source_from_set(set)
+          return pathname_from_spec(best_spec, spec_source)
+        end
+
+        return all_paths_from_set(set)
+      end
+
+      # @return [Pathname] the absolute path of the given spec and source
+      #
+      def pathname_from_spec(spec, source)
+        Pathname.new("~/.cocoapods/#{ source }/#{ spec.name }/#{ spec.version }/#{ spec.name }.podspec").expand_path
+      end
+
+      # @return [String] of spec paths one on each line
+      #
+      def all_paths_from_set(set)
+        paths = ""
+
+        sources = set.sources
+
+        sources.each do |source|
+          versions = source.versions(set.name)
+
+          versions.each do |version|
+            spec = source.specification(set.name, version)
+            paths += "#{ pathname_from_spec(spec, source) }\n"
+          end
+        end
+
+        paths
+      end
+
+      # @return [Specification, Source] the highest known specification with it's source of the given
+      #         set.
+      #
+      def spec_and_source_from_set(set)
+        sources = set.sources
+
+        best_source = sources.first
+        best_version = best_source.versions(set.name).first
+        sources.each do |source|
+          version = source.versions(set.name).first
+          if version > best_version
+              best_source = source
+              best_version = version
+          end
+        end
+
+        return best_source.specification(set.name, best_version), best_source
       end
 
       def podspecs_to_lint
@@ -154,7 +387,13 @@ module Pod
          Pathname.new('/tmp/CocoaPods/Lint_podspec')
       end
 
-      # Templates and github information retrival for spec create
+      #--------------------------------------#
+
+      # Templates and github information retrieval for spec create
+      #
+      # @todo It would be nice to have a template class that accepts options
+      #       and uses the default ones if not provided.
+      # @todo The template is outdated.
 
       def default_data_for_template(name)
         data = {}
@@ -230,7 +469,7 @@ Pod::Spec.new do |s|
   s.homepage     = "#{data[:homepage]}"
 
   # Specify the license type. CocoaPods detects automatically the license file if it is named
-  # `LICEN{C,S}E*.*', however if the name is different, specify it.
+  # 'LICENCE*.*' or 'LICENSE*.*', however if the name is different, specify it.
   s.license      = 'MIT (example)'
   # s.license      = { :type => 'MIT (example)', :file => 'FILE_LICENSE' }
   #