cocoapods 1.5.2 → 1.6.1

data/lib/cocoapods/installer.rb

@@ -61,17 +61,18 @@ module Pod
 
     # Initialize a new instance
     #
-    # @param  [Sandbox]  sandbox     @see sandbox
-    # @param  [Podfile]  podfile     @see podfile
-    # @param  [Lockfile] lockfile    @see lockfile
+    # @param  [Sandbox]  sandbox     @see #sandbox
+    # @param  [Podfile]  podfile     @see #podfile
+    # @param  [Lockfile] lockfile    @see #lockfile
     #
     def initialize(sandbox, podfile, lockfile = nil)
-      @sandbox  = sandbox
-      @podfile  = podfile
+      @sandbox  = sandbox || raise(ArgumentError, 'Missing required argument `sandbox`')
+      @podfile  = podfile || raise(ArgumentError, 'Missing required argument `podfile`')
       @lockfile = lockfile
 
       @use_default_plugins = true
       @has_dependencies = true
+      @pod_installers = []
     end
 
     # @return [Hash, Boolean, nil] Pods that have been requested to be
@@ -97,6 +98,25 @@ module Pod
     attr_accessor :use_default_plugins
     alias_method :use_default_plugins?, :use_default_plugins
 
+    # @return [Boolean] Whether installation should verify that there are no
+    #                   Podfile or Lockfile changes. Defaults to false.
+    #
+    attr_accessor :deployment
+    alias_method :deployment?, :deployment
+
+    #-------------------------------------------------------------------------#
+
+    private
+
+    # @return [Array<PodSourceInstaller>] the pod installers created
+    #         while installing pod targets
+    #
+    attr_reader :pod_installers
+
+    #-------------------------------------------------------------------------#
+
+    public
+
     # Installs the Pods.
     #
     # The installation process is mostly linear with a few minor complications
@@ -155,12 +175,17 @@ module Pod
         validate_build_configurations
         clean_sandbox
       end
+
+      UI.section 'Verifying no changes' do
+        verify_no_podfile_changes!
+        verify_no_lockfile_changes!
+      end if deployment?
+
       analyzer
     end
 
     def download_dependencies
       UI.section 'Downloading dependencies' do
-        create_file_accessors
         install_pod_sources
         run_podfile_pre_install_hooks
         clean_pod_sources
@@ -174,14 +199,14 @@ module Pod
     private
 
     def create_generator
-      Xcode::PodsProjectGenerator.new(aggregate_targets, sandbox, pod_targets, analysis_result, installation_options, config)
+      Xcode::PodsProjectGenerator.new(sandbox, aggregate_targets, pod_targets, analysis_result, installation_options, config)
     end
 
     # Generate the 'Pods/Pods.xcodeproj' project.
     #
     def generate_pods_project(generator = create_generator)
       UI.section 'Generating Pods project' do
-        generator.generate!
+        @target_installation_results = generator.generate!
         @pods_project = generator.project
         run_podfile_post_install_hooks
         generator.write
@@ -201,13 +226,14 @@ module Pod
     #
     attr_reader :analysis_result
 
-    # @return [Pod::Project] the `Pods/Pods.xcodeproj` project.
+    # @return [Array<Hash{String, TargetInstallationResult}>] the installation results produced by the pods project
+    #         generator
     #
-    attr_reader :pods_project
+    attr_reader :target_installation_results
 
-    # @return [Array<String>] The Pods that should be installed.
+    # @return [Pod::Project] the `Pods/Pods.xcodeproj` project.
     #
-    attr_reader :names_of_pods_to_install
+    attr_reader :pods_project
 
     # @return [Array<AggregateTarget>] The model representations of an
     #         aggregation of pod targets generated for a target definition
@@ -218,13 +244,9 @@ module Pod
     # @return [Array<PodTarget>] The model representations of pod targets
     #         generated as result of the analyzer.
     #
-    def pod_targets
-      aggregate_target_pod_targets = aggregate_targets.flat_map(&:pod_targets)
-      test_dependent_targets = aggregate_target_pod_targets.flat_map(&:test_dependent_targets)
-      (aggregate_target_pod_targets + test_dependent_targets).uniq
-    end
+    attr_reader :pod_targets
 
-    # @return [Array<Specification>] The specifications that where installed.
+    # @return [Array<Specification>] The specifications that were installed.
     #
     attr_accessor :installed_specs
 
@@ -236,18 +258,19 @@ module Pod
 
     # Performs the analysis.
     #
+    # @param  [Analyzer] analyzer the analyzer to use for analysis
+    #
     # @return [void]
     #
     def analyze(analyzer = create_analyzer)
-      analyzer.update = update
       @analysis_result = analyzer.analyze
-      @aggregate_targets = analyzer.result.targets
+      @aggregate_targets = @analysis_result.targets
+      @pod_targets = @analysis_result.pod_targets
     end
 
     def create_analyzer(plugin_sources = nil)
-      Analyzer.new(sandbox, podfile, lockfile, plugin_sources).tap do |analyzer|
+      Analyzer.new(sandbox, podfile, lockfile, plugin_sources, has_dependencies?, update).tap do |analyzer|
         analyzer.installation_options = installation_options
-        analyzer.has_dependencies = has_dependencies?
       end
     end
 
@@ -302,11 +325,26 @@ module Pod
       end
     end
 
-    # @return [void] In this step we create the file accessors for the pod
-    #                targets.
+    # @raise [Informative] If there are any Podfile changes
     #
-    def create_file_accessors
-      sandbox.create_file_accessors(pod_targets)
+    def verify_no_podfile_changes!
+      return unless analysis_result.podfile_needs_install?
+
+      changed_state = analysis_result.podfile_state.to_s(:states => %i(added deleted changed))
+      raise Informative, "There were changes to the podfile in deployment mode:\n#{changed_state}"
+    end
+
+    # @raise [Informative] If there are any Lockfile changes
+    #
+    def verify_no_lockfile_changes!
+      new_lockfile = generate_lockfile
+      return if new_lockfile == lockfile
+
+      diff = Xcodeproj::Differ.hash_diff(lockfile.to_hash, new_lockfile.to_hash, :key_1 => 'Old Lockfile', :key_2 => 'New Lockfile')
+      pretty_diff = YAMLHelper.convert_hash(diff, Lockfile::HASH_KEY_ORDER, "\n\n")
+      pretty_diff.gsub!(':diff:', 'diff:'.yellow)
+
+      raise Informative, "There were changes to the lockfile in deployment mode:\n#{pretty_diff}"
     end
 
     # Downloads, installs the documentation and cleans the sources of the Pods
@@ -327,7 +365,7 @@ module Pod
             current_repo = analysis_result.specs_by_source.detect { |key, values| break key if values.map(&:name).include?(spec.name) }
             current_repo &&= current_repo.url || current_repo.name
             previous_spec_repo = sandbox.manifest.spec_repo(spec.name)
-            has_changed_repo = !previous_spec_repo.nil? && current_repo && (current_repo != previous_spec_repo)
+            has_changed_repo = !previous_spec_repo.nil? && current_repo && !current_repo.casecmp(previous_spec_repo).zero?
             title = "Installing #{spec.name} #{spec.version}"
             title << " (was #{previous_version} and source changed to `#{current_repo}` from `#{previous_spec_repo}`)" if has_changed_version && has_changed_repo
             title << " (was #{previous_version})" if has_changed_version && !has_changed_repo
@@ -347,22 +385,36 @@ module Pod
     end
 
     def create_pod_installer(pod_name)
-      specs_by_platform = {}
-      pod_targets.each do |pod_target|
-        if pod_target.root_spec.name == pod_name
-          specs_by_platform[pod_target.platform] ||= []
-          specs_by_platform[pod_target.platform].concat(pod_target.specs)
-        end
+      specs_by_platform = specs_for_pod(pod_name)
+
+      if specs_by_platform.empty?
+        requiring_targets = pod_targets.select { |pt| pt.recursive_dependent_targets.any? { |dt| dt.pod_name == pod_name } }
+        message = "Could not install '#{pod_name}' pod"
+        message += ", dependended upon by #{requiring_targets.to_sentence}" unless requiring_targets.empty?
+        message += '. There is either no platform to build for, or no target to build.'
+        raise StandardError, message
       end
 
-      raise Informative, "Could not install '#{pod_name}' pod. There is no target that supports it." if specs_by_platform.empty?
-
-      @pod_installers ||= []
       pod_installer = PodSourceInstaller.new(sandbox, specs_by_platform, :can_cache => installation_options.clean?)
-      @pod_installers << pod_installer
+      pod_installers << pod_installer
       pod_installer
     end
 
+    # The specifications matching the specified pod name
+    #
+    # @param  [String] pod_name the name of the pod
+    #
+    # @return [Hash{Platform => Array<Specification>}] the specifications grouped by platform
+    #
+    def specs_for_pod(pod_name)
+      pod_targets.each_with_object({}) do |pod_target, hash|
+        if pod_target.root_spec.name == pod_name
+          hash[pod_target.platform] ||= []
+          hash[pod_target.platform].concat(pod_target.specs)
+        end
+      end
+    end
+
     # Install the Pods. If the resolver indicated that a Pod should be
     # installed and it exits, it is removed and then reinstalled. In any case if
     # the Pod doesn't exits it is installed.
@@ -377,21 +429,16 @@ module Pod
 
     # Cleans the sources of the Pods if the config instructs to do so.
     #
-    # @todo Why the @pod_installers might be empty?
     #
     def clean_pod_sources
       return unless installation_options.clean?
-      return unless @pod_installers
-      @pod_installers.each(&:clean!)
+      pod_installers.each(&:clean!)
     end
 
     # Unlocks the sources of the Pods.
     #
-    # @todo Why the @pod_installers might be empty?
-    #
     def unlock_pod_sources
-      return unless @pod_installers
-      @pod_installers.each do |installer|
+      pod_installers.each do |installer|
         pod_target = pod_targets.find { |target| target.pod_name == installer.name }
         installer.unlock_files!(pod_target.file_accessors)
       end
@@ -399,12 +446,9 @@ module Pod
 
     # Locks the sources of the Pods if the config instructs to do so.
     #
-    # @todo Why the @pod_installers might be empty?
-    #
     def lock_pod_sources
       return unless installation_options.lock_pod_sources?
-      return unless @pod_installers
-      @pod_installers.each do |installer|
+      pod_installers.each do |installer|
         pod_target = pod_targets.find { |target| target.pod_name == installer.name }
         installer.lock_files!(pod_target.file_accessors)
       end
@@ -429,11 +473,9 @@ module Pod
     # @return [void]
     #
     def perform_post_install_actions
-      unlock_pod_sources
       run_plugins_post_install_hooks
       warn_for_deprecations
       warn_for_installed_script_phases
-      lock_pod_sources
       print_post_install_message
     end
 
@@ -451,13 +493,26 @@ module Pod
     # Runs the registered callbacks for the plugins post install hooks.
     #
     def run_plugins_post_install_hooks
-      context = PostInstallHooksContext.generate(sandbox, aggregate_targets)
-      HooksManager.run(:post_install, context, plugins)
+      # This short-circuits because unlocking pod sources is expensive
+      if any_plugin_post_install_hooks?
+        unlock_pod_sources
+
+        context = PostInstallHooksContext.generate(sandbox, aggregate_targets)
+        HooksManager.run(:post_install, context, plugins)
+      end
+
+      lock_pod_sources
+    end
+
+    # @return [Boolean] whether there are any plugin post-install hooks to run
+    #
+    def any_plugin_post_install_hooks?
+      HooksManager.hooks_to_run(:post_install, plugins).any?
     end
 
     # Runs the registered callbacks for the source provider plugin hooks.
     #
-    # @return [void]
+    # @return [Array<Pod::Source>] the plugin sources
     #
     def run_source_provider_hooks
       context = SourceProviderHooksContext.generate
@@ -550,16 +605,20 @@ module Pod
       end
     end
 
-    # Writes the Podfile and the lock files.
+    # @return [Lockfile] The lockfile to write to disk.
     #
-    # @todo   Pass the checkout options to the Lockfile.
+    def generate_lockfile
+      external_source_pods = analysis_result.podfile_dependency_cache.podfile_dependencies.select(&:external_source).map(&:root_name).uniq
+      checkout_options = sandbox.checkout_sources.select { |root_name, _| external_source_pods.include? root_name }
+      Lockfile.generate(podfile, analysis_result.specifications, checkout_options, analysis_result.specs_by_source)
+    end
+
+    # Writes the Podfile and the lock files.
     #
     # @return [void]
     #
     def write_lockfiles
-      external_source_pods = analysis_result.podfile_dependency_cache.podfile_dependencies.select(&:external_source).map(&:root_name).uniq
-      checkout_options = sandbox.checkout_sources.select { |root_name, _| external_source_pods.include? root_name }
-      @lockfile = Lockfile.generate(podfile, analysis_result.specifications, checkout_options, analysis_result.specs_by_source)
+      @lockfile = generate_lockfile
 
       UI.message "- Writing Lockfile in #{UI.path config.lockfile_path}" do
         @lockfile.write_to_disk(config.lockfile_path)
@@ -579,11 +638,6 @@ module Pod
     #
     # @return [void]
     #
-    # @todo   [#397] The libraries should be cleaned and the re-added on every
-    #         installation. Maybe a clean_user_project phase should be added.
-    #         In any case it appears to be a good idea store target definition
-    #         information in the lockfile.
-    #
     def integrate_user_project
       UI.section "Integrating client #{'project'.pluralize(aggregate_targets.map(&:user_project_path).uniq.count)}" do
         installation_root = config.installation_root
@@ -684,5 +738,28 @@ module Pod
     end
 
     #-------------------------------------------------------------------------#
+
+    public
+
+    # @!group Convenience Methods
+
+    def self.targets_from_sandbox(sandbox, podfile, lockfile)
+      raise Informative, 'You must run `pod install` to be able to generate target information' unless lockfile
+
+      new(sandbox, podfile, lockfile).instance_exec do
+        plugin_sources = run_source_provider_hooks
+        analyzer = create_analyzer(plugin_sources)
+        analyze(analyzer)
+        if analysis_result.podfile_needs_install?
+          raise Pod::Informative, 'The Podfile has changed, you must run `pod install`'
+        elsif analysis_result.sandbox_needs_install?
+          raise Pod::Informative, 'The `Pods` directory is out-of-date, you must run `pod install`'
+        end
+
+        aggregate_targets
+      end
+    end
+
+    #-------------------------------------------------------------------------#
   end
 end

data/lib/cocoapods/project.rb

@@ -8,9 +8,22 @@ module Pod
   # through the installation process.
   #
   class Project < Xcodeproj::Project
+    # @return [PBXGroup] The group for the support files of the aggregate
+    #         targets.
+    #
+    attr_reader :support_files_group
+
+    # @return [PBXGroup] The group for the Pods.
+    #
+    attr_reader :pods
+
+    # @return [PBXGroup] The group for Development Pods.
+    #
+    attr_reader :development_pods
+
     # Initialize a new instance
     #
-    # @param  [Pathname, String] path @see path
+    # @param  [Pathname, String] path @see #path
     # @param  [Bool] skip_initialization
     #         Whether the project should be initialized from scratch.
     # @param  [Int] object_version
@@ -27,19 +40,6 @@ module Pod
       self.symroot = LEGACY_BUILD_ROOT
     end
 
-    # @return [PBXGroup] The group for the support files of the aggregate
-    #         targets.
-    #
-    attr_reader :support_files_group
-
-    # @return [PBXGroup] The group for the Pods.
-    #
-    attr_reader :pods
-
-    # @return [PBXGroup] The group for Development Pods.
-    #
-    attr_reader :development_pods
-
     # Generates a list of new UUIDs that created objects can be assigned.
     #
     # @note Overridden to generate UUIDs in a much faster way, since we don't need to check for collisions
@@ -252,6 +252,8 @@ module Pod
       file_ref.xc_language_specification_identifier = 'xcode.lang.ruby'
       file_ref.explicit_file_type = 'text.script.ruby'
       file_ref.last_known_file_type = 'text'
+      file_ref.tab_width = '2'
+      file_ref.indent_width = '2'
     end
 
     # Adds a new build configuration to the project and populates it with

data/lib/cocoapods/resolver/resolver_specification.rb

@@ -0,0 +1,41 @@
+module Pod
+  class Resolver
+    # A small container that wraps a resolved specification for a given target definition. Additional metadata
+    # is included here such as if the specification is only used by tests.
+    #
+    class ResolverSpecification
+      # @return [Specification] the specification that was resolved
+      #
+      attr_reader :spec
+
+      # @return [Source] the spec repo source the specification came from
+      #
+      attr_reader :source
+
+      # @return [Bool] whether this resolved specification is only used by tests.
+      #
+      attr_reader :used_by_tests_only
+      alias used_by_tests_only? used_by_tests_only
+
+      def initialize(spec, used_by_tests_only, source)
+        @spec = spec
+        @used_by_tests_only = used_by_tests_only
+        @source = source
+      end
+
+      def name
+        spec.name
+      end
+
+      def root
+        spec.root
+      end
+
+      def ==(other)
+        self.class == other.class &&
+          spec == other.spec &&
+          used_by_tests_only? == other.used_by_tests_only?
+      end
+    end
+  end
+end