pg_morph 0.3.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cef0e13fb0248806b82ff74afe1306cf9fa80260
+  data.tar.gz: 617f2272d8aa391e06daca0ada34805c64d447d7
+SHA512:
+  metadata.gz: 15155e9dbf5d53573b9eee074d94090a7489a3b3603a81bca75928554cb8908884013eebf403049ca69e1bfac9b886753ae90aaecfb00725b08aaed732b94551
+  data.tar.gz: 4837b92da2446cdd827cc31c83f65c17b340c6ef83beb04591b589948b1276d78c1f9a94aad5a22c3b88593fddbb583b12d06c62b874922ba1fefc3f419298e3

data/.gitignore

@@ -1,4 +1,5 @@
 spec/dummy/log
 spec/dummy/config/*.yml
 tags
+/coverage/
 *.gem

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.1
+before_script:
+  - psql -c 'create database pg_morph_test;' -U postgres
+script:
+  - bundle exec rake db:migrate RAILS_ENV=test
+  - CODECLIMATE_REPO_TOKEN=60392238805181ab599e01b29566617c47bffed0083cbfd119aa3c230f9d611d bundle exec rake
+addons:
+  postgresql: 9.3
+notifications:
+  email:
+    - hanka@lunarlogic.io

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### v1.0.0
+
+This version adds additional layer on top of all tables and partitions, which is table view. Thanks to that there is no need for any after insert triggers and ActiveRecord don't have any problems with missing id after creating a new record.
+
+This version is not compatible with previous one.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pg_morph (0.1.0)
+    pg_morph (1.0.0)
       activerecord (~> 3)
 
 GEM
@@ -37,13 +37,34 @@ GEM
     arel (3.0.3)
     awesome_print (1.2.0)
     builder (3.0.4)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    codeclimate-test-reporter (0.4.6)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
     erubis (2.7.0)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.4)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.0)
+      guard (>= 2.1.1)
+      rspec (>= 2.14, < 4.0)
     hike (1.2.3)
     i18n (0.6.11)
     journey (1.0.4)
     json (1.8.1)
+    listen (2.3.1)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
     mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
@@ -79,8 +100,15 @@ GEM
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
     rake (10.3.2)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
     rdoc (3.12.2)
       json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
     rspec-core (2.14.8)
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
@@ -93,6 +121,11 @@ GEM
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
     slop (3.6.0)
     sprockets (2.2.2)
       hike (~> 1.2)
@@ -101,6 +134,7 @@ GEM
       tilt (~> 1.1, != 1.3.0)
     thor (0.19.1)
     tilt (1.4.1)
+    timers (1.1.0)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
@@ -111,9 +145,11 @@ PLATFORMS
 
 DEPENDENCIES
   awesome_print (~> 1.2)
+  codeclimate-test-reporter (~> 0.4)
+  guard-rspec (~> 4.2)
   pg (~> 0.17)
   pg_morph!
   pry (~> 0.10)
   rails (~> 3)
   rake (~> 10.3)
-  rspec-rails
+  rspec-rails (~> 2.14)

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec --color --format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| ["spec/lib/#{m[1]}_spec.rb", "spec/lib/#{m[1]}_integration_spec.rb"] }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,8 +1,16 @@
+[![Build Status](https://travis-ci.org/LunarLogic/pg_morph.svg?branch=view)](https://travis-ci.org/LunarLogic/pg_morph)
+[![Code Climate](https://codeclimate.com/github/LunarLogic/pg_morph/badges/gpa.svg)](https://codeclimate.com/github/LunarLogic/pg_morph)
+[![Test Coverage](https://codeclimate.com/github/LunarLogic/pg_morph/badges/coverage.svg)](https://codeclimate.com/github/LunarLogic/pg_morph)
+
 # PgMorph
 # ![PgMorph logo](docs/pg_morph.png)
 
 PgMorph gives you a way to handle DB consistency for polymorphic relations and is based on postgreSQL inheritance and partitioning features.
 
+## Requirements
+
+postgresql >= 9.2
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -33,7 +41,8 @@ By adding migration:
 add_polymorphic_foreign_key :likes, :comments, column: :likeable
 ```
 
-PgMorph creates a partition table named `likes_comments` which inherits from `likes` table, sets foreign key on it and redirects all inserts to `likes` to this partition table if `likeable_type` is `Like`. It's done by using before insert trigger.
+At first PgMorph wants to use `likes` table view instead of normal table as a master one. To prevent braking all potential relations with other tables it renames `likes` table to `likes_base` and then creates a view of `likes_base` named `likes`.
+PgMorph then creates a partition table named `likes_comments` which inherits from `likes_base` table, sets foreign key on it and redirects all inserts to `likes` - since this is the table name AR knows aobut - to this partition table if `likeable_type` is `Comment`. It's done by using before insert trigger.
 
 You will have to add polymorphic foreign key on all related tables and each time new relation is added, before insert trigger function will be updated to reflect all defined relations and redirect new records to proper partitions.
 
@@ -47,11 +56,14 @@ remove_polymorphic_foreign_key :likes, :comments, column: :likeable
 
 Because it means that whole partition table would be removed, you will be forbidden to do that if partition table contains any data.
 
-## Issues
+## Caveats
+
+While updating records check constraints which are set on each partition does not allow to change association type, so if in examplary model some like is for a comment, it can't be reassigned to a post, postgres will raise an exception.
 
-ActiveRecord uses `INSERT ... RETURNING id` query which was impossible to keep while while using regular tables without some trick. In ideal situation there should be inly one insert to partition table, omitting main table, but than `id` of newly created record would become `nil` which would frustrate most of us. To preserve `id` of new record main table is not omitted, two records are being made and in after insert trigger duplicated record from master table is removed.
+## Development plan
 
-This extra database operations may be skipped by using view for main table, however it requires more work to make it so transparent for ActiveRecord as it is now, and is going to be done in next release.
+- support moving records between partitions while updating relation type
+- your suggestions?
 
 ## Contributing
 

data/Rakefile

@@ -1,4 +1,11 @@
 require 'rake/testtask'
+require 'rspec/core/rake_task'
+require_relative './spec/dummy/config/application.rb'
+
+task :default => :spec
+RSpec::Core::RakeTask.new
+
+Dummy::Application.load_tasks
 
 desc 'test pg_morph'
 Rake::TestTask.new do |t|

data/lib/pg_morph/adapter.rb

@@ -7,11 +7,11 @@ module PgMorph
 
       polymorphic = PgMorph::Polymorphic.new(parent_table, child_table, options)
 
-      sql = polymorphic.create_proxy_table_sql
+      sql =  polymorphic.rename_base_table_sql
+      sql << polymorphic.create_base_table_view_sql
+      sql << polymorphic.create_proxy_table_sql
       sql << polymorphic.create_before_insert_trigger_fun_sql
       sql << polymorphic.create_before_insert_trigger_sql
-      sql << polymorphic.create_after_insert_trigger_fun_sql
-      sql << polymorphic.create_after_insert_trigger_sql
 
       execute(sql)
     end
@@ -22,8 +22,9 @@ module PgMorph
       polymorphic = PgMorph::Polymorphic.new(parent_table, child_table, options)
 
       sql = polymorphic.remove_before_insert_trigger_sql
-      sql << polymorphic.remove_partition_table
-      sql << polymorphic.remove_after_insert_trigger_sql
+      sql << polymorphic.remove_proxy_table
+      sql << polymorphic.remove_base_table_view_sql
+      sql << polymorphic.rename_base_table_back_sql
 
       execute(sql)
     end

data/lib/pg_morph/naming.rb

@@ -25,13 +25,5 @@ module PgMorph
       "#{parent_table}_#{column_name}_insert_trigger"
     end
 
-    def after_insert_fun_name
-      "delete_from_#{parent_table}_master_fun"
-    end
-
-    def after_insert_trigger_name
-      "#{parent_table}_after_insert_trigger"
-    end
-
   end
 end

data/lib/pg_morph/polymorphic.rb

@@ -1,30 +1,63 @@
 module PgMorph
 
   class Polymorphic
+    BASE_TABLE_SUFIX = :base
+
     include PgMorph::Naming
-    attr_reader :parent_table, :child_table, :column_name
+    attr_reader :parent_table, :child_table, :column_name, :base_table
 
     def initialize(parent_table, child_table, options)
       @parent_table = parent_table
       @child_table = child_table
       @column_name = options[:column]
+      @base_table = options[:base_table] || :"#{parent_table}_#{BASE_TABLE_SUFIX}"
 
       raise PgMorph::Exception.new("Column not specified") unless @column_name
     end
 
+    def rename_base_table_sql
+      return '' unless can_rename_to_base_table?
+      %Q{
+        ALTER TABLE #{parent_table} RENAME TO #{base_table};
+      }
+    end
+
+    def can_rename_to_base_table?
+      return true unless ActiveRecord::Base.connection.table_exists? base_table
+
+      parent_table_set = ActiveRecord::Base.connection.columns(parent_table).
+                          map{|column| column.as_json.except('null')}
+      base_table_set = ActiveRecord::Base.connection.columns(base_table).
+                          map{|column| column.as_json.except('null')}
+
+      return false if parent_table_set == base_table_set
+      raise PgMorph::Exception.new('table name mismatch!')
+    end
+
+    def create_base_table_view_sql
+      %Q{
+        CREATE OR REPLACE VIEW #{parent_table} AS SELECT * FROM #{base_table};
+      }
+    end
+
     def create_proxy_table_sql
       %Q{
       CREATE TABLE #{proxy_table} (
         CHECK (#{column_name_type} = '#{type}'),
         PRIMARY KEY (id),
         FOREIGN KEY (#{column_name_id}) REFERENCES #{child_table}(id)
-      ) INHERITS (#{parent_table});
+      ) INHERITS (#{base_table});
       }
     end
 
     def create_before_insert_trigger_fun_sql
       before_insert_trigger_content do
-        create_trigger_body.strip
+        %Q{
+        IF NEW.id IS NULL THEN
+          NEW.id := nextval('#{parent_table}_id_seq');
+        END IF;
+        #{create_trigger_body.strip}
+        }
       end
     end
 
@@ -32,44 +65,29 @@ module PgMorph
       fun_name = before_insert_fun_name
       trigger_name = before_insert_trigger_name
 
-      create_trigger_sql(parent_table, trigger_name, fun_name, 'BEFORE INSERT')
-    end
-
-    def create_after_insert_trigger_sql
-      fun_name = after_insert_fun_name
-      trigger_name = after_insert_trigger_name
-
-      create_trigger_sql(parent_table, trigger_name, fun_name, 'AFTER INSERT')
-    end
-
-    def create_after_insert_trigger_fun_sql
-      fun_name = after_insert_fun_name
-      create_trigger_fun(fun_name) do
-        %Q{DELETE FROM ONLY #{parent_table} WHERE id = NEW.id;}
-      end
+      create_trigger_sql(parent_table, trigger_name, fun_name, 'INSTEAD OF INSERT')
     end
 
     def remove_before_insert_trigger_sql
       trigger_name = before_insert_trigger_name
       fun_name = before_insert_fun_name
-
-      prosrc = get_function(fun_name)
-      raise PG::Error.new("There is no such function #{fun_name}()\n") unless prosrc
-
-      scan =  prosrc.scan(/(( +(ELS)?IF.+\n)(\s+INSERT INTO.+;\n))/)
-      cleared = scan.reject { |x| x[0].match("#{proxy_table}") }
+      cleared = check_more_partitions
 
       if cleared.present?
-        cleared[0][0].sub!('ELSIF', 'IF')
-        before_insert_trigger_content do
-          cleared.map { |m| m[0] }.join('').strip
-        end
+        update_before_insert_trigger_sql(cleared)
       else
         drop_trigger_and_fun_sql(trigger_name, parent_table, fun_name)
       end
     end
 
-    def remove_partition_table
+    def update_before_insert_trigger_sql(cleared)
+      cleared[0][0].sub!('ELSIF', 'IF')
+      before_insert_trigger_content do
+        cleared.map { |m| m[0] }.join('').strip
+      end
+    end
+
+    def remove_proxy_table
       table_empty = ActiveRecord::Base.connection.select_value("SELECT COUNT(*) FROM #{parent_table}_#{child_table}").to_i.zero?
       if table_empty
         %Q{ DROP TABLE IF EXISTS #{proxy_table}; }
@@ -78,20 +96,34 @@ module PgMorph
       end
     end
 
-    def remove_after_insert_trigger_sql
-      prosrc = get_function(before_insert_fun_name)
-      scan =  prosrc.scan(/(( +(ELS)?IF.+\n)(\s+INSERT INTO.+;\n))/)
-      cleared = scan.reject { |x| x[0].match("#{proxy_table}") }
-
-      return '' if cleared.present?
-      fun_name = after_insert_fun_name
-      trigger_name = after_insert_trigger_name
+    def remove_base_table_view_sql
+      if check_more_partitions.present?
+        ''
+      else
+        %Q{ DROP VIEW #{parent_table}; }
+      end
+    end
 
-      drop_trigger_and_fun_sql(trigger_name, parent_table, fun_name)
+    def rename_base_table_back_sql
+      if check_more_partitions.present?
+        ''
+      else
+        %Q{ ALTER TABLE #{base_table} RENAME TO #{parent_table}; }
+      end
     end
 
     private
 
+    def check_more_partitions
+      fun_name = before_insert_fun_name
+
+      prosrc = get_function(fun_name)
+      raise PG::Error.new("There is no such function #{fun_name}()\n") unless prosrc
+
+      scan =  prosrc.scan(/(( +(ELS)?IF.+\n)(\s+INSERT INTO.+;\n))/)
+      scan.reject { |x| x[0].match("#{proxy_table}") }
+    end
+
     def create_trigger_fun(fun_name, &block)
       %Q{
         CREATE OR REPLACE FUNCTION #{fun_name}() RETURNS TRIGGER AS $$
@@ -115,21 +147,29 @@ module PgMorph
       prosrc = get_function(before_insert_fun_name)
 
       if prosrc
-        scan =  prosrc.scan(/(( +(ELS)?IF.+\n)(\s+INSERT INTO.+;\n))/)
-        raise PG::Error.new("Condition for #{proxy_table} table already exists in trigger function") if scan[0][0].match proxy_table
-        %Q{
-          #{scan.map { |m| m[0] }.join.strip}
-          ELSIF (NEW.#{column_name}_type = '#{child_table.to_s.singularize.camelize}') THEN
-            INSERT INTO #{parent_table}_#{child_table} VALUES (NEW.*);
-        }
+        update_existing_trigger_body(prosrc)
       else
-        %Q{
-          IF (NEW.#{column_name}_type = '#{child_table.to_s.singularize.camelize}') THEN
-            INSERT INTO #{parent_table}_#{child_table} VALUES (NEW.*);
-        }
+        create_new_trigger_body
       end
     end
 
+    def update_existing_trigger_body(prosrc)
+      scan =  prosrc.scan(/(( +(ELS)?IF.+\n)(\s+INSERT INTO.+;\n))/)
+      raise PG::Error.new("Condition for #{proxy_table} table already exists in trigger function") if scan[0][0].match proxy_table
+      %Q{
+        #{scan.map { |m| m[0] }.join.strip}
+        ELSIF (NEW.#{column_name}_type = '#{child_table.to_s.singularize.camelize}') THEN
+          INSERT INTO #{parent_table}_#{child_table} VALUES (NEW.*);
+      }
+    end
+
+    def create_new_trigger_body
+      %Q{
+        IF (NEW.#{column_name}_type = '#{child_table.to_s.singularize.camelize}') THEN
+          INSERT INTO #{parent_table}_#{child_table} VALUES (NEW.*);
+      }
+    end
+
     def create_trigger_sql(parent_table, trigger_name, fun_name, when_to_call)
       %Q{
       DROP TRIGGER IF EXISTS #{trigger_name} ON #{parent_table};

data/lib/pg_morph/version.rb

@@ -1,3 +1,3 @@
 module PgMorph
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end