rails-observers 0.1.0

data/test/models/observers.rb

@@ -0,0 +1,27 @@
+class ORM
+  include ActiveModel::Observing
+
+  def save
+    notify_observers :before_save
+  end
+
+  class Observer < ActiveModel::Observer
+    def before_save_invocations
+      @before_save_invocations ||= []
+    end
+
+    def before_save(record)
+      before_save_invocations << record
+    end
+  end
+end
+
+class Widget < ORM; end
+class Budget < ORM; end
+class WidgetObserver < ORM::Observer; end
+class BudgetObserver < ORM::Observer; end
+class AuditTrail < ORM::Observer
+  observe :widget, :budget
+end
+
+ORM.instantiate_observers

data/test/observer_array_test.rb

@@ -0,0 +1,222 @@
+require 'minitest/autorun'
+require 'active_model'
+require 'rails/observers/active_model/active_model'
+require 'models/observers'
+
+class ObserverArrayTest < ActiveModel::TestCase
+  def teardown
+    ORM.observers.enable :all
+    Budget.observers.enable :all
+    Widget.observers.enable :all
+  end
+
+  def assert_observer_notified(model_class, observer_class)
+    observer_class.instance.before_save_invocations.clear
+    model_instance = model_class.new
+    model_instance.save
+    assert_equal [model_instance], observer_class.instance.before_save_invocations
+  end
+
+  def assert_observer_not_notified(model_class, observer_class)
+    observer_class.instance.before_save_invocations.clear
+    model_instance = model_class.new
+    model_instance.save
+    assert_equal [], observer_class.instance.before_save_invocations
+  end
+
+  test "all observers are enabled by default" do
+    assert_observer_notified Widget, WidgetObserver
+    assert_observer_notified Budget, BudgetObserver
+    assert_observer_notified Widget, AuditTrail
+    assert_observer_notified Budget, AuditTrail
+  end
+
+  test "can disable individual observers using a class constant" do
+    ORM.observers.disable WidgetObserver
+
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_notified     Budget, BudgetObserver
+    assert_observer_notified     Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "can enable individual observers using a class constant" do
+    ORM.observers.disable :all
+    ORM.observers.enable AuditTrail
+
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_not_notified Budget, BudgetObserver
+    assert_observer_notified     Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "can disable individual observers using a symbol" do
+    ORM.observers.disable :budget_observer
+
+    assert_observer_notified     Widget, WidgetObserver
+    assert_observer_not_notified Budget, BudgetObserver
+    assert_observer_notified     Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "can enable individual observers using a symbol" do
+    ORM.observers.disable :all
+    ORM.observers.enable :audit_trail
+
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_not_notified Budget, BudgetObserver
+    assert_observer_notified     Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "can disable multiple observers at a time" do
+    ORM.observers.disable :widget_observer, :budget_observer
+
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_not_notified Budget, BudgetObserver
+    assert_observer_notified     Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "can enable multiple observers at a time" do
+    ORM.observers.disable :all
+    ORM.observers.enable :widget_observer, :budget_observer
+
+    assert_observer_notified     Widget, WidgetObserver
+    assert_observer_notified     Budget, BudgetObserver
+    assert_observer_not_notified Widget, AuditTrail
+    assert_observer_not_notified Budget, AuditTrail
+  end
+
+  test "can disable all observers using :all" do
+    ORM.observers.disable :all
+
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_not_notified Budget, BudgetObserver
+    assert_observer_not_notified Widget, AuditTrail
+    assert_observer_not_notified Budget, AuditTrail
+  end
+
+  test "can enable all observers using :all" do
+    ORM.observers.disable :all
+    ORM.observers.enable :all
+
+    assert_observer_notified Widget, WidgetObserver
+    assert_observer_notified Budget, BudgetObserver
+    assert_observer_notified Widget, AuditTrail
+    assert_observer_notified Budget, AuditTrail
+  end
+
+  test "can disable observers on individual models without affecting those observers on other models" do
+    Widget.observers.disable :all
+
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_notified     Budget, BudgetObserver
+    assert_observer_not_notified Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "can enable observers on individual models without affecting those observers on other models" do
+    ORM.observers.disable :all
+    Budget.observers.enable AuditTrail
+
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_not_notified Budget, BudgetObserver
+    assert_observer_not_notified Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "can disable observers for the duration of a block" do
+    yielded = false
+    ORM.observers.disable :budget_observer do
+      yielded = true
+      assert_observer_notified     Widget, WidgetObserver
+      assert_observer_not_notified Budget, BudgetObserver
+      assert_observer_notified     Widget, AuditTrail
+      assert_observer_notified     Budget, AuditTrail
+    end
+
+    assert yielded
+    assert_observer_notified Widget, WidgetObserver
+    assert_observer_notified Budget, BudgetObserver
+    assert_observer_notified Widget, AuditTrail
+    assert_observer_notified Budget, AuditTrail
+  end
+
+  test "can enable observers for the duration of a block" do
+    yielded = false
+    Widget.observers.disable :all
+
+    Widget.observers.enable :all do
+      yielded = true
+      assert_observer_notified Widget, WidgetObserver
+      assert_observer_notified Budget, BudgetObserver
+      assert_observer_notified Widget, AuditTrail
+      assert_observer_notified Budget, AuditTrail
+    end
+
+    assert yielded
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_notified     Budget, BudgetObserver
+    assert_observer_not_notified Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+
+  test "raises an appropriate error when a developer accidentally enables or disables the wrong class (i.e. Widget instead of WidgetObserver)" do
+    assert_raise ArgumentError do
+      ORM.observers.enable :widget
+    end
+
+    assert_raise ArgumentError do
+      ORM.observers.enable Widget
+    end
+
+    assert_raise ArgumentError do
+      ORM.observers.disable :widget
+    end
+
+    assert_raise ArgumentError do
+      ORM.observers.disable Widget
+    end
+  end
+
+  test "allows #enable at the superclass level to override #disable at the subclass level when called last" do
+    Widget.observers.disable :all
+    ORM.observers.enable :all
+
+    assert_observer_notified Widget, WidgetObserver
+    assert_observer_notified Budget, BudgetObserver
+    assert_observer_notified Widget, AuditTrail
+    assert_observer_notified Budget, AuditTrail
+  end
+
+  test "allows #disable at the superclass level to override #enable at the subclass level when called last" do
+    Budget.observers.enable :audit_trail
+    ORM.observers.disable :audit_trail
+
+    assert_observer_notified     Widget, WidgetObserver
+    assert_observer_notified     Budget, BudgetObserver
+    assert_observer_not_notified Widget, AuditTrail
+    assert_observer_not_notified Budget, AuditTrail
+  end
+
+  test "can use the block form at different levels of the hierarchy" do
+    yielded = false
+    Widget.observers.disable :all
+
+    ORM.observers.enable :all do
+      yielded = true
+      assert_observer_notified Widget, WidgetObserver
+      assert_observer_notified Budget, BudgetObserver
+      assert_observer_notified Widget, AuditTrail
+      assert_observer_notified Budget, AuditTrail
+    end
+
+    assert yielded
+    assert_observer_not_notified Widget, WidgetObserver
+    assert_observer_notified     Budget, BudgetObserver
+    assert_observer_not_notified Widget, AuditTrail
+    assert_observer_notified     Budget, AuditTrail
+  end
+end
+

data/test/observing_test.rb

@@ -0,0 +1,183 @@
+require 'minitest/autorun'
+require 'active_model'
+require 'rails/observers/active_model/active_model'
+
+class ObservedModel
+  include ActiveModel::Observing
+
+  class Observer
+  end
+end
+
+class FooObserver < ActiveModel::Observer
+  class << self
+    public :new
+  end
+
+  attr_accessor :stub
+
+  def on_spec(record, *args)
+    stub.event_with(record, *args) if stub
+  end
+
+  def around_save(record)
+    yield :in_around_save
+  end
+end
+
+class Foo
+  include ActiveModel::Observing
+end
+
+class ObservingTest < ActiveModel::TestCase
+  def setup
+    ObservedModel.observers.clear
+  end
+
+  test "initializes model with no cached observers" do
+    assert ObservedModel.observers.empty?, "Not empty: #{ObservedModel.observers.inspect}"
+  end
+
+  test "stores cached observers in an array" do
+    ObservedModel.observers << :foo
+    assert ObservedModel.observers.include?(:foo), ":foo not in #{ObservedModel.observers.inspect}"
+  end
+
+  test "flattens array of assigned cached observers" do
+    ObservedModel.observers = [[:foo], :bar]
+    assert ObservedModel.observers.include?(:foo), ":foo not in #{ObservedModel.observers.inspect}"
+    assert ObservedModel.observers.include?(:bar), ":bar not in #{ObservedModel.observers.inspect}"
+  end
+
+  test "uses an ObserverArray so observers can be disabled" do
+    ObservedModel.observers = [:foo, :bar]
+    assert ObservedModel.observers.is_a?(ActiveModel::ObserverArray)
+  end
+
+  test "instantiates observer names passed as strings" do
+    ObservedModel.observers << 'foo_observer'
+    FooObserver.expects(:instance)
+    ObservedModel.instantiate_observers
+  end
+
+  test "instantiates observer names passed as symbols" do
+    ObservedModel.observers << :foo_observer
+    FooObserver.expects(:instance)
+    ObservedModel.instantiate_observers
+  end
+
+  test "instantiates observer classes" do
+    ObservedModel.observers << ObservedModel::Observer
+    ObservedModel::Observer.expects(:instance)
+    ObservedModel.instantiate_observers
+  end
+
+  test "raises an appropriate error when a developer accidentally adds the wrong class (i.e. Widget instead of WidgetObserver)" do
+    assert_raise ArgumentError do
+      ObservedModel.observers = ['string']
+      ObservedModel.instantiate_observers
+    end
+    assert_raise ArgumentError do
+      ObservedModel.observers = [:string]
+      ObservedModel.instantiate_observers
+    end
+    assert_raise ArgumentError do
+      ObservedModel.observers = [String]
+      ObservedModel.instantiate_observers
+    end
+  end
+
+  test "passes observers to subclasses" do
+    FooObserver.instance
+    bar = Class.new(Foo)
+    assert_equal Foo.observers_count, bar.observers_count
+  end
+end
+
+class ObserverTest < ActiveModel::TestCase
+  def setup
+    ObservedModel.observers = :foo_observer
+    FooObserver.singleton_class.instance_eval do
+      alias_method :original_observed_classes, :observed_classes
+    end
+  end
+
+  def teardown
+    FooObserver.singleton_class.instance_eval do
+      undef_method :observed_classes
+      alias_method :observed_classes, :original_observed_classes
+    end
+  end
+
+  test "guesses implicit observable model name" do
+    assert_equal Foo, FooObserver.observed_class
+  end
+
+  test "tracks implicit observable models" do
+    instance = FooObserver.new
+    assert_equal [Foo], instance.observed_classes
+  end
+
+  test "tracks explicit observed model class" do
+    FooObserver.observe ObservedModel
+    instance = FooObserver.new
+    assert_equal [ObservedModel], instance.observed_classes
+  end
+
+  test "tracks explicit observed model as string" do
+    FooObserver.observe 'observed_model'
+    instance = FooObserver.new
+    assert_equal [ObservedModel], instance.observed_classes
+  end
+
+  test "tracks explicit observed model as symbol" do
+    FooObserver.observe :observed_model
+    instance = FooObserver.new
+    assert_equal [ObservedModel], instance.observed_classes
+  end
+
+  test "calls existing observer event" do
+    foo = Foo.new
+    FooObserver.instance.stub = stub
+    FooObserver.instance.stub.expects(:event_with).with(foo)
+    Foo.notify_observers(:on_spec, foo)
+  end
+
+  test "calls existing observer event from the instance" do
+    foo = Foo.new
+    FooObserver.instance.stub = stub
+    FooObserver.instance.stub.expects(:event_with).with(foo)
+    foo.notify_observers(:on_spec)
+  end
+
+  test "passes extra arguments" do
+    foo = Foo.new
+    FooObserver.instance.stub = stub
+    FooObserver.instance.stub.expects(:event_with).with(foo, :bar)
+    Foo.send(:notify_observers, :on_spec, foo, :bar)
+  end
+
+  test "skips nonexistent observer event" do
+    foo = Foo.new
+    Foo.notify_observers(:whatever, foo)
+  end
+
+  test "update passes a block on to the observer" do
+    yielded_value = nil
+    FooObserver.instance.update(:around_save, Foo.new) do |val|
+      yielded_value = val
+    end
+    assert_equal :in_around_save, yielded_value
+  end
+
+  test "observe redefines observed_classes class method" do
+    class BarObserver < ActiveModel::Observer
+      observe :foo
+    end
+
+    assert_equal [Foo], BarObserver.observed_classes
+
+    BarObserver.observe(ObservedModel)
+    assert_equal [ObservedModel], BarObserver.observed_classes
+  end
+end

data/test/rake_test.rb

@@ -0,0 +1,40 @@
+require 'isolation/abstract_unit'
+require 'rails-observers'
+
+module ApplicationTests
+  class RakeTest < ActiveSupport::TestCase
+    include ActiveSupport::Testing::Isolation
+
+    def setup
+      build_app
+      boot_rails
+      FileUtils.rm_rf("#{app_path}/config/environments")
+    end
+
+    def teardown
+      teardown_app
+    end
+
+    def test_load_activerecord_base_when_we_use_observers
+      Dir.chdir(app_path) do
+        `bundle exec rails g model user;
+         bundle exec rake db:migrate;
+         bundle exec rails g observer user;`
+
+        add_to_config "config.active_record.observers = :user_observer"
+
+        assert_equal "0", `bundle exec rails r "puts User.count"`.strip
+
+        app_file "lib/tasks/count_user.rake", <<-RUBY
+          namespace :user do
+            task :count => :environment do
+              puts User.count
+            end
+          end
+        RUBY
+
+        assert_equal "0", `bundle exec rake user:count`.strip
+      end
+    end
+  end
+end