no_peeping_toms 1.1.0 → 2.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/debug.log

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in no-peeping-toms.gemspec
+gemspec

data/History.rdoc

@@ -1,3 +1,6 @@
+=== Version 2.0.1 / 2011-02-16
+* Supports current Rails 3.x release.  No longer supports Rails 2.
+
 === Version 1.1.0 / 2010-01-06
 
 * Explicit enable/disable API (Corey Haines & Drew Olson)

data/README.rdoc

@@ -0,0 +1,67 @@
+= no_peeping_toms
+
+This plugin disables observers in your specs, so that model specs can run in complete isolation.
+
+== Installation
+
+Add to your Gemfile:
+
+  gem 'no_peeping_toms', :git => 'git://github.com/alindeman/no_peeping_toms.git'
+
+and run `bundle install`.
+
+no_peeping_toms >= 2.0.0 only supports on Rails 3.  If you need Rails 2 support, use 1.1.0: `gem install no_peeping_toms -v 1.1.0`
+
+== Usage
+
+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)
+      old_person = Person.find person.id
+      if old_person.name != person.name
+        NameChange.create! :person => person, :old_name => old_person.name, :new_name => person.name
+      end
+    end
+  end
+
+You can spec the Person class in complete isolation.
+
+  describe Person, " when changing a name" do
+    before(:each) do
+      @person = Person.create! :name => "Pat Maddox"
+    end
+
+    # By default, don't run any observers
+    it "should not register a name change" do
+      lambda { @person.update_attribute :name, "Don Juan Demarco" }.should_not change(NameChange, :count)
+    end
+
+    # Run only a portion of code with certain observers turned on
+    it "should register a name change with the person observer turned on" do
+      ActiveRecord::Observer.with_observers(:person_observer) do
+        lambda { @person.update_attribute :name, "Don Juan Demarco" }.should change(NameChange, :count).by(1)
+      end
+
+      lambda { @person.update_attribute :name, "Man Without a Name" }.should_not change(NameChange, :count)
+    end
+  end
+
+== Credits
+
+* Brandon Keepers
+* Corey Haines
+* Drew Olson
+* Jeff Siegel
+* Zach Dennis
+* Andy Lindeman
+
+Copyright (c) 2007-2011 Pat Maddox, released under the MIT license.

data/lib/no_peeping_toms.rb

@@ -1,42 +1,77 @@
+require 'active_record'
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/string/inflections'
+
 module NoPeepingToms
-  def self.included(base)
-    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
+  extend ActiveSupport::Concern
 
-    base.enable_observers
-  end
+  included do
+    # Define class-level accessors
+    cattr_accessor :default_observers_enabled, :observers_enabled
 
-  module InstanceMethods
-    def update_with_neighborhood_watch(*args)
-      if self.class.default_observers_enabled || self.class.peeping_toms.include?(self)
-        update_without_neighborhood_watch(*args)
-      end
-    end
+    # By default, enable all observers
+    enable_observers
+    self.observers_enabled = []
+
+    alias_method_chain :define_callbacks, :enabled_check
   end
-  
+
   module ClassMethods
+    # Enables all observers (default behavior)
+    def enable_observers
+      self.default_observers_enabled = true
+    end
+
+    # Disables all observers
+    def disable_observers
+      self.default_observers_enabled = false
+    end
+
+    # Run a block with a specific set of observers enabled
     def with_observers(*observer_syms)
-      self.peeping_toms = Array(observer_syms).map do |o| 
+      self.observers_enabled = Array(observer_syms).map do |o|
         o.respond_to?(:instance) ? o.instance : o.to_s.classify.constantize.instance
       end
       yield
     ensure
-      self.peeping_toms.clear
+      self.observers_enabled = []
     end
 
-    def disable_observers
-      self.default_observers_enabled = false
+    # Determines whether an observer is enabled.  Either:
+    # - All observers are enabled OR
+    # - The observer is in the whitelist
+    def observer_enabled?(observer)
+      default_observers_enabled or self.observers_enabled.include?(observer)
     end
+  end
 
-    def enable_observers
-      self.default_observers_enabled = true
+  module InstanceMethods
+    # Overrides ActiveRecord#define_callbacks so that observers are only called
+    # when enabled.
+    #
+    # This is a bit yuck being a protected method, but appears to be the cleanest
+    # way so far
+    def define_callbacks_with_enabled_check(klass)
+      observer = self
+      observer_name = observer.class.name.underscore.gsub('/', '__')
+
+      ActiveRecord::Callbacks::CALLBACKS.each do |callback|
+        next unless respond_to?(callback)
+        callback_meth = :"_notify_#{observer_name}_for_#{callback}"
+        unless klass.respond_to?(callback_meth)
+          klass.send(:define_method, callback_meth) do
+            observer.send(callback, self) if observer.observer_enabled?
+          end
+          klass.send(callback, callback_meth)
+        end
+      end
+    end
+
+    # Determines whether this observer should be run
+    def observer_enabled?
+      self.class.observer_enabled?(self)
     end
   end
 end
 
-ActiveRecord::Observer.send :include, NoPeepingToms
+ActiveRecord::Observer.__send__ :include, NoPeepingToms

data/lib/no_peeping_toms/version.rb

@@ -0,0 +1,3 @@
+module NoPeepingToms
+  VERSION = "2.1.0"
+end

data/no_peeping_toms.gemspec

@@ -1,58 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "no_peeping_toms/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{no_peeping_toms}
-  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"]
-  s.date = %q{2010-01-06}
+  s.name        = "no_peeping_toms"
+  s.version     = NoPeepingToms::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Pat Maddox"]
+  s.email       = ["pat.maddox@gmail.com"]
+  s.homepage    = "https://github.com/patmaddox/no_peeping_toms"
+  s.summary     = %q{Disables observers during testing, allowing you to write model tests that are completely decoupled from the observer.}
   s.description = %q{Disables observers during testing, allowing you to write model tests that are completely decoupled from the observer.}
-  s.email = %q{pat.maddox@gmail.com}
-  s.extra_rdoc_files = [
-    "README"
-  ]
-  s.files = [
-    "History.rdoc",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "install.rb",
-     "lib/no_peeping_toms.rb",
-     "no_peeping_toms.gemspec",
-     "spec/db/database.yml",
-     "spec/db/schema.rb",
-     "spec/no_peeping_toms_spec.rb",
-     "spec/spec_helper.rb",
-     "uninstall.rb"
-  ]
-  s.homepage = %q{http://github.com/patmaddox/no-peeping-toms}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.rubyforge_project = "no_peeping_toms"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Disables observers during testing, allowing you to write model tests that are completely decoupled from the observer.}
-  s.test_files = [
-    "spec/db",
-     "spec/db/database.yml",
-     "spec/db/schema.rb",
-     "spec/no_peeping_toms_spec.rb",
-     "spec/spec_helper.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_runtime_dependency 'activerecord', '>=3.0.0'
+  s.add_runtime_dependency 'activesupport', '>=3.0.0'
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<activerecord>, [">= 1.1"])
-    else
-      s.add_dependency(%q<activerecord>, [">= 1.1"])
-    end
-  else
-    s.add_dependency(%q<activerecord>, [">= 1.1"])
-  end
+  s.add_development_dependency 'rspec', '~>2.5'
+  s.add_development_dependency 'sqlite3'
 end
-

data/spec/no_peeping_toms_spec.rb

@@ -2,12 +2,14 @@ require File.dirname(__FILE__) + '/spec_helper'
 
 module NoPeepingTomsSpec
   class Person < ActiveRecord::Base; end
+  class SpecialPerson < Person; end
   
   class PersonObserver < ActiveRecord::Observer
     cattr_accessor :called
 
     def before_create(person)
-      self.class.called = true
+      self.class.called ||= 0
+      self.class.called += 1
     end
   end
   
@@ -16,10 +18,15 @@ module NoPeepingTomsSpec
     cattr_accessor :called
 
     def before_create(person)
-      self.class.called = true
+      self.class.called ||= 0
+      self.class.called += 1
     end
   end
 
+  # Register the observers with the host app
+  PersonObserver.instance
+  AnotherObserver.instance
+
   describe NoPeepingToms, "configuration" do
     it "enables observers by default" do
       load 'no_peeping_toms.rb'
@@ -28,16 +35,23 @@ module NoPeepingTomsSpec
 
     it "runs default observers when default observers are enabled" do
       ActiveRecord::Observer.enable_observers
-      PersonObserver.called = false
+      PersonObserver.called = 0
       Person.create!
-      PersonObserver.called.should be_true
+      PersonObserver.called.should == 1
     end
 
     it "does not run default observers when default observers are disabled" do
       ActiveRecord::Observer.disable_observers
-      PersonObserver.called = false
+      PersonObserver.called = 0
       Person.create!
-      PersonObserver.called.should be_false
+      PersonObserver.called.should == 0
+    end
+
+    it "only runs observers once on descendent classes" do
+      ActiveRecord::Observer.enable_observers
+      PersonObserver.called = 0
+      SpecialPerson.create!
+      PersonObserver.called.should == 1
     end
   end
 
@@ -68,23 +82,13 @@ module NoPeepingTomsSpec
       AnotherObserver.called.should be_true
     end
 
-    it "should accept anonymous observers" do
-      called = false
-      observer = Class.new(ActiveRecord::Observer) do
-        observe NoPeepingTomsSpec::Person
-        define_method(:before_create) {|person| called = true }
-      end
-      ActiveRecord::Observer.with_observers(observer) { Person.create! }
-      called.should be_true
-    end
-
     it "should ensure peeping toms are reset after raised exception" do
       lambda {
         ActiveRecord::Observer.with_observers(NoPeepingTomsSpec::PersonObserver) do
           raise ArgumentError, "Michael, I've made a huge mistake"
         end
       }.should raise_error(ArgumentError)
-      ActiveRecord::Observer.peeping_toms.should == []
+      ActiveRecord::Observer.observers_enabled.should_not include(NoPeepingTomsSpec::PersonObserver)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,8 +1,12 @@
-require File.expand_path(File.dirname(__FILE__) + '/../../../../spec/spec_helper')
+require 'logger'
 
 plugin_spec_dir = File.dirname(__FILE__)
-ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+plugin_lib_dir = File.join(plugin_spec_dir, '..', 'lib')
+
+require File.join(plugin_lib_dir, 'no_peeping_toms')
 
+# Setup ActiveRecord
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
 databases = YAML::load(IO.read(plugin_spec_dir + "/db/database.yml"))
 ActiveRecord::Base.establish_connection(databases[ENV["DB"] || "sqlite3"])
 load(File.join(plugin_spec_dir, "db", "schema.rb"))

metadata

@@ -1,74 +1,136 @@
 --- !ruby/object:Gem::Specification 
 name: no_peeping_toms
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  hash: 11
+  prerelease: false
+  segments: 
+  - 2
+  - 1
+  - 0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Pat Maddox
-- Brandon Keepers
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-06 00:00:00 -08:00
+date: 2011-02-26 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 5
+        version: "2.5"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "1.1"
-    version: 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Disables observers during testing, allowing you to write model tests that are completely decoupled from the observer.
-email: pat.maddox@gmail.com
+email: 
+- pat.maddox@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- Gemfile
 - History.rdoc
-- README
-- Rakefile
-- VERSION
-- install.rb
+- README.rdoc
 - lib/no_peeping_toms.rb
+- lib/no_peeping_toms/version.rb
 - no_peeping_toms.gemspec
 - spec/db/database.yml
 - spec/db/schema.rb
 - spec/no_peeping_toms_spec.rb
 - spec/spec_helper.rb
-- uninstall.rb
 has_rdoc: true
-homepage: http://github.com/patmaddox/no-peeping-toms
+homepage: https://github.com/patmaddox/no_peeping_toms
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: no_peeping_toms
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Disables observers during testing, allowing you to write model tests that are completely decoupled from the observer.

data/README

@@ -1,58 +0,0 @@
-no_peeping_toms
-=============
-
-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.
-
-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)
-        old_person = Person.find person.id
-        if old_person.name != person.name
-          NameChange.create! :person => person, :old_name => old_person.name, :new_name => person.name
-        end
-      end
-    end
-    
-You can spec the Person class in complete isolation.
-
-    describe Person, " when changing a name" do
-      before(:each) do
-        @person = Person.create! :name => "Pat Maddox"
-      end
-  
-      # By default, don't run any observers
-      it "should not register a name change" do
-        lambda { @person.update_attribute :name, "Don Juan Demarco" }.should_not change(NameChange, :count)
-      end
-  
-      # Run only a portion of code with certain observers turned on
-      it "should register a name change with the person observer turned on" do
-        ActiveRecord::Observer.with_observers(:person_observer) do
-          lambda { @person.update_attribute :name, "Don Juan Demarco" }.should change(NameChange, :count).by(1)
-        end
-    
-        lambda { @person.update_attribute :name, "Man Without a Name" }.should_not change(NameChange, :count)
-      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

@@ -1,25 +0,0 @@
-begin
-  require 'jeweler'
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-  exit 1
-end
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rcov/rcovtask'
-require "load_multi_rails_rake_tasks" 
-
-Jeweler::Tasks.new do |s|
-  s.name = "no_peeping_toms"
-  s.summary = "Disables observers during testing, allowing you to write model tests that are completely decoupled from the observer."
-  s.description = s.summary
-  s.email = "pat.maddox@gmail.com"
-  s.homepage = "http://github.com/patmaddox/no-peeping-toms"
-  s.authors = ["Pat Maddox", "Brandon Keepers"]
-  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 +0,0 @@
-1.1.0

data/install.rb

@@ -1 +0,0 @@
-# Install hook code here

data/uninstall.rb

@@ -1 +0,0 @@
-# Uninstall hook code here