xcocoapods 1.5.3

data/lib/cocoapods/installer/post_install_hooks_context.rb

@@ -0,0 +1,132 @@
+module Pod
+  class Installer
+    # Context object designed to be used with the HooksManager which describes
+    # the context of the installer.
+    #
+    class PostInstallHooksContext
+      # @return [Sandbox] The Sandbox for the project.
+      #
+      attr_reader :sandbox
+
+      # @return [String] The path to the sandbox root (`Pods` directory).
+      #
+      attr_reader :sandbox_root
+
+      # @return [Xcodeproj::Project] The Pods Xcode project.
+      #
+      attr_reader :pods_project
+
+      # @return [Array<UmbrellaTargetDescription>] The list of
+      #         the CocoaPods umbrella targets generated by the installer.
+      #
+      attr_reader :umbrella_targets
+
+      # Initialize a new instance
+      #
+      # @param [Sandbox] sandbox see #sandbox
+      # @param [String] sandbox_root see #sandbox_root
+      # @param [Xcodeproj::Project] pods_project see #pods_project
+      # @param [Array<UmbrellaTargetDescription>] umbrella_targets see #umbrella_targets
+      #
+      def initialize(sandbox, sandbox_root, pods_project, umbrella_targets)
+        @sandbox = sandbox
+        @sandbox_root = sandbox_root
+        @pods_project = pods_project
+        @umbrella_targets = umbrella_targets
+      end
+
+      # @return [PostInstallHooksContext] Convenience class generator method
+      #
+      # @param  [Sandbox] sandbox
+      #         The sandbox
+      #
+      # @param  [Array<AggregateTarget>] aggregate_targets
+      #         The aggregate targets, which will been presented by an adequate
+      #         {UmbrellaTargetDescription} in the generated context.
+      #
+      # @return [HooksContext] Convenience class method to generate the
+      #         static context.
+      #
+      def self.generate(sandbox, aggregate_targets)
+        umbrella_targets_descriptions = aggregate_targets.map do |umbrella|
+          user_project = umbrella.user_project
+          user_targets = umbrella.user_targets
+          specs = umbrella.specs
+          platform_name = umbrella.platform.name
+          platform_deployment_target = umbrella.platform.deployment_target.to_s
+          cocoapods_target_label = umbrella.label
+          UmbrellaTargetDescription.new(user_project, user_targets, specs, platform_name, platform_deployment_target, cocoapods_target_label)
+        end
+
+        new(sandbox, sandbox.root.to_s, sandbox.project, umbrella_targets_descriptions)
+      end
+
+      # Pure data class which describes and umbrella target.
+      #
+      class UmbrellaTargetDescription
+        # @return [Xcodeproj::Project] The user project into which this target
+        #         is integrated.
+        #
+        attr_reader :user_project
+
+        # @return [Array<PBXNativeTarget>]
+        #         The list of user targets integrated by this umbrella target.
+        #
+        attr_reader :user_targets
+
+        # @return [Array<Specification>] The list of the
+        #         specifications of the target.
+        #
+        attr_reader :specs
+
+        # @return [Symbol] The platform (either `:ios`, `:watchos`, `:tvos`, or `:osx`).
+        #
+        attr_reader :platform_name
+
+        # @return [String] The deployment target.
+        #
+        attr_reader :platform_deployment_target
+
+        # @return [String] The label for the target.
+        #
+        attr_reader :cocoapods_target_label
+
+        # Initialize a new instance
+        #
+        # @param [Xcodeproj::Project] user_project see #user_project
+        # @param [Array<PBXNativeTarget>] user_targets see #user_targets
+        # @param [Array<Specification>] specs see #specs
+        # @param [Symbol] platform_name see #platform_name
+        # @param [String] platform_deployment_target see #platform_deployment_target
+        # @param [String] cocoapods_target_label see #cocoapods_target_label
+        #
+        def initialize(user_project, user_targets, specs, platform_name, platform_deployment_target, cocoapods_target_label)
+          @user_project = user_project
+          @user_targets = user_targets
+          @specs = specs
+          @platform_name = platform_name
+          @platform_deployment_target = platform_deployment_target
+          @cocoapods_target_label = cocoapods_target_label
+        end
+
+        # @return [String] The path of the user project
+        #         integrated by this target.
+        #
+        def user_project_path
+          user_project.path if user_project
+        end
+
+        # @return [Array<String>] The list of the UUIDs of the
+        #         user targets integrated by this umbrella
+        #         target.  They can be used to find the
+        #         targets opening the project They can be used
+        #         to find the targets opening the project with
+        #         Xcodeproj.
+        #
+        def user_target_uuids
+          user_targets.map(&:uuid)
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/installer/pre_install_hooks_context.rb

@@ -0,0 +1,51 @@
+module Pod
+  class Installer
+    # Context object designed to be used with the HooksManager which describes
+    # the context of the installer before analysis has been completed.
+    #
+    class PreInstallHooksContext
+      # @return [Podfile] The Podfile for the project.
+      #
+      attr_reader :podfile
+
+      # @return [Sandbox] The Sandbox for the project.
+      #
+      attr_reader :sandbox
+
+      # @return [String] The path to the sandbox root (`Pods` directory).
+      #
+      attr_reader :sandbox_root
+
+      # @return [Lockfile] The Lockfile for the project.
+      #
+      attr_reader :lockfile
+
+      # Initialize a new instance
+      #
+      # @param [Sandbox] sandbox see #sandbox
+      # @param [String] sandbox_root see #sandbox_root
+      # @param [Podfile] podfile see #podfile
+      # @param [Lockfile] lockfile see #lockfile
+      #
+      def initialize(podfile, sandbox, sandbox_root, lockfile)
+        @podfile = podfile
+        @sandbox = sandbox
+        @sandbox_root = sandbox_root
+        @lockfile = lockfile
+      end
+
+      # @param  [Sandbox] sandbox see {#sandbox}
+      #
+      # @param  [Podfile] podfile see {#podfile}
+      #
+      # @param  [Lockfile] lockfile see {#lockfile}
+      #
+      # @return [PreInstallHooksContext] Convenience class method to generate the
+      #         static context.
+      #
+      def self.generate(sandbox, podfile, lockfile)
+        new(podfile, sandbox, sandbox.root.to_s, lockfile)
+      end
+    end
+  end
+end

data/lib/cocoapods/installer/source_provider_hooks_context.rb

@@ -0,0 +1,34 @@
+module Pod
+  class Installer
+    # Context object designed to be used with the HooksManager which describes
+    # the context of the installer before spec sources have been created
+    #
+    class SourceProviderHooksContext
+      # @return [Array<Source>] The source objects to send to the installer
+      #
+      attr_reader :sources
+
+      # @return [SourceProviderHooksContext] Convenience class method to generate the
+      #         static context.
+      #
+      def self.generate
+        result = new
+        result
+      end
+
+      def initialize
+        @sources = []
+      end
+
+      # @param [Source] source object to be added to the installer
+      #
+      # @return [void]
+      #
+      def add_source(source)
+        unless source.nil?
+          @sources << source
+        end
+      end
+    end
+  end
+end

data/lib/cocoapods/installer/user_project_integrator.rb

@@ -0,0 +1,250 @@
+require 'xcodeproj/workspace'
+require 'xcodeproj/project'
+
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/array/conversions'
+
+module Pod
+  class Installer
+    # The {UserProjectIntegrator} integrates the libraries generated by
+    # TargetDefinitions of the {Podfile} with their correspondent user
+    # projects.
+    #
+    class UserProjectIntegrator
+      autoload :TargetIntegrator, 'cocoapods/installer/user_project_integrator/target_integrator'
+
+      # @return [Podfile] the podfile that should be integrated with the user
+      #         projects.
+      #
+      attr_reader :podfile
+
+      # @return [Project] the pods project which contains the libraries to
+      #         integrate.
+      #
+      # attr_reader :pods_project
+
+      attr_reader :sandbox
+
+      # @return [Pathname] the path of the installation.
+      #
+      # @todo This is only used to compute the workspace path in case that it
+      #       should be inferred by the project. If the workspace should be in
+      #       the same dir of the project, this could be removed.
+      #
+      attr_reader :installation_root
+
+      # @return [Array<AggregateTarget>] the targets represented in the Podfile.
+      #
+      attr_reader :targets
+
+      # Init a new UserProjectIntegrator
+      #
+      # @param  [Podfile]  podfile @see #podfile
+      # @param  [Sandbox]  sandbox @see #sandbox
+      # @param  [Pathname] installation_root @see #installation_root
+      # @param  [Array<AggregateTarget>]  targets @see #targets
+      #
+      def initialize(podfile, sandbox, installation_root, targets)
+        @podfile = podfile
+        @sandbox = sandbox
+        @installation_root = installation_root
+        @targets = targets
+      end
+
+      # Integrates the user projects associated with the {TargetDefinitions}
+      # with the Pods project and its products.
+      #
+      # @return [void]
+      #
+      def integrate!
+        create_workspace
+        integrate_user_targets
+        warn_about_xcconfig_overrides
+        save_projects
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # @!group Integration steps
+
+      # Creates and saved the workspace containing the Pods project and the
+      # user projects, if needed.
+      #
+      # @note If the workspace already contains the projects it is not saved
+      #       to avoid Xcode from displaying the revert dialog: `Do you want to
+      #       keep the Xcode version or revert to the version on disk?`
+      #
+      # @return [void]
+      #
+      def create_workspace
+        all_projects = user_project_paths.sort.push(sandbox.project_path).uniq
+        file_references = all_projects.map do |path|
+          relative_path = path.relative_path_from(workspace_path.dirname).to_s
+          Xcodeproj::Workspace::FileReference.new(relative_path, 'group')
+        end
+
+        if workspace_path.exist?
+          workspace = Xcodeproj::Workspace.new_from_xcworkspace(workspace_path)
+          new_file_references = file_references - workspace.file_references
+          unless new_file_references.empty?
+            new_file_references.each { |fr| workspace << fr }
+            workspace.save_as(workspace_path)
+          end
+
+        else
+          UI.notice "Please close any current Xcode sessions and use `#{workspace_path.basename}` for this project from now on."
+          workspace = Xcodeproj::Workspace.new(*file_references)
+          workspace.save_as(workspace_path)
+        end
+      end
+
+      # Integrates the targets of the user projects with the libraries
+      # generated from the {Podfile}.
+      #
+      # @note   {TargetDefinition} without dependencies are skipped prevent
+      #         creating empty libraries for targets definitions which are only
+      #         wrappers for others.
+      #
+      # @return [void]
+      #
+      def integrate_user_targets
+        target_integrators = targets_to_integrate.sort_by(&:name).map do |target|
+          TargetIntegrator.new(target)
+        end
+
+        Config.instance.with_changes(:silent => true) do
+          deintegrator = Deintegrator.new
+          all_project_targets = user_projects.flat_map(&:native_targets).uniq
+          all_native_targets = targets_to_integrate.flat_map(&:user_targets).uniq
+          targets_to_deintegrate = all_project_targets - all_native_targets
+          targets_to_deintegrate.each do |target|
+            deintegrator.deintegrate_target(target)
+          end
+        end
+
+        target_integrators.each(&:integrate!)
+      end
+
+      # Save all user projects.
+      #
+      # @return [void]
+      #
+      def save_projects
+        user_projects.each do |project|
+          if project.dirty?
+            project.save
+          else
+            # There is a bug in Xcode where the process of deleting and
+            # re-creating the xcconfig files used in the build
+            # configuration cause building the user project to fail until
+            # Xcode is relaunched.
+            #
+            # Touching/saving the project causes Xcode to reload these.
+            #
+            # https://github.com/CocoaPods/CocoaPods/issues/2665
+            FileUtils.touch(project.path + 'project.pbxproj')
+          end
+        end
+      end
+
+      IGNORED_KEYS = %w(CODE_SIGN_IDENTITY).freeze
+      INHERITED_FLAGS = %w($(inherited) ${inherited}).freeze
+
+      # Checks whether the settings of the CocoaPods generated xcconfig are
+      # overridden by the build configuration of a target and prints a
+      # warning to inform the user if needed.
+      #
+      def warn_about_xcconfig_overrides
+        targets.each do |aggregate_target|
+          aggregate_target.user_targets.each do |user_target|
+            user_target.build_configurations.each do |config|
+              xcconfig = aggregate_target.xcconfigs[config.name]
+              if xcconfig
+                (xcconfig.to_hash.keys - IGNORED_KEYS).each do |key|
+                  target_values = config.build_settings[key]
+                  if target_values &&
+                      !INHERITED_FLAGS.any? { |flag| target_values.include?(flag) }
+                    print_override_warning(aggregate_target, user_target, config, key)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      # @!group Private Helpers
+      #-----------------------------------------------------------------------#
+
+      # @return [Pathname] the path where the workspace containing the Pods
+      #         project and the user projects should be saved.
+      #
+      def workspace_path
+        if podfile.workspace_path
+          declared_path = podfile.workspace_path
+          path_with_ext = File.extname(declared_path) == '.xcworkspace' ? declared_path : "#{declared_path}.xcworkspace"
+          podfile_dir   = File.dirname(podfile.defined_in_file || '')
+          absolute_path = File.expand_path(path_with_ext, podfile_dir)
+          Pathname.new(absolute_path)
+        elsif user_project_paths.count == 1
+          project = user_project_paths.first.basename('.xcodeproj')
+          installation_root + "#{project}.xcworkspace"
+        else
+          raise Informative, 'Could not automatically select an Xcode ' \
+            "workspace. Specify one in your Podfile like so:\n\n"       \
+            "    workspace 'path/to/Workspace.xcworkspace'\n"
+        end
+      end
+
+      # @return [Array<Pathname>] the paths of all the user projects referenced
+      #         by the target definitions.
+      #
+      # @note   Empty target definitions are ignored.
+      #
+      def user_project_paths
+        targets.map(&:user_project_path).compact.uniq
+      end
+
+      def user_projects
+        targets.map(&:user_project).compact.uniq
+      end
+
+      def targets_to_integrate
+        targets
+      end
+
+      # Prints a warning informing the user that a build configuration of
+      # the integrated target is overriding the CocoaPods build settings.
+      #
+      # @param  [Target::AggregateTarget] aggregate_target
+      #         The umbrella target.
+      #
+      # @param  [XcodeProj::PBXNativeTarget] user_target
+      #         The native target.
+      #
+      # @param  [Xcodeproj::XCBuildConfiguration] config
+      #         The build configuration.
+      #
+      # @param  [String] key
+      #         The key of the overridden build setting.
+      #
+      def print_override_warning(aggregate_target, user_target, config, key)
+        actions = [
+          'Use the `$(inherited)` flag, or',
+          'Remove the build settings from the target.',
+        ]
+        message = "The `#{user_target.name} [#{config.name}]` " \
+          "target overrides the `#{key}` build setting defined in " \
+          "`#{aggregate_target.xcconfig_relative_path(config.name)}'. " \
+          'This can lead to problems with the CocoaPods installation'
+        UI.warn(message, actions)
+      end
+
+      #-----------------------------------------------------------------------#
+    end
+  end
+end