pg_trunk 0.1.0 → 0.2.0

data/lib/pg_trunk/operations/views/change_view.rb

@@ -1,44 +1,53 @@
 # frozen_string_literal: false
 
-# @!method ActiveRecord::Migration#change_view(name, **options, &block)
-# Modify a view
-#
-# @param [#to_s] name (nil) The qualified name of the view
-# @option [Boolean] :if_exists (false) Suppress the error when the view is absent
-# @yield [Proc] the block with the view's definition
-# @yieldparam The receiver of methods specifying the view
-#
-# The operation replaces the view with a new definition(s):
-#
-#   change_view "admin_users" do |v|
-#     v.sql_definition: <<~SQL, from: <<~SQL
-#       SELECT id, name FROM users WHERE admin;
-#     SQL
-#       SELECT * FROM users WHERE admin;
-#     SQL
+# @!parse
+#   class ActiveRecord::Migration
+#     # Modify a view
+#     #
+#     # @param [#to_s] name (nil) The qualified name of the view
+#     # @option options [Boolean] :if_exists (false) Suppress the error when the view is absent
+#     # @yield [v] the block with the view's definition
+#     # @yieldparam Object receiver of methods specifying the view
+#     # @return [void]
+#     #
+#     # The operation replaces the view with a new definition(s):
+#     #
+#     # ```ruby
+#     # change_view "admin_users" do |v|
+#     #   v.sql_definition: <<~SQL, from: <<~SQL
+#     #     SELECT id, name FROM users WHERE admin;
+#     #   SQL
+#     #     SELECT * FROM users WHERE admin;
+#     #   SQL
+#     # end
+#     # ```
+#     #
+#     # For some compatibility to the `scenic` gem, we also support
+#     # adding a definition via its version:
+#     #
+#     # ```ruby
+#     # change_view "admin_users" do |v|
+#     #   v.version 2, from: 1
+#     # end
+#     # ```
+#     #
+#     # It is expected, that both `db/views/admin_users_v01.sql`
+#     # and `db/views/admin_users_v02.sql` to contain SQL snippets.
+#     #
+#     # Please, notice that neither deletion of columns,
+#     # nor changing their types is supported by the PostgreSQL.
+#     #
+#     # You can also (re)set a comment describing the view,
+#     # and the check option (either `:local` or `:cascaded`):
+#     #
+#     # ```ruby
+#     # change_view "admin_users" do |v|
+#     #   v.check :local, from: :cascaded
+#     #   v.comment "Admin users only", from: ""
+#     # end
+#     # ```
+#     def change_view(name, **options, &block); end
 #   end
-#
-# For some compatibility to the `scenic` gem, we also support
-# adding a definition via its version:
-#
-#    change_view "admin_users" do |v|
-#      v.version 2, from: 1
-#    end
-#
-# It is expected, that both `db/views/admin_users_v01.sql`
-# and `db/views/admin_users_v02.sql` to contain SQL snippets.
-#
-# Please, notice that neither deletion of columns,
-# nor changing their types is supported by the PostgreSQL.
-#
-# You can also (re)set a comment describing the view,
-# and the check option (either `:local` or `:cascaded`):
-#
-#   change_view "admin_users" do |v|
-#     v.check :local, from: :cascaded
-#     v.comment "Admin users only", from: ""
-#   end
-
 module PGTrunk::Operations::Views
   # @private
   class ChangeView < Base

data/lib/pg_trunk/operations/views/create_view.rb

@@ -1,51 +1,62 @@
 # frozen_string_literal: false
 
-# @!method ActiveRecord::Migration#create_view(name, **options, &block)
-# Create a view
-#
-# @param [#to_s] name (nil) The qualified name of the view
-# @option [Boolean] :replace_existing (false) If the view should overwrite an existing one
-# @option [#to_s] :sql_definition (nil) The snippet containing the query
-# @option [#to_i] :version (nil)
-#   The alternative way to set sql_definition by referencing to a file containing the snippet
-# @option [#to_s] :check (nil) Controls the behavior of automatically updatable views
-#   Supported values: :local, :cascaded
-# @option [#to_s] :comment (nil) The comment describing the view
-# @yield [Proc] the block with the view's definition
-# @yieldparam The receiver of methods specifying the view
-#
-# The operation creates the view using its `sql_definition`:
-#
-#   create_view("views.admin_users", sql_definition: <<~SQL)
-#     SELECT id, name FROM users WHERE admin;
-#   SQL
-#
-# For compatibility to the `scenic` gem, we also support
-# adding a definition via its version:
-#
-#    create_view "admin_users", version: 1
-#
-# It is expected, that a `db/views/admin_users_v01.sql`
-# to contain the SQL snippet.
-#
-# You can also set a comment describing the view, and the check option
-# (either `:local` or `:cascaded`):
-#
-#   create_view "admin_users" do |v|
-#     v.sql_definition "SELECT id, name FROM users WHERE admin;"
-#     v.check :local
-#     v.comment "Admin users only"
+# @!parse
+#   class ActiveRecord::Migration
+#     # Create a view
+#     #
+#     # @param [#to_s] name (nil) The qualified name of the view
+#     # @option options [Boolean] :replace_existing (false) If the view should overwrite an existing one
+#     # @option options [#to_s] :sql_definition (nil) The snippet containing the query
+#     # @option options [#to_i] :version (nil)
+#     #   The alternative way to set sql_definition by referencing to a file containing the snippet
+#     # @option options [#to_s] :check (nil) Controls the behavior of automatically updatable views
+#     #   Supported values: :local, :cascaded
+#     # @option options [#to_s] :comment (nil) The comment describing the view
+#     # @yield [v] the block with the view's definition
+#     # @yieldparam Object receiver of methods specifying the view
+#     # @return [void]
+#     #
+#     # The operation creates the view using its `sql_definition`:
+#     #
+#     # ```ruby
+#     # create_view("views.admin_users", sql_definition: <<~SQL)
+#     #   SELECT id, name FROM users WHERE admin;
+#     # SQL
+#     # ```
+#     #
+#     # For compatibility to the `scenic` gem, we also support
+#     # adding a definition via its version:
+#     #
+#     # ```ruby
+#     # create_view "admin_users", version: 1
+#     # ```
+#     #
+#     # It is expected, that a `db/views/admin_users_v01.sql`
+#     # to contain the SQL snippet.
+#     #
+#     # You can also set a comment describing the view, and the check option
+#     # (either `:local` or `:cascaded`):
+#     #
+#     # ```ruby
+#     # create_view "admin_users" do |v|
+#     #   v.sql_definition "SELECT id, name FROM users WHERE admin;"
+#     #   v.check :local
+#     #   v.comment "Admin users only"
+#     # end
+#     # ```
+#     #
+#     # With the `replace_existing: true` option the operation
+#     # would use `CREATE OR REPLACE VIEW` command, so it
+#     # can be used to "update" (or reload) the existing view.
+#     #
+#     # ```ruby
+#     # create_view "admin_users", version: 1, replace_existing: true
+#     # ```
+#     #
+#     # This option makes an operation irreversible due to uncertainty
+#     # of the previous state of the database.
+#     def create_view(name, **options, &block); end
 #   end
-#
-# With the `replace_existing: true` option the operation
-# would use `CREATE OR REPLACE VIEW` command, so it
-# can be used to "update" (or reload) the existing view.
-#
-#   create_view "admin_users", version: 1, replace_existing: true
-#
-# This option makes an operation irreversible due to uncertainty
-# of the previous state of the database.
-
 module PGTrunk::Operations::Views
   # @private
   class CreateView < Base

data/lib/pg_trunk/operations/views/drop_view.rb

@@ -1,52 +1,65 @@
 # frozen_string_literal: false
 
-# @!method ActiveRecord::Migration#drop_view(name, **options, &block)
-# Drop a view
-#
-# @param [#to_s] name (nil) The qualified name of the view
-# @option [Boolean] :replace_existing (false) If the view should overwrite an existing one
-# @option [Boolean] :if_exists (false) Suppress the error when the view is absent
-# @option [Symbol] :force (:restrict) How to process dependent objects (`:cascade` or `:restrict`)
-# @option [#to_s] :sql_definition (nil) The snippet containing the query
-# @option [#to_i] :revert_to_version (nil)
-#   The alternative way to set sql_definition by referencing to a file containing the snippet
-# @option [#to_s] :check (nil) Controls the behavior of automatically updatable views
-#   Supported values: :local, :cascaded
-# @option [#to_s] :comment (nil) The comment describing the view
-# @yield [Proc] the block with the view's definition
-# @yieldparam The receiver of methods specifying the view
-#
-# The operation drops the existing view identified by its
-# qualified name (it can include a schema).
-#
-#   drop_view "views.admin_users"
-#
-# To make the operation invertible, use the same options
-# as in the `create_view` operation.
-#
-#   drop_view "views.admin_users" do |v|
-#     v.sql_definition "SELECT name, email FROM users WHERE admin;"
-#     v.check :local
-#     v.comment "Admin users only"
+# @!parse
+#   class ActiveRecord::Migration
+#     # Drop a view
+#     #
+#     # @param [#to_s] name (nil) The qualified name of the view
+#     # @option options [Boolean] :replace_existing (false) If the view should overwrite an existing one
+#     # @option options [Boolean] :if_exists (false) Suppress the error when the view is absent
+#     # @option options [Symbol] :force (:restrict) How to process dependent objects (`:cascade` or `:restrict`)
+#     # @option options [#to_s] :sql_definition (nil) The snippet containing the query
+#     # @option options [#to_i] :revert_to_version (nil)
+#     #   The alternative way to set sql_definition by referencing to a file containing the snippet
+#     # @option options [#to_s] :check (nil) Controls the behavior of automatically updatable views
+#     #   Supported values: :local, :cascaded
+#     # @option options [#to_s] :comment (nil) The comment describing the view
+#     # @yield [v] the block with the view's definition
+#     # @yieldparam Object receiver of methods specifying the view
+#     # @return [void]
+#     #
+#     # The operation drops the existing view identified by its
+#     # qualified name (it can include a schema).
+#     #
+#     # ```ruby
+#     # drop_view "views.admin_users"
+#     # ```
+#     #
+#     # To make the operation invertible, use the same options
+#     # as in the `create_view` operation.
+#     #
+#     # ```ruby
+#     # drop_view "views.admin_users" do |v|
+#     #   v.sql_definition "SELECT name, email FROM users WHERE admin;"
+#     #   v.check :local
+#     #   v.comment "Admin users only"
+#     # end
+#     # ```
+#     #
+#     # You can also use a version-base SQL definition like:
+#     #
+#     # ```ruby
+#     # drop_view "views.admin_users", revert_to_version: 1
+#     # ```
+#     #
+#     # With the `force: :cascade` option the operation would remove
+#     # all the objects which depend on the view.
+#     #
+#     # ```ruby
+#     # drop_view "views.admin_users", force: :cascade
+#     # ```
+#     #
+#     # With the `if_exists: true` option the operation won't fail
+#     # even when the view was absent in the database.
+#     #
+#     # ```ruby
+#     # drop_view "views.admin_users", if_exists: true
+#     # ```
+#     #
+#     # Both options make an operation irreversible due to uncertainty
+#     # of the previous state of the database.
+#     def drop_view(name, **options, &block); end
 #   end
-#
-# You can also use a version-base SQL definition like:
-#
-#    drop_view "views.admin_users", revert_to_version: 1
-#
-# With the `force: :cascade` option the operation would remove
-# all the objects which depend on the view.
-#
-#   drop_view "views.admin_users", force: :cascade
-#
-# With the `if_exists: true` option the operation won't fail
-# even when the view was absent in the database.
-#
-#   drop_view "views.admin_users", if_exists: true
-#
-# Both options make an operation irreversible due to uncertainty
-# of the previous state of the database.
-
 module PGTrunk::Operations::Views
   # @private
   class DropView < Base

data/lib/pg_trunk/operations/views/rename_view.rb

@@ -1,25 +1,32 @@
 # frozen_string_literal: false
 
-# @!method ActiveRecord::Migration#rename_view(name, **options)
-# Change the name and/or schema of a view
-#
-# @param [#to_s] :name (nil) The qualified name of the view
-# @option [#to_s] :to (nil) The new qualified name for the view
-# @option [Boolean] :if_exists (false) Suppress the error when the view is absent
-#
-# A view can be renamed by changing both the name
-# and the schema (namespace) it belongs to.
-#
-#   rename_view "views.admin_users", to: "admins"
-#
-# With the `if_exists: true` option, the operation won't fail
-# even when the view wasn't existed.
-#
-#   rename_view "views.admin_users", to: "admins", if_exists: true
-#
-# At the same time, the option makes a view irreversible
-# due to uncertainty of the previous state of the database.
-
+# @!parse
+#   class ActiveRecord::Migration
+#     # Change the name and/or schema of a view
+#     #
+#     # @param [#to_s] :name (nil) The qualified name of the view
+#     # @option options [#to_s] :to (nil) The new qualified name for the view
+#     # @option options [Boolean] :if_exists (false) Suppress the error when the view is absent
+#     # @return [void]
+#     #
+#     # A view can be renamed by changing both the name
+#     # and the schema (namespace) it belongs to.
+#     #
+#     # ```ruby
+#     # rename_view "views.admin_users", to: "admins"
+#     # ```
+#     #
+#     # With the `if_exists: true` option, the operation won't fail
+#     # even when the view wasn't existed.
+#     #
+#     # ```ruby
+#     # rename_view "views.admin_users", to: "admins", if_exists: true
+#     # ```
+#     #
+#     # At the same time, the option makes a view irreversible
+#     # due to uncertainty of the previous state of the database.
+#     def rename_view(name, **options); end
+#   end
 module PGTrunk::Operations::Views
   # @private
   class RenameView < Base

data/lib/pg_trunk/operations.rb

@@ -9,6 +9,7 @@ module PGTrunk
     require_relative "operations/enums"
     require_relative "operations/composite_types"
     require_relative "operations/domains"
+    require_relative "operations/sequences"
     require_relative "operations/tables"
     require_relative "operations/views"
     require_relative "operations/materialized_views"
@@ -18,6 +19,7 @@ module PGTrunk
     require_relative "operations/foreign_keys"
     require_relative "operations/procedures"
     require_relative "operations/triggers"
+    require_relative "operations/rules"
     require_relative "operations/statistics"
   end
 end

data/lib/pg_trunk/version.rb

@@ -2,5 +2,5 @@
 
 module PGTrunk
   # @private
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/pg_trunk.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.files = `git ls-files -z`.split("\x0")
-  spec.test_files = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord", ">= 4.0.0"

data/spec/operations/rules/create_rule_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#create_rule" do
+  before_all do
+    run_migration <<~RUBY
+      create_table :users do |t|
+        t.string :name
+      end
+
+      create_table :user_updates do |t|
+        t.timestamps
+      end
+    RUBY
+  end
+
+  context "with a minimal definition" do
+    let(:migration) do
+      <<~RUBY
+        create_rule "users", "prevent_insertion" do |r|
+          r.event :insert
+          r.kind :instead
+          r.comment "Prevent insertion to users"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "with a commands definition" do
+    let(:migration) do
+      <<~RUBY
+        create_rule "users", "count_updates" do |r|
+          r.event :update
+          r.command <<~Q.chomp
+            INSERT INTO user_updates (created_at) VALUES (now())
+          Q
+          r.comment "Count updates of users"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "without an explicit name of the rule" do
+    let(:migration) do
+      <<~RUBY
+        create_rule "users" do |r|
+          r.event :update
+          r.command <<~Q.chomp
+            INSERT INTO user_updates (created_at) VALUES (now())
+          Q
+          r.comment "Count updates of users"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(migration).into_schema }
+    its(:inversion) { is_expected.not_to change_schema }
+  end
+
+  context "with the `replace_existing: true` option" do
+    let(:migration) do
+      <<~RUBY
+        create_rule "users", replace_existing: true do |r|
+          r.event :update
+          r.command <<~Q.chomp
+            INSERT INTO user_updates (created_at) VALUES (now());
+          Q
+          r.comment "Count updates of users"
+        end
+      RUBY
+    end
+    let(:snippet) do
+      <<~RUBY
+        create_rule "users" do |r|
+          r.event :update
+          r.command <<~Q.chomp
+            INSERT INTO user_updates (created_at) VALUES (now())
+          Q
+          r.comment "Count updates of users"
+        end
+      RUBY
+    end
+
+    its(:execution) { is_expected.to insert(snippet).into_schema }
+    it { is_expected.to be_irreversible.because_of(/replace_existing: true/i) }
+  end
+
+  context "without an event" do
+    let(:migration) do
+      <<~RUBY
+        create_rule "users" do |r|
+          r.kind :instead
+          r.comment "Prevent insertion to users"
+        end
+      RUBY
+    end
+
+    it { is_expected.to fail_validation.because(/event can't be blank/i) }
+  end
+
+  context "without a table" do
+    let(:migration) do
+      <<~RUBY
+        create_rule do |r|
+          r.event :insert
+          r.kind :instead
+          r.comment "Prevent insertion to users"
+        end
+      RUBY
+    end
+
+    it { is_expected.to fail_validation.because(/table can't be blank/i) }
+  end
+end

data/spec/operations/rules/drop_rule_spec.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+describe ActiveRecord::Migration, "#drop_rule" do
+  before_all do
+    run_migration <<~RUBY
+      create_table :users do |t|
+        t.string :name
+      end
+    RUBY
+  end
+  before { run_migration(snippet) }
+
+  context "when a rule was named" do
+    let(:snippet) do
+      <<~RUBY
+        create_rule "users", "prevent_insertion" do |r|
+          r.event :insert
+          r.kind :instead
+          r.comment "Prevent insertion to users"
+        end
+      RUBY
+    end
+
+    context "with a full definition" do
+      let(:migration) do
+        <<~RUBY
+          drop_rule "users", "prevent_insertion" do |r|
+            r.event :insert
+            r.kind :instead
+            r.comment "Prevent insertion to users"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "with a name only" do
+      let(:migration) do
+        <<~RUBY
+          drop_rule "users", "prevent_insertion"
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      it { is_expected.to be_irreversible.because(/event can't be blank/i) }
+    end
+
+    context "with if_exists: true option" do
+      let(:migration) do
+        <<~RUBY
+          drop_rule "users", "prevent_insertion", if_exists: true do |r|
+            r.event :insert
+            r.kind :instead
+            r.comment "Prevent insertion to users"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      it { is_expected.to be_irreversible.because_of(/if_exists: true/i) }
+    end
+
+    context "with force: :cascade option" do
+      let(:migration) do
+        <<~RUBY
+          drop_rule "users", "prevent_insertion", force: :cascade do |r|
+            r.event :insert
+            r.kind :instead
+            r.comment "Prevent insertion to users"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      it { is_expected.to be_irreversible.because_of(/force: :cascade/i) }
+    end
+  end
+
+  context "when a rule was anonymous" do
+    let(:snippet) do
+      <<~RUBY
+        create_rule "users" do |r|
+          r.event :insert
+          r.kind :instead
+          r.comment "Prevent insertion to users"
+        end
+      RUBY
+    end
+
+    context "with a full definition" do
+      let(:migration) do
+        <<~RUBY
+          drop_rule "users" do |r|
+            r.event :insert
+            r.kind :instead
+            r.comment "Prevent insertion to users"
+          end
+        RUBY
+      end
+
+      its(:execution) { is_expected.to remove(snippet).from_schema }
+      its(:inversion) { is_expected.not_to change_schema }
+    end
+
+    context "with a table only" do
+      let(:migration) do
+        <<~RUBY
+          drop_rule "users"
+        RUBY
+      end
+
+      it { is_expected.to fail_validation.because(/name can't be blank/i) }
+    end
+  end
+end