conflict_free_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65dd602a264a1ea9cfa015453ed0900eded7695b999b8e6d337c888a0b65508e
+  data.tar.gz: 2c6656c296c93327c1e6522354bce75bb8d167f7bcec85e73d112ef9c1c5f6b8
+SHA512:
+  metadata.gz: 56cf7aa6bf7ffbb148d58ddb72332e0d9fc4afbd2e9b52fcdd2850a377d241f9784ab6c0e8b44f7554a0364cf3e54dea346cb2b168466e7551985b39b036906b
+  data.tar.gz: 935c49c912879ca8ee86aff19fdb83c55136ac82ccc2511000392aa18188e8b71c7b8b1146d7ab77ae3fbcbceb4010feaa8b2f62b028d6a7e41fc42ca6812763

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+.idea/
+.rspec_status
+Gemfile.lock
+gemfiles/*.lock
+log/
+structure.sql
+.bundle/

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "rails-6.0" do
+  gem "rails", "6.0.3.5"
+end
+
+appraise "rails-6.1" do
+  gem "rails", "6.1.3"
+end

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,22 @@
+FROM ruby:2.6.6-buster
+
+ENV BUNDLE_JOBS=4 \
+    BUNDLE_RETRY=5
+
+WORKDIR /app
+
+RUN sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt buster-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+    wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+    apt-get update && apt-get install --no-install-recommends -y \
+    postgresql-client-12 \
+    && rm -rf /var/lib/apt/lists/*
+
+COPY Gemfile Gemfile.lock conflict_free_schema.gemspec ./
+
+ENV BUNDLE_VERSION=2.0.2
+
+RUN gem update --system && gem install bundler:$BUNDLE_VERSION
+RUN bundle install
+
+COPY Appraisals ./
+RUN bundle exec appraisal install

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in conflict-free-schema.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Rafal Wojsznis
+
+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,45 @@
+![71wdVdp0ncL](https://user-images.githubusercontent.com/1527612/111843245-1a0d8b80-8901-11eb-987a-f382d2396f8d.jpg)
+
+### Why stolen ruby?
+
+_Stolen ruby_ is an idea behind extracting open-source code into more accessible packages. I noticed that a lot of interesting projects have quite a lot of brilliant code that is unfortunately often _embedded_ into the source and never extracted - which is a shame because often it's very useful stuff and a lot of different people could benefit from it. The idea is to change that - extract those hidden gems and publish them into the world.
+
+_Note: cover stolen [from well known book](https://austinkleon.com/steal/)._
+
+# conflict_free_schema
+
+![status](https://github.com/stolen-ruby/conflict_free_schema/actions/workflows/ci.yml/badge.svg)
+
+**Stolen from:** [GitLab](https://gitlab.com); references: [merge request](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30109#65c74abf34b80b85fc4b56a98b029c7e2d884bac), [issue](https://gitlab.com/gitlab-org/gitlab/-/issues/218590)
+
+Original author: Patrick Bair; extracted code with very minor modifications, added higher-level Rails integrations tests on top
+
+## Requirements
+
+Rails 6+ with postgresql
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+~~~ruby
+gem 'conflict_free_schema'
+~~~
+
+Then install the gem using bundle:
+
+~~~bash
+bundle install
+~~~
+
+Gem will auto-hook into your rails app via `Rails::Railtie`
+
+## What does it do?
+
+> Remove conflicts from structure.sql that are caused by tracking the schema_migrations.versions information. To do this, store an empty file named after each version under the db/schema_migrations directory. That way when we versions are added or removed, we add or delete files from the directory, which should not conflict with other changes.
+
+If you're using `structure.sql` in your Rails project with postgresql - instead of putting schema version in the sql file upon dump, each migration will be stored as a separate file in `db/schema_migrations` (with a SHA hash as content so it's a unique file from git's perspective). If you're doing a lot of structure changes across your organization it should make the life of your developers much easier - resolving conflicts in structure is pain already - even without the need to resolve schema migrations version numbers.
+
+## Development
+
+You can spin up docker-based development environment with provided `docker-compose` file (useful for Apple M1 users) or simply install dependencies locally.

data/Rakefile

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

data/conflict_free_schema.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |spec|
+  spec.name          = "conflict_free_schema"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Rafal Wojsznis"]
+  spec.email         = ["wojsznis@pm.me"]
+
+  spec.summary       = "Conflict-free schema version handling"
+  spec.description   = "Remove conflicts from structure.sql that are caused by tracking the schema_migrations.versions information."
+  spec.homepage      = "https://github.com/stolen-ruby/conflict-free-schema"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/stolen-ruby/conflict-free-schema"
+  spec.metadata["changelog_uri"] = "https://github.com/stolen-ruby/conflict_free_schema/blob/main/CHANGELOG.md"
+
+  # 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{^(\.github|spec|docker|gemfiles|bin)/}i) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pg"
+  spec.add_dependency "rails", "> 5"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal"
+end

data/docker-compose.yml

@@ -0,0 +1,37 @@
+version: "3"
+services:
+  ruby:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    image: conflict_free_schema
+    environment:
+      BOOTSNAP_CACHE_DIR: /usr/local/bundle/_bootsnap
+      HISTFILE: /app/log/.bash_history
+      PSQL_HISTFILE: /app/log/.psql_history
+    depends_on:
+      postgres:
+        condition: service_healthy
+    volumes:
+      - .:/app:cached
+    tmpfs:
+      - /tmp
+    stdin_open: true
+    tty: true
+  postgres:
+    image: postgres:12.5-alpine
+    volumes:
+      - postgres:/var/lib/postgresql/data
+      - ./log:/root/log:cached
+    environment:
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_DB: conflict_free_schema
+      PSQL_HISTFILE: /root/log/.psql_history
+    healthcheck:
+      test: pg_isready -U postgres -h 127.0.0.1
+      interval: 10s
+      timeout: 3s
+
+volumes:
+  postgres:

data/lib/conflict_free_schema.rb

@@ -0,0 +1,4 @@
+require_relative 'conflict_free_schema/database/postgresql_adapter/dump_schema_version_mixin'
+require_relative 'conflict_free_schema/database/postgresql_database_tasks/load_schema_version_mixin'
+require_relative 'conflict_free_schema/database/schema_version_files'
+require_relative 'conflict_free_schema/railtie'

data/lib/conflict_free_schema/database/postgresql_adapter/dump_schema_version_mixin.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+
+module ConflictFreeSchema
+  module Database
+    module PostgresqlAdapter
+      module DumpSchemaVersionsMixin
+        extend ActiveSupport::Concern
+
+        def dump_schema_information # :nodoc:
+          versions = schema_migration.all_versions
+          ConflictFreeSchema::Database::SchemaVersionFiles.touch_all(versions) if versions.any?
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/conflict_free_schema/database/postgresql_database_tasks/load_schema_version_mixin.rb

@@ -0,0 +1,14 @@
+module ConflictFreeSchema
+  module Database
+    module PostgresqlDatabaseTasks
+      module LoadSchemaVersionsMixin
+        extend ActiveSupport::Concern
+
+        def structure_load(*args)
+          super(*args)
+          ConflictFreeSchema::Database::SchemaVersionFiles.load_all
+        end
+      end
+    end
+  end
+end

data/lib/conflict_free_schema/database/schema_version_files.rb

@@ -0,0 +1,72 @@
+require 'tmpdir'
+require 'digest'
+require 'rails'
+
+module ConflictFreeSchema
+  module Database
+    class SchemaVersionFiles
+      SCHEMA_DIRECTORY = 'db/schema_migrations'
+      MIGRATION_DIRECTORIES = %w[db/migrate db/post_migrate].freeze
+      MIGRATION_VERSION_GLOB = '20[0-9][0-9]*'
+
+      def self.touch_all(versions_from_database)
+        init_schema_directory
+        versions_from_migration_files = find_versions_from_migration_files
+
+        version_filepaths = find_version_filenames.map { |f| schema_directory.join(f) }
+        FileUtils.rm(version_filepaths)
+
+        versions_to_create = versions_from_database & versions_from_migration_files
+        versions_to_create.each do |version|
+          version_filepath = schema_directory.join(version)
+
+          File.open(version_filepath, 'w') do |file|
+            file << Digest::SHA256.hexdigest(version)
+          end
+        end
+      end
+
+      def self.load_all
+        init_schema_directory
+        version_filenames = find_version_filenames
+        return if version_filenames.empty?
+
+        values = version_filenames.map { |vf| "('#{connection.quote_string(vf)}')" }
+        connection.execute(<<~SQL)
+          INSERT INTO schema_migrations (version)
+          VALUES #{values.join(',')}
+          ON CONFLICT DO NOTHING
+        SQL
+      end
+
+      def self.schema_directory
+        @schema_directory ||= Rails.root.join(SCHEMA_DIRECTORY)
+      end
+
+      def self.migration_directories
+        @migration_directories ||= MIGRATION_DIRECTORIES.map { |dir| Rails.root.join(dir) }
+      end
+
+      def self.find_version_filenames
+        Dir.glob(MIGRATION_VERSION_GLOB, base: schema_directory)
+      end
+
+      def self.init_schema_directory
+        FileUtils.mkdir_p(schema_directory)
+      end
+
+      def self.find_versions_from_migration_files
+        migration_directories.each_with_object([]) do |directory, migration_versions|
+          directory_migrations = Dir.glob(MIGRATION_VERSION_GLOB, base: directory)
+          directory_versions = directory_migrations.map! { |m| m.split('_').first }
+
+          migration_versions.concat(directory_versions)
+        end
+      end
+
+      def self.connection
+        ActiveRecord::Base.connection
+      end
+    end
+  end
+end

data/lib/conflict_free_schema/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails/railtie'
+
+module ConflictFreeSchema
+  class Railtie < Rails::Railtie
+    initializer "conflict_free_schema.extend_active_record" do
+      require 'active_record/connection_adapters/postgresql_adapter'
+
+      # Patch to write version information as empty files under the db/schema_migrations directory
+      # This is intended to reduce potential for merge conflicts in db/structure.sql
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(ConflictFreeSchema::Database::PostgresqlAdapter::DumpSchemaVersionsMixin)
+      # Patch to load version information from empty files under the db/schema_migrations directory
+      ActiveRecord::Tasks::PostgreSQLDatabaseTasks.prepend(ConflictFreeSchema::Database::PostgresqlDatabaseTasks::LoadSchemaVersionsMixin)
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: conflict_free_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafal Wojsznis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Remove conflicts from structure.sql that are caused by tracking the schema_migrations.versions
+  information.
+email:
+- wojsznis@pm.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- conflict_free_schema.gemspec
+- docker-compose.yml
+- lib/conflict_free_schema.rb
+- lib/conflict_free_schema/database/postgresql_adapter/dump_schema_version_mixin.rb
+- lib/conflict_free_schema/database/postgresql_database_tasks/load_schema_version_mixin.rb
+- lib/conflict_free_schema/database/schema_version_files.rb
+- lib/conflict_free_schema/railtie.rb
+homepage: https://github.com/stolen-ruby/conflict-free-schema
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stolen-ruby/conflict-free-schema
+  source_code_uri: https://github.com/stolen-ruby/conflict-free-schema
+  changelog_uri: https://github.com/stolen-ruby/conflict_free_schema/blob/main/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.0.3
+signing_key: 
+specification_version: 4
+summary: Conflict-free schema version handling
+test_files: []