refinement 0.2.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cde77a0d0d41bfeebca40808c3053d38d9eff4ec7d09d82a9f29d8f9f3bed31b
-  data.tar.gz: 6d38e9cb3025c970513d80b18074e37eec4ad8edfec278c8c8eab9a4258310e8
+  metadata.gz: 3f99f7e0933bae18ddd8c4f6fbd14f3e182f6233a1244b1418ccf678b5c1e471
+  data.tar.gz: 451abebd764ff651e9489095bca0ce0fc4043965e81e962ca49df68e90341367
 SHA512:
-  metadata.gz: a878d3fc86e0c733da2fcbddc9da9a869ef56e035172e17b8ea63ada49cde2cceb4ead3c5d6b1024343ebd809368f096a77d50cd6464233c87e6d724cac33127
-  data.tar.gz: '09bd2a181cc8646d2f5a352a5b70bcf41681432a31588ee30502e40416f2641158fcaf59a3a8ad99b52abac383f1494f1804aaacaa97e9e286886fc4edc8afbb'
+  metadata.gz: 6f8348156cedae83212560898d95229be93c592347e052a82bd5a1bd3b13d76a7298703976f4e93799cd8d38543316409462d9c6ef564e1680bdde746bf084aa
+  data.tar.gz: 1109c4b167045b0a2ac2ba45aa036ec6b3d4aacf06726be393c68fe072ee49479d61d41c89a6a29ad927b1e419a3e7932f82acba25ccf02fe4a08efc0a8aaae6

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Refinement Changes
 
+## 0.3.1 (2019-08-09)
+
+##### Bug Fixes
+
+* Take into consideration product reference names when refinining.
+
+
+## 0.3.0 (2019-08-09)
+
+##### Bug Fixes
+
+* Multiple YAML used keys paths for the same file will no longer cause the YAML
+  to be parsed multiple times.  
+
+
 ## 0.2.2 (2019-04-08)
 
 No changes.  

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.5.0

data/exe/refine

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'refinement'
 require 'refinement/cli'

data/lib/cocoapods_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cocoapods'
 
 Pod::Installer
@@ -7,9 +9,7 @@ Pod::Installer
 
                return unless plugins.key?('refinement')
 
-               unless Gem::Version.create(Pod::VERSION) >= Gem::Version.create('1.6.0')
-                 raise Pod::Informative, 'Refinement requires a CocoaPods version >= 1.6.0'
-               end
+               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'
                Pod::UI.message 'Writing refinement file' do

data/lib/refinement.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'xcodeproj'
 
 # Generates a list of Xcode targets to build & test as a result of a git diff.

data/lib/refinement/analyzer.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 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 :changeset, :workspace_path, :augmenting_paths_yaml_files
-    private :changeset, :workspace_path, :augmenting_paths_yaml_files
+    attr_reader :changesets, :workspace_path, :augmenting_paths_yaml_files
+    private :changesets, :workspace_path, :augmenting_paths_yaml_files
 
-    # Initializes an analyzer with a changeset, projects, and augmenting paths.
-    # @param changeset [Changeset]
+    # 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,
@@ -20,18 +22,18 @@ module Refinement
     #
     # @raise [ArgumentError] when conflicting arguments are given
     #
-    def initialize(changeset:, workspace_path:, projects: nil,
+    def initialize(changesets:, workspace_path:, projects: nil,
                    augmenting_paths_yaml_files:, augmenting_paths_by_target: nil)
 
-      @changeset = changeset
+      @changesets = changesets
 
       raise ArgumentError, 'Can only specify one of workspace_path and projects' if workspace_path && projects
+
       @workspace_path = workspace_path
       @projects = projects
 
-      if augmenting_paths_yaml_files && augmenting_paths_by_target
-        raise ArgumentError, 'Can only specify one of augmenting_paths_yaml_files and augmenting_paths_by_target'
-      end
+      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
@@ -75,25 +77,38 @@ module Refinement
                 "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_changeset(changeset)
+      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 = Hash[annotate_targets!
+                              .map { |at| [at.xcode_target.name, at.change_reason(level: change_level)] }]
 
-        changes_by_suite_name = Hash[annotate_targets!
-                                .map { |at| [at.xcode_target.name, at.change_reason(level: change_level)] }]
+      doc = scheme.doc
 
-        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
+            next
+          end
+          puts "#{suite_name} did not change, removing from scheme" if log_changes
+          buildable_reference.parent.remove
+        end
+      end
 
-        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
-              next
-            end
-            puts "#{suite_name} did not change, removing from scheme" if log_changes
-            buildable_reference.parent.remove
+      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
+            next
           end
+          puts "#{suite_name} did not change, setting to not build for testing" if log_changes
+          buildable_reference.parent.attributes['buildForTesting'] = 'NO'
         end
       end
 
@@ -110,6 +125,7 @@ module Refinement
                                    .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
@@ -129,7 +145,7 @@ module Refinement
       @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(changeset.repository)
+          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
@@ -141,19 +157,20 @@ module Refinement
     # @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_changeset
+      workspace_modification = find_workspace_modification_in_changesets
       project_changes = Hash[projects.map do |project|
-        [project, find_project_modification_in_changeset(project: project) || workspace_modification]
+        [project, find_project_modification_in_changesets(project: project) || workspace_modification]
       end]
 
       require 'tsort'
       targets = projects.flat_map(&:targets)
       targets_by_uuid = Hash[targets.map { |t| [t.uuid, t] }]
       targets_by_name = Hash[targets.map { |t| [t.name, t] }]
-      targets_by_product_name = Hash[targets.map do |t|
+      targets_by_product_name = targets.each_with_object({}) do |t, h|
         next unless t.respond_to?(:product_reference)
-        [File.basename(t.product_reference.path), t]
-      end.compact]
+        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|
@@ -166,7 +183,7 @@ module Refinement
         # yay auto-linking
         if (phase = target.frameworks_build_phases)
           phase.files_references.each do |fr|
-            if (dt = fr && fr.path && targets_by_product_name[File.basename(fr.path)])
+            if (dt = fr&.path && targets_by_product_name[File.basename(fr.path)])
               target_dependencies << dt
             end
           end
@@ -181,7 +198,7 @@ module Refinement
       )
 
       targets.each_with_object({}) do |target, h|
-        change_reason = project_changes[target.project] || find_target_modification_in_changeset(target: target)
+        change_reason = project_changes[target.project] || find_target_modification_in_changesets(target: target)
 
         h[target] = AnnotatedTarget.new(
           target: target,
@@ -232,6 +249,7 @@ module Refinement
 
       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|
@@ -242,6 +260,7 @@ module Refinement
       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
@@ -249,6 +268,7 @@ module Refinement
       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
@@ -257,9 +277,11 @@ module Refinement
       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: path,
@@ -273,6 +295,7 @@ module Refinement
         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: path, inclusion_reason: "#{build_setting} value")
           end
@@ -283,11 +306,11 @@ module Refinement
     # @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_changeset(target:)
+    def find_target_modification_in_changesets(target:)
       augmenting_paths = used_paths_from_augmenting_paths_by_target[target.name]
-      find_in_changeset = ->(path) { path.find_in_changeset(changeset) }
-      Refinement.map_find(augmenting_paths, &find_in_changeset) ||
-        Refinement.map_find(target_each_file_path(target: target), &find_in_changeset)
+      find_in_changesets = ->(path) { path.find_in_changesets(changesets) }
+      Refinement.map_find(augmenting_paths, &find_in_changesets) ||
+        Refinement.map_find(target_each_file_path(target: target), &find_in_changesets)
     end
 
     # @yieldparam used_path [UsedPath] an absolute path that belongs to the given project
@@ -301,6 +324,7 @@ module Refinement
       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
@@ -310,9 +334,9 @@ module Refinement
     #   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_changeset(project:)
+    def find_project_modification_in_changesets(project:)
       Refinement.map_find(project_each_file_path(project: project)) do |path|
-        path.find_in_changeset(changeset)
+        path.find_in_changesets(changesets)
       end
     end
 
@@ -320,17 +344,17 @@ module Refinement
     #   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_changeset
+    def find_workspace_modification_in_changesets
       return unless workspace_path
 
       UsedPath.new(path: workspace_path, inclusion_reason: 'workspace directory')
-              .find_in_changeset(changeset)
+              .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 = changeset.repository
+        repo = changesets.first.repository
         used_paths_from_augmenting_paths_by_target =
           augmenting_paths_by_target.each_with_object({}) do |(name, augmenting_paths), h|
             h[name] = augmenting_paths.map do |augmenting_path|

data/lib/refinement/annotated_target.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Refinement
   # A target, annotated with any changes
   class AnnotatedTarget
@@ -45,15 +47,20 @@ module Refinement
         when :full_transitive
           direct_change_reason || Refinement.map_find(dependencies) do |dependency|
             next unless (dependency_change_reason = dependency.change_reason(level: 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 < 0
+          raise ArgumentError, "level must be positive, not #{distance_from_target}" if distance_from_target.negative?
+
           change_reason = direct_change_reason
-          if distance_from_target > 0
+          if distance_from_target.positive?
             change_reason ||= Refinement.map_find(dependencies) do |dependency|
-              next unless (dependency_change_reason = dependency.change_reason(level: [:at_most_n_away, level.last.pred]))
+              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

data/lib/refinement/changeset.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cocoapods/executable'
 require 'set'
 
@@ -16,12 +18,15 @@ module Refinement
     attr_reader :modified_paths
     # @return [Hash<Pathname,FileModification>] modifications keyed by relative path
     attr_reader :modified_absolute_paths
+    # @return [String] a desciption of the changeset
+    attr_reader :description
 
     private :modifications, :modified_paths, :modified_absolute_paths
 
-    def initialize(repository:, modifications:)
+    def initialize(repository:, modifications:, description: nil)
       @repository = repository
       @modifications = self.class.add_directories(modifications).uniq.freeze
+      @description = description
 
       @modified_paths = {}
       @modifications
@@ -43,6 +48,7 @@ module Refinement
       dirs = Set.new
       add = lambda { |path|
         break unless dirs.add?(path)
+
         add[path.dirname]
       }
       modifications.each do |mod|
@@ -124,8 +130,10 @@ module Refinement
     # @param keypath [Array]
     def find_modification_for_yaml_keypath(absolute_path:, keypath:)
       return unless (file_modification = find_modification_for_path(absolute_path: absolute_path))
+
       diff = file_modification.yaml_diff(keypath)
       return unless diff
+
       [file_modification, diff]
     end
 
@@ -140,18 +148,18 @@ module Refinement
       diff = git!('diff', '--raw', '-z', merge_base, chdir: repository)
       modifications = parse_raw_diff(diff, repository: repository, base_revision: merge_base).freeze
 
-      new(repository: repository, modifications: modifications)
+      new(repository: repository, modifications: modifications, description: "since #{base_revision}")
     end
 
     CHANGE_TYPES = {
-      :'was added' => 'A',
-      :'was copied' => 'C',
-      :'was deleted' => 'D',
-      :'was modified' => 'M',
-      :'was renamed' => 'R',
-      :'changed type' => 'T',
-      :'is unmerged' => 'U',
-      :'changed in an unknown way' => 'X'
+      'was added': 'A',
+      'was copied': 'C',
+      'was deleted': 'D',
+      'was modified': 'M',
+      'was renamed': 'R',
+      'changed type': 'T',
+      'is unmerged': 'U',
+      'changed in an unknown way': 'X'
     }.freeze
     private_constant :CHANGE_TYPES
 
@@ -206,9 +214,8 @@ module Refinement
     def self.git!(command, *args, chdir:)
       require 'open3'
       out, err, status = Open3.capture3('git', command, *args, chdir: chdir.to_s)
-      unless status.success?
-        raise GitError, "Running git #{command} failed (#{status.to_s.gsub(/pid \d+\s*/, '')}):\n\n#{err}"
-      end
+      raise GitError, "Running git #{command} failed (#{status.to_s.gsub(/pid \d+\s*/, '')}):\n\n#{err}" unless status.success?
+
       out
     end
     private_class_method :git!

data/lib/refinement/changeset/file_modification.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Refinement
   class Changeset
     # Represents a modification to a single file or directory on disk
@@ -51,12 +53,14 @@ module Refinement
       # @visibility private
       def ==(other)
         return unless other.is_a?(FileModification)
+
         (path == other.path) && (type == other.type) && prior_path == other.prior_path
       end
 
       # @visibility private
       def eql?(other)
         return unless other.is_a?(FileModification)
+
         path.eql?(other.path) && type.eql?(other.type) && prior_path.eql?(other.prior_path)
       end
 
@@ -68,9 +72,12 @@ module Refinement
       def yaml_diff(keypath)
         require 'yaml'
 
-        dig_yaml = lambda do |yaml|
+        @cached_yaml ||= {}
+
+        dig_yaml = lambda do |yaml, path|
           return yaml if DOES_NOT_EXIST == yaml
-          object = YAML.safe_load(yaml, [Symbol])
+
+          object = @cached_yaml[path] ||= YAML.safe_load(yaml, [Symbol])
           if keypath.empty?
             object
           elsif object.respond_to?(:dig)
@@ -82,8 +89,8 @@ module Refinement
           end
         end
 
-        prior = dig_yaml[prior_contents]
-        current = dig_yaml[contents]
+        prior = dig_yaml[prior_contents, :prior]
+        current = dig_yaml[contents, :current]
 
         require 'xcodeproj/differ'
 

data/lib/refinement/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'claide'
 
 module Refinement
@@ -48,6 +50,7 @@ module Refinement
       puts analyzer.format_changes if @print_changes
 
       return unless @scheme
+
       analyzer.filtered_scheme(scheme_path: @scheme, log_changes: @print_scheme_changes, filter_scheme_for_build_action: @filter_scheme_for_build_action)
               .save_as(@scheme.gsub(%r{\.(xcodeproj|xcworkspace)/.+}, '.\1'), File.basename(@scheme, '.xcscheme'), true)
     end

data/lib/refinement/cocoapods_post_install_writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Refinement
   # Called after CocoaPods installation to write an augmenting file that
   # takes into account changes to Pod configuration,
@@ -101,6 +103,10 @@ module Refinement
             inclusion_reason: 'CocoaPods lockfile',
             yaml_keypath: ['SPEC CHECKSUMS', pod_target.pod_name] }
         ]
+        if pod_target.sandbox.predownloaded?(pod_target.pod_name)
+          paths << { path: 'Podfile.lock', inclusion_reason: 'Dependency external source', yaml_keypath: ['EXTERNAL SOURCES', pod_target.pod_name] }
+          paths << { path: 'Podfile.lock', inclusion_reason: 'Pod checkout options', yaml_keypath: ['CHECKOUT OPTIONS', pod_target.pod_name] }
+        end
         spec_paths.each { |path| paths << { path: path, inclusion_reason: 'podspec' } }
 
         Pod::Validator::FILE_PATTERNS.each do |pattern|

data/lib/refinement/used_path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Refinement
   # Represents a path that some target depends upon.
   class UsedPath
@@ -17,7 +19,17 @@ module Refinement
     # @return [Nil, String] If the path has been modified, a string explaining the modification
     # @param changeset [Changeset] the changeset to search for a modification to this path
     def find_in_changeset(changeset)
-      add_reason changeset.find_modification_for_path(absolute_path: path)
+      add_reason changeset.find_modification_for_path(absolute_path: path), changeset: changeset
+    end
+
+    # @return [Nil, String] If the path has been modified, a string explaining the modification
+    # @param changesets [Array<Changeset>] the changesets to search for a modification to this path
+    def find_in_changesets(changesets)
+      raise ArgumentError, 'Must provide at least one changeset' if changesets.empty?
+
+      changesets.reduce(true) do |explanation, changeset|
+        explanation && find_in_changeset(changeset)
+      end
     end
 
     # @return [String]
@@ -31,10 +43,22 @@ module Refinement
     # @return [Nil, String] A string suitable for user display that explains
     #   why the given modification means a target is modified
     # @param modification [Nil, FileModification]
-    def add_reason(modification)
+    # @param changeset [Changeset]
+    def add_reason(modification, changeset:)
       return unless modification
 
-      "#{modification.path} (#{inclusion_reason}) #{modification.type}"
+      add_changeset_description "#{modification.path} (#{inclusion_reason}) #{modification.type}", changeset: changeset
+    end
+
+    # @return [String] A string suitable for user display that explains
+    #   why the given modification means a target is modified, including the description
+    #   of the changeset that contains the modification
+    # @param description [String]
+    # @param changeset [Nil, Changeset]
+    def add_changeset_description(description, changeset:)
+      return description unless changeset&.description
+
+      description + " (#{changeset.description})"
     end
 
     # Represents a path to a YAML file that some target depends upon,
@@ -52,7 +76,7 @@ module Refinement
       # (see UsedPath#find_in_changeset)
       def find_in_changeset(changeset)
         modification, _yaml_diff = changeset.find_modification_for_yaml_keypath(absolute_path: path, keypath: yaml_keypath)
-        add_reason modification
+        add_reason modification, changeset: changeset
       end
 
       # (see UsedPath#to_s)
@@ -63,7 +87,7 @@ module Refinement
       private
 
       # (see UsedPath#add_reason)
-      def add_reason(modification)
+      def add_reason(modification, changeset:)
         return unless modification
 
         keypath_string =
@@ -72,7 +96,7 @@ module Refinement
           else
             ' @ ' + yaml_keypath.map { |path| path.to_s =~ /\A[a-zA-Z0-9_]+\z/ ? path : path.inspect }.join('.')
           end
-        "#{modification.path}#{keypath_string} (#{inclusion_reason}) #{modification.type}"
+        add_changeset_description "#{modification.path}#{keypath_string} (#{inclusion_reason}) #{modification.type}", changeset: changeset
       end
     end
   end
@@ -94,7 +118,16 @@ module Refinement
 
     # (see UsedPath#find_in_changeset)
     def find_in_changeset(changeset)
-      add_reason changeset.find_modification_for_glob(absolute_glob: glob)
+      add_reason changeset.find_modification_for_glob(absolute_glob: glob), changeset: changeset
+    end
+
+    # (see UsedPath#find_in_changesets)
+    def find_in_changesets(changesets)
+      raise ArgumentError, 'Must provide at least one changeset' if changesets.empty?
+
+      changesets.reduce(true) do |explanation, changeset|
+        explanation && find_in_changeset(changeset)
+      end
     end
 
     # (see UsedPath#to_s)
@@ -105,10 +138,17 @@ module Refinement
     private
 
     # (see UsedPath#add_reason)
-    def add_reason(modification)
+    def add_reason(modification, changeset:)
       return unless modification
 
-      "#{modification.path} (#{inclusion_reason}) #{modification.type}"
+      add_changeset_description "#{modification.path} (#{inclusion_reason}) #{modification.type}", changeset: changeset
+    end
+
+    # (see UsedPath#add_changeset_description)
+    def add_changeset_description(description, changeset:)
+      return description unless changeset&.description
+
+      description + " (#{changeset.description})"
     end
   end
 end

data/lib/refinement/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Refinement
   # @visibility private
   VERSION = File.read(File.expand_path('../../VERSION', __dir__)).strip.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refinement
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Giddins
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-09 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj
@@ -44,7 +44,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: 
+description:
 email:
 - segiddins@squareup.com
 executables:
@@ -70,7 +70,7 @@ files:
 homepage: https://github.com/square/refinement
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -78,15 +78,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.0.1
+signing_key:
 specification_version: 4
 summary: Generates a list of Xcode targets to build & test as a result of a git diff.
 test_files: []