sequel-attribute_callbacks 0.0.1 → 0.1.0

data/README.md

@@ -5,8 +5,8 @@ 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.
+array types with :pg_array extension) and hashes (HStore), so that they can 
+be used similarly to associations, with add and remove callbacks.
 
 ## Installation
 
@@ -39,7 +39,7 @@ class Person < Sequel::Model
 end
 ```
 
-Special support for arrays (with pg_array plugin):
+Special support for arrays (with pg_array extension):
 
 ```ruby
 # widgets table has (colors text[]) column
@@ -47,7 +47,7 @@ class Widget < Sequel::Model
   plugin :attribute_callbacks
   
   def before_colors_add color
-    return false unless Paint.color_vailable? color
+    return false unless Paint.color_available? color
   end
   
   def after_colors_add color
@@ -65,6 +65,32 @@ class Widget < Sequel::Model
 end
 ```
 
+Special support for hashes (with pg_hstore extension):
+
+```ruby
+# robots table has (parts hstore) column
+class Robot < Sequel::Model
+  plugin :attribute_callbacks
+  
+  def before_parts_add place, part
+    return false unless Part[part].fits_in? place
+  end
+  
+  def after_parts_add place, part
+    Part.order part
+  end
+  
+  def before_parts_remove place, part
+    # if you want a different skeleton go make a new robot
+    return true unless place == 'skeleton'
+  end
+  
+  def after_parts_remove place, part
+    Part.reduce_consumption part
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/sequel-attribute_callbacks/version.rb

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

data/lib/sequel/plugins/attribute_callbacks.rb

@@ -5,9 +5,9 @@ module Sequel::Plugins
     def self.apply model
       model.plugin :dirty
       
-      if defined? ::Sequel::Postgres::PGArray
-        require 'sequel/plugins/attribute_callbacks/pg_array_fixes'
-        model.include PgArrayFixes::AttributeCallbacks
+      if defined? ::Sequel::Postgres::PGArray || defined? ::Sequel::Postgres::HStore
+        require 'sequel/plugins/attribute_callbacks/rich_data_fixes'
+        model.plugin RichDataCloner
       end
     end
     
@@ -74,8 +74,8 @@ module Sequel::Plugins
         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 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
 
@@ -85,8 +85,8 @@ module Sequel::Plugins
         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
+        (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

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

@@ -0,0 +1,39 @@
+module Sequel::Plugins::AttributeCallbacks
+  module DelegatorDeepClone
+    # 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 RichDataCloner
+    module InstanceMethods
+      def after_initialize
+        super
+        clone_rich_attributes
+      end
+      
+      def after_save
+        super
+        clone_rich_attributes
+      end
+      
+      private
+      
+      # those are often going to be modified in place
+      def clone_rich_attributes
+        values.each do |name, value|
+          if value.kind_of?(Sequel::Postgres::PGArray) || value.kind_of?(Sequel::Postgres::HStore)
+            initial_values[name] = value.clone
+          end
+        end
+      end
+    end
+  end
+end
+
+Sequel::Postgres::PGArray.send :include, Sequel::Plugins::AttributeCallbacks::DelegatorDeepClone if defined? Sequel::Postgres::PGArray
+Sequel::Postgres::HStore.send :include, Sequel::Plugins::AttributeCallbacks::DelegatorDeepClone if defined? Sequel::Postgres::HStore

data/spec/callbacks_spec.rb

@@ -4,16 +4,19 @@ describe 'attribute_callbacks plugin' do
   include_context 'database'
   
   before :all do
+    db.execute "CREATE EXTENSION IF NOT EXISTS hstore"
     db.create_table :widgets do
       primary_key :id
       String :name
       column :colors, 'text[]'
+      column :store, :hstore
     end
   end
   
   before do
     db.execute "TRUNCATE TABLE widgets"
     db.extension:pg_array
+    db.extension:pg_hstore
   end
   
   let(:model) { Sequel::Model(:widgets) }
@@ -77,31 +80,60 @@ describe 'attribute_callbacks plugin' do
   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']
+    context "with an array" 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
     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']
+    context "with an hstore" do
+      it "are called when an instance is being modified" do
+        i = model.create store: {a: 5}
+        i.should_receive(:before_store_add).with('b', '6').and_return true
+        i.store = i.store.merge b: 6
+        i.save.should be
+        model.first.store.should == {'a' => '5', 'b' => '6'}
+      end
+      
+      it "work with in place modification" do
+        i = model.create store: {a: 5}
+        i.should_receive(:before_store_add).with('b', '6').and_return true
+        i.will_change_column :store
+        i.store[:b] = 6
+        i.save.should be
+        model.first.store.should == {'a' => '5', 'b' => '6'}
+      end
+      
+      it "work with in place modification without will_change_column" do
+        i = model.create store: {a: 5}
+        i.should_receive(:before_store_add).with('b', '6').and_return true
+        i.store[:b] = 6
+        i.save.should be
+        model.first.store.should == {'a' => '5', 'b' => '6'}
+      end
     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
@@ -119,6 +151,14 @@ describe 'attribute_callbacks plugin' do
   end
   
   describe 'before_<attribute>_remove callbacks' do
+    it "work with hstore" do
+      i = model.create store: {a: 5}
+      i.should_receive(:before_store_remove).with('a', '5').and_return true
+      i.store = {}
+      i.save.should be
+      model.first.store.should == {}
+    end
+
     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
@@ -138,6 +178,14 @@ describe 'attribute_callbacks plugin' do
   end
 
   describe 'after_<attribute>_add callbacks' do
+    it "work with hstore" do
+      i = model.create store: {a: 5}
+      i.should_receive(:after_store_add).with('b', '6').and_return true
+      i.store = i.store.merge b: 6
+      i.save.should be
+      model.first.store.should == {'a' => '5', 'b' => '6'}
+    end
+      
     it "are called when an instance is being modified" do
       i = model.create colors: ['red']
       i.should_receive(:after_colors_add).with('blue')
@@ -163,6 +211,14 @@ describe 'attribute_callbacks plugin' do
   end
   
   describe 'after_<attribute>_remove callbacks' do
+    it "work with hstore" do
+      i = model.create store: {a: 5}
+      i.should_receive(:after_store_remove).with('a', '5').and_return true
+      i.store = {}
+      i.save.should be
+      model.first.store.should == {}
+    end
+    
     it "are called when an instance is being modified" do
       i = model.create colors: ['red']
       i.should_receive(:after_colors_remove).with('red')
@@ -180,4 +236,13 @@ describe 'attribute_callbacks plugin' do
       model.first.colors.should == ['red']
     end
   end
+  
+  it "reports store changes as remove then add" do
+    i = model.create store: {a: 5}
+    i.should_receive(:before_store_remove).with('a', '5').and_return true
+    i.should_receive(:before_store_add).with('a', '6').and_return true
+    i.store[:a] = 6
+    i.save.should be
+    model.first.store.should == {'a' => '6'}
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-attribute_callbacks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -91,7 +91,7 @@ files:
 - 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
+- lib/sequel/plugins/attribute_callbacks/rich_data_fixes.rb
 - sequel-attribute_callbacks.gemspec
 - spec/callbacks_spec.rb
 - spec/spec_helper.rb

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

@@ -1,38 +0,0 @@
-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