sync_machine 0.8.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b00a4dbacf75b3f31caf20ef9e230ddbddea1f3e0fc0e6611b9f8956d89b135
-  data.tar.gz: 98e2325ac8aa3dd3ab7d1fe378433df87f5ac66f5dbec252e3869e2ab3fb3597
+  metadata.gz: 590006776b984bcede930cae17327932ac2e5c2e6b0d4bfab23e3f3742d0ecfa
+  data.tar.gz: 7e04325fae0528ba6fe48d413827c694aed86f13d69460dfb96782f38f25bc03
 SHA512:
-  metadata.gz: beec8451ec62b0392c92460aa7c962894740b077d7379d2bad335ff021c78548fe0b50373006e05cbfef7f4ec4a96e127a816aa20ac582a4ed06731b3d8bc841
-  data.tar.gz: d6f026775a430eb5c6daa55563df3176b339b09b01020202e522af2e4bd1c0b3fdd635873f2ef0278a66cfa5b376e390d7b3ca5504c003c6b7691456d9dfa95c
+  metadata.gz: 6e236957b67a82d29556fa8f57c6fe00f49e0cdb0f4e9c081eb29c99a0123de65ff4aae5f3c6ca308e48eb635c957cda14ce13dc2e40e2f064f6ee17e6395fbb
+  data.tar.gz: d49cca0da353472f8fc561d9a612df8d63a0cd745aec41cf183bc173051719c65eaa2d63d6ab0ae63b7007169c2be6b7abce3c3fd72a3415324791d89eb55f07

data/lib/sync_machine.rb

@@ -7,6 +7,7 @@ require "sync_machine/ensure_publication/deduper"
 require "sync_machine/ensure_publication/publication_history"
 require "sync_machine/ensure_publication_worker"
 require "sync_machine/find_subjects_worker"
+require "sync_machine/orm_adapters"
 require "sync_machine/version"
 
 # A mini-framework for intelligently publishing complex model changes to an
@@ -33,6 +34,10 @@ module SyncMachine
     child_const.name.split(/::/)[0..-2].join('::').constantize
   end
 
+  def orm_adapter
+    SyncMachine::OrmAdapters.orm_adapter(self)
+  end
+
   def subject(subject_sym, opts = {})
     self.subject_sym = subject_sym
     self.subject_opts = ActiveSupport::HashWithIndifferentAccess.new(opts)

data/lib/sync_machine/change_listener.rb

@@ -56,7 +56,7 @@ module SyncMachine
     end
 
     def orm_adapter
-      SyncMachine.orm_adapter
+      SyncMachine.sync_module(self.class).orm_adapter
     end
   end
 end

data/lib/sync_machine/ensure_publication.rb

@@ -56,7 +56,7 @@ module SyncMachine
     end
 
     def subject_id
-      SyncMachine.orm_adapter.record_id_for_job(@subject.id)
+      @sync_module.orm_adapter.record_id_for_job(@subject.id)
     end
   end
 end

data/lib/sync_machine/ensure_publication/publication_history.rb

@@ -38,7 +38,7 @@ module SyncMachine
         payload_class.create!(
           body: payload_body,
           generated_at: Time.now,
-          subject_id: SyncMachine.orm_adapter.record_id_for_job(@subject_id)
+          subject_id: @sync_module.orm_adapter.record_id_for_job(@subject_id)
         )
       end
 

data/lib/sync_machine/find_subjects_worker.rb

@@ -9,6 +9,12 @@ module SyncMachine
 
     class_attribute :hooks
 
+    def self.add_hook(meth, block)
+      sync_module = SyncMachine.sync_module(self)
+      hooks[meth] = Hook.new(sync_module, block)
+    end
+    private_class_method :add_hook
+
     def self.inherited(subclass)
       subclass.hooks = {}
     end
@@ -16,9 +22,9 @@ module SyncMachine
     def self.method_missing(meth, *args, &block)
       if meth.to_s == "subject_ids_from_#{parent.subject_sym}"
         block ||= ->(subject) { [subject.id.to_s] }
-        hooks[meth] = Hook.new(block)
+        add_hook(meth, block)
       elsif meth.to_s =~ /^subject_ids_from_.*/
-        hooks[meth] = Hook.new(block)
+        add_hook(meth, block)
       else
         super
       end
@@ -46,7 +52,8 @@ module SyncMachine
 
     # Wrap a "subject_ids_from_*" block.
     class Hook
-      def initialize(block)
+      def initialize(sync_module, block)
+        @sync_module = sync_module
         @block = block
       end
 
@@ -57,7 +64,7 @@ module SyncMachine
                            @block.call(record)
                          end
         Array.wrap(raw_source_ids).map { |raw_source_id|
-          SyncMachine.orm_adapter.record_id_for_job(raw_source_id)
+          @sync_module.orm_adapter.record_id_for_job(raw_source_id)
         }
       end
     end

data/lib/sync_machine/orm_adapters.rb

@@ -0,0 +1,20 @@
+Bundler.require(:default)
+
+require "sync_machine/orm_adapters/active_record_adapter" if Module.const_defined?(:ActiveRecord)
+require "sync_machine/orm_adapters/mongoid_adapter" if Module.const_defined?(:Mongoid)
+
+module SyncMachine
+  # Adapt generic SyncMachine functionality to a specific ORM.
+  module OrmAdapters
+    def self.orm_adapter(sync_module)
+      subject_class = sync_module.subject_class
+      if const_defined?(:ActiveRecordAdapter) &&
+         subject_class < ActiveRecord::Base
+        ActiveRecordAdapter
+      elsif const_defined?(:MongoidAdapter) &&
+            subject_class.included_modules.include?(Mongoid::Document)
+        MongoidAdapter
+      end
+    end
+  end
+end

data/lib/sync_machine/orm_adapters/active_record_adapter.rb

@@ -0,0 +1,28 @@
+begin
+  require 'wisper/activerecord'
+rescue LoadError
+  Kernel.abort(
+    "Please install the wisper-activerecord gem when using SyncMachine with ActiveRecord."
+  )
+end
+
+module SyncMachine
+  module OrmAdapters
+    # Adapt generic SyncMachine functionality to ActiveRecord.
+    module ActiveRecordAdapter
+      def self.change_listener_changed_keys(record)
+        record.previous_changes.keys
+      end
+
+      def self.record_id_for_job(record_id)
+        record_id
+      end
+
+      def self.sufficient_changes_to_find_subjects?(record)
+        change_listener_changed_keys(record).present?
+      end
+    end
+  end
+end
+
+Wisper::ActiveRecord.extend_all

data/lib/sync_machine/orm_adapters/mongoid_adapter.rb

@@ -0,0 +1,28 @@
+begin
+  require 'wisper/mongoid'
+rescue LoadError
+  Kernel.abort(
+    "Please install the fhwang-wisper-mongoid gem when using SyncMachine with Mongoid."
+  )
+end
+
+module SyncMachine
+  module OrmAdapters
+    # Adapt generic SyncMachine functionality to Mongoid.
+    module MongoidAdapter
+      def self.change_listener_changed_keys(record)
+        record.changes.keys
+      end
+
+      def self.record_id_for_job(record_id)
+        record_id.to_s
+      end
+
+      def self.sufficient_changes_to_find_subjects?(_record)
+        true
+      end
+    end
+  end
+end
+
+Wisper::Mongoid.extend_all

data/lib/sync_machine/version.rb

@@ -1,3 +1,3 @@
 module SyncMachine
-  VERSION = "0.8.1".freeze
+  VERSION = "1.0.0".freeze
 end

data/sync_machine.gemspec

@@ -39,9 +39,14 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "sidekiq"
   spec.add_runtime_dependency "wisper"
 
+  spec.add_development_dependency "activerecord"
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "factory_bot"
+  spec.add_development_dependency "fhwang-wisper-mongoid"
+  spec.add_development_dependency "mongoid"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "wisper-activerecord"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sync_machine
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Francis Hwang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fhwang-wisper-mongoid
+  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
+    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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +164,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: wisper-activerecord
+  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'
 description: A mini-framework for intelligently publishing complex model changes to
   an external API.
 email:
@@ -151,6 +221,9 @@ files:
 - lib/sync_machine/ensure_publication/publication_history.rb
 - lib/sync_machine/ensure_publication_worker.rb
 - lib/sync_machine/find_subjects_worker.rb
+- lib/sync_machine/orm_adapters.rb
+- lib/sync_machine/orm_adapters/active_record_adapter.rb
+- lib/sync_machine/orm_adapters/mongoid_adapter.rb
 - lib/sync_machine/version.rb
 - sync_machine.gemspec
 homepage: https://github.com/fhwang/sync_machine