rails-credentials-conflict 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69ad41e2d662e231c9cc58895b567280a3f1c78943dd4dfd389f8b83db21ed73
-  data.tar.gz: 1ea33b52f592947663ad9c24c0cf8162c284e2caf91fcf2555c8e8d55c8b6874
+  metadata.gz: e3cd17fd0e8851b22e9b7ecf7e539ba99d1080a1aad3fc65c98c1cb72ce536e0
+  data.tar.gz: f8f643184cc1eeca3305bd6249bf8fc8da126baaa214c732cfe0e6b0e582669d
 SHA512:
-  metadata.gz: 16863610cb7967fb70d71996dbc88f347ef442464be96462e6387df629c9fe5899de3fead02debc6180abc515250c214a968ff21bcfd2c383527a4ec2c37ef9a
-  data.tar.gz: '0936c701ef1b31c7d3724f9a3257ec4e41fc6736ccd7547a06d6a05228531ff5190a0123443462026f866ca3aa87172e5df3fb0c2e64dbcd6438d172e2be8e28'
+  metadata.gz: 3b9f6572939173826d39f0a85051b9ea7ae9cf01544dc975305e836b1b7d50da79ceaea93d78aa909cbf02532a0d34e5db259694957928e9715ee09faf6275f2
+  data.tar.gz: f19f66117c4cc206bc11ec23a248f62f231305454bf361162814fa0c7e110a1dd263ecc2d507007b07b50e6f59c4f24debf0383567a7763c61865460ef11905a

data/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2026-04-13
+
+### Added
+
+- Automatic credentials conflict resolution via a custom git merge driver
+- `base` command to select the base version from git stages
+- Auto-merge of non-conflicting changes in different sections
+- Conflict markers enriched with branch names and commit SHAs
+- Use of `git merge-file` to produce proper conflict markers
+
+### Changed
+
+- Refactored resolver into focused, single-responsibility classes
+- Enhanced documentation and error handling across conflict resolution
+- Improved gem summary and description
+- Lowered Ruby version requirement
+
+### Fixed
+
+- Read resolved content from disk after the editor saves
+- Task argument syntax for the environment parameter
+
 ## [0.1.0] - 2025-01-01
 
 ### Added

data/README.md

@@ -1,6 +1,15 @@
 # Rails Credentials Conflict
 
-A Rails gem that helps resolve git merge conflicts in encrypted credentials files by decrypting, merging, and re-encrypting them.
+[![Gem Version](https://badge.fury.io/rb/rails-credentials-conflict.svg)](https://rubygems.org/gems/rails-credentials-conflict)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.txt)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.1.0-red.svg)](https://www.ruby-lang.org)
+[![Rails](https://img.shields.io/badge/rails-%3E%3D%206.0-red.svg)](https://rubyonrails.org)
+
+Resolve git merge conflicts in Rails encrypted credentials by decrypting, merging, and re-encrypting them. Works with merge, rebase, and cherry-pick.
+
+- [RubyGems](https://rubygems.org/gems/rails-credentials-conflict)
+- [Source Code](https://github.com/jwo1f/rails-credentials-conflict)
+- [Changelog](CHANGELOG.md)
 
 ## Problem
 
@@ -28,6 +37,23 @@ And then execute:
 bundle install
 ```
 
+## Automatic merge driver (recommended)
+
+Register a custom git merge driver so that git can automatically decrypt, merge, and re-encrypt credentials during merge, rebase, and cherry-pick — resolving conflicts transparently when changes are in different sections.
+
+```bash
+rails credentials:conflict:install
+```
+
+This command:
+
+1. Adds a `rails-credentials` merge driver to your local `.git/config`
+2. Appends rules to `.gitattributes` so all `*.yml.enc` credentials files use it
+
+**How it works:** When git encounters a conflict in a credentials file it invokes the merge driver instead of producing encrypted gibberish with conflict markers. The driver decrypts all three versions (base, ours, theirs), runs a three-way merge, and re-encrypts the result. If the changes are in different sections the merge succeeds automatically (exit 0). If there is a real conflict the driver exits 1, git marks the file as conflicted, and you can fall back to the manual rake tasks below.
+
+> **Note:** `.gitattributes` should be committed so the whole team benefits. The `.git/config` entry is local — each developer runs `rails credentials:conflict:install` once after cloning.
+
 ## Usage
 
 When you encounter a merge conflict in your credentials file, you have four options:

data/lib/rails/credentials/conflict/merge_driver.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Rails
+  module Credentials
+    module Conflict
+      # Git merge driver entry point for encrypted credentials files.
+      #
+      # Invoked by git during merge/rebase/cherry-pick when a custom
+      # merge driver is configured via +.gitattributes+.
+      #
+      # Git calls the driver with four paths:
+      # - +base_path+ (+%O+) — common ancestor version
+      # - +ours_path+ (+%A+) — current branch version (result is written here)
+      # - +theirs_path+ (+%B+) — other branch version
+      # - +file_path+ (+%P+) — pathname of the file being merged
+      module MergeDriver
+        # Extracts the environment name from a credentials file path.
+        #
+        # "config/credentials.yml.enc"          → nil
+        # "config/credentials/staging.yml.enc"  → "staging"
+        def self.extract_environment(file_path)
+          if file_path =~ %r{config/credentials/([^/]+)\.yml\.enc\z}
+            $1
+          end
+        end
+
+        # Runs the merge driver. Decrypts the three versions, performs a
+        # three-way merge, and writes the encrypted result back to +ours_path+.
+        #
+        # Returns +0+ on successful auto-merge, +1+ when conflicts remain.
+        def self.call(base_path, ours_path, theirs_path, file_path)
+          environment = extract_environment(file_path)
+          path_resolver = PathResolver.new(environment)
+          encryption_service = EncryptionService.new(path_resolver.key_path)
+          merge_strategy = MergeStrategy.new(encryption_service)
+
+          base_content = encryption_service.decrypt(File.binread(base_path))
+          ours_content = encryption_service.decrypt(File.binread(ours_path))
+          theirs_content = encryption_service.decrypt(File.binread(theirs_path))
+
+          return 0 if ours_content == theirs_content
+
+          result = merge_strategy.create_conflict_markers(
+            ours_content,
+            base_content,
+            theirs_content,
+            labels: { ours: "ours", base: "base", theirs: "theirs" }
+          )
+
+          return 1 if result[:has_conflicts]
+
+          encryption_service.save_encrypted(result[:content], ours_path)
+          0
+        rescue StandardError
+          1
+        end
+      end
+    end
+  end
+end

data/lib/rails/credentials/conflict/version.rb

@@ -3,7 +3,7 @@
 module Rails
   module Credentials
     module Conflict
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/rails/credentials/conflict.rb

@@ -6,6 +6,7 @@ require_relative "conflict/encryption_service"
 require_relative "conflict/git_conflict_handler"
 require_relative "conflict/merge_strategy"
 require_relative "conflict/resolver"
+require_relative "conflict/merge_driver"
 require_relative "conflict/railtie" if defined?(Rails::Railtie)
 
 module Rails

data/lib/tasks/credentials_conflict.rake

@@ -31,5 +31,47 @@ namespace :credentials do
     rescue Rails::Credentials::Conflict::Error => e
       abort e.message
     end
+
+    desc "Install git merge driver for automatic credentials conflict resolution"
+    task install: :environment do
+      require "open3"
+
+      # Configure git merge driver
+      commands = [
+        ["git", "config", "merge.rails-credentials.name", "Rails encrypted credentials merge driver"],
+        ["git", "config", "merge.rails-credentials.driver",
+         "bundle exec rails runner \"Rails::Credentials::Conflict::MergeDriver.call('%O', '%A', '%B', '%P')\""]
+      ]
+
+      commands.each do |cmd|
+        _, status = Open3.capture2(*cmd)
+        abort "Failed to run: #{cmd.join(" ")}" unless status.success?
+      end
+
+      puts "Configured git merge driver 'rails-credentials' in .git/config"
+
+      # Update .gitattributes
+      gitattributes_path = Rails.root.join(".gitattributes")
+      existing_content = File.exist?(gitattributes_path) ? File.read(gitattributes_path) : ""
+
+      lines_to_add = [
+        "config/credentials.yml.enc merge=rails-credentials",
+        "config/credentials/*.yml.enc merge=rails-credentials"
+      ]
+
+      new_lines = lines_to_add.reject { |line| existing_content.include?(line) }
+
+      if new_lines.any?
+        File.open(gitattributes_path, "a") do |f|
+          f.puts unless existing_content.empty? && !existing_content.end_with?("\n")
+          new_lines.each { |line| f.puts(line) }
+        end
+        puts "Added merge driver entries to .gitattributes"
+      else
+        puts ".gitattributes already configured"
+      end
+
+      puts "Done! Credentials conflicts will now be auto-merged when possible."
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-credentials-conflict
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - jwo1f
@@ -37,8 +37,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-description: A gem that helps resolve git merge conflicts in Rails encrypted credentials
-  by decrypting, merging, and re-encrypting the files.
+description: Resolve git merge conflicts in Rails encrypted credentials by decrypting,
+  merging, and re-encrypting them. Works with merge, rebase, and cherry-pick.
 email:
 - ''
 executables: []
@@ -52,6 +52,7 @@ files:
 - lib/rails/credentials/conflict.rb
 - lib/rails/credentials/conflict/encryption_service.rb
 - lib/rails/credentials/conflict/git_conflict_handler.rb
+- lib/rails/credentials/conflict/merge_driver.rb
 - lib/rails/credentials/conflict/merge_strategy.rb
 - lib/rails/credentials/conflict/path_resolver.rb
 - lib/rails/credentials/conflict/railtie.rb
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.0
+rubygems_version: 4.0.3
 specification_version: 4
-summary: Resolve Rails encrypted credentials conflicts during git merges
+summary: Resolve git merge conflicts in Rails encrypted credentials
 test_files: []