event_hooks 0.0.2 → 0.1.0

data/README.md

@@ -1,8 +1,13 @@
 # EventHooks
 
-EventHooks enhances Ruby classes to allow adding pre-conditions to method calls (events).
+EventHooks enhances 
+* Ruby classes to allow adding pre-conditions to method calls (events).
+* ActiveRecord::Base subclasses to allow adding post-conditions to methods calls.
+
 If the pre-conditions method returns false the event method will not run. It can be used on ActiveRecord subclasses to validate some conditions only when a certain event occurs. 
 
+If the post-conditions method returns false the database operations triggered by the event will be rolled back. Again, it can be used to validate some conditions after a certain event occurs. 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,16 +33,28 @@ where:
 * event is the name of a method that you must define prior to the hook_before.
 * hook is the name of a method that will be run before the call to event. 
 
+or to hook a post-condition
+```ruby
+	hook_after :event, :hook
+```
+
+An example: 
+
 ```ruby
 class AnyClass
 	def submit
 	  # do something
 	end
 	hook_before :submit, :submit_preconditions
+	hook_after :submit, :submit_postconditions
 
   def submit_preconditions
 	  am_i_ready?
   end
+
+	def submit_postconditions
+		am_i_ready?
+	end
 end
 ```
 

data/event_hooks.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |gem|
   gem.homepage      = ""
 
 	gem.add_development_dependency "rspec", "~> 2.12.0"
+	gem.add_development_dependency "activerecord"
+	gem.add_development_dependency "sqlite3"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/event_hooks/event_hooks.rb

@@ -1,3 +1,5 @@
+require 'active_record'
+
 module EventHooks
 	def self.included(base) #:nodoc:
 		#base.extend EventHooks::ClassMethods
@@ -19,4 +21,30 @@ module EventHooks
 	end
 
 	Class.send(:include, EventHooks)
+
+	module ClassMethods
+		# make sure hook_after method must be injected in subclasses 
+		def inherited(klass)
+			klass.send(:extend, EventHooks::ClassMethods)
+		end
+
+		def hook_after(event, hook)
+			alias_method "#{event}_without_after_hook".to_sym, event
+
+			define_method "#{event}_with_after_hook".to_sym do |*args|
+				ActiveRecord::Base.transaction do
+					res = send("#{event}_without_after_hook".to_sym, *args)
+					unless send(hook)
+						raise ActiveRecord::Rollback, "After_hook #{hook} failed"
+						return false
+					end
+					res
+				end
+			end
+
+			alias_method event, "#{event}_with_after_hook".to_sym
+		end
+	end
+
+	ActiveRecord::Base.send(:extend, EventHooks::ClassMethods)
 end

data/lib/event_hooks/version.rb

@@ -1,3 +1,3 @@
 module EventHooks
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/database.yml

@@ -0,0 +1,3 @@
+sqlite3:
+  adapter: sqlite3
+  database: spec/hook.sqlite3.db

data/spec/event_hooks/event_hooks_spec.rb

@@ -1,5 +1,9 @@
+require 'active_record'
+require 'logger'
 require 'spec_helper'
 
+load_schema
+
 class StateMachine
 	attr_accessor :ready, :submitted
 
@@ -9,7 +13,6 @@ class StateMachine
 	end
 
 	def submit 
-		puts "SUBMIT NOW"
 		@submitted = true
 	end
 
@@ -21,48 +24,117 @@ class StateMachine
 end
 
 describe "any class" do
-	class Sub; end
+	class Bar; end
 
 	it "responds to hook_before" do
-		Sub.should respond_to(:hook_before)
+		Bar.should respond_to(:hook_before)
 	end
-end
 
-describe 'hook_before' do
-	let(:sm) { StateMachine.new }
+	describe 'hook_before' do
+		let(:sm) { StateMachine.new }
 
-	it "calls the hook before sending the event" do
-		sm.should_receive(:submission_preconditions)
-		sm.submit
-	end
-
-	context "when precondition is met (hook returns true)" do
-		it "allows the event to occur" do
-			sm.should_receive(:submit_without_before_hook).and_call_original
+		it "calls the hook before sending the event" do
+			sm.should_receive(:submission_preconditions)
 			sm.submit
-			sm.submitted.should be_true
+		end
+
+		context "when precondition is met (hook returns true)" do
+			it "allows the event to occur" do
+				sm.should_receive(:submit_without_before_hook).and_call_original
+				sm.submit
+				sm.submitted.should be_true
+			end
+		end
+
+		context "when precondition is not met (hook returns false)" do
+			let(:sm) { StateMachine.new(false) }
+
+			it "stops the event from happening" do
+				sm.should_receive(:submit_without_before_hook).never
+				sm.submit
+				sm.submitted.should be_false
+			end
+		end
+
+		context "when you try to add another before hook" do
+			class StateMachine
+				def another_hook
+				end
+			end
+
+			it "raises a DoubleHook exception" do
+				expect { StateMachine.send :hook_before, :submit, :another_hook }.
+					to raise_exception(EventHooks::DoubleHook)
+			end
 		end
 	end
+end
 
-	context "when precondition is not met (hook returns false)" do
-		let(:sm) { StateMachine.new(false) }
+describe "ActiveRecord::Base" do
+	it "responds to hook_after" do
+		ActiveRecord::Base.should respond_to(:hook_after)
+	end
+end
 
-		it "stops the event from happening" do
-			sm.should_receive(:submit_without_before_hook).never
-			sm.submit
-			sm.submitted.should be_false
+describe "any ActiveRecord::Base subclass" do
+	class Foo < ActiveRecord::Base
+		attr_accessor :ready
+
+		after_initialize do |object|
+			object.ready = true
 		end
+
+		def submit
+			save
+			"SUBMITTED"
+		end
+
+		def submission_postconditions
+			@ready
+		end
+
+		hook_after :submit, :submission_postconditions
+	end
+
+	it "responds to hook_after" do
+		Foo.should respond_to(:hook_after)
 	end
 
-	context "when you try to add another before hook" do
-		class StateMachine
-			def another_hook
+	describe "hook_after" do
+		let(:foo) { Foo.new }
+
+		it "calls the hook after sending the event" do
+			foo.should_receive(:submit_without_after_hook).ordered
+			foo.should_receive(:submission_postconditions).ordered
+			foo.submit
+		end
+
+		context "when postcondition is met (hook returns true)" do
+			it "returns the original return value of the event" do
+				foo.submit.should == "SUBMITTED"
+			end
+
+			context "when event involves database changes" do
+				it "changes the record" do
+					foo.submit
+					foo.should be_persisted
+				end
 			end
 		end
 
-		it "raises a DoubleHook exception" do
-			expect { StateMachine.send :hook_before, :submit, :another_hook }.
-				to raise_exception(EventHooks::DoubleHook)
+		context" when postcondition is not met (hook returns false)" do
+			before { foo.ready = false }
+
+			it "returns false" do
+				foo.submit.should be_false
+			end
+
+			context "when event involves database changes" do
+				it "does not change the foo record" do
+					foo.submit
+					foo.should_not be_persisted
+				end
+			end
 		end
 	end
 end

data/spec/schema.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Schema.define(:version => 0) do
+	create_table :foos, :force => true do |t|
+		t.string :name
+	end
+end

data/spec/spec_helper.rb

@@ -3,3 +3,10 @@ $LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib
 require 'event_hooks'
 
 require 'rspec'
+
+def load_schema
+	config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+	ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+	ActiveRecord::Base.establish_connection(config['sqlite3'])
+	load(File.dirname(__FILE__) + "/schema.rb")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_hooks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -27,6 +27,38 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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'
 description: Add hooks before or after events
 email:
 - pablo@pcr-webdesign.com
@@ -45,7 +77,10 @@ files:
 - lib/event_hooks/errors.rb
 - lib/event_hooks/event_hooks.rb
 - lib/event_hooks/version.rb
+- spec/database.yml
 - spec/event_hooks/event_hooks_spec.rb
+- spec/hook.sqlite3.db
+- spec/schema.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -72,5 +107,8 @@ signing_key:
 specification_version: 3
 summary: HookEvents allows you to add pre and post-conditions to events
 test_files:
+- spec/database.yml
 - spec/event_hooks/event_hooks_spec.rb
+- spec/hook.sqlite3.db
+- spec/schema.rb
 - spec/spec_helper.rb