no_peeping_toms 1.0.1 → 1.1.0

data/History.rdoc

@@ -1,3 +1,10 @@
+=== Version 1.1.0 / 2010-01-06
+
+* Explicit enable/disable API (Corey Haines & Drew Olson)
+  ActiveRecord::Observer.enable_observers
+  ActiveRecord::Observer.disable_observers
+  NOTE: Observers are enabled by default.  You now need to explicitly disable them in your test helper
+
 === Version 1.0.1 / 2010-01-06
 
 * official gem release

data/README

@@ -5,7 +5,15 @@ Originally a plugin, now gemified.  'gem install no_peeping_toms'
 
 This plugin disables observers in your specs, so that model specs can run in complete isolation.
 
-You can choose to run some code with observers turned on.  This is useful when spec'ing an observer.  For example, if you write the following observer:
+To disable observers, place the following code in your test.rb, or spec_helper.rb, or wherever:
+
+  ActiveRecord::Observer.disable_observers
+
+You can easily reenable observers:
+
+  ActiveRecord::Observer.enable_observers
+
+You can choose to run some code with specific observers turned on.  This is useful when spec'ing an observer.  For example, if you write the following observer:
 
     class PersonObserver < ActiveRecord::Observer
       def before_update(person)
@@ -38,5 +46,13 @@ You can spec the Person class in complete isolation.
       end
     end
 
+Cool people who have contributed to NoPeepingToms:
+  * Brandon Keepers
+  * Corey Haines
+  * Jeff Siegel
+  * Drew Olson
+  * Zach Dennis
+
+If you think your name should be here, shoot me an email and I'll add it ASAP.
 
 Copyright (c) 2007-2010 Pat Maddox, released under the MIT license

data/Rakefile

@@ -19,6 +19,7 @@ Jeweler::Tasks.new do |s|
   s.add_dependency "activerecord", ['>= 1.1']
   s.files -= ['.gitignore', 'init.rb']
   s.test_files = Dir['spec/**/*']
+  s.test_files -= ['spec/debug.log']
 end
 
 Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/no_peeping_toms.rb

@@ -1,16 +1,19 @@
 module NoPeepingToms
   def self.included(base)
-    base.send :include, NoPeepingToms::InstanceMethods
-    base.extend NoPeepingToms::ClassMethods
-    base.alias_method_chain :update, :neighborhood_watch
-    base.cattr_accessor :allow_peeping_toms, :peeping_toms
-    base.allow_peeping_toms = false
-    base.peeping_toms = [] # toms that are allowed to peep
+    unless base.included_modules.include?(NoPeepingToms::InstanceMethods)
+      base.send :include, NoPeepingToms::InstanceMethods
+      base.extend NoPeepingToms::ClassMethods
+      base.alias_method_chain :update, :neighborhood_watch
+      base.cattr_accessor :peeping_toms, :default_observers_enabled
+      base.peeping_toms = [] # toms that are allowed to peep
+    end
+
+    base.enable_observers
   end
 
   module InstanceMethods
     def update_with_neighborhood_watch(*args)
-      if self.class.allow_peeping_toms || self.class.peeping_toms.include?(self)
+      if self.class.default_observers_enabled || self.class.peeping_toms.include?(self)
         update_without_neighborhood_watch(*args)
       end
     end
@@ -25,6 +28,14 @@ module NoPeepingToms
     ensure
       self.peeping_toms.clear
     end
+
+    def disable_observers
+      self.default_observers_enabled = false
+    end
+
+    def enable_observers
+      self.default_observers_enabled = true
+    end
   end
 end
 

data/no_peeping_toms.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{no_peeping_toms}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pat Maddox", "Brandon Keepers"]

data/spec/no_peeping_toms_spec.rb

@@ -4,106 +4,78 @@ module NoPeepingTomsSpec
   class Person < ActiveRecord::Base; end
   
   class PersonObserver < ActiveRecord::Observer
-    def before_update(person)
-      $observer_called_names.push person.name
+    cattr_accessor :called
+
+    def before_create(person)
+      self.class.called = true
     end
   end
   
   class AnotherObserver < ActiveRecord::Observer
     observe Person
-    def before_update(person)
-      $calls_to_another_observer += 1
+    cattr_accessor :called
+
+    def before_create(person)
+      self.class.called = true
     end
   end
-  
-  describe Person, " when changing a name" do
-    before(:each) do
-      $observer_called_names = []
-      $calls_to_another_observer = 0
-      @person = Person.create! :name => "Pat Maddox"
-    end
 
-    it "should not register a name change" do
-      @person.update_attribute :name, "Name change"
-      $observer_called_names.pop.should be_blank
-      $calls_to_another_observer.should == 0
+  describe NoPeepingToms, "configuration" do
+    it "enables observers by default" do
+      load 'no_peeping_toms.rb'
+      ActiveRecord::Observer.default_observers_enabled.should be_true
     end
 
-    it "should register a name change with the person observer turned on by name" do
-      ActiveRecord::Observer.with_observers("NoPeepingTomsSpec::PersonObserver") do
-        @person.update_attribute :name, "Name change"
-        $observer_called_names.pop.should == "Name change"
-      end
+    it "runs default observers when default observers are enabled" do
+      ActiveRecord::Observer.enable_observers
+      PersonObserver.called = false
+      Person.create!
+      PersonObserver.called.should be_true
+    end
 
-      @person.update_attribute :name, "Man Without a Name"
-      $observer_called_names.pop.should be_blank
-      
-      $calls_to_another_observer.should == 0
+    it "does not run default observers when default observers are disabled" do
+      ActiveRecord::Observer.disable_observers
+      PersonObserver.called = false
+      Person.create!
+      PersonObserver.called.should be_false
     end
-    
-    it "should register a name change with the person observer turned on by class reference" do
-      ActiveRecord::Observer.with_observers(NoPeepingTomsSpec::PersonObserver) do
-        @person.update_attribute :name, "Name change"
-        $observer_called_names.pop.should == "Name change"
-      end
+  end
 
-      @person.update_attribute :name, "Man Without a Name"
-      $observer_called_names.pop.should be_blank
-      
-      $calls_to_another_observer.should == 0      
+  describe ActiveRecord::Observer, 'with_observers' do
+    before(:each) do
+      ActiveRecord::Observer.disable_observers
     end
 
-    it "should register a name change with an anonymous observer" do
-      observer = Class.new(ActiveRecord::Observer) do
-        observe NoPeepingTomsSpec::Person
-        def before_update(person)
-          $observer_called_names.push person.name
-        end
-      end
-      ActiveRecord::Observer.with_observers(observer) do
-        @person.update_attribute :name, "Name change"
-        $observer_called_names.pop.should == "Name change"
-      end
+    it "should enable an observer via stringified class name" do
+      PersonObserver.called = false
+      ActiveRecord::Observer.with_observers("NoPeepingTomsSpec::PersonObserver") { Person.create! }
+      PersonObserver.called.should be_true
+    end
 
-      @person.update_attribute :name, "Man Without a Name"
-      $observer_called_names.pop.should be_blank
-      
-      $calls_to_another_observer.should == 0      
+    it "should enable an observer via class" do
+      PersonObserver.called = false
+      ActiveRecord::Observer.with_observers(NoPeepingTomsSpec::PersonObserver) { Person.create! }
+      PersonObserver.called.should be_true
     end
 
-    
-    it "should handle multiple observers" do
-      ActiveRecord::Observer.with_observers("NoPeepingTomsSpec::PersonObserver", "NoPeepingTomsSpec::AnotherObserver") do
-        @person.update_attribute :name, "Name change"
-        $observer_called_names.pop.should == "Name change"
+    it "should accept multiple observers" do
+      PersonObserver.called = false
+      AnotherObserver.called = false
+      ActiveRecord::Observer.with_observers(NoPeepingTomsSpec::PersonObserver, NoPeepingTomsSpec::AnotherObserver) do
+        Person.create!
       end
-
-      @person.update_attribute :name, "Man Without a Name"
-      $observer_called_names.pop.should be_blank
-      
-      $calls_to_another_observer.should == 1
+      PersonObserver.called.should be_true
+      AnotherObserver.called.should be_true
     end
 
-    it "should handle multiple anonymous observers" do
-      observer1 = Class.new(ActiveRecord::Observer) do
-        observe NoPeepingTomsSpec::Person
-        def before_update(person) ; $observer_called_names.push "#{person.name} 1" ; end
-      end
-      observer2 = Class.new(ActiveRecord::Observer) do
+    it "should accept anonymous observers" do
+      called = false
+      observer = Class.new(ActiveRecord::Observer) do
         observe NoPeepingTomsSpec::Person
-        def before_update(person) ; $observer_called_names.push "#{person.name} 2" ; end
+        define_method(:before_create) {|person| called = true }
       end
-
-      ActiveRecord::Observer.with_observers(observer1, observer2) do
-        @person.update_attribute :name, "Name change"
-        $observer_called_names.pop.should == "Name change 2"
-        $observer_called_names.pop.should == "Name change 1"
-      end
-
-      @person.update_attribute :name, "Man Without a Name"
-      $observer_called_names.pop.should be_blank
-      
-      $calls_to_another_observer.should == 0
+      ActiveRecord::Observer.with_observers(observer) { Person.create! }
+      called.should be_true
     end
 
     it "should ensure peeping toms are reset after raised exception" do

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+require File.expand_path(File.dirname(__FILE__) + '/../../../../spec/spec_helper')
 
 plugin_spec_dir = File.dirname(__FILE__)
 ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: no_peeping_toms
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - Pat Maddox