custom_active_record_observer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de2f53459d0571d2542de638f2f10e80637d20ff
+  data.tar.gz: f1a58b6f3014fbbbfb96eee376fa1a8de82c7110
+SHA512:
+  metadata.gz: 91aaa0ca81ac659ef16b3f58169e3069ecae1d549ffe5b959391b87c34fc5b17234aeaf6b29c308cf0d60e23a6ce3ad52acdefebd56b5643210d5313426d161c
+  data.tar.gz: 7deb22d765fffe58c49902a163604823e88e22172fd5b8e0bdd63dcce2fe7b53960dd7e3a622a24c0cca60449c03154b089938812562e7885788d57dd5866f96

data/README.md

@@ -0,0 +1,25 @@
+# CustomActiveRecordObserver
+
+`custom_active_record_observer` is a DSL to track create/update/destroy operations based on AR callbacks.
+
+Its a simple DSL similar to the code below:
+
+```
+CustomActiveRecordObserver.observe :EngagedUser, :CompanyOwner, handler: CustomerEventPublisher.new do
+  on_create do |customer|
+    Events::CustomerSignedUp.new(data: {customer_id: customer.id}
+  end
+
+  on_destroy do |customer|
+    Events::CustomerSignedOut.new(data: {…})
+  end
+
+  on_change :group_id do |customer|
+    Events::CustomerGroupChanged.new(data: {…})
+  end
+…
+end
+```
+
+which you can put into a single initializer file instead of scattering it around and having it in each AR model.
+That file is easier to remove in future. It incapsulates all the “inaccurate" dependencies.

data/Rakefile

@@ -0,0 +1,20 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+

data/lib/custom_active_record_observer.rb

@@ -0,0 +1,16 @@
+require 'active_support/dependencies'
+
+module CustomActiveRecordObserver
+  require_relative 'custom_active_record_observer/all'
+
+  mattr_accessor :schema
+  @@schema = Schema.new
+
+  def self.observe(*class_names, handler:, &block)
+    class_names.each do |class_name|
+      DSL.new(block).actions_and_rules.each do |(action, rule)|
+        schema.add_rule(class_name, action, rule, handler)
+      end
+    end
+  end
+end

data/lib/custom_active_record_observer/all.rb

@@ -0,0 +1,9 @@
+require_relative 'models_extender'
+require_relative 'observable'
+require_relative 'engine'
+require_relative 'rules/all'
+require_relative 'not_nil'
+require_relative 'handler'
+require_relative 'dsl'
+require_relative 'schema'
+require_relative 'changes_tracker'

data/lib/custom_active_record_observer/changes_tracker.rb

@@ -0,0 +1,16 @@
+module CustomActiveRecordObserver
+  module ChangesTracker
+    def self.[](*method_names)
+      Module.new do
+        method_names.each do |name|
+          define_method name do |*args|
+            @_active_record_observer_changes ||= {}
+            @_active_record_observer_changes.merge!(changes)
+
+            super(*args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/custom_active_record_observer/dsl.rb

@@ -0,0 +1,45 @@
+module CustomActiveRecordObserver
+  class DSL
+    def initialize(block)
+      instance_exec(&block)
+    end
+
+    def actions_and_rules
+      @actions_and_rules ||= []
+    end
+
+    def on_create(&block)
+      store(:create, Rules::CreateRule.new(block))
+    end
+
+    def on_destroy(&block)
+      store(:destroy, Rules::DestroyRule.new(block))
+    end
+
+    def on_update(*attributes, &block)
+      pattern = attributes.pop if attributes.last.is_a?(Array)
+
+      attributes.each do |attribute|
+        store(:update, Rules::UpdateRule.new(block, attribute: attribute, pattern: pattern))
+      end
+    end
+
+    def on_add(*attributes, &block)
+      on_update(*attributes.push([nil, NotNil]), &block)
+    end
+
+    def on_remove(*attributes, &block)
+      on_update(*attributes.push([NotNil, nil]), &block)
+    end
+
+    def on_change(*attributes, &block)
+      on_update(*attributes.push([NotNil, NotNil]), &block)
+    end
+
+    private
+
+    def store(action, rule)
+      actions_and_rules << [action, rule]
+    end
+  end
+end

data/lib/custom_active_record_observer/engine.rb

@@ -0,0 +1,11 @@
+module CustomActiveRecordObserver
+  class Engine < ::Rails::Engine
+    isolate_namespace CustomActiveRecordObserver
+
+    config.to_prepare do
+      CustomActiveRecordObserver.schema.freeze
+
+      CustomActiveRecordObserver::ModelsExtender.(CustomActiveRecordObserver.schema)
+    end
+  end
+end

data/lib/custom_active_record_observer/handler.rb

@@ -0,0 +1,17 @@
+module CustomActiveRecordObserver
+  module Handler
+    def self.call(target, action, _changes, schema: CustomActiveRecordObserver.schema)
+      # Some AR libraries reload AR object in the callbacks.
+      # Hence, ActiveModel::Dirty model changes hash becomes empty.
+      # @_active_record_observer_changes is needed to that changes not be missed
+      changes =
+        (target.instance_variable_get(:@_active_record_observer_changes) || {}).merge(_changes)
+
+      ActiveRecord::Base.transaction do
+        schema.
+          get_rules(target.class.name, action, changes).
+          each { |rule, handler| handler.(rule.(target)) }
+      end
+    end
+  end
+end

data/lib/custom_active_record_observer/models_extender.rb

@@ -0,0 +1,9 @@
+module CustomActiveRecordObserver
+  module ModelsExtender
+    def self.call(schema)
+      schema.classes.map(&:base_class).uniq.each do |base_class|
+        base_class.include(CustomActiveRecordObserver::Observable)
+      end
+    end
+  end
+end

data/lib/custom_active_record_observer/not_nil.rb

@@ -0,0 +1,7 @@
+module CustomActiveRecordObserver
+  module NotNil
+    def self.===(other)
+      super || !other.nil?
+    end
+  end
+end

data/lib/custom_active_record_observer/observable.rb

@@ -0,0 +1,11 @@
+module CustomActiveRecordObserver
+  module Observable
+    extend ActiveSupport::Concern
+
+    included do
+      after_commit -> { CustomActiveRecordObserver::Handler.(self, :create, previous_changes) }, on: :create
+      after_commit -> { CustomActiveRecordObserver::Handler.(self, :update, previous_changes) }, on: :update
+      after_commit -> { CustomActiveRecordObserver::Handler.(self, :destroy, previous_changes) }, on: :destroy
+    end
+  end
+end

data/lib/custom_active_record_observer/rules/all.rb

@@ -0,0 +1,3 @@
+require_relative 'base_rule'
+
+Dir[File.expand_path('*.rb', __dir__)].each { |f| require f }

data/lib/custom_active_record_observer/rules/base_rule.rb

@@ -0,0 +1,19 @@
+module CustomActiveRecordObserver
+  module Rules
+    class BaseRule
+      attr_reader :block
+
+      def initialize(block)
+        @block = block
+      end
+
+      def call(target)
+        block.call(target)
+      end
+
+      def allowed?(changes)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/custom_active_record_observer/rules/create_rule.rb

@@ -0,0 +1,10 @@
+module CustomActiveRecordObserver
+  module Rules
+    class CreateRule < BaseRule
+      def allowed?(changes)
+        true
+      end
+    end
+  end
+end
+

data/lib/custom_active_record_observer/rules/destroy_rule.rb

@@ -0,0 +1,10 @@
+module CustomActiveRecordObserver
+  module Rules
+    class DestroyRule < BaseRule
+      def allowed?(changes)
+        true
+      end
+    end
+  end
+end
+

data/lib/custom_active_record_observer/rules/update_rule.rb

@@ -0,0 +1,32 @@
+module CustomActiveRecordObserver
+  module Rules
+    class UpdateRule < BaseRule
+      attr_reader :attribute, :pattern
+
+      def initialize(block, attribute: nil, pattern: nil)
+        super(block)
+
+        if pattern.is_a?(Array) && pattern.size != 2
+          raise ArgumentError, "#{ pattern } is expected to be an array of two elements"
+        end
+
+        @attribute = attribute
+        @pattern = pattern
+      end
+
+      def allowed?(changes)
+        attribute &&
+          changes.has_key?(attribute) &&
+          matches_pattern?(*changes.fetch(attribute))
+      end
+
+      private
+
+      def matches_pattern?(value_was, value)
+        return true unless pattern # no pattern => allowed for all
+
+        pattern.first === value_was && pattern.last === value
+      end
+    end
+  end
+end

data/lib/custom_active_record_observer/schema.rb

@@ -0,0 +1,44 @@
+module CustomActiveRecordObserver
+  class Schema
+    attr_reader :schema
+
+    delegate :fetch, to: :schema
+
+    # {
+    #   'User' =>
+    #     {
+    #       update: [[rule_1, handler], [rule_2, handler]],
+    #       create: [[rule_3, handler]]
+    #     }
+    #   'Article' =>
+    #     {
+    #       destroy: [[rule5, handler]],
+    #     }
+    # }
+    def initialize(schema = {})
+      @schema = schema
+    end
+
+    def add_rule(class_name, action, rules, handler)
+      schema[class_name] ||= {}
+      schema[class_name][action] ||= []
+
+      Array(rules).each do |rule|
+        schema[class_name][action] << [rule, handler]
+      end
+    end
+
+    def get_rules(class_name, action, raw_changes = {})
+      changes = raw_changes.symbolize_keys
+
+      schema.fetch(class_name.to_sym, {}).
+             fetch(action, []).select do |(rule, handler)|
+        rule.allowed?(changes)
+      end
+    end
+
+    def classes
+      schema.keys.map { |name| name.to_s.constantize }
+    end
+  end
+end

data/lib/custom_active_record_observer/version.rb

@@ -0,0 +1,3 @@
+module CustomActiveRecordObserver
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: custom_active_record_observer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OnApp Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !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: fuubar
+  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'
+description: 
+email:
+- support@onapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/custom_active_record_observer.rb
+- lib/custom_active_record_observer/all.rb
+- lib/custom_active_record_observer/changes_tracker.rb
+- lib/custom_active_record_observer/dsl.rb
+- lib/custom_active_record_observer/engine.rb
+- lib/custom_active_record_observer/handler.rb
+- lib/custom_active_record_observer/models_extender.rb
+- lib/custom_active_record_observer/not_nil.rb
+- lib/custom_active_record_observer/observable.rb
+- lib/custom_active_record_observer/rules/all.rb
+- lib/custom_active_record_observer/rules/base_rule.rb
+- lib/custom_active_record_observer/rules/create_rule.rb
+- lib/custom_active_record_observer/rules/destroy_rule.rb
+- lib/custom_active_record_observer/rules/update_rule.rb
+- lib/custom_active_record_observer/schema.rb
+- lib/custom_active_record_observer/version.rb
+homepage: 
+licenses:
+- Apache 2.0
+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.5.2
+signing_key: 
+specification_version: 4
+summary: CustomActiveRecordObserver
+test_files: []