xcocoapods 1.5.3

data/lib/cocoapods/command/repo/list.rb

@@ -0,0 +1,93 @@
+module Pod
+  class Command
+    class Repo < Command
+      class List < Repo
+        self.summary = 'List repos'
+
+        self.description = <<-DESC
+            List the repos from the local spec-repos directory at `#{Config.instance.repos_dir}`.
+        DESC
+
+        def self.options
+          [['--count-only', 'Show the total number of repos']].concat(super)
+        end
+
+        def initialize(argv)
+          @count_only = argv.flag?('count-only')
+          super
+        end
+
+        # @output  Examples:
+        #
+        #          master
+        #          - type: git (master)
+        #          - URL:  https://github.com/CocoaPods/Specs.git
+        #          - path: /Users/lascorbe/.cocoapods/repos/master
+        #
+        #          test
+        #          - type: local copy
+        #          - URL: file:///Users/lascorbe/.cocoapods/repos/test
+        #          - path: /Users/lascorbe/.cocoapods/repos/test
+        #
+        def run
+          sources = config.sources_manager.all
+          print_sources(sources) unless @count_only
+          print_count_of_sources(sources)
+        end
+
+        private
+
+        # Pretty-prints the source at the given path.
+        #
+        # @param  [Source] source
+        #         The source repository to be printed.
+        #
+        # @return [void]
+        #
+        def print_source(source)
+          if source.git?
+            Dir.chdir(source.repo) do
+              branch_name = `git name-rev --name-only HEAD 2>/dev/null`.strip
+              branch_name = 'unknown' if branch_name.empty?
+              UI.puts "- Type: git (#{branch_name})"
+            end
+          else
+            UI.puts '- Type: local'
+          end
+
+          UI.puts "- URL:  #{source.url}"
+          UI.puts "- Path: #{source.repo}"
+        end
+
+        # Pretty-prints the given sources.
+        #
+        # @param  [Array<Source>] sources
+        #         The sources that should be printed.
+        #
+        # @return [void]
+        #
+        def print_sources(sources)
+          sources.each do |source|
+            UI.title source.name do
+              print_source(source)
+            end
+          end
+          UI.puts "\n"
+        end
+
+        # Pretty-prints the number of sources.
+        #
+        # @param  [Array<Source>] sources
+        #         The sources whose count should be printed.
+        #
+        # @return [void]
+        #
+        def print_count_of_sources(sources)
+          number_of_repos = sources.length
+          repo_string = number_of_repos != 1 ? 'repos' : 'repo'
+          UI.puts "#{number_of_repos} #{repo_string}".green
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/command/repo/push.rb

@@ -0,0 +1,281 @@
+require 'tempfile'
+require 'fileutils'
+require 'active_support/core_ext/string/inflections'
+
+module Pod
+  class Command
+    class Repo < Command
+      class Push < Repo
+        self.summary = 'Push new specifications to a spec-repo'
+
+        self.description = <<-DESC
+        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` (#{Config.instance.repos_dir}/[REPO]), copies the podspec file into the
+        version directory, and finally it pushes `REPO` to its remote.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('REPO', true),
+          CLAide::Argument.new('NAME.podspec', false),
+        ]
+
+        def self.options
+          [
+            ['--allow-warnings', 'Allows pushing even if there are warnings'],
+            ['--use-libraries', 'Linter uses static libraries to install the spec'],
+            ['--sources=https://github.com/artsy/Specs,master', 'The sources from which to pull dependent pods ' \
+             '(defaults to all available repos). ' \
+             'Multiple sources must be comma-delimited.'],
+            ['--local-only', 'Does not perform the step of pushing REPO to its remote'],
+            ['--no-private', 'Lint includes checks that apply only to public repos'],
+            ['--skip-import-validation', 'Lint skips validating that the pod can be imported'],
+            ['--skip-tests', 'Lint skips building and running tests during validation'],
+            ['--commit-message="Fix bug in pod"', 'Add custom commit message. ' \
+            'Opens default editor if no commit message is specified.'],
+            ['--use-json', 'Push JSON spec to repo'],
+            ['--swift-version=VERSION', 'The SWIFT_VERSION that should be used when linting the spec. ' \
+             'This takes precedence over a .swift-version file.'],
+            ['--no-overwrite', 'Disallow pushing that would overwrite an existing spec.'],
+          ].concat(super)
+        end
+
+        def initialize(argv)
+          @allow_warnings = argv.flag?('allow-warnings')
+          @local_only = argv.flag?('local-only')
+          @repo = argv.shift_argument
+          @source = source_for_repo
+          @source_urls = argv.option('sources', config.sources_manager.all.map(&:url).join(',')).split(',')
+          @podspec = argv.shift_argument
+          @use_frameworks = !argv.flag?('use-libraries')
+          @private = argv.flag?('private', true)
+          @message = argv.option('commit-message')
+          @commit_message = argv.flag?('commit-message', false)
+          @use_json = argv.flag?('use-json')
+          @swift_version = argv.option('swift-version', nil)
+          @skip_import_validation = argv.flag?('skip-import-validation', false)
+          @skip_tests = argv.flag?('skip-tests', false)
+          @allow_overwrite = argv.flag?('overwrite', true)
+          super
+        end
+
+        def validate!
+          super
+          help! 'A spec-repo name or url is required.' unless @repo
+          unless @source && @source.repo.directory?
+            raise Informative,
+                  "Unable to find the `#{@repo}` repo. " \
+                  'If it has not yet been cloned, add it via `pod repo add`.'
+          end
+        end
+
+        def run
+          open_editor if @commit_message && @message.nil?
+          check_if_master_repo
+          validate_podspec_files
+          check_repo_status
+          update_repo
+          add_specs_to_repo
+          push_repo unless @local_only
+        end
+
+        #---------------------------------------------------------------------#
+
+        private
+
+        # @!group Push sub-steps
+
+        extend Executable
+        executable :git
+
+        # Open default editor to allow users to enter commit message
+        #
+        def open_editor
+          return if ENV['EDITOR'].nil?
+
+          file = Tempfile.new('cocoapods')
+          File.chmod(0777, file.path)
+          file.close
+
+          system("#{ENV['EDITOR']} #{file.path}")
+          @message = File.read file.path
+        end
+
+        # Temporary check to ensure that users do not push accidentally private
+        # specs to the master repo.
+        #
+        def check_if_master_repo
+          remotes = `git -C "#{repo_dir}" remote -v 2>&1`
+          master_repo_urls = [
+            'git@github.com:CocoaPods/Specs.git',
+            'https://github.com/CocoaPods/Specs.git',
+          ]
+          is_master_repo = master_repo_urls.any? do |url|
+            remotes.include?(url)
+          end
+
+          if is_master_repo
+            raise Informative, 'To push to the CocoaPods master repo use ' \
+              "the `pod trunk push` command.\n\nIf you are using a fork of " \
+              'the master repo for private purposes we recommend to migrate ' \
+              'to a clean private repo. To disable this check remove the ' \
+              'remote pointing to the CocoaPods master repo.'
+          end
+        end
+
+        # Performs a full lint against the podspecs.
+        #
+        def validate_podspec_files
+          UI.puts "\nValidating #{'spec'.pluralize(count)}".yellow
+          podspec_files.each do |podspec|
+            validator = Validator.new(podspec, @source_urls)
+            validator.allow_warnings = @allow_warnings
+            validator.use_frameworks = @use_frameworks
+            validator.ignore_public_only_results = @private
+            validator.swift_version = @swift_version
+            validator.skip_import_validation = @skip_import_validation
+            validator.skip_tests = @skip_tests
+            begin
+              validator.validate
+            rescue => e
+              raise Informative, "The `#{podspec}` specification does not validate." \
+                                 "\n\n#{e.message}"
+            end
+            raise Informative, "The `#{podspec}` specification does not validate." unless validator.validated?
+          end
+        end
+
+        # Checks that the repo is clean.
+        #
+        # @raise  If the repo is not clean.
+        #
+        # @todo   Add specs for staged and unstaged files.
+        #
+        # @todo   Gracefully handle the case where source is not under git
+        #         source control.
+        #
+        # @return [void]
+        #
+        def check_repo_status
+          clean = `git -C "#{repo_dir}" status --porcelain  2>&1` == ''
+          raise Informative, "The repo `#{@repo}` at #{UI.path repo_dir} is not clean" unless clean
+        end
+
+        # Updates the git repo against the remote.
+        #
+        # @return [void]
+        #
+        def update_repo
+          UI.puts "Updating the `#{@repo}' repo\n".yellow
+          UI.puts `git -C "#{repo_dir}" pull 2>&1`
+        end
+
+        # Commits the podspecs to the source, which should be a git repo.
+        #
+        # @note   The pre commit hook of the repo is skipped as the podspecs have
+        #         already been linted.
+        #
+        # @return [void]
+        #
+        def add_specs_to_repo
+          UI.puts "\nAdding the #{'spec'.pluralize(count)} to the `#{@repo}' repo\n".yellow
+          podspec_files.each do |spec_file|
+            spec = Pod::Specification.from_file(spec_file)
+            output_path = @source.pod_path(spec.name) + spec.version.to_s
+            if @message && !@message.empty?
+              message = @message
+            elsif output_path.exist?
+              unless @allow_overwrite
+                raise Informative, "#{spec} already exists and overwriting has been disabled."
+              end
+              message = "[Fix] #{spec}"
+            elsif output_path.dirname.directory?
+              message = "[Update] #{spec}"
+            else
+              message = "[Add] #{spec}"
+            end
+            FileUtils.mkdir_p(output_path)
+
+            if @use_json
+              json_file_name = "#{spec.name}.podspec.json"
+              json_file = File.join(output_path, json_file_name)
+              File.open(json_file, 'w') { |file| file.write(spec.to_pretty_json) }
+            else
+              FileUtils.cp(spec_file, output_path)
+            end
+
+            # only commit if modified
+            if repo_git('status', '--porcelain').include?(spec.name)
+              UI.puts " - #{message}"
+              repo_git('add', spec.name)
+              repo_git('commit', '--no-verify', '-m', message)
+            else
+              UI.puts " - [No change] #{spec}"
+            end
+          end
+        end
+
+        # Pushes the git repo against the remote.
+        #
+        # @return [void]
+        #
+        def push_repo
+          UI.puts "\nPushing the `#{@repo}' repo\n".yellow
+          repo_git('-C', repo_dir, 'push', 'origin', 'HEAD:refs/for/master')
+        end
+
+        #---------------------------------------------------------------------#
+
+        private
+
+        # @!group Private helpers
+
+        # @return result of calling the git! with args in repo_dir
+        #
+        def repo_git(*args)
+          git!(['-C', repo_dir] + args)
+        end
+
+        # @return [Pathname] The directory of the repository.
+        #
+        def repo_dir
+          @source.specs_dir
+        end
+
+        # @return [Array<Pathname>] The path of the specifications to push.
+        #
+        def podspec_files
+          if @podspec
+            path = Pathname(@podspec)
+            raise Informative, "Couldn't find #{@podspec}" unless path.exist?
+            [path]
+          else
+            files = Pathname.glob('*.podspec{,.json}')
+            raise Informative, "Couldn't find any podspec files in current directory" if files.empty?
+            files
+          end
+        end
+
+        # @return [Integer] The number of the podspec files to push.
+        #
+        def count
+          podspec_files.count
+        end
+
+        # Returns source for @repo
+        #
+        # @note If URL is invalid or repo doesn't exist, validate! will throw the error
+        #
+        # @return [Source]
+        #
+        def source_for_repo
+          config.sources_manager.source_with_name_or_url(@repo) unless @repo.nil?
+        rescue
+          nil
+        end
+
+        #---------------------------------------------------------------------#
+      end
+    end
+  end
+end

data/lib/cocoapods/command/repo/remove.rb

@@ -0,0 +1,36 @@
+module Pod
+  class Command
+    class Repo < Command
+      class Remove < Repo
+        self.summary = 'Remove a spec repo'
+
+        self.description = <<-DESC
+          Deletes the remote named `NAME` from the local spec-repos directory at `#{Config.instance.repos_dir}`.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('NAME', true),
+        ]
+
+        def initialize(argv)
+          @name = argv.shift_argument
+          super
+        end
+
+        def validate!
+          super
+          help! 'Deleting a repo needs a `NAME`.' unless @name
+          help! "repo #{@name} does not exist" unless File.directory?(dir)
+          help! "You do not have permission to delete the #{@name} repository." \
+                'Perhaps try prefixing this command with sudo.' unless File.writable?(dir)
+        end
+
+        def run
+          UI.section("Removing spec repo `#{@name}`") do
+            FileUtils.rm_rf(dir)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/command/repo/update.rb

@@ -0,0 +1,28 @@
+module Pod
+  class Command
+    class Repo < Command
+      class Update < Repo
+        self.summary = 'Update a spec repo'
+
+        self.description = <<-DESC
+          Updates the local clone of the spec-repo `NAME`. If `NAME` is omitted
+          this will update all spec-repos in `#{Config.instance.repos_dir}`.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('NAME', false),
+        ]
+
+        def initialize(argv)
+          @name = argv.shift_argument
+          super
+        end
+
+        def run
+          show_output = !config.silent?
+          config.sources_manager.update(@name, show_output)
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/command/setup.rb

@@ -0,0 +1,103 @@
+require 'fileutils'
+
+module Pod
+  class Command
+    class Setup < Command
+      self.summary = 'Setup the CocoaPods environment'
+
+      self.description = <<-DESC
+        Creates a directory at `#{Config.instance.repos_dir}` 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
+
+        If the clone already exists, it will ensure that it is up-to-date.
+      DESC
+
+      extend Executable
+      executable :git
+
+      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
+        end
+
+        UI.puts 'Setup completed'.green
+      end
+
+      #--------------------------------------#
+
+      # @!group Setup steps
+
+      # 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
+
+      # Adds the master repo from the remote.
+      #
+      # @return [void]
+      #
+      def add_master_repo
+        cmd = ['master', url, 'master', '--progress']
+        Repo::Add.parse(cmd).run
+      end
+
+      # Updates the master repo against the remote.
+      #
+      # @return [void]
+      #
+      def update_master_repo
+        show_output = !config.silent?
+        config.sources_manager.update('master', show_output)
+      end
+
+      # 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 %w(checkout master)
+        end
+      end
+
+      #--------------------------------------#
+
+      # @!group Private helpers
+
+      # @return [String] the url to use according to whether push mode should
+      #         be enabled.
+      #
+      def url
+        self.class.read_only_url
+      end
+
+      # @return [String] the read only url of the master repo.
+      #
+      def self.read_only_url
+        'https://github.com/CocoaPods/Specs.git'
+      end
+
+      # @return [Pathname] the directory of the master repo.
+      #
+      def master_repo_dir
+        config.sources_manager.master_repo_dir
+      end
+    end
+  end
+end