sync_machine 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 590006776b984bcede930cae17327932ac2e5c2e6b0d4bfab23e3f3742d0ecfa
-  data.tar.gz: 7e04325fae0528ba6fe48d413827c694aed86f13d69460dfb96782f38f25bc03
+  metadata.gz: a87f8dc11ee9675808f703b22cbe674c17d1ed0e05896eb2b061c2a85062f5e9
+  data.tar.gz: f21649d91d260a5c4499544881e14e615d9e657e6f776ef331e408021117c600
 SHA512:
-  metadata.gz: 6e236957b67a82d29556fa8f57c6fe00f49e0cdb0f4e9c081eb29c99a0123de65ff4aae5f3c6ca308e48eb635c957cda14ce13dc2e40e2f064f6ee17e6395fbb
-  data.tar.gz: d49cca0da353472f8fc561d9a612df8d63a0cd745aec41cf183bc173051719c65eaa2d63d6ab0ae63b7007169c2be6b7abce3c3fd72a3415324791d89eb55f07
+  metadata.gz: 9ed147b8be624b64816c1e9837265a05f2aa4322a82e7bfa75873199d24ab63a27ed133fbc6d3bcb51c625479a31a698b73a0eae43c1a09bfd222067c8d368b7
+  data.tar.gz: 4634324884852210076115e04707590a2dda67d083d968fc5c45eb793370b8ff458c442e697ebdd5f4d14b3e8a03d3eaa1d6643e5a8a8ee8cae721fdbf3febe7

data/.rubocop.yml

@@ -1,3 +1,10 @@
+AllCops:
+  Exclude:
+    - 'lib/rails/generators/active_record/templates/*.rb'
+    - 'lib/rails/generators/mongoid/templates/*.rb'
+    - 'lib/rails/generators/rspec/templates/*.rb'
+    - 'lib/rails/generators/templates/*.rb'
+
 Layout/ExtraSpacing:
   Enabled: false
 

data/lib/rails/generators/active_record/sync_machine_generator.rb

@@ -0,0 +1,27 @@
+require "rails/generators"
+
+module ActiveRecord
+  # Generate SyncMachine files for ActiveRecord.
+  class SyncMachineGenerator < Rails::Generators::NamedBase
+    class_option :subject, type: :string
+    source_root File.expand_path('templates', __dir__)
+
+    def create_payload_file
+      template "payload.rb", "app/models/#{file_path}/payload.rb"
+    end
+
+    def create_payload_migration
+      generate(
+        "migration",
+        "create_#{singular_name}_payloads body:text generated_at:datetime subject_id:integer"
+      )
+    end
+
+    private
+
+    def subject
+      options['subject'] || file_name.split(/_to_/).first
+    end
+  end
+end
+

data/lib/rails/generators/active_record/templates/payload.rb

@@ -0,0 +1,10 @@
+module <%= class_name %>
+  class Payload < ActiveRecord::Base
+    self.table_name = "<%= singular_name %>_payloads"
+
+    serialize :body
+
+    validates :generated_at, presence: true
+    validates :subject_id, presence: true, uniqueness: true
+  end
+end

data/lib/rails/generators/mongoid/sync_machine_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+
+module Mongoid
+  # Generate SyncMachine files for Mongoid.
+  class SyncMachineGenerator < Rails::Generators::NamedBase
+    class_option :subject, type: :string
+    source_root File.expand_path('templates', __dir__)
+
+    def create_payload_file
+      template "payload.rb", "app/models/#{file_path}/payload.rb"
+    end
+
+    private
+
+    def subject
+      options['subject'] || file_name.split(/_to_/).first
+    end
+  end
+end

data/lib/rails/generators/mongoid/templates/payload.rb

@@ -0,0 +1,12 @@
+module <%= class_name %>
+  class Payload
+    include ::Mongoid::Document
+
+    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
+end

data/lib/rails/generators/rspec/sync_machine_generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators"
+
+module Rspec
+  # Generate SyncMachine files for RSpec.
+  class SyncMachineGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    def create_service_spec_file
+      template "service_spec.rb", "spec/services/#{file_path}_spec.rb"
+    end
+  end
+end
+

data/lib/rails/generators/rspec/templates/service_spec.rb

@@ -0,0 +1,18 @@
+require 'rails_helper'
+
+describe <%= class_name %> do
+  before do
+    SyncMachine.eager_load(<%= class_name %>)
+    clear_workers
+  end
+
+  def clear_workers
+    <%= class_name %>::FindSubjectsWorker.clear
+    <%= class_name %>::EnsurePublicationWorker.clear
+  end
+
+  def drain_workers
+    <%= class_name %>::FindSubjectsWorker.drain
+    <%= class_name %>::EnsurePublicationWorker.drain
+  end
+end

data/lib/rails/generators/sync_machine_generator.rb

@@ -0,0 +1,48 @@
+require "rails/generators"
+
+# Generate SyncMachine files.
+class SyncMachineGenerator < Rails::Generators::NamedBase
+  class_option :subject, type: :string
+  source_root File.expand_path('templates', __dir__)
+
+  hook_for :orm
+  hook_for :test_framework
+
+  def create_sync_file
+    template "sync.rb", "app/services/#{file_path}.rb"
+  end
+
+  def create_find_subjects_worker_file
+    template(
+      "find_subjects_worker.rb",
+      "app/workers/#{file_path}/find_subjects_worker.rb"
+    )
+  end
+
+  def create_ensure_publication_worker_file
+    template(
+      "ensure_publication_worker.rb",
+      "app/workers/#{file_path}/ensure_publication_worker.rb"
+    )
+  end
+
+  def create_change_listener_file
+    template(
+      "change_listener.rb", "app/services/#{file_path}/change_listener.rb"
+    )
+  end
+
+  def append_subscribe_to_initializer
+    initializer_path = "config/initializers/sync_machines.rb"
+    create_file(initializer_path, "") unless File.exist?(initializer_path)
+    append_to_file(
+      initializer_path, "#{class_name}::ChangeListener.subscribe\n"
+    )
+  end
+
+  private
+
+  def subject
+    options['subject'] || file_name.split(/_to_/).first
+  end
+end

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

@@ -0,0 +1,5 @@
+module <%= class_name %>
+  class ChangeListener < SyncMachine::ChangeListener
+    listen_to_models :<%= subject %>
+  end
+end

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

@@ -0,0 +1,22 @@
+module <%= class_name %>
+  class EnsurePublicationWorker < SyncMachine::EnsurePublicationWorker
+    check_publishable do |<%= subject %>|
+      # Return a boolean value indicating whether the <%= subject %>
+      # should be published at all.
+    end
+
+    build do |<%= subject %>|
+      # Generate and return a payload to send to the external service.
+    end
+
+    publish do |<%= subject %>, payload|
+      # Send the payload to the external service.
+    end
+
+    after_publish do |<%= subject %>|
+      # Execute any actions after a successful publish.  This step is optional
+      # and can be deleted entirely.
+    end
+  end
+end
+

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

@@ -0,0 +1,5 @@
+module <%= class_name %>
+  class FindSubjectsWorker < SyncMachine::FindSubjectsWorker
+    subject_ids_from_<%= subject %>
+  end
+end

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

@@ -0,0 +1,6 @@
+module <%= class_name %>
+  extend SyncMachine
+
+  subject :<%= subject %>
+end
+

data/lib/sync_machine/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sync_machine
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Francis Hwang
@@ -214,6 +214,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/rails/generators/active_record/sync_machine_generator.rb
+- lib/rails/generators/active_record/templates/payload.rb
+- lib/rails/generators/mongoid/sync_machine_generator.rb
+- lib/rails/generators/mongoid/templates/payload.rb
+- lib/rails/generators/rspec/sync_machine_generator.rb
+- lib/rails/generators/rspec/templates/service_spec.rb
+- lib/rails/generators/sync_machine_generator.rb
+- lib/rails/generators/templates/change_listener.rb
+- lib/rails/generators/templates/ensure_publication_worker.rb
+- lib/rails/generators/templates/find_subjects_worker.rb
+- lib/rails/generators/templates/sync.rb
 - lib/sync_machine.rb
 - lib/sync_machine/change_listener.rb
 - lib/sync_machine/ensure_publication.rb