pg_trunk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27719617c7b0d1c1fbd927d07012f218a48a6a02183334766f4defde22c3a7eb
-  data.tar.gz: 8c1d90a98ea419a38a1f0971c5d122432488e7677872c79f637e3d99c93e9a85
+  metadata.gz: 7e7e7834f9f7da413371ea11262161da230fab549707bad615f3d5ab4ad9b19c
+  data.tar.gz: 14084be1a484bd0a7201f33d680546a1bba2ff8e5b34bc59aa3f3597f5d48c87
 SHA512:
-  metadata.gz: 787ec0229602b9abf5d31e684175a44dd5dfb3c4ccb449dc3145eee365bed8e0ac0c7c8f18def6251b0fa2c51ea550cf2ae204b22a63bd1c347c03938376cf11
-  data.tar.gz: 46bf35d7204f8497622168743cbd1ade98d63802d33f5634109df45b2e25d34f070922c2d00dd45926e033f066f9b0fe412bbe7257a1af14a8f38eb9abd6c459
+  metadata.gz: 056da9038cee7e60551a7b1ddb3cf990fe6a0eaeee95b48b95b38babd777ec97e9cce2564e3c1e1dbcd13a30072360beb87a0f20f48c152b2080997e0e489cd6
+  data.tar.gz: c83b7f738860de782e7cf407cfdbcd71fbfe3e3c5f995aa3a4fcdc7643e9a000f69eeca02b4c025e4219f5ecf19fb24781704e4fc8524944c7e11a9bc18f355e

data/CHANGELOG.md

@@ -4,9 +4,13 @@ The noteworthy changes for each PGTrunk version are included here.
 The format is based on [Keep a Changelog] and this project adheres to [Semantic Versioning].
 For a complete changelog, see the [commits] for each version via the version links.
 
+## [0.1.2] (2022-01-17)
+
+* Fix registry of custom types (nepalez)
+
 ## [0.1.1] (2022-01-16)
 
-* Fix inline documentation for methods added to ActiveRecord::Migration
+* Fix inline documentation for methods added to ActiveRecord::Migration (nepalez)
 
 ## [0.1.0] (2022-01-14)
 

data/README.md

@@ -88,7 +88,7 @@ The gem is targeted to support PostgreSQL-specific features, that's why we won't
 ## Documentation
 
 The gem provides a lot of additional methods to create, rename, change a drop various objects.
-You can find the necessary details in the gem's [wiki].
+You can find the necessary details [here](https://rubydoc.info/gems/pg_trunk/ActiveRecord/Migration).
 
 ## Installation
 

data/lib/pg_trunk/core/railtie/custom_types.rb

@@ -12,22 +12,21 @@ module PGTrunk
     end
 
     def enable_pg_trunk_types
-      execute(<<~SQL).each { |item| enable_pg_trunk_type item["name"] }
+      execute(<<~SQL).each { |item| enable_pg_trunk_type(**item.symbolize_keys) }
         SELECT (
           CASE
           WHEN t.typnamespace = 'public'::regnamespace THEN t.typname
           ELSE t.typnamespace::regnamespace || '.' || t.typname
           END
-        ) AS name
+        ) AS name, t.oid
         FROM pg_trunk e JOIN pg_type t ON t.oid = e.oid
         WHERE e.classid = 'pg_type'::regclass
       SQL
     end
 
-    def enable_pg_trunk_type(type)
-      type = type.to_s
-      CustomTypes.known << type
-      type_map.register_type(type, TYPE.new(type)) unless type_map.key?(type)
+    def enable_pg_trunk_type(oid:, name:)
+      CustomTypes.known << name
+      type_map.register_type(oid.to_i, TYPE.new(name.to_s))
     end
 
     def valid_type?(type)

data/lib/pg_trunk/operations/check_constraints/add_check_constraint.rb

@@ -15,24 +15,30 @@
 #     #
 #     # The name of the new constraint can be set explicitly
 #     #
-#     #   add_check_constraint :users, "length(phone) > 10",
-#     #                        name: "phone_is_long_enough",
-#     #                        inherit: false,
-#     #                        comment: "Phone is 10+ chars long"
+#     # ```ruby
+#     # add_check_constraint :users, "length(phone) > 10",
+#     #                      name: "phone_is_long_enough",
+#     #                      inherit: false,
+#     #                      comment: "Phone is 10+ chars long"
+#     # ```
 #     #
 #     # The name can also be skipped (it will be generated by default):
 #     #
-#     #   add_check_constraint :users, "length(phone) > 1"
+#     # ```ruby
+#     # add_check_constraint :users, "length(phone) > 1"
+#     # ```
 #     #
 #     # The block syntax can be used for any argument as usual:
 #     #
-#     #   add_check_constraint do |c|
-#     #     c.table "users"
-#     #     c.expression "length(phone) > 10"
-#     #     c.name "phone_is_long_enough"
-#     #     c.inherit false
-#     #     c.comment "Phone is 10+ chars long"
-#     #   end
+#     # ```ruby
+#     # add_check_constraint do |c|
+#     #   c.table "users"
+#     #   c.expression "length(phone) > 10"
+#     #   c.name "phone_is_long_enough"
+#     #   c.inherit false
+#     #   c.comment "Phone is 10+ chars long"
+#     # end
+#     # ```
 #     #
 #     # The operation is always reversible.
 #     def add_check_constraint(table, expression = nil, **options, &block); end

data/lib/pg_trunk/operations/check_constraints/drop_check_constraint.rb

@@ -18,27 +18,35 @@
 #     #
 #     # The constraint can be identified by the table and explicit name
 #     #
-#     #   drop_check_constraint :users, name: "phone_is_long_enough"
+#     # ```ruby
+#     # drop_check_constraint :users, name: "phone_is_long_enough"
+#     # ```
 #     #
 #     # Alternatively the name can be got from the expression.
 #     # Be careful! the expression must have exactly the same form
 #     # as stored in the database:
 #     #
-#     #   drop_check_constraint :users, "length((phone::text) > 10)"
+#     # ```ruby
+#     # drop_check_constraint :users, "length((phone::text) > 10)"
+#     # ```
 #     #
 #     # To made operation reversible the expression must be provided:
 #     #
-#     #   drop_check_constraint "users" do |c|
-#     #     c.expression "length((phone::text) > 10)"
-#     #     c.inherit false
-#     #     c.comment "The phone is 10+ chars long"
-#     #   end
+#     # ```ruby
+#     # drop_check_constraint "users" do |c|
+#     #   c.expression "length((phone::text) > 10)"
+#     #   c.inherit false
+#     #   c.comment "The phone is 10+ chars long"
+#     # end
+#     # ```
 #     #
 #     # The operation can be called with `if_exists` option.
 #     #
-#     #   drop_check_constraint :users,
-#     #                         name: "phone_is_long_enough",
-#     #                         if_exists: true
+#     # ```ruby
+#     # drop_check_constraint :users,
+#     #                       name: "phone_is_long_enough",
+#     #                       if_exists: true
+#     # ```
 #     #
 #     # In this case the operation is always irreversible due to
 #     # uncertainty of the previous state of the database.

data/lib/pg_trunk/operations/check_constraints/rename_check_constraint.rb

@@ -14,21 +14,27 @@
 #     #
 #     # A constraint can be identified by the table and explicit name
 #     #
-#     #   rename_check_constraint :users,
-#     #                           name: "phone_is_long_enough",
-#     #                           to: "phones.long_enough"
+#     # ```ruby
+#     # rename_check_constraint :users,
+#     #                         name: "phone_is_long_enough",
+#     #                         to: "phones.long_enough"
+#     # ```
 #     #
 #     # Alternatively the name can be got from the expression.
 #     # Be careful! the expression must have exactly the same form
 #     # as stored in the database:
 #     #
-#     #   rename_check_constraint :users, "length((phone::text) > 10)",
-#     #                           to: "long_enough"
+#     # ```ruby
+#     # rename_check_constraint :users, "length((phone::text) > 10)",
+#     #                         to: "long_enough"
+#     # ```
 #     #
 #     # The name can be reset to auto-generated when
 #     # the `:to` option is missed or blank:
 #     #
-#     #   rename_check_constraint :users, "phone_is_long_enough"
+#     # ```ruby
+#     # rename_check_constraint :users, "phone_is_long_enough"
+#     # ```
 #     #
 #     # The operation is always reversible.
 #     def rename_check_constraint(table, expression = nil, **options, &block); end

data/lib/pg_trunk/operations/check_constraints/validate_check_constraint.rb

@@ -13,13 +13,17 @@
 #     #
 #     # The invalid constraint can be identified by table and explicit name:
 #     #
-#     #   validate_check_constraint :users, name: "phone_is_long_enough"
+#     # ```ruby
+#     # validate_check_constraint :users, name: "phone_is_long_enough"
+#     # ```
 #     #
 #     # Alternatively it can be specified by expression. In this case
 #     # you must ensure the expression has the same form as it is stored
 #     # in the database (after parsing the source).
 #     #
-#     #   validate_check_constraint :users, "length((phone::text) > 10)"
+#     # ```ruby
+#     # validate_check_constraint :users, "length((phone::text) > 10)"
+#     # ```
 #     #
 #     # Notice that it is invertible but the inverted operation does nothing.
 #     def validate_check_constraint(table, expression = nil, **options, &block); end

data/lib/pg_trunk/operations/composite_types/change_composite_type.rb

@@ -16,30 +16,36 @@
 #     #
 #     # Providing a type "paint.colored_point":
 #     #
-#     #   create_composite_type "paint.colored_point" do |t|
-#     #     t.column "color", "text", collation: "en_US"
-#     #     t.column "x", "integer"
-#     #     t.column "z", "integer"
-#     #   end
+#     # ```ruby
+#     # create_composite_type "paint.colored_point" do |t|
+#     #   t.column "color", "text", collation: "en_US"
+#     #   t.column "x", "integer"
+#     #   t.column "z", "integer"
+#     # end
+#     # ```
 #     #
 #     # After the following change:
 #     #
-#     #   change_composite_type "paint.colored_point" do |t|
-#     #     t.change_column "color", "text", collation: "ru_RU", from_collation: "en_US"
-#     #     t.change_column "x", "bigint", from_type: "integer"
-#     #     t.drop_column "z", "integer"
-#     #     t.add_column "Y", "bigint"
-#     #     t.rename_column "x", to: "X"
-#     #     t.comment "2D point with a color", from: "2D point"
-#     #   end
+#     # ```ruby
+#     # change_composite_type "paint.colored_point" do |t|
+#     #   t.change_column "color", "text", collation: "ru_RU", from_collation: "en_US"
+#     #   t.change_column "x", "bigint", from_type: "integer"
+#     #   t.drop_column "z", "integer"
+#     #   t.add_column "Y", "bigint"
+#     #   t.rename_column "x", to: "X"
+#     #   t.comment "2D point with a color", from: "2D point"
+#     # end
+#     # ```
 #     #
 #     # The definition became:
 #     #
-#     #   create_composite_type "paint.colored_point" do |t|
-#     #     t.column "color", "text", collation: "ru_RU"
-#     #     t.column "X", "bigint"
-#     #     t.column "Y", "integer"
-#     #   end
+#     # ```ruby
+#     # create_composite_type "paint.colored_point" do |t|
+#     #   t.column "color", "text", collation: "ru_RU"
+#     #   t.column "X", "bigint"
+#     #   t.column "Y", "integer"
+#     # end
+#     # ```
 #     #
 #     # Notice, that all renames will be done AFTER other changes,
 #     # so in `change_column` you should use the old names.

data/lib/pg_trunk/operations/composite_types/create_composite_type.rb

@@ -10,15 +10,16 @@
 #     # @yieldparam Object receiver of methods specifying the type
 #     # @return [void]
 #     #
-#     # @example
-#     #   create_composite_type "paint.colored_point" do |d|
-#     #     d.column "x", "integer"
-#     #     d.column "y", "integer"
-#     #     d.column "color", "text", collation: "en_US"
-#     #     d.comment <<~COMMENT
-#     #       2D point with color
-#     #     COMMENT
-#     #   end
+#     # ```ruby
+#     # create_composite_type "paint.colored_point" do |d|
+#     #   d.column "x", "integer"
+#     #   d.column "y", "integer"
+#     #   d.column "color", "text", collation: "en_US"
+#     #   d.comment <<~COMMENT
+#     #     2D point with color
+#     #   COMMENT
+#     # end
+#     # ```
 #     #
 #     # It is always reversible.
 #     def create_composite_type(name, **options, &block); end

data/lib/pg_trunk/operations/composite_types/drop_composite_type.rb

@@ -12,39 +12,41 @@
 #     # @yieldparam Object receiver of methods specifying the type
 #     # @return [void]
 #     #
-#     # The operation drops a composite_type type identified by its
-#     # qualified name (it can include a schema).
+#     # The operation drops a composite_type type identified by its qualified name (it can include a schema).
 #     #
-#     # For inversion use the same options as in the
-#     # `create_composite_type` operation.
+#     # For inversion use the same options as in the `create_composite_type` operation.
 #     #
-#     #   drop_composite_type "paint.colored_point" do |d|
-#     #     d.column "x", "integer"
-#     #     d.column "y", "integer"
-#     #     d.column "color", "text", collation: "en_US"
-#     #     d.comment <<~COMMENT
-#     #       2D point with color
-#     #     COMMENT
-#     #   end
+#     # ```ruby
+#     # drop_composite_type "paint.colored_point" do |d|
+#     #   d.column "x", "integer"
+#     #   d.column "y", "integer"
+#     #   d.column "color", "text", collation: "en_US"
+#     #   d.comment <<~COMMENT
+#     #     2D point with color
+#     #   COMMENT
+#     # end
+#     # ```
 #     #
 #     # Notice, that the composite type creation can use no attributes.
-#     # That's why dropping it is always reversible; though the reversion
-#     # would provide a type without columns:
+#     # That's why dropping it is always reversible; though the reversion provides a type without columns:
 #     #
-#     #   drop_composite_type "paint.colored_point"
+#     # ```ruby
+#     # drop_composite_type "paint.colored_point"
+#     # ```
 #     #
-#     # With the `force: :cascade` option the operation would remove
-#     # all objects using the type.
+#     # With the `force: :cascade` option the operation removes all objects using the type.
 #     #
-#     #   drop_composite_type "paint.colored_point", force: :cascade
+#     # ```ruby
+#     # drop_composite_type "paint.colored_point", force: :cascade
+#     # ```
 #     #
-#     # With the `if_exists: true` option the operation won't fail
-#     # even when the view was absent in the database.
+#     # With the `if_exists: true` option the operation won't fail even when the view was absent.
 #     #
-#     #   drop_composite_type "paint.colored_point", if_exists: true
+#     # ```ruby
+#     # drop_composite_type "paint.colored_point", if_exists: true
+#     # ```
 #     #
-#     # Both options make a migration irreversible due to uncertainty
-#     # of the previous state of the database.
+#     # Both options make a migration irreversible due to uncertainty of the previous state of the database.
 #     def drop_composite_type(name, **options, &block); end
 #   end
 module PGTrunk::Operations::CompositeTypes

data/lib/pg_trunk/operations/composite_types/rename_composite_type.rb

@@ -8,9 +8,9 @@
 #     # @option [#to_s] :to (nil) The new qualified name for the type
 #     # @return [void]
 #     #
-#     # @example
-#     #
-#     #   rename_composite_type "point", to: "paint.colored_point"
+#     # ```ruby
+#     # rename_composite_type "point", to: "paint.colored_point"
+#     # ```
 #     #
 #     # The operation is always reversible.
 #     def rename_composite_type(name, to:); end

data/lib/pg_trunk/operations/domains/change_domain.rb

@@ -13,22 +13,24 @@
 #     # modify the default_sql value, or the description of the domain type.
 #     # Neither the underlying type nor the collation can be changed.
 #     #
-#     #   change_domain "dict.us_postal_code" do |d|
-#     #     d.null true # from: false
-#     #     # check is added for inversion
-#     #     d.drop_constraint "postal_code_length", check: <<~SQL
-#     #       length(VALUE) > 3 AND length(VALUE) < 6
-#     #     SQL
-#     #     d.add_constraint <<~SQL, name: "postal_code_valid"
-#     #       VALUE ~ '^\d{5}$' OR VALUE ~ '^\d{5}-\d{4}$'
-#     #     SQL
-#     #     d.default_sql "'00000'::text", from: "'0000'::text"
-#     #     d.comment <<~COMMENT, from: <<~COMMENT
-#     #       Supported currencies
-#     #     COMMENT
-#     #       Currencies
-#     #     COMMENT
-#     #   end
+#     # ```ruby
+#     # change_domain "dict.us_postal_code" do |d|
+#     #   d.null true # from: false
+#     #   # check is added for inversion
+#     #   d.drop_constraint "postal_code_length", check: <<~SQL
+#     #     length(VALUE) > 3 AND length(VALUE) < 6
+#     #   SQL
+#     #   d.add_constraint <<~SQL, name: "postal_code_valid"
+#     #     VALUE ~ '^\d{5}$' OR VALUE ~ '^\d{5}-\d{4}$'
+#     #   SQL
+#     #   d.default_sql "'00000'::text", from: "'0000'::text"
+#     #   d.comment <<~COMMENT, from: <<~COMMENT
+#     #     Supported currencies
+#     #   COMMENT
+#     #     Currencies
+#     #   COMMENT
+#     # end
+#     # ```
 #     #
 #     # Use blank string (not a `nil` value) to reset either a default_sql,
 #     # or the comment. `nil`-s here will be ignored.
@@ -41,14 +43,15 @@
 #     # has `if_exists: true` or `force: :cascade` option -- due to
 #     # uncertainty of the previous state of the database:
 #     #
-#     #   # Irreversible change
-#     #   change_domain "dict.us_postal_code", force: :cascade do |d|
-#     #     d.drop_constraint "postal_code_valid" # missed `:check` option
-#     #     d.drop_constraint "postal_code_length"
-#     #     d.drop_constraint "postal_code_format", if_exists: true
-#     #     d.default_sql "'0000'::text" # missed `:from` option
-#     #     d.comment "New comment" # missed `:from` option
-#     #   end
+#     # ```ruby
+#     # change_domain "dict.us_postal_code", force: :cascade do |d|
+#     #   d.drop_constraint "postal_code_valid" # missed `:check` option
+#     #   d.drop_constraint "postal_code_length"
+#     #   d.drop_constraint "postal_code_format", if_exists: true
+#     #   d.default_sql "'0000'::text" # missed `:from` option
+#     #   d.comment "New comment" # missed `:from` option
+#     # end
+#     # ```
 #     def change_domain(name, &block); end
 #   end
 module PGTrunk::Operations::Domains

data/lib/pg_trunk/operations/domains/create_domain.rb

@@ -14,17 +14,17 @@
 #     # @yieldparam Object receiver of methods specifying the type
 #     # @return [void]
 #     #
-#     # @example:
-#     #
-#     #   create_domain "dict.us_postal_code", as: "text" do |d|
-#     #     d.collation "en_US"
-#     #     d.default_sql "'0000'::text"
-#     #     d.null false
-#     #     d.constraint <<~SQL, name: "code_valid"
-#     #       VALUE ~ '^\d{5}$' OR VALUE ~ '^\d{5}-\d{4}$'
-#     #     SQL
-#     #     d.comment "US postal code"
-#     #   end
+#     # ```ruby
+#     # create_domain "dict.us_postal_code", as: "text" do |d|
+#     #   d.collation "en_US"
+#     #   d.default_sql "'0000'::text"
+#     #   d.null false
+#     #   d.constraint <<~SQL, name: "code_valid"
+#     #     VALUE ~ '^\d{5}$' OR VALUE ~ '^\d{5}-\d{4}$'
+#     #   SQL
+#     #   d.comment "US postal code"
+#     # end
+#     # ```
 #     #
 #     # It is always reversible.
 #     def create_domain(name, **options, &block); end

data/lib/pg_trunk/operations/domains/drop_domain.rb

@@ -15,31 +15,37 @@
 #     # @yieldparam Object receiver of methods specifying the type
 #     # @return [void]
 #     #
-#     # @example:
-#     #
-#     #   drop_domain "dict.us_postal_code"
+#     # ```ruby
+#     # drop_domain "dict.us_postal_code"
+#     # ```
 #     #
 #     # To make the operation invertible, use the same options
 #     # as in the `create_domain` operation.
 #     #
-#     #   drop_domain "dict.us_postal_code", as: "string" do |d|
-#     #     d.constraint <<~SQL, name: "code_valid"
-#     #       VALUE ~ '^\d{5}$' OR VALUE ~ '^\d{5}-\d{4}$'
-#     #     SQL
-#     #     d.comment <<~COMMENT
-#     #       US postal code
-#     #     COMMENT
-#     #   end
+#     # ```ruby
+#     # drop_domain "dict.us_postal_code", as: "string" do |d|
+#     #   d.constraint <<~SQL, name: "code_valid"
+#     #     VALUE ~ '^\d{5}$' OR VALUE ~ '^\d{5}-\d{4}$'
+#     #   SQL
+#     #   d.comment <<~COMMENT
+#     #     US postal code
+#     #   COMMENT
+#     # end
+#     # ```
 #     #
 #     # With the `force: :cascade` option the operation would remove
 #     # all the objects that use the type.
 #     #
-#     #   drop_domain "dict.us_postal_code", force: :cascade
+#     # ```ruby
+#     # drop_domain "dict.us_postal_code", force: :cascade
+#     # ```
 #     #
 #     # With the `if_exists: true` option the operation won't fail
 #     # even when the view was absent in the database.
 #     #
-#     #   drop_domain "dict.us_postal_code", if_exists: true
+#     # ```ruby
+#     # drop_domain "dict.us_postal_code", if_exists: true
+#     # ```
 #     #
 #     # Both options make a migration irreversible due to uncertainty
 #     # of the previous state of the database.

data/lib/pg_trunk/operations/domains/rename_domain.rb

@@ -10,7 +10,9 @@
 #     #
 #     # A domain type can be both renamed and moved to another schema.
 #     #
-#     #   rename_domain "us_code", to: "dict.us_postal_code"
+#     # ```ruby
+#     # rename_domain "us_code", to: "dict.us_postal_code"
+#     # ```
 #     #
 #     # The operation is always reversible.
 #     def rename_domain(name, to:); end

data/lib/pg_trunk/operations/enums/change_enum.rb

@@ -12,17 +12,19 @@
 #     # The operation can be used to rename or add values to the
 #     # enumerated type. The commend can be changed as well.
 #     #
-#     #   change_enum "currencies" do |e|
-#     #     e.add_value "EUR", after: "BTC"
-#     #     e.add_value "GBP", before: "usd"
-#     #     e.add_value "JPY" # to the end of the list
-#     #     e.rename_value "usd", to: "USD"
-#     #     e.comment <<~COMMENT, from: <<~COMMENT
-#     #       Supported currencies
-#     #     COMMENT
-#     #       Currencies
-#     #     COMMENT
-#     #   end
+#     # ```ruby
+#     # change_enum "currencies" do |e|
+#     #   e.add_value "EUR", after: "BTC"
+#     #   e.add_value "GBP", before: "usd"
+#     #   e.add_value "JPY" # to the end of the list
+#     #   e.rename_value "usd", to: "USD"
+#     #   e.comment <<~COMMENT, from: <<~COMMENT
+#     #     Supported currencies
+#     #   COMMENT
+#     #     Currencies
+#     #   COMMENT
+#     # end
+#     # ```
 #     #
 #     # Please, keep in mind that all values will be added before
 #     # the first rename. That's why you should use old values

data/lib/pg_trunk/operations/enums/create_enum.rb

@@ -11,15 +11,15 @@
 #     # @yieldparam Object receiver of methods specifying the type
 #     # @return [void]
 #     #
-#     # @example
-#     #
-#     #   create_enum "finances.currency" do |e|
-#     #     e.values "BTC", "EUR", "GBP", "USD"
-#     #     e.value "JPY" # the alternative way to add a value to the tail
-#     #     e.comment <<~COMMENT
-#     #       The list of values for supported currencies.
-#     #     COMMENT
-#     #   end
+#     # ```ruby
+#     # create_enum "finances.currency" do |e|
+#     #   e.values "BTC", "EUR", "GBP", "USD"
+#     #   e.value "JPY" # the alternative way to add a value to the tail
+#     #   e.comment <<~COMMENT
+#     #     The list of values for supported currencies.
+#     #   COMMENT
+#     # end
+#     # ```
 #     #
 #     # It is always reversible.
 #     def create_enum(name, **options, &block); end