cocoapods-dykit 0.5.2 → 0.5.3

data/lib/pod/installer/pod_source_installer.rb

@@ -0,0 +1,214 @@
+require 'active_support/core_ext/string/strip'
+
+module Pod
+  class DyInstaller
+    # Controller class responsible of installing the activated specifications
+    # of a single Pod.
+    #
+    # @note This class needs to consider all the activated specs of a Pod.
+    #
+    class PodSourceInstaller
+      # @return [Sandbox] The installation target.
+      #
+      attr_reader :sandbox
+
+      # @return [Hash{Symbol=>Array}] The specifications that need to be
+      #         installed grouped by platform.
+      #
+      attr_reader :specs_by_platform
+
+      # @return [Boolean] Whether the installer is allowed to touch the cache.
+      #
+      attr_reader :can_cache
+      alias_method :can_cache?, :can_cache
+
+      # Initialize a new instance
+      #
+      # @param [Sandbox] sandbox @see sandbox
+      # @param [Hash{Symbol=>Array}] specs_by_platform @see specs_by_platform
+      # @param [Boolean] can_cache @see can_cache
+      #
+      def initialize(sandbox, specs_by_platform, can_cache: true)
+        @sandbox = sandbox
+        @specs_by_platform = specs_by_platform
+        @can_cache = can_cache
+      end
+
+      # @return [String] A string suitable for debugging.
+      #
+      def inspect
+        "<#{self.class} sandbox=#{sandbox.root} pod=#{root_spec.name}"
+      end
+
+      # @return [String] The name of the pod this installer is installing.
+      #
+      def name
+        root_spec.name
+      end
+
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # @!group Installation
+
+      # Creates the target in the Pods project and the relative support files.
+      #
+      # @return [void]
+      #
+      def install!
+        download_source unless predownloaded? || local?
+        PodSourcePreparer.new(root_spec, root).prepare! if local?
+      end
+
+      # Cleans the installations if appropriate.
+      #
+      # @todo   As the pre install hooks need to run before cleaning this
+      #         method should be refactored.
+      #
+      # @return [void]
+      #
+      def clean!
+        clean_installation unless local?
+      end
+
+      # Locks the source files if appropriate.
+      #
+      # @todo   As the pre install hooks need to run before cleaning this
+      #         method should be refactored.
+      #
+      # @return [void]
+      #
+      def lock_files!(file_accessors)
+        return if local?
+        each_source_file(file_accessors) do |source_file|
+          FileUtils.chmod('u-w', source_file)
+        end
+      end
+
+      # Unlocks the source files if appropriate.
+      #
+      # @todo   As the pre install hooks need to run before cleaning this
+      #         method should be refactored.
+      #
+      # @return [void]
+      #
+      def unlock_files!(file_accessors)
+        return if local?
+        each_source_file(file_accessors) do |source_file|
+          FileUtils.chmod('u+w', source_file)
+        end
+      end
+
+      # @return [Hash] @see Downloader#checkout_options
+      #
+      attr_reader :specific_source
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # @!group Installation Steps
+
+      # Downloads the source of the Pod. It also stores the specific options
+      # needed to recreate the same exact installation if needed in
+      # `#specific_source`.
+      #
+      # @return [void]
+      #
+      def download_source
+        verify_source_is_secure(root_spec)
+        download_result = Downloader.download(download_request, root, :can_cache => can_cache?)
+
+        if (@specific_source = download_result.checkout_options) && specific_source != root_spec.source
+          sandbox.store_checkout_source(root_spec.name, specific_source)
+        end
+      end
+
+      # Verify the source of the spec is secure, which is used to
+      # show a warning to the user if that isn't the case
+      # This method doesn't verify all protocols, but currently
+      # only prohibits unencrypted http:// connections
+      #
+      def verify_source_is_secure(root_spec)
+        return if root_spec.source.nil? || root_spec.source[:http].nil?
+        http_source = URI(root_spec.source[:http])
+        return if http_source.scheme == 'https' || http_source.scheme == 'file'
+        UI.warn "'#{root_spec.name}' uses the unencrypted http protocol to transfer the Pod. " \
+                'Please be sure you\'re in a safe network with only trusted hosts in there. ' \
+                'Please reach out to the library author to notify them of this security issue.'
+      end
+
+      def download_request
+        Downloader::Request.new(
+          :spec => root_spec,
+          :released => released?,
+        )
+      end
+
+      # Removes all the files not needed for the installation according to the
+      # specs by platform.
+      #
+      # @return [void]
+      #
+      def clean_installation
+        cleaner = Sandbox::PodDirCleaner.new(root, specs_by_platform)
+        cleaner.clean!
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # @!group Convenience methods.
+
+      # @return [Array<Specifications>] the specification of the Pod used in
+      #         this installation.
+      #
+      def specs
+        specs_by_platform.values.flatten
+      end
+
+      # @return [Specification] the root specification of the Pod.
+      #
+      def root_spec
+        specs.first.root
+      end
+
+      # @return [Pathname] the folder where the source of the Pod is located.
+      #
+      def root
+        sandbox.pod_dir(root_spec.name)
+      end
+
+      # @return [Boolean] whether the source has been pre downloaded in the
+      #         resolution process to retrieve its podspec.
+      #
+      def predownloaded?
+        sandbox.predownloaded_pods.include?(root_spec.name)
+      end
+
+      # @return [Boolean] whether the pod uses the local option and thus
+      #         CocoaPods should not interfere with the files of the user.
+      #
+      def local?
+        sandbox.local?(root_spec.name)
+      end
+
+      def released?
+        !local? && !predownloaded? && sandbox.specification(root_spec.name) != root_spec
+      end
+
+      def each_source_file(file_accessors, &blk)
+        file_accessors.each do |file_accessor|
+          file_accessor.source_files.each do |source_file|
+            next unless source_file.exist?
+            blk[source_file]
+          end
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+    end
+  end
+end

data/lib/pod/installer/pod_source_preparer.rb

@@ -0,0 +1,77 @@
+module Pod
+  class DyInstaller
+    # Controller class responsible of executing the prepare command
+    # of a single Pod.
+    #
+    class PodSourcePreparer
+      # @return [Specification] the root specification of the Pod.
+      #
+      attr_reader :spec
+
+      # @return [Pathname] the folder where the source of the Pod is located.
+      #
+      attr_reader :path
+
+      # Initialize a new instance
+      #
+      # @param [Specification] spec the root specification of the Pod.
+      # @param [Pathname] path the folder where the source of the Pod is located.
+      #
+      def initialize(spec, path)
+        raise "Given spec isn't a root spec, but must be." unless spec.root?
+        @spec = spec
+        @path = path
+      end
+
+      #-----------------------------------------------------------------------#
+
+      public
+
+      # @!group Preparation
+
+      # Executes the prepare command if there is one.
+      #
+      # @return [void]
+      #
+      def prepare!
+        run_prepare_command
+      end
+
+      #-----------------------------------------------------------------------#
+
+      private
+
+      # @!group Preparation Steps
+
+      extend Executable
+      executable :bash
+
+      # Runs the prepare command bash script of the spec.
+      #
+      # @note   Unsets the `CDPATH` env variable before running the
+      #         shell script to avoid issues with relative paths
+      #         (issue #1694).
+      #
+      # @return [void]
+      #
+      def run_prepare_command
+        return unless spec.prepare_command
+        UI.section(' > Running prepare command', '', 1) do
+          Dir.chdir(path) do
+            begin
+              ENV.delete('CDPATH')
+              ENV['COCOAPODS_VERSION'] = Pod::VERSION
+              prepare_command = spec.prepare_command.strip_heredoc.chomp
+              full_command = "\nset -e\n" + prepare_command
+              bash!('-c', full_command)
+            ensure
+              ENV.delete('COCOAPODS_VERSION')
+            end
+          end
+        end
+      end
+
+      #-----------------------------------------------------------------------#
+    end
+  end
+end

data/lib/pod/installer/podfile_validator.rb

@@ -0,0 +1,139 @@
+module Pod
+  class DyInstaller
+    # Validate the podfile before installing to catch errors and
+    # problems
+    #
+    class PodfileValidator
+      # @return [Podfile] The podfile being validated
+      #
+      attr_reader :podfile
+
+      # @return [Array<String>] any errors that have occured during the validation
+      #
+      attr_reader :errors
+
+      # @return [Array<String>] any warnings that have occured during the validation
+      #
+      attr_reader :warnings
+
+      # Initialize a new instance
+      #
+      # @param [Podfile] podfile
+      #        The podfile to validate
+      #
+      # @param [Analyzer::PodfileDependencyCache] podfile_dependency_cache
+      #        An (optional) cache of all the dependencies in the podfile
+      #
+      def initialize(podfile, podfile_dependency_cache = Analyzer::PodfileDependencyCache.from_podfile(podfile))
+        @podfile = podfile
+        @podfile_dependency_cache = podfile_dependency_cache
+        @errors = []
+        @warnings = []
+        @validated = false
+      end
+
+      # Validate the podfile
+      # Errors are added to the errors array
+      #
+      def validate
+        validate_pod_directives
+        validate_no_abstract_only_pods!
+        validate_dependencies_are_present!
+        validate_no_duplicate_targets!
+
+        @validated = true
+      end
+
+      # Wether the podfile is valid is not
+      # NOTE: Will execute `validate` if the podfile
+      # has not yet been validated
+      #
+      def valid?
+        validate unless @validated
+
+        @validated && errors.empty?
+      end
+
+      # A message describing any errors in the
+      # validation
+      #
+      def message
+        errors.join("\n")
+      end
+
+      private
+
+      def add_error(error)
+        errors << error
+      end
+
+      def add_warning(warning)
+        warnings << warning
+      end
+
+      def validate_pod_directives
+        @podfile_dependency_cache.podfile_dependencies.each do |dependency|
+          validate_conflicting_external_sources!(dependency)
+        end
+      end
+
+      def validate_conflicting_external_sources!(dependency)
+        external_source = dependency.external_source
+        return false if external_source.nil?
+
+        available_downloaders = Downloader.downloader_class_by_key.keys
+        specified_downloaders = external_source.select { |key| available_downloaders.include?(key) }
+        if specified_downloaders.size > 1
+          add_error "The dependency `#{dependency.name}` specifies more than one download strategy(#{specified_downloaders.keys.join(',')})." \
+            'Only one is allowed'
+        end
+
+        pod_spec_or_path = external_source[:podspec].present? || external_source[:path].present?
+        if pod_spec_or_path && specified_downloaders.size > 0
+          add_error "The dependency `#{dependency.name}` specifies `podspec` or `path` in combination with other" \
+            ' download strategies. This is not allowed'
+        end
+      end
+
+      # Warns the user if the podfile is empty.
+      #
+      # @note   The workspace is created in any case and all the user projects
+      #         are added to it, however the projects are not integrated as
+      #         there is no way to discern between target definitions which are
+      #         empty and target definitions which just serve the purpose to
+      #         wrap other ones. This is not an issue because empty target
+      #         definitions generate empty libraries.
+      #
+      # @return [void]
+      #
+      def validate_dependencies_are_present!
+        if @podfile_dependency_cache.target_definition_list.all?(&:empty?)
+          add_warning 'The Podfile does not contain any dependencies.'
+        end
+      end
+
+      # Verifies that no dependencies in the Podfile will end up not being built
+      # at all. In other words, all dependencies _must_ belong to a non-abstract
+      # target, or be inherited by a target where `inheritance == complete`.
+      #
+      def validate_no_abstract_only_pods!
+        all_dependencies = @podfile_dependency_cache.podfile_dependencies
+        concrete_dependencies = @podfile_dependency_cache.target_definition_list.reject(&:abstract?).flat_map { |td| @podfile_dependency_cache.target_definition_dependencies(td) }
+        abstract_only_dependencies = all_dependencies - concrete_dependencies
+        abstract_only_dependencies.each do |dep|
+          add_error "The dependency `#{dep}` is not used in any concrete target."
+        end
+      end
+
+      def validate_no_duplicate_targets!
+        @podfile_dependency_cache.target_definition_list.group_by { |td| [td.name, td.user_project_path] }.
+          each do |(name, project), definitions|
+          next unless definitions.size > 1
+          error = "The target `#{name}` is declared twice"
+          error << " for the project `#{project}`" if project
+          add_error(error << '.')
+        end
+      end
+    end
+  end
+end

data/lib/pod/installer/post_install_hooks_context.rb

@@ -0,0 +1,107 @@
+module Pod
+  class DyInstaller
+    # Context object designed to be used with the HooksManager which describes
+    # the context of the installer.
+    #
+    class PostInstallHooksContext
+      # @return [String] The path to the sandbox root (`Pods` directory).
+      #
+      attr_accessor :sandbox_root
+
+      # @return [Project] The Pods Xcode project.
+      #
+      attr_accessor :pods_project
+
+      # @return [Sandbox] The Sandbox for the project.
+      #
+      attr_accessor :sandbox
+
+      # @return [Array<UmbrellaTargetDescription>] The list of
+      #         the CocoaPods umbrella targets generated by the installer.
+      #
+      attr_accessor :umbrella_targets
+
+      # @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.each do |umbrella|
+          desc = UmbrellaTargetDescription.new
+          desc.user_project = umbrella.user_project
+          desc.user_targets = umbrella.user_targets
+          desc.specs = umbrella.specs
+          desc.platform_name = umbrella.platform.name
+          desc.platform_deployment_target = umbrella.platform.deployment_target.to_s
+          desc.cocoapods_target_label = umbrella.label
+          umbrella_targets_descriptions << desc
+        end
+
+        result = new
+        result.sandbox_root = sandbox.root.to_s
+        result.pods_project = sandbox.project
+        result.sandbox = sandbox
+        result.umbrella_targets = umbrella_targets_descriptions
+        result
+      end
+
+      # Pure data class which describes and umbrella target.
+      #
+      class UmbrellaTargetDescription
+        # @return [Xcodeproj::Project] The user project into which this target
+        #         is integrated.
+        #
+        attr_accessor :user_project
+
+        # @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<PBXNativeTarget>]
+        #         The list of user targets integrated by this umbrella target.
+        #
+        attr_accessor :user_targets
+
+        # @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
+
+        # @return [Array<Specification>] The list of the
+        #         specifications of the target.
+        #
+        attr_accessor :specs
+
+        # @return [Symbol] The platform (either `:ios`, `:watchos`, `:tvos`, or `:osx`).
+        #
+        attr_accessor :platform_name
+
+        # @return [String] The deployment target.
+        #
+        attr_accessor :platform_deployment_target
+
+        # @return [String] The label for the target.
+        #
+        attr_accessor :cocoapods_target_label
+      end
+    end
+  end
+end