activerecord-reactor 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 onrooby GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+activerecord-reactor
+====================
+
+Unobtrusive observers for Rails models

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run all tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/cases/*_test.rb']
+  t.verbose = true
+end
+
+desc 'Generate documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveModel::Reactor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/active_record/active_record.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+module ActiveRecord
+  class Reactor < ActiveModel::Reactor
+  end
+
+  Base.class_eval do
+    include ActiveModel::Reactor::Callbacks
+    self.reactor_callbacks = Base::CALLBACKS.dup
+  end
+end
+

data/lib/active_record/reactor/callbacks.rb

@@ -0,0 +1,40 @@
+module ActiveRecord
+
+  class Reactor
+
+    module Callbacks
+
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_attribute :reactor_callbacks
+        base.reactor_callbacks = ActiveRecord::Base::CALLBACKS.dup
+      end
+
+      module ClassMethods
+
+        def define_reactor_callbacks(*args)
+          options = args.extract_options!
+          options[:only] ||= [:before, :after] # TODO: implement around callbacks
+          types = Array.wrap(options[:only])
+          define_model_callbacks(*(args << options))
+          def args.combine(other, &block)
+            return product(other) unless block_given?
+            product(other).inject([]) { |result, ab| result << yield(ab.first, ab.last) }
+          end
+          self.reactor_callbacks = (reactor_callbacks + args.combine(types) { |arg, type| :"#{type}_#{arg}" }).uniq
+        end
+
+        def reactor(klass_or_name)
+          reactor = klass_or_name.is_a?(Class) ? klass_or_name : "#{klass_or_name.to_s.camelize}Reactor".constantize
+          (reactor.callbacks & self.reactor_callbacks).each do |callback|
+            send(callback) { |record| reactor.instance.send(callback, record) unless reactor.scrammed?; true }
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/active_record/reactor/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class Reactor
+    VERSION = '1.0.0'
+  end
+end

data/lib/active_record/reactor.rb

@@ -0,0 +1,28 @@
+require 'singleton'
+
+module ActiveRecord
+
+  class Reactor
+
+    include Singleton
+
+    class << self
+      def callbacks
+        (self.public_instance_methods - ActiveRecord::Reactor.public_instance_methods).grep(/\A(before|around|after)_.+/)
+      end
+
+      def scrammed?
+        !!@scrammed
+      end
+
+      def scram(&block)
+        previously_scrammed = @scrammed
+        @scrammed = true
+        yield
+      ensure
+        @scrammed = previously_scrammed
+      end
+    end
+  end
+
+end

data/lib/activerecord-reactor.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+require 'active_record/reactor'
+require 'active_record/reactor/callbacks'
+require 'active_record/reactor/version'
+
+ActiveRecord::Base.class_eval do
+  include ActiveRecord::Reactor::Callbacks
+end

data/test/cases/reactor_test.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require File.expand_path('../../test_helper', __FILE__)
+
+class ReactorTest < ActiveSupport::TestCase
+
+  setup do
+    FruitReactor.calls.clear
+    PeelReactor.calls.clear
+  end
+
+  test 'Callbacks are invoked' do
+    b = Banana.create(color: 'blue')
+    b.peel!
+    c = Cherry.create(color: 'red')
+    c.peel!
+    assert_equal ['before_save blue Banana', 'after_create blue Banana', 'before_save red Cherry', 'after_create red Cherry'], FruitReactor.calls
+    assert_equal ['before_peel blue Banana', 'after_peel blue Banana'], PeelReactor.calls
+  end  
+
+  test 'Scrammed reactors do not react' do
+    FruitReactor.scram do
+      b = Banana.create(color: 'blue')
+      c = Cherry.create(color: 'red')
+    end
+    assert_empty FruitReactor.calls
+    assert_equal false, FruitReactor.scrammed?
+  end  
+end

data/test/models/banana.rb

@@ -0,0 +1,5 @@
+class Banana < Fruit
+
+  reactor :peel
+
+end

data/test/models/cherry.rb

@@ -0,0 +1,3 @@
+class Cherry < Fruit
+
+end

data/test/models/fruit.rb

@@ -0,0 +1,15 @@
+class Fruit < ActiveRecord::Base
+
+  attr_accessible :color
+
+  define_reactor_callbacks :peel
+
+  reactor FruitReactor
+
+  def peel!
+    run_callbacks :peel do
+      self.peeled = true
+    end
+  end
+
+end

data/test/models/fruit_reactor.rb

@@ -0,0 +1,21 @@
+class FruitReactor < ActiveRecord::Reactor
+
+  class << self
+    delegate :calls, to: :instance
+  end
+
+  def calls
+    @calls ||= []
+  end
+
+  def before_save(record)
+    puts "#{self.class.name}#before_save #{record.color} #{record.class.name}"
+    calls << "before_save #{record.color} #{record.class.name}"
+  end
+
+  def after_create(record)
+    puts "#{self.class.name}#after_create #{record.color} #{record.class.name}"
+    calls << "after_create #{record.color} #{record.class.name}"
+  end
+
+end

data/test/models/peel_reactor.rb

@@ -0,0 +1,21 @@
+class PeelReactor < ActiveRecord::Reactor
+
+  class << self
+    delegate :calls, to: :instance
+  end
+
+  def calls
+    @calls ||= []
+  end
+
+  def before_peel(record)
+    puts "#{self.class.name}#before_peel #{record.color} #{record.class.name}"
+    calls << "before_peel #{record.color} #{record.class.name}"
+  end
+
+  def after_peel(record)
+    puts "#{self.class.name}#after_peel #{record.color} #{record.class.name}"
+    calls << "after_peel #{record.color} #{record.class.name}"
+  end
+
+end

data/test/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  
+  create_table :fruits, :force => true do |t|
+    t.string  :type
+    t.string  :color
+    t.boolean :peeled
+  end
+  
+end

data/test/support/custom_assertions.rb

@@ -0,0 +1,68 @@
+module CustomAssertions
+  def assert_empty(collection)
+    fail "collection expected, got nil" if collection.nil?
+    assert collection.empty?
+  end
+  
+  def assert_not_empty(collection)
+    fail "collection expected, got nil" if collection.nil?
+    assert !collection.empty?
+  end
+  
+  def assert_float_equal(expected, actual, order = 1)
+    assert_in_delta expected, actual, Float::EPSILON * 10**order
+  end
+  
+  def assert_valid(record)
+    fail "record expected, got nil" if record.nil?
+    result = record.valid?
+    errors = record.errors
+    assert result, "Expected #{record} to be valid, but had errors on #{errors.keys.map(&:to_s).to_sentence}"
+  end
+  
+  def assert_not_valid(record)
+    fail "record expected, got nil" if record.nil?
+    assert !record.valid?, "Expected #{record} not to be valid, but was"
+  end
+  
+  def assert_error_on(record, attr_name, error = nil)
+    fail "record expected, got nil" if record.nil?
+    if error
+      errors = record.errors
+      #error_instances = errors[attr_name.to_s]
+      message = "Expected validation error of type '#{error}' on attribute '#{attr_name}'"
+      message << " but was on #{errors.keys.map { |k| "'#{k}'" }.to_sentence}" if errors.any? && !errors.keys.include?(attr_name.to_sym)
+      message << " but was valid" if errors.empty?
+      assert errors.added?(attr_name, error), message
+    else
+      assert record.errors[attr_name.to_sym], "Expected validation error on attribute '#{attr_name}'"
+    end
+  end
+  
+  def assert_no_error_on(record, *attr_names)
+    fail "record expected, got nil" if record.nil?
+    attr_names = Array(attr_names)
+    if attr_names.empty?
+      assert record.errors.empty?, "Expected no errors on #{record}, but found #{record.errors.full_messages * ", "}"
+    else
+      attr_names.each do |attr_name|
+        assert record.errors[attr_name.to_sym].empty?, "Validation error on attribute #{attr_name}"
+      end
+    end
+  end
+  
+  def assert_save(record)
+    result = record.save
+    return assert(true) if result
+    assert_no_error_on record
+    fail "could not save record #{record.inspect}, although there were no validation errors"
+  end
+  
+  def assert_attrs(record, attrs)
+    fail "record expected, got nil" if record.nil?
+    attrs.each do |attr_name, value|
+      assert_equal value, record.send(attr_name), attr_name
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,46 @@
+ENV["RAILS_ENV"] = "test"
+
+require 'pathname'
+
+if RUBY_VERSION >= '1.9'
+  require 'simplecov'
+  SimpleCov.start do
+    if artifacts_dir = ENV['CC_BUILD_ARTIFACTS']
+      coverage_dir Pathname.new(artifacts_dir).relative_path_from(Pathname.new(SimpleCov.root)).to_s
+    end
+    add_filter '/test/'
+    add_filter 'vendor'
+  end
+
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    if result = SimpleCov.result
+      File.open(File.join(SimpleCov.coverage_path, 'coverage_percent.txt'), 'w') { |f| f << result.covered_percent.to_s }
+    end
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+require 'test/unit'
+require 'debugger'
+
+require 'active_record'
+require 'activerecord-reactor'
+
+ActiveRecord::Base.mass_assignment_sanitizer = :strict
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+require File.expand_path('../schema', __FILE__)
+require File.expand_path('../support/custom_assertions', __FILE__)
+
+require File.expand_path('../models/fruit_reactor', __FILE__)
+require File.expand_path('../models/peel_reactor', __FILE__)
+require File.expand_path('../models/fruit', __FILE__)
+require File.expand_path('../models/banana', __FILE__)
+require File.expand_path('../models/cherry', __FILE__)
+
+class ActiveSupport::TestCase
+  include CustomAssertions
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-reactor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Matthias Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email: mtgrosser@gmx.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_record/active_record.rb
+- lib/active_record/reactor/callbacks.rb
+- lib/active_record/reactor/version.rb
+- lib/active_record/reactor.rb
+- lib/activerecord-reactor.rb
+- MIT-LICENSE
+- README.md
+- Rakefile
+- test/models/banana.rb
+- test/models/fruit.rb
+- test/models/fruit_reactor.rb
+- test/models/peel_reactor.rb
+- test/models/cherry.rb
+- test/cases/reactor_test.rb
+- test/test_helper.rb
+- test/support/custom_assertions.rb
+- test/schema.rb
+homepage: https://github.com/mtgrosser/activerecord-reactor
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Unobtrusive observers for Rails models
+test_files:
+- test/models/banana.rb
+- test/models/fruit.rb
+- test/models/fruit_reactor.rb
+- test/models/peel_reactor.rb
+- test/models/cherry.rb
+- test/cases/reactor_test.rb
+- test/test_helper.rb
+- test/support/custom_assertions.rb
+- test/schema.rb