table_sync 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c09777052902dc012d825d79668aeebe130d2fd4fcfefb77d3d33bbb1dc511
-  data.tar.gz: ec571dc138e800ada7e0f4fd112516caed6f110bbaabcc64cdfb3aac36b81989
+  metadata.gz: fd4c73054274dd89d2a58f98fb0974a4202a78aad3512a9d85e50219ab4dc7b0
+  data.tar.gz: 50f863a5e00336c03c58d19733354d7287db2a66e5c415ff784c23501642331d
 SHA512:
-  metadata.gz: 18ed6af8a53a850c59ec1fbffa2ae9e85d197644528cbde81f8502fce2a88affbedfed071890430f0abbcfa718c11567c0171eef2f90886d6d01ff4db21c10fa
-  data.tar.gz: ea36659bef94f7cf27109c8882f5f6e5cacc90201032024ce8c41ce0bac3449dfb3172d0ba675b0f5b8d075e82bd9b0807571f49340e2d6e6a62330028c7695f
+  metadata.gz: 8bd844b57952aa85a32324832660b73270a28bce1c3b3a16e8a12bf02d6858531da2d1475f19865e13378b9c355639a17cf37c6f35a0b8067118d423cd9d9825
+  data.tar.gz: 9e5911d3ed2050128d3b7ec63c9e8d3fe1ec8c464026f531cc16a6ad183e739fdd730f1a4890176a2c3194c894f07ffd7a39b12d0e69a54c643aeac6ac021ec8

data/.rubocop.yml

@@ -10,3 +10,7 @@ AllCops:
     - Gemfile
     - Rakefile
     - table_sync.gemspec
+
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [2.2.0] - 2020-04-12
+### Added
+- Introduce Plugin ecosystem (**TableSync::Plugins**);
+
+## [2.1.1] - 2020-04-10
+### Fixed
+- Updated docs for batch_publishing to fully reflect changes in 2.1.0
+
 ## [2.1.0] - 2020-04-09
 ### Added
 - **TableSync::BatchPublisher**: custom headers;

data/README.md

@@ -21,6 +21,7 @@ require 'table_sync'
 ## Usage
 
 - [Documentation](docs/synopsis.md)
+- [Development](docs/development.md)
 
 ## Contributing
 

data/docs/development.md

@@ -0,0 +1,43 @@
+# TableSync (development)
+
+## Table of Contents
+
+- [Creation and registration of the new plugin](#creation-and-registration-of-the-new-plugin)
+
+### Creation and registration of the new plugin
+
+* Create a class inherited from `TableSync::Plugins::Abstract` (recommendation: place it in the plugins directory (`lib/plugins/`));
+* Implement `.install!` method (`TableSync::Plugins::Abstract.install!`)
+* Register the newly created class in plugins ecosystem (`TableSync.register_plugin('plugin_name', PluginClass))`);
+* Usage: `TableSync.enable(:plugin_name)` / `TableSync.plugin(:plugin_name)` / `TableSync.load(:plugin_name)` (string name is supported too);
+
+Example:
+
+```ruby
+# 1) creation (lib/plugins/global_method.rb)
+class TableSync::Plugins::GlobalMethod < TableSync::Plugins::Abstract
+  class << self
+    # 2) plugin loader method implementation
+    def install!
+      ::TableSync.extend(Module.new do
+        def global_method
+          :works!
+        end
+      end)
+    end
+  end
+end
+
+# 3) plugin registration
+TableSync.register('global_method', TableSync::Plugins::GlobalMethod)
+
+# 4) enable registerd plugin
+TableSync.plugin(:global_method) # string is supported too
+# --- or ---
+TableSync.enable(:global_method) # string is supported too
+# --- or ---
+TableSync.load(:global_method) # string is supported too
+
+# Your new functionality
+TableSync.global_method # => :works!
+```

data/docs/synopsis.md

@@ -90,11 +90,10 @@ where state is one of `:created / :updated / :destroyed` and `confirm` is Rabbit
 # Manual publishing with batches
 
 You can use `TableSync::BatchPublisher` to publish changes in batches (array of hashes in `attributes`).
-For now, only the following changes in the table can be published: `create` and` update`.
 
 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: header value is set to empty hash.
+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.
 
@@ -123,11 +122,10 @@ TableSync::BatchPublisher.new(
 # Manual publishing with batches (Russian)
 
 С помощью класса `TableSync::BatchPublisher` вы можете опубликовать изменения батчами (массивом в `attributes`).
-Пока можно публиковать только следующие изменения в таблице: `создание записи` и `обновление записи`.
 
 При использовании `TableSync::BatchPublisher`, `TableSync.routing_key_callable` вызывается следующим образом:
 `TableSync.routing_key_callable.call(klass, {})`, то есть вместо аттрибутов передается пустой хэш.
-А `TableSync.routing_metadata_callable` не вызывается вовсе: в хидерах устанавливается пустой хэш.
+А `TableSync.routing_metadata_callable` не вызывается вовсе: в метадате устанавливается пустой хэш.
 
 `TableSync::BatchPublisher.new(object_class, original_attributes_array, **options)`, где `original_attributes_array` - массив с аттрибутами публикуемых объектов и `options`- это хэш с дополнительными опциями.
 

data/lib/table_sync.rb

@@ -7,26 +7,31 @@ require "active_support/core_ext/object/blank"
 require "active_support/core_ext/numeric/time"
 
 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"
-  require_relative "./table_sync/dsl"
-  require_relative "./table_sync/receiving_handler"
-  require_relative "./table_sync/base_publisher"
-  require_relative "./table_sync/publisher"
-  require_relative "./table_sync/batch_publisher"
-  require_relative "./table_sync/orm_adapter/active_record"
-  require_relative "./table_sync/orm_adapter/sequel"
-  require_relative "./table_sync/model/active_record"
-  require_relative "./table_sync/model/sequel"
-  require_relative "./table_sync/instrument"
-  require_relative "./table_sync/instrument_adapter/active_support"
-  require_relative "./table_sync/naming_resolver/active_record"
-  require_relative "./table_sync/naming_resolver/sequel"
+  require_relative "table_sync/version"
+  require_relative "table_sync/errors"
+  require_relative "table_sync/plugins"
+  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"
+  require_relative "table_sync/dsl"
+  require_relative "table_sync/receiving_handler"
+  require_relative "table_sync/base_publisher"
+  require_relative "table_sync/publisher"
+  require_relative "table_sync/batch_publisher"
+  require_relative "table_sync/orm_adapter/active_record"
+  require_relative "table_sync/orm_adapter/sequel"
+  require_relative "table_sync/model/active_record"
+  require_relative "table_sync/model/sequel"
+  require_relative "table_sync/instrument"
+  require_relative "table_sync/instrument_adapter/active_support"
+  require_relative "table_sync/naming_resolver/active_record"
+  require_relative "table_sync/naming_resolver/sequel"
+
+  # @api public
+  # @since 2.2.0
+  extend Plugins::AccessMixin
 
   class << self
     include Memery

data/lib/table_sync/errors.rb

@@ -38,4 +38,26 @@ module TableSync
       MSG
     end
   end
+
+  # @api public
+  # @since 2.2.0
+  PluginError = Class.new(Error)
+
+  # @api public
+  # @since 2.2.0
+  class UnregisteredPluginError < PluginError
+    # @param plugin_name [Any]
+    def initialize(plugin_name)
+      super("#{plugin_name} plugin is not registered")
+    end
+  end
+
+  # @api public
+  # @since 2.2.0
+  class AlreadyRegisteredPluginError < PluginError
+    # @param plugin_name [Any]
+    def initialize(plugin_name)
+      super("#{plugin_name} plugin already exists")
+    end
+  end
 end

data/lib/table_sync/plugins.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# @api public
+# @since 2.2.0
+module TableSync::Plugins
+  require_relative "plugins/registry"
+  require_relative "plugins/access_mixin"
+  require_relative "plugins/abstract"
+
+  # @since 2.2.0
+  @plugin_registry = Registry.new
+  # @since 2.2.0
+  @access_lock = Mutex.new
+
+  class << self
+    # @param plugin_name [Symbol, String]
+    # @return [void]
+    #
+    # @api public
+    # @since 2.2.0
+    def load(plugin_name)
+      thread_safe { plugin_registry[plugin_name].load! }
+    end
+
+    # @return [Array<String>]
+    #
+    # @api public
+    # @since 2.2.0
+    def loaded_plugins
+      thread_safe { plugin_registry.loaded.keys }
+    end
+
+    # @return [Array<String>]
+    #
+    # @api public
+    # @since 2.2.0
+    def names
+      thread_safe { plugin_registry.names }
+    end
+
+    # @param plugin_name [Symbol, String]
+    # @return [void]
+    #
+    # @api private
+    # @since 2.2.0
+    def register_plugin(plugin_name, plugin_module)
+      thread_safe { plugin_registry[plugin_name] = plugin_module }
+    end
+
+    private
+
+    # @return [TableSync::Plugins::Registry]
+    #
+    # @api private
+    # @since 2.2.0
+    attr_reader :plugin_registry
+
+    # @return [Mutex]
+    #
+    # @api private
+    # @since 2.2.0
+    attr_reader :access_lock
+
+    # @return [void]
+    #
+    # @api private
+    # @since 2.2.0
+    def thread_safe
+      access_lock.synchronize { yield if block_given? }
+    end
+  end
+end

data/lib/table_sync/plugins/abstract.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 2.2.0
+class TableSync::Plugins::Abstract
+  class << self
+    # @param child_klass [Class]
+    # @return [void]
+    #
+    # @api private
+    # @since 2.2.0
+    def inherited(child_klass)
+      child_klass.instance_variable_set(:@__loaded__, false)
+      child_klass.instance_variable_set(:@__lock__, Mutex.new)
+      super
+    end
+
+    # @return [void]
+    #
+    # @api private
+    # @since 2.2.0
+    def load!
+      __thread_safe__ do
+        unless @__loaded__
+          @__loaded__ = true
+          install!
+        end
+      end
+    end
+
+    # @return [Boolean]
+    #
+    # @api private
+    # @since 2.2.0
+    def loaded?
+      __thread_safe__ { @__loaded__ }
+    end
+
+    private
+
+    # @return [void]
+    #
+    # @api private
+    # @since 2.2.0
+    def install!; end
+
+    # @return [Any]
+    #
+    # @api private
+    # @since 2.2.0
+    def __thread_safe__
+      @__lock__.synchronize { yield }
+    end
+  end
+end

data/lib/table_sync/plugins/access_mixin.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 2.2.0
+module TableSync::Plugins::AccessMixin
+  # @param plugin_name [Symbol, String]
+  # @return [void]
+  #
+  # @see TableSync::Plugins
+  #
+  # @api public
+  # @since 2.2.0
+  def plugin(plugin_name)
+    TableSync::Plugins.load(plugin_name)
+  end
+  alias_method :enable, :plugin
+  alias_method :load, :plugin
+
+  # @return [Array<String>]
+  #
+  # @see TableSync::Plugins
+  #
+  # @api public
+  # @since 2.2.0
+  def plugins
+    TableSync::Plugins.names
+  end
+
+  # @return [Hash<String,Class<TableSync::Plugins::Abstract>>]
+  #
+  # @api private
+  # @since 2.2.0
+  def loaded_plugins
+    TableSync::Plugins.loaded_plugins
+  end
+  alias_method :enabled_plugins, :loaded_plugins
+
+  # @param plugin_name [String, Symbol]
+  # @param plugin_klass [Class<TableSync::Plugins::Abstract>]
+  # @return [void]
+  #
+  # @see TableSync::Plugins
+  #
+  # @api public
+  # @since 2.2.0
+  def register_plugin(plugin_name, plugin_klass)
+    TableSync::Plugins.register_plugin(plugin_name, plugin_klass)
+  end
+end

data/lib/table_sync/plugins/registry.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 2.2.0
+class TableSync::Plugins::Registry
+  include Enumerable
+
+  # @return [void]
+  #
+  # @api private
+  # @since 2.2.0
+  def initialize
+    @plugin_set = {}
+    @access_lock = Mutex.new
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [TableSync::Plugins::Abstract]
+  #
+  # @api private
+  # @since 2.2.0
+  def [](plugin_name)
+    thread_safe { fetch(plugin_name) }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [TableSync::Plugins::Abstract]
+  # @return [void]
+  #
+  # @api private
+  # @since 2.2.0
+  def register(plugin_name, plugin_module)
+    thread_safe { apply(plugin_name, plugin_module) }
+  end
+  alias_method :[]=, :register
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 2.2.0
+  def names
+    thread_safe { plugin_names }
+  end
+
+  # @return [Hash<String,Class<TableSync::Plugins::Abstract>>]
+  #
+  # @api private
+  # @since 2.2.0
+  def loaded
+    thread_safe { loaded_plugins }
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 2.2.0
+  def each(&block)
+    thread_safe { iterate(&block) }
+  end
+
+  private
+
+  # @return [Hash]
+  #
+  # @api private
+  # @since 2.2.0
+  attr_reader :plugin_set
+
+  # @return [Mutex]
+  #
+  # @api private
+  # @since 2.2.0
+  attr_reader :access_lock
+
+  # @return [void]
+  #
+  # @api private
+  # @since 2.2.0
+  def thread_safe
+    access_lock.synchronize { yield if block_given? }
+  end
+
+  # @return [Array<String>]
+  #
+  # @api private
+  # @since 2.2.0
+  def plugin_names
+    plugin_set.keys
+  end
+
+  # @param block [Block]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 2.2.0
+  def iterate(&block)
+    block_given? ? plugin_set.each_pair(&block) : plugin_set.each_pair
+  end
+
+  # @param plugin_name [String]
+  # @return [Boolean]
+  #
+  # @api private
+  # @since 2.2.0
+  def registered?(plugin_name)
+    plugin_set.key?(plugin_name)
+  end
+
+  # @return [Array<TableSync::Plugins::Abstract>]
+  #
+  # @api private
+  # @since 2.2.0
+  def loaded_plugins
+    plugin_set.select { |_plugin_name, plugin_module| plugin_module.loaded? }
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @param plugin_module [TableSync::Plugins::Abstract]
+  # @return [void]
+  #
+  # @raise [TableSync::AlreadyRegisteredPluginError]
+  #
+  # @api private
+  # @since 2.2.0
+  def apply(plugin_name, plugin_module)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+    raise(TableSync::AlreadyRegisteredPluginError.new(plugin_name)) if registered?(plugin_name)
+    plugin_set[plugin_name] = plugin_module
+  end
+
+  # @param plugin_name [Symbol, String]
+  # @return [TableSync::Plugins::Abstract]
+  #
+  # @raise [TableSync::UnregisteredPluginError]
+  #
+  # @api private
+  # @since 2.2.0
+  def fetch(plugin_name)
+    plugin_name = indifferently_accessible_plugin_name(plugin_name)
+    raise(TableSync::UnregisteredPluginError.new(plugin_name)) unless registered?(plugin_name)
+    plugin_set[plugin_name]
+  end
+
+  # @param key [Symbol, String]
+  # @return [String]
+  #
+  # @api private
+  # @since 2.2.0
+  def indifferently_accessible_plugin_name(plugin_name)
+    plugin_name.to_s
+  end
+end

data/lib/table_sync/version.rb

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

data/table_sync.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "coveralls", "~> 0.8"
   spec.add_development_dependency "rspec", "~> 3.8"
-  spec.add_development_dependency "rubocop-config-umbrellio", "~> 0.74"
+  spec.add_development_dependency "rubocop-config-umbrellio", "~> 0.81"
   spec.add_development_dependency "simplecov", "~> 0.16"
 
   spec.add_development_dependency "activejob", ">= 4.2.11"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: table_sync
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Umbrellio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-09 00:00:00.000000000 Z
+date: 2020-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memery
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.81'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.74'
+        version: '0.81'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +253,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/development.md
 - docs/synopsis.md
 - lib/table_sync.rb
 - lib/table_sync/base_publisher.rb
@@ -275,6 +276,10 @@ files:
 - lib/table_sync/naming_resolver/sequel.rb
 - lib/table_sync/orm_adapter/active_record.rb
 - lib/table_sync/orm_adapter/sequel.rb
+- lib/table_sync/plugins.rb
+- lib/table_sync/plugins/abstract.rb
+- lib/table_sync/plugins/access_mixin.rb
+- lib/table_sync/plugins/registry.rb
 - lib/table_sync/publisher.rb
 - lib/table_sync/receiving_handler.rb
 - lib/table_sync/version.rb