pg_triggers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fd69d976d7bfa873479a91959a658a6759d5865
+  data.tar.gz: a680642cbb7969e151ad170fccbb82d63c95f5e4
+SHA512:
+  metadata.gz: 2545b586d2434cca289761fbe9e3cb0011a7fd1069cb7ddeacd7ac36f682b51107eb2bb54b2d88cc77db5a217f5e0170d0958379c05f10b9901b0a341bdf2dbf
+  data.tar.gz: 14749fe98fbe669e2326801d0a27bf36714ec5f62709d9f879f9e611ad44bb7d6bff1764e8fe13f6844d9c0893772bfd0ec153323cf445ebfd0d7e9fa49523cf

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 (2014-08-21)
+
+*   Initial release.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Hanks
+
+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,29 @@
+# PgTriggers
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pg_triggers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pg_triggers
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pg_triggers/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/pg_triggers.rb

@@ -0,0 +1,52 @@
+require "pg_triggers/version"
+
+module PgTriggers
+  class << self
+    def counter_cache(main_table, counter_column, counted_table, relationship, options = {})
+      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 ')
+
+      condition = proc do |source|
+        a = []
+        a << columns.map{|c| "#{source}.#{c} IS NOT NULL"}.join(' AND ')
+        a << options[:where].gsub('ROW.', "#{source}.") if options[:where]
+        a.join(' AND ')
+      end
+
+      <<-SQL
+        CREATE FUNCTION pg_triggers_counter_#{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']};
+                END IF;
+                RETURN NEW;
+              ELSIF (TG_OP = 'UPDATE') THEN
+                IF (#{changed}) THEN
+                  IF (#{condition['OLD']}) THEN
+                    UPDATE #{main_table} SET #{counter_column} = #{counter_column} - 1 WHERE #{where['OLD']};
+                  END IF;
+                  IF (#{condition['NEW']}) THEN
+                    UPDATE #{main_table} SET #{counter_column} = #{counter_column} + 1 WHERE #{where['NEW']};
+                  END IF;
+                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']};
+                END IF;
+                RETURN OLD;
+              END IF;
+            END;
+          $$;
+
+        CREATE TRIGGER pg_triggers_counter_#{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}();
+      SQL
+    end
+  end
+end

data/lib/pg_triggers/version.rb

@@ -0,0 +1,3 @@
+module PgTriggers
+  VERSION = "0.0.1"
+end

data/pg_triggers.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pg_triggers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pg_triggers"
+  spec.version       = PgTriggers::VERSION
+  spec.authors       = ["Chris Hanks"]
+  spec.email         = ["christopher.m.hanks@gmail.com"]
+  spec.summary       = %q{Helpers for Postgres Triggers}
+  spec.description   = %q{Handy helpers to create PostgreSQL Triggers}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sequel"
+  spec.add_development_dependency "pg"
+end

data/spec/counter_cache_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+describe PgTriggers, 'counter_cache' do
+  before do
+    DB.drop_table?(:counter_table)
+    DB.drop_table?(:counted_table)
+  end
+
+  it "should increment and decrement the count of related items in the associated table as rows are inserted and updated and deleted" 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}
+
+    DB[:counter_table].insert(id: 1)
+    DB[:counter_table].insert(id: 2)
+    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 == 1
+
+    DB[:counted_table].insert(id: 2, counter_id: 1)
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 2
+
+    DB[:counted_table].insert(id: 3, counter_id: 2)
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 2
+    DB[:counter_table].where(id: 2).get(:counted_count).should == 1
+
+    DB[:counted_table].insert(id: 4, counter_id: 1)
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 3
+
+    DB[:counted_table].where(id: 4).update(counter_id: 2).should == 1
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 2
+    DB[:counter_table].where(id: 2).get(:counted_count).should == 2
+
+    DB[:counted_table].where(counter_id: 1).delete.should == 2
+    DB[:counter_table].where(id: 1).get(:counted_count).should == 0
+  end
+
+  it "should work when the tables are related by multiple columns" do
+    DB.create_table :counter_table do
+      integer :id1, null: false
+      integer :id2, null: false
+      integer :counted_count, null: false, default: 0
+    end
+
+    DB.create_table :counted_table do
+      integer :id, null: false
+      integer :counter_id1, null: false
+      integer :counter_id2, null: false
+    end
+
+    DB.run PgTriggers.counter_cache :counter_table, :counted_count, :counted_table, {id1: :counter_id1, id2: :counter_id2}
+
+    DB[:counter_table].insert(id1: 1, id2: 1)
+    DB[:counter_table].insert(id1: 2, id2: 1)
+    DB[:counter_table].where(id1: 1).get(:counted_count).should == 0
+
+    DB[:counted_table].insert(id: 1, counter_id1: 1, counter_id2: 1)
+    DB[:counter_table].where(id1: 1).get(:counted_count).should == 1
+
+    DB[:counted_table].insert(id: 2, counter_id1: 1, counter_id2: 1)
+    DB[:counter_table].where(id1: 1).get(:counted_count).should == 2
+
+    DB[:counted_table].insert(id: 3, counter_id1: 2, counter_id2: 1)
+    DB[:counter_table].where(id1: 1).get(:counted_count).should == 2
+    DB[:counter_table].where(id1: 2).get(:counted_count).should == 1
+
+    DB[:counted_table].insert(id: 4, counter_id1: 1, counter_id2: 1)
+    DB[:counter_table].where(id1: 1).get(:counted_count).should == 3
+
+    DB[:counted_table].where(id: 4).update(counter_id1: 2).should == 1
+    DB[:counter_table].where(id1: 1).get(:counted_count).should == 2
+    DB[:counter_table].where(id1: 2).get(:counted_count).should == 2
+
+    DB[:counted_table].where(counter_id1: 1).delete.should == 2
+    DB[:counter_table].where(id1: 1).get(:counted_count).should == 0
+  end
+
+  it "should work as expected when any of the columns are set to null or an unknown value" do
+    DB.create_table :counter_table do
+      integer :id1, null: false
+      integer :id2, null: false
+      integer :counted1_count, null: false, default: 0
+      integer :counted2_count, null: false, default: 0
+    end
+
+    DB.create_table :counted_table do
+      integer :id, null: false
+      integer :counter_id1
+      integer :counter_id2
+    end
+
+    DB.run PgTriggers.counter_cache :counter_table, :counted1_count, :counted_table, {id1: :counter_id1}
+    DB.run PgTriggers.counter_cache :counter_table, :counted2_count, :counted_table, {id1: :counter_id1, id2: :counter_id2}
+
+    DB[:counter_table].insert(id1: 1, id2: 1)
+    DB[:counted_table].insert(id: 1, counter_id1: 1, counter_id2: 1)
+    DB[:counted_table].insert(id: 2, counter_id1: 1, counter_id2: 1)
+    DB[:counted_table].insert(id: 3, counter_id1: 1, counter_id2: 1)
+    DB[:counted_table].insert(id: 4, counter_id1: 1, counter_id2: 1)
+    DB[:counter_table].where(id1: 1, id2: 1).get([:counted1_count, :counted2_count]).should == [4, 4]
+
+    DB[:counted_table].where(id: 1).update(counter_id1: nil).should == 1
+    DB[:counter_table].where(id1: 1, id2: 1).get([:counted1_count, :counted2_count]).should == [3, 3]
+
+    DB[:counted_table].where(id: 2).update(counter_id2: nil).should == 1
+    DB[:counter_table].where(id1: 1, id2: 1).get([:counted1_count, :counted2_count]).should == [3, 2]
+
+    DB[:counted_table].where(id: 3).update(counter_id1: 90000000).should == 1
+    DB[:counter_table].where(id1: 1, id2: 1).get([:counted1_count, :counted2_count]).should == [2, 1]
+
+    DB[:counted_table].where(id: 4).update(counter_id2: 90000000).should == 1
+    DB[:counter_table].where(id1: 1, id2: 1).get([:counted1_count, :counted2_count]).should == [2, 0]
+
+    DB[:counted_table].insert(id: 5, counter_id1: 1, counter_id2: nil)
+    DB[:counter_table].where(id1: 1, id2: 1).get([:counted1_count, :counted2_count]).should == [3, 0]
+
+    DB[:counted_table].insert(id: 6, counter_id1: nil, counter_id2: nil)
+    DB[:counter_table].where(id1: 1, id2: 1).get([:counted1_count, :counted2_count]).should == [3, 0]
+  end
+
+  it "should accept a :where clause to filter the rows that are counted" do
+    DB.create_table :counter_table do
+      integer :id, null: false
+
+      integer :condition_count,       null: false, default: 0
+      integer :value_count,           null: false, default: 0
+      integer :condition_value_count, null: false, default: 0
+    end
+
+    DB.create_table :counted_table do
+      integer :id, null: false
+      integer :counter_id, null: false
+
+      boolean :condition
+      integer :value
+    end
+
+    DB.run PgTriggers.counter_cache :counter_table, :condition_count,       :counted_table, {id: :counter_id}, where: "ROW.condition"
+    DB.run PgTriggers.counter_cache :counter_table, :value_count,           :counted_table, {id: :counter_id}, where: "ROW.value > 5"
+    DB.run PgTriggers.counter_cache :counter_table, :condition_value_count, :counted_table, {id: :counter_id}, where: "ROW.condition AND ROW.value > 5"
+
+    def values
+      DB[:counter_table].where(id: 1).get([:condition_count, :value_count, :condition_value_count])
+    end
+
+    DB[:counter_table].insert(id: 1)
+
+    values.should == [0, 0, 0]
+    DB[:counted_table].insert(id: 1, counter_id: 1, condition: true,  value: 4)
+    values.should == [1, 0, 0]
+    DB[:counted_table].insert(id: 2, counter_id: 1, condition: false, value: 4)
+    values.should == [1, 0, 0]
+    DB[:counted_table].insert(id: 3, counter_id: 1, condition: true,  value: 6)
+    values.should == [2, 1, 1]
+    DB[:counted_table].insert(id: 4, counter_id: 1, condition: false, value: 6)
+    values.should == [2, 2, 1]
+    DB[:counted_table].insert(id: 5, counter_id: 1, condition: nil,   value: 4)
+    values.should == [2, 2, 1]
+    DB[:counted_table].insert(id: 6, counter_id: 1, condition: false, value: nil)
+    values.should == [2, 2, 1]
+    DB[:counted_table].insert(id: 7, counter_id: 1, condition: true,  value: nil)
+    values.should == [3, 2, 1]
+    DB[:counted_table].insert(id: 8, counter_id: 1, condition: nil,   value: 6)
+    values.should == [3, 3, 1]
+
+    DB[:counted_table].where(id: 3).update(counter_id: 2).should == 1
+    values.should == [2, 2, 0]
+    DB[:counted_table].where(id: [4, 7]).delete.should == 2
+    values.should == [1, 1, 0]
+    DB[:counted_table].where(id: 3).update(counter_id: 1).should == 1
+    values.should == [2, 2, 1]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'sequel'
+require 'pg_triggers'
+
+url = ENV['PG_TRIGGERS_URL'] || 'postgres:///pg_triggers'
+
+DB = Sequel.connect(url)
+
+RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = [:expect, :should] }
+
+  config.around do |example|
+    DB.transaction(rollback: :always, auto_savepoint: true) { example.run }
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: pg_triggers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Hanks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: Handy helpers to create PostgreSQL Triggers
+email:
+- christopher.m.hanks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pg_triggers.rb
+- lib/pg_triggers/version.rb
+- pg_triggers.gemspec
+- spec/counter_cache_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Helpers for Postgres Triggers
+test_files:
+- spec/counter_cache_spec.rb
+- spec/spec_helper.rb