pg_triggers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19f1fcd14466ad95643f91d2dc62934b7b6eef63
-  data.tar.gz: eaaea66c3afaa575234c0fb2be06c3b3f265df0c
+  metadata.gz: 4c8e5d7162ea64f110cae96cb207f761a3a03f5f
+  data.tar.gz: 9a47381f9bba876a570abe52c81bb30e66d3182a
 SHA512:
-  metadata.gz: f25370dae7dfffba8e21b20c7072b979942c7542b12857166d8473b5307bbc108e897b5726560c22166962182e2d0720503467a86694f8e3c16be0df42ede480
-  data.tar.gz: 73b51af990c1a93f284ff1f1402378f5299e995ad39ae1452b7bbe22468b5cd772ac58f9fa4abe8fea9c6a232643ea4daaa7aa656fe85f6f09ae8c4d9e84ed74
+  metadata.gz: 6020076643bec765f6815d43fb0559120e8585f4cbc94dcaa23e86c641b835eea248e5112407168b2cbcc26168c32ec8fa6f4b9467c9395029e5f5257ce23f3f
+  data.tar.gz: 730068add4d00c160ce2fbc634a0c8e2b7ce93a57f8a67a3449fee746922cc220bb16a74c517058c982f6bc3eb2cedf2e89c48239c8db230a9f312d3baded8d6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.2.0 (2014-09-19)
+
+*   Add :value option to counter_cache to support incrementing/decrementing counters by a specific amount.
+
+*   Add updated_at trigger to track update times, while still allowing its values to be overridden for testing purposes.
+
 ### 0.1.0 (2014-08-25)
 
 *   Add audit_table trigger to track changes to a table.

data/lib/pg_triggers.rb

@@ -6,6 +6,7 @@ module PgTriggers
       where   = proc { |source| relationship.map{|k, v| "#{k} = #{source}.#{v}"}.join(' AND ') }
       columns = relationship.values
       changed = columns.map{|c| "((OLD.#{c} <> NEW.#{c}) OR (OLD.#{c} IS NULL <> NEW.#{c} IS NULL))"}.join(' OR ')
+      value   = (options[:value] || 1).to_i
 
       condition = proc do |source|
         a = []
@@ -15,39 +16,67 @@ module PgTriggers
       end
 
       <<-SQL
-        CREATE FUNCTION pg_triggers_counter_#{main_table}_#{counter_column}() RETURNS trigger
+        CREATE OR REPLACE FUNCTION pt_cc_#{main_table}_#{counter_column}() RETURNS trigger
           LANGUAGE plpgsql
           AS $$
             BEGIN
               IF (TG_OP = 'INSERT') THEN
                 IF (#{condition['NEW']}) THEN
-                  UPDATE #{main_table} SET #{counter_column} = #{counter_column} + 1 WHERE #{where['NEW']};
+                  UPDATE #{main_table} SET #{counter_column} = #{counter_column} + #{value} WHERE #{where['NEW']};
                 END IF;
                 RETURN NEW;
               ELSIF (TG_OP = 'UPDATE') THEN
                 IF (#{changed}) OR ((#{condition['OLD']}) <> (#{condition['NEW']})) THEN
                   IF (#{condition['OLD']}) THEN
-                    UPDATE #{main_table} SET #{counter_column} = #{counter_column} - 1 WHERE #{where['OLD']};
+                    UPDATE #{main_table} SET #{counter_column} = #{counter_column} - #{value} WHERE #{where['OLD']};
                   END IF;
                   IF (#{condition['NEW']}) THEN
-                    UPDATE #{main_table} SET #{counter_column} = #{counter_column} + 1 WHERE #{where['NEW']};
+                    UPDATE #{main_table} SET #{counter_column} = #{counter_column} + #{value} WHERE #{where['NEW']};
                   END IF;
-                ELSE
-
                 END IF;
                 RETURN NEW;
               ELSIF (TG_OP = 'DELETE') THEN
                 IF (#{condition['OLD']}) THEN
-                  UPDATE #{main_table} SET #{counter_column} = #{counter_column} - 1 WHERE #{where['OLD']};
+                  UPDATE #{main_table} SET #{counter_column} = #{counter_column} - #{value} WHERE #{where['OLD']};
                 END IF;
                 RETURN OLD;
               END IF;
             END;
           $$;
 
-        CREATE TRIGGER pg_triggers_counter_#{main_table}_#{counter_column}
+        DROP TRIGGER IF EXISTS pt_cc_#{main_table}_#{counter_column} ON #{counted_table};
+
+        CREATE TRIGGER pt_cc_#{main_table}_#{counter_column}
         AFTER INSERT OR UPDATE OR DELETE ON #{counted_table}
-        FOR EACH ROW EXECUTE PROCEDURE pg_triggers_counter_#{main_table}_#{counter_column}();
+        FOR EACH ROW EXECUTE PROCEDURE pt_cc_#{main_table}_#{counter_column}();
+      SQL
+    end
+
+    def updated_at(table, column)
+      <<-SQL
+        CREATE OR REPLACE FUNCTION pt_u_#{table}_#{column}() RETURNS trigger
+          LANGUAGE plpgsql
+          AS $$
+            BEGIN
+              IF (TG_OP = 'INSERT') THEN
+                IF NEW.updated_at IS NULL THEN
+                  NEW.updated_at := CURRENT_TIMESTAMP;
+                END IF;
+              ELSIF (TG_OP = 'UPDATE') THEN
+                IF NEW.updated_at = OLD.updated_at THEN
+                  NEW.updated_at := CURRENT_TIMESTAMP;
+                END IF;
+              END IF;
+
+              RETURN NEW;
+            END;
+          $$;
+
+        DROP TRIGGER IF EXISTS pt_u_#{table}_#{column} ON #{table};
+
+        CREATE TRIGGER pt_u_#{table}_#{column}
+        BEFORE INSERT OR UPDATE ON #{table}
+        FOR EACH ROW EXECUTE PROCEDURE pt_u_#{table}_#{column}();
       SQL
     end
 
@@ -67,7 +96,7 @@ module PgTriggers
       ignore = options[:ignore].map{|a| "'#{a}'"}.join(', ') if options[:ignore]
 
       <<-SQL
-        CREATE OR REPLACE FUNCTION pg_triggers_audit_#{table_name}() RETURNS TRIGGER
+        CREATE OR REPLACE FUNCTION pt_a_#{table_name}() RETURNS TRIGGER
         AS $body$
           DECLARE
             changed_keys text[];
@@ -100,11 +129,11 @@ module PgTriggers
         $body$
         LANGUAGE plpgsql;
 
-        DROP TRIGGER IF EXISTS pg_triggers_audit_#{table_name} ON #{table_name};
+        DROP TRIGGER IF EXISTS pt_a_#{table_name} ON #{table_name};
 
-        CREATE TRIGGER pg_triggers_audit_#{table_name}
+        CREATE TRIGGER pt_a_#{table_name}
         AFTER UPDATE OR DELETE ON #{table_name}
-        FOR EACH ROW EXECUTE PROCEDURE pg_triggers_audit_#{table_name}();
+        FOR EACH ROW EXECUTE PROCEDURE pt_a_#{table_name}();
       SQL
     end
   end

data/lib/pg_triggers/version.rb

@@ -1,3 +1,3 @@
 module PgTriggers
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/spec/counter_cache_spec.rb

@@ -181,4 +181,73 @@ describe PgTriggers, 'counter_cache' do
     DB[:counted_table].where(id: 1).update(value: 6).should == 1
     values.should == [2, 3, 2]
   end
+
+  it "should silently replace another counter cache trigger on the same set of columns" do
+    DB.create_table :counter_table do
+      integer :id, null: false
+
+      integer :condition_count,       null: false, default: 0
+    end
+
+    DB.create_table :counted_table do
+      integer :id, null: false
+      integer :counter_id, null: false
+
+      boolean :condition
+    end
+
+    def value
+      DB[:counter_table].where(id: 1).get(:condition_count)
+    end
+
+    DB.run PgTriggers.counter_cache :counter_table, :condition_count, :counted_table, {id: :counter_id}
+
+    DB[:counter_table].insert(id: 1)
+
+    DB[:counted_table].insert(id: 1, counter_id: 1, condition: true)
+    value.should == 1
+    DB[:counted_table].insert(id: 2, counter_id: 1, condition: false)
+    value.should == 2
+    DB[:counted_table].insert(id: 3, counter_id: 1, condition: true)
+    value.should == 3
+    DB[:counted_table].insert(id: 4, counter_id: 1, condition: false)
+    value.should == 4
+
+    DB.run PgTriggers.counter_cache :counter_table, :condition_count, :counted_table, {id: :counter_id}, where: "ROW.condition"
+
+    DB[:counted_table].insert(id: 5, counter_id: 1, condition: nil)
+    value.should == 4
+    DB[:counted_table].insert(id: 6, counter_id: 1, condition: false)
+    value.should == 4
+    DB[:counted_table].insert(id: 7, counter_id: 1, condition: true)
+    value.should == 5
+    DB[:counted_table].insert(id: 8, counter_id: 1, condition: nil)
+    value.should == 5
+  end
+
+  it "should support a custom value to increment and decrement the count by" do
+    DB.create_table :counter_table do
+      integer :id, null: false
+      integer :counted_count, null: false, default: 0
+    end
+
+    DB.create_table :counted_table do
+      integer :id, null: false
+      integer :counter_id, null: false
+    end
+
+    DB.run PgTriggers.counter_cache :counter_table, :counted_count, :counted_table, {id: :counter_id}, value: 5
+
+    DB[:counter_table].insert(id: 1)
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 0
+
+    DB[:counted_table].insert(id: 1, counter_id: 1)
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 5
+
+    DB[:counted_table].insert(id: 2, counter_id: 1)
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 10
+
+    DB[:counted_table].where(id: 1).delete.should == 1
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 5
+  end
 end

data/spec/updated_at_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe PgTriggers, 'updated_at' do
+  before do
+    DB.drop_table? :updated_at_table
+
+    DB.create_table :updated_at_table do
+      primary_key :id
+
+      integer :integer_column
+
+      timestamptz :updated_at
+    end
+
+    DB.run PgTriggers.updated_at :updated_at_table, :updated_at
+  end
+
+  it "should set the updated_at time to now() when the row is inserted" do
+    # The result of now() is the time the transaction began.
+    t = nil
+    DB.transaction do
+      t = DB.get{now{}}
+      DB[:updated_at_table].insert(integer_column: 1)
+      DB[:updated_at_table].get(:updated_at).should == t
+    end
+    DB[:updated_at_table].get(:updated_at).should == t
+  end
+
+  it "should set the updated_at time to now() when the row is updated" do
+    # The result of now() is the time the transaction began.
+    t = nil
+    id = DB[:updated_at_table].insert(integer_column: 1)
+    DB.transaction do
+      t = DB.get{now{}}
+      DB[:updated_at_table].update integer_column: 2
+      DB[:updated_at_table].get(:updated_at).should == t
+    end
+    DB[:updated_at_table].get(:updated_at).should == t
+  end
+
+  it "should set the updated_at time to now() when the row is updated, even if no values in the row change" do
+    # The result of now() is the time the transaction began.
+    DB[:updated_at_table].insert(integer_column: 1)
+    t = nil
+    DB.transaction do
+      t = DB.get{now{}}
+      DB[:updated_at_table].update integer_column: 1
+      DB[:updated_at_table].get(:updated_at).should == t
+    end
+    DB[:updated_at_table].get(:updated_at).should == t
+  end
+
+  it "on insert should not overwrite a time the column is specifically set to" do
+    # Handle loss of timestamp precision in DB roundtrip.
+    t = DB.get Sequel.cast(Time.now - 30, :timestamptz)
+
+    DB.transaction do
+      DB[:updated_at_table].insert integer_column: 1, updated_at: t
+      DB[:updated_at_table].get(:updated_at).should == t
+    end
+
+    DB[:updated_at_table].get(:updated_at).should == t
+  end
+
+  it "on update should not overwrite a time the column is specifically set to" do
+    id = DB[:updated_at_table].insert(integer_column: 1)
+    DB[:updated_at_table].get(:updated_at)
+
+    # Handle loss of timestamp precision in DB roundtrip.
+    t = DB.get Sequel.cast(Time.now - 30, :timestamptz)
+
+    DB.transaction do
+      DB[:updated_at_table].update integer_column: 1, updated_at: t
+      DB[:updated_at_table].get(:updated_at).should == t
+    end
+
+    DB[:updated_at_table].get(:updated_at).should == t
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_triggers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Hanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,6 +113,7 @@ files:
 - spec/audit_table_spec.rb
 - spec/counter_cache_spec.rb
 - spec/spec_helper.rb
+- spec/updated_at_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -141,3 +142,4 @@ test_files:
 - spec/audit_table_spec.rb
 - spec/counter_cache_spec.rb
 - spec/spec_helper.rb
+- spec/updated_at_spec.rb