table_sync 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d78fecdf8f43cfa8a84fb4ce366af5c9a8da236988b66887ef5aff16c40e3f89
-  data.tar.gz: 47ad42e41cc6b3383977aa63105a8dc7c575115dddd00f868acfb6b4a15f73b5
+  metadata.gz: 9e2da80dd5ebdacac4e255dd9aacae603e6c76c5f52677db25fab0e1bb0dc15e
+  data.tar.gz: 6edc6c7805c4f9eea01b43fb14dc3bb19e3af906a1016b2308350077935c911a
 SHA512:
-  metadata.gz: 17b77342ca100235816dbc5d1dabf9391eb0a612eb5c540776b6e7f234f23da4a50fe802a62e511e4148657f804a6e04159560798f650dfd3fb1c3b8f07cb005
-  data.tar.gz: 83e53da6b5895ee392a7b0d53e70509ce453c7973a0f08d3b8bd1b7cea7dc50d252a1848506206cbcfef80fa80bc16abea3f1f711ce4806097a540fac31e0bc3
+  metadata.gz: 3b2981462066a389651bef3be1a8301ce165d9b25298b0b912f3002a27daef1e566dc932dbe2aa5c89c70806457449c5c189949fd10c4d9efabf69ba37ee5627
+  data.tar.gz: 47c419f7dbdcfc4e8517604b4df14aaccf40d67eb2071e5991a6ccf211d6698735c22aad2cfba339b2d1b9d7b45405d7071b04045ac94c17fb8f8dd379d4eeaf

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [5.1.0] - 2021-09-09
+
+### Changed
+- Provide current fired event to wrap receiver. You'll be able to get it with `wrap_receiving(event:, **rest) {}` as usual for `data, target_keys, version_key`
+- Update rails dependencies with patch version
+
+## [5.0.1] - 2021-04-06
+### Fixed
+- documentation
+
+### Changed
+- update gems
+
 ## [5.0.0] - 2021-03-04
 ### Fixed
 - Fix `delete` events being broken when either `#attrs_for_routing_key` or `#attrs_for_metadata` was defined on a model.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    table_sync (5.0.0)
+    table_sync (5.1.0)
       memery
       rabbit_messaging
       rails
@@ -10,60 +10,60 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.3)
-      actionpack (= 6.1.3)
-      activejob (= 6.1.3)
-      activerecord (= 6.1.3)
-      activestorage (= 6.1.3)
-      activesupport (= 6.1.3)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       mail (>= 2.7.1)
-    actionmailer (6.1.3)
-      actionpack (= 6.1.3)
-      actionview (= 6.1.3)
-      activejob (= 6.1.3)
-      activesupport (= 6.1.3)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.3)
-      actionview (= 6.1.3)
-      activesupport (= 6.1.3)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.3)
-      actionpack (= 6.1.3)
-      activerecord (= 6.1.3)
-      activestorage (= 6.1.3)
-      activesupport (= 6.1.3)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       nokogiri (>= 1.8.5)
-    actionview (6.1.3)
-      activesupport (= 6.1.3)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.3)
-      activesupport (= 6.1.3)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
       globalid (>= 0.3.6)
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activestorage (6.1.3)
-      actionpack (= 6.1.3)
-      activejob (= 6.1.3)
-      activerecord (= 6.1.3)
-      activesupport (= 6.1.3)
-      marcel (~> 0.3.1)
-      mimemagic (~> 0.3.2)
-    activesupport (6.1.3)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -72,13 +72,14 @@ GEM
     amq-protocol (2.3.2)
     ast (2.4.2)
     builder (3.2.4)
-    bundler-audit (0.7.0.1)
+    bundler-audit (0.8.0)
       bundler (>= 1.2.0, < 3)
-      thor (>= 0.18, < 2)
-    bunny (2.17.0)
+      thor (~> 1.0)
+    bunny (2.19.0)
       amq-protocol (~> 2.3, >= 2.3.1)
+      sorted_set (~> 1, >= 1.0.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     diff-lcs (1.4.4)
     docile (1.3.5)
@@ -86,29 +87,27 @@ GEM
     exception_notification (4.4.3)
       actionmailer (>= 4.0, < 7)
       activesupport (>= 4.0, < 7)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.9)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     lamian (1.2.0)
       rails (>= 4.2)
-    loofah (2.9.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
-    memery (1.3.0)
+    marcel (1.0.1)
+    memery (1.4.1)
       ruby2_keywords (~> 0.0.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
+    mini_mime (1.1.1)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
-    nio4r (2.5.7)
-    nokogiri (1.11.1)
-      mini_portile2 (~> 2.5.0)
+    nio4r (2.5.8)
+    nokogiri (1.12.4)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
     parallel (1.20.1)
     parser (3.0.0.0)
@@ -117,7 +116,7 @@ GEM
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rabbit_messaging (0.9.0)
+    rabbit_messaging (0.12.0)
       bunny (~> 2.0)
       exception_notification
       lamian
@@ -128,36 +127,37 @@ GEM
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.3)
-      actioncable (= 6.1.3)
-      actionmailbox (= 6.1.3)
-      actionmailer (= 6.1.3)
-      actionpack (= 6.1.3)
-      actiontext (= 6.1.3)
-      actionview (= 6.1.3)
-      activejob (= 6.1.3)
-      activemodel (= 6.1.3)
-      activerecord (= 6.1.3)
-      activestorage (= 6.1.3)
-      activesupport (= 6.1.3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       bundler (>= 1.15.0)
-      railties (= 6.1.3)
+      railties (= 6.1.4.1)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 0.13)
       thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.3)
+    rake (13.0.6)
+    rbtree (0.4.4)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -204,11 +204,12 @@ GEM
     rubocop-sequel (0.2.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
+    ruby2_keywords (0.0.5)
     self_data (1.2.1)
-    sequel (5.42.0)
+    sequel (5.43.0)
     serverengine (2.0.7)
       sigdump (~> 0.2.2)
+    set (1.0.1)
     sigdump (0.2.4)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -223,6 +224,9 @@ GEM
       rake
       serverengine (~> 2.0.5)
       thor
+    sorted_set (1.0.3)
+      rbtree
+      set (~> 1.0)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -237,7 +241,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     zeitwerk (2.4.2)
@@ -262,4 +266,4 @@ DEPENDENCIES
   timecop
 
 BUNDLED WITH
-   2.2.11
+   2.2.27

data/docs/publishing.md

@@ -41,7 +41,7 @@ Example:
 ```ruby
 class TableSync::Job < ActiveJob::Base
   def perform(*args)
-    TableSync::Publisher.new(*args).publish_now
+    TableSync::Publishing::Publisher.new(*args).publish_now
   end
 end
 ```
@@ -70,16 +70,16 @@ TableSync.routing_metadata_callable = -> (klass, attributes) { attributes.slice(
 
 # Manual publishing
 
-`TableSync::Publisher.new(object_class, original_attributes, confirm: true, state: :updated, debounce_time: 45)`
+`TableSync::Publishing::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
 
-You can use `TableSync::BatchPublisher` to publish changes in batches (array of hashes in `attributes`).
+You can use `TableSync::Publishing::BatchPublisher` to publish changes in batches (array of hashes in `attributes`).
 
-When using `TableSync::BatchPublisher`,` TableSync.routing_key_callable` is called as follows: `TableSync.routing_key_callable.call(klass, {})`, i.e. empty hash is passed instead of attributes. And `TableSync.routing_metadata_callable` is not called at all: metadata is set to empty hash.
+When using `TableSync::Publishing::BatchPublisher`,` TableSync.routing_key_callable` is called as follows: `TableSync.routing_key_callable.call(klass, {})`, i.e. empty hash is passed instead of attributes. And `TableSync.routing_metadata_callable` is not called at all: metadata is set to empty hash.
 
-`TableSync::BatchPublisher.new(object_class, original_attributes_array, **options)`, where `original_attributes_array` is an array with hash of attributes of published objects and `options` is a hash of options.
+`TableSync::Publishing::BatchPublisher.new(object_class, original_attributes_array, **options)`, where `original_attributes_array` is an array with hash of attributes of published objects and `options` is a hash of options.
 
 `options` consists of:
 - `confirm`, which is a flag for RabbitMQ, `true` by default
@@ -92,7 +92,7 @@ original_attributes_array will be pushed to Rabbit instead of fetching records f
 Example:
 
 ```ruby
-TableSync::BatchPublisher.new(
+TableSync::Publishing::BatchPublisher.new(
   "SomeClass",
   [{ id: 1 }, { id: 2 }],
   confirm: false,
@@ -105,11 +105,11 @@ TableSync::BatchPublisher.new(
 
 # Manual publishing with batches (Russian)
 
-С помощью класса `TableSync::BatchPublisher` вы можете опубликовать изменения батчами (массивом в `attributes`).
+С помощью класса `TableSync::Publishing::BatchPublisher` вы можете опубликовать изменения батчами (массивом в `attributes`).
 
-При использовании `TableSync::BatchPublisher`, `TableSync.routing_key_callable` вызывается следующим образом: `TableSync.routing_key_callable.call(klass, {})`, то есть вместо аттрибутов передается пустой хэш. А `TableSync.routing_metadata_callable` не вызывается вовсе: в метадате устанавливается пустой хэш.
+При использовании `TableSync::Publishing::BatchPublisher`, `TableSync.routing_key_callable` вызывается следующим образом: `TableSync.routing_key_callable.call(klass, {})`, то есть вместо аттрибутов передается пустой хэш. А `TableSync.routing_metadata_callable` не вызывается вовсе: в метадате устанавливается пустой хэш.
 
-`TableSync::BatchPublisher.new(object_class, original_attributes_array, **options)`, где `original_attributes_array` - массив с аттрибутами публикуемых объектов и `options`- это хэш с дополнительными опциями.
+`TableSync::Publishing::BatchPublisher.new(object_class, original_attributes_array, **options)`, где `original_attributes_array` - массив с аттрибутами публикуемых объектов и `options`- это хэш с дополнительными опциями.
 
 `options` состоит из:
 - `confirm`, флаг для RabbitMQ, по умолчанию - `true`
@@ -121,7 +121,7 @@ TableSync::BatchPublisher.new(
 Example:
 
 ```ruby
-TableSync::BatchPublisher.new(
+TableSync::Publishing::BatchPublisher.new(
   "SomeClass",
   [{ id: 1 }, { id: 2 }],
   confirm: false,

data/docs/receiving.md

@@ -68,7 +68,7 @@ The method receives following arguments
 - `events` - array of supported events (optional)
 - `block` - configuration block with options (optional)
 
-This method implements logic of mapping `source` to `to_table` (or to `to_model`) and allows customizing 
+This method implements logic of mapping `source` to `to_table` (or to `to_model`) and allows customizing
 the event handling logic with provided block.
 You can use one `source` for a lot of `to_table` or `to_moel`.
 
@@ -235,12 +235,13 @@ default value is `false`
 Proc that is used to wrap the receiving logic by custom block of code.
 
 ```ruby
-wrap_receiving do |data:, target_keys:, version_key:, default_values: {}, &receiving_logic|
+wrap_receiving do |data:, target_keys:, version_key:, default_values: {}, event:, &receiving_logic|
   receiving_logic.call
   return makes no sense
 end
 ```
 
+event option is current fired event
 default value is `proc { |&block| block.call }`
 
 #### before_update
@@ -262,15 +263,17 @@ end
 Perform code after updated data was committed.
 
 ```ruby
-after_commit_on_update do |data:, target_keys:, version_key:, default_values:|
+after_commit_on_update do |data:, target_keys:, version_key:, default_values:, results:|
   return makes no sense
 end
 
-after_commit_on_update do |data:, target_keys:, version_key:, default_values:|
+after_commit_on_update do |data:, target_keys:, version_key:, default_values:, results:|
   return makes no sense
 end
 ```
 
+- `results` - returned value from `model.upsert`
+
 Сan be defined several times. Execution order guaranteed.
 
 #### before_destroy
@@ -292,15 +295,17 @@ end
 Perform code after destroyed data was committed.
 
 ```ruby
-after_commit_on_destroy do |data:, target_keys:, version_key:|
+after_commit_on_destroy do |data:, target_keys:, version_key:, results:|
   return makes no sense
 end
 
-after_commit_on_destroy do |data:, target_keys:, version_key:|
+after_commit_on_destroy do |data:, target_keys:, version_key:, results:|
   return makes no sense
 end
 ```
 
+- `results` - returned value from `model.destroy`
+
 Сan be defined several times. Execution order guaranteed.
 
 ### Custom model

data/lib/table_sync/receiving/handler.rb

@@ -31,7 +31,7 @@ class TableSync::Receiving::Handler < Rabbit::EventHandler
         params[:default_values] = config.default_values(data: data)
       end
 
-      config.wrap_receiving(**params) do
+      config.wrap_receiving(event: event, **params) do
         perform(config, params)
       end
     end

data/lib/table_sync/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_sync
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Umbrellio
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memery
@@ -317,7 +317,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.11
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: DB Table synchronization between microservices based on Model's event system