sequel_postgresql_triggers 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0c46791ed8af6edc2e71f5e7964625fe66811eb76d7a99c085b5157336f2d43
-  data.tar.gz: 0d3cae20446b2f4d334746077959d8415cb815c9afcb4212a57c35ff2bc8ab88
+  metadata.gz: 2a985c677d8d3b87630378feee9b80dda40ef2ba95147ec525f2df8feff18b38
+  data.tar.gz: 8c6b9526bbedb13a72fd3edc44c2da56041fc985c0e41187613914bae9163230
 SHA512:
-  metadata.gz: 19e85c00deff747bd3d89bad0d3dfd5d64105cd9191d4a336e004f5a862b097734fa5fe81793ac5bb8f32c8b849f5d28e1c9ef0975f038679f66357689702408
-  data.tar.gz: 1a59b39455c23b6e41af7825de4e6a9c53ba0c394ddb48296e4636f31b5a34bb86f13524562edb104050791d47fa4ac39a7ec665234dcb110ced6bf5c862798f
+  metadata.gz: 39bd5f9c742aeed9331e59b521d571e5631c1b3dcd0804dd959e010a2a6c2bcd110ad8752eac92b1f9d0a768d0a9925f67cf59cdc5a34b718bc4e15e07ba996e
+  data.tar.gz: e5304e315766b8059adc6d29e48b6eb60af4ead1662a70d0eb5d7a87daa541a3b5068385a0b3a302bddaf23fd35f88637c6c3cf762b8308d5f2b5c27f9db682e

data/README.rdoc

@@ -126,7 +126,7 @@ sum cache that sums the length of a string column.
 
 Arguments:
 main_table :: name of table holding counter cache column
-main_table_id_column :: column in main table matching counted_table_id_column in counted_table
+main_table_id_column :: column in main table matching summed_table_id_column in summed_table
 sum_column :: column in main table containing the sum cache
 summed_table :: name of table being summed
 summed_table_id_column :: column in summed_table matching main_table_id_column in main_table
@@ -254,6 +254,18 @@ function :: The name of the trigger function to call to log changes
 Note that it is probably a bad idea to use the same table argument
 to both +pgt_json_audit_log_setup+ and +pgt_json_audit_log+.
 
+== Caveats
+
+If you have defined counter or sum cache triggers using this library
+before version 1.6.0, you should drop them and regenerate them if
+you want the triggers to work correctly with queries that use
+<tt>INSERT ... ON CONFLICT DO NOTHING</tt>.
+
+When restoring a data-only migration with +pg_dump+, you may need to
+use <tt>--disable-triggers</tt> for it to restore correctly, and you
+will need to manually enforce data integrity if you are doing
+partial restores and not full restores.
+
 == License
 
 This library is released under the MIT License.  See the MIT-LICENSE

data/lib/sequel/extensions/pg_triggers.rb

@@ -14,7 +14,7 @@ module Sequel
         main_column = quote_identifier(main_table_id_column)
         count_column = quote_identifier(counter_column)
 
-        pgt_trigger(counted_table, trigger_name, function_name, [:insert, :update, :delete], <<-SQL)
+        pgt_trigger(counted_table, trigger_name, function_name, [:insert, :update, :delete], <<-SQL, :after=>true)
         BEGIN
           IF (TG_OP = 'UPDATE' AND (NEW.#{id_column} = OLD.#{id_column} OR (OLD.#{id_column} IS NULL AND NEW.#{id_column} IS NULL))) THEN
             RETURN NEW;
@@ -122,7 +122,7 @@ module Sequel
         main_column = quote_identifier(main_table_id_column)
         sum_column = quote_identifier(sum_column)
 
-        pgt_trigger(summed_table, trigger_name, function_name, [:insert, :delete, :update], <<-SQL)
+        pgt_trigger(summed_table, trigger_name, function_name, [:insert, :delete, :update], <<-SQL, :after=>true)
         BEGIN
           IF (TG_OP = 'UPDATE' AND NEW.#{id_column} = OLD.#{id_column}) THEN
             UPDATE #{table} SET #{sum_column} = #{sum_column} + #{new_table_summed_column} - #{old_table_summed_column} WHERE #{main_column} = NEW.#{id_column};
@@ -176,7 +176,7 @@ module Sequel
         main_table_fk_column = quote_schema_table(main_table_fk_column)
         summed_table_fk_column = quote_schema_table(summed_table_fk_column)
 
-        pgt_trigger(orig_summed_table, trigger_name, function_name, [:insert, :delete, :update], <<-SQL)
+        pgt_trigger(orig_summed_table, trigger_name, function_name, [:insert, :delete, :update], <<-SQL, :after=>true)
         BEGIN
           IF (TG_OP = 'UPDATE' AND NEW.#{summed_table_id_column} = OLD.#{summed_table_id_column}) THEN
             UPDATE #{main_table} SET #{sum_column} = #{sum_column} + #{new_table_summed_column} - #{old_table_summed_column} WHERE #{main_table_id_column} IN (SELECT #{main_table_fk_column} FROM #{join_table} WHERE #{summed_table_fk_column} = NEW.#{summed_table_id_column});
@@ -195,7 +195,7 @@ module Sequel
         END;
         SQL
 
-        pgt_trigger(orig_join_table, join_trigger_name, join_function_name, [:insert, :delete, :update], <<-SQL)
+        pgt_trigger(orig_join_table, join_trigger_name, join_function_name, [:insert, :delete, :update], <<-SQL, :after=>true)
         BEGIN
           IF (NOT (TG_OP = 'UPDATE' AND NEW.#{main_table_fk_column} = OLD.#{main_table_fk_column} AND NEW.#{summed_table_fk_column} = OLD.#{summed_table_fk_column})) THEN
             IF (TG_OP = 'INSERT' OR TG_OP = 'UPDATE') THEN

data/spec/sequel_postgresql_triggers_spec.rb

@@ -1,10 +1,21 @@
 #!/usr/bin/env ruby
-require 'rubygems'
 require 'sequel'
 
+if coverage = ENV.delete('COVERAGE')
+  require 'simplecov'
+
+  SimpleCov.start do
+    enable_coverage :branch
+    command_name coverage
+    add_filter "/spec/"
+    add_group('Missing'){|src| src.covered_percent < 100}
+    add_group('Covered'){|src| src.covered_percent == 100}
+  end
+end
+
 ENV['MT_NO_PLUGINS'] = '1' # Work around stupid autoloading of plugins
 gem 'minitest'
-require 'minitest/autorun'
+require 'minitest/global_expectations/autorun'
 
 DB = Sequel.connect(ENV['PGT_SPEC_DB']||'postgres:///spgt_test?user=postgres')
 
@@ -32,6 +43,14 @@ describe "PostgreSQL Counter Cache Trigger" do
     DB.drop_function(:spgt_counter_cache)
   end
 
+  it "should not modify counter cache if adding/removing records fails due to ON CONFLICT DO NOTHING" do
+    DB.alter_table(:entries){add_unique_constraint :account_id}
+    DB[:entries].insert(:id=>1, :account_id=>1)
+    DB[:accounts].order(:id).select_map(:num_entries).must_equal [1, 0]
+    DB[:entries].insert_conflict.insert(:id=>1, :account_id=>1)
+    DB[:accounts].order(:id).select_map(:num_entries).must_equal [1, 0]
+  end
+
   it "should modify counter cache when adding or removing records" do
     DB[:accounts].order(:id).select_map(:num_entries).must_equal [0, 0]
 
@@ -129,6 +148,23 @@ describe "PostgreSQL Immutable Trigger" do
   end
 end
 
+describe "PostgreSQL Immutable Trigger" do
+  before do
+    DB.create_table(:accounts){integer :id; integer :balance, :default=>0}
+    DB.pgt_immutable(:accounts, :balance)
+    DB[:accounts].insert(:id=>1)
+  end
+
+  after do
+    DB.drop_table(:accounts)
+    DB.drop_function(:pgt_im_balance)
+  end
+
+  it "should work when called without options" do
+    DB[:accounts].update(:id=>2)
+  end
+end
+
 describe "PostgreSQL Sum Cache Trigger" do
   before do
     DB.create_table(:accounts){integer :id; integer :balance, :default=>0}
@@ -143,6 +179,14 @@ describe "PostgreSQL Sum Cache Trigger" do
     DB.drop_function(:spgt_sum_cache)
   end
 
+  it "should not modify sum cache if adding/removing records fails due to ON CONFLICT DO NOTHING" do
+    DB.alter_table(:entries){add_unique_constraint :account_id}
+    DB[:entries].insert(:id=>1, :account_id=>1, :amount=>5)
+    DB[:accounts].order(:id).select_map(:balance).must_equal [5, 0]
+    DB[:entries].insert_conflict.insert(:id=>1, :account_id=>1, :amount=>10)
+    DB[:accounts].order(:id).select_map(:balance).must_equal [5, 0]
+  end
+
   it "should modify sum cache when adding, updating, or removing records" do
     DB[:accounts].order(:id).select_map(:balance).must_equal [0, 0]
 
@@ -266,6 +310,17 @@ describe "PostgreSQL Sum Through Many Cache Trigger" do
     DB.drop_function(:spgt_stm_cache_join)
   end
 
+  it "should not modify sum cache if adding/removing records fails due to ON CONFLICT DO NOTHING" do
+    DB.alter_table(:children){add_unique_constraint :amount}
+    DB[:children].insert(:id=>1, :amount=>5)
+    DB[:links].insert(:parent_id=>1, :child_id=>1)
+    DB[:parents].order(:id).select_map(:balance).must_equal [5, 0]
+    DB[:children].insert_conflict.insert(:id=>1, :amount=>5)
+    DB[:parents].order(:id).select_map(:balance).must_equal [5, 0]
+    DB[:links].insert_conflict.insert(:parent_id=>1, :child_id=>1)
+    DB[:parents].order(:id).select_map(:balance).must_equal [5, 0]
+  end
+
   it "should modify sum cache when adding, updating, or removing records" do
     DB[:parents].order(:id).select_map(:balance).must_equal [0, 0]
 
@@ -461,6 +516,17 @@ describe "PostgreSQL Touch Trigger" do
     DB.drop_function(:spgt_touch2) if @spgt_touch2
   end
 
+  it "should not modify timestamp column of related table if adding/removing records fails due to ON CONFLICT DO NOTHING" do
+    DB.pgt_touch(:children, :parents, :changed_on, {:id1=>:parent_id1}, :function_name=>:spgt_touch)
+    DB.alter_table(:children){add_unique_constraint :parent_id1}
+    d30 = Date.today - 30
+    DB[:children].insert(:id=>1, :parent_id1=>1)
+    DB[:parents].insert(:id1=>1, :changed_on=>d30)
+    DB[:parents].get(:changed_on).to_date.must_equal d30
+    DB[:children].insert_conflict.insert(:id=>1, :parent_id1=>1)
+    DB[:parents].get(:changed_on).to_date.must_equal d30
+  end
+
   it "should update the timestamp column of the related table when adding, updating or removing records" do
     DB.pgt_touch(:children, :parents, :changed_on, {:id1=>:parent_id1}, :function_name=>:spgt_touch)
     d = Date.today
@@ -624,13 +690,13 @@ describe "PostgreSQL JSON Audit Logging" do
     DB.drop_function(:spgt_audit_log)
   end
 
-  it "should previous values in JSON format for inserts and updates" do
+  it "should store previous values in JSON format in audit table for updates and deletes on main table" do
     @logs.first.must_be_nil
 
     @ds.update(:id=>2, :a=>3)
     @ds.all.must_equal [{:id=>2, :a=>3}]
     h = @logs.first
-    h.delete(:at).to_i.must_be_within_delta(10, DB.get(Sequel::CURRENT_TIMESTAMP).to_i)
+    h.delete(:at).to_i.must_be_close_to(10, DB.get(Sequel::CURRENT_TIMESTAMP).to_i)
     h.delete(:user).must_be_kind_of(String)
     txid1 = h.delete(:txid)
     txid1.must_be_kind_of(Integer)
@@ -639,7 +705,7 @@ describe "PostgreSQL JSON Audit Logging" do
     @ds.delete
     @ds.all.must_equal []
     h = @logs.first
-    h.delete(:at).to_i.must_be_within_delta(10, DB.get(Sequel::CURRENT_TIMESTAMP).to_i)
+    h.delete(:at).to_i.must_be_close_to(10, DB.get(Sequel::CURRENT_TIMESTAMP).to_i)
     h.delete(:user).must_be_kind_of(String)
     txid2 = h.delete(:txid)
     txid2.must_be_kind_of(Integer)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel_postgresql_triggers
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-16 00:00:00.000000000 Z
+date: 2024-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -24,7 +24,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: minitest-global_expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
 email: code@jeremyevans.net
 executables: []
 extensions: []
@@ -39,7 +67,7 @@ homepage: https://github.com/jeremyevans/sequel_postgresql_triggers
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--inline-source"
 - "--line-numbers"
@@ -62,9 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Database enforced timestamps, immutable columns, counter/sum caches, and
   touch propogation