sequel_simple_callbacks 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+tmp
+*.gem

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Scott Tadman, The Working Group
+
+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.rdoc

@@ -0,0 +1,85 @@
+= sequel_simple_callbacks
+
+This adds ActiveRecord style callback declarations to standard Sequel models.
+
+Sequel::Model with no plugins:
+
+    class MyModel < Sequel::Model
+      def before_validation
+        check_something
+        check_something_else
+      end
+      
+      def before_save
+        return unless (some_condition?)
+        
+        do_something
+      end
+    end
+
+Sequel::Model with SequelSimpleCallbacks plugin added:
+    
+    Sequel::Model.plugin(SequelSimpleCallbacks)
+    
+    class MyModel < Sequel::Model
+      before_validation :check_something, :check_something_else
+      
+      before_save :do_something, :unless => :some_condition?
+    end
+    
+If any of the callbacks returns false then additional checking will be
+pre-empted and the callback will return false. This will halt processing
+of not only the chain, but the entire operation being performed, as is the
+expected behavior of Sequel::Model.
+
+Each of the callback methods takes zero or more method names to call as
+part of that callback cycle:
+
+    before_save :method_1, :method_2
+    
+The execution of these methods can be limited conditionally using the
+:if or :unless options either independently or in tandem:
+
+    before_save :method_1, :if => :working?, :unless => :on_break?
+
+The blocks referenced by :if and :unless should return true or false,
+but any value that evaluates as false for :if or true for :unless will
+block execution of these callbacks. Note that this does not halt the
+callback chain.
+
+These arguments can be combined as demonstrated here:
+
+    before_save :method_1, :method_2,
+      :if => :method,
+      :unless => lambda { other_method },
+      :on => :create do
+      check_something
+    end
+
+Any blocks given are evaluated within the context of the model in question,
+but the model may be explicitly specified as a parameter to the block:
+
+  before_save do |model|
+    model.check_something
+  end
+  
+It is important to node that using these class-level declarations means that
+the instance methods with the same name should not be defined:
+
+  before_save :do_something
+  
+  def before_save
+    # WARNING: This will block the :do_something method from running,
+    # as this method over-rides that behavior. Calling super will not
+    # restore this functionality.
+    
+    do_some_stuff
+    
+    # Execute the default behavior as defined in the class if this mixed
+    # approach is strictly required. This is intended as a last-resort.
+    self.class.run_callbacks(self, :before_save)
+  end
+
+== Copyright
+
+Copyright (c) 2010 Scott Tadman, The Working Group

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sequel_simple_callbacks"
+    gem.summary = %Q[Sequel Plugin to add ActiveRecord style callback declarations]
+    gem.description = %Q[This plugin makes it possible to declare simple before and after callbacks on the class level just like ActiveRecord]
+    gem.email = "github@tadman.ca"
+    gem.homepage = "http://github.com/tadman/sequel_simple_callbacks"
+    gem.authors = %w[ tadman ]
+
+    gem.add_development_dependency "sequel"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sequel_simple_callbacks #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/sequel_simple_callbacks.rb

@@ -0,0 +1,172 @@
+module SimpleSequelCallbacks
+  SPECIAL_HOOKS = [
+    :before_validation,
+    :after_validation
+  ].freeze
+
+  ADDITIONAL_HOOKS = [
+    :before_validation_on_create,
+    :before_validation_on_update,
+    :after_validation_on_create,
+    :after_validation_on_update
+  ].freeze
+  
+  STANDARD_HOOKS = (Sequel::Model::HOOKS - SPECIAL_HOOKS).freeze
+  INSTALLABLE_HOOKS = (Sequel::Model::HOOKS + ADDITIONAL_HOOKS).freeze
+  
+  def apply(model_class)
+  end
+  
+  def configure(model_class, *arguments, &block)
+  end
+  
+  module ClassMethods
+    # Add a callback hook to the model with parameters:
+    # * :if => One of [ Symbol, Proc ] (optional)
+    # * :unless => One of [ Symbol, Proc ] (optional)
+    # * :on => One of [ :create, :update ] (optional)
+    
+    def add_callback(chain, *args, &block)
+      @callbacks ||= { }
+      callbacks = @callbacks[chain] ||= [ ]
+
+      # Extract the options from the arguments by testing if the last
+      # is a Hash, otherwise default to an empty set.
+      options = (args[-1].is_a?(Hash)) ? args.pop : { }
+      option_on = options[:on]
+      option_if = options[:if]
+      option_unless = options[:unless]
+
+      callbacks << lambda do |model|
+        result = nil
+        
+        trigger =
+          case (option_on)
+          when :create
+            model.new?
+          when :update
+            !model.new?
+          when nil
+            true
+          else
+            false
+          end
+        
+        if (trigger and !option_if.nil?)
+          trigger =
+            case (option_if)
+            when Symbol, String
+              model.send(option_if)
+            when Proc
+              if (option_if.arity == 0)
+                model.instance_eval(option_if)
+              else
+                option_if.call(model)
+              end
+            else
+              option_if
+            end
+        end
+
+        if (trigger and !option_unless.nil?)
+          trigger =
+            case (option_unless)
+            when Symbol, String
+              !model.send(option_unless)
+            when Proc
+              if (option_unless.arity == 0)
+                !model.instance_eval(option_unless)
+              else
+                !option_unless.call(model)
+              end
+            else
+              !option_unless
+            end
+        end
+        
+        if (trigger)
+          args.each do |callback|
+            result =
+              case (callback)
+              when Symbol, String
+                model.send(callback)
+              else
+                if (callback.arity == 0)
+                  model.instance_eval(callback)
+                else
+                  callback.call(model)
+                end
+              end
+            
+            break if (result === false)
+          end
+        end
+        
+        if (trigger and block)
+          if (block.arity == 0)
+            model.instance_eval(&block)
+          else
+            block.call(model)
+          end
+        end
+        
+        result
+      end
+    end
+
+    def run_callbacks(model, hook)
+      return unless (@callbacks)
+      
+      callbacks = @callbacks[hook]
+      
+      return unless (callbacks)
+      
+      result = nil
+      
+      callbacks.each do |callback|
+        result = callback.call(model)
+        
+        break if (result === false)
+      end
+      
+      result
+    end
+
+    INSTALLABLE_HOOKS.each do |hook|
+      eval %Q[
+        def #{hook}(*args, &block)
+          add_callback(:#{hook}, *args, &block)
+        end
+      ]
+    end
+  end
+
+  module InstanceMethods
+    STANDARD_HOOKS.each do |hook|
+      define_method(hook) do
+        self.class.run_callbacks(self, hook)
+      end
+    end
+    
+    SPECIAL_HOOKS.each do |hook|
+      define_method(hook) do
+        self.class.run_callbacks(self, hook)
+      
+        if (new?)
+          self.class.run_callbacks(self, :"#{hook}_on_create")
+        else
+          self.class.run_callbacks(self, :"#{hook}_on_update")
+        end
+      end
+    end
+    
+    # This method is provided as a simple method to call arbitrary callback
+    # chains without having to run through the specific method
+    def run_callbacks(hook)
+      self.class.run_callbacks(self, hook)
+    end
+  end
+  
+  module DatasetMethods
+  end
+end

data/sequel_simple_callbacks.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sequel_simple_callbacks}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["tadman"]
+  s.date = %q{2010-08-25}
+  s.description = %q{This plugin makes it possible to declare simple before and after callbacks on the class level just like ActiveRecord}
+  s.email = %q{github@tadman.ca}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/sequel_simple_callbacks.rb",
+     "sequel_simple_callbacks.gemspec",
+     "test/helper.rb",
+     "test/models/conditional.rb",
+     "test/models/example.rb",
+     "test/models/model_triggers.rb",
+     "test/test_sequel_simple_callbacks.rb"
+  ]
+  s.homepage = %q{http://github.com/tadman/sequel_simple_callbacks}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Sequel Plugin to add ActiveRecord style callback declarations}
+  s.test_files = [
+    "test/helper.rb",
+     "test/models/conditional.rb",
+     "test/models/example.rb",
+     "test/models/model_triggers.rb",
+     "test/test_sequel_simple_callbacks.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<sequel>, [">= 0"])
+    else
+      s.add_dependency(%q<sequel>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<sequel>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'sequel'
+require 'sqlite3'
+
+require 'sequel_simple_callbacks'
+
+class Test::Unit::TestCase
+end

data/test/models/conditional.rb

@@ -0,0 +1,62 @@
+if (DB.table_exists?(:conditionals))
+  DB.drop_table(:conditionals)
+end
+
+DB.create_table(:conditionals) do
+  primary_key :id
+  string :name
+end  
+
+class ConditionalModel < Sequel::Model(:conditionals)
+  include ModelTriggers
+  plugin SimpleSequelCallbacks
+
+  before_validation do |model|
+    model.trigger(:before_validation_with_model)
+  end
+
+  before_validation do
+    trigger(:before_validation_without_model)
+  end
+
+  after_validation :on => :create do
+    trigger(:after_validation_only_on_create)
+  end
+
+  before_save :if => nil, :unless => nil do
+    trigger(:before_save_with_nil)
+  end
+
+  before_save :if => true, :unless => false do
+    trigger(:before_save_with_true_false)
+  end
+
+  after_update :on => :never do
+    trigger(:after_update_never_called)
+  end
+
+  after_save :if => false do
+    trigger(:after_save_not_called)
+  end
+  
+  after_update :returns_true, :returns_false, :returns_nil
+  
+  def never
+    false
+  end
+  
+  def returns_true
+    trigger(:returns_true)
+    true
+  end
+  
+  def returns_false
+    trigger(:returns_false)
+    false
+  end
+  
+  def returns_nil
+    trigger(:returns_nil)
+    nil
+  end
+end

data/test/models/example.rb

@@ -0,0 +1,26 @@
+if (DB.table_exists?(:examples))
+  DB.drop_table(:examples)
+end
+
+DB.create_table(:examples) do
+  primary_key :id
+  string :name
+end  
+
+class ExampleModel < Sequel::Model(:examples)
+  include ModelTriggers
+  
+  plugin SimpleSequelCallbacks
+
+  SimpleSequelCallbacks::INSTALLABLE_HOOKS.each do |hook|
+    send(hook, :"do_#{hook}", :if => :triggers_active?)
+    
+    define_method(:"do_#{hook}") do
+      trigger(hook)
+    end
+  end
+  
+  def triggers_active?
+    !name or name != 'off'
+  end
+end

data/test/models/model_triggers.rb

@@ -0,0 +1,18 @@
+module ModelTriggers
+  def clear_triggered!
+    @triggered = [ ]
+  end
+  
+  def trigger(type)
+    @triggered ||= [ ]
+    @triggered << type
+  end
+  
+  def triggered
+    @triggered ||= [ ]
+  end
+  
+  def triggered?(type)
+    @triggered and @triggered.include?(type)
+  end
+end

data/test/test_sequel_simple_callbacks.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+DB_DIRECTORY = File.expand_path(File.join(*%w[ .. tmp ]), File.dirname(__FILE__))
+
+unless (File.exist?(DB_DIRECTORY))
+  Dir.mkdir(DB_DIRECTORY)
+end
+
+DB = Sequel.sqlite(File.expand_path('test.sqlite3', DB_DIRECTORY))
+
+require 'models/model_triggers'
+require 'models/example'
+require 'models/conditional'
+
+class TestSequelSimpleCallbacks < Test::Unit::TestCase
+  def test_model_can_be_created
+    model = ExampleModel.new
+    
+    assert model.triggers_active?
+    
+    assert_equal [ :after_initialize ], model.triggered
+
+    model.save
+    
+    assert_equal [ :after_initialize, :before_validation, :before_validation_on_create, :after_validation, :after_validation_on_create, :before_save, :before_create, :after_create, :after_save ], model.triggered
+    
+    model.clear_triggered!
+    
+    assert_equal [ ], model.triggered
+    
+    assert model.id
+    
+    model.name = 'Test'
+    
+    model.save
+
+    assert_equal [ :before_validation, :before_validation_on_update, :after_validation, :after_validation_on_update, :before_save, :before_update, :after_update, :after_save ], model.triggered
+  end
+
+  def test_model_triggers_can_be_turned_off
+    model = ExampleModel.new(:name => 'off')
+    
+    assert !model.triggers_active?
+    
+    assert_equal [ ], model.triggered
+
+    model.save
+    
+    assert_equal [ ], model.triggered
+    
+    model.clear_triggered!
+    
+    assert_equal [ ], model.triggered
+    
+    assert model.id
+    
+    model.name = 'Test'
+    
+    model.save
+
+    assert_equal [ :before_validation, :before_validation_on_update, :after_validation, :after_validation_on_update, :before_save, :before_update, :after_update, :after_save ], model.triggered
+    
+    model = ExampleModel.find(:id => model.id)
+  end
+  
+  def test_model_conditional_triggers
+    model = ConditionalModel.new
+    
+    assert_equal [ ], model.triggered
+    
+    model.save
+    
+    assert !model.new?
+    
+    assert_equal [ :before_validation_with_model, :before_validation_without_model, :after_validation_only_on_create, :before_save_with_nil, :before_save_with_true_false ], model.triggered
+    
+    model.clear_triggered!
+
+    model.save
+    
+    assert_equal [ :before_validation_with_model, :before_validation_without_model, :before_save_with_nil, :before_save_with_true_false, :returns_true, :returns_false ], model.triggered
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: sequel_simple_callbacks
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- tadman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This plugin makes it possible to declare simple before and after callbacks on the class level just like ActiveRecord
+email: github@tadman.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sequel_simple_callbacks.rb
+- sequel_simple_callbacks.gemspec
+- test/helper.rb
+- test/models/conditional.rb
+- test/models/example.rb
+- test/models/model_triggers.rb
+- test/test_sequel_simple_callbacks.rb
+has_rdoc: true
+homepage: http://github.com/tadman/sequel_simple_callbacks
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Sequel Plugin to add ActiveRecord style callback declarations
+test_files: 
+- test/helper.rb
+- test/models/conditional.rb
+- test/models/example.rb
+- test/models/model_triggers.rb
+- test/test_sequel_simple_callbacks.rb