git-driver-merge-structure-sql 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e61232c5b081e9fbaecaf0863159d88e404492a43ed1893306e946a6e5a8ddf
+  data.tar.gz: a7ef1741fa075f99ca06946e915a63dc8c1817570ebce7d2cda51e234dd3a55a
+SHA512:
+  metadata.gz: 9ab42fcc95eb6509ddc249bca5367f87d8694b257785047d5a20e99bf411c466fa697465711ef9e18ac04da14f0eae4e7c8a2c8c36774897438cde59f2a33320
+  data.tar.gz: 2f0060eedf7c56845daa706e1733acc97e3ba71637cbceb2fc0b8349bc85228a0ea49131341eaa3b760dc421bc7591125472de5f7710924f363c8efe3ebbb471

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Change Log
+
+## 1.0.0 (2018-11-29)
+
+- Initial release
+
+## 1.1.0 (2018-11-30)
+
+- Add support for the latest MySQL dump format
+- Mention support for the SQLite3 dump format
+
+## 1.1.1 (2021-04-28)
+
+- Fix installation when the attribute file does not exist yet
+
+## 1.1.2 (2021-04-30)
+
+- Implemnt local installation with --install=local
+
+## 1.2.0 (2024-12-16)
+
+- Implement reverse ordering

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in git-merge-structure-sql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2018-2021 Akinori MUSHA
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.	 IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,55 @@
+# git-merge-structure-sql
+
+This is a merge driver for Git that resolves typical merge conflicts
+in a `db/structure.sql` file of Rails.
+
+When your project is configured with
+`config.active_record.schema_format = :sql`, the database schema is
+kept in `db/structure.sql` instead of `db/schema.rb` in the native
+dump format of the underlying database engine, which is not suitable
+for the default merge driver of Git to deal with.  As a result, when
+you try to merge two branches you always have to resolve trivial
+conflicts manually if new schema migrations take place in both
+branches.  This custom driver takes away such a pain.
+
+Currently only PostgreSQL, MySQL and SQLite3 dump formats are
+supported.
+
+## Installation
+
+Run this:
+
+    $ gem install git-merge-structure-sql
+
+And enable it yourself in your Git configuration, or let it do that
+for you by this command:
+
+    $ git-merge-structure-sql --install
+
+This adds necessary settings to your `~/.gitconfig` or
+`$XDG_CONFIG_HOME/git/config` and the default gitattributes(5) file to
+enable the merge driver for structure.sql files.
+
+If you want to enable this driver only in the current git directory,
+run this:
+
+    $ git-merge-structure-sql --install=local
+
+## Usage
+
+Once enabled, Git should call this driver as necessary when it needs
+to merge changes made in structure.sql.
+
+## History
+
+See `CHANGELOG.md` for the version history.
+
+## Author
+
+Copyright (c) 2018-2021 Akinori MUSHA.
+
+Licensed under the 2-clause BSD license.  See `LICENSE.txt` for
+details.
+
+Visit the [GitHub Repository](https://github.com/knu/sidetiq-timezone)
+for the latest information.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "git-driver-merge-structure-sql"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/git-driver-merge-structure-sql

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "git-driver-merge-structure-sql"
+
+StructureSqlMergeDriver.new.main(*ARGV)

data/git-driver-merge-structure-sql.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "git-driver-merge-structure-sql"
+
+Gem::Specification.new do |spec|
+  spec.name          = "git-driver-merge-structure-sql"
+  spec.version       = StructureSqlMergeDriver::VERSION
+  spec.authors       = ["Akinori MUSHA", "Joe Degler"]
+  spec.email         = ["knu@idaemons.org", "joe@degler.dev"]
+  spec.license       = "BSD-2-Clause"
+
+  spec.summary       = %q{git merge driver for db/structure.sql in a Rails project. Originally forked from git-merge-structure-sql}
+  spec.homepage      = "https://github.com/Joe-Degler/git-driver-merge-structure-sql"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "https://github.com/Joe-Degler/git-driver-merge-structure-sql/blob/master/CHANGELOG.md"
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/git-driver-merge-structure-sql.rb

@@ -0,0 +1,258 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# git-driver-merge-structure-sql - git merge driver for db/structure.sql in a Rails project
+#
+# How to use:
+#     $ git-driver-merge-structure-sql --install
+#
+# Copyright (c) 2018-2021 Akinori MUSHA
+#
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 1. Redistributions of source code must retain the above copyright
+#    notice, this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+# SUCH DAMAGE.
+#
+
+class StructureSqlMergeDriver
+  VERSION = '1.2.0'
+  VARIANTS = []
+
+  module Default # This covers PostgreSQL, SQLite and newer MySQL formats.
+    RE_VERSION = /^\('(\d+)'\)[,;]\n/
+    RE_VERSIONS = /^INSERT INTO (?<q>["`])schema_migrations\k<q> \(version\) VALUES\n\K#{RE_VERSION}+/
+
+    class << self
+      def match?(content)
+        RE_VERSIONS === content
+      end
+
+      def merge!(*contents)
+        merge_versions!(*contents)
+      end
+
+      private
+
+      def merge_versions!(*contents)
+        replacement = format_versions(
+          contents.inject([]) { |versions, content|
+            versions | content[RE_VERSIONS].scan(RE_VERSION).flatten
+          }.sort.reverse
+        )
+
+        contents.each { |content|
+          content.sub!(RE_VERSIONS, replacement)
+        }
+      end
+
+      def format_versions(versions)
+        versions.map { |version| "('%s')" % version }.join(",\n") << ";\n"
+      end
+    end
+
+    VARIANTS.unshift self
+  end
+
+  module MySQL
+    class << self
+      RE_DUMP_TIMESTAMP = /^-- Dump completed on \K.+$/
+      RE_AUTO_INCREMENT_VALUE = /^\)(?= ).*\K AUTO_INCREMENT=\d+(?=.*;$)/
+      RE_VERSION = /^INSERT INTO schema_migrations \(version\) VALUES \('(\d+)'\);\s+/
+      RE_VERSIONS = /#{RE_VERSION}+/
+
+      def match?(content)
+        /^-- MySQL dump / === content
+      end
+
+      def merge!(*contents)
+        merge_dump_timestamps!(*contents)
+        scrub_auto_increment_values!(*contents)
+        merge_versions!(*contents)
+      end
+
+      private
+
+      def merge_dump_timestamps!(*contents)
+        replacement = contents.inject('') { |timestamp, content|
+          [timestamp, *content.scan(RE_DUMP_TIMESTAMP)].max rescue ''
+        }
+
+        unless replacement.empty?
+          contents.each { |content|
+            content.gsub!(RE_DUMP_TIMESTAMP, replacement)
+          }
+        end
+      end
+
+      def scrub_auto_increment_values!(*contents)
+        contents.each { |content|
+          content.gsub!(RE_AUTO_INCREMENT_VALUE, '')
+        }
+      end
+
+      def merge_versions!(*contents)
+        replacement = format_versions(
+          contents.inject([]) { |versions, content|
+            versions | content.scan(RE_VERSION).flatten
+          }.sort.reverse
+        )
+
+        contents.each { |content|
+          content.sub!(RE_VERSIONS, replacement)
+        }
+      end
+
+      def format_versions(versions)
+        versions.map { |version| "INSERT INTO schema_migrations (version) VALUES ('%s');\n\n" % version }.join
+      end
+    end
+
+    VARIANTS.unshift self
+  end
+
+  def system!(*args)
+    system(*args) or exit $?.exitstatus
+  end
+
+  def main(*argv)
+    require 'optparse'
+    require 'shellwords'
+
+    myname = File.basename($0)
+    driver_name = 'merge-structure-sql'
+
+    banner = <<~EOF
+      #{myname} - git merge driver for db/structure.sql in a Rails project #{VERSION}
+
+      usage: #{myname} <current-file> <base-file> <other-file>
+             #{myname} --install
+
+    EOF
+
+    install = false
+
+    opts = OptionParser.new(banner) { |opts|
+      opts.version = VERSION
+      opts.summary_indent = ''
+      opts.summary_width = 24
+
+      opts.on('--install[={global|local}]',
+        "Enable this merge driver in Git (default: global)") { |val|
+        case install = val&.to_sym || :global
+        when :global, :local
+          # ok
+        else
+          raise OptionParser::InvalidArgument, "--install=#{val}: unknown argument"
+        end
+      }
+    }
+
+    files = opts.order(argv)
+
+    if install
+      global = install == :global
+
+      git_config = ["git", "config", *("--global" if global)]
+
+      config_file = `GIT_EDITOR=echo #{git_config.shelljoin} -e 2>/dev/null`.chomp
+
+      puts "#{config_file}: Adding the \"#{driver_name}\" driver definition"
+
+      system!(
+        *git_config,
+        "merge.#{driver_name}.name",
+        "Rails structure.sql merge driver"
+      )
+      system!(
+        *git_config,
+        "merge.#{driver_name}.driver",
+        "#{myname.shellescape} %A %O %B"
+      )
+
+      attributes_file =
+        if global
+          filename = `git config --global core.attributesfile`.chomp
+
+          if $?.success?
+            File.expand_path(filename)
+          else
+            [
+              [File.join(ENV['XDG_CONFIG_HOME'] || '~/.config', 'git'), 'attributes'],
+              ['~', '.gitattributes']
+            ].find { |dir, file|
+              if File.directory?(File.expand_path(dir))
+                system!(*%W[
+                  git config --global core.attributesfile #{File.join(dir, file)}
+                ])
+                break File.expand_path(file, dir)
+              end
+            } or raise "don't you have home?"
+          end
+        else
+          git_dir = `git rev-parse --git-dir`.chomp
+
+          if $?.success?
+            File.expand_path(File.join('info', 'attributes'), git_dir)
+          else
+            raise "not in a git directory"
+          end
+        end
+
+      File.open(attributes_file, 'a+') { |f|
+        pattern = /^\s*structure.sql\s+(?:\S+\s+)*merge=#{Regexp.quote(driver_name)}(?:\s|$)/
+        break if f.any? { |line| pattern === line }
+
+        puts "#{attributes_file}: Registering the \"#{driver_name}\" driver for structure.sql"
+        f.puts if f.pos > 0
+        f.puts "structure.sql merge=#{driver_name}"
+      }
+
+      exit
+    end
+
+    unless files.size == 3
+      STDERR.print opts.help
+      exit 64
+    end
+
+    contents = files.map { |file| File.read(file) }
+
+    sample = contents[0]
+    if variant = VARIANTS.find { |v| v.match?(sample) }
+      variant.merge!(*contents)
+
+      files.zip(contents) do |file, content|
+        File.write(file, content)
+      end
+    else
+      STDERR.puts "#{myname}: Unsupported format; falling back to git-merge-file(1)"
+    end
+
+    exec(*%W[git merge-file -q], *files)
+  rescue => e
+    STDERR.puts "#{myname}: #{e.message}"
+    exit 1
+  end
+end
+
+if $0 == __FILE__
+  StructureSqlMergeDriver.new.main(*ARGV)
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: git-driver-merge-structure-sql
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Akinori MUSHA
+- Joe Degler
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- knu@idaemons.org
+- joe@degler.dev
+executables:
+- git-driver-merge-structure-sql
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/git-driver-merge-structure-sql
+- git-driver-merge-structure-sql.gemspec
+- lib/git-driver-merge-structure-sql.rb
+homepage: https://github.com/Joe-Degler/git-driver-merge-structure-sql
+licenses:
+- BSD-2-Clause
+metadata:
+  homepage_uri: https://github.com/Joe-Degler/git-driver-merge-structure-sql
+  source_code_uri: https://github.com/Joe-Degler/git-driver-merge-structure-sql
+  changelog_uri: https://github.com/Joe-Degler/git-driver-merge-structure-sql/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: git merge driver for db/structure.sql in a Rails project. Originally forked
+  from git-merge-structure-sql
+test_files: []