sequel-attribute_callbacks 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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sequel-attribute_callbacks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rafał Rzepecki
+
+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,74 @@
+# Sequel::AttributeCallbacks
+
+This plugin for Sequel::Record allows to easily hook in callbacks watching 
+specific model attribute changes. The hooks are defined with conventionally 
+named instance methods for maximum DRYness.
+
+There's special support for callbacks involving array fields (as in Postgres 
+array types with :pg_array extension), so that they can be used similarly to 
+associations, with add and remove callbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sequel-attribute_callbacks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-attribute_callbacks
+
+## Synopsis
+
+```ruby
+# people table has (name text) column
+class Person < Sequel::Model
+  plugin :attribute_callbacks
+  
+  def before_name_change old, new_name
+    return true unless Dictionary.is_offensive? new_name
+  end
+  
+  def after_name_change old, new
+    NameChangeRecord.create self.id, old, new
+  end
+end
+```
+
+Special support for arrays (with pg_array plugin):
+
+```ruby
+# widgets table has (colors text[]) column
+class Widget < Sequel::Model
+  plugin :attribute_callbacks
+  
+  def before_colors_add color
+    return false unless Paint.color_vailable? color
+  end
+  
+  def after_colors_add color
+    Paint.order color
+  end
+  
+  def before_colors_remove color
+    # this is our company color, we need it!
+    return true unless color == 'fuchsia'
+  end
+  
+  def after_colors_remove color
+    Paint.reduce_consumption color
+  end
+end
+```
+
+## 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,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/sequel-attribute_callbacks.rb

@@ -0,0 +1,2 @@
+require "sequel-attribute_callbacks/version"
+require 'sequel/plugins/attribute_callbacks'

data/lib/sequel-attribute_callbacks/version.rb

@@ -0,0 +1,5 @@
+module Sequel
+  module AttributeCallbacks
+    VERSION = "0.0.1"
+  end
+end

data/lib/sequel/plugins/attribute_callbacks.rb

@@ -0,0 +1,93 @@
+require 'sequel'
+
+module Sequel::Plugins
+  module AttributeCallbacks
+    def self.apply model
+      model.plugin :dirty
+      
+      if defined? ::Sequel::Postgres::PGArray
+        require 'sequel/plugins/attribute_callbacks/pg_array_fixes'
+        model.include PgArrayFixes::AttributeCallbacks
+      end
+    end
+    
+    module InstanceMethods
+      def before_update
+        (column_changes || []).each do |column, change|
+          return false unless call_before_attribute_hook column, change
+        end
+        super
+      end
+      
+      def after_update
+        super
+        (previous_changes || []).each do |column, change|
+          call_after_attribute_hook column, change
+        end
+      end
+
+      def before_create
+        columns.each do |column|
+          value = send column
+          return false unless call_before_attribute_hook column, [nil, value] if value
+        end
+        super
+      end
+
+      def after_create
+        super
+        columns.each do |column|
+          value = send column
+          call_after_attribute_hook column, [nil, value] if value
+        end
+      end
+      
+      private
+      
+      def call_after_attribute_hook column, change
+        method = "after_#{column}_change".to_sym
+        send method, *change if respond_to? method
+        call_after_array_hooks column, *change if change.all?{|x| x.respond_to? :to_a}
+      end
+
+      def call_before_attribute_hook column, change
+        method = "before_#{column}_change".to_sym
+        
+        scalar = if respond_to? method
+          send method, *change
+        else
+          true
+        end
+        
+        return false unless scalar
+        
+        if change.all?{|x| x.respond_to? :to_a}
+          call_before_array_hooks column, *change
+        else
+          true
+        end
+      end
+      
+      def call_before_array_hooks column, before, after
+        add_hook = "before_#{column}_add".to_sym
+        rm_hook = "before_#{column}_remove".to_sym
+        before = before.to_a
+        after = after.to_a
+        
+        return false unless (after - before).all? {|x| send add_hook, x} if respond_to? add_hook
+        return false unless (before - after).all? {|x| send rm_hook, x} if respond_to? rm_hook
+        return true
+      end
+
+      def call_after_array_hooks column, before, after
+        add_hook = "after_#{column}_add".to_sym
+        rm_hook = "after_#{column}_remove".to_sym
+        before = before.to_a
+        after = after.to_a
+        
+        (after - before).each {|x| send add_hook, x} if respond_to? add_hook
+        (before - after).each {|x| send rm_hook, x} if respond_to? rm_hook
+      end
+    end
+  end
+end

data/lib/sequel/plugins/attribute_callbacks/pg_array_fixes.rb

@@ -0,0 +1,38 @@
+module Sequel::Plugins::AttributeCallbacks
+  module PgArrayFixes
+    module PgArray
+      # Delegator clone method doesn't clone the delegated to object
+      # which makes it impossible for the Dirty plugin track changes
+      def clone
+        c = super
+        c.__setobj__ __getobj__.clone
+        c
+      end
+    end
+    
+    module AttributeCallbacks
+      def after_initialize
+        super
+        clone_array_attributes
+      end
+      
+      def after_save
+        super
+        clone_array_attributes
+      end
+      
+      private
+      
+      # arrays are probably going to be often modified in place
+      def clone_array_attributes
+        values.each do |name, value|
+          if value.kind_of? Sequel::Postgres::PGArray
+            initial_values[name] = value.clone
+          end
+        end
+      end
+    end
+  end
+end
+
+Sequel::Postgres::PGArray.send :include, Sequel::Plugins::AttributeCallbacks::PgArrayFixes::PgArray if defined? Sequel::Postgres::PGArray

data/sequel-attribute_callbacks.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel-attribute_callbacks/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sequel-attribute_callbacks"
+  gem.version       = Sequel::AttributeCallbacks::VERSION
+  gem.authors       = ["Rafał Rzepecki"]
+  gem.email         = ["divided.mind@gmail.com"]
+  gem.description   = %q{Model plugin making it easy to define callbacks on modification of specific attributes in the database}
+  gem.summary       = %q{Attribute modification callbacks}
+  gem.homepage      = "https://github.com/dividedmind/sequel-attribute_callbacks"
+
+  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"]
+  
+  gem.add_runtime_dependency 'sequel', '~>3.44'
+  
+  gem.add_development_dependency 'rake', '~>10.0'
+  gem.add_development_dependency 'rspec', '~>2.12'
+  gem.add_development_dependency 'pg'
+end

data/spec/callbacks_spec.rb

@@ -0,0 +1,183 @@
+require 'spec_helper'
+
+describe 'attribute_callbacks plugin' do
+  include_context 'database'
+  
+  before :all do
+    db.create_table :widgets do
+      primary_key :id
+      String :name
+      column :colors, 'text[]'
+    end
+  end
+  
+  before do
+    db.execute "TRUNCATE TABLE widgets"
+    db.extension:pg_array
+  end
+  
+  let(:model) { Sequel::Model(:widgets) }
+  subject { model }
+  
+  before {
+    model.instance_eval {
+      plugin :attribute_callbacks
+    }
+  }
+  
+  it "doesn't interfere with record creation" do
+    model.create
+  end
+
+  describe 'after_<attribute>_change callbacks' do
+    it "are called when an instance is being modified" do
+      i = model.create
+      i.should_receive(:after_name_change).with(nil, 'foo')
+      i.name = 'foo'
+      i.save
+    end
+    
+    it "are called when an instance is being created" do
+      model.any_instance.should_receive(:after_name_change).with(nil, 'foo')
+      i = model.create name: "foo"
+    end
+
+    it "roll back the change if an exception is thrown" do
+      i = model.create name: "foo"
+      i.should_receive(:after_name_change).with("foo", "bar").and_raise Exception
+      i.name = 'bar'
+      expect { i.save }.to raise_error
+      
+      model.first.name.should == "foo"
+    end
+  end
+
+  describe 'before_<attribute>_change callbacks' do
+    it "are called when an instance is being modified" do
+      i = model.create
+      i.should_receive(:before_name_change).with(nil, 'foo').and_return true
+      i.name = 'foo'
+      i.save.should be
+      model.first.name.should == "foo"
+    end
+    
+    it "are called when an instance is being created" do
+      model.any_instance.should_receive(:before_name_change).with(nil, 'foo').and_return true
+      i = model.create name: "foo"
+    end
+
+    it "cancel the change if false is returned" do
+      i = model.create name: "foo"
+      i.should_receive(:before_name_change).with("foo", "bar").and_return false
+      i.name = 'bar'
+      expect { i.save }.to raise_error(Sequel::HookFailed)
+      
+      model.first.name.should == "foo"
+    end
+  end
+  
+  describe 'before_<attribute>_add callbacks' do
+    it "are called when an instance is being modified" do
+      i = model.create colors: ['red']
+      i.should_receive(:before_colors_add).with('blue').and_return true
+      i.colors += ['blue']
+      i.save.should be
+      model.first.colors.should == ['red', 'blue']
+    end
+    
+    it "work with in place modification" do
+      i = model.create colors: ['red']
+      i.should_receive(:before_colors_add).with('blue').and_return true
+      i.will_change_column :colors
+      i.colors << 'blue'
+      i.save.should be
+      model.first.colors.should == ['red', 'blue']
+    end
+    
+    it "work with in place modification without will_change_column" do
+      i = model.create colors: ['red']
+      i.should_receive(:before_colors_add).with('blue').and_return true
+      i.colors << 'blue'
+      i.save.should be
+      model.first.colors.should == ['red', 'blue']
+    end
+    
+    it "are called when an instance is being created" do
+      model.any_instance.should_receive(:before_colors_add).with('red').and_return true
+      model.any_instance.should_receive(:before_colors_add).with('blue').and_return true
+      i = model.create colors: ['red', 'blue']
+    end
+
+    it "cancel the change if false is returned" do
+      i = model.create colors: ['red']
+      i.should_receive(:before_colors_add).with('blue').and_return false
+      i.colors += ['blue']
+      expect { i.save }.to raise_error(Sequel::HookFailed)
+      
+      model.first.colors.should == ['red']
+    end
+  end
+  
+  describe 'before_<attribute>_remove callbacks' do
+    it "are called when an instance is being modified" do
+      i = model.create colors: ['red']
+      i.should_receive(:before_colors_remove).with('red').and_return true
+      i.colors -= ['red']
+      i.save.should be
+      model.first.colors.should == []
+    end
+    
+    it "cancel the change if false is returned" do
+      i = model.create colors: ['red']
+      i.should_receive(:before_colors_remove).with('red').and_return false
+      i.colors -= ['red']
+      expect { i.save }.to raise_error(Sequel::HookFailed)
+      
+      model.first.colors.should == ['red']
+    end
+  end
+
+  describe 'after_<attribute>_add callbacks' do
+    it "are called when an instance is being modified" do
+      i = model.create colors: ['red']
+      i.should_receive(:after_colors_add).with('blue')
+      i.colors << 'blue'
+      i.save.should be
+      model.first.colors.should == ['red', 'blue']
+    end
+
+    it "are called when an instance is being created" do
+      model.any_instance.should_receive(:after_colors_add).with('red')
+      model.any_instance.should_receive(:after_colors_add).with('blue')
+      i = model.create colors: ['red', 'blue']
+    end
+
+    it "cancel the change if an exception is thrown" do
+      i = model.create colors: ['red']
+      i.should_receive(:after_colors_add).with('blue').and_raise Exception
+      i.colors << 'blue'
+      expect { i.save }.to raise_error
+      
+      model.first.colors.should == ['red']
+    end
+  end
+  
+  describe 'after_<attribute>_remove callbacks' do
+    it "are called when an instance is being modified" do
+      i = model.create colors: ['red']
+      i.should_receive(:after_colors_remove).with('red')
+      i.colors -= ['red']
+      i.save.should be
+      model.first.colors.should == []
+    end
+    
+    it "cancel the change if an exception is thrown" do
+      i = model.create colors: ['red']
+      i.should_receive(:after_colors_remove).with('red').and_raise Exception
+      i.colors -= ['red']
+      expect { i.save }.to raise_error
+      
+      model.first.colors.should == ['red']
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'sequel-attribute_callbacks'
+
+shared_context 'database' do
+  let(:dburl) { ENV['TEST_DATABASE_URL'] || 'postgres:///sequel-attribute_callbacks_test' }
+  let(:db) { Sequel::connect dburl }
+  
+  let(:clean_database) {
+    db.execute """
+      DROP SCHEMA public CASCADE;
+      CREATE SCHEMA public;
+    """
+  }
+  
+  before(:all) { clean_database }
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: sequel-attribute_callbacks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rafał Rzepecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.44'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.44'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: Model plugin making it easy to define callbacks on modification of specific
+  attributes in the database
+email:
+- divided.mind@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel-attribute_callbacks.rb
+- lib/sequel-attribute_callbacks/version.rb
+- lib/sequel/plugins/attribute_callbacks.rb
+- lib/sequel/plugins/attribute_callbacks/pg_array_fixes.rb
+- sequel-attribute_callbacks.gemspec
+- spec/callbacks_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dividedmind/sequel-attribute_callbacks
+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: Attribute modification callbacks
+test_files:
+- spec/callbacks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: