xcocoapods 1.5.3

data/lib/cocoapods/command/spec/env_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Env do
+    describe 'In general' do
+      before do
+        @report = Command::Env
+      end
+
+      it 'returns a well-structured environment report' do
+        expected = <<-EOS
+
+### Stack
+
+```
+   CocoaPods : #{Pod::VERSION}
+        Ruby : #{RUBY_DESCRIPTION}
+    RubyGems : #{Gem::VERSION}
+        Host : :host_information
+       Xcode : :xcode_information
+         Git : :git_information
+Ruby lib dir : #{RbConfig::CONFIG['libdir']}
+Repositories : repo_1
+               repo_2
+```
+
+### Installation Source
+
+```
+Executable Path: /usr/bin/command
+```
+
+### Plugins
+
+```
+cocoapods         : #{Pod::VERSION}
+cocoapods-core    : #{Pod::VERSION}
+cocoapods-plugins : 1.2.3
+```
+
+### Podfile
+
+```ruby
+
+```
+EOS
+
+        @report.stubs(:actual_path).returns('/usr/bin/command')
+        report.should == expected
+      end
+    end
+  end
+end

data/lib/cocoapods/command/spec/lint.rb

@@ -0,0 +1,137 @@
+module Pod
+  class Command
+    class Spec < Command
+      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 = [
+          CLAide::Argument.new(%w(NAME.podspec DIRECTORY http://PATH/NAME.podspec), false, true),
+        ]
+
+        def self.options
+          [
+            ['--quick', 'Lint skips checks that would require to download and build the spec'],
+            ['--allow-warnings', 'Lint validates even if warnings are present'],
+            ['--subspec=NAME', 'Lint validates only the given subspec'],
+            ['--no-subspecs', 'Lint skips validation of subspecs'],
+            ['--no-clean', 'Lint leaves the build directory intact for inspection'],
+            ['--fail-fast', 'Lint stops on the first failing platform or subspec'],
+            ['--use-libraries', 'Lint uses static libraries to install the spec'],
+            ['--sources=https://github.com/artsy/Specs,master', 'The sources from which to pull dependent pods ' \
+             '(defaults to https://github.com/CocoaPods/Specs.git). ' \
+             'Multiple sources must be comma-delimited.'],
+            ['--platforms=ios,macos', 'Lint against specific platforms' \
+              '(defaults to all platforms supported by the podspec).' \
+              'Multiple platforms must be comma-delimited'],
+            ['--private', 'Lint skips checks that apply only to public specs'],
+            ['--swift-version=VERSION', 'The SWIFT_VERSION that should be used to lint the spec. ' \
+             'This takes precedence over a .swift-version file.'],
+            ['--skip-import-validation', 'Lint skips validating that the pod can be imported'],
+            ['--skip-tests', 'Lint skips building and running tests during validation'],
+          ].concat(super)
+        end
+
+        def initialize(argv)
+          @quick           = argv.flag?('quick')
+          @allow_warnings  = argv.flag?('allow-warnings')
+          @clean           = argv.flag?('clean', true)
+          @fail_fast       = argv.flag?('fail-fast', false)
+          @subspecs        = argv.flag?('subspecs', true)
+          @only_subspec    = argv.option('subspec')
+          @use_frameworks  = !argv.flag?('use-libraries')
+          @source_urls     = argv.option('sources', 'https://github.com/CocoaPods/Specs.git').split(',')
+          @platforms       = argv.option('platforms', '').split(',')
+          @private         = argv.flag?('private', false)
+          @swift_version   = argv.option('swift-version', nil)
+          @skip_import_validation = argv.flag?('skip-import-validation', false)
+          @skip_tests = argv.flag?('skip-tests', false)
+          @podspecs_paths = argv.arguments!
+          super
+        end
+
+        def run
+          UI.puts
+          failure_reasons = []
+          podspecs_to_lint.each do |podspec|
+            validator                = Validator.new(podspec, @source_urls, @platforms)
+            validator.quick          = @quick
+            validator.no_clean       = !@clean
+            validator.fail_fast      = @fail_fast
+            validator.allow_warnings = @allow_warnings
+            validator.no_subspecs    = !@subspecs || @only_subspec
+            validator.only_subspec   = @only_subspec
+            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
+            validator.validate
+            failure_reasons << validator.failure_reason
+
+            unless @clean
+              UI.puts "Pods workspace available at `#{validator.validation_dir}/App.xcworkspace` for inspection."
+              UI.puts
+            end
+          end
+
+          count = podspecs_to_lint.count
+          UI.puts "Analyzed #{count} #{'podspec'.pluralize(count)}.\n\n"
+
+          failure_reasons.compact!
+          if failure_reasons.empty?
+            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, if count == 1
+                                 "The spec did not pass validation, due to #{failure_reasons.first}."
+                               else
+                                 "#{failure_reasons.count} out of #{count} specs failed validation."
+                               end
+          end
+          podspecs_tmp_dir.rmtree if podspecs_tmp_dir.exist?
+        end
+
+        private
+
+        def podspecs_to_lint
+          @podspecs_to_lint ||= begin
+            files = []
+            @podspecs_paths << '.' if @podspecs_paths.empty?
+            @podspecs_paths.each do |path|
+              if path =~ %r{https?://}
+                require 'cocoapods/open-uri'
+                output_path = podspecs_tmp_dir + File.basename(path)
+                output_path.dirname.mkpath
+                begin
+                  open(path) do |io|
+                    output_path.open('w') { |f| f << io.read }
+                  end
+                rescue => e
+                  raise Informative, "Downloading a podspec from `#{path}` failed: #{e}"
+                end
+                files << output_path
+              elsif (pathname = Pathname.new(path)).directory?
+                files += Pathname.glob(pathname + '*.podspec{.json,}')
+                raise Informative, 'No specs found in the current directory.' if files.empty?
+              else
+                files << (pathname = Pathname.new(path))
+                raise Informative, "Unable to find a spec named `#{path}'." unless pathname.exist? && path.include?('.podspec')
+              end
+            end
+            files
+          end
+        end
+
+        def podspecs_tmp_dir
+          Pathname.new(Dir.tmpdir) + 'CocoaPods/Lint_podspec'
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/command/spec/which.rb

@@ -0,0 +1,43 @@
+module Pod
+  class Command
+    class Spec < Command
+      class Which < Spec
+        self.summary = 'Prints the path of the given spec'
+
+        self.description = <<-DESC
+          Prints the path of the .podspec file(s) whose name matches `QUERY`
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('QUERY', false),
+        ]
+
+        def self.options
+          [
+            ['--regex', 'Interpret the `QUERY` as a regular expression'],
+            ['--show-all', 'Print all versions of the given podspec'],
+          ].concat(super)
+        end
+
+        def initialize(argv)
+          @use_regex = argv.flag?('regex')
+          @show_all = argv.flag?('show-all')
+          @query = argv.shift_argument
+          @query = @query.gsub('.podspec', '') unless @query.nil?
+          super
+        end
+
+        def validate!
+          super
+          help! 'A podspec name is required.' unless @query
+          validate_regex!(@query) if @use_regex
+        end
+
+        def run
+          query = @use_regex ? @query : Regexp.escape(@query)
+          UI.puts get_path_of_spec(query, @show_all)
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/command/update.rb

@@ -0,0 +1,101 @@
+module Pod
+  class Command
+    class Update < Command
+      include RepoUpdate
+      include ProjectDirectory
+
+      self.summary = 'Update outdated project dependencies and create new ' \
+        'Podfile.lock'
+
+      self.description = <<-DESC
+        Updates the Pods identified by the specified `POD_NAMES`, which is a
+        space-delimited list of pod names. If no `POD_NAMES` are specified, it
+        updates all the Pods, ignoring the contents of the Podfile.lock. This
+        command is reserved for the update of dependencies; pod install should
+        be used to install changes to the Podfile.
+      DESC
+
+      self.arguments = [
+        CLAide::Argument.new('POD_NAMES', false, true),
+      ]
+
+      def self.options
+        [
+          ['--sources=https://github.com/artsy/Specs,master', 'The sources from which to update dependent pods. ' \
+           'Multiple sources must be comma-delimited. The master repo will not be included by default with this option.'],
+          ['--exclude-pods=podName', 'Pods to exclude during update. Multiple pods must be comma-delimited.'],
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        @pods = argv.arguments! unless argv.arguments.empty?
+
+        source_urls = argv.option('sources', '').split(',')
+        excluded_pods = argv.option('exclude-pods', '').split(',')
+        unless source_urls.empty?
+          source_pods = source_urls.flat_map { |url| config.sources_manager.source_with_name_or_url(url).pods }
+          unless source_pods.empty?
+            source_pods = source_pods.select { |pod| config.lockfile.pod_names.include?(pod) }
+            if @pods
+              @pods += source_pods
+            else
+              @pods = source_pods unless source_pods.empty?
+            end
+          end
+        end
+
+        unless excluded_pods.empty?
+          @pods ||= config.lockfile.pod_names.dup
+
+          non_installed_pods = (excluded_pods - @pods)
+          unless non_installed_pods.empty?
+            pluralized_words = non_installed_pods.length > 1 ? %w(Pods are) : %w(Pod is)
+            message = "Trying to skip `#{non_installed_pods.join('`, `')}` #{pluralized_words.first} " \
+                    "which #{pluralized_words.last} not installed"
+            raise Informative, message
+          end
+
+          @pods.delete_if { |pod| excluded_pods.include?(pod) }
+        end
+
+        super
+      end
+
+      # Check if all given pods are installed
+      #
+      def verify_pods_are_installed!
+        lockfile_roots = config.lockfile.pod_names.map { |p| Specification.root_name(p) }
+        missing_pods = @pods.map { |p| Specification.root_name(p) }.select do |pod|
+          !lockfile_roots.include?(pod)
+        end
+
+        unless missing_pods.empty?
+          message = if missing_pods.length > 1
+                      "Pods `#{missing_pods.join('`, `')}` are not " \
+                          'installed and cannot be updated'
+                    else
+                      "The `#{missing_pods.first}` Pod is not installed " \
+                          'and cannot be updated'
+                    end
+          raise Informative, message
+        end
+      end
+
+      def run
+        verify_podfile_exists!
+
+        installer = installer_for_config
+        installer.repo_update = repo_update?(:default => true)
+        if @pods
+          verify_lockfile_exists!
+          verify_pods_are_installed!
+          installer.update = { :pods => @pods }
+        else
+          UI.puts 'Update all pods'.yellow
+          installer.update = true
+        end
+        installer.install!
+      end
+    end
+  end
+end

data/lib/cocoapods/config.rb

@@ -0,0 +1,347 @@
+require 'active_support/multibyte/unicode'
+
+module Pod
+  # Stores the global configuration of CocoaPods.
+  #
+  class Config
+    # The default settings for the configuration.
+    #
+    # Users can specify custom settings in `~/.cocoapods/config.yaml`.
+    # An example of the contents of this file might look like:
+    #
+    #     ---
+    #     skip_repo_update: true
+    #     new_version_message: false
+    #
+    DEFAULTS = {
+      :verbose             => false,
+      :silent              => false,
+      :skip_download_cache => !ENV['COCOAPODS_SKIP_CACHE'].nil?,
+
+      :new_version_message => ENV['COCOAPODS_SKIP_UPDATE_MESSAGE'].nil?,
+
+      :cache_root          => Pathname.new(Dir.home) + 'Library/Caches/CocoaPods',
+    }
+
+    # Applies the given changes to the config for the duration of the given
+    # block.
+    #
+    # @param [Hash<#to_sym,Object>] changes
+    #        the changes to merge temporarily with the current config
+    #
+    # @yield [] is called while the changes are applied
+    #
+    def with_changes(changes)
+      old = {}
+      changes.keys.each do |key|
+        key = key.to_sym
+        old[key] = send(key) if respond_to?(key)
+      end
+      configure_with(changes)
+      yield if block_given?
+    ensure
+      configure_with(old)
+    end
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group UI
+
+    # @return [Bool] Whether CocoaPods should provide detailed output about the
+    #         performed actions.
+    #
+    attr_accessor :verbose
+    alias_method :verbose?, :verbose
+
+    # @return [Bool] Whether CocoaPods should produce not output.
+    #
+    attr_accessor :silent
+    alias_method :silent?, :silent
+
+    # @return [Bool] Whether a message should be printed when a new version of
+    #         CocoaPods is available.
+    #
+    attr_accessor :new_version_message
+    alias_method :new_version_message?, :new_version_message
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Installation
+
+    # @return [Bool] Whether the installer should skip the download cache.
+    #
+    attr_accessor :skip_download_cache
+    alias_method :skip_download_cache?, :skip_download_cache
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Cache
+
+    # @return [Pathname] The directory where CocoaPods should cache remote data
+    #         and other expensive to compute information.
+    #
+    attr_accessor :cache_root
+
+    def cache_root
+      @cache_root.mkpath unless @cache_root.exist?
+      @cache_root
+    end
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Initialization
+
+    def initialize(use_user_settings = true)
+      configure_with(DEFAULTS)
+
+      unless ENV['CP_HOME_DIR'].nil?
+        @cache_root = home_dir + 'cache'
+      end
+
+      if use_user_settings && user_settings_file.exist?
+        require 'yaml'
+        user_settings = YAML.load_file(user_settings_file)
+        configure_with(user_settings)
+      end
+
+      unless ENV['CP_CACHE_DIR'].nil?
+        @cache_root = Pathname.new(ENV['CP_CACHE_DIR']).expand_path
+      end
+    end
+
+    def verbose
+      @verbose && !silent
+    end
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Paths
+
+    # @return [Pathname] the directory where repos, templates and configuration
+    #         files are stored.
+    #
+    def home_dir
+      @home_dir ||= Pathname.new(ENV['CP_HOME_DIR'] || '~/.cocoapods').expand_path
+    end
+
+    # @return [Pathname] the directory where the CocoaPods sources are stored.
+    #
+    def repos_dir
+      @repos_dir ||= Pathname.new(ENV['CP_REPOS_DIR'] || (home_dir + 'repos')).expand_path
+    end
+
+    attr_writer :repos_dir
+
+    def sources_manager
+      return @sources_manager if @sources_manager && @sources_manager.repos_dir == repos_dir
+      @sources_manager = Source::Manager.new(repos_dir)
+    end
+
+    # @return [Pathname] the directory where the CocoaPods templates are stored.
+    #
+    def templates_dir
+      @templates_dir ||= Pathname.new(ENV['CP_TEMPLATES_DIR'] || (home_dir + 'templates')).expand_path
+    end
+
+    # @return [Pathname] the root of the CocoaPods installation where the
+    #         Podfile is located.
+    #
+    def installation_root
+      current_dir = ActiveSupport::Multibyte::Unicode.normalize(Dir.pwd)
+      current_path = Pathname.new(current_dir)
+      unless @installation_root
+        until current_path.root?
+          if podfile_path_in_dir(current_path)
+            @installation_root = current_path
+            unless current_path == Pathname.pwd
+              UI.puts("[in #{current_path}]")
+            end
+            break
+          else
+            current_path = current_path.parent
+          end
+        end
+        @installation_root ||= Pathname.pwd
+      end
+      @installation_root
+    end
+
+    attr_writer :installation_root
+    alias_method :project_root, :installation_root
+
+    # @return [Pathname] The root of the sandbox.
+    #
+    def sandbox_root
+      @sandbox_root ||= installation_root + 'Pods'
+    end
+
+    attr_writer :sandbox_root
+    alias_method :project_pods_root, :sandbox_root
+
+    # @return [Sandbox] The sandbox of the current project.
+    #
+    def sandbox
+      @sandbox ||= Sandbox.new(sandbox_root)
+    end
+
+    # @return [Podfile] The Podfile to use for the current execution.
+    # @return [Nil] If no Podfile is available.
+    #
+    def podfile
+      @podfile ||= Podfile.from_file(podfile_path) if podfile_path
+    end
+    attr_writer :podfile
+
+    # @return [Lockfile] The Lockfile to use for the current execution.
+    # @return [Nil] If no Lockfile is available.
+    #
+    def lockfile
+      @lockfile ||= Lockfile.from_file(lockfile_path) if lockfile_path
+    end
+
+    # Returns the path of the Podfile.
+    #
+    # @note The Podfile can be named either `CocoaPods.podfile.yaml`,
+    #       `CocoaPods.podfile` or `Podfile`.  The first two are preferred as
+    #       they allow to specify an OS X UTI.
+    #
+    # @return [Pathname]
+    # @return [Nil]
+    #
+    def podfile_path
+      @podfile_path ||= podfile_path_in_dir(installation_root)
+    end
+
+    # Returns the path of the Lockfile.
+    #
+    # @note The Lockfile is named `Podfile.lock`.
+    #
+    def lockfile_path
+      @lockfile_path ||= installation_root + 'Podfile.lock'
+    end
+
+    # Returns the path of the default Podfile pods.
+    #
+    # @note The file is expected to be named Podfile.default
+    #
+    # @return [Pathname]
+    #
+    def default_podfile_path
+      @default_podfile_path ||= templates_dir + 'Podfile.default'
+    end
+
+    # Returns the path of the default Podfile test pods.
+    #
+    # @note The file is expected to be named Podfile.test
+    #
+    # @return [Pathname]
+    #
+    def default_test_podfile_path
+      @default_test_podfile_path ||= templates_dir + 'Podfile.test'
+    end
+
+    # @return [Pathname] The file to use to cache the search data.
+    #
+    def search_index_file
+      cache_root + 'search_index.json'
+    end
+
+    private
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Private helpers
+
+    # @return [Pathname] The path of the file which contains the user settings.
+    #
+    def user_settings_file
+      home_dir + 'config.yaml'
+    end
+
+    # Sets the values of the attributes with the given hash.
+    #
+    # @param  [Hash{String,Symbol => Object}] values_by_key
+    #         The values of the attributes grouped by key.
+    #
+    # @return [void]
+    #
+    def configure_with(values_by_key)
+      return unless values_by_key
+      values_by_key.each do |key, value|
+        if key == :cache_root
+          value = Pathname.new(value).expand_path
+        end
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # @return [Array<String>] The filenames that the Podfile can have ordered
+    #         by priority.
+    #
+    PODFILE_NAMES = [
+      'CocoaPods.podfile.yaml',
+      'CocoaPods.podfile',
+      'Podfile',
+    ].freeze
+
+    public
+
+    # Returns the path of the Podfile in the given dir if any exists.
+    #
+    # @param  [Pathname] dir
+    #         The directory where to look for the Podfile.
+    #
+    # @return [Pathname] The path of the Podfile.
+    # @return [Nil] If not Podfile was found in the given dir
+    #
+    def podfile_path_in_dir(dir)
+      PODFILE_NAMES.each do |filename|
+        candidate = dir + filename
+        if candidate.exist?
+          return candidate
+        end
+      end
+      nil
+    end
+
+    public
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Singleton
+
+    # @return [Config] the current config instance creating one if needed.
+    #
+    def self.instance
+      @instance ||= new
+    end
+
+    # Sets the current config instance. If set to nil the config will be
+    # recreated when needed.
+    #
+    # @param  [Config, Nil] the instance.
+    #
+    # @return [void]
+    #
+    class << self
+      attr_writer :instance
+    end
+
+    # Provides support for accessing the configuration instance in other
+    # scopes.
+    #
+    module Mixin
+      def config
+        Config.instance
+      end
+    end
+  end
+end