pg_trunk 0.1.0

data/spec/operations/statistics/create_statistics_spec.rb

@@ -0,0 +1,230 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#create_statistics" do
+  before_all do
+    run_migration <<~RUBY
+      create_table :users do |t|
+        t.string :name
+        t.string :family
+      end
+    RUBY
+  end
+
+  context "with an explicit name" do
+    let(:migration) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :ndistinct
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "without a name" do
+    let(:migration) do
+      <<~RUBY
+        create_statistics do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :ndistinct
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "with one column" do
+    let(:migration) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "family"
+          s.kinds :dependencies, :ndistinct
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    it { is_expected.to fail_validation.because(/add more columns/i) }
+  end
+
+  context "with several expressions", since_version: 14 do
+    let(:migration) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.expression "length(family::text)"
+          s.expression "length(name::text)"
+          s.kinds :dependencies, :ndistinct
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "with several columns and expressions", since_version: 14 do
+    let(:migration) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "name"
+          s.expression "length(family::text)"
+          s.kinds :dependencies, :ndistinct
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "with mcv kind" do
+    let(:migration) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :mcv, :ndistinct
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    context "before version 12", before_version: 12 do
+      its(:execution) { is_expected.to raise_error(/supported in PostgreSQL v12+/i) }
+    end
+
+    context "since version 12", since_version: 12 do
+      its(:execution) { is_expected.to insert(migration).into_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+  end
+
+  context "with one expression only", since_version: 14 do
+    context "without kinds" do
+      let(:migration) do
+        <<~RUBY
+          create_statistics "my_stats" do |s|
+            s.table "users"
+            s.expression "length(family::text)"
+            s.comment "Collect all stats"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to insert(migration).into_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "with kinds" do
+      let(:migration) do
+        <<~RUBY
+          create_statistics "my_stats" do |s|
+            s.table "users"
+            s.expression "length(family::text)"
+            s.kinds :dependencies
+            s.comment "Collect all stats"
+          end
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/kinds must be blank/i) }
+    end
+  end
+
+  context "with expressions", before_version: 14 do
+    let(:migration) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "name"
+          s.expression "length(family::text)"
+          s.kinds :dependencies, :ndistinct
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to raise_error(/supported in PostgreSQL v14+/i) }
+  end
+
+  context "when the statistics existed" do
+    before do
+      run_migration <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.comment "Collect all stats"
+        end
+      RUBY
+    end
+
+    context "without the `if_not_exists` option" do
+      let(:migration) do
+        <<~RUBY
+          create_statistics "my_stats" do |s|
+            s.table "users"
+            s.columns "family", "name"
+            s.comment "Collect all stats"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to raise_error(StandardError) }
+    end
+
+    context "with the `if_not_exists: true` option" do
+      let(:migration) do
+        <<~RUBY
+          create_statistics "my_stats", if_not_exists: true do |s|
+            s.table "users"
+            s.columns "family", "name"
+            s.comment "Collect all stats"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.not_to change_schema }
+      it { is_expected.to be_irreversible.because_of(/if_not_exists: true/i) }
+    end
+
+    context "without a table" do
+      let(:migration) do
+        <<~RUBY
+          create_statistics "my_stats" do |s|
+            s.columns "family", "name"
+            s.kinds :dependencies, :ndistinct
+          end
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/table can't be blank/i) }
+    end
+
+    context "without columns and expressions" do
+      let(:migration) do
+        <<~RUBY
+          create_statistics "my_stats" do |s|
+            s.table "users"
+            s.kinds :dependencies, :ndistinct
+          end
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/can't be blank/i) }
+    end
+  end
+end

data/spec/operations/statistics/drop_statistics_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#drop_statistics" do
+  before_all do
+    run_migration <<~RUBY
+      create_table :users do |t|
+        t.string :name
+        t.string :family
+      end
+    RUBY
+  end
+  before { run_migration(snippet) }
+
+  context "when the statistics was anonymous" do
+    let(:snippet) do
+      <<~RUBY
+        create_statistics do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :ndistinct
+        end
+      RUBY
+    end
+    let(:migration) do
+      <<~RUBY
+        drop_statistics do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :ndistinct
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to remove(snippet).from_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "when the statistics was named explicitly" do
+    let(:snippet) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :ndistinct
+        end
+      RUBY
+    end
+    let(:migration) do
+      <<~RUBY
+        drop_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :ndistinct
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to remove(snippet).from_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "without a full definition" do
+    let(:snippet) do
+      <<~RUBY
+        create_statistics "my_stats" do |s|
+          s.table "users"
+          s.columns "family", "name"
+          s.kinds :dependencies, :ndistinct
+        end
+      RUBY
+    end
+    let(:migration) do
+      <<~RUBY
+        drop_statistics "my_stats"
+      RUBY
+    end
+
+    its(:execution) { is_expected.to remove(snippet).from_schema }
+    it { is_expected.to be_irreversible.because(/table can't be blank/i) }
+  end
+
+  context "when a statistics was absent" do
+    let(:snippet) { "" }
+
+    context "without `if_exists` option" do
+      let(:migration) do
+        <<~RUBY
+          drop_statistics "my_stats"
+        RUBY
+      end
+
+      its(:execution) { is_expected.to raise_error(StandardError) }
+    end
+
+    context "with the `if_exists: true` option" do
+      let(:migration) do
+        <<~RUBY
+          drop_statistics "my_stats", if_exists: true
+        RUBY
+      end
+
+      its(:execution) { is_expected.not_to change_schema }
+      it { is_expected.to be_irreversible.because_of(/if_exists: true/i) }
+    end
+  end
+end

data/spec/operations/statistics/rename_statistics_spec.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#rename_statistics" do
+  before_all do
+    run_migration <<~RUBY
+      create_table :users do |t|
+        t.string :name
+        t.string :family
+      end
+    RUBY
+  end
+  before { run_migration(old_snippet) }
+
+  context "when the constraint was anonymous" do
+    let(:old_snippet) do
+      <<~RUBY
+        create_statistics do |s|
+          s.table :users
+          s.kinds :dependencies, :ndistinct
+          s.columns "name", "family"
+        end
+      RUBY
+    end
+
+    context "with a new name" do
+      let(:migration) do
+        <<~RUBY
+          rename_statistics to: "my_stats" do |s|
+            s.table :users
+            s.kinds :dependencies, :ndistinct
+            s.columns "name", "family"
+          end
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_statistics "my_stats" do |s|
+            s.table "users"
+            s.columns "family", "name"
+            s.kinds :dependencies, :ndistinct
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:reversion) { is_expected.not_to change_schema }
+    end
+
+    context "without a new name" do
+      let(:migration) do
+        <<~RUBY
+          rename_statistics do |s|
+            s.table :users
+            s.kinds :dependencies, :ndistinct
+            s.columns "name", "family"
+          end
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/new name must be different/i) }
+    end
+  end
+
+  context "when the constraint was named explicitly" do
+    let(:old_snippet) do
+      <<~RUBY
+        create_statistics "my_old_name" do |s|
+          s.table "users"
+          s.kinds :dependencies, :ndistinct
+          s.columns "name", "family"
+        end
+      RUBY
+    end
+
+    context "with a new name" do
+      let(:migration) do
+        <<~RUBY
+          rename_statistics "my_old_name", to: "my_new_name"
+        RUBY
+      end
+      let(:new_snippet) do
+        <<~RUBY
+          create_statistics "my_new_name" do |s|
+            s.table "users"
+            s.columns "family", "name"
+            s.kinds :dependencies, :ndistinct
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to insert(new_snippet).into_schema }
+      its(:reversion) { is_expected.not_to change_schema }
+    end
+
+    context "when missed new name can be generated" do
+      let(:migration) do
+        <<~RUBY
+          rename_statistics "my_old_name" do |s|
+            s.table "users"
+            s.kinds :dependencies, :ndistinct
+            s.columns "name", "family"
+          end
+        RUBY
+      end
+      let(:snippet) do
+        <<~RUBY
+          create_statistics do |s|
+            s.table "users"
+            s.columns "family", "name"
+            s.kinds :dependencies, :ndistinct
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to insert(snippet).into_schema }
+      its(:reversion) { is_expected.not_to change_schema }
+    end
+
+    context "when missed new name can't be generated" do
+      let(:migration) do
+        <<~RUBY
+          rename_statistics "my_old_name"
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/new name can't be blank/i) }
+    end
+  end
+end

data/spec/operations/tables/create_table_spec.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#create_table" do
+  context "with indexes and check constraints" do
+    let(:migration) do
+      <<~RUBY
+        create_table :roles
+        create_table :users do |t|
+          t.integer :role_id, index: true
+          t.string :name
+          t.check_constraint "length(name) > 2"
+          t.foreign_key :roles
+        end
+      RUBY
+    end
+    let(:snippet) do
+      <<~RUBY
+        create_table "roles", force: :cascade do |t|
+        end
+
+        create_table "users", force: :cascade do |t|
+          t.integer "role_id"
+          t.string "name"
+        end
+
+        add_index "users", ["role_id"], name: "index_users_on_role_id"
+
+        add_check_constraint "users", "length((name)::text) > 2"
+
+        add_foreign_key "users", "roles"
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(snippet).into_schema }
+  end
+
+  context "with a custom id (primary key) definition" do
+    let(:migration) do
+      <<~RUBY
+        create_table :users, primary_key: :name do |t|
+        end
+      RUBY
+    end
+    let(:snippet) do
+      <<~RUBY
+        create_table "users", primary_key: "name", force: :cascade do |t|
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(snippet).into_schema }
+  end
+end

data/spec/operations/tables/rename_table_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#rename_table" do
+  let(:migration) do
+    <<~RUBY
+      create_table :roles
+      create_table :users do |t|
+        t.integer :role_id, index: true
+        t.string :name
+        t.foreign_key :roles
+        t.check_constraint "length(name) > 1"
+      end
+
+      rename_table :users, :customers
+    RUBY
+  end
+  let(:snippet) do
+    <<~RUBY
+      create_table "customers", force: :cascade do |t|
+        t.integer "role_id"
+        t.string "name"
+      end
+
+      create_table "roles", force: :cascade do |t|
+      end
+
+      add_index "customers", ["role_id"], name: "index_customers_on_role_id"
+
+      add_check_constraint "customers", "length((name)::text) > 1"
+
+      add_foreign_key "customers", "roles"
+    RUBY
+  end
+
+  its(:execution) { is_expected.to insert(snippet).into_schema }
+  its(:inversion) { is_expected.not_to change_schema }
+end