event_hooks 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.2" > .rvmrc
+environment_id="ruby-1.9.3-p194@clip"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.14.3 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+if [[ -s Gemfile ]] && {
+  ! builtin command -v bundle >/dev/null ||
+  builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+}
+then
+  printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+  gem install bundler
+fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 pcrwebdesign
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# EventHooks
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'event_hooks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_hooks
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/event_hooks.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'event_hooks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "event_hooks"
+  gem.version       = EventHooks::VERSION
+  gem.authors       = ["Pablo Calderon"]
+  gem.email         = ["pablo@pcr-webdesign.com"]
+  gem.description   = %q{Add hooks before or after events}
+  gem.summary       = %q{HookEvents allows you to add pre and post-conditions to events}
+  gem.homepage      = ""
+
+	gem.add_development_dependency "rspec", "~> 2.12.0"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/event_hooks/errors.rb

@@ -0,0 +1,3 @@
+module EventHooks
+	class DoubleHook < StandardError; end
+end

data/lib/event_hooks/event_hooks.rb

@@ -0,0 +1,22 @@
+module EventHooks
+	def self.included(base) #:nodoc:
+		#base.extend EventHooks::ClassMethods
+		super
+	end
+
+	# prepend the hook to the event
+	# event won't run unless hook returns a true-ish value
+	def hook_before(event, hook)
+		raise EventHooks::DoubleHook.new if instance_methods.include?("#{event}_without_before_hook".to_sym)
+
+		alias_method "#{event}_without_before_hook".to_sym, event
+
+		define_method "#{event}_with_before_hook".to_sym do |*args|
+			send(hook) && send("#{event}_without_before_hook".to_sym, *args)
+		end
+
+		alias_method event, "#{event}_with_before_hook".to_sym
+	end
+
+	Class.send(:include, EventHooks)
+end

data/lib/event_hooks/version.rb

@@ -0,0 +1,3 @@
+module EventHooks
+  VERSION = "0.0.1"
+end

data/lib/event_hooks.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), 'event_hooks', 'version')
+require File.join(File.dirname(__FILE__), 'event_hooks', 'event_hooks')
+require File.join(File.dirname(__FILE__), 'event_hooks', 'errors')

data/spec/event_hooks/event_hooks_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+class StateMachine
+	attr_accessor :ready, :submitted
+
+	def initialize(ready=true)
+		@ready = ready
+		@submitted = false
+	end
+
+	def submit 
+		puts "SUBMIT NOW"
+		@submitted = true
+	end
+
+	def submission_preconditions
+		@ready
+	end
+
+	hook_before :submit, :submission_preconditions
+end
+
+describe "any class" do
+	class Sub; end
+
+	it "responds to hook_before" do
+		Sub.should respond_to(:hook_before)
+	end
+end
+
+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
+			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

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__)))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+require 'event_hooks'
+
+require 'rspec'

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: event_hooks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Pablo Calderon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Add hooks before or after events
+email:
+- pablo@pcr-webdesign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- event_hooks.gemspec
+- lib/event_hooks.rb
+- lib/event_hooks/errors.rb
+- lib/event_hooks/event_hooks.rb
+- lib/event_hooks/version.rb
+- spec/event_hooks/event_hooks_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: HookEvents allows you to add pre and post-conditions to events
+test_files:
+- spec/event_hooks/event_hooks_spec.rb
+- spec/spec_helper.rb