pg_morph 0.3.0 → 1.0.0

data/pg_morph.gemspec

@@ -23,7 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rails", "~> 3"
   spec.add_development_dependency "pg", "~> 0.17"
 
-  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
+  spec.add_development_dependency "rspec-rails", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.2"
 
   spec.add_development_dependency "rake", "~> 10.3"
   spec.add_development_dependency "pry", "~> 0.10"

data/spec/dummy/db/schema.rb

@@ -9,30 +9,27 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended that you check this file into your version control system.
+# It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140401124727) do
+ActiveRecord::Schema.define(:version => 20140401124727) do
 
-  # These are extensions that must be enabled in order to support this database
-  enable_extension "plpgsql"
-
-  create_table "comments", force: true do |t|
+  create_table "comments", :force => true do |t|
     t.string   "content"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
-  create_table "likes", force: true do |t|
+  create_table "likes", :force => true do |t|
     t.string   "likeable_type"
     t.integer  "likeable_id"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at",    :null => false
+    t.datetime "updated_at",    :null => false
   end
 
-  create_table "posts", force: true do |t|
+  create_table "posts", :force => true do |t|
     t.string   "content"
-    t.datetime "created_at"
-    t.datetime "updated_at"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
   end
 
 end

data/spec/lib/pg_morph/adapter_integration_spec.rb

@@ -0,0 +1,263 @@
+require 'spec_helper'
+
+describe PgMorph::Adapter do
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval do
+    include PgMorph::Adapter
+
+    def pg_views(name = nil)
+      query(%Q{
+        SELECT viewname
+        FROM pg_views
+        WHERE schemaname = ANY (current_schemas(false))
+      }, 'SCHEMA').map { |row| row[0] }
+    end
+
+    def run(query)
+      ActiveRecord::Base.connection.select_value(query)
+    end
+  end
+
+  let(:comment) { Comment.create(content: 'comment') }
+
+  before do
+    @adapter = ActiveRecord::Base.connection
+    @comments_polymorphic = PgMorph::Polymorphic.new(:likes, :comments, column: :likeable)
+    @posts_polymorphic = PgMorph::Polymorphic.new(:likes, :posts, column: :likeable)
+    begin
+      Like.destroy_all
+      Comment.destroy_all
+      @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+      @adapter.remove_polymorphic_foreign_key(:likes, :posts, column: :likeable)
+    rescue
+    end
+  end
+
+  after do
+    begin
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+    rescue
+    end
+  end
+
+  describe '#add_polymorphic_foreign_key' do
+    it 'renames base table' do
+      expect(@adapter.tables).to include "likes"
+      expect(@adapter.tables).not_to include "likes_base"
+
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.tables).not_to include "likes"
+      expect(@adapter.tables).to include "likes_base"
+    end
+
+    it 'creates base table view' do
+      expect(@adapter.pg_views).to be_empty
+      expect(@adapter.tables).to include "likes"
+
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.pg_views).to include "likes"
+      expect(@adapter.tables).not_to include "likes"
+    end
+
+    it 'creates proxy table' do
+      expect(@adapter.tables).not_to include "likes_comments"
+
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.tables).to include "likes_comments"
+    end
+
+    it 'creates before insert trigger fun' do
+      fun_name = @comments_polymorphic.before_insert_fun_name
+      expect(@adapter.run("select proname from pg_proc where proname = '#{fun_name}'")).
+        to be nil
+
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.run("select proname from pg_proc where proname = '#{fun_name}'")).
+        to eq fun_name
+    end
+
+    it 'creates before insert trigger' do
+      trigger_name = @comments_polymorphic.before_insert_trigger_name
+      expect(@adapter.query("SELECT * FROM pg_trigger WHERE tgname = '#{trigger_name}'")).
+        to be_empty
+
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.query("SELECT count(*) FROM pg_trigger WHERE tgname = '#{trigger_name}'")).
+        to eq [["1"]]
+    end
+  end
+
+  describe '#remove_polymorphic_foreign_key' do
+    before do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+    end
+
+    it 'removes before insert trigger' do
+      fun_name = @comments_polymorphic.before_insert_fun_name
+      expect(@adapter.run("select proname from pg_proc where proname = '#{fun_name}'")).
+        to eq fun_name
+
+      @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.run("select proname from pg_proc where proname = '#{fun_name}'")).
+        to be nil
+    end
+
+    it 'removes before insert trigger fun' do
+      trigger_name = @comments_polymorphic.before_insert_trigger_name
+      expect(@adapter.query("SELECT count(*) FROM pg_trigger WHERE tgname = '#{trigger_name}'")).
+        to eq [["1"]]
+
+      @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.query("SELECT * FROM pg_trigger WHERE tgname = '#{trigger_name}'")).
+        to be_empty
+    end
+
+    it 'removes proxy table' do
+      expect(@adapter.tables).to include "likes_comments"
+
+      @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.tables).not_to include "likes_comments"
+    end
+
+    it 'prevents from removing proxy with data' do
+      Like.create(likeable: comment)
+
+      -> { @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable) }
+        .should raise_error PG::Error
+    end
+
+    it 'removes table view if empty' do
+      expect(@adapter.pg_views).to include "likes"
+      expect(@adapter.tables).not_to include "likes"
+
+      @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.pg_views).to be_empty
+    end
+
+    it 'renames base table to original name' do
+      expect(@adapter.pg_views).to include "likes"
+      expect(@adapter.tables).not_to include "likes"
+
+      @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@adapter.tables).to include "likes"
+    end
+
+    context 'with more than one partitions' do
+      before do
+        @adapter.add_polymorphic_foreign_key(:likes, :posts, column: :likeable)
+      end
+
+      it 'does not rename base table to original name' do
+        expect(@adapter.pg_views).to include "likes"
+        expect(@adapter.tables).not_to include "likes"
+
+        @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+        expect(@adapter.tables).not_to include "likes"
+        expect(@adapter.pg_views).to include "likes"
+      end
+    end
+  end
+
+  describe 'operations on a partition' do
+    let(:comment) { Comment.create(content: 'comment') }
+    let(:post) { Post.create(content: 'content') }
+
+    before do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+      @comment_like = Like.create(likeable: comment)
+    end
+
+    context "creating records" do
+      it "works with single partition" do
+        expect(Like.count).to eq(1)
+        expect(@comment_like.id).to eq(Like.last.id)
+      end
+
+      it "works with multiple partitions" do
+        @adapter.add_polymorphic_foreign_key(:likes, :posts, column: :likeable)
+        post_like = Like.create(likeable: post)
+
+        expect(Like.count).to eq(2)
+        expect(post_like.id).to eq(Like.last.id)
+      end
+
+      it "raises error for a missing partition" do
+        -> {  Like.create(likeable: post) }
+          .should raise_error ActiveRecord::StatementInvalid
+      end
+
+      it "works if no partitions" do
+        @comment_like.destroy
+        expect(Like.count).to eq(0)
+        @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+        like = Like.create(likeable: post)
+
+        expect(Like.count).to eq(1)
+        expect(like.id).to eq(Like.last.id)
+      end
+    end
+
+    context "updating records" do
+      let(:another_comment) { Comment.create(content: 'comment') }
+
+      before do
+        @adapter.add_polymorphic_foreign_key(:likes, :posts, column: :likeable)
+      end
+
+      it 'works within one partition' do
+        expect(@comment_like.likeable).to eq(comment)
+
+        @comment_like.likeable = another_comment
+        @comment_like.save
+
+        @comment_like.reload
+        expect(@comment_like.likeable).to eq(another_comment)
+      end
+
+      it 'does not allow to change associated type' do
+        expect(@comment_like.likeable).to eq(comment)
+
+        @comment_like.likeable = post
+        expect { @comment_like.save }.to raise_error ActiveRecord::StatementInvalid
+      end
+    end
+
+    context "deleting records" do
+      before do
+        expect(@adapter.run("SELECT id from likes where id = #{@comment_like.id}"))
+          .to eq @comment_like.id.to_s
+        expect(@adapter.run("SELECT id from likes_comments where id = #{@comment_like.id}"))
+          .to eq @comment_like.id.to_s
+        @comment_like.destroy
+      end
+
+      it "works on a partition" do
+        expect(@adapter.run("SELECT id from likes where id = #{@comment_like.id}")).to eq nil
+        expect(@adapter.run("SELECT id from likes_comments where id = #{@comment_like.id}")).to eq nil
+      end
+
+      context "after removing paritions" do
+        before do
+          @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+          @like = Like.create(likeable: comment)
+        end
+
+        it "works on a master table" do
+          @like.destroy
+          expect(@adapter.run("SELECT id from likes where id = #{@comment_like.id}")).to eq nil
+        end
+      end
+    end
+  end
+
+end

data/spec/{pg_morph → lib/pg_morph}/adapter_spec.rb

@@ -3,15 +3,6 @@ require 'spec_helper'
 describe PgMorph::Adapter do
   class FakeAdapter
     include PgMorph::Adapter
-
-    def execute(sql, name = nil)
-      sql_statements << sql
-      sql
-    end
-
-    def sql_statements
-      @sql_statements || []
-    end
   end
 
   before do

data/spec/{pg_morph → lib/pg_morph}/naming_spec.rb

@@ -22,8 +22,4 @@ describe PgMorph::Naming do
 
   it { expect(@fake.before_insert_trigger_name).to eq('foos_baz_insert_trigger') }
 
-  it { expect(@fake.after_insert_fun_name).to eq('delete_from_foos_master_fun') }
-
-  it { expect(@fake.after_insert_trigger_name).to eq('foos_after_insert_trigger') }
-
 end

data/spec/lib/pg_morph/polymorphic_integration_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe PgMorph::Polymorphic do
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval do
+    include PgMorph::Adapter
+
+    def run(query)
+      ActiveRecord::Base.connection.select_value(query)
+    end
+  end
+
+  before do
+    @adapter = ActiveRecord::Base.connection
+    @comments_polymorphic = PgMorph::Polymorphic.new(:likes, :comments, column: :likeable)
+    @posts_polymorphic = PgMorph::Polymorphic.new(:likes, :posts, column: :likeable)
+    begin
+      Like.destroy_all
+      Comment.destroy_all
+      @adapter.remove_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+    rescue
+    end
+  end
+
+  describe '#can_rename_to_base_table?' do
+    it 'returns true if base table does not exist' do
+      @adapter.stub(:table_exists?).with(@comments_polymorphic.base_table)
+        .and_return(false)
+
+      expect(@comments_polymorphic.can_rename_to_base_table?)
+        .to be_true
+    end
+
+    it 'returns false if there is compatible base table' do
+      @adapter.add_polymorphic_foreign_key(:likes, :posts, column: :likeable)
+
+      expect(@comments_polymorphic.can_rename_to_base_table?)
+        .to be_false
+    end
+
+    it 'raises an exception if existing base table is not compatible table' do
+      @adapter.create_table(@comments_polymorphic.base_table)
+
+      expect { @comments_polymorphic.can_rename_to_base_table? }.
+        to raise_error PgMorph::Exception
+    end
+  end
+
+  describe '#create_trigger_body' do
+    before do
+      @adapter.stub(:raise_unless_postgres)
+    end
+
+    it 'raises error for updating trigger with duplicated partition' do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect { @comments_polymorphic.send(:create_trigger_body) }
+        .to raise_error PG::Error
+    end
+
+    it 'updates trigger with new partition' do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@posts_polymorphic.send(:create_trigger_body).squeeze(' ')).to eq %Q{
+        IF (NEW.likeable_type = 'Comment') THEN
+          INSERT INTO likes_comments VALUES (NEW.*);
+        ELSIF (NEW.likeable_type = 'Post') THEN
+          INSERT INTO likes_posts VALUES (NEW.*);
+        }.squeeze(' ')
+    end
+  end
+
+  describe '#create_before_insert_trigger_sql' do
+    it 'returns sql' do
+      expect(@comments_polymorphic.create_before_insert_trigger_sql.squeeze(' ')).to eq %Q{
+      DROP TRIGGER IF EXISTS likes_likeable_insert_trigger ON likes;
+      CREATE TRIGGER likes_likeable_insert_trigger
+        INSTEAD OF INSERT ON likes
+        FOR EACH ROW EXECUTE PROCEDURE likes_likeable_fun();
+      }.squeeze(' ')
+    end
+  end
+
+  describe '#remove_before_insert_trigger_sql' do
+    it 'returns proper sql if more partitions' do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+      @adapter.add_polymorphic_foreign_key(:likes, :posts, column: :likeable)
+
+      expect(@comments_polymorphic.remove_before_insert_trigger_sql.squeeze(' ')).to eq %Q{
+      CREATE OR REPLACE FUNCTION likes_likeable_fun() RETURNS TRIGGER AS $$
+      BEGIN
+      IF (NEW.#{@posts_polymorphic.column_name}_type = 'Post') THEN
+      INSERT INTO #{@posts_polymorphic.parent_table}_#{@posts_polymorphic.child_table} VALUES (NEW.*);
+      ELSE
+      RAISE EXCEPTION 'Wrong "#{@posts_polymorphic.column_name}_type"="%" used. Create proper partition table and update likes_likeable_fun function', NEW.likeable_type;
+      END IF;
+      RETURN NEW;
+      END; $$ LANGUAGE plpgsql;
+      }.squeeze(' ')
+    end
+  end
+
+  describe '#remove_proxy_table' do
+    it 'returns sql' do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@comments_polymorphic.remove_proxy_table.squeeze(' ')).to eq %Q{ DROP TABLE IF EXISTS likes_comments; }
+    end
+  end
+
+  describe '#remove_base_table_view_sql' do
+    it 'returns proper sql if no more partitions' do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+
+      expect(@comments_polymorphic.remove_base_table_view_sql.squeeze(' ')).to eq %Q{ DROP VIEW likes; }
+    end
+
+    it 'returns empty string if there are more partitions' do
+      @adapter.add_polymorphic_foreign_key(:likes, :comments, column: :likeable)
+      @adapter.add_polymorphic_foreign_key(:likes, :posts, column: :likeable)
+
+      expect(@comments_polymorphic.remove_base_table_view_sql.squeeze(' ')).to eq ''
+    end
+  end
+
+end