sync_machine 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102155af0851cece6b27470411c50f11c945be750d08c6acb98093b011f65e85
-  data.tar.gz: 956031cb81b308903a5606d43c877eed613f4c3a3302b655592f1ce891197357
+  metadata.gz: 582b683ceda765fc486ebbe449206c61ad2aceded9e1f0cdc68a023510f4ebbb
+  data.tar.gz: 4145f8fca67cca0a36dbde2b7302333d0f3da6c8aa56ef0bf00106b49f45f5b6
 SHA512:
-  metadata.gz: 0e0718d0e199a23ca685eccd530cffa3bdd49969925536d2881fea680126aa96a83a8ebae0ea871e93179670928df40b4564962c02d10641bf2b92d6159f571a
-  data.tar.gz: 52ac953901aed56ca103e58e7285fc15bb2acdec89a9ad9f88531b01e91d080aaed78892e9d835b6df6e55b7219c475681fd10708d79b1f94557b4a269ac633a
+  metadata.gz: 06cbe6d8e456c10ae14466501f7995be45f58b43dcf3b4b51c7cb1f0cbca1888d9eff76d12790ac17867ce551431734348cfdd6c728f44f1316d70482ded446a
+  data.tar.gz: c188d5bc1baa7c74dd9a4dc947ca8df7cdd41e823ac4577dd46265dc3607d2d79200b8f79985d44c1d9e1e0bf0eb565a507445f98ee99b52ac85eeadc121b064

data/.travis.yml

@@ -2,6 +2,15 @@
 sudo: false
 language: ruby
 cache: bundler
+gemfile:
+  - Gemfile.mongoid6-activesupport5
+  - Gemfile.mongoid7
 rvm:
   - 2.4.2
+  - 2.5.7
+  - 2.6.3
+matrix:
+  exclude:
+    - gemfile: Gemfile.mongoid7
+      rvm: 2.4.2
 before_install: gem install bundler -v 2.0.1

data/Gemfile.mongoid6-activesupport5

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'activesupport', '>= 5', '< 6'
+gem 'mongoid', '>= 6', '< 7'
+
+# Development dependencies
+gem 'activerecord'
+gem 'factory_bot'
+gem 'fhwang-wisper-mongoid', '>= 0.3.0'
+gem 'gemika'
+gem 'opentracing'
+gem 'rspec'
+gem 'sqlite3'
+gem 'wisper-activerecord'
+
+# Gem under test
+gem 'sync_machine', path: '.'

data/Gemfile.mongoid6-activesupport5.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    sync_machine (1.2.0)
+      activesupport
+      sidekiq
+      wisper
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    bson (4.6.0)
+    concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    fhwang-wisper-mongoid (0.3.0)
+      activesupport
+      mongoid (>= 6)
+      wisper
+    gemika (0.4.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.13.0)
+    mongo (2.11.1)
+      bson (>= 4.6.0, < 5.0.0)
+    mongoid (6.4.4)
+      activemodel (>= 5.1, < 6.0.0)
+      mongo (>= 2.5.1, < 3.0.0)
+    opentracing (0.5.0)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
+    redis (4.1.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    sidekiq (5.2.7)
+      connection_pool (~> 2.2, >= 2.2.2)
+      rack (>= 1.5.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    wisper (2.0.1)
+    wisper-activerecord (1.0.0)
+      activerecord (>= 3.0.0)
+      wisper (~> 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  activesupport (>= 5, < 6)
+  factory_bot
+  fhwang-wisper-mongoid (>= 0.3.0)
+  gemika
+  mongoid (>= 6, < 7)
+  opentracing
+  rspec
+  sqlite3
+  sync_machine!
+  wisper-activerecord
+
+BUNDLED WITH
+   2.0.2

data/Gemfile.mongoid7

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Runtime dependencies
+gem 'mongoid', '>= 7'
+
+# Development dependencies
+gem 'activerecord'
+gem 'factory_bot'
+gem 'fhwang-wisper-mongoid', '>= 0.3.0'
+gem 'gemika'
+gem 'opentracing'
+gem 'rspec'
+gem 'sqlite3'
+gem 'wisper-activerecord'
+
+# Gem under test
+gem 'sync_machine', path: '.'

data/Gemfile.mongoid7.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    sync_machine (1.2.0)
+      activesupport
+      sidekiq
+      wisper
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.1)
+      activesupport (= 6.0.1)
+    activerecord (6.0.1)
+      activemodel (= 6.0.1)
+      activesupport (= 6.0.1)
+    activesupport (6.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    bson (4.6.0)
+    concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    factory_bot (5.1.1)
+      activesupport (>= 4.2.0)
+    fhwang-wisper-mongoid (0.3.0)
+      activesupport
+      mongoid (>= 6)
+      wisper
+    gemika (0.4.0)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.13.0)
+    mongo (2.11.1)
+      bson (>= 4.6.0, < 5.0.0)
+    mongoid (7.0.5)
+      activemodel (>= 5.1, < 6.1)
+      mongo (>= 2.5.1, < 3.0.0)
+    opentracing (0.5.0)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
+    redis (4.1.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    sidekiq (6.0.3)
+      connection_pool (>= 2.2.2)
+      rack (>= 2.0.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    sqlite3 (1.4.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    wisper (2.0.1)
+    wisper-activerecord (1.0.0)
+      activerecord (>= 3.0.0)
+      wisper (~> 2.0)
+    zeitwerk (2.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  factory_bot
+  fhwang-wisper-mongoid (>= 0.3.0)
+  gemika
+  mongoid (>= 7)
+  opentracing
+  rspec
+  sqlite3
+  sync_machine!
+  wisper-activerecord
+
+BUNDLED WITH
+   2.0.2

data/Rakefile

@@ -1,6 +1,7 @@
 require "bundler/gem_tasks"
+require "gemika/tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: 'matrix:spec'

data/lib/rails/generators/templates/ensure_publication_worker.rb

@@ -3,6 +3,9 @@ module <%= class_name %>
     check_publishable do |<%= subject %>|
       # Return a boolean value indicating whether the <%= subject %>
       # should be published at all.
+      #
+      # This step is optional.  If the step is deleted, the <%= subject %>
+      # is considered always publishable.
     end
 
     build do |<%= subject %>|
@@ -14,8 +17,9 @@ module <%= class_name %>
     end
 
     after_publish do |<%= subject %>|
-      # Execute any actions after a successful publish.  This step is optional
-      # and can be deleted entirely.
+      # Execute any actions after a successful publish.
+      #
+      # This step is optional and can be deleted entirely.
     end
   end
 end

data/lib/sync_machine/change_listener.rb

@@ -8,7 +8,15 @@ module SyncMachine
   # occurs.
   class ChangeListener
     def self.inherited(base)
-      base.cattr_accessor :model_syms
+      base.cattr_accessor :model_syms do
+        []
+      end
+    end
+
+    def self.define_method_matching_wisper_event(event)
+      define_method(event) do |subject|
+        find_subjects_async(subject)
+      end
     end
 
     def self.listen_to_models(*model_syms)
@@ -22,6 +30,12 @@ module SyncMachine
       end
     end
 
+    def self.listen_to_wisper_events(*events)
+      events.each do |event|
+        define_method_matching_wisper_event(event)
+      end
+    end
+
     def self.subscribe
       Wisper.subscribe(new)
     end
@@ -34,24 +48,15 @@ module SyncMachine
 
     def after_record_saved(record)
       return unless orm_adapter.sufficient_changes_to_find_subjects?(record)
-      sync_module = SyncMachine.sync_module(self.class)
-      finder_class = sync_module.const_get('FindSubjectsWorker')
-      finder_class.perform_async(
-        record.class.name,
-        record_id_for_job(record.id),
-        changed_keys(record),
-        Time.now.to_json
-      )
+      find_subjects_async(record)
     end
 
     private
 
-    def changed_keys(record)
-      orm_adapter.change_listener_changed_keys(record)
-    end
-
-    def record_id_for_job(record_id)
-      orm_adapter.record_id_for_job(record_id)
+    def find_subjects_async(record)
+      sync_module = SyncMachine.sync_module(self.class)
+      finder_class = sync_module.const_get('FindSubjectsWorker')
+      finder_class.perform_async_for_record(record)
     end
 
     def orm_adapter

data/lib/sync_machine/ensure_publication.rb

@@ -47,8 +47,12 @@ module SyncMachine
       )
     end
 
+    def publishable?
+      !hook(:check_publishable) || hook(:check_publishable).call(@subject)
+    end
+
     def run_deduped
-      return unless hook(:check_publishable).call(@subject)
+      return unless publishable?
       if publication_history.last_publish_equals?(payload_body)
         publication_history.record_generation_time
       else

data/lib/sync_machine/find_subjects_worker.rb

@@ -30,6 +30,16 @@ module SyncMachine
       end
     end
 
+    def self.perform_async_for_record(record)
+      sync_module = SyncMachine.sync_module(self)
+      orm_adapter = sync_module.orm_adapter
+      record_id_for_job = orm_adapter.record_id_for_job(record.id)
+      changed_keys = orm_adapter.change_listener_changed_keys(record)
+      perform_async(
+        record.class.name, record_id_for_job, changed_keys, Time.now.to_json
+      )
+    end
+
     # :reek:LongParameterList is unavoidable here since this is a Sidekiq
     # worker
     def perform(record_class_name, record_id, changed_keys, enqueue_time_str)

data/lib/sync_machine/version.rb

@@ -1,3 +1,3 @@
 module SyncMachine
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.0".freeze
 end

data/sync_machine.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "factory_bot"
   spec.add_development_dependency "fhwang-wisper-mongoid"
+  spec.add_development_dependency "gemika"
   spec.add_development_dependency "mongoid"
   spec.add_development_dependency "opentracing"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_machine
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Francis Hwang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-26 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gemika
+  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'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +237,10 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.mongoid6-activesupport5
+- Gemfile.mongoid6-activesupport5.lock
+- Gemfile.mongoid7
+- Gemfile.mongoid7.lock
 - LICENSE.txt
 - README.md
 - Rakefile