refinement 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d250f8a41cab420b717380a1b0c713541ecda9d0a8439c596bd351c25631fbf
-  data.tar.gz: cc6635b7ebb6f797f7d5142f99a7a85b355d90a0a09b5af15f39a5a6450c389c
+  metadata.gz: 3f99f7e0933bae18ddd8c4f6fbd14f3e182f6233a1244b1418ccf678b5c1e471
+  data.tar.gz: 451abebd764ff651e9489095bca0ce0fc4043965e81e962ca49df68e90341367
 SHA512:
-  metadata.gz: bebda46b92a0bc1eaa25d4852c674a697472caa89f67d9fd5e990d0fd16cd7bf594b0c19559d9a8b4a9de7f4fe7a91f08d6f825ab2116afbe3b6fe5525d42cd1
-  data.tar.gz: c86b9b7e206c8b201374817bc4c27b8e7b5372cec0e1a082f27e5c94d34245e50fb237cb5e22c6d3abadb33194ed90b7281d26a69b3484f470f477a47c20879e
+  metadata.gz: 6f8348156cedae83212560898d95229be93c592347e052a82bd5a1bd3b13d76a7298703976f4e93799cd8d38543316409462d9c6ef564e1680bdde746bf084aa
+  data.tar.gz: 1109c4b167045b0a2ac2ba45aa036ec6b3d4aacf06726be393c68fe072ee49479d61d41c89a6a29ad927b1e419a3e7932f82acba25ccf02fe4a08efc0a8aaae6

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/lib/refinement/analyzer.rb

@@ -4,11 +4,11 @@ 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,
@@ -22,10 +22,10 @@ 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
 
@@ -78,7 +78,7 @@ module Refinement
         end
 
       if !filter_when_scheme_has_changed &&
-         UsedPath.new(path: Pathname(scheme_path), inclusion_reason: 'scheme').find_in_changeset(changeset)
+         UsedPath.new(path: Pathname(scheme_path), inclusion_reason: 'scheme').find_in_changesets(changesets)
         return scheme
       end
 
@@ -145,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
@@ -157,9 +157,9 @@ 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'
@@ -198,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,
@@ -306,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
@@ -334,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
 
@@ -344,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/changeset.rb

@@ -18,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
@@ -145,7 +148,7 @@ 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 = {

data/lib/refinement/used_path.rb

@@ -19,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]
@@ -33,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,
@@ -54,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)
@@ -65,7 +87,7 @@ module Refinement
       private
 
       # (see UsedPath#add_reason)
-      def add_reason(modification)
+      def add_reason(modification, changeset:)
         return unless modification
 
         keypath_string =
@@ -74,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
@@ -96,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)
@@ -107,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: refinement
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Giddins
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj