callback_skipper 0.3.1 → 1.0.0

data/.rvmrc

@@ -1,4 +1,4 @@
-rvm use ree-1.8.7-2011.03@callback_skipper --create
+rvm use ruby-1.9.3-p125@callback_skipper --create
 if ! command -v bundle ; then
   gem install bundler
   bundle

data/README.md

@@ -24,6 +24,19 @@ foo = Foo.new
 foo.skip_callback :save, :after, :do_something_expensive
 foo.save!
 ```
+### Error handling
+If the code attempts to skip an undefined callback, a **CallbackSkipper::CallbackMethodNotDefined** will be raised:
+
+```ruby
+# class Foo is defined above
+foo = Foo.new
+begin
+  foo.skip_callback :save ,:after, :method_that_is_not_defined
+rescue CallbackSkipper::CallbackMethodNotDefined
+  puts "You should not skip callback methods that are not defined"
+end
+```
+
 ### Example: FactoryGirl Usage
 
 https://github.com/thoughtbot/factory_girl

data/Rakefile

@@ -1 +1,4 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => 'spec'

data/callback_skipper.gemspec

@@ -20,5 +20,9 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here
   s.add_runtime_dependency 'activerecord', ['>= 3.0']
-  s.add_development_dependency "rake", ["0.9.2.2"]
+  s.add_development_dependency 'rake', ['0.9.2.2']
+  s.add_development_dependency('sqlite3', ['>= 1.3.5'])
+  s.add_development_dependency('rspec', ['>= 2.11.0'])
+  s.add_development_dependency('pry', ['>= 0'])
+
 end

data/lib/callback_skipper.rb

@@ -2,10 +2,25 @@ require "callback_skipper/version"
 
 module CallbackSkipper
   extend ActiveSupport::Concern
+
+  class CallbackNotDefinedError < StandardError; end
+
+  # skip a specific callback for the given instance
+  # @raises CallbackNotDefinedError if no callback is found matching the requested callback
   def skip_callback(*args)
+    raise CallbackNotDefinedError.new("Callback not defined matching: #{self.class.name} #{args}") unless callback_defined?(*args)
     instance = self
     args << {:if => lambda { self == instance }}
     self.class.skip_callback *args
   end
+
+  private
+  # asserts that the callback exists in the callback chain
+  # @param args [Array] array of options matching the set_callback signiture.  first param is either the method name or the callback type (before/after/around)
+  def callback_defined?(name, *args)
+    callback_method_name = args[0].in?([:before, :after, :around]) ? args[1] : args[0]
+    self.send("_#{name}_callbacks").collect(&:filter).include?(callback_method_name)
+  end
 end
+
 ActiveRecord::Base.send :include, CallbackSkipper

data/lib/callback_skipper/version.rb

@@ -1,3 +1,3 @@
 module CallbackSkipper
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

data/spec/lib/callback_skipper_spec.rb

@@ -0,0 +1,69 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe CallbackSkipper do
+  describe "For an instance of ActiveRecord model with callbacks" do
+
+    class User < ActiveRecord::Base
+      around_create :do_around_create
+      after_save :do_after_save
+      before_validation :do_before_validation
+
+      protected
+
+      def do_around_create
+        true
+      end
+
+      def do_after_save
+        true
+      end
+
+      def do_before_validation
+        true
+      end
+    end
+
+    before do
+      @user = User.new
+    end
+
+    describe "when its saved while skipping all callbacks" do
+      before do
+        @user.skip_callback :save, :after, :do_after_save
+        @user.skip_callback :create, :around, :do_around_create
+        @user.skip_callback :validation, :before, :do_before_validation
+      end
+      it "should skip all validations" do
+        @user.should_receive(:do_after_save).never
+        @user.should_receive(:do_around_create).never
+        @user.should_receive(:do_before_validation).never
+        @user.save!
+      end
+      describe "when a new instance of user is assigned to the same variable that skipped callbacks before" do
+        before do
+          @user = User.new
+        end
+        it "should not skip validations upon saving" do
+          @user.should_receive(:do_after_save).once
+          @user.should_receive(:do_around_create).once
+          @user.should_receive(:do_before_validation).once
+          @user.save!
+        end
+      end
+      describe "when a new instance of user is initialized" do
+        before do
+          @another_user = User.new
+        end
+        it "should not skip validations upon saving" do
+          @another_user.should_receive(:do_after_save).once
+          @another_user.should_receive(:do_around_create).once
+          @another_user.should_receive(:do_before_validation).once
+          @another_user.save!
+        end
+      end
+    end
+    it "should through an error when attempting to skip an undefined callback" do
+      lambda { @user.skip_callback :save, :after, :method_that_doesnt_exist }.should raise_error CallbackSkipper::CallbackNotDefinedError
+    end
+  end
+end

data/spec/setup_database.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+    t.column :email, :string
+    t.column :password, :string
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'active_record'
+require 'pry'
+
+require 'callback_skipper'
+require 'setup_database'
+
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -1,64 +1,103 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: callback_skipper
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: 1.0.0
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
 platform: ruby
-authors: 
+authors:
 - Ryan Sonnek
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  requirement: *id001
-  prerelease: false
+date: 2012-08-29 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.0'
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 0
-        - 9
-        - 2
-        - 2
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
         version: 0.9.2.2
-  requirement: *id002
+  type: :development
   prerelease: false
-  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: programatically skip ActiveRecord callbacks
-email: 
+email:
 - ryan@codecrate.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rvmrc
 - CONTRIBUTORS.txt
@@ -69,38 +108,40 @@ files:
 - callback_skipper.gemspec
 - lib/callback_skipper.rb
 - lib/callback_skipper/version.rb
-homepage: ""
+- spec/lib/callback_skipper_spec.rb
+- spec/setup_database.rb
+- spec/spec_helper.rb
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 2424141270523251175
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: 2424141270523251175
 requirements: []
-
 rubyforge_project: callback_skipper
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Skip ActiveRecord callbacks
-test_files: []
-
+test_files:
+- spec/lib/callback_skipper_spec.rb
+- spec/setup_database.rb
+- spec/spec_helper.rb