sync_machine_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 210e67b77b701c460eca8f8f3a77de99ed30f7101eda68664db45e4821905db0
+  data.tar.gz: 64412fc93cee818119b459a6b201a03a10cb7253a935359c2e61b9687c76e125
+SHA512:
+  metadata.gz: 5c18cd945d25328587b06d7b0b3a80af1e64b8f67a49de9f0cc3a68652a4c621aeaeb6ee315bf5777747751339d789e43a22318273dd1d7c83e32cb80115ba82
+  data.tar.gz: 7891881e728f874d274148c37ea85439510de9f4ad1b2bffbc5265def534cd6c9bc049faacaa0cdbe509dc2c68631a51e792455986651da4801dab3ea04789b3

data/.codeclimate.yml

@@ -0,0 +1,38 @@
+version: "2"         # required to adjust maintainability checks
+checks:
+  argument-count:
+    config:
+      threshold: 4
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 250
+  method-complexity:
+    config:
+      threshold: 5
+  method-count:
+    config:
+      threshold: 20
+  method-lines:
+    config:
+      threshold: 25
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+  similar-code:
+    config:
+      threshold: 150
+  identical-code:
+    config:
+      threshold: 75
+plugins:
+  reek:
+    enabled: true
+  rubocop:
+    enabled: true
+

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.reek.yml

@@ -0,0 +1,12 @@
+---
+detectors:
+  DuplicateMethodCall:
+    max_calls: 3
+  UtilityFunction:
+    public_methods_only: true
+
+exclude_paths:
+  - spec
+  - lib/generators/templates
+  - lib/generators/mongoid/templates
+  - lib/generators/rspec/templates

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,53 @@
+AllCops:
+  Exclude:
+    - 'lib/generators/**/templates/*.rb'
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: false
+
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+Layout/TrailingBlankLines:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'sync_machine_generator.gemspec'
+
+Metrics/LineLength:
+  Max: 100
+
+# Handled by Reek
+Metrics/MethodLength:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/EmptyMethod:
+  Exclude:
+    - 'spec/**/*'
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RandomWithOffset:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/SymbolProc:
+  Exclude:
+    - 'spec/**/*'
+
+Style/UnneededPercentQ:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sync_machine_generator.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# SyncMachineGenerator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sync_machine_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sync_machine_generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sync_machine_generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sync_machine_generator.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sync_machine_generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/mongoid/sync_machine_generator.rb

@@ -0,0 +1,23 @@
+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
+
+    def create_sync_file
+      template "sync.rb", "app/services/#{file_path}.rb"
+    end
+
+    private
+
+    def subject
+      options['subject'] || file_name.split(/_to_/).first
+    end
+  end
+end

data/lib/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/generators/mongoid/templates/sync.rb

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

data/lib/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/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/generators/sync_machine_generator/version.rb

@@ -0,0 +1,6 @@
+module SyncMachine
+  module Generator
+    VERSION = "0.1.0".freeze
+  end
+end
+

data/lib/generators/sync_machine_generator.rb

@@ -0,0 +1,44 @@
+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_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/generators/templates/change_listener.rb

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

data/lib/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/generators/templates/find_subjects_worker.rb

@@ -0,0 +1,7 @@
+module <%= class_name %>
+  class FindSubjectsWorker < SyncMachine::FindSubjectsWorker
+    subject_ids_from_<%= subject %> do |<%= subject %>|
+      [<%= subject %>.id.to_s]
+    end
+  end
+end

data/sync_machine_generator.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "generators/sync_machine_generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sync_machine_generator"
+  spec.version       = SyncMachine::Generator::VERSION
+  spec.authors       = ["Francis Hwang"]
+  spec.email         = ["sera@fhwang.net"]
+
+  spec.summary       = %q{Rails generator for SyncMachine.}
+  spec.homepage      = "https://github.com/fhwang/sync_machine_generator"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fhwang/sync_machine_generator"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: sync_machine_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francis Hwang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- sera@fhwang.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/mongoid/sync_machine_generator.rb
+- lib/generators/mongoid/templates/payload.rb
+- lib/generators/mongoid/templates/sync.rb
+- lib/generators/rspec/sync_machine_generator.rb
+- lib/generators/rspec/templates/service_spec.rb
+- lib/generators/sync_machine_generator.rb
+- lib/generators/sync_machine_generator/version.rb
+- lib/generators/templates/change_listener.rb
+- lib/generators/templates/ensure_publication_worker.rb
+- lib/generators/templates/find_subjects_worker.rb
+- sync_machine_generator.gemspec
+homepage: https://github.com/fhwang/sync_machine_generator
+licenses: []
+metadata:
+  homepage_uri: https://github.com/fhwang/sync_machine_generator
+  source_code_uri: https://github.com/fhwang/sync_machine_generator
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Rails generator for SyncMachine.
+test_files: []