kintsugi 0.5.4 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 563ca542b9548a7627fbed93666f74046bb2d58d172c8d8669e9450935391804
-  data.tar.gz: '0049c73e560aefe9d627ac32cb2834914611ad9f7944ba6cd99f9b07744d5b9b'
+  metadata.gz: 3cad34bb224a6760f052ff90ac433095e7fb071e7b59ca9018719e3c6a8f5c96
+  data.tar.gz: a0b9675697896041b08d60186804e3c112e51c0dd61d66d26ce9f9310c626f4e
 SHA512:
-  metadata.gz: 420b46d20c19b8ed5596d1034a4791a054820e1ad550c28bf6cd18bbc92334b1f969f65b9b9384b1d824430d11f41cb48e9cabc09a2bb5aea0cb85f68d6d3fca
-  data.tar.gz: dc09f81c4d329a6e2ba93624a7caf2e54bc38a29752076ba56bb347d12fcb7ad49537c50d6ea42af17d92d55e46250582da71f1b8b946537f3193e0b1b58faba
+  metadata.gz: 359e1799a2f313daf547645342677eca83f58a76dc857d2f72b6f97b06318455385cec7b0145344c380ec659376ff3228add2f6c91499f1bef1cd20d63beae11
+  data.tar.gz: 04c9e862353bef092c14464de1e781c3d2168ad958fb8c5d08ed53f74e4090921023f674e6759eff997fbe2994af9514a0d546de4a8d652b19e5a37b32ce3970

data/lib/kintsugi/apply_change_to_project.rb

@@ -6,8 +6,21 @@ require "xcodeproj"
 
 require_relative "utils"
 require_relative "error"
+require_relative "settings"
 require_relative "xcodeproj_extensions"
 
+class Array
+  # Converts an array of arrays of size 2 into a multimap, mapping the first element of each
+  # subarray to an array of the last elements it appears with in the same subarray.
+  def to_multi_h
+    raise ArgumentError, "Not all elements are arrays of size 2" unless all? do |arr|
+      arr.is_a?(Array) && arr.count == 2
+    end
+
+    group_by(&:first).transform_values { |group| group.map(&:last) }
+  end
+end
+
 module Kintsugi
   class << self
     # Applies the change specified by `change` to `project`.
@@ -22,14 +35,15 @@ module Kintsugi
     #
     # @return [void]
     def apply_change_to_project(project, change)
+      return unless change&.key?("rootObject")
+
       # We iterate over the main group and project references first because they might create file
       # or project references that are referenced in other parts.
       unless change["rootObject"]["mainGroup"].nil?
         if project.root_object.main_group.nil?
           puts "Warning: Main group doesn't exist, ignoring changes to it."
         else
-          apply_change_to_component(project.root_object, "mainGroup",
-                                    change["rootObject"]["mainGroup"], "rootObject")
+          apply_main_group_change(project, change["rootObject"]["mainGroup"])
         end
       end
 
@@ -46,10 +60,159 @@ module Kintsugi
 
     private
 
+    def apply_main_group_change(project, main_group_change)
+      additions, removals, diffs = classify_group_and_file_changes(main_group_change, "")
+      apply_group_additions(project, additions)
+      apply_file_changes(project, additions, removals)
+      apply_group_and_file_diffs(project, diffs)
+      apply_group_removals(project, removals)
+    end
+
+    def classify_group_and_file_changes(change, path)
+      children_changes = change["children"] || {}
+      removals = flatten_change(children_changes[:removed], path)
+      additions = flatten_change(children_changes[:added], path)
+      diffs = [[change, path]]
+      subchanges_of_change(children_changes).each do |key, subchange|
+        sub_additions, sub_removals, sub_diffs =
+          classify_group_and_file_changes(subchange, join_path(path, key))
+        removals += sub_removals
+        additions += sub_additions
+        diffs += sub_diffs
+      end
+
+      [additions, removals, diffs]
+    end
+
+    def flatten_change(change, path)
+      entries = (change || []).map do |child|
+        [child, path]
+      end
+      group_entries = entries.map do |group, _|
+        next if group["children"].nil?
+
+        flatten_change(group["children"], join_path(path, group["displayName"]))
+      end.compact.flatten(1)
+      entries + group_entries
+    end
+
+    def apply_group_additions(project, additions)
+      additions.each do |change, path|
+        next unless %w[PBXGroup PBXVariantGroup].include?(change["isa"])
+
+        group_type = Module.const_get("Xcodeproj::Project::#{change["isa"]}")
+        containing_group = path.empty? ? project.main_group : project[path]
+
+        next if !Settings.allow_duplicates &&
+          !find_group_in_group(containing_group, group_type, change).nil?
+
+        new_group = project.new(group_type)
+        containing_group.children << new_group
+        add_attributes_to_component(new_group, change, path, ignore_keys: ["children"])
+      end
+    end
+
+    def find_group_in_group(group, instance_type, change)
+      group
+        .children
+        .select { |child| child.instance_of?(instance_type) }
+        .find do |child_group|
+          child_group.display_name == change["displayName"] && child_group.path == change["path"]
+        end
+    end
+
+    def apply_file_changes(project, additions, removals)
+      def file_reference_key(change)
+        [change["name"], change["path"], change["sourceTree"]]
+      end
+
+      file_additions = additions.select { |change, _| change["isa"] == "PBXFileReference" }
+      file_removals = removals.select { |change, _| change["isa"] == "PBXFileReference" }
+
+      addition_keys_to_paths = file_additions
+                               .map { |change, path| [file_reference_key(change), path] }
+                               .to_multi_h
+      removal_keys_to_references = file_removals.to_multi_h.map do |change, paths|
+        references = paths.map do |containing_path|
+          project[join_path(containing_path, change["displayName"])]
+        end
+
+        [file_reference_key(change), references]
+      end.to_h
+
+      file_additions.each do |change, path|
+        containing_group = path.empty? ? project.main_group : project[path]
+        change_key = file_reference_key(change)
+
+        if (removal_keys_to_references[change_key] || []).empty?
+          apply_file_addition(containing_group, change, "rootObject/mainGroup/#{path}")
+        elsif addition_keys_to_paths[change_key].length == 1 &&
+            removal_keys_to_references[change_key].length == 1 &&
+            !removal_keys_to_references[change_key].first.nil?
+          removal_keys_to_references[change_key].first.move(containing_group)
+        else
+          file_path = join_path(path, change["displayName"])
+          raise MergeError,
+                "Cannot deduce whether the file #{file_path} is new, or was moved to its new place"
+        end
+      end
+
+      file_removals.each do |change, path|
+        next unless addition_keys_to_paths[file_reference_key(change)].nil?
+
+        file_reference = project[join_path(path, change["displayName"])]
+        remove_component(file_reference, change)
+      end
+    end
+
+    def apply_file_addition(containing_group, change, path)
+      return if !Settings.allow_duplicates &&
+        !find_file_in_group(containing_group, Xcodeproj::Project::PBXFileReference,
+                            change["path"]).nil?
+
+      file_reference = containing_group.project.new(Xcodeproj::Project::PBXFileReference)
+      containing_group.children << file_reference
+
+      # For some reason, `include_in_index` is set to `1` and `source_tree` to `SDKROOT` by
+      # default.
+      file_reference.include_in_index = nil
+      file_reference.source_tree = nil
+      add_attributes_to_component(file_reference, change, path)
+    end
+
+    def apply_group_and_file_diffs(project, diffs)
+      diffs.each do |change, path|
+        component = project[path]
+
+        next if component.nil?
+
+        change.each do |subchange_name, subchange|
+          next if subchange_name == "children"
+
+          apply_change_to_component(component, subchange_name, subchange, path)
+        end
+      end
+    end
+
+    def apply_group_removals(project, removals)
+      removals.sort_by(&:last).reverse.each do |change, path|
+        next unless %w[PBXGroup PBXVariantGroup].include?(change["isa"])
+
+        group_path = join_path(path, change["displayName"])
+
+        # by now we've deleted all of this group's children in the project, so we need to adapt the
+        # change to the expected current state of the group, that is, without any children.
+        change_without_children = change.dup
+        change_without_children["children"] = []
+
+        remove_component(project[group_path], change_without_children)
+      end
+    end
+
     def apply_change_to_component(parent_component, change_name, change, parent_change_path)
       return if change_name == "displayName"
 
-      change_path = parent_change_path.empty? ? change_name : "#{parent_change_path}/#{change_name}"
+      change_path = join_path(parent_change_path, change_name)
 
       attribute_name = attribute_name_from_change_name(change_name)
       if simple_attribute?(parent_component, attribute_name)
@@ -61,28 +224,40 @@ module Kintsugi
         component = replace_component_with_new_type(parent_component, attribute_name, change)
         change = change_for_component_of_new_type(component, change)
       else
-        component = child_component(parent_component, change_name)
-
-        if component.nil?
-          add_missing_component_if_valid(parent_component, change_name, change, change_path)
-          return
-        end
+        component = child_component(parent_component, change, change_name)
       end
 
-      (change[:removed] || []).each do |removed_change|
-        child = child_component(component, removed_change["displayName"])
-        next if child.nil?
-
-        remove_component(child, removed_change)
+      if change[:removed].is_a?(Hash)
+        remove_component(component, change[:removed])
+      elsif change[:removed].is_a?(Array)
+        unless component.nil?
+          (change[:removed]).each do |removed_change|
+            child = child_component_of_object_list(component, removed_change,
+                                                   removed_change["displayName"])
+            remove_component(child, removed_change)
+          end
+        end
+      elsif !change[:removed].nil?
+        raise MergeError, "Unsupported removed change type for #{change[:removed]}"
       end
 
-      (change[:added] || []).each do |added_change|
-        is_object_list = component.is_a?(Xcodeproj::Project::ObjectList)
-        add_child_to_component(is_object_list ? parent_component : component, added_change,
-                               change_path)
+      if change[:added].is_a?(Hash)
+        add_child_to_component(parent_component, change[:added], change_path)
+      elsif change[:added].is_a?(Array)
+        (change[:added]).each do |added_change|
+          add_child_to_component(parent_component, added_change, change_path)
+        end
+      elsif !change[:added].nil?
+        raise MergeError, "Unsupported added change type for #{change[:added]}"
       end
 
       subchanges_of_change(change).each do |subchange_name, subchange|
+        if component.nil?
+          raise MergeError, "Trying to apply changes to a component that doesn't exist at path " \
+            "#{change_path}. It was probably removed in a previous commit. This is considered a " \
+            "conflict that should be resolved manually."
+        end
+
         apply_change_to_component(component, subchange_name, subchange, change_path)
       end
     end
@@ -103,16 +278,6 @@ module Kintsugi
       end
     end
 
-    def add_missing_component_if_valid(parent_component, change_name, change, change_path)
-      if change[:added] && change.compact.count == 1
-        add_child_to_component(parent_component, change[:added], change_path)
-        return
-      end
-
-      puts "Warning: Detected change of an object named '#{change_name}' contained in " \
-        "'#{parent_component}' but the object doesn't exist. Ignoring this change."
-    end
-
     def replace_component_with_new_type(parent_component, name_in_parent_component, change)
       old_component = parent_component.send(name_in_parent_component)
       new_component = component_of_new_type(parent_component, change, old_component)
@@ -164,15 +329,23 @@ module Kintsugi
       end
     end
 
-    def child_component(component, change_name)
+    def child_component(component, change, change_name)
       if component.is_a?(Xcodeproj::Project::ObjectList)
-        component.find { |child| child.display_name == change_name }
+        child_component_of_object_list(component, change, change_name)
       else
         attribute_name = attribute_name_from_change_name(change_name)
         component.send(attribute_name)
       end
     end
 
+    def child_component_of_object_list(component, change, change_name)
+      if change["isa"] == "PBXReferenceProxy"
+        find_reference_proxy_in_component(component, change["remoteRef"])
+      else
+        component.find { |child| child.display_name == change_name }
+      end
+    end
+
     def simple_attribute?(component, attribute_name)
       return false unless component.respond_to?("simple_attributes")
 
@@ -281,7 +454,14 @@ module Kintsugi
 
       return added_change if ((old_value || []) - (removed_change || [])).empty?
 
-      (old_value || []) + (added_change || []) - (removed_change || [])
+      new_value = (old_value || []) - (removed_change || [])
+      filtered_added_change = if Settings.allow_duplicates
+                                (added_change || [])
+                              else
+                                (added_change || []).reject { |added| new_value.include?(added) }
+                              end
+
+      new_value + filtered_added_change
     end
 
     def new_string_simple_attribute_value(old_value, removed_change, added_change)
@@ -294,10 +474,13 @@ module Kintsugi
     end
 
     def remove_component(component, change)
+      return if component.nil?
+
       if component.to_tree_hash != change
         raise MergeError, "Trying to remove an object that changed since then. This is " \
           "considered a conflict that should be resolved manually. Name of the object is: " \
-          "'#{component.display_name}'"
+          "'#{component.display_name}'. Existing component: #{component.to_tree_hash}. " \
+          "Change: #{change}"
       end
 
       if change["isa"] == "PBXFileReference"
@@ -320,7 +503,7 @@ module Kintsugi
     end
 
     def add_child_to_component(component, change, component_change_path)
-      change_path = "#{component_change_path}/#{change["displayName"]}"
+      change_path = join_path(component_change_path, change["displayName"])
 
       if change["ProjectRef"] && change["ProductGroup"]
         add_subproject_reference(component, change, change_path)
@@ -426,6 +609,10 @@ module Kintsugi
         end
         containing_component.file_ref = file_reference
       when Xcodeproj::Project::PBXGroup
+        return if !Settings.allow_duplicates &&
+          !find_file_in_group(containing_component, Xcodeproj::Project::PBXReferenceProxy,
+                              change["path"]).nil?
+
         reference_proxy = containing_component.project.new(Xcodeproj::Project::PBXReferenceProxy)
         containing_component << reference_proxy
         add_attributes_to_component(reference_proxy, change, change_path)
@@ -441,13 +628,11 @@ module Kintsugi
         containing_component.file_ref =
           find_variant_group(containing_component.project, change["displayName"])
       when Xcodeproj::Project::PBXGroup, Xcodeproj::Project::PBXVariantGroup
-        unless adding_files_and_groups_allowed?(change_path)
-          return
+        if find_group_in_group(containing_component, Xcodeproj::Project::PBXVariantGroup,
+                               change).nil?
+          raise "Group should have been added already, so this is most likely a bug in Kintsugi" \
+            "Change is: #{change}. Change path: #{change_path}"
         end
-
-        variant_group = containing_component.project.new(Xcodeproj::Project::PBXVariantGroup)
-        containing_component.children << variant_group
-        add_attributes_to_component(variant_group, change, change_path)
       else
         raise MergeError, "Trying to add variant group to an unsupported component type " \
           "#{containing_component.isa}. Change is: #{change}"
@@ -506,6 +691,11 @@ module Kintsugi
         return
       end
 
+      existing_build_file = build_phase.files.find do |build_file|
+        build_file.file_ref && build_file.file_ref.path == change["fileRef"]["path"]
+      end
+      return if !Settings.allow_duplicates && !existing_build_file.nil?
+
       build_file = build_phase.project.new(Xcodeproj::Project::PBXBuildFile)
       build_phase.files << build_file
       add_attributes_to_component(build_file, change, change_path)
@@ -581,6 +771,12 @@ module Kintsugi
     end
 
     def add_subproject_reference(root_object, project_reference_change, change_path)
+      existing_subproject =
+        root_object.project_references.find do |project_reference|
+          project_reference.project_ref.path == project_reference_change["ProjectRef"]["path"]
+        end
+      return if !Settings.allow_duplicates && !existing_subproject.nil?
+
       filter_subproject_without_project_references = lambda do |file_reference|
         root_object.project_references.find do |project_reference|
           project_reference.project_ref.uuid == file_reference.uuid
@@ -645,48 +841,45 @@ module Kintsugi
       when Xcodeproj::Project::PBXBuildFile
         containing_component.file_ref = find_file(containing_component.project, change["path"])
       when Xcodeproj::Project::PBXGroup, Xcodeproj::Project::PBXVariantGroup
-        unless adding_files_and_groups_allowed?(change_path)
-          return
+        if find_file_in_group(containing_component, Xcodeproj::Project::PBXFileReference,
+                              change["path"]).nil?
+          raise "File should have been added already, so this is most likely a bug in Kintsugi" \
+            "Change is: #{change}. Change path: #{change_path}"
         end
-
-        file_reference = containing_component.project.new(Xcodeproj::Project::PBXFileReference)
-        containing_component.children << file_reference
-
-        # For some reason, `include_in_index` is set to `1` and `source_tree` to `SDKROOT` by
-        # default.
-        file_reference.include_in_index = nil
-        file_reference.source_tree = nil
-        add_attributes_to_component(file_reference, change, change_path)
       else
         raise MergeError, "Trying to add file reference to an unsupported component type " \
           "#{containing_component.isa}. Change is: #{change}"
       end
     end
 
+    def find_file_in_group(group, instance_type, filepath)
+      group
+        .children
+        .select { |child| child.instance_of?(instance_type) }
+        .find { |file| file.path == filepath }
+    end
+
     def adding_files_and_groups_allowed?(change_path)
       change_path.start_with?("rootObject/mainGroup") ||
         change_path.start_with?("rootObject/projectReferences")
     end
 
     def add_group(containing_component, change, change_path)
-      unless adding_files_and_groups_allowed?(change_path)
-        return
-      end
-
       case containing_component
       when Xcodeproj::Project::ObjectDictionary
         # It is assumed that an `ObjectDictionary` always represents a project reference.
         new_group = containing_component[:project_ref].project.new(Xcodeproj::Project::PBXGroup)
         containing_component[:product_group] = new_group
+        add_attributes_to_component(new_group, change, change_path)
       when Xcodeproj::Project::PBXGroup
-        new_group = containing_component.project.new(Xcodeproj::Project::PBXGroup)
-        containing_component.children << new_group
+        if find_group_in_group(containing_component, Xcodeproj::Project::PBXGroup, change).nil?
+          raise "Group should have been added already, so this is most likely a bug in Kintsugi" \
+            "Change is: #{change}. Change path: #{change_path}"
+        end
       else
         raise MergeError, "Trying to add group to an unsupported component type " \
-          "#{containing_component.isa}. Change is: #{change}"
+          "#{containing_component.isa}. Change is: #{change}. Change path: #{change_path}"
       end
-
-      add_attributes_to_component(new_group, change, change_path)
     end
 
     def add_attributes_to_component(component, change, change_path, ignore_keys: [])
@@ -739,12 +932,9 @@ module Kintsugi
 
     def find_reference_proxy(project, container_item_proxy_change, reference_filter: ->(_) { true })
       reference_proxies = project.root_object.project_references.map do |project_ref_and_products|
-        project_ref_and_products[:product_group].children.find do |product|
-          product.remote_ref.remote_global_id_string ==
-            container_item_proxy_change["remoteGlobalIDString"] &&
-            product.remote_ref.remote_info == container_item_proxy_change["remoteInfo"] &&
-            reference_filter.call(product)
-        end
+        find_reference_proxy_in_component(project_ref_and_products[:product_group].children,
+                                          container_item_proxy_change,
+                                          reference_filter: reference_filter)
       end.compact
 
       if reference_proxies.length > 1
@@ -758,5 +948,19 @@ module Kintsugi
 
       reference_proxies.first
     end
+
+    def find_reference_proxy_in_component(component, container_item_proxy_change,
+                                          reference_filter: ->(_) { true })
+      component.find do |product|
+        product.remote_ref.remote_global_id_string ==
+          container_item_proxy_change["remoteGlobalIDString"] &&
+          product.remote_ref.remote_info == container_item_proxy_change["remoteInfo"] &&
+          reference_filter.call(product)
+      end
+    end
+
+    def join_path(left, right)
+      left.empty? ? right : "#{left}/#{right}"
+    end
   end
 end

data/lib/kintsugi/cli.rb

@@ -5,6 +5,7 @@
 require "fileutils"
 require "optparse"
 
+require_relative "settings"
 require_relative "version"
 
 module Kintsugi
@@ -182,6 +183,8 @@ module Kintsugi
           exit
         end
 
+        opts.on("--allow-duplicates", "Allow to add duplicates of the same entity")
+
         opts.on_tail("\nSUBCOMMANDS\n#{subcommands_descriptions(subcommands)}")
       end
 
@@ -192,6 +195,10 @@ module Kintsugi
           exit(1)
         end
 
+        if options[:"allow-duplicates"]
+          Settings.allow_duplicates = true
+        end
+
         project_file_path = File.expand_path(arguments[0])
         Kintsugi.resolve_conflicts(project_file_path, options[:"changes-output-path"])
         puts "Resolved conflicts successfully"

data/lib/kintsugi/settings.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2022 Lightricks. All rights reserved.
+# Created by Ben Yohay.
+# frozen_string_literal: true
+
+module Kintsugi
+  # Kintsugi global settings.
+  class Settings
+    class << self
+      # `true` if Kintsugi can create entities that are identical to existing ones, `false`
+      # otherwise.
+      attr_writer :allow_duplicates
+
+      def allow_duplicates
+        @allow_duplicates || false
+      end
+    end
+  end
+end

data/lib/kintsugi/version.rb

@@ -3,6 +3,6 @@
 module Kintsugi
   # This module holds the Kintsugi version information.
   module Version
-    STRING = "0.5.4"
+    STRING = "0.6.2"
   end
 end