kintsugi 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdc0655ad443f7511adec336aef55e40ed0bb5458cf5fd9ae7747294bf40881d
-  data.tar.gz: 214a8426b955d0c36b2ff51f55b2016ed69861ccc5d99fa2d463567cbc6872fc
+  metadata.gz: 0e2593fa95851c928b7ad943430c1db40d4c21831e24bd16f371f24298714c99
+  data.tar.gz: dca49c53301790803690ad5aa81dcf59b2f9036402a713b63b9093130994fe51
 SHA512:
-  metadata.gz: 79d21fb3b3ddcb977a0b09bb5f80d19d6337574cb5b975a342d261bd689b53ff387a4ef2c7f0fb9a33d6698ce0e739b76824515ecf4b869f5858228635d99047
-  data.tar.gz: 4a902033e2f4236d82f3db8b1fa832ec78e8201b264a32a11599b3c0df3b048bb82e5abee8cb3d3fac7e74ae4d6ff37029ae9cd809fee5ebbe65723c997862e7
+  metadata.gz: aa8c40252da2e56f9753fd143e1b100599c31737badcb5c16906e5883008b6344a5e44c09f2619f90045b0c987971f0248f2400d5f95acd20dac7c810b061a05
+  data.tar.gz: 15da61db3bea0d5d3c9528ba93b087ae67956eb58f4d846639936fcf682ac5f7cc5f6d2ec8eb87cc41673b960978e245b3eaf33d21b31c1e5a0ebadf46780d07

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/lib/kintsugi/apply_change_to_project.rb

@@ -190,24 +190,24 @@ module Kintsugi
       when Hash
         (old_value || {}).reject do |key, value|
           if value != removed_change[key] && added_change[key] != value
-            raise "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."
+            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
 
           removed_change.key?(key)
         end
       when String
         if old_value != removed_change && !old_value.nil? && added_change != old_value
-          raise "Trying to remove value '#{removed_change}', but the existing value is " \
-            "'#{old_value}'. This is considered a conflict that should be resolved manually."
+          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 #{removed_change} of type #{removed_change.class}"
+        raise MergeError, "Unsupported change #{removed_change} of type #{removed_change.class}"
       end
     end
 
@@ -220,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
@@ -229,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"
@@ -302,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
 
@@ -331,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
@@ -346,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
@@ -442,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"])
@@ -541,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
@@ -556,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)
@@ -581,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

@@ -12,12 +12,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 +29,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 +42,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 +52,110 @@ 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
+      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
-      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" \
@@ -83,7 +181,7 @@ module Kintsugi
         opts.on_tail("\nSUBCOMMANDS\n#{subcommands_descriptions}")
       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,7 +194,7 @@ module Kintsugi
       }
 
       Command.new(
-        option_parser: root_option_parser,
+        option_parser: option_parser,
         action: root_action,
         description: nil
       )

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.1"
+    STRING = "0.4.0"
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kintsugi
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Yohay
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2022-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj
@@ -123,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
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6.3
 signing_key:
 specification_version: 4
 summary: pbxproj files git conflicts solver