kintsugi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3047191981783a65015d6646c15e0c4aa5cba3b3a6f32b6328163a4e8ca7ff37
+  data.tar.gz: 0653aa77f904b249d285feade1d8b5d34a2fbd4ee25bd9431cb32be6462a938e
+SHA512:
+  metadata.gz: f15ab16432c5b3bf335a1b25cac66d2e7bc0b20ec29b3b374b6d88010efc804b292750b703af3aed353a2c01666e116b11290ed32d48731ac3471f94a964c70c
+  data.tar.gz: 54220422787ba0bf75c1cb1594ad3dfed6414e7d95df1193de3e2550953aee798396ed99204e433e10522577b51f2655b15e90b98219c7c608dca6379557580e

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  main-job:
+    name: Main
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5.8
+          bundler-cache: true
+
+      - name: Run Rake
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,221 @@
+require: rubocop-rspec
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Enabled: false
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.5
+  NewCops: enable
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/NumericPredicate:
+  Exclude:
+    - 'features/steps/**'
+
+Layout/EndAlignment:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+Lint/UselessAccessModifier:
+  Enabled: true
+
+Lint/Void:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Layout/EmptyLinesAroundArguments:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Layout/HashAlignment:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/ParameterAlignment:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/BarePercentLiterals:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+Layout/CaseIndentation:
+  Enabled: true
+
+Style/ClassVars:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerBackticks.
+Style/CommandLiteral:
+  Exclude:
+    - 'features/support/*.rb'
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Style/LineEndConcatenation:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Style/NonNilCheck:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: true
+
+Style/PercentQLiterals:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Style/RedundantPercentQ:
+  Exclude:
+    - 'kintsugi.gemspec'
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/CONTRIBUTING.md

@@ -0,0 +1,23 @@
+# Contributing
+
+If you wish to contribute to the project, please follow the guidelines below.
+
+## Opening issues
+
+- Check that the issue doesn't exist already.
+- Check that the issue was not already fixed in the latest `main`.
+
+## Pull requests
+
+**During development**
+
+- Make sure you're on the latest version to avoid conflicts when opening the pull request.
+- Install the needed gems by running `bundle install`.
+- Make the changes you need and commit them.
+- Add tests for the new functionality.
+- Run `bundle exec rake` and make sure all the tests pass.
+
+**Before opening a pull request:**
+
+- Squash the commits such that each represents a single coherent change. Make sure that they have [good commit messages](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+- Open a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Lightricks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+<p align="center">
+  <img src="./logo/kintsugi.png" alt="Kintsugi Logo"/>
+</p>
+
+# Kintsugi [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
+## What is this?
+
+One of the frustrations of working with Xcode together with Git is resolving conflicts in Xcode project files, i.e. the `project.pbxproj` file.
+
+Kintsugi sets out to solve this exact problem: Automatically resolving Git merge conflicts occurring in `.pbxproj` files.
+
+The end goal is for the tool to succeed 99.9% of the time, and let you resolve the real conflicts in a convenient way the rest of the time.
+
+> Kintsugi (金継ぎ) is the art of repairing broken pottery by mending it with gold. [Wikipedia](http://en.wikipedia.org/wiki/Kintsugi)
+
+## How?
+
+Kintsugi understands the changes you've made to the `.pbxproj` file, so it simply resets the conflicts and re-applies those changes to it.
+
+From a technical perspective, Kintsugi heavily relies on [Xcodeproj](https://github.com/CocoaPods/Xcodeproj). It uses its diff capability to extract the changes, and uses its project files editing capabilities to apply the changes.
+
+## Installing Kintsugi
+
+```sh
+$ gem install kintsugi
+```
+
+If you prefer to use bundler, add the following line to your Gemfile:
+
+```rb
+gem 'kintsugi', require: false
+```
+
+## Usage
+
+When there's a `.pbxproj` file with Git conflicts, run `kintsugi <path_to_pbxproj_file>`.
+
+And see the magic happen! :sparkles:
+
+## 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.
+
+## Copyright
+
+Copyright (c) 2021 Lightricks. See [LICENSE](./LICENSE) for details.

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2020 Lightricks. All rights reserved.
+# Created by Ben Yohay.
+
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/bin/kintsugi

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (c) 2020 Lightricks. All rights reserved.
+# Created by Ben Yohay.
+
+require "json"
+require "optparse"
+
+require "kintsugi"
+
+def parse_options!(argv)
+  options_parser = create_options_parser
+
+  options = {}
+  options_parser.parse!(argv, into: options)
+
+  if argv.length != 1
+    puts "Incorrect number of arguments\n\n"
+    puts options_parser
+    exit(1)
+  end
+
+  options
+end
+
+def create_options_parser
+  OptionParser.new do |opts|
+    opts.banner = "Usage: 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
+  end
+end
+
+options = parse_options!(ARGV)
+project_file_path = File.expand_path(ARGV[0])
+Kintsugi.resolve_conflicts(project_file_path, options[:"changes-output-path"])
+
+puts "Resolved conflicts successfully"