active_propagation 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3e00938b35501723e36afe6ec04011464588d594
+  data.tar.gz: 5c348effb95ccccceabf508bc49e979c88d9d526
+SHA512:
+  metadata.gz: c4136786fc4c3360ab773609ea828aaa59efe957d683e6faa6d660e53cb4c2e1e5b1fcd1ea069b76a00854290fe1a8ea095611d80b3e5f770c1e17c59cc8c135
+  data.tar.gz: bee8f450fc60056c75bad9d0d7e0a0ddb0305f43689ab0a6d8f137f89730388b3014d5d0b41a8a8a78a0cc0420c8d52953af330f0378a786dc5ef4ba4f0821be

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+*.sqlite3
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    active_propagation (0.1.0)
+      activerecord (~> 4.0)
+      activesupport (~> 4.0)
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+    activerecord (4.2.1)
+      activemodel (= 4.2.1)
+      activesupport (= 4.2.1)
+      arel (~> 6.0)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.0)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    coderay (1.1.0)
+    connection_pool (2.2.0)
+    database_cleaner (1.4.1)
+    diff-lcs (1.2.5)
+    hitimes (1.2.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    method_source (0.8.2)
+    minitest (5.7.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    redis (3.2.1)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    sidekiq (3.3.4)
+      celluloid (>= 0.16.0)
+      connection_pool (>= 2.1.1)
+      json
+      redis (>= 3.0.6)
+      redis-namespace (>= 1.3.1)
+    slop (3.6.0)
+    sqlite3 (1.3.10)
+    thread_safe (0.3.5)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_propagation!
+  bundler (~> 1.8)
+  database_cleaner
+  pry
+  rake (~> 10.0)
+  rspec
+  sqlite3

data/README.md

@@ -0,0 +1,28 @@
+# ActivePropagation
+
+Provides an ActiveRecord extension for propagating changes amongst models. 
+
+Propagations are ran as callbacks and can be propagated synchronously in background jobs, or synchronously within the callback lifecycle. Furthermore, the individual updates on each associated record can be ran in jobs of their own.
+
+# Usage Example
+
+Say you have a posts model with an optional `post_id` such that a Post can have many posts and also belong to a post:
+
+```ruby
+class Post < ActiveRecord::Base
+  belongs_to :post
+  has_many :sub_posts
+
+  propagates_changes_to :sub_posts, only: [:title], on: [:update], async: true
+end
+```
+
+This will register an `after_commit` callback that will fire a Sidekiq worker to set the titles of all of the sub_posts to be the same as their parent post.
+
+# Why?
+
+Many Rails codebases rely heavily on callbacks to keep the application's state consistent. While changes can be propagated performantly and easily using `update_all` or `destroy_all`, if there are callbacks that need to be ran then this isn't possible. active_propagation calls `update` or `destroy` on each instantiated activerecord object so all callbacks are ran. By having an asynch option, even if you expect lots of dependent records and long running callbacks, each update and destroy, as well as their callbacks, are parallelized. 
+
+Caveats:
+- Currently the only supported job system is Sidekiq. The plan is to make this configurable for multiple backends(probably using ActiveJob).
+- The callbacks are executed `after_commit`. This is to make sure it plays nicely with Sidekiq.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/active_propagation.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_propagation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_propagation"
+  spec.version       = ActivePropagation::VERSION
+  spec.authors       = ["Yoshiki Schmitz"]
+  spec.email         = ["yoshiki@masteryconnect.com"]
+
+  spec.summary       = %q{propagates changes across models}
+  spec.description   = %q{ActivePropagation provides classes and ActiveRecord extensions for propagating changes amongst models, optionally using Sidekiq to parallelize the process.}
+  spec.homepage      = "https://bitbucket.org/doweber/active_propagation/overview"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "activerecord", "~> 4.0"
+  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "sidekiq"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_propagation"
+
+# 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

data/bin/setup

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

data/lib/active_propagation.rb

@@ -0,0 +1,106 @@
+require 'active_record'
+require 'sidekiq'
+require "active_propagation/version"
+require "active_propagation/class_extensions"
+require "active_propagation/instance_extensions"
+require "active_propagation/propagater_helper"
+
+module ActivePropagation
+  class Propagater
+    def initialize(klass, association, id)
+      @klass, @association, @id = klass, association, id
+    end 
+
+    def run 
+      assocs.each do |a| 
+        yield a
+      end 
+    end 
+
+    def assocs
+      assoc_klass.where(foreign_key => id) 
+    end 
+
+    def foreign_key
+      klass.reflections[association.to_s].foreign_key
+    end 
+
+    def assoc_klass
+      klass.reflections[association.to_s].class_name.constantize
+    end
+
+    private
+
+    attr_reader :klass, :association, :id
+  end
+
+  class AbstractPropagaterWorker
+    include PropagaterHelper
+    include Sidekiq::Worker
+
+    def self.run(klass_str, model_id, assoc, only)
+      self.perform_async(klass_str, model_id, assoc, only)
+    end
+  end
+
+  class AsyncLoopDeletor
+    include PropagaterHelper
+    include Sidekiq::Worker
+    def perform(klass_str, assoc_id)
+      klass = klass_str.constantize
+      klass.find(assoc_id).destroy
+    end 
+  end
+
+  class AsyncDeletor < AbstractPropagaterWorker
+    def perform(klass_str, model_id, assoc, only)
+      klass = klass_str.constantize
+       Propagater.new(klass, assoc, model_id).run do |a| 
+         AsyncLoopDeletor.perform_async(klass.to_s, a.id)
+       end
+    end
+  end
+
+  class AsyncLoopUpdater
+    include Sidekiq::Worker
+    include PropagaterHelper
+    def perform(klass_str, model_id, assoc_id, only)
+      klass = klass_str.constantize
+      model = klass.find(model_id)
+      klass.find(assoc_id).update(propagated_attributes(model, only))
+    end 
+  end
+
+  class AsyncUpdater < AbstractPropagaterWorker
+    def perform(klass_str, model_id, assoc, only)
+      klass = klass_str.constantize
+      Propagater.new(klass, assoc, model_id).run do |a| 
+        AsyncLoopUpdater.perform_async(klass.to_s, model_id, a.id, only)
+      end 
+    end 
+  end
+
+  class Updater
+    extend PropagaterHelper
+    def self.run(klass_str, model_id, assoc, only)
+      klass = klass_str.constantize
+      model = klass.find(model_id)
+      Propagater.new(klass, assoc, model_id).run do |a| 
+        a.update(propagated_attributes(model, only))
+      end 
+    end 
+  end
+
+  class Deletor
+    extend PropagaterHelper
+    def self.run(klass_str, model_id, assoc, only)
+      klass = klass_str.constantize
+      Propagater.new(klass, assoc, model_id).run do |a|
+        a.destroy
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, ActivePropagation::ClassExtensions)
+ActiveRecord::Base.send(:include, ActivePropagation::InstanceExtensions)

data/lib/active_propagation/class_extensions.rb

@@ -0,0 +1,7 @@
+module ActivePropagation::ClassExtensions
+  def propagates_changes_to(association, only: [], async: false, nested_async: false, on: [:update, :destroy])
+    self.class_variable_set(:@@propagations, self.class_variable_get(:@@propagations) || {})
+    after_commit(:_run_active_propagation, on: on) unless _commit_callbacks.map(&:filter).include?(:_run_active_propagation)
+    self.class_variable_get(:@@propagations)[association] = {only: only, async: async, nested_async: nested_async}
+  end
+end

data/lib/active_propagation/instance_extensions.rb

@@ -0,0 +1,21 @@
+module ActivePropagation::InstanceExtensions
+  def _run_active_propagation
+    klass = self.class
+    klass.class_variable_get(:@@propagations).each do |association, config|
+      args = [self.class.to_s, self.id, association.to_s, config[:only]]
+      if self.destroyed?
+        if config[:async]
+          ActivePropagation::AsyncDeletor.run(*args)
+        else
+          ActivePropagation::Deletor.run(*args)
+        end
+      else
+        if config[:async]
+          ActivePropagation::AsyncUpdater.run(*args)
+        else
+          ActivePropagation::Updater.run(*args)
+        end
+      end
+    end
+  end
+end

data/lib/active_propagation/propagater_helper.rb

@@ -0,0 +1,5 @@
+module PropagaterHelper
+  def propagated_attributes(model, only)
+    only.map{|x| [x, model.attributes[x.to_s]]}.to_h
+  end
+end

data/lib/active_propagation/version.rb

@@ -0,0 +1,3 @@
+module ActivePropagation
+  VERSION = "0.2.1"
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: active_propagation
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Yoshiki Schmitz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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: database_cleaner
+  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: pry
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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'
+description: ActivePropagation provides classes and ActiveRecord extensions for propagating
+  changes amongst models, optionally using Sidekiq to parallelize the process.
+email:
+- yoshiki@masteryconnect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- active_propagation.gemspec
+- bin/console
+- bin/setup
+- lib/active_propagation.rb
+- lib/active_propagation/class_extensions.rb
+- lib/active_propagation/instance_extensions.rb
+- lib/active_propagation/propagater_helper.rb
+- lib/active_propagation/version.rb
+homepage: https://bitbucket.org/doweber/active_propagation/overview
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: propagates changes across models
+test_files: []
+has_rdoc: