sync_machine 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 594e4e0870147957bb2f36f65b6b028433bf5ee3
-  data.tar.gz: 58a8af1ae9acd3b64fdff79414d6fcc3e7499332
+SHA256:
+  metadata.gz: d74a6108d033784c23a0dbcbf0212523dbb8498b55b867d630272806f726ae19
+  data.tar.gz: 18b5753d9abff76d0dec3c5d98e5b0660deeb45ae525eb4db3aea25741a33f60
 SHA512:
-  metadata.gz: da5e1182ccf5d8623190e170826e122bc6b60a819a707c4f16c61167009d90140e35263ce9f634f95bf66d17065c047cbffa940320e68a475a0939b2ca48ee80
-  data.tar.gz: 0a94e81f19b4096e233fa457946c59ee5a0e669e95e908fe9e80ba9efa49b359f8a8b7ccf3517ebb7e839789057bf2c8e8b8a1b684cabaf6938653ee25f15921
+  metadata.gz: 1c7100fd78a1809760743413f3024779243b1bb6d2d2963b1ad074b92e46cf1f196f0ab9b446fd2a7179bfe36ee0bfefdfd42ff82feccb8e97ca6091b7063ca9
+  data.tar.gz: c09a284f84e695dcb6a8935d1ca8510589e5094f235da6c011d14c7293aca9629990c0c92897ccba08f7d538114490a6fbcb703e1c56dcb707789348faadaef8

data/.circleci/config.yml

@@ -21,13 +21,6 @@ jobs:
     steps:
       - checkout
 
-      # Download and cache dependencies
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            # fallback to using the latest cache if no exact match is found
-            - v1-dependencies-
-
       - run:
           name: Configure Bundler
           command: |
@@ -40,11 +33,6 @@ jobs:
           command: |
             bundle install --jobs=4 --retry=3 --path vendor/bundle
 
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
       # run tests!
       - run:
           name: run tests

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock

data/lib/sync_machine/change_listener.rb

@@ -7,6 +7,7 @@ module SyncMachine
   class ChangeListener
     def self.inherited(base)
       base.cattr_accessor :model_syms
+      base.subscribe
     end
 
     def self.listen_to_models(*model_syms)
@@ -15,7 +16,7 @@ module SyncMachine
         send(
           :alias_method,
           "update_#{model_sym}_successful".to_sym,
-          :after_subject_saved
+          :after_record_saved
         )
       end
     end
@@ -24,34 +25,36 @@ module SyncMachine
       Wisper.subscribe(new)
     end
 
-    def after_create(subject)
-      model_sym = subject.class.name.underscore.to_sym
+    def after_create(record)
+      model_sym = record.class.name.underscore.to_sym
       return unless self.class.model_syms.include?(model_sym)
-      after_subject_saved(subject)
+      after_record_saved(record)
     end
 
-    def after_subject_saved(subject)
-      return unless changed_keys(subject).present?
+    def after_record_saved(record)
+      return unless changed_keys(record).present?
       sync_module = SyncMachine.sync_module(self.class)
       finder_class = sync_module.const_get('FindSubjectsWorker')
       finder_class.perform_async(
-        subject.class.name,
-        subject.id.to_s,
-        changed_keys(subject),
+        record.class.name,
+        record_id_for_job(record.id),
+        changed_keys(record),
         Time.now.iso8601
       )
     end
 
     private
 
-    def changed_keys(subject)
-      changed_keys = subject.changes.keys
-      subject.class.reflect_on_all_associations.each do |assoc|
-        if assoc.macro == :embeds_one && subject.send(assoc.name).try(:changed?)
-          changed_keys << assoc.name
-        end
-      end
-      changed_keys
+    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)
+    end
+
+    def orm_adapter
+      SyncMachine.orm_adapter
     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: @subject_id.to_s
+          subject_id: SyncMachine.orm_adapter.record_id_for_job(@subject_id)
         )
       end
 

data/lib/sync_machine/ensure_publication.rb

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

data/lib/sync_machine/find_subjects_worker.rb

@@ -53,7 +53,9 @@ module SyncMachine
                          else
                            @block.call(record)
                          end
-        Array.wrap(raw_source_ids).map(&:to_s)
+        Array.wrap(raw_source_ids).map { |raw_source_id|
+          SyncMachine.orm_adapter.record_id_for_job(raw_source_id)
+        }
       end
     end
   end

data/lib/sync_machine/orm_adapter/active_record.rb

@@ -0,0 +1,20 @@
+module SyncMachine
+  module OrmAdapter
+    # Adapt SyncMachine for use with ActiveRecord-based applications.
+    module ActiveRecord
+      def self.setup
+        require "active_record"
+        require "wisper/active_record"
+        Wisper::ActiveRecord.extend_all
+      end
+
+      def self.change_listener_changed_keys(record)
+        record.previous_changes.keys
+      end
+
+      def self.record_id_for_job(record_id)
+        record_id
+      end
+    end
+  end
+end

data/lib/sync_machine/orm_adapter/mongoid.rb

@@ -0,0 +1,20 @@
+module SyncMachine
+  module OrmAdapter
+    # Adapt SyncMachine for use with Mongoid-based applications.
+    module Mongoid
+      def self.setup
+        require "mongoid"
+        require "wisper/mongoid"
+        Wisper::Mongoid.extend_all
+      end
+
+      def self.change_listener_changed_keys(record)
+        record.changes.keys
+      end
+
+      def self.record_id_for_job(record_id)
+        record_id.to_s
+      end
+    end
+  end
+end

data/lib/sync_machine/version.rb

@@ -1,3 +1,3 @@
 module SyncMachine
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/sync_machine.rb

@@ -1,20 +1,47 @@
 require "active_support/core_ext/class"
 require "active_support/core_ext/string"
-require "mongoid"
 require "sync_machine/change_listener"
 require "sync_machine/ensure_publication"
 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_adapter/active_record"
+require "sync_machine/orm_adapter/mongoid"
 require "sync_machine/version"
-require "wisper/mongoid"
 
 # A mini-framework for intelligently publishing complex model changes to an
 # external API..
 module SyncMachine
+  mattr_accessor :orm_adapter
+
+  def self.use_active_record
+    setup_orm_adapter(OrmAdapter::ActiveRecord)
+  end
+
+  def self.use_mongoid
+    setup_orm_adapter(OrmAdapter::Mongoid)
+  end
+
+  def self.setup_orm_adapter(orm_adapter)
+    self.orm_adapter = orm_adapter
+    orm_adapter.setup
+  end
+
   def self.extended(base)
     base.mattr_accessor :subject_sym
+
+    # Force loading of all relevant classes.  Should only be necessary when
+    # running your application in a way that it defers loading constants, i.e.,
+    # Rails' development or test mode.
+    def base.eager_load
+      const_names = %w(
+        Payload FindSubjectsWorker EnsurePublicationWorker ChangeListener
+      )
+      const_names.each do |const_name|
+        const_get(const_name)
+      end
+    end
   end
 
   def self.sync_module(child_const)
@@ -28,29 +55,4 @@ module SyncMachine
   def subject_class
     subject_sym.to_s.camelize.constantize
   end
-
-  def setup
-    define_payload_class unless const_defined?('Payload')
-    const_get('ChangeListener').subscribe
-  end
-
-  # :reek:TooManyStatements is unavoidable with this sort of dynamic class
-  # definition
-  def define_payload_class
-    collection_name = name.underscore + '_payloads'
-    payload_class = Class.new do
-      include Mongoid::Document
-      store_in collection: collection_name
-
-      field :body, type: Hash
-      field :generated_at, type: Time
-      field :subject_id, type: String
-
-      validates :generated_at, presence: true
-      validates :subject_id, presence: true, uniqueness: true
-    end
-    const_set('Payload', payload_class)
-  end
 end
-
-Wisper::Mongoid.extend_all

data/sync_machine.gemspec

@@ -36,14 +36,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "activesupport"
-  spec.add_runtime_dependency "fhwang-wisper-mongoid"
-  spec.add_runtime_dependency "mongoid"
   spec.add_runtime_dependency "sidekiq"
   spec.add_runtime_dependency "wisper"
 
   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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Francis Hwang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-26 00:00:00.000000000 Z
+date: 2019-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fhwang-wisper-mongoid
+  name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: wisper
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,27 +53,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: wisper
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: fhwang-wisper-mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -150,6 +150,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:
@@ -167,7 +195,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -180,6 +207,8 @@ 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_adapter/active_record.rb
+- lib/sync_machine/orm_adapter/mongoid.rb
 - lib/sync_machine/version.rb
 - sync_machine.gemspec
 homepage: https://github.com/fhwang/sync_machine
@@ -204,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A mini-framework for intelligently publishing complex model changes to an

data/Gemfile.lock

@@ -1,80 +0,0 @@
-PATH
-  remote: .
-  specs:
-    sync_machine (0.1.0)
-      activesupport
-      fhwang-wisper-mongoid
-      mongoid
-      sidekiq
-      wisper
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.1)
-      activesupport (= 5.2.1)
-    activesupport (5.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    bson (4.3.0)
-    concurrent-ruby (1.0.5)
-    connection_pool (2.2.2)
-    diff-lcs (1.3)
-    factory_bot (5.0.2)
-      activesupport (>= 4.2.0)
-    fhwang-wisper-mongoid (0.2.0)
-      mongoid (>= 6)
-      wisper
-    i18n (1.1.1)
-      concurrent-ruby (~> 1.0)
-    minitest (5.11.3)
-    mongo (2.6.2)
-      bson (>= 4.3.0, < 5.0.0)
-    mongoid (6.4.2)
-      activemodel (>= 5.1, < 6.0.0)
-      mongo (>= 2.5.1, < 3.0.0)
-    rack (2.0.6)
-    rack-protection (2.0.4)
-      rack
-    rake (10.4.2)
-    redis (4.0.2)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    sidekiq (5.0.5)
-      concurrent-ruby (~> 1.0)
-      connection_pool (~> 2.2, >= 2.2.0)
-      rack-protection (>= 1.5.0)
-      redis (>= 3.3.4, < 5)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    wisper (2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  factory_bot
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rspec_junit_formatter
-  sync_machine!
-
-BUNDLED WITH
-   2.0.1