refinement 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61159414fd746fe91c0a50bf44ad0f382a7abd0b9aae6fd16c67e989f9039650
-  data.tar.gz: f1d97a4cf3a54cee29209928dc3cbff10f981abc2b925d46b2312a6018ad9064
+  metadata.gz: 1d250f8a41cab420b717380a1b0c713541ecda9d0a8439c596bd351c25631fbf
+  data.tar.gz: cc6635b7ebb6f797f7d5142f99a7a85b355d90a0a09b5af15f39a5a6450c389c
 SHA512:
-  metadata.gz: 7b4c9f79c1971593e745864674fcabb9f05b89a0708e76d8bf59d0f37f9302a488847b2971b2c40d07287efe3d6aab8e23a0e1a95972beaae375cd06a6a55bed
-  data.tar.gz: ce51b8bc7721049959317f8366fb508e593c0690d1c78f12da13d0a69f2f5c9fd74149f2cfb413a116a51b9a990e74ba8fef192cfc59f20360236570235f1ce8
+  metadata.gz: bebda46b92a0bc1eaa25d4852c674a697472caa89f67d9fd5e990d0fd16cd7bf594b0c19559d9a8b4a9de7f4fe7a91f08d6f825ab2116afbe3b6fe5525d42cd1
+  data.tar.gz: c86b9b7e206c8b201374817bc4c27b8e7b5372cec0e1a082f27e5c94d34245e50fb237cb5e22c6d3abadb33194ed90b7281d26a69b3484f470f477a47c20879e

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # 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.  
+
+
 ## 0.2.1 (2019-04-08)
 
 ##### Bug Fixes

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.4.1

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,3 +1,5 @@
+# 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.
@@ -26,12 +28,12 @@ module Refinement
       @changeset = changeset
 
       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_changeset(changeset)
+        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
@@ -150,10 +166,11 @@ module Refinement
       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
@@ -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
@@ -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

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'
 
@@ -43,6 +45,7 @@ module Refinement
       dirs = Set.new
       add = lambda { |path|
         break unless dirs.add?(path)
+
         add[path.dirname]
       }
       modifications.each do |mod|
@@ -124,8 +127,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
 
@@ -144,14 +149,14 @@ module Refinement
     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 +211,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,
@@ -9,6 +11,7 @@ module Refinement
     # Initializes a post-install writer with CocoaPods target objects.
     # @return [CocoaPodsPostInstallWriter] a new instance of CocoaPodsPostInstallWriter
     # @param aggregate_targets [Array<Pod::AggregateTarget>]
+    # @param pod_targets [Array<Pod::PodTarget>]
     # @param config [Pod::Config]
     # @param options [Hash]
     def initialize(aggregate_targets, pod_targets, config, options)
@@ -100,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

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.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Samuel Giddins
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-05-09 00:00:00.000000000 Z
+date: 2020-08-04 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: []