refinement 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56b3b7a2e07f1e8fa23b66b8315d00251b6e06bb95be13d8aa003c03da61a31a
-  data.tar.gz: ccee2542ae61bb6de2593ac355cf19caf7875d42ecfb19adc15905857472be39
+  metadata.gz: 80840c17572abec1f76bc0b66fadf26f82794ece72f8b8240d32adfae917dfeb
+  data.tar.gz: e947035d3a2ce3490aac22e3458cd83dcefd1af652ae5416e8a2b6cfca397be6
 SHA512:
-  metadata.gz: 2865c1e30ca1b080dba0c186dbcd1b3656b9aae9a5c793727738f34c3c6b110c53c266d0be46a28aa8f005794b8e48aca551cd37d92d63f08ac479bb6439c37b
-  data.tar.gz: 7b793a31d222ba4ac8621812c5c963289aed3b4aee10dc31818266dd25b92db85d3f1ea25bcb29af94472010d5fbbf356f60e049c1ba797186ef818159ce9ac1
+  metadata.gz: 4a5b71c0a0b027fd695cc400e5278dd1fa5fc0f3af17392678c0aa68752de45a6a2f5529c5a5c0ba39d8379d3436eee915c0c6a3a14802af7d6e80358d54be00
+  data.tar.gz: e79b94e4c7dc6fb58bdebaa272377ff4244255ea5335cd39a634c287c7d051f44f24f1536ac5cfbf7fd879619b5b884448f4bb08eab1cc7cb188f500e92054de

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Refinement Changes
 
+## 0.7.0 (2023-08-11)
+
+##### Breaking Changes
+
+Since the introduction of the class '**Refinement**' 
+[in Ruby 3.1](https://ruby-doc.org/core-3.1.0/Refinement.html), there is a naming 
+collision that requires this gem to be updated. 
+
+We have prefixed the `Refinement` module with `Sq::` to minimize the amount of 
+downstream changes required, in addition to maintaining the meaning and purpose 
+of the project.
+
+##### Enhancements
+
+* Update dependencies to modern versions
+
 ## 0.3.1 (2019-08-09)
 
 ##### Bug Fixes

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.0

data/exe/refine

@@ -2,6 +2,6 @@
 # frozen_string_literal: true
 
 require 'refinement'
-require 'refinement/cli'
+require 'sq/refinement/cli'
 
 Refinement::CLI.run(ARGV)

data/lib/cocoapods_plugin.rb

@@ -11,9 +11,9 @@ Pod::Installer
 
                raise Pod::Informative, 'Refinement requires a CocoaPods version >= 1.6.0' unless Gem::Version.create(Pod::VERSION) >= Gem::Version.create('1.6.0')
 
-               require 'refinement/cocoapods_post_install_writer'
+               require 'sq/refinement/cocoapods_post_install_writer'
                Pod::UI.message 'Writing refinement file' do
-                 Refinement::CocoaPodsPostInstallWriter.new(aggregate_targets, pod_targets, config, plugins['refinement']).write!
+                 Sq::Refinement::CocoaPodsPostInstallWriter.new(aggregate_targets, pod_targets, config, plugins['refinement']).write!
                end
              end
            end)

data/lib/refinement.rb

@@ -1,29 +1,8 @@
 # frozen_string_literal: true
 
-require 'xcodeproj'
-
-# Generates a list of Xcode targets to build & test as a result of a git diff.
-module Refinement
-  class Error < StandardError; end
-
-  # @visibility private
-  # @param enum [Enumerable]
-  # Enumerates through `enum`, and applied the given block to each element.
-  # If the result of calling the block is truthy, the first such result is returned.
-  # If no such result is found, `nil` is returned.
-  def self.map_find(enum)
-    enum.each do |elem|
-      transformed = yield elem
-      return transformed if transformed
-    end
-
-    nil
-  end
-
-  require 'refinement/version'
-
-  require 'refinement/analyzer'
-  require 'refinement/annotated_target'
-  require 'refinement/changeset'
-  require 'refinement/used_path'
-end
+require 'sq/refinement/version'
+require 'sq/refinement/setup'
+require 'sq/refinement/analyzer'
+require 'sq/refinement/annotated_target'
+require 'sq/refinement/changeset'
+require 'sq/refinement/used_path'

data/lib/sq/refinement/analyzer.rb

@@ -0,0 +1,396 @@
+# frozen_string_literal: true
+
+require 'xcodeproj'
+
+module Sq
+  module Refinement
+    # Analyzes changes in a repository
+    # and determines how those changes impact the targets in Xcode projects in the workspace.
+    class Analyzer
+      attr_reader :changesets, :workspace_path, :augmenting_paths_yaml_files
+      private :changesets, :workspace_path, :augmenting_paths_yaml_files
+
+      # Initializes an analyzer with changesets, projects, and augmenting paths.
+      # @param changesets [Array<Changeset>]
+      # @param workspace_path [Pathname] path to a root workspace or project,
+      #   must be `nil` if `projects` are specified explicitly
+      # @param projects [Array<Xcodeproj::Project>] projects to find targets in,
+      #   must not be specified if `workspace_path` is not `nil`
+      # @param augmenting_paths_yaml_files [Array<Pathname>] paths to YAML files that provide augmenting paths by target,
+      #   must be `nil` if `augmenting_paths_by_target` are specified explicitly
+      # @param augmenting_paths_by_target [Hash<String, Array>] arrays of hashes keyed by target name
+      #  (or '*' for all targets)
+      #  describing paths or globs that each target should be considered to be using,
+      #  must not be specified if `augmenting_paths_yaml_files` is not `nil`
+      #
+      # @raise [ArgumentError] when conflicting arguments are given
+      #
+      def initialize(changesets:, workspace_path:, augmenting_paths_yaml_files:, projects: nil, augmenting_paths_by_target: nil)
+        @changesets = changesets
+
+        raise ArgumentError, 'Can only specify one of workspace_path and projects' if workspace_path && projects
+
+        @workspace_path = workspace_path
+        @projects = projects
+
+        raise ArgumentError, 'Can only specify one of augmenting_paths_yaml_files and augmenting_paths_by_target' if augmenting_paths_yaml_files && augmenting_paths_by_target
+
+        @augmenting_paths_yaml_files = augmenting_paths_yaml_files
+        @augmenting_paths_by_target = augmenting_paths_by_target
+      end
+
+      # @return [Array<AnnotatedTarget>] targets from the projects annotated with their changes, based upon
+      #   the changeset
+      def annotate_targets!
+        @annotate_targets ||= annotated_targets
+      end
+
+      # @param scheme_path [Pathname] the absolute path to the scheme to be filtered
+      # @param change_level [Symbol] the change level at which a target must have changed in order
+      #  to remain in the scheme. defaults to `:full_transitive`
+      # @param filter_when_scheme_has_changed [Boolean] whether the scheme should be filtered
+      #   even when the changeset includes the scheme's path as changed.
+      #   Defaults to `false`
+      # @param log_changes [Boolean] whether modifications to the scheme are logged.
+      #   Defaults to `false`
+      # @param filter_scheme_for_build_action [:building, :testing]
+      #   The xcodebuild action the scheme is being filtered for. The currently supported values are
+      #   `:building` and `:testing`, with the only difference being `BuildActionEntry` are not
+      #   filtered out when building for testing, since test action macro expansion could
+      #   depend on a build entry being present.
+      # @param each_target [Proc] A proc called each time a target was determined to have changed or not.
+      # @return [Xcodeproj::XCScheme] a scheme whose unchanged targets have been removed.
+      def filtered_scheme(scheme_path:, filter_scheme_for_build_action:, change_level: :full_transitive, filter_when_scheme_has_changed: false, log_changes: false, each_target: nil)
+        scheme = Xcodeproj::XCScheme.new(scheme_path)
+
+        sections_to_filter =
+          case filter_scheme_for_build_action
+          when :building
+            %w[BuildActionEntry TestableReference]
+          when :testing
+            # don't want to filter out build action entries running
+            # xcodebuild build-for-testing / test, since the test action could have a macro expansion
+            # that depends upon one of the build targets.
+            %w[TestableReference]
+          else
+            raise ArgumentError,
+                  'The supported values for the `filter_scheme_for_build_action` parameter are: [:building, :testing]. ' \
+                  "Given: #{filter_scheme_for_build_action.inspect}."
+          end
+
+        if !filter_when_scheme_has_changed &&
+          UsedPath.new(path: Pathname(scheme_path), inclusion_reason: 'scheme').find_in_changesets(changesets)
+          return scheme
+        end
+
+        changes_by_suite_name = annotate_targets!
+                                .to_h { |at| [at.xcode_target.name, at.change_reason(level: change_level)] }
+
+        doc = scheme.doc
+
+        xpaths = sections_to_filter.map { |section| "//*/#{section}/BuildableReference" }
+        xpaths.each do |xpath|
+          doc.get_elements(xpath).to_a.each do |buildable_reference|
+            suite_name = buildable_reference.attributes['BlueprintName']
+            if (change_reason = changes_by_suite_name[suite_name])
+              puts "#{suite_name} changed because #{change_reason}" if log_changes
+              each_target&.call(type: :changed, target_name: suite_name, change_reason:)
+              next
+            end
+            puts "#{suite_name} did not change, removing from scheme" if log_changes
+            each_target&.call(type: :unchanged, target_name: suite_name, change_reason: nil)
+            buildable_reference.parent.remove
+          end
+        end
+
+        if filter_scheme_for_build_action == :testing
+          doc.get_elements('//*/BuildActionEntry/BuildableReference').to_a.each do |buildable_reference|
+            suite_name = buildable_reference.attributes['BlueprintName']
+            if (change_reason = changes_by_suite_name[suite_name])
+              puts "#{suite_name} changed because #{change_reason}" if log_changes
+              each_target&.call(type: :changed, target_name: suite_name, change_reason:)
+              next
+            end
+            puts "#{suite_name} did not change, setting to not build for testing" if log_changes
+            each_target&.call(type: :unchanged, target_name: suite_name, change_reason: nil)
+            buildable_reference.parent.attributes['buildForTesting'] = 'NO'
+          end
+        end
+
+        scheme
+      end
+
+      # @return [String] a string suitable for user display that explains target changes
+      # @param include_unchanged_targets [Boolean] whether targets that have not changed should also be displayed
+      # @param change_level [Symbol] the change level used for computing whether a target has changed
+      def format_changes(include_unchanged_targets: false, change_level: :full_transitive)
+        annotate_targets!.group_by { |target| target.xcode_target.project.path.to_s }.sort_by(&:first)
+                        .map do |project, annotated_targets|
+          changes = annotated_targets.sort_by { |annotated_target| annotated_target.xcode_target.name }
+                                    .map do |annotated_target|
+            change_reason = annotated_target.change_reason(level: change_level)
+            next if !include_unchanged_targets && !change_reason
+
+            change_reason ||= 'did not change'
+            "\t#{annotated_target.xcode_target}: #{change_reason}"
+          end.compact
+          "#{project}:\n#{changes.join("\n")}" unless changes.empty?
+        end.compact.join("\n")
+      end
+
+      private
+
+      # @return [Array<Xcodeproj::Project>]
+      def projects
+        @projects ||= find_projects(workspace_path)
+      end
+
+      # @return [Hash<String,Array<Hash>>]
+      def augmenting_paths_by_target
+        @augmenting_paths_by_target ||= begin
+          require 'yaml'
+          augmenting_paths_yaml_files.reduce({}) do |augmenting_paths_by_target, yaml_file|
+            yaml_file = Pathname(yaml_file).expand_path(changesets.first.repository)
+            yaml = YAML.safe_load(yaml_file.read)
+            augmenting_paths_by_target.merge(yaml) do |_target_name, prior_paths, new_paths|
+              prior_paths + new_paths
+            end
+          end
+        end
+      end
+
+      # @return [Array<AnnotatedTarget>] targets in the given list of Xcode projects,
+      #   annotated according to the given changeset
+      def annotated_targets
+        workspace_modification = find_workspace_modification_in_changesets
+        project_changes = projects.to_h do |project|
+          [project, find_project_modification_in_changesets(project:) || workspace_modification]
+        end
+
+        require 'tsort'
+        targets = projects.flat_map(&:targets)
+        targets_by_uuid = targets.to_h { |t| [t.uuid, t] }
+        targets_by_name = targets.to_h { |t| [t.name, t] }
+        targets_by_product_name = targets.each_with_object({}) do |t, h|
+          next unless t.respond_to?(:product_reference)
+          h[File.basename(t.product_reference.path)] = t
+          h[File.basename(t.product_reference.name)] = t if t.product_reference.name
+        end
+
+        find_dep = ->(td) { targets_by_uuid[td.native_target_uuid] || targets_by_name[td.name] }
+        target_deps = lambda do |target|
+          target_dependencies = []
+          target.dependencies.each do |td|
+            target_dependencies << find_dep[td]
+          end
+
+          # TODO: also resolve OTHER_LDFLAGS?
+          # yay auto-linking
+          if (phase = target.frameworks_build_phases)
+            phase.files_references.each do |fr|
+              if (dt = fr&.path && targets_by_product_name[File.basename(fr.path)])
+                target_dependencies << dt
+              end
+            end
+          end
+
+          target_dependencies
+        end
+
+        targets = TSort.tsort(
+          ->(&b) { targets.each(&b) },
+          ->(target, &b) { target_deps[target].each(&b) }
+        )
+
+        targets.each_with_object({}) do |target, h|
+          change_reason = project_changes[target.project] || find_target_modification_in_changesets(target:)
+
+          h[target] = AnnotatedTarget.new(
+            target:,
+            dependencies: target_deps[target].map { |td| h.fetch(td) },
+            change_reason:
+          )
+        end.values
+      end
+
+      # @return [Array<Xcodeproj::Project>] the projects found by walking the
+      #  project/workspace at the given path
+      # @param  path [Pathname] path to a `.xcodeproj` or `.xcworkspace` on disk
+      def find_projects(path)
+        seen = {}
+        find_projects_cached = lambda do |project_path|
+          return if seen.key?(project_path)
+
+          case File.extname(project_path)
+          when '.xcodeproj'
+            project = Xcodeproj::Project.open(project_path)
+            seen[project_path] = project
+            project.files.each do |file_reference|
+              next unless File.extname(file_reference.path) == '.xcodeproj'
+
+              find_projects_cached[file_reference.real_path]
+            end
+          when '.xcworkspace'
+            workspace = Xcodeproj::Workspace.new_from_xcworkspace(project_path)
+            workspace.file_references.each do |file_reference|
+              next unless File.extname(file_reference.path) == '.xcodeproj'
+
+              find_projects_cached[file_reference.absolute_path(File.dirname(project_path))]
+            end
+          else
+            raise ArgumentError, "Unknown path #{project_path.inspect}"
+          end
+        end
+        find_projects_cached[path]
+
+        seen.values
+      end
+
+      # @yieldparam used_path [UsedPath] an absolute path that belongs to the given target
+      # @return [Void]
+      # @param target [Xcodeproj::Project::AbstractTarget]
+      def target_each_file_path(target:)
+        return enum_for(__method__, target:) unless block_given?
+
+        expand_build_settings = lambda do |s|
+          return [s] unless s =~ /\$(?:\{([_a-zA-Z0-0]+?)\}|\(([_a-zA-Z0-0]+?)\))/
+
+          match, key = Regexp.last_match.values_at(0, 1, 2).compact
+          substitutions = target.resolved_build_setting(key, true).values.compact.uniq
+          substitutions.flat_map do |sub|
+            expand_build_settings[s.gsub(match, sub)]
+          end
+        end
+
+        target.build_configuration_list.build_configurations.each do |build_configuration|
+          ref = build_configuration.base_configuration_reference
+          next unless ref
+
+          yield UsedPath.new(path: ref.real_path,
+                            inclusion_reason: "base configuration reference for #{build_configuration}")
+        end
+
+        target.build_phases.each do |build_phase|
+          build_phase.files_references.each do |fr|
+            next unless fr
+
+            yield UsedPath.new(path: fr.real_path,
+                              inclusion_reason: "#{build_phase.display_name.downcase.chomp('s')} file")
+          end
+        end
+
+        target.shell_script_build_phases.each do |shell_script_build_phase|
+          %w[input_file_list_paths output_file_list_paths input_paths output_paths].each do |method|
+            next unless (paths = shell_script_build_phase.public_send(method))
+
+            file_type = method.tr('_', ' ').chomp('s')
+            paths.each do |config_path|
+              next unless config_path
+
+              expand_build_settings[config_path].each do |path|
+                path = Pathname(path).expand_path(target.project.project_dir)
+                yield UsedPath.new(path:,
+                                  inclusion_reason: "#{shell_script_build_phase.name} build phase #{file_type}")
+              end
+            end
+          end
+        end
+
+        %w[INFOPLIST_FILE HEADER_SEARCH_PATHS FRAMEWORK_SEARCH_PATHS USER_HEADER_SEARCH_PATHS].each do |build_setting|
+          target.resolved_build_setting(build_setting, true).each_value do |paths|
+            Array(paths).each do |path|
+              next unless path
+
+              path = Pathname(path).expand_path(target.project.project_dir)
+              yield UsedPath.new(path:, inclusion_reason: "#{build_setting} value")
+            end
+          end
+        end
+      end
+
+      # @return [FileModification,Nil] a modification to a file that is used by the given target, or `nil`
+      #   if none if found
+      # @param target [Xcodeproj::Project::AbstractTarget]
+      def find_target_modification_in_changesets(target:)
+        augmenting_paths = used_paths_from_augmenting_paths_by_target[target.name]
+        find_in_changesets = ->(path) { path.find_in_changesets(changesets) }
+        Sq::Refinement.map_find(augmenting_paths, &find_in_changesets) ||
+          Sq::Refinement.map_find(target_each_file_path(target:), &find_in_changesets)
+      end
+
+      # @yieldparam used_path [UsedPath] an absolute path that belongs to the given project
+      # @return [Void]
+      # @param project [Xcodeproj::Project]
+      def project_each_file_path(project:)
+        return enum_for(__method__, project:) unless block_given?
+
+        yield UsedPath.new(path: project.path, inclusion_reason: 'project directory')
+
+        project.root_object.build_configuration_list.build_configurations.each do |build_configuration|
+          ref = build_configuration.base_configuration_reference
+          next unless ref
+
+          yield UsedPath.new(path: ref.real_path,
+                            inclusion_reason: "base configuration reference for #{build_configuration}")
+        end
+      end
+
+      # # @return [FileModification,Nil] a modification to a file that is directly used by the given project, or `nil`
+      #   if none if found
+      # @note This method does not take into account whatever file paths targets in the project may reference
+      # @param project [Xcodeproj::Project]
+      def find_project_modification_in_changesets(project:)
+        Sq::Refinement.map_find(project_each_file_path(project:)) do |path|
+          path.find_in_changesets(changesets)
+        end
+      end
+
+      # @return [FileModification,Nil] a modification to the workspace itself, or `nil`
+      #   if none if found
+      # @note This method does not take into account whatever file paths projects or
+      #   targets in the workspace path may reference
+      def find_workspace_modification_in_changesets
+        return unless workspace_path
+
+        UsedPath.new(path: workspace_path, inclusion_reason: 'workspace directory')
+                .find_in_changesets(changesets)
+      end
+
+      # @return [Hash<String,UsedPath>]
+      def used_paths_from_augmenting_paths_by_target
+        @used_paths_from_augmenting_paths_by_target ||= begin
+          repo = changesets.first.repository
+          used_paths_from_augmenting_paths_by_target =
+            augmenting_paths_by_target.transform_values do |augmenting_paths|
+              augmenting_paths.map do |augmenting_path|
+                case augmenting_path.keys.sort
+                when %w[inclusion_reason path], %w[inclusion_reason path yaml_keypath]
+                  kwargs = {
+                    path: Pathname(augmenting_path['path']).expand_path(repo),
+                    inclusion_reason: augmenting_path['inclusion_reason']
+                  }
+                  if augmenting_path.key?('yaml_keypath')
+                    kwargs[:yaml_keypath] = augmenting_path['yaml_keypath']
+                    UsedPath::YAML.new(**kwargs)
+                  else
+                    UsedPath.new(**kwargs)
+                  end
+                when %w[glob inclusion_reason]
+                  UsedGlob.new(glob: File.expand_path(augmenting_path['glob'], repo),
+                              inclusion_reason: augmenting_path['inclusion_reason'])
+                else
+                  raise ArgumentError,
+                        "unhandled set of keys in augmenting paths dictionary entry: #{augmenting_path.keys.inspect}"
+                end
+              end
+            end
+          wildcard_paths = used_paths_from_augmenting_paths_by_target.fetch('*', [])
+
+          Hash.new do |h, k|
+            h[k] = wildcard_paths + used_paths_from_augmenting_paths_by_target.fetch(k, [])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sq/refinement/annotated_target.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'xcodeproj'
+
+module Sq
+  module Refinement
+    # A target, annotated with any changes
+    class AnnotatedTarget
+      # @return [Xcodeproj::Project::AbstactTarget] the target in an Xcode project
+      attr_reader :xcode_target
+
+      # @return [String,Nil] the reason why the target has changed, or `nil` if it has not changed
+      attr_reader :direct_change_reason
+      private :direct_change_reason
+
+      def initialize(target:, change_reason:, dependencies: [])
+        @xcode_target = target
+        @direct_change_reason = change_reason
+        @dependencies = dependencies
+        dependencies.each do |dependency|
+          dependency.depended_upon_by << self
+        end
+        @depended_upon_by = []
+      end
+
+      # @visibility private
+      def to_s
+        xcode_target.to_s
+      end
+
+      CHANGE_LEVELS = %i[
+        itself
+        at_most_n_away
+        full_transitive
+      ].freeze
+      private_constant :CHANGE_LEVELS
+
+      # @return [Boolean] whether the target has changed, at the given change level
+      # @param level [Symbol,(:at_most_n_away,Integer)] change level, e.g. :itself, :at_most_n_away, :full_transitive
+      def change_reason(level:)
+        @change_reason ||= {}
+        # need to use this form for memoization, as opposed to ||=,
+        # since this will (often) be nil and it makes a significant performance difference
+        return @change_reason[level] if @change_reason.key?(level)
+
+        @change_reason[level] =
+          case level
+          when :itself
+            direct_change_reason
+          when :full_transitive
+            direct_change_reason || Sq::Refinement.map_find(dependencies) do |dependency|
+              next unless (dependency_change_reason = dependency.change_reason(level:))
+
+              "dependency #{dependency} changed because #{dependency_change_reason}"
+            end
+          when proc { |symbol, int| (symbol == :at_most_n_away) && int.is_a?(Integer) }
+            distance_from_target = level.last
+            raise ArgumentError, "level must be positive, not #{distance_from_target}" if distance_from_target.negative?
+
+            change_reason = direct_change_reason
+            if distance_from_target.positive?
+              change_reason ||= Sq::Refinement.map_find(dependencies) do |dependency|
+                unless (dependency_change_reason = dependency.change_reason(level: [:at_most_n_away, level.last.pred]))
+                  next
+                end
+
+                "dependency #{dependency} changed because #{dependency_change_reason}"
+              end
+            end
+            change_reason
+          else
+            raise Error, "No known change level #{level.inspect}, only #{CHANGE_LEVELS.inspect} are known"
+          end
+      end
+
+      # @return [Array<AnnotatedTarget>] the list of annotated targets this target depends upon
+      attr_reader :dependencies
+      # @return [Array<AnnotatedTarget>] the list of annotated targets that depend upon this target
+      attr_reader :depended_upon_by
+    end
+  end
+end