kintsugi 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48ba29d100ace39635610ad2876a7b6b78b2ff0b7eb56e34b158c962471b0e3
-  data.tar.gz: 719750e48502f5a4bb3a9c924faf2a2b6b959235555a7545c40262ad80b8ee3a
+  metadata.gz: 0e2593fa95851c928b7ad943430c1db40d4c21831e24bd16f371f24298714c99
+  data.tar.gz: dca49c53301790803690ad5aa81dcf59b2f9036402a713b63b9093130994fe51
 SHA512:
-  metadata.gz: 26e3adcbe40a0ee5d597cb3bae344f4b124db1de5fb662b5af3d4357d334edc3f46d4367879c33cb26e395b957ca62c2ac824e6d0478fbd3639fe0d71533da13
-  data.tar.gz: 7a71972eb202112a3e83d6923f42b30e509af7b3a0ee4394d83822a89129fa984da8e6e1422046c5ee5c6e43152cbb876101f42dab04bad0c17516b6ba5d329f
+  metadata.gz: aa8c40252da2e56f9753fd143e1b100599c31737badcb5c16906e5883008b6344a5e44c09f2619f90045b0c987971f0248f2400d5f95acd20dac7c810b061a05
+  data.tar.gz: 15da61db3bea0d5d3c9528ba93b087ae67956eb58f4d846639936fcf682ac5f7cc5f6d2ec8eb87cc41673b960978e245b3eaf33d21b31c1e5a0ebadf46780d07

data/.rubocop.yml

@@ -6,6 +6,9 @@ RSpec/ExampleLength:
 RSpec/DescribeClass:
   Enabled: false
 
+RSpec/MultipleExpectations:
+  Enabled: false
+
 AllCops:
   DisplayCopNames: true
   TargetRubyVersion: 2.5

data/README.md

@@ -38,13 +38,45 @@ When there's a `.pbxproj` file with Git conflicts, and a 3-way merge is possible
 
 And see the magic happen! :sparkles:
 
+### Git merge driver
+
+You can setup Kintsugi to automatically resolve conflicts that occur in `pbxproj` files when such conflicts occur.
+
+#### Automatic install
+
+Run `kintsugi install-driver`. This will install Kintsugi as a merge driver globally. Note that Kintsugi needs to be in your `PATH`.
+
+❗ Do not install with bundler because the installation might succeed even if Kintsugi is not in `PATH`.
+
+#### Manual install
+
+- Add Kintsugi as driver to Git config file by running the following:
+```sh
+git config merge.kintsugi.name "Kintsugi driver" # Or any other name you prefer
+git config merge.kintsugi.driver "<path_to_kintsugi> driver %O %A %B %P"
+```
+
+Run `git config` with `--global` to add this to the global config file.
+
+- Add the following line to the `.gitattributes` file at the root of the repository:
+
+`*.pbxproj merge=kintsugi`
+
+This will instruct Git to use Kintsugi as a merge driver for `.pbxproj` files.
+
+See the [official docs](https://git-scm.com/docs/gitattributes) if you want to set this globally.
+
 ## Contribution
 
 See our [Contribution guidelines](./CONTRIBUTING.md).
 
 ## Alternatives
 
-- [XcodeGen](https://github.com/yonaskolb/XcodeGen): You can commit this JSON file into Git instead of the `.pbxproj` file. Then resolving conflicts is much easier.
+All of the alternatives below allow you to generate your Xcode projects based on a spec or manifest. You commit these files to git, and can even remove the `.xcodeproj` files from git.
+
+- [XcodeGen](https://github.com/yonaskolb/XcodeGen)
+- [Tuist](https://github.com/tuist)
+- [Xcake](https://github.com/igor-makarov/xcake)
 
 ## Copyright
 

data/bin/kintsugi

@@ -4,49 +4,36 @@
 # Copyright (c) 2020 Lightricks. All rights reserved.
 # Created by Ben Yohay.
 
-require "json"
-require "optparse"
-
 require "kintsugi"
-require_relative "../lib/kintsugi/version"
-
-
-def parse_options!(argv)
-  options_parser = create_options_parser
+require_relative "../lib/kintsugi/cli"
+require_relative "../lib/kintsugi/error"
 
+def parse_options!(command, argv)
   options = {}
-  options_parser.parse!(argv, into: options)
-
-  if argv.length != 1
-    puts "Incorrect number of arguments\n\n"
-    puts options_parser
-    exit(1)
-  end
-
+  command.option_parser.parse!(argv, into: options)
   options
 end
 
-def create_options_parser
-  OptionParser.new do |opts|
-    opts.banner = "Kintsugi, version #{Kintsugi::Version::STRING}\nCopyright (c) 2021 " \
-                  "Lightricks\n\nUsage: kintsugi [pbxproj_filepath] [options]"
-    opts.on("--changes-output-path=PATH", "Path to which changes applied to the project are " \
-            "written in JSON format. Used for debug purposes.")
-
-    opts.on("-h", "--help", "Prints this help") do
-      puts opts
-      exit
-    end
+def name_of_subcommand?(subcommands, argument)
+  subcommands.include?(argument)
+end
 
-    opts.on_tail("-v", "--version", "Prints version") do
-      puts Kintsugi::Version::STRING
-      exit
-    end
+first_argument = ARGV[0]
+cli = Kintsugi::CLI.new
+command =
+  if name_of_subcommand?(cli.subcommands, first_argument)
+    ARGV.shift
+    cli.subcommands[first_argument]
+  else
+    cli.root_command
   end
-end
 
-options = parse_options!(ARGV)
-project_file_path = File.expand_path(ARGV[0])
-Kintsugi.resolve_conflicts(project_file_path, options[:"changes-output-path"])
+options = parse_options!(command, ARGV)
 
-puts "Resolved conflicts successfully"
+begin
+  command.action.call(options, ARGV)
+rescue ArgumentError => e
+  puts "#{e.class}: #{e}"
+rescue Kintsugi::MergeError => e
+  puts e
+end

data/kintsugi.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "xcodeproj", "1.19.0"
+  spec.add_dependency "xcodeproj", ">= 1.19.0", "<= 1.21.0"
 
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9"

data/lib/kintsugi/apply_change_to_project.rb

@@ -167,7 +167,7 @@ module Kintsugi
       new_value = nil
 
       if change.key?(:removed)
-        new_value = apply_removal_to_simple_attribute(old_value, change[:removed])
+        new_value = apply_removal_to_simple_attribute(old_value, change[:removed], change[:added])
       end
 
       if change.key?(:added)
@@ -183,29 +183,31 @@ module Kintsugi
       new_value
     end
 
-    def apply_removal_to_simple_attribute(old_value, change)
-      case change
+    def apply_removal_to_simple_attribute(old_value, removed_change, added_change)
+      case removed_change
       when Array
-        (old_value || []) - change
+        (old_value || []) - removed_change
       when Hash
         (old_value || {}).reject do |key, value|
-          if value != change[key]
-            raise "Trying to remove value #{change[key]} of hash with key #{key} but it changed " \
-              "to #{value}."
+          if value != removed_change[key] && added_change[key] != value
+            raise MergeError, "Trying to remove value '#{removed_change[key]}' of hash with key " \
+              "'#{key}' but it changed to #{value}. This is considered a conflict that should be " \
+              "resolved manually."
           end
 
-          change.key?(key)
+          removed_change.key?(key)
         end
       when String
-        if old_value != change
-          raise "Value changed from #{old_value} to #{change}."
+        if old_value != removed_change && !old_value.nil? && added_change != old_value
+          raise MergeError, "Trying to remove value '#{removed_change}', but the existing value " \
+            "is '#{old_value}'. This is considered a conflict that should be resolved manually."
         end
 
         nil
       when nil
         nil
       else
-        raise "Unsupported change #{change} of type #{change.class}"
+        raise MergeError, "Unsupported change #{removed_change} of type #{removed_change.class}"
       end
     end
 
@@ -218,7 +220,8 @@ module Kintsugi
         new_value = old_value.merge(change)
 
         unless (old_value.to_a - new_value.to_a).empty?
-          raise "New hash #{change} contains values that conflict with old hash #{old_value}"
+          raise MergeError, "New hash #{change} contains values that conflict with old hash " \
+            "#{old_value}"
         end
 
         new_value
@@ -227,14 +230,15 @@ module Kintsugi
       when nil
         nil
       else
-        raise "Unsupported change #{change} of type #{change.class}"
+        raise MergeError, "Unsupported change #{change} of type #{change.class}"
       end
     end
 
     def remove_component(component, change)
       if component.to_tree_hash != change
-        raise "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}'"
+        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}'"
       end
 
       if change["isa"] == "PBXFileReference"
@@ -265,6 +269,8 @@ module Kintsugi
       case change["isa"]
       when "PBXNativeTarget"
         add_target(component, change)
+      when "PBXAggregateTarget"
+        add_aggregate_target(component, change)
       when "PBXFileReference"
         add_file_reference(component, change)
       when "PBXGroup"
@@ -298,21 +304,36 @@ module Kintsugi
       when "PBXReferenceProxy"
         add_reference_proxy(component, change)
       else
-        raise "Trying to add unsupported component type #{change["isa"]}. Full component change " \
-          "is: #{change}"
+        raise MergeError, "Trying to add unsupported component type #{change["isa"]}. Full " \
+          "component change is: #{change}"
       end
     end
 
     def add_reference_proxy(containing_component, change)
       case containing_component
       when Xcodeproj::Project::PBXBuildFile
-        containing_component.file_ref = find_file(containing_component.project, change)
+        # If there are two file references that refer to the same file, one with a build file and
+        # the other one without, this method will prefer to take the one without the build file.
+        # This assumes that it's preferred to have a file reference with build file than a file
+        # reference without/with two build files.
+        filter_references_without_build_files = lambda do |reference|
+          reference.referrers.find do |referrer|
+            referrer.is_a?(Xcodeproj::Project::PBXBuildFile)
+          end.nil?
+        end
+        file_reference =
+          find_reference_proxy(containing_component.project, change["remoteRef"],
+                               reference_filter: filter_references_without_build_files)
+        if file_reference.nil?
+          file_reference = find_reference_proxy(containing_component.project, change["remoteRef"])
+        end
+        containing_component.file_ref = file_reference
       when Xcodeproj::Project::PBXGroup
         reference_proxy = containing_component.project.new(Xcodeproj::Project::PBXReferenceProxy)
         containing_component << reference_proxy
         add_attributes_to_component(reference_proxy, change)
       else
-        raise "Trying to add reference proxy to an unsupported component type " \
+        raise MergeError, "Trying to add reference proxy to an unsupported component type " \
           "#{containing_component.isa}. Change is: #{change}"
       end
     end
@@ -327,7 +348,7 @@ module Kintsugi
         containing_component.children << variant_group
         add_attributes_to_component(variant_group, change)
       else
-        raise "Trying to add variant group to an unsupported component type " \
+        raise MergeError, "Trying to add variant group to an unsupported component type " \
           "#{containing_component.isa}. Change is: #{change}"
       end
     end
@@ -423,7 +444,7 @@ module Kintsugi
       when "PBXReferenceProxy"
         component.remote_ref = container_proxy
       else
-        raise "Trying to add container item proxy to an unsupported component type " \
+        raise MergeError, "Trying to add container item proxy to an unsupported component type " \
           "#{containing_component.isa}. Change is: #{change}"
       end
       add_attributes_to_component(container_proxy, change, ignore_keys: ["containerPortal"])
@@ -458,7 +479,14 @@ module Kintsugi
     end
 
     def add_subproject_reference(root_object, project_reference_change)
-      subproject_reference = find_file(root_object.project, project_reference_change["ProjectRef"])
+      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
+        end.nil?
+      end
+      subproject_reference =
+        find_file(root_object.project, project_reference_change["ProjectRef"],
+                  file_filter: filter_subproject_without_project_references)
 
       attribute =
         Xcodeproj::Project::PBXProject.references_by_keys_attributes
@@ -488,6 +516,12 @@ module Kintsugi
       add_attributes_to_component(target, change)
     end
 
+    def add_aggregate_target(root_object, change)
+      target = root_object.project.new(Xcodeproj::Project::PBXAggregateTarget)
+      root_object.project.targets << target
+      add_attributes_to_component(target, change)
+    end
+
     def add_file_reference(containing_component, change)
       # base configuration reference and product reference always reference a file that exists
       # inside a group, therefore in these cases the file is searched for.
@@ -509,7 +543,7 @@ module Kintsugi
         file_reference.include_in_index = nil
         add_attributes_to_component(file_reference, change)
       else
-        raise "Trying to add file reference to an unsupported component type " \
+        raise MergeError, "Trying to add file reference to an unsupported component type " \
           "#{containing_component.isa}. Change is: #{change}"
       end
     end
@@ -524,8 +558,8 @@ module Kintsugi
         new_group = containing_component.project.new(Xcodeproj::Project::PBXGroup)
         containing_component.children << new_group
       else
-        raise "Trying to add group to an unsupported component type #{containing_component.isa}. " \
-          "Change is: #{change}"
+        raise MergeError, "Trying to add group to an unsupported component type " \
+          "#{containing_component.isa}. Change is: #{change}"
       end
 
       add_attributes_to_component(new_group, change)
@@ -549,31 +583,35 @@ module Kintsugi
             add_child_to_component(component, added_attribute_element)
           end
         else
-          raise "Trying to add attribute of unsupported type '#{change_value.class}' to " \
-            "object #{component}. Attribute name is '#{change_name}'"
+          raise MergeError, "Trying to add attribute of unsupported type '#{change_value.class}' " \
+            "to object #{component}. Attribute name is '#{change_name}'"
         end
       end
     end
 
-    def find_file(project, file_reference_change)
-      case file_reference_change["isa"]
-      when "PBXFileReference"
-        project.files.find do |file_reference|
-          next file_reference.path == file_reference_change["path"]
-        end
-      when "PBXReferenceProxy"
-        find_reference_proxy(project, file_reference_change["remoteRef"])
-      else
-        raise "Unsupported file reference change of type #{file_reference["isa"]}."
+    def find_file(project, file_reference_change, file_filter: ->(_) { true })
+      file_references = project.files.select do |file_reference|
+        file_reference.path == file_reference_change["path"] && file_filter.call(file_reference)
+      end
+      if file_references.length > 1
+        puts "Debug: Found more than one matching file with path " \
+          "'#{file_reference_change["path"]}'. Using the first one."
+      elsif file_references.empty?
+        puts "Debug: No file reference found for file with path " \
+          "'#{file_reference_change["path"]}'."
+        return
       end
+
+      file_references.first
     end
 
-    def find_reference_proxy(project, container_item_proxy_change)
+    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"]
+            product.remote_ref.remote_info == container_item_proxy_change["remoteInfo"] &&
+            reference_filter.call(product)
         end
       end.compact
 

data/lib/kintsugi/cli.rb

@@ -0,0 +1,203 @@
+# Copyright (c) 2021 Lightricks. All rights reserved.
+# Created by Ben Yohay.
+# frozen_string_literal: true
+
+require "optparse"
+
+require_relative "version"
+
+module Kintsugi
+  # Class resposible for creating the logic of various options for Kintsugi CLI.
+  class CLI
+    # Subcommands of Kintsugi CLI.
+    attr_reader :subcommands
+
+    # Root command of Kintsugi CLI.
+    attr_reader :root_command
+
+    def initialize
+      @subcommands = {
+        "driver" => create_driver_subcommand,
+        "install-driver" => create_install_driver_subcommand,
+        "uninstall-driver" => create_uninstall_driver_subcommand
+      }.freeze
+      @root_command = create_root_command
+    end
+
+    private
+
+    Command = Struct.new(:option_parser, :action, :description, keyword_init: true)
+
+    def create_driver_subcommand
+      option_parser =
+        OptionParser.new do |opts|
+          opts.banner = "Usage: kintsugi driver BASE OURS THEIRS ORIGINAL_FILE_PATH\n" \
+            "Uses Kintsugi as a Git merge driver. Parameters " \
+            "should be the path to base version of the file, path to ours version, path to " \
+            "theirs version, and the original file path."
+
+          opts.on("-h", "--help", "Prints this help") do
+            puts opts
+            exit
+          end
+        end
+
+      driver_action = lambda { |_, arguments|
+        if arguments.count != 4
+          puts "Incorrect number of arguments to 'driver' subcommand\n\n"
+          puts option_parser
+          exit(1)
+        end
+        Kintsugi.three_way_merge(arguments[0], arguments[1], arguments[2], arguments[3])
+      }
+
+      Command.new(
+        option_parser: option_parser,
+        action: driver_action,
+        description: "3-way merge compatible with Git merge driver"
+      )
+    end
+
+    def create_install_driver_subcommand
+      option_parser =
+        OptionParser.new do |opts|
+          opts.banner = "Usage: kintsugi install-driver\n" \
+            "Installs Kintsugi as a Git merge driver globally. "
+
+          opts.on("-h", "--help", "Prints this help") do
+            puts opts
+            exit
+          end
+        end
+
+      action = lambda { |_, arguments|
+        if arguments.count != 0
+          puts "Incorrect number of arguments to 'install-driver' subcommand\n\n"
+          puts option_parser
+          exit(1)
+        end
+
+        if `which kintsugi`.chomp.empty?
+          puts "Can only install Kintsugi globally if Kintsugi is in your PATH"
+          exit(1)
+        end
+
+        install_kintsugi_driver_globally
+        puts "Done! 🪄"
+      }
+
+      Command.new(
+        option_parser: option_parser,
+        action: action,
+        description: "Installs Kintsugi as a Git merge driver globally"
+      )
+    end
+
+    def install_kintsugi_driver_globally
+      `git config --global merge.kintsugi.name "Kintsugi driver"`
+      `git config --global merge.kintsugi.driver "kintsugi driver %O %A %B %P"`
+
+      attributes_file_path = global_attributes_file_path
+      merge_using_kintsugi_line = "'*.pbxproj merge=kintsugi'"
+      `grep -sqxF #{merge_using_kintsugi_line} "#{attributes_file_path}" \
+        || echo #{merge_using_kintsugi_line} >> "#{attributes_file_path}"`
+    end
+
+    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`
+      return config_attributes_file_path unless config_attributes_file_path.empty?
+
+      if ENV["XDG_CONFIG_HOME"].nil? || ENV["XDG_CONFIG_HOME"].empty?
+        File.join(ENV["HOME"], ".config/git/attributes")
+      else
+        File.join(ENV["XDG_CONFIG_HOME"], "git/attributes")
+      end
+    end
+
+    def create_uninstall_driver_subcommand
+      option_parser =
+        OptionParser.new do |opts|
+          opts.banner = "Usage: kintsugi uninstall-driver\n" \
+            "Uninstalls Kintsugi as a Git merge driver that was previously installed globally."
+
+          opts.on("-h", "--help", "Prints this help") do
+            puts opts
+            exit
+          end
+        end
+
+      action = lambda { |_, arguments|
+        if arguments.count != 0
+          puts "Incorrect number of arguments to 'uninstall-driver' subcommand\n\n"
+          puts option_parser
+          exit(1)
+        end
+
+        uninstall_kintsugi_driver_globally
+        puts "Done!"
+      }
+
+      Command.new(
+        option_parser: option_parser,
+        action: action,
+        description: "Uninstalls Kintsugi as a Git merge driver that was previously installed " \
+                     "globally."
+      )
+    end
+
+    def uninstall_kintsugi_driver_globally
+      `git config --global --unset merge.kintsugi.name`
+      `git config --global --unset merge.kintsugi.driver`
+
+      `sed -i '' '/\*.pbxproj\ merge=kintsugi/d' "#{global_attributes_file_path}"`
+    end
+
+    def create_root_command
+      option_parser = OptionParser.new do |opts|
+        opts.banner = "Kintsugi, version #{Version::STRING}\n" \
+                      "Copyright (c) 2021 Lightricks\n\n" \
+                      "Usage: kintsugi <pbxproj_filepath> [options]\n" \
+                      "       kintsugi <subcommand> [options]"
+
+        opts.separator ""
+        opts.on("--changes-output-path=PATH", "Path to which changes applied to the project are " \
+                "written in JSON format. Used for debug purposes.")
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+
+        opts.on("-v", "--version", "Prints version") do
+          puts Version::STRING
+          exit
+        end
+
+        subcommands_descriptions = @subcommands.map do |command_name, command|
+          "    #{command_name}:    #{command.description}"
+        end.join("\n")
+        opts.on_tail("\nSUBCOMMANDS\n#{subcommands_descriptions}")
+      end
+
+      root_action = lambda { |options, arguments|
+        if arguments.count != 1
+          puts "Incorrect number of arguments\n\n"
+          puts option_parser
+          exit(1)
+        end
+
+        project_file_path = File.expand_path(arguments[0])
+        Kintsugi.resolve_conflicts(project_file_path, options[:"changes-output-path"])
+        puts "Resolved conflicts successfully"
+      }
+
+      Command.new(
+        option_parser: option_parser,
+        action: root_action,
+        description: nil
+      )
+    end
+  end
+end

data/lib/kintsugi/error.rb

@@ -0,0 +1,9 @@
+# Copyright (c) 2021 Lightricks. All rights reserved.
+# Created by Ben Yohay.
+# frozen_string_literal: true
+
+module Kintsugi
+  # Raised when an error occurred while Kintsugi tried to resolve conflicts.
+  class MergeError < RuntimeError
+  end
+end

data/lib/kintsugi/version.rb

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

data/lib/kintsugi.rb

@@ -2,12 +2,14 @@
 # Created by Ben Yohay.
 # frozen_string_literal: true
 
+require "json"
 require "tmpdir"
 require "tempfile"
 require "xcodeproj"
 
 require_relative "kintsugi/xcodeproj_extensions"
 require_relative "kintsugi/apply_change_to_project"
+require_relative "kintsugi/error"
 
 module Kintsugi
   class << self
@@ -16,15 +18,15 @@ module Kintsugi
     # @param  [String] project_file_path
     #         Project to which to apply the changes.
     #
-    # @param  [String] output_changes_path
+    # @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
+    #        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 [RuntimeError]
-    #        If no rebase, cherry-pick, or merge is in progress, or the project file couldn't be
-    #        opened, or there was an error applying the change to the project.
+    # @raise [MergeError]
+    #        If there was an error applying the change to the project.
     #
     # @return [void]
     def resolve_conflicts(project_file_path, changes_output_path)
@@ -39,43 +41,89 @@ module Kintsugi
         File.write(changes_output_path, JSON.pretty_generate(change))
       end
 
-      apply_change_to_project(project_in_temp_directory, change)
-
-      project_in_temp_directory.save
-
-      Dir.chdir(File.dirname(project_file_path)) do
-        `git reset #{project_file_path}`
-      end
-      FileUtils.cp(File.join(project_in_temp_directory.path, "project.pbxproj"), project_file_path)
+      apply_change_and_copy_to_original_path(project_in_temp_directory, change, project_file_path)
+    end
 
-      # Some of the metadata in a `pbxproj` file include a part of the name of the directory it's
-      # inside. The modified project is stored in a temporary directory and then copied to the
-      # original path, therefore its metadata is incorrect. To fix this, the project at the original
-      # path is opened and saved.
-      Xcodeproj::Project.open(File.dirname(project_file_path)).save
+    # 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
 
-    def validate_project(project_file_path)
-      if File.extname(project_file_path) != ".pbxproj"
-        raise ArgumentError, "Wrong file extension, please provide file with extension .pbxproj\""
-      end
+    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."
+          raise ArgumentError, "File '#{project_file_path}' doesn't have conflicts, " \
+            "or a 3-way merge is not possible."
         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
+
     def open_project_of_current_commit_in_temporary_directory(project_file_path)
-      temp_project_file_path = File.join(Dir.mktmpdir, "project.pbxproj")
+      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}`
       end
@@ -99,11 +147,11 @@ module Kintsugi
 
     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.pbxproj")
-        `git show :3:./project.pbxproj > #{conflicting_commit_project_file_path}`
+        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.pbxproj")
-        `git show :1:./project.pbxproj > #{conflicting_commit_parent_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)

data/spec/kintsugi_apply_change_to_project_spec.rb

@@ -38,6 +38,18 @@ describe Kintsugi, :apply_change_to_project do
     expect(base_project).to be_equivalent_to_project(theirs_project)
   end
 
+  it "adds new aggregate target" do
+    theirs_project = create_copy_of_project(base_project.path, "theirs")
+    theirs_project.new_aggregate_target("foo")
+
+    changes_to_apply = get_diff(theirs_project, base_project)
+
+    described_class.apply_change_to_project(base_project, changes_to_apply)
+    base_project.save
+
+    expect(base_project).to be_equivalent_to_project(theirs_project)
+  end
+
   it "adds new subproject" do
     theirs_project = create_copy_of_project(base_project.path, "theirs")
     add_new_subproject_to_project(theirs_project, "foo", "foo")
@@ -50,6 +62,26 @@ describe Kintsugi, :apply_change_to_project do
     expect(base_project).to be_equivalent_to_project(theirs_project, ignore_keys: ["containerPortal"])
   end
 
+  it "adds subproject that already exists" do
+    theirs_project = create_copy_of_project(base_project.path, "theirs")
+
+    subproject = add_new_subproject_to_project(theirs_project, "foo", "foo")
+    theirs_project.save
+
+    ours_project = create_copy_of_project(base_project.path, "ours")
+    add_existing_subproject_to_project(ours_project, subproject, "foo")
+
+    changes_to_apply = get_diff(theirs_project, base_project)
+
+    described_class.apply_change_to_project(ours_project, changes_to_apply)
+    ours_project.save
+
+    expect(ours_project.root_object.project_references[0][:project_ref].uuid)
+      .not_to equal(ours_project.root_object.project_references[1][:project_ref].uuid)
+    expect(ours_project.root_object.project_references[0][:project_ref].proxy_containers).not_to be_empty
+    expect(ours_project.root_object.project_references[1][:project_ref].proxy_containers).not_to be_empty
+  end
+
   # Checks that the order the changes are applied in is correct.
   it "adds new subproject and reference to its framework" do
     theirs_project = create_copy_of_project(base_project.path, "theirs")
@@ -144,6 +176,23 @@ describe Kintsugi, :apply_change_to_project do
       expect(base_project).to be_equivalent_to_project(theirs_project)
     end
 
+    it "changes simple attribute of a file that has a build file" do
+      target = base_project.new_target("com.apple.product-type.library.static", "bar", :ios)
+      file_reference = base_project.main_group.find_file_by_path(filepath)
+      target.frameworks_build_phase.add_file_reference(file_reference)
+      base_project.save
+
+      theirs_project = create_copy_of_project(base_project.path, "theirs")
+      file_reference = theirs_project.main_group.find_file_by_path(filepath)
+      file_reference.include_in_index = "4"
+
+      changes_to_apply = get_diff(theirs_project, base_project)
+
+      described_class.apply_change_to_project(base_project, changes_to_apply)
+
+      expect(base_project).to be_equivalent_to_project(theirs_project)
+    end
+
     it "removes build files of a removed file" do
       target = base_project.new_target("com.apple.product-type.library.static", "foo", :ios)
       target.source_build_phase.add_file_reference(
@@ -417,6 +466,30 @@ describe Kintsugi, :apply_change_to_project do
       expect(base_project).to be_equivalent_to_project(theirs_project, ignore_keys: ["containerPortal"])
     end
 
+    it "adds build file to a file reference that already exist" do
+      file_reference = base_project.main_group.new_reference("bar")
+      base_project.targets[0].frameworks_build_phase.add_file_reference(file_reference)
+
+      base_project.main_group.new_reference("bar")
+
+      base_project.save
+
+      theirs_project = create_copy_of_project(base_project.path, "theirs")
+
+      theirs_file_reference = theirs_project.main_group.files.find do |file|
+        !file.referrers.find { |referrer| referrer.is_a?(Xcodeproj::Project::PBXBuildFile) } &&
+          file.display_name == "bar"
+      end
+      theirs_project.targets[0].frameworks_build_phase.add_file_reference(theirs_file_reference)
+
+      changes_to_apply = get_diff(theirs_project, base_project)
+
+      described_class.apply_change_to_project(base_project, changes_to_apply)
+      base_project.save
+
+      expect(base_project).to be_equivalent_to_project(theirs_project)
+    end
+
     it "adds file reference to build file" do
       file_reference = base_project.main_group.new_reference("bar")
 
@@ -770,7 +843,44 @@ describe Kintsugi, :apply_change_to_project do
     expect(base_project).to be_equivalent_to_project(theirs_project)
   end
 
-  it "identifies subproject added in separate times" do
+  it "removes attribute target changes from a project it was removed from already" do
+    base_project.root_object.attributes["TargetAttributes"] =
+      {"foo" => {"LastSwiftMigration" => "1140"}}
+    base_project.save
+
+    theirs_project = create_copy_of_project(base_project.path, "theirs")
+    theirs_project.root_object.attributes["TargetAttributes"]["foo"] = {}
+
+    ours_project = create_copy_of_project(base_project.path, "ours")
+    ours_project.root_object.attributes["TargetAttributes"]["foo"] = {}
+
+    changes_to_apply = get_diff(theirs_project, base_project)
+
+    described_class.apply_change_to_project(ours_project, changes_to_apply)
+    ours_project.save
+
+    expect(ours_project).to be_equivalent_to_project(theirs_project)
+  end
+
+  it "doesn't throw if existing attribute target change is same as added change" do
+    base_project.root_object.attributes["TargetAttributes"] = {"foo" => "1140"}
+    base_project.save
+
+    theirs_project = create_copy_of_project(base_project.path, "theirs")
+    theirs_project.root_object.attributes["TargetAttributes"]["foo"] = "1111"
+
+    ours_project = create_copy_of_project(base_project.path, "ours")
+    ours_project.root_object.attributes["TargetAttributes"]["foo"] = "1111"
+
+    changes_to_apply = get_diff(theirs_project, base_project)
+
+    described_class.apply_change_to_project(ours_project, changes_to_apply)
+    ours_project.save
+
+    expect(ours_project).to be_equivalent_to_project(theirs_project)
+  end
+
+  it "identifies subproject added at separate times when adding a product to the subproject" do
     framework_filename = "baz"
 
     subproject = new_subproject("subproj", framework_filename)
@@ -851,10 +961,10 @@ describe Kintsugi, :apply_change_to_project do
       file_reference.path == subproject_product_name
     end.remove_from_project
 
-    project.root_object.project_references[0][:product_group] =
+    project.root_object.project_references[-1][:product_group] =
       project.new(Xcodeproj::Project::PBXGroup)
-    project.root_object.project_references[0][:product_group].name = "Products"
-    project.root_object.project_references[0][:product_group] <<
+    project.root_object.project_references[-1][:product_group].name = "Products"
+    project.root_object.project_references[-1][:product_group] <<
       create_reference_proxy_from_product_reference(project, subproject_reference,
                                                     subproject.products_group.files[0])
   end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: kintsugi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Yohay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2022-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.19.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.19.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,6 +122,8 @@ files:
 - kintsugi.gemspec
 - lib/kintsugi.rb
 - lib/kintsugi/apply_change_to_project.rb
+- lib/kintsugi/cli.rb
+- lib/kintsugi/error.rb
 - lib/kintsugi/utils.rb
 - lib/kintsugi/version.rb
 - lib/kintsugi/xcodeproj_extensions.rb
@@ -142,7 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project:
+rubygems_version: 2.7.6.3
 signing_key:
 specification_version: 4
 summary: pbxproj files git conflicts solver