cocoapods-dykit 0.5.2 → 0.5.3

data/lib/pod/installer/analyzer/specs_state.rb

@@ -0,0 +1,84 @@
+require 'set'
+
+module Pod
+  class DyInstaller
+    class Analyzer
+      # This class represents the state of a collection of Pods.
+      #
+      # @note The names of the pods stored by this class are always the **root**
+      #       name of the specification.
+      #
+      # @note The motivation for this class is to ensure that the names of the
+      #       subspecs are added instead of the name of the Pods.
+      #
+      class SpecsState
+        # @return [Set<String>] the names of the pods that were added.
+        #
+        attr_reader :added
+
+        # @return [Set<String>] the names of the pods that were changed.
+        #
+        attr_reader :changed
+
+        # @return [Set<String>] the names of the pods that were deleted.
+        #
+        attr_reader :deleted
+
+        # @return [Set<String>] the names of the pods that were unchanged.
+        #
+        attr_reader :unchanged
+
+        # Initialize a new instance
+        #
+        # @param  [Hash{Symbol=>String}] pods_by_state
+        #         The name of the pods grouped by their state
+        #         (`:added`, `:removed`, `:changed` or `:unchanged`).
+        #
+        def initialize(pods_by_state = nil)
+          @added     = Set.new
+          @deleted   = Set.new
+          @changed   = Set.new
+          @unchanged = Set.new
+
+          if pods_by_state
+            {
+              :added => :added,
+              :changed => :changed,
+              :removed => :deleted,
+              :unchanged => :unchanged,
+            }.each do |state, spec_state|
+              Array(pods_by_state[state]).each do |name|
+                add_name(name, spec_state)
+              end
+            end
+          end
+        end
+
+        # Displays the state of each pod.
+        #
+        # @return [void]
+        #
+        def print
+          added    .sort.each { |pod| UI.message('A'.green + " #{pod}", '', 2) }
+          deleted  .sort.each { |pod| UI.message('R'.red + " #{pod}", '', 2) }
+          changed  .sort.each { |pod| UI.message('M'.yellow + " #{pod}", '', 2) }
+          unchanged.sort.each { |pod| UI.message('-' + " #{pod}", '', 2) }
+        end
+
+        # Adds the name of a Pod to the give state.
+        #
+        # @param  [String] name
+        #         the name of the Pod.
+        #
+        # @param  [Symbol] state
+        #         the state of the Pod.
+        #
+        # @return [void]
+        #
+        def add_name(name, state)
+          send(state) << Specification.root_name(name)
+        end
+      end
+    end
+  end
+end

data/lib/pod/installer/analyzer/target_inspection_result.rb

@@ -0,0 +1,45 @@
+module Pod
+  class DyInstaller
+    class Analyzer
+      class TargetInspectionResult
+        # @return [TargetDefinition] the target definition, whose project was
+        #         inspected
+        #
+        attr_accessor :target_definition
+
+        # @return [Pathname] the path of the user project that the
+        #         #target_definition should integrate
+        #
+        attr_accessor :project_path
+
+        # @return [Array<String>] the uuid of the user's targets
+        #
+        attr_accessor :project_target_uuids
+
+        # @return [Hash{String=>Symbol}] A hash representing the user build
+        #         configurations where each key corresponds to the name of a
+        #         configuration and its value to its type (`:debug` or
+        #         `:release`).
+        #
+        attr_accessor :build_configurations
+
+        # @return [Platform] the platform of the user targets
+        #
+        attr_accessor :platform
+
+        # @return [Array<String>] the architectures used by user's targets
+        #
+        attr_accessor :archs
+
+        # @return [Bool] whether frameworks are recommended for the integration
+        #         due to the presence of Swift source in the user's targets
+        #
+        attr_accessor :recommends_frameworks
+
+        # @return [Xcodeproj::Project] the user's Xcode project
+        #
+        attr_accessor :project
+      end
+    end
+  end
+end

data/lib/pod/installer/analyzer/target_inspector.rb

@@ -0,0 +1,254 @@
+require 'active_support/core_ext/array/conversions'
+
+module Pod
+  class DyInstaller
+    class Analyzer
+      class TargetInspector
+        PLATFORM_INFO_URL = 'https://guides.cocoapods.org/syntax/podfile.html#platform'.freeze
+
+        # @return [TargetDefinition] the target definition to inspect
+        #
+        attr_reader :target_definition
+
+        # @return [Pathname] the root of the CocoaPods installation where the
+        #         Podfile is located
+        #
+        attr_reader :installation_root
+
+        # Initialize a new instance
+        #
+        # @param [TargetDefinition] target_definition
+        #        @see #target_definition
+        #
+        # @param [Pathname] installation_root
+        #        @see #installation_root
+        #
+        def initialize(target_definition, installation_root)
+          @target_definition = target_definition
+          @installation_root = installation_root
+        end
+
+        # Inspect the #target_definition
+        #
+        # @raise If no `user_project` is set
+        #
+        # @return [TargetInspectionResult]
+        #
+        def compute_results(user_project)
+          raise ArgumentError, 'Cannot compute results without a user project set' unless user_project
+
+          targets = compute_targets(user_project)
+
+          result = TargetInspectionResult.new
+          result.target_definition = target_definition
+          result.project_path = user_project.path
+          result.project_target_uuids = targets.map(&:uuid)
+          result.build_configurations = compute_build_configurations(targets)
+          result.platform = compute_platform(targets)
+          result.archs = compute_archs(targets)
+          result.project = user_project
+          result.target_definition.swift_version = compute_swift_version_from_targets(targets)
+          result
+        end
+
+        # Returns the path of the user project that the #target_definition
+        # should integrate.
+        #
+        # @raise  If the project is implicit and there are multiple projects.
+        #
+        # @raise  If the path doesn't exits.
+        #
+        # @return [Pathname] the path of the user project.
+        #
+        def compute_project_path
+          if target_definition.user_project_path
+            path = installation_root + target_definition.user_project_path
+            path = "#{path}.xcodeproj" unless File.extname(path) == '.xcodeproj'
+            path = Pathname.new(path)
+            unless path.exist?
+              raise Informative, 'Unable to find the Xcode project ' \
+              "`#{path}` for the target `#{target_definition.label}`."
+            end
+          else
+            xcodeprojs = installation_root.children.select { |e| e.fnmatch('*.xcodeproj') }
+            if xcodeprojs.size == 1
+              path = xcodeprojs.first
+            else
+              raise Informative, 'Could not automatically select an Xcode project. ' \
+                "Specify one in your Podfile like so:\n\n" \
+                "    project 'path/to/Project.xcodeproj'\n"
+            end
+          end
+          path
+        end
+
+        #-----------------------------------------------------------------------#
+
+        private
+
+        # Returns a list of the targets from the project of #target_definition
+        # that needs to be integrated.
+        #
+        # @note   The method first looks if there is a target specified with
+        #         the `link_with` option of the {TargetDefinition}. Otherwise
+        #         it looks for the target that has the same name of the target
+        #         definition.  Finally if no target was found the first
+        #         encountered target is returned (it is assumed to be the one
+        #         to integrate in simple projects).
+        #
+        # @param  [Xcodeproj::Project] user_project
+        #         the user project
+        #
+        # @return [Array<PBXNativeTarget>]
+        #
+        def compute_targets(user_project)
+          native_targets = user_project.native_targets
+          target = native_targets.find { |t| t.name == target_definition.name.to_s }
+          unless target
+            found = native_targets.map { |t| "`#{t.name}`" }.to_sentence
+            raise Informative, "Unable to find a target named `#{target_definition.name}`, did find #{found}."
+          end
+          [target]
+        end
+
+        # @param  [Array<PBXNativeTarget] user_targets the user's targets of the project of
+        #         #target_definition which needs to be integrated
+        #
+        # @return [Hash{String=>Symbol}] A hash representing the user build
+        #         configurations where each key corresponds to the name of a
+        #         configuration and its value to its type (`:debug` or `:release`).
+        #
+        def compute_build_configurations(user_targets)
+          if user_targets
+            user_targets.flat_map { |t| t.build_configurations.map(&:name) }.each_with_object({}) do |name, hash|
+              hash[name] = name == 'Debug' ? :debug : :release
+            end.merge(target_definition.build_configurations || {})
+          else
+            target_definition.build_configurations || {}
+          end
+        end
+
+        # @param  [Array<PBXNativeTarget] user_targets the user's targets of the project of
+        #         #target_definition which needs to be integrated
+        #
+        # @return [Platform] The platform of the user's targets
+        #
+        # @note   This resolves to the lowest deployment target across the user
+        #         targets.
+        #
+        # @todo   Is assigning the platform to the target definition the best way
+        #         to go?
+        #
+        def compute_platform(user_targets)
+          return target_definition.platform if target_definition.platform
+          name = nil
+          deployment_target = nil
+
+          user_targets.each do |target|
+            name ||= target.platform_name
+            raise Informative, 'Targets with different platforms' unless name == target.platform_name
+            if !deployment_target || deployment_target > Version.new(target.deployment_target)
+              deployment_target = Version.new(target.deployment_target)
+            end
+          end
+
+          unless name
+            raise Informative,
+                  "Unable to determine the platform for the `#{target_definition.name}` target."
+          end
+
+          UI.warn "Automatically assigning platform `#{name}` with version `#{deployment_target}` " \
+            "on target `#{target_definition.name}` because no platform was specified. " \
+            "Please specify a platform for this target in your Podfile. See `#{PLATFORM_INFO_URL}`."
+
+          target_definition.set_platform(name, deployment_target)
+          Platform.new(name, deployment_target)
+        end
+
+        # Computes the architectures relevant for the user's targets.
+        #
+        # @param  [Array<PBXNativeTarget] user_targets the user's targets of the project of
+        #         #target_definition which needs to be integrated
+        #
+        # @return [Array<String>]
+        #
+        def compute_archs(user_targets)
+          user_targets.flat_map do |target|
+            Array(target.common_resolved_build_setting('ARCHS'))
+          end.compact.uniq.sort
+        end
+
+        # Checks if any of the targets for the {TargetDefinition} computed before
+        # by #compute_user_project_targets is recommended to be build as a framework
+        # due the presence of Swift source code in any of the source build phases.
+        #
+        # @param  [TargetDefinition] target_definition
+        #         the target definition
+        #
+        # @param  [Array<PBXNativeTarget>] native_targets
+        #         the targets which are checked for presence of Swift source code
+        #
+        # @return [Boolean] Whether the user project targets to integrate into
+        #         uses Swift
+        #
+        def compute_recommends_frameworks(target_definition, native_targets)
+          file_predicate = nil
+          file_predicate = proc do |file_ref|
+            if file_ref.respond_to?(:last_known_file_type)
+              file_ref.last_known_file_type == 'sourcecode.swift'
+            elsif file_ref.respond_to?(:files)
+              file_ref.files.any?(&file_predicate)
+            else
+              false
+            end
+          end
+          target_definition.platform.supports_dynamic_frameworks? || native_targets.any? do |target|
+            target.source_build_phase.files.any? do |build_file|
+              file_predicate.call(build_file.file_ref)
+            end
+          end
+        end
+
+        # Compute the Swift version for the target build configurations. If more
+        # than one Swift version is defined for a given target, then it will raise.
+        #
+        # @param  [Array<PBXNativeTarget>] targets
+        #         the targets that are checked for Swift versions.
+        #
+        # @return [String] the targets Swift version or nil
+        #
+        def compute_swift_version_from_targets(targets)
+          versions_to_targets = targets.inject({}) do |memo, target|
+            versions = target.resolved_build_setting('SWIFT_VERSION').values
+            versions.each do |version|
+              memo[version] = [] if memo[version].nil?
+              memo[version] << target.name unless memo[version].include? target.name
+            end
+            memo
+          end
+
+          case versions_to_targets.count
+          when 0
+            nil
+          when 1
+            versions_to_targets.keys.first
+          else
+            target_version_pairs = versions_to_targets.map do |version_names, target_names|
+              target_names.map { |target_name| [target_name, version_names] }
+            end
+
+            sorted_pairs = target_version_pairs.flat_map { |i| i }.sort_by do |target_name, version_name|
+              "#{target_name} #{version_name}"
+            end
+
+            formatted_output = sorted_pairs.map do |target, version_name|
+              "#{target}: Swift #{version_name}"
+            end.join("\n")
+
+            raise Informative, "There may only be up to 1 unique SWIFT_VERSION per target. Found target(s) with multiple Swift versions:\n#{formatted_output}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pod/installer/installation_options.rb

@@ -0,0 +1,158 @@
+require 'active_support/hash_with_indifferent_access'
+
+module Pod
+  class DyInstaller
+    # Represents the installation options the user can customize via a
+    # `Podfile`.
+    #
+    class InstallationOptions
+      # Parses installation options from a podfile.
+      #
+      # @param  [Podfile] podfile the podfile to parse installation options
+      #         from.
+      #
+      # @raise  [Informative] if `podfile` does not specify a `CocoaPods`
+      #         install.
+      #
+      # @return [Self]
+      #
+      def self.from_podfile(podfile)
+        name, options = podfile.installation_method
+        unless name.downcase == 'cocoapods'
+          raise Informative, "Currently need to specify a `cocoapods` install, you chose `#{name}`."
+        end
+        new(options)
+      end
+
+      # Defines a new installation option.
+      #
+      # @param  [#to_s] name the name of the option.
+      #
+      # @param  default the default value for the option.
+      #
+      # @param [Boolean] boolean whether the option has a boolean value.
+      #
+      # @return [void]
+      #
+      # @!macro [attach] option
+      #
+      #   @note this option defaults to $2.
+      #
+      #   @return the $1 $0 for installation.
+      #
+      def self.option(name, default, boolean: true)
+        name = name.to_s
+        raise ArgumentError, "The `#{name}` option is already defined" if defaults.key?(name)
+        defaults[name] = default
+        attr_accessor name
+        alias_method "#{name}?", name if boolean
+      end
+
+      # @return [Hash<Symbol,Object>] all known installation options and their
+      #         default values.
+      #
+      def self.defaults
+        @defaults ||= {}
+      end
+
+      # @return [Array<Symbol>] the names of all known installation options.
+      #
+      def self.all_options
+        defaults.keys
+      end
+
+      # Initializes the installation options with a hash of options from a
+      # Podfile.
+      #
+      # @param  [Hash] options the options to parse.
+      #
+      # @raise  [Informative] if `options` contains any unknown keys.
+      #
+      def initialize(options = {})
+        options = ActiveSupport::HashWithIndifferentAccess.new(options)
+        unknown_keys = options.keys - self.class.all_options.map(&:to_s)
+        raise Informative, "Unknown installation options: #{unknown_keys.to_sentence}." unless unknown_keys.empty?
+        self.class.defaults.each do |key, default|
+          value = options.fetch(key, default)
+          send("#{key}=", value)
+        end
+      end
+
+      # @param  [Boolean] include_defaults whether values that match the default
+      #         for their option should be included. Defaults to `true`.
+      #
+      # @return [Hash] the options, keyed by option name.
+      #
+      def to_h(include_defaults: true)
+        self.class.defaults.reduce(ActiveSupport::HashWithIndifferentAccess.new) do |hash, (option, default)|
+          value = send(option)
+          hash[option] = value if include_defaults || value != default
+          hash
+        end
+      end
+
+      def ==(other)
+        other.is_a?(self.class) && to_h == other.to_h
+      end
+
+      alias_method :eql, :==
+
+      def hash
+        to_h.hash
+      end
+
+      option :clean, true
+      option :deduplicate_targets, true
+      option :deterministic_uuids, true
+      option :integrate_targets, true
+      option :lock_pod_sources, true
+      option :warn_for_multiple_pod_sources, true
+      option :share_schemes_for_development_pods, false
+
+      module Mixin
+        module ClassMethods
+          # Delegates the creation of {#installation_options} to the `Podfile`
+          # returned by the given block.
+          #
+          # @param  blk a block that returns the `Podfile` to create
+          #         installation options from.
+          #
+          # @return [Void]
+          #
+          def delegate_installation_options(&blk)
+            define_method(:installation_options) do
+              @installation_options ||= InstallationOptions.from_podfile(instance_eval(&blk))
+            end
+          end
+
+          # Delegates the installation options attributes directly to
+          # {#installation_options}.
+          #
+          # @return [Void]
+          #
+          def delegate_installation_option_attributes!
+            define_method(:respond_to_missing?) do |name, *args|
+              installation_options.respond_to?(name, *args) || super
+            end
+
+            define_method(:method_missing) do |name, *args, &blk|
+              if installation_options.respond_to?(name)
+                installation_options.send(name, *args, &blk)
+              else
+                super
+              end
+            end
+          end
+        end
+
+        # @return [InstallationOptions] The installation options.
+        #
+        attr_accessor :installation_options
+
+        def self.included(mod)
+          mod.extend(ClassMethods)
+        end
+      end
+    end
+  end
+end