kintsugi 0.3.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ebc10e7941cd3b92850cefb1d5fc0d0046b178b0b3e6bdc929833ff9474302f
-  data.tar.gz: 5cddf2267408f4361862e68f7391783626c6bf7f536962d0c0021b559c0cc637
+  metadata.gz: 35d23332d5548a077db178c966f44413a314276628404a7a9e70d7e2ae45da96
+  data.tar.gz: ea35a4c7587ddb9243103d4c249050900505e630beb8a3764ad7e083360db320
 SHA512:
-  metadata.gz: b052e5047b603307043b708d804678094ac38ee4e392a3de1d5f94b1ca37a552ff5999320a1168f976f803620cb2072e44712dd49a6fc87d929e666248b64ccf
-  data.tar.gz: 213fea0a670e021ae68dae8669e216da4fc19039e71e059e6c33b57adbc753ae824e28d1a5d6b806527215b057a8fd354481c8772794337d73daa88e6c884300
+  metadata.gz: c9731d92243eff91a6a33ae674a936e274c1cfc58979ceedae1248bdb0d6602fbc51d0c192e6f982aa1a150f1fcc2874d0a0255f11ed9aaa68abefae81212ee7
+  data.tar.gz: a96ac801a8ea82a2893d41b25fc7a7fdfd928fba280f6f837c83a49b7b02358d124fcac6d2bd377230f3ab14d3f5f16d8b4de3c9524a1c96cf2ffff927377233

data/README.md

@@ -40,15 +40,22 @@ And see the magic happen! :sparkles:
 
 ### Git merge driver
 
-To use Kintsugi as a Git merge driver, follow these steps:
+You can setup Kintsugi to automatically resolve conflicts that occur in `pbxproj` files when such conflicts occur.
 
-- Add it as driver to Git config file by running the following:
+#### 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 "kintsugi driver %O %A %B %P"
+git config merge.kintsugi.driver "<path_to_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:
@@ -65,7 +72,11 @@ 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

@@ -6,6 +6,7 @@
 
 require "kintsugi"
 require_relative "../lib/kintsugi/cli"
+require_relative "../lib/kintsugi/error"
 
 def parse_options!(command, argv)
   options = {}
@@ -28,4 +29,11 @@ command =
   end
 
 options = parse_options!(command, ARGV)
-command.action.call(options, ARGV, command.option_parser)
+
+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,30 +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}. This is considered a conflict that should be resolved manually."
+          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 && !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."
+        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
 
@@ -219,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
@@ -228,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"
@@ -301,8 +304,8 @@ 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
 
@@ -330,7 +333,7 @@ module Kintsugi
         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
@@ -345,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
@@ -441,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"])
@@ -540,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
@@ -555,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)
@@ -580,8 +583,8 @@ 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

data/lib/kintsugi/cli.rb

@@ -2,6 +2,7 @@
 # Created by Ben Yohay.
 # frozen_string_literal: true
 
+require "fileutils"
 require "optparse"
 
 require_relative "version"
@@ -12,12 +13,14 @@ module Kintsugi
     # Subcommands of Kintsugi CLI.
     attr_reader :subcommands
 
-    # Root command Kintsugi CLI.
+    # Root command of Kintsugi CLI.
     attr_reader :root_command
 
     def initialize
       @subcommands = {
-        "driver" => create_driver_subcommand
+        "driver" => create_driver_subcommand,
+        "install-driver" => create_install_driver_subcommand,
+        "uninstall-driver" => create_uninstall_driver_subcommand
       }.freeze
       @root_command = create_root_command
     end
@@ -27,7 +30,7 @@ module Kintsugi
     Command = Struct.new(:option_parser, :action, :description, keyword_init: true)
 
     def create_driver_subcommand
-      driver_option_parser =
+      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 " \
@@ -40,7 +43,7 @@ module Kintsugi
           end
         end
 
-      driver_action = lambda { |_, arguments, option_parser|
+      driver_action = lambda { |_, arguments|
         if arguments.count != 4
           puts "Incorrect number of arguments to 'driver' subcommand\n\n"
           puts option_parser
@@ -50,14 +53,115 @@ module Kintsugi
       }
 
       Command.new(
-        option_parser: driver_option_parser,
+        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
+      FileUtils.mkdir_p(File.dirname(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`
+
+      attributes_file_path = global_attributes_file_path
+      return unless File.exist?(attributes_file_path)
+
+      `sed -i '' '/\*.pbxproj\ merge=kintsugi/d' "#{attributes_file_path}"`
+    end
+
     def create_root_command
-      root_option_parser = OptionParser.new do |opts|
+      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" \
@@ -77,13 +181,10 @@ module Kintsugi
           exit
         end
 
-        subcommands_descriptions = @subcommands.map do |command_name, command|
-          "    #{command_name}:    #{command.description}"
-        end.join("\n")
-        opts.on_tail("\nSUBCOMMANDS\n#{subcommands_descriptions}")
+        opts.on_tail("\nSUBCOMMANDS\n#{subcommands_descriptions(subcommands)}")
       end
 
-      root_action = lambda { |options, arguments, option_parser|
+      root_action = lambda { |options, arguments|
         if arguments.count != 1
           puts "Incorrect number of arguments\n\n"
           puts option_parser
@@ -96,10 +197,18 @@ module Kintsugi
       }
 
       Command.new(
-        option_parser: root_option_parser,
+        option_parser: option_parser,
         action: root_action,
         description: nil
       )
     end
+
+    def subcommands_descriptions(subcommands)
+      longest_subcommand_length = subcommands.keys.map(&:length).max + 4
+      format_string = "    %-#{longest_subcommand_length}s%s"
+      subcommands.map do |command_name, command|
+        format(format_string, "#{command_name}:", command.description)
+      end.join("\n")
+    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.3.0"
+    STRING = "0.4.2"
   end
 end

data/lib/kintsugi.rb

@@ -9,6 +9,7 @@ require "xcodeproj"
 
 require_relative "kintsugi/xcodeproj_extensions"
 require_relative "kintsugi/apply_change_to_project"
+require_relative "kintsugi/error"
 
 module Kintsugi
   class << self
@@ -21,11 +22,11 @@ module Kintsugi
     #         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)
@@ -59,7 +60,7 @@ module Kintsugi
     # @param  [String] original_project_path
     #         Path to the original path of the file.
     #
-    # @raise [RuntimeError]
+    # @raise [MergeError]
     #        If there was an error applying the change to the project.
     #
     # @return [void]
@@ -104,8 +105,8 @@ module Kintsugi
 
       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
@@ -138,7 +139,7 @@ module Kintsugi
     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 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?

data/spec/kintsugi_apply_change_to_project_spec.rb

@@ -176,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(
@@ -845,6 +862,24 @@ describe Kintsugi, :apply_change_to_project do
     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"
 

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: kintsugi
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Ben Yohay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2022-01-13 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
@@ -117,6 +123,7 @@ files:
 - 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