table_sync 1.12.1 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 979b79907f09475cf112a2b921326b5f1725b2231878ec5c2b182c5179f0c12c
-  data.tar.gz: d74fd6fb5a73eaec7cc6447c239c1b51eb7a1a7718ec010121d52f43df551c4a
+  metadata.gz: 01c6a6ad4b67454e29e7eaf06f85c09f4d786fc7842ef34cc87bc1db29937765
+  data.tar.gz: 5ffdfad99bdd53182870f0297c9bba8181884b51fc8a7bcc234ec8fd7a5035ee
 SHA512:
-  metadata.gz: b89efc1b8b42c8ab941afdda6d0ba688b279a8c4f1caf6fd9898a14406088ef7e26dcd452a2538542551e0c8606a47097799477f581d9e991f40999ce119ce30
-  data.tar.gz: 46c2d7c70a6faf75cd4b7edddaa834b7e842c7e8450c28f7c5c0609824bda56e4bae4b6224346af0420ed59d70c0c6213523615068031a838640dce4ecdcdb1f
+  metadata.gz: b7c21a601fa063b33ee9f13d580700c5ba2f70c88cdf59fbccc1fe5e9bb4a88d7cba8336dae55be7154e4aaf07194f869789c0b6a6886a04d7dc08db2dfa3f15
+  data.tar.gz: 378f2049f688922282d0b99972b28e021b36508fc153c8546085b710ca1649993d4e19f1dfa5eaebe9041dfdbd0b871ddef1f042a0bf29825dee8ebfa6ac69bc

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [1.13.0] - 2019-11-02
+### Added
+- Wrapping interface around receiving logic (`wrap_receiving`);
+
 ## [1.12.1] - 2019-09-27
 ### Fixed
 - The `default_values` option no longer overrides original values.

data/docs/synopsis.md

@@ -84,7 +84,7 @@ to default Rabbit gem configuration).
 
 # Manual publishing
 
-`TableSync::Publisher.new(object_class, original_attributes, confirm: true, state: :updated, debounce_time: 45)` 
+`TableSync::Publisher.new(object_class, original_attributes, confirm: true, state: :updated, debounce_time: 45)`
 where state is one of `:created / :updated / :destroyed` and `confirm` is Rabbit's confirm delivery flag and optional param `debounce_time` determines debounce time in seconds, 1 minute by default.
 
 # Manual publishing with batches
@@ -224,17 +224,33 @@ The following options are available inside the block:
 - `additional_data` - additional data for insert or update (e.g. `project_id`)
 - `default_values` - values for insert if a row is not found
 - `partitions` - proc that is used to obtain partitioned data to support table partitioning. Must return a hash which
- keys are names of partitions of partitioned table and values - arrays of attributes to be inserted into particular
- partition `{ measurements_2018_01: [ { attrs }, ... ], measurements_2018_02: [ { attrs }, ... ], ...}`.
- While the proc is called inside an upsert transaction it is suitable place for creating partitions for new data.
- Note that transaction of proc is a TableSynk.orm transaction.
-
-```ruby
-partitions do |data:|
-  data.group_by { |d| "measurements_#{d[:time].year}_#{d[:time].month}" }
-      .tap { |data| data.keys.each { |table| DB.run("CREATE TABLE IF NOT EXISTS #{table} PARTITION OF measurements") } }
-end
-```
+  keys are names of partitions of partitioned table and values - arrays of attributes to be inserted into particular
+  partition `{ measurements_2018_01: [ { attrs }, ... ], measurements_2018_02: [ { attrs }, ... ], ...}`.
+  While the proc is called inside an upsert transaction it is suitable place for creating partitions for new data.
+  Note that transaction of proc is a TableSynk.orm transaction.
+  ```ruby
+  partitions do |data:|
+    data.group_by { |d| "measurements_#{d[:time].year}_#{d[:time].month}" }
+        .tap { |data| data.keys.each { |table| DB.run("CREATE TABLE IF NOT EXISTS #{table} PARTITION OF measurements") } }
+  end
+  ```
+- `wrap_reciving` - proc that is used to wrap the receiving logic by custom block of code. Receives `data` and `receiving` attributes
+  (received event data and receiving logic proc respectively). `receiving.call` runs receiving process (you should use it manually).
+    - example (concurrent receiving):
+    ```ruby
+      wrap_receiving do |data, receiving|
+        Locking.acquire("some-lock-key") { receiving.call }
+      end
+    ```
+  - `data` attribute:
+    - for `destroy` event - an instance of `TableSync::EventActions::DataWrapper::Destroy`;
+    - for `update` event - an instance of `TableSync::EventActions::DataWrapper::Update`;
+    - `#event_data` - raw recevied event data:
+      - for `destroy` event - simple `Hash`;
+      - for `update` event - `Hash` with `Hash<ModelKlass, Array<Hash<Symbol, Object>>>` signature;
+    - `#destroy?` / `#update?` - corresponding predicates;
+    - `#type` - indicates a type of data (`:destroy` and `:update` respectively);
+    - `#each` - iterates over `#event_data` elements (acts like an iteration over an array of elements);
 
 Each of options can receive static value or code block which will be called for each event with the following arguments:
 - `event` - type of event (`:update` or `:destroy`)
@@ -283,7 +299,7 @@ You have access to the payload, which contains  `event`, `direction`, `table`, `
   :event => :update,       # one of update / destroy
   :direction => :publish,  # one of publish / receive
   :table => "users",
-  :schema => "public",  
+  :schema => "public",
   :count => 1
 }
 ```

data/lib/table_sync.rb

@@ -10,6 +10,7 @@ module TableSync
   require_relative "./table_sync/version"
   require_relative "./table_sync/errors"
   require_relative "./table_sync/event_actions"
+  require_relative "./table_sync/event_actions/data_wrapper"
   require_relative "./table_sync/config"
   require_relative "./table_sync/config/callback_registry"
   require_relative "./table_sync/config_decorator"

data/lib/table_sync/config.rb

@@ -19,6 +19,7 @@ module TableSync
       @version_key = :version
       @first_sync_time_key = nil
       @on_destroy = nil
+      @wrap_receiving = nil
       target_keys(model.primary_keys)
     end
 
@@ -71,6 +72,10 @@ module TableSync
       block_given? ? @on_destroy = block : @on_destroy
     end
 
+    def wrap_receiving(&block)
+      block_given? ? @wrap_receiving = block : @wrap_receiving
+    end
+
     check_and_set_column_key = proc do |key|
       key = key.to_sym
       raise "#{model.inspect} doesn't have key: #{key}" unless model.columns.include?(key)

data/lib/table_sync/config_decorator.rb

@@ -6,7 +6,7 @@ module TableSync
     include ::TableSync::EventActions
     extend Forwardable
 
-    def_delegators :@config, :on_destroy
+    def_delegators :@config, :on_destroy, :wrap_receiving
 
     def initialize(config, handler)
       @config = config

data/lib/table_sync/event_actions.rb

@@ -2,13 +2,29 @@
 
 module TableSync
   module EventActions
-    def update(data) # rubocop:disable Metrics/MethodLength
+    def update(data)
       data.each_value do |attribute_set|
         attribute_set.each do |attributes|
           prevent_incomplete_event!(attributes)
         end
       end
 
+      with_wrapping(DataWrapper::Update.new(data)) do
+        process_upsert(data)
+      end
+    end
+
+    def destroy(data)
+      attributes = data.first || {}
+      target_attributes = attributes.select { |key, _value| target_keys.include?(key) }
+      prevent_incomplete_event!(target_attributes)
+
+      with_wrapping(DataWrapper::Destroy.new(attributes)) do
+        process_destroy(attributes, target_attributes)
+      end
+    end
+
+    def process_upsert(data) # rubocop:disable Metrics/MethodLength
       model.transaction do
         args = {
           data: data,
@@ -37,11 +53,7 @@ module TableSync
       end
     end
 
-    def destroy(data)
-      attributes = data.first || {}
-      target_attributes = attributes.select { |key, _value| target_keys.include?(key) }
-      prevent_incomplete_event!(target_attributes)
-
+    def process_destroy(attributes, target_attributes)
       model.transaction do
         @config.callback_registry.get_callbacks(kind: :before_commit, event: :destroy).each do |cb|
           cb[attributes]
@@ -63,6 +75,14 @@ module TableSync
       end
     end
 
+    def with_wrapping(data = {}, &block)
+      if @config.wrap_receiving
+        @config.wrap_receiving.call(data, block)
+      else
+        yield
+      end
+    end
+
     def expected_update_result?(query_results)
       query_results.uniq { |d| d.slice(*target_keys) }.size == query_results.size
     end

data/lib/table_sync/event_actions/data_wrapper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TableSync::EventActions::DataWrapper
+  require_relative "data_wrapper/base"
+  require_relative "data_wrapper/destroy"
+  require_relative "data_wrapper/update"
+end

data/lib/table_sync/event_actions/data_wrapper/base.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class TableSync::EventActions::DataWrapper::Base
+  include Enumerable
+
+  attr_reader :event_data
+
+  def initialize(event_data)
+    @event_data = event_data
+  end
+
+  def type
+    raise NoMethodError # NOTE: for clarity
+  end
+
+  def destroy?
+    false
+  end
+
+  def update?
+    false
+  end
+end

data/lib/table_sync/event_actions/data_wrapper/destroy.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class TableSync::EventActions::DataWrapper::Destroy < TableSync::EventActions::DataWrapper::Base
+  def type
+    :destroy
+  end
+
+  def each
+    yield(event_data)
+  end
+
+  def destroy?
+    true
+  end
+
+  def update?
+    false
+  end
+end

data/lib/table_sync/event_actions/data_wrapper/update.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class TableSync::EventActions::DataWrapper::Update < TableSync::EventActions::DataWrapper::Base
+  def type
+    :update
+  end
+
+  def each
+    event_data.each_pair do |model_klass, changed_models_attrs|
+      yield([model_klass, changed_models_attrs])
+    end
+  end
+
+  def destroy?
+    false
+  end
+
+  def update?
+    true
+  end
+end

data/lib/table_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TableSync
-  VERSION = "1.12.1"
+  VERSION = "1.13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_sync
 version: !ruby/object:Gem::Version
-  version: 1.12.1
+  version: 1.13.0
 platform: ruby
 authors:
 - Umbrellio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2019-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memery
@@ -263,6 +263,10 @@ files:
 - lib/table_sync/dsl.rb
 - lib/table_sync/errors.rb
 - lib/table_sync/event_actions.rb
+- lib/table_sync/event_actions/data_wrapper.rb
+- lib/table_sync/event_actions/data_wrapper/base.rb
+- lib/table_sync/event_actions/data_wrapper/destroy.rb
+- lib/table_sync/event_actions/data_wrapper/update.rb
 - lib/table_sync/instrument.rb
 - lib/table_sync/instrument_adapter/active_support.rb
 - lib/table_sync/model/active_record.rb