kintsugi 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48ba29d100ace39635610ad2876a7b6b78b2ff0b7eb56e34b158c962471b0e3
-  data.tar.gz: 719750e48502f5a4bb3a9c924faf2a2b6b959235555a7545c40262ad80b8ee3a
+  metadata.gz: 1d58044d1f7c23e62f290c33defa4d9b3e95c0012b62754997a7c628d96e4358
+  data.tar.gz: 6d63f1e0cf56c131fe7222c9d316f4f152310077fa2a9f4e386fba54ab82a340
 SHA512:
-  metadata.gz: 26e3adcbe40a0ee5d597cb3bae344f4b124db1de5fb662b5af3d4357d334edc3f46d4367879c33cb26e395b957ca62c2ac824e6d0478fbd3639fe0d71533da13
-  data.tar.gz: 7a71972eb202112a3e83d6923f42b30e509af7b3a0ee4394d83822a89129fa984da8e6e1422046c5ee5c6e43152cbb876101f42dab04bad0c17516b6ba5d329f
+  metadata.gz: 1aa18d3fd3456e1aa44f6497bc3e2f4e4877836e8722887050725012591e43b0086efa490df8eab8f1b63800f900897365a81c87935fb68341b1727e4c432e99
+  data.tar.gz: f8aa152a98e35b9620a3c855eb010781a7fb65e843c6323ea4d14fb27ba414416c2e585273f797e0d8698dfae67d9f7a963e626cc2a2f40ca0d6cce0707cfc0d

data/Gemfile

@@ -2,3 +2,5 @@
 
 source "https://rubygems.org"
 gemspec
+gem "ruby-debug-ide", "0.7.2"
+gem "debase", "0.2.5.beta2"

data/README.md

@@ -38,6 +38,27 @@ 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
+
+To use Kintsugi as a Git merge driver, follow these steps:
+
+- Add it 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 "kintsugi driver %O %A %B %P"
+```
+
+`kintsugi` should be in your `PATH`.
+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).

data/bin/kintsugi

@@ -4,49 +4,28 @@
 # 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"
 
+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
-
-    opts.on_tail("-v", "--version", "Prints version") do
-      puts Kintsugi::Version::STRING
-      exit
-    end
-  end
+def name_of_subcommand?(subcommands, argument)
+  subcommands.include?(argument)
 end
 
-options = parse_options!(ARGV)
-project_file_path = File.expand_path(ARGV[0])
-Kintsugi.resolve_conflicts(project_file_path, options[:"changes-output-path"])
+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
 
-puts "Resolved conflicts successfully"
+options = parse_options!(command, ARGV)
+command.action.call(options, ARGV, command.option_parser)

data/lib/kintsugi.rb

@@ -39,33 +39,68 @@ 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 [RuntimeError]
+    #        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 " \
@@ -74,8 +109,19 @@ module Kintsugi
       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 +145,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/lib/kintsugi/apply_change_to_project.rb

@@ -191,14 +191,15 @@ module Kintsugi
         (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}."
+              "to #{value}. This is considered a conflict that should be resolved manually."
           end
 
           change.key?(key)
         end
       when String
-        if old_value != change
-          raise "Value changed from #{old_value} to #{change}."
+        if old_value != change && !old_value.nil?
+          raise "Trying to remove value #{change}, but the existing value is #{old_value}. This " \
+            "is considered a conflict that should be resolved manually."
         end
 
         nil

data/lib/kintsugi/cli.rb

@@ -0,0 +1,105 @@
+# 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 Kintsugi CLI.
+    attr_reader :root_command
+
+    def initialize
+      @subcommands = {
+        "driver" => create_driver_subcommand
+      }.freeze
+      @root_command = create_root_command
+    end
+
+    private
+
+    Command = Struct.new(:option_parser, :action, :description, keyword_init: true)
+
+    def create_driver_subcommand
+      driver_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, option_parser|
+        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: driver_option_parser,
+        action: driver_action,
+        description: "3-way merge compatible with Git merge driver"
+      )
+    end
+
+    def create_root_command
+      root_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, option_parser|
+        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: root_option_parser,
+        action: root_action,
+        description: nil
+      )
+    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.1.1"
+    STRING = "0.2.0"
   end
 end

data/spec/kintsugi_apply_change_to_project_spec.rb

@@ -770,6 +770,25 @@ describe Kintsugi, :apply_change_to_project do
     expect(base_project).to be_equivalent_to_project(theirs_project)
   end
 
+  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 "identifies subproject added in separate times" do
     framework_filename = "baz"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kintsugi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Yohay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj
@@ -116,6 +116,7 @@ files:
 - kintsugi.gemspec
 - lib/kintsugi.rb
 - lib/kintsugi/apply_change_to_project.rb
+- lib/kintsugi/cli.rb
 - lib/kintsugi/utils.rb
 - lib/kintsugi/version.rb
 - lib/kintsugi/xcodeproj_extensions.rb