pg_trunk 0.1.0 → 0.1.1

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

@@ -1,51 +1,54 @@
 # 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 [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 [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`:
+#     #
+#     #   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"
+#     #   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.
+#     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,55 @@
 # 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 [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 [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).
+#     #
+#     #   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"
+#     #   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.
+#     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,28 @@
 # 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 [#to_s] :to (nil) The new qualified name for the view
+#     # @option [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.
+#     #
+#     #   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.
+#     def rename_view(name, **options); end
+#   end
 module PGTrunk::Operations::Views
   # @private
   class RenameView < Base

data/lib/pg_trunk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pg_trunk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord