postgresql_adapter_extensions 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db065d0487684a0647e17b2db8e5ef1f2131a6b15a7b0316d1fcd9856e46c07a
-  data.tar.gz: bd6cb683c11d9e27c1225d5c29e638adf6f14b96b1f7c3bf1803d96944383478
+  metadata.gz: fedbb03323e871885e04d3799efbdbae9f5f058acc2148ed2e5005a273bedf9f
+  data.tar.gz: 73bfe4528be9a2a28395fe40ee40e920052058b5a1a1276fe58c4bb857e57bbf
 SHA512:
-  metadata.gz: 986daa750a1e762d710dbda29ba587ea8c76a8894f2c7ff346b2d64dc974e4c3fe54098e9549646d584c8b8c9efb5ebe00e0581a3d00c76dc3be253e7d5af9c5
-  data.tar.gz: 8dc3a0571ff79ce9dd058ab3c22e0876c07cd748ddc0b4c42b5f642e51869aaddc353b144be5f1feff165cbe967bacaf08f0e70dbe0828fba8ffe8fa5703c5fc
+  metadata.gz: e3e30ccebbbbc5eae45c6daa70d953a8479ce2fecfeedb46c5e545be614e8c5080ec48c99057d2e4fefc668e7775cb9d9bac187401e1637a47cefefd092d244b
+  data.tar.gz: c2c2a06aedbcaa1d1ebef70fcb61d411ad81f8d5d787b24a43a60a7f2f8c84ffab48be36531f3147a859c807edd78d094a9a689fb8be54b810ac826a827ab3e5

data/CHANGELOG.md

@@ -1,7 +1,22 @@
+## [1.2.0](https://github.com/shivam091/postgresql_adapter_extensions/compare/v1.1.0...v1.2.0) - 2025-03-27
+
+### What's new
+
+#### PostgreSQLAdapterExtensions::SequenceMethods
+- Added `rename_sequence` method to rename a PostgreSQL sequences with optional IF EXISTS.
+
+#### 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.
+
+### Notes
+- `rename_sequence` can be reversed by renaming the sequence back to its previous name.
+
 ## [1.1.0](https://github.com/shivam091/postgresql_adapter_extensions/compare/v1.0.0...v1.1.0) - 2025-03-21
 
 ### What's new
-- Extended `ActiveRecord::Migration::CommandRecorder` to support PostgreSQL sequence-related commands.
+
+#### 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).
@@ -12,30 +27,20 @@
 - `create_sequence` can be reversed by dropping the sequence.
 - `alter_sequence` and `drop_sequence` are irreversible operations.
 
-----------
-
 ## [1.0.0](https://github.com/shivam091/postgresql_adapter_extensions/compare/v0.1.0...v1.0.0) - 2025-03-12
 
 ### What's new
 
-- Added `create_sequence` method
-
-  Allows creating PostgreSQL sequences with customizable options such as start value, increment step, min/max values, caching, cycling, and ownership.
-
-- Added `alter_sequence` method
-
-  Enables modifying existing PostgreSQL sequences, supporting changes to increment steps, restart values, min/max limits, caching, cycling behavior, and ownership.
+#### 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.
 
-- Added `drop_sequence` method
+- 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.
 
-  Provides functionality to remove a PostgreSQL sequence with optional IF EXISTS and CASCADE/RESTRICT behaviors to manage dependencies.
-
-----------
+- 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
-
------------
-
-### Unreleased

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    postgresql_adapter_extensions (1.1.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/command_recorder.rb

@@ -77,6 +77,23 @@ module PostgreSQLAdapterExtensions
       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
 
     ##
@@ -117,5 +134,19 @@ module PostgreSQLAdapterExtensions
     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

@@ -175,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.1.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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-21 00:00:00.000000000 Z
+date: 2025-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord