column_sync 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1512d2bab77e8503dc4ab8733853e8ef1802c6f4c0a31488614b6c5a0c39ecc
-  data.tar.gz: 4f5484e1809bac2bc7dc6262b29a7a38bbac93e42a04e680773d6bbb048f8cab
+  metadata.gz: b7f7eb5d8496290fa5def80e98ad2460c2c594138b0ee1742ec352cd26df5cab
+  data.tar.gz: 63d4bcc6b35668f914912912dcc1c46aff154aa8396d3a6297e01eb66c09da8b
 SHA512:
-  metadata.gz: 16cb3a76f2c9754ff077efb0612d14c51700aa277b514d9197da1878bcea569b6994ec88048b70777f9ecb570d0b7472eb242f61eab4ca16aa602d7c8329272a
-  data.tar.gz: 1bb08540d79e18d2c4d5b04371c7c3ab8b7d227cc32c3d29778e985a4b237ca8912d52f77ba664da23592b486abf13b992aaf4a51d26dd6c7b68c1cb63ebac92
+  metadata.gz: 8d1024c86f3847a7fd510abb2fb9cd9292204559ba7098c1ae04c1731e829f527b1a62104a9d13803cd954975ea3d2b993ee603494154d2f952404e91788ba8b
+  data.tar.gz: f7ca54ddd71c6e2e43dd1619e6530203f75eb2e597b1bb0a77f9d5df6434bc6d7167b07b3d86d699ef2ddf4dfa051c09068cf374943df18798956c2836e527aa

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2023-12-23
+
+- Added in-memory attribute sync
+
 ## [0.1.0] - 2023-12-10
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,10 @@
 PATH
   remote: .
   specs:
-    column_sync (0.1.0)
+    column_sync (0.2.0)
+      fx (~> 0.8.0)
+      pg (~> 1.5.4)
+      rails (>= 6.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -213,9 +216,6 @@ PLATFORMS
 
 DEPENDENCIES
   column_sync!
-  fx (~> 0.8.0)
-  pg (~> 1.5.4)
-  rails (>= 6.0.0)
   rubocop
 
 BUNDLED WITH

data/README.md

@@ -32,12 +32,67 @@ end
 
 The migration above generates the functions and triggers needed to keep `subscriptions.country_code` in sync with `companies.country`.
 
+You also need to update your models to reflect the syncroniaztion between their columns:
+
+```ruby
+class Company < ApplicationRecord
+  include ColumnSync::Model
+  
+  has_one :subscription
+
+  sync_column :country, to: :subscription, column: :country_code
+end
+
+class Subscription < ApplicationRecord
+  include ColumnSync::Model
+
+  belongs_to :company
+
+  sync_column :country_code, to: :company, column: :country
+end
+```
+
+## Example
+
+Given the following scenario:
+
+```ruby
+Company.create!(country: "es")
+Subscription.create!(country_code: "es", company: Company.first)
+```
+
+Changes are reflected in memory when the value is modified:
+
+```ruby
+company = Company.first
+company.country = "fr"
+company.subscription.country_code
+# => "fr"
+
+company.subscription.country_code = "ca"
+company.country
+# => "ca"
+```
+
+Changes are also reflected in the DB when the value is persisted:
+
+```ruby
+company = Company.first
+company.update(country: "it")
+company.subscription.country_code
+# => "it"
+
+company.subscription.update(country_code: "ma")
+company.country
+# => "ma" 
+```
+
 ## 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 is assumed that 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/lib/column_sync/migration.rb

@@ -3,6 +3,9 @@
 module ColumnSync
   module Migration
     def sync_columns(columns)
+      FileUtils.mkdir_p("db/functions")
+      FileUtils.mkdir_p("db/triggers")
+
       service = Service.new(columns)
 
       each_function(service) { |name| create_function(name) }

data/lib/column_sync/model.rb

@@ -0,0 +1,48 @@
+require "active_support/concern"
+
+module ColumnSync
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      scope :disabled, -> { where(disabled: true) }
+
+      before_update :propagate_changes
+
+      private
+
+      def propagate_changes
+        changes.each do |attribute, (_before, after)|
+          propagate_changes_in_memory(attribute, after)
+        end
+      end
+
+      def propagate_changes_in_memory(attribute, value)
+        self.class.columns_to_sync[attribute]&.each do |sync|
+          object = public_send(sync[:to])
+          next unless object
+
+          current_value = object.attributes[sync[:column].to_s]
+
+          object.public_send("#{sync[:column]}=", value) if current_value.to_s != value.to_s
+        end
+      end
+    end
+
+    class_methods do
+      attr_reader :columns_to_sync
+
+      def sync_column(column_name, to:, column:)
+        @columns_to_sync ||= {}
+        @columns_to_sync[column_name.to_s] ||= []
+        @columns_to_sync[column_name.to_s] << { to: to, column: column }
+
+        define_method("#{column_name}=") do |value|
+          super(value)
+
+          propagate_changes_in_memory(column_name.to_s, value)
+        end
+      end
+    end
+  end
+end

data/lib/column_sync/version.rb

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

data/lib/column_sync.rb

@@ -6,6 +6,7 @@ require "fx"
 require "column_sync/version"
 require "column_sync/service"
 require "column_sync/migration"
+require "column_sync/model"
 
 module ColumnSync
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: column_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Manuel Bustillo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2023-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fx
@@ -17,7 +17,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.0
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -31,7 +31,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.4
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -45,7 +45,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -82,6 +82,7 @@ files:
 - Rakefile
 - lib/column_sync.rb
 - lib/column_sync/migration.rb
+- lib/column_sync/model.rb
 - lib/column_sync/service.rb
 - lib/column_sync/version.rb
 - sig/column_sync.rbs