refinement 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23ec4c7c515278641dbd8dd7f8927a42126801d00d0963979a5deca88937382d
-  data.tar.gz: 10b9168d22d7853fbcbdc0d5a47127643a86f41a55bf6260b9f21c3a88457778
+  metadata.gz: bc6b7da6738a2abb9d51bbb8b07333f370ef7f819307217e01cee42cde2b4ea4
+  data.tar.gz: bf21a6db5de7f51904296972c4e45f27b8853b5751ec31705d7d3e45d2d7f80f
 SHA512:
-  metadata.gz: d88a448b3f573e5f7441dd81b2fc818b928f61f4aeb7fcbbf4b31a9cbb33fd64cc0f91b9d9199a572017b1bde699595c694831368ac528d961d54f3e65f951d3
-  data.tar.gz: 7d9eddf6218a4f70d433a55e8fa1aef2b055dbe5d8f599c94e1496a407de45704e260808562dd2c8358991ca40054cb0eeeae52740c011d5d5384428e9124038
+  metadata.gz: 7333b23a303b68863872011b638d1bab86fb29ea56dd244a33e194873e0c90c4969a1340636c2a80bcee4d0f141b5f12003d038e21ecd10f566e3590d14e63a1
+  data.tar.gz: 024b7afb50f77256b0b399c3c349a3cd2abb92eeda59e51a4dfd1c3a80a757e1901937417e64471be04282470c692489ba10ec23482c72618f8e6e3fa9ec9c8d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # 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

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.6.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
 
@@ -57,9 +57,10 @@ module Refinement
     #   `: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.
-    # @return [Xcodeproj::XCScheme] a scheme whose unchanged targets have been removed
+    # @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:, change_level: :full_transitive, filter_when_scheme_has_changed: false, log_changes: false,
-                        filter_scheme_for_build_action:)
+                        filter_scheme_for_build_action:, each_target: nil)
       scheme = Xcodeproj::XCScheme.new(scheme_path)
 
       sections_to_filter =
@@ -77,25 +78,42 @@ 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
+      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: 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: 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
 
@@ -132,7 +150,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
@@ -144,20 +162,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|
@@ -185,7 +203,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,
@@ -293,11 +311,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
@@ -321,9 +339,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
 
@@ -331,17 +349,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

@@ -57,7 +57,9 @@ module Refinement
           change_reason = direct_change_reason
           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

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
@@ -86,7 +89,7 @@ module Refinement
       pattern = pattern.gsub('/**/', '{/**/,/}')
       values_by_set = {}
       pattern.scan(/\{[^}]*\}/) do |set|
-        values = set.gsub(/[{}]/, '').split(',')
+        values = set.gsub(/[{}]/, '').split(',', -1)
         values_by_set[set] = values
       end
 
@@ -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/cocoapods_post_install_writer.rb

@@ -103,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

@@ -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.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Giddins
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-08-12 00:00:00.000000000 Z
+date: 2021-01-22 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
@@ -85,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-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: []