kintsugi 0.4.3 → 0.5.3

data/lib/kintsugi/cli.rb

@@ -50,6 +50,7 @@ module Kintsugi
           exit(1)
         end
         Kintsugi.three_way_merge(arguments[0], arguments[1], arguments[2], arguments[3])
+        warn "\e[32mKintsugi auto-merged #{arguments[3]}\e[0m"
       }
 
       Command.new(
@@ -109,7 +110,7 @@ module Kintsugi
     def global_attributes_file_path
       # The logic to decide the path to the global attributes file is described at:
       # https://git-scm.com/docs/gitattributes.
-      config_attributes_file_path = `git config --global core.attributesfile`
+      config_attributes_file_path = `git config --global core.attributesfile`.chomp
       return config_attributes_file_path unless config_attributes_file_path.empty?
 
       if ENV["XDG_CONFIG_HOME"].nil? || ENV["XDG_CONFIG_HOME"].empty?

data/lib/kintsugi/merge.rb

@@ -0,0 +1,146 @@
+# Copyright (c) 2021 Lightricks. All rights reserved.
+# Created by Ben Yohay.
+# frozen_string_literal: true
+
+require "json"
+require "tmpdir"
+require "tempfile"
+require "xcodeproj"
+
+require_relative "xcodeproj_extensions"
+require_relative "apply_change_to_project"
+require_relative "error"
+
+module Kintsugi
+  class << self
+    # Resolves git conflicts of a pbxproj file specified by `project_file_path`.
+    #
+    # @param  [String] project_file_path
+    #         Project to which to apply the changes.
+    #
+    # @param  [String] changes_output_path
+    #         Path to where the changes to apply to the project are written in JSON format.
+    #
+    # @raise [ArgumentError]
+    #        If the file extension is not `pbxproj`, or the file doesn't exist, or if no rebase,
+    #        cherry-pick, or merge is in progress
+    #
+    # @raise [MergeError]
+    #        If there was an error applying the change to the project.
+    #
+    # @return [void]
+    def resolve_conflicts(project_file_path, changes_output_path)
+      validate_project(project_file_path)
+
+      base_project = copy_project_from_stage_number_to_temporary_directory(project_file_path, 1)
+      ours_project = copy_project_from_stage_number_to_temporary_directory(project_file_path, 2)
+      theirs_project = copy_project_from_stage_number_to_temporary_directory(project_file_path, 3)
+
+      change = Xcodeproj::Differ.project_diff(theirs_project, base_project, :added, :removed)
+
+      if changes_output_path
+        File.write(changes_output_path, JSON.pretty_generate(change))
+      end
+
+      apply_change_and_copy_to_original_path(ours_project, change, project_file_path)
+    end
+
+    # Merges the changes done between `theirs_project_path` and `base_project_path` to the file at
+    # `ours_project_path`. The files may not be at the original path, and therefore the
+    # `original_project_path` is required in order for the project metadata to be written properly.
+    #
+    # @param  [String] base_project_path
+    #         Path to the base version of the project.
+    #
+    # @param  [String] ours_project_path
+    #         Path to ours version of the project.
+    #
+    # @param  [String] theirs_project_path
+    #         Path to theirs version of the project.
+    #
+    # @param  [String] original_project_path
+    #         Path to the original path of the file.
+    #
+    # @raise [MergeError]
+    #        If there was an error applying the change to the project.
+    #
+    # @return [void]
+    def three_way_merge(base_project_path, ours_project_path, theirs_project_path,
+                        original_project_path)
+      original_directory_name = File.basename(File.dirname(original_project_path))
+      base_temporary_project =
+        copy_project_to_temporary_path_in_directory_with_name(base_project_path,
+                                                              original_directory_name)
+      ours_temporary_project =
+        copy_project_to_temporary_path_in_directory_with_name(ours_project_path,
+                                                              original_directory_name)
+      theirs_temporary_project =
+        copy_project_to_temporary_path_in_directory_with_name(theirs_project_path,
+                                                              original_directory_name)
+
+      change =
+        Xcodeproj::Differ.project_diff(theirs_temporary_project, base_temporary_project,
+                                       :added, :removed)
+
+      apply_change_and_copy_to_original_path(ours_temporary_project, change, ours_project_path)
+    end
+
+    private
+
+    PROJECT_FILE_NAME = "project.pbxproj"
+
+    def apply_change_and_copy_to_original_path(project, change, original_project_file_path)
+      apply_change_to_project(project, change)
+      project.save
+      FileUtils.cp(File.join(project.path, PROJECT_FILE_NAME), original_project_file_path)
+    end
+
+    def validate_project(project_file_path)
+      unless File.exist?(project_file_path)
+        raise ArgumentError, "File '#{project_file_path}' doesn't exist"
+      end
+
+      if File.extname(project_file_path) != ".pbxproj"
+        raise ArgumentError, "Wrong file extension, please provide file with extension .pbxproj\""
+      end
+
+      unless file_has_base_ours_and_theirs_versions?(project_file_path)
+        raise ArgumentError, "File '#{project_file_path}' doesn't have conflicts, " \
+          "or a 3-way merge is not possible."
+      end
+    end
+
+    def copy_project_from_stage_number_to_temporary_directory(project_file_path, stage_number)
+      project_directory_name = File.basename(File.dirname(project_file_path))
+      temp_project_file_path = File.join(Dir.mktmpdir, project_directory_name, PROJECT_FILE_NAME)
+      Dir.mkdir(File.dirname(temp_project_file_path))
+      Dir.chdir(File.dirname(project_file_path)) do
+        `git show :#{stage_number}:./#{PROJECT_FILE_NAME} > "#{temp_project_file_path}"`
+      end
+      Xcodeproj::Project.open(File.dirname(temp_project_file_path))
+    end
+
+    def copy_project_to_temporary_path_in_directory_with_name(project_file_path, directory_name)
+      temp_directory_name = File.join(Dir.mktmpdir, directory_name)
+      Dir.mkdir(temp_directory_name)
+      temp_project_file_path = File.join(temp_directory_name, PROJECT_FILE_NAME)
+      FileUtils.cp(project_file_path, temp_project_file_path)
+      Xcodeproj::Project.open(File.dirname(temp_project_file_path))
+    end
+
+    def file_has_base_ours_and_theirs_versions?(file_path)
+      Dir.chdir(`git -C "#{File.dirname(file_path)}" rev-parse --show-toplevel`.strip) do
+        file_has_version_in_stage_numbers?(file_path, [1, 2, 3])
+      end
+    end
+
+    def file_has_version_in_stage_numbers?(file_path, stage_numbers)
+      file_absolute_path = File.absolute_path(file_path)
+      actual_stage_numbers =
+        `git ls-files -u -- "#{file_absolute_path}"`.split("\n").map do |git_file_status|
+          git_file_status.split[2]
+        end
+      (stage_numbers - actual_stage_numbers.map(&:to_i)).empty?
+    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.4.3"
+    STRING = "0.5.3"
   end
 end

data/lib/kintsugi/xcodeproj_extensions.rb

@@ -27,5 +27,127 @@ module Xcodeproj
         self[:project_ref]
       end
     end
+
+    module Object
+      # Extends `XCBuildConfiguration` to convert array settings (which might be either array or
+      # string) to actual arrays in `to_tree_hash` so diffs are always between arrays. This means
+      # that if the values in both `ours` and `theirs` are different strings, we will know to solve
+      # the conflict into an array containing both strings.
+      # Code was mostly copied from https://github.com/CocoaPods/Xcodeproj/blob/master/lib/xcodeproj/project/object/build_configuration.rb#L211
+      class XCBuildConfiguration
+        @@old_to_tree_hash = instance_method(:to_tree_hash)
+
+        def to_tree_hash
+          @@old_to_tree_hash.bind(self).call.tap do |hash|
+            convert_array_settings_to_arrays(hash['buildSettings'])
+          end
+        end
+
+        def convert_array_settings_to_arrays(settings)
+          return unless settings
+
+          array_settings = BuildSettingsArraySettingsByObjectVersion[project.object_version]
+
+          settings.each_key do |key|
+            value = settings[key]
+            next unless value.is_a?(String)
+
+            stripped_key = key.sub(/\[[^\]]+\]$/, '')
+            next unless array_settings.include?(stripped_key)
+
+            array_value = split_string_setting_into_array(value)
+            settings[key] = array_value
+          end
+        end
+
+        def split_string_setting_into_array(string)
+          string.scan(/ *((['"]?).*?[^\\]\2)(?=( |\z))/).map(&:first)
+        end
+      end
+    end
+  end
+
+  module Differ
+      # Replaces the implementation of `array_diff` with an implementation that takes into account
+      # the number of occurrences an element is found in the array.
+      # Code was mostly copied from https://github.com/CocoaPods/Xcodeproj/blob/51fb78a03f31614103815ce21c56dc25c044a10d/lib/xcodeproj/differ.rb#L111
+      def self.array_diff(value_1, value_2, options)
+      ensure_class(value_1, Array)
+      ensure_class(value_2, Array)
+      return nil if value_1 == value_2
+
+      new_objects_value_1 = array_non_unique_diff(value_1, value_2)
+      new_objects_value_2 = array_non_unique_diff(value_2, value_1)
+      return nil if value_1.empty? && value_2.empty?
+
+      matched_diff = {}
+      if id_key = options[:id_key]
+        matched_value_1 = []
+        matched_value_2 = []
+        new_objects_value_1.each do |entry_value_1|
+          if entry_value_1.is_a?(Hash)
+            id_value = entry_value_1[id_key]
+            entry_value_2 = new_objects_value_2.find do |entry|
+              entry[id_key] == id_value
+            end
+            if entry_value_2
+              matched_value_1 << entry_value_1
+              matched_value_2 << entry_value_2
+              diff = diff(entry_value_1, entry_value_2, options)
+              matched_diff[id_value] = diff if diff
+            end
+          end
+        end
+
+        new_objects_value_1 -= matched_value_1
+        new_objects_value_2 -= matched_value_2
+      end
+
+      if new_objects_value_1.empty? && new_objects_value_2.empty?
+        if matched_diff.empty?
+          nil
+        else
+          matched_diff
+        end
+      else
+        result = {}
+        result[options[:key_1]] = new_objects_value_1 unless new_objects_value_1.empty?
+        result[options[:key_2]] = new_objects_value_2 unless new_objects_value_2.empty?
+        result[:diff] = matched_diff unless matched_diff.empty?
+        result
+      end
+    end
+
+    # Returns the difference between two arrays, taking into account the number of occurrences an
+    # element is found in both arrays.
+    #
+    # @param  [Array] value_1
+    #         First array to the difference operation.
+    #
+    # @param  [Array] value_2
+    #         Second array to the difference operation.
+    #
+    # @return [Array]
+    #
+    def self.array_non_unique_diff(value_1, value_2)
+      value_2_elements_by_count = value_2.reduce({}) do |hash, element|
+        updated_element_hash = hash.key?(element) ? {element => hash[element] + 1} : {element => 1}
+        hash.merge(updated_element_hash)
+      end
+
+      value_1_elements_by_deletions =
+        value_1.to_set.map do |element|
+          times_to_delete_element = value_2_elements_by_count[element] || 0
+          [element, times_to_delete_element]
+        end.to_h
+
+      value_1.select do |element|
+        if value_1_elements_by_deletions[element].positive?
+          value_1_elements_by_deletions[element] -= 1
+          next false
+        end
+        next true
+      end
+    end
   end
 end

data/lib/kintsugi.rb

@@ -1,167 +1,48 @@
-# Copyright (c) 2021 Lightricks. All rights reserved.
-# Created by Ben Yohay.
 # frozen_string_literal: true
 
-require "json"
-require "tmpdir"
-require "tempfile"
-require "xcodeproj"
+# Copyright (c) 2022 Lightricks. All rights reserved.
+# Created by Ben Yohay.
 
-require_relative "kintsugi/xcodeproj_extensions"
-require_relative "kintsugi/apply_change_to_project"
+require_relative "kintsugi/cli"
 require_relative "kintsugi/error"
+require_relative "kintsugi/merge"
 
 module Kintsugi
   class << self
-    # Resolves git conflicts of a pbxproj file specified by `project_file_path`.
-    #
-    # @param  [String] project_file_path
-    #         Project to which to apply the changes.
-    #
-    # @param  [String] changes_output_path
-    #         Path to where the changes to apply to the project are written in JSON format.
-    #
-    # @raise [ArgumentError]
-    #        If the file extension is not `pbxproj`, or the file doesn't exist, or if no rebase,
-    #        cherry-pick, or merge is in progress
-    #
-    # @raise [MergeError]
-    #        If there was an error applying the change to the project.
-    #
-    # @return [void]
-    def resolve_conflicts(project_file_path, changes_output_path)
-      validate_project(project_file_path)
-
-      project_in_temp_directory =
-        open_project_of_current_commit_in_temporary_directory(project_file_path)
-
-      change = change_of_conflicting_commit_with_parent(project_file_path)
-
-      if changes_output_path
-        File.write(changes_output_path, JSON.pretty_generate(change))
-      end
-
-      apply_change_and_copy_to_original_path(project_in_temp_directory, change, project_file_path)
-    end
-
-    # Merges the changes done between `theirs_project_path` and `base_project_path` to the file at
-    # `ours_project_path`. The files may not be at the original path, and therefore the
-    # `original_project_path` is required in order for the project metadata to be written properly.
-    #
-    # @param  [String] base_project_path
-    #         Path to the base version of the project.
-    #
-    # @param  [String] ours_project_path
-    #         Path to ours version of the project.
-    #
-    # @param  [String] theirs_project_path
-    #         Path to theirs version of the project.
-    #
-    # @param  [String] original_project_path
-    #         Path to the original path of the file.
-    #
-    # @raise [MergeError]
-    #        If there was an error applying the change to the project.
-    #
-    # @return [void]
-    def three_way_merge(base_project_path, ours_project_path, theirs_project_path,
-                        original_project_path)
-      original_directory_name = File.basename(File.dirname(original_project_path))
-      base_temporary_project =
-        copy_project_to_temporary_path_in_directory_with_name(base_project_path,
-                                                              original_directory_name)
-      ours_temporary_project =
-        copy_project_to_temporary_path_in_directory_with_name(ours_project_path,
-                                                              original_directory_name)
-      theirs_temporary_project =
-        copy_project_to_temporary_path_in_directory_with_name(theirs_project_path,
-                                                              original_directory_name)
-
-      change =
-        Xcodeproj::Differ.project_diff(theirs_temporary_project, base_temporary_project,
-                                       :added, :removed)
-
-      apply_change_and_copy_to_original_path(ours_temporary_project, change, ours_project_path)
-    end
-
-    private
-
-    PROJECT_FILE_NAME = "project.pbxproj"
-
-    def apply_change_and_copy_to_original_path(project, change, original_project_file_path)
-      apply_change_to_project(project, change)
-      project.save
-      FileUtils.cp(File.join(project.path, PROJECT_FILE_NAME), original_project_file_path)
-    end
-
-    def validate_project(project_file_path)
-      unless File.exist?(project_file_path)
-        raise ArgumentError, "File '#{project_file_path}' doesn't exist"
-      end
-
-      if File.extname(project_file_path) != ".pbxproj"
-        raise ArgumentError, "Wrong file extension, please provide file with extension .pbxproj\""
-      end
-
-      Dir.chdir(File.dirname(project_file_path)) do
-        unless file_has_base_ours_and_theirs_versions?(project_file_path)
-          raise ArgumentError, "File '#{project_file_path}' doesn't have conflicts, " \
-            "or a 3-way merge is not possible."
+    def run(arguments)
+      first_argument = arguments[0]
+      cli = CLI.new
+      command =
+        if name_of_subcommand?(cli.subcommands, first_argument)
+          arguments.shift
+          cli.subcommands[first_argument]
+        else
+          cli.root_command
         end
-      end
-    end
 
-    def copy_project_to_temporary_path_in_directory_with_name(project_file_path, directory_name)
-      temp_directory_name = File.join(Dir.mktmpdir, directory_name)
-      Dir.mkdir(temp_directory_name)
-      temp_project_file_path = File.join(temp_directory_name, PROJECT_FILE_NAME)
-      FileUtils.cp(project_file_path, temp_project_file_path)
-      Xcodeproj::Project.open(File.dirname(temp_project_file_path))
-    end
+      options = parse_options!(command, arguments)
 
-    def open_project_of_current_commit_in_temporary_directory(project_file_path)
-      project_directory_name = File.basename(File.dirname(project_file_path))
-      temp_directory_name = File.join(Dir.mktmpdir, project_directory_name)
-      Dir.mkdir(temp_directory_name)
-      temp_project_file_path = File.join(temp_directory_name, PROJECT_FILE_NAME)
-      Dir.chdir(File.dirname(project_file_path)) do
-        `git show HEAD:./project.pbxproj > "#{temp_project_file_path}"`
+      begin
+        command.action.call(options, arguments)
+      rescue ArgumentError => e
+        puts "#{e.class}: #{e}"
+        raise
+      rescue Kintsugi::MergeError => e
+        puts e
+        raise
       end
-      Xcodeproj::Project.open(File.dirname(temp_project_file_path))
     end
 
-    def file_has_base_ours_and_theirs_versions?(file_path)
-      Dir.chdir(`git rev-parse --show-toplevel`.strip) do
-        file_has_version_in_stage_numbers?(file_path, [1, 2, 3])
-      end
-    end
+    private
 
-    def file_has_version_in_stage_numbers?(file_path, stage_numbers)
-      file_absolute_path = File.absolute_path(file_path)
-      actual_stage_numbers =
-        `git ls-files -u -- "#{file_absolute_path}"`.split("\n").map do |git_file_status|
-          git_file_status.split[2]
-        end
-      (stage_numbers - actual_stage_numbers.map(&:to_i)).empty?
+    def parse_options!(command, arguments)
+      options = {}
+      command.option_parser.parse!(arguments, into: options)
+      options
     end
 
-    def change_of_conflicting_commit_with_parent(project_file_path)
-      Dir.chdir(File.dirname(project_file_path)) do
-        conflicting_commit_project_file_path = File.join(Dir.mktmpdir, PROJECT_FILE_NAME)
-        `git show :3:./#{PROJECT_FILE_NAME} > #{conflicting_commit_project_file_path}`
-
-        conflicting_commit_parent_project_file_path = File.join(Dir.mktmpdir, PROJECT_FILE_NAME)
-        `git show :1:./#{PROJECT_FILE_NAME} > #{conflicting_commit_parent_project_file_path}`
-
-        conflicting_commit_project = Xcodeproj::Project.open(
-          File.dirname(conflicting_commit_project_file_path)
-        )
-        conflicting_commit_parent_project =
-          Xcodeproj::Project.open(File.dirname(conflicting_commit_parent_project_file_path))
-
-        Xcodeproj::Differ.project_diff(conflicting_commit_project,
-                                       conflicting_commit_parent_project, :added, :removed)
-      end
+    def name_of_subcommand?(subcommands, argument)
+      subcommands.include?(argument)
     end
   end
 end