postgresql_adapter_extensions 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd87ca1ccdc1fede8e8b7ef90eacff3ba354b36917313100d53057e120801eeb
-  data.tar.gz: 687551a9e6dfa33f62ccca04d7baf365084372a6f45621f8eb6c4b436de72d60
+  metadata.gz: fedbb03323e871885e04d3799efbdbae9f5f058acc2148ed2e5005a273bedf9f
+  data.tar.gz: 73bfe4528be9a2a28395fe40ee40e920052058b5a1a1276fe58c4bb857e57bbf
 SHA512:
-  metadata.gz: a51140bd27d50bcfb9818dfe861e32e6b04ce15391af9982f817489af66b0dac65dab04da0feac9ba17694e9579ca0f1e16710b9b54663e3f575261a62d93124
-  data.tar.gz: 01d16059bdcab91eba009cd6c644c17e8aa908d2ace1d0c2cb20d28f0260a8c92a119e0ad0331aae38b07bdd56e71630fc239591170ab847531a8cf1d4540458
+  metadata.gz: e3e30ccebbbbc5eae45c6daa70d953a8479ce2fecfeedb46c5e545be614e8c5080ec48c99057d2e4fefc668e7775cb9d9bac187401e1637a47cefefd092d244b
+  data.tar.gz: c2c2a06aedbcaa1d1ebef70fcb61d411ad81f8d5d787b24a43a60a7f2f8c84ffab48be36531f3147a859c807edd78d094a9a689fb8be54b810ac826a827ab3e5

data/CHANGELOG.md

@@ -1,25 +1,46 @@
-## [1.0.0](https://github.com/shivam091/postgresql_adapter_extensions/compare/v0.1.0...v1.0.0) - 2025-03-12
+## [1.2.0](https://github.com/shivam091/postgresql_adapter_extensions/compare/v1.1.0...v1.2.0) - 2025-03-27
 
 ### What's new
 
-- Added `create_sequence` method
+#### PostgreSQLAdapterExtensions::SequenceMethods
+- Added `rename_sequence` method to rename a PostgreSQL sequences with optional IF EXISTS.
 
-  Allows creating PostgreSQL sequences with customizable options such as start value, increment step, min/max values, caching, cycling, and ownership.
+#### PostgreSQLAdapterExtensions::CommandRecorder
+- Added `rename_sequence` method to record sequence rename in migrations.
+- Implemented `invert_rename_sequence` to allow rollback by renaming the sequence back to its previous name.
 
-- Added `alter_sequence` method
+### Notes
+- `rename_sequence` can be reversed by renaming the sequence back to its previous name.
 
-  Enables modifying existing PostgreSQL sequences, supporting changes to increment steps, restart values, min/max limits, caching, cycling behavior, and ownership.
+## [1.1.0](https://github.com/shivam091/postgresql_adapter_extensions/compare/v1.0.0...v1.1.0) - 2025-03-21
 
-- Added `drop_sequence` method
+### What's new
 
-  Provides functionality to remove a PostgreSQL sequence with optional IF EXISTS and CASCADE/RESTRICT behaviors to manage dependencies.
+#### PostgreSQLAdapterExtensions::CommandRecorder
+- Added `create_sequence` method to record sequence creation in migrations.
+- Added `alter_sequence` method to record sequence alterations (irreversible).
+- Added `drop_sequence` method to record sequence deletions (irreversible).
+- Implemented `invert_create_sequence` to allow rollback by dropping the sequence.
+- Implemented `invert_alter_sequence` and `invert_drop_sequence` to raise `ActiveRecord::IrreversibleMigration`.
 
-----------
+### Notes
+- `create_sequence` can be reversed by dropping the sequence.
+- `alter_sequence` and `drop_sequence` are irreversible operations.
 
-## 0.1.0 - 2025-03-11
+## [1.0.0](https://github.com/shivam091/postgresql_adapter_extensions/compare/v0.1.0...v1.0.0) - 2025-03-12
 
-### Initial release
+### What's new
 
------------
+#### PostgreSQLAdapterExtensions::SequenceMethods
+- Added `create_sequence` method to allow creating PostgreSQL sequences with customizable options such as
+  start value, increment step, min/max values, caching, cycling, and ownership.
 
-### Unreleased
+- Added `alter_sequence` method to enable modifying existing PostgreSQL sequences, supporting changes to
+  increment steps, restart values, min/max limits, caching, cycling behavior, and ownership.
+
+- Added `drop_sequence` method to provides functionality to remove a PostgreSQL sequence with optional
+  IF EXISTS and CASCADE/RESTRICT behaviors to manage dependencies.
+
+## 0.1.0 - 2025-03-11
+
+### Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    postgresql_adapter_extensions (1.0.0)
+    postgresql_adapter_extensions (1.2.0)
       activerecord (~> 8)
       pg (~> 1.5)
 

data/README.md

@@ -121,8 +121,8 @@ alter_sequence(:order_id_seq, cycle: false)
 alter_sequence(:order_id_seq, owned_by: "orders.id")
 ```
 
-This method provides flexibility in managing sequences dynamically in your Rails application,
- ensuring that sequence-related database behavior can be modified as needed.
+This method provides flexibility in managing sequences dynamically in your Rails
+application, ensuring that sequence-related database behavior can be modified as needed.
 
 ### drop_sequence
 
@@ -156,6 +156,26 @@ drop_sequence(:order_id_seq, drop_behavior: :cascade)
 drop_sequence(:order_id_seq, drop_behavior: :restrict)
 ```
 
+### rename_sequence
+
+The `rename_sequence` method allows you to rename an existing sequence in your PostgreSQL database.
+
+```ruby
+rename_sequence(name, options = {})
+```
+
+**Rename a sequence:**
+
+```ruby
+rename_sequence(:order_id_seq, to: :new_order_id_seq)
+```
+
+**Rename a sequence only if it exists:**
+
+```ruby
+rename_sequence(:order_id_seq, to: :new_order_id_seq, if_exists: true)
+```
+
 ## PostgreSQL Setup for Contributors
 
 If you're contributing to this gem and need to set up PostgreSQL for local development or testing,

data/lib/postgresql_adapter_extensions/base.rb

@@ -5,6 +5,7 @@
 require "active_record"
 require "active_record/connection_adapters/postgresql_adapter"
 
+require "postgresql_adapter_extensions/command_recorder"
 require "postgresql_adapter_extensions/sequence_methods"
 
 module PostgreSQLAdapterExtensions
@@ -20,4 +21,7 @@ module PostgreSQLAdapterExtensions
     ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(SequenceMethods)
   end
 
+  if defined?(ActiveRecord::Migration::CommandRecorder)
+    ActiveRecord::Migration::CommandRecorder.include(CommandRecorder)
+  end
 end

data/lib/postgresql_adapter_extensions/command_recorder.rb

@@ -0,0 +1,152 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+module PostgreSQLAdapterExtensions
+  ##
+  # Module that extends ActiveRecord's CommandRecorder to handle sequence-related commands.
+  #
+  # This module is designed to work with reversible migrations in ActiveRecord, specifically to manage PostgreSQL sequence operations.
+  # The methods capture forward migration commands for sequences and generate their inverse using simple metaprogramming.
+  #
+  # @example
+  #   class AddSomeSequence < ActiveRecord::Migration[6.0]
+  #     def change
+  #       create_sequence :some_sequence
+  #     end
+  #   end
+  #
+  # This will create a sequence, and during rollback, it will drop the sequence.
+  #
+  # @see ActiveRecord::Migration::CommandRecorder
+  #
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.0.0
+  #
+  module CommandRecorder
+    ##
+    # Records the creation of a PostgreSQL sequence during a migration.
+    #
+    # This method is invoked when creating a sequence in the database. The corresponding
+    # inverse operation will be to drop the sequence during rollback.
+    #
+    # @param args [Array] Arguments required to create the sequence (usually the sequence name).
+    # @param block [Proc] An optional block passed to the command.
+    # @return [void]
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
+    def create_sequence(*args, &block)
+      record(:create_sequence, args, &block)
+    end
+
+    ##
+    # Records the alteration of a PostgreSQL sequence during a migration.
+    #
+    # This method is invoked when altering a sequence in the database.
+    # The corresponding inverse operation is not possible, so it will raise an error during rollback.
+    #
+    # @param args [Array] Arguments required to alter the sequence.
+    # @param block [Proc] An optional block passed to the command.
+    # @raise [ActiveRecord::IrreversibleMigration] When attempting to rollback an altered sequence.
+    # @return [void]
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
+    def alter_sequence(*args, &block)
+      record(:alter_sequence, args, &block)
+    end
+
+    ##
+    # Records the dropping of a PostgreSQL sequence during a migration.
+    #
+    # This method is invoked when dropping a sequence from the database.
+    # The corresponding inverse operation is not possible, so it will raise an error during rollback.
+    #
+    # @param args [Array] Arguments required to drop the sequence (usually the sequence name).
+    # @param block [Proc] An optional block passed to the command.
+    # @raise [ActiveRecord::IrreversibleMigration] When attempting to rollback a dropped sequence.
+    # @return [void]
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
+    def drop_sequence(*args, &block)
+      record(:drop_sequence, args, &block)
+    end
+
+    ##
+    # Records the renaming of a PostgreSQL sequence during a migration.
+    #
+    # This method is invoked when renaming a sequence in the database.
+    # The corresponding inverse operation will be to rename the sequence back to
+    # its original name during rollback.
+    #
+    # @param args [Array] Arguments required to rename the sequence (usually the old and new sequence names).
+    #
+    # @return [void]
+    #
+    # @since 1.2.0
+    #
+    def rename_sequence(*args)
+      record(:rename_sequence, args)
+    end
+
+    private
+
+    ##
+    # Generates the inverse command for creating a sequence, which is to drop the sequence.
+    #
+    # @param args [Array] Arguments passed to the create_sequence method (sequence name).
+    # @return [Array] An array with the inverse command `:drop_sequence` and its arguments.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
+    def invert_create_sequence(args)
+      [:drop_sequence, args]
+    end
+
+    ##
+    # Generates the inverse command for altering a sequence, which is not possible.
+    #
+    # @param args [Array] Arguments passed to the alter_sequence method.
+    # @raise [ActiveRecord::IrreversibleMigration] This operation cannot be reversed.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
+    def invert_alter_sequence(args)
+      raise ActiveRecord::IrreversibleMigration, "Alter sequence is irreversible."
+    end
+
+    ##
+    # Generates the inverse command for dropping a sequence, which is not possible.
+    #
+    # @param args [Array] Arguments passed to the drop_sequence method (sequence name).
+    # @raise [ActiveRecord::IrreversibleMigration] This operation cannot be reversed.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
+    def invert_drop_sequence(args)
+      raise ActiveRecord::IrreversibleMigration, "Drop sequence is irreversible."
+    end
+
+    ##
+    # Generates the inverse command for renaming a sequence, which renames it
+    # back to its original name.
+    #
+    # @param args [Array] Arguments passed to the rename_sequence method (old sequence name and new sequence name).
+    #
+    # @return [Array] An array with the inverse command `:rename_sequence` and its arguments swapped.
+    #
+    # @since 1.2.0
+    #
+    def invert_rename_sequence(args)
+      [:rename_sequence, [args.last[:to], to: args.first]]
+    end
+  end
+end

data/lib/postgresql_adapter_extensions/sequence_methods.rb

@@ -7,18 +7,15 @@ module PostgreSQLAdapterExtensions
   # This module provides methods for managing PostgreSQL sequences, including
   # creating, altering, and dropping sequences with various customization options.
   #
+  # @note This module is designed for PostgreSQL databases and may not be compatible with other database systems.
+  #
   # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
   # @since 1.0.0
   #
-  # @note This module is designed for PostgreSQL databases and may not be compatible with other database systems.
-  #
   module SequenceMethods
     ##
     # Creates a new sequence in the PostgreSQL database with customizable options.
     #
-    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
-    # @since 1.0.0
-    #
     # @param name [String, Symbol] The name of the sequence to create.
     # @param options [Hash] Additional options to configure the sequence.
     # @option options [Boolean] :if_not_exists (false) Includes +IF NOT EXISTS+ to avoid errors if the sequence exists.
@@ -47,6 +44,9 @@ module PostgreSQLAdapterExtensions
     #
     # @note Uses `CREATE SEQUENCE` SQL statement with PostgreSQL-specific options.
     #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
     def create_sequence(name, options = {})
       options = options.reverse_merge(
         start: 1,
@@ -73,11 +73,9 @@ module PostgreSQLAdapterExtensions
       execute(sql).tap { reload_type_map }
     end
 
+    ##
     # Alters an existing PostgreSQL sequence with the given options.
     #
-    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
-    # @since 1.0.0
-    #
     # @param name [String, Symbol] The name of the sequence to alter.
     # @param options [Hash] A hash of options to modify the sequence behavior.
     # @option options [Boolean] :if_exists Includes +IF EXISTS+ to avoid errors if the sequence does not exist.
@@ -113,6 +111,9 @@ module PostgreSQLAdapterExtensions
     #
     # @note Uses `ALTER SEQUENCE` SQL statement with PostgreSQL-specific options.
     #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
     def alter_sequence(name, options = {})
       sql = +"ALTER SEQUENCE"
       sql << " IF EXISTS" if options[:if_exists]
@@ -135,9 +136,6 @@ module PostgreSQLAdapterExtensions
     ##
     # Drops an existing sequence from the PostgreSQL database with optional conditions.
     #
-    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
-    # @since 1.0.0
-    #
     # @param name [String, Symbol] The name of the sequence to drop.
     # @param options [Hash] Additional options to modify the behavior of the drop operation.
     # @option options [Boolean] :if_exists (false) Adds +IF EXISTS+ to avoid errors if the sequence does not exist.
@@ -161,6 +159,9 @@ module PostgreSQLAdapterExtensions
     #
     # @note Uses `DROP SEQUENCE` SQL statement with PostgreSQL-specific options.
     #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.0.0
+    #
     def drop_sequence(name, options = {})
       options = options.reverse_merge(
         if_exists: false
@@ -174,5 +175,43 @@ module PostgreSQLAdapterExtensions
 
       execute(sql).tap { reload_type_map }
     end
+
+    ##
+    # Renames an existing PostgreSQL sequence.
+    #
+    # @param name [String, Symbol] The current name of the sequence.
+    # @param options [Hash] A hash of options for renaming the sequence.
+    # @option options [Boolean] :if_exists (false) Includes +IF EXISTS+ to avoid errors if the sequence does not exist.
+    # @option options [String, Symbol] :to The new name for the sequence.
+    #
+    # @raise [ArgumentError] If the +:to+ option is not provided.
+    #
+    # @example Rename a sequence
+    #   rename_sequence(:order_id_seq, to: :new_order_id_seq)
+    #
+    # @example Rename a sequence only if it exists
+    #   rename_sequence(:order_id_seq, to: :new_order_id_seq, if_exists: true)
+    #
+    # @return [void]
+    #
+    # @note Uses `ALTER SEQUENCE ... RENAME TO` SQL statement in PostgreSQL.
+    #
+    # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+    # @since 1.2.0
+    #
+    def rename_sequence(name, options = {})
+      to = options.fetch(:to) { raise ArgumentError, ":to is required" }
+
+      options = options.reverse_merge(
+        if_exists: false
+      )
+
+      sql = +"ALTER SEQUENCE"
+      sql << " IF EXISTS" if options[:if_exists]
+      sql << " #{quote_table_name(name)}"
+      sql << " RENAME TO #{quote_table_name(to)}"
+
+      execute(sql).tap { reload_type_map }
+    end
   end
 end

data/lib/postgresql_adapter_extensions/version.rb

@@ -4,5 +4,5 @@
 
 module PostgreSQLAdapterExtensions
   # Current stable version.
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postgresql_adapter_extensions
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-12 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -121,6 +121,7 @@ files:
 - bin/setup_postgresql.sh
 - lib/postgresql_adapter_extensions.rb
 - lib/postgresql_adapter_extensions/base.rb
+- lib/postgresql_adapter_extensions/command_recorder.rb
 - lib/postgresql_adapter_extensions/sequence_methods.rb
 - lib/postgresql_adapter_extensions/version.rb
 - postgresql_adapter_extensions.gemspec