column_sync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1512d2bab77e8503dc4ab8733853e8ef1802c6f4c0a31488614b6c5a0c39ecc
+  data.tar.gz: 4f5484e1809bac2bc7dc6262b29a7a38bbac93e42a04e680773d6bbb048f8cab
+SHA512:
+  metadata.gz: 16cb3a76f2c9754ff077efb0612d14c51700aa277b514d9197da1878bcea569b6994ec88048b70777f9ecb570d0b7472eb242f61eab4ca16aa602d7c8329272a
+  data.tar.gz: 1bb08540d79e18d2c4d5b04371c7c3ab8b7d227cc32c3d29778e985a4b237ca8912d52f77ba664da23592b486abf13b992aaf4a51d26dd6c7b68c1cb63ebac92

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-12-10
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,222 @@
+PATH
+  remote: .
+  specs:
+    column_sync (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.2)
+      actionpack (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.2)
+      actionpack (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activesupport (= 7.1.2)
+      marcel (~> 1.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    fx (0.8.0)
+      activerecord (>= 6.0.0)
+      railties (>= 6.0.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.10.1)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    minitest (5.20.0)
+    mutex_m (0.2.0)
+    net-imap (0.4.8)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.15.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pg (1.5.4)
+    psych (5.1.1.1)
+      stringio
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.2)
+      actioncable (= 7.1.2)
+      actionmailbox (= 7.1.2)
+      actionmailer (= 7.1.2)
+      actionpack (= 7.1.2)
+      actiontext (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activemodel (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.1)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.1)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    stringio (3.1.0)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  column_sync!
+  fx (~> 0.8.0)
+  pg (~> 1.5.4)
+  rails (>= 6.0.0)
+  rubocop
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Manuel Bustillo Alonso
+
+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,43 @@
+# ColumnSync
+
+Keeping in sync columns in different tables is a pretty common step during database refactorings. The
+`column_sync` gem provides ActiveRecord migration helpers to facilitate the sync of data between
+columns.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add column_sync
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install column_sync
+
+## Usage
+
+The following snippet should be used as a migration template:
+
+```ruby
+class SyncColumns < ActiveRecord::Migration[7.1]
+  def up
+    sync_columns(Subscription => :country_code, Company => :country)
+  end
+
+  def down
+    unsync_columns(Subscription => :country_code, Company => :country)
+  end
+end
+```
+
+The migration above generates the functions and triggers needed to keep `subscriptions.country_code` in sync with `companies.country`.
+
+## Limitations
+
+- Each `sync_columns` statement can only sync a pair of columns. If the same column needs to be synchronized across multiple
+  tables, multiple such statements will be needed.
+- The gem expects a `has_one` - `belongs_to` association between the models involved. It uses Rails reflections to understand
+  the table names and column names involved.
+- The columns involved in the migration will be kept in sync via database triggers executed on row update.
+  It assumes the records are initially in sync, so it does **not** automatically sync values using any of the two columns involved.
+- It also does not sync values when a row is created, only when it is modified.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[rubocop]

data/lib/column_sync/migration.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module ColumnSync
+  module Migration
+    def sync_columns(columns)
+      service = Service.new(columns)
+
+      each_function(service) { |name| create_function(name) }
+      each_trigger(service) { |name, table_name| create_trigger(name, on: table_name) }
+    end
+
+    def unsync_columns(columns)
+      service = Service.new(columns)
+
+      each_trigger(service) { |name, table_name| drop_trigger(name, on: table_name) }
+      each_function(service) { |name| drop_function(name) }
+    end
+
+    private
+
+    def each_function(service)
+      service.functions.each do |name, definition|
+        function_name = "#{name}_v01".to_sym
+        file_name = "db/functions/#{function_name}.sql"
+        File.open(file_name, "w") { |f| f.write(definition) }
+        yield name
+      ensure
+        FileUtils.rm_f(file_name)
+      end
+    end
+
+    def each_trigger(service)
+      service.triggers.each do |name, config|
+        trigger_name = "#{name}_v01".to_sym
+        file_name = "db/triggers/#{trigger_name}.sql"
+        File.open(file_name, "w") { |f| f.write(config[:definition]) }
+        yield name, config[:table_name]
+      ensure
+        FileUtils.rm_f(file_name)
+      end
+    end
+  end
+end

data/lib/column_sync/service.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module ColumnSync
+  class Service
+    FUNCTION_PREFIX = "column_sync"
+    attr_reader :referenced_table_name,
+                :referenced_column_name,
+                :referenced_primary_key,
+                :referencer_table_name,
+                :referencer_column_name,
+                :referencer_fk_column_name
+
+    def initialize(columns)
+      raise ArgumentError, "columns must be a hash" unless columns.is_a?(Hash)
+      raise ArgumentError, "two tables and columns must be provided" unless columns.size == 2
+
+      referenced_model, referencer_model = columns.keys.permutation(2).find do |(referenced, referencer)|
+        referenced.reflect_on_all_associations(:has_one)
+                  .find { |association| association.klass == referencer }
+                  .tap { |association| @referencer_fk_column_name = association.foreign_key if association }
+      end
+
+      raise ArgumentError, "no valid column relation found" unless referenced_model && referencer_model
+
+      @referenced_column_name = columns[referenced_model].to_s
+      @referencer_column_name = columns[referencer_model].to_s
+
+      unless referenced_model.column_names.include?(referenced_column_name)
+        raise ArgumentError, "referenced column #{referenced_column_name} does not exist"
+      end
+
+      unless referencer_model.column_names.include?(referencer_column_name)
+        raise ArgumentError, "referencer column #{referencer_column_name} does not exist"
+      end
+
+      @referenced_table_name = referenced_model.table_name
+      @referenced_primary_key = referenced_model.primary_key
+      @referencer_table_name = referencer_model.table_name
+    end
+
+    def functions
+      {
+        referencer_sync_name => referencer_update_function,
+        referenced_sync_name => referenced_update_function
+      }
+    end
+
+    def triggers
+      {
+        referencer_sync_name => { definition: referencer_trigger, table_name: referenced_table_name },
+        referenced_sync_name => { definition: referenced_trigger, table_name: referencer_table_name }
+      }
+    end
+
+    private
+
+    def referencer_sync_name
+      "#{FUNCTION_PREFIX}_#{referencer_table_name}_#{referencer_column_name}_on_#{referenced_table_name}_update"
+    end
+
+    def referenced_sync_name
+      "#{FUNCTION_PREFIX}_#{referenced_table_name}_#{referenced_column_name}_on_#{referencer_table_name}_update"
+    end
+
+    def referencer_update_function
+      <<~SQL
+        CREATE OR REPLACE FUNCTION #{FUNCTION_PREFIX}_#{referencer_table_name}_#{referencer_column_name}_on_#{referenced_table_name}_update()
+        RETURNS TRIGGER AS $$
+        BEGIN
+        IF NEW.#{referenced_column_name} IS DISTINCT FROM OLD.#{referenced_column_name} THEN
+          UPDATE #{referencer_table_name}
+          SET #{referencer_column_name} = NEW.#{referenced_column_name}
+          WHERE #{referencer_fk_column_name} = NEW.#{referenced_primary_key};
+        END IF;
+        RETURN NEW;
+        END;
+        $$ LANGUAGE plpgsql;
+      SQL
+    end
+
+    def referenced_update_function
+      <<~SQL
+        CREATE OR REPLACE FUNCTION #{FUNCTION_PREFIX}_#{referenced_table_name}_#{referenced_column_name}_on_#{referencer_table_name}_update()
+        RETURNS TRIGGER AS $$
+        BEGIN
+        IF NEW.#{referencer_column_name} IS DISTINCT FROM OLD.#{referencer_column_name} THEN
+          UPDATE #{referenced_table_name}
+          SET #{referenced_column_name} = NEW.#{referencer_column_name}
+          WHERE #{referenced_primary_key} = NEW.#{referencer_fk_column_name};
+        END IF;
+        RETURN NEW;
+        END;
+        $$ LANGUAGE plpgsql;
+      SQL
+    end
+
+    def referencer_trigger
+      <<~SQL
+        CREATE TRIGGER #{FUNCTION_PREFIX}_#{referencer_table_name}_#{referencer_column_name}_on_#{referenced_table_name}_update
+        AFTER UPDATE ON #{referenced_table_name}
+        FOR EACH ROW EXECUTE PROCEDURE #{FUNCTION_PREFIX}_#{referencer_table_name}_#{referencer_column_name}_on_#{referenced_table_name}_update();
+      SQL
+    end
+
+    def referenced_trigger
+      <<~SQL
+        CREATE TRIGGER #{FUNCTION_PREFIX}_#{referenced_table_name}_#{referenced_column_name}_on_#{referencer_table_name}_update
+        AFTER UPDATE ON #{referencer_table_name}
+        FOR EACH ROW EXECUTE PROCEDURE #{FUNCTION_PREFIX}_#{referenced_table_name}_#{referenced_column_name}_on_#{referencer_table_name}_update();
+      SQL
+    end
+  end
+end

data/lib/column_sync/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ColumnSync
+  VERSION = "0.1.0"
+end

data/lib/column_sync.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "fx"
+
+require "column_sync/version"
+require "column_sync/service"
+require "column_sync/migration"
+
+module ColumnSync
+  class Error < StandardError; end
+
+  ::ActiveRecord::Migration.include(ColumnSync::Migration)
+end

data/sig/column_sync.rbs

@@ -0,0 +1,4 @@
+module ColumnSync
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: column_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manuel Bustillo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.4
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: 
+email:
+- bustikiller@bustikiller.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/column_sync.rb
+- lib/column_sync/migration.rb
+- lib/column_sync/service.rb
+- lib/column_sync/version.rb
+- sig/column_sync.rbs
+homepage: https://github.com/bustikiller/column_sync
+licenses: []
+metadata:
+  homepage_uri: https://github.com/bustikiller/column_sync
+  source_code_uri: https://github.com/bustikiller/column_sync
+  changelog_uri: https://github.com/bustikiller/column_sync/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: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: A ruby gem to sync values between columns using Postgres and Rails
+test_files: []