nandi 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '068eff75d4f385070e3da2d3738019cf4e6be7554a16e235f3701e3c0db79419'
-  data.tar.gz: cfe9e766d00073ab040888cad17bedb8c4b2b294d7e353d5298a9ccce9a130f2
+  metadata.gz: ab45002075955602da710e92a39cc3b9fe8bdc9371a33e97319e9e24d68a3385
+  data.tar.gz: 25f3e29b999a37eeb5d46ea272b12e313ae11de5c272dd81120dde4d2dd6ecfe
 SHA512:
-  metadata.gz: 86c97f9217b2fc3819d8204f80e0f29d7d00e63b3929b40cd684d66b6e701d97b69bb1094714ef8e33bf3c451d67fb31803a18c6625ac2f2a06e4c159ff2dd98
-  data.tar.gz: 83b8831e08ddcfedf0e558acf5b4813866605757f17d3ca74ec21f9815f774f8207d0b2e7dd1d50aa87674c39e06420fac106454996b2a8f37eb4a660a6e1b95
+  metadata.gz: a916d9acc8c50060a472e2c6630529ac6b6832380d2198f1d8e19785ce7da5ff211e24e44b33ce51d6f305fab24e98ba7297cba55904f89d394cc939cb202883
+  data.tar.gz: 6b1674699aa6e907474c00d31c6a337ae4af7d9e29d1528811e8dcc19e2235a3340fd59ae1f4f1b4176f21c882508e6d20ec992a77b292d7c31a78c05f671315

data/README.md

@@ -315,6 +315,10 @@ Drops an existing NOT NULL constraint. Please not that this migration is not saf
 
 Changes the default value for this column when new rows are inserted into the table.
 
+### `#extend_varchar_column_limit(table, column, from:, to:)`
+
+Widens (or removes, with `to: nil`) the character limit on an existing varchar column. Since Postgres 9.2 this is metadata-only; _narrowing_ a limit requires a full-table scan and isn't supported. The generated migration re-checks the column's actual type and limit in the database against `from:` before changing it, so this is safe to recompile even after it has already run. Not safely reversible: `down` should be `irreversible_migration`.
+
 ### `#remove_index(table, target)`
 
 Drop an index from the database.

data/lib/nandi/instructions/extend_varchar_column_limit.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nandi
+  module Instructions
+    class ExtendVarcharColumnLimit
+      attr_reader :table, :column, :from, :to
+
+      def initialize(table:, column:, from:, to:)
+        unless from.is_a?(Integer)
+          raise ArgumentError, "extend_varchar_column_limit requires an integer `from:` limit"
+        end
+
+        unless to.nil? || (to.is_a?(Integer) && to > from)
+          raise ArgumentError,
+                "extend_varchar_column_limit only supports widening a character limit, or " \
+                "removing it entirely (to: nil), but #{table}.#{column} would go from #{from} " \
+                "to #{to.inspect}. Narrowing a limit requires a full-table scan under an " \
+                "ACCESS EXCLUSIVE lock and isn't supported here."
+        end
+
+        @table = table
+        @column = column
+        @from = from
+        @to = to
+      end
+
+      def procedure
+        :extend_varchar_column_limit
+      end
+
+      def lock
+        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
+      end
+    end
+  end
+end

data/lib/nandi/instructions.rb

@@ -12,6 +12,7 @@ require "nandi/instructions/add_foreign_key"
 require "nandi/instructions/drop_constraint"
 require "nandi/instructions/remove_not_null_constraint"
 require "nandi/instructions/change_column_default"
+require "nandi/instructions/extend_varchar_column_limit"
 require "nandi/instructions/validate_constraint"
 require "nandi/instructions/add_check_constraint"
 require "nandi/instructions/irreversible_migration"

data/lib/nandi/migration.rb

@@ -311,6 +311,19 @@ module Nandi
       )
     end
 
+    # Widens (or removes) the character limit on an existing varchar column.
+    # Since Postgres 9.2 this is metadata-only (a brief ACCESS EXCLUSIVE lock).
+    # Narrowing remains a different, unsafe operation and is not supported.
+    #
+    # Not safely reversible: `down` should be `irreversible_migration`.
+    # @param table [Symbol, String] The name of the table with the column
+    # @param column [Symbol, String] The name of the column to change
+    # @param from [Integer] The column's current character limit
+    # @param to [Integer, nil] The new character limit, or nil to remove it entirely
+    def extend_varchar_column_limit(table, column, from:, to:)
+      current_instructions << Instructions::ExtendVarcharColumnLimit.new(table:, column:, from:, to:)
+    end
+
     # Raises an `ActiveRecord::IrreversibleMigration` error for use in
     # irreversible migrations
     def irreversible_migration

data/lib/nandi/renderers/active_record/instructions.rb

@@ -105,6 +105,16 @@ module Nandi
           formatted_property :value
         end
 
+        class ExtendVarcharColumnLimitCell < Base
+          property :table
+          property :column
+          property :from
+
+          def to_type_sql
+            model.to.nil? ? "character varying" : "character varying(#{model.to})"
+          end
+        end
+
         class RemoveNotNullConstraintCell < Base
           formatted_property :table
           formatted_property :column

data/lib/nandi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nandi
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/lib/templates/nandi/renderers/active_record/instructions/extend_varchar_column_limit/show.rb.erb

@@ -0,0 +1,16 @@
+execute <<-SQL
+  DO $$
+  DECLARE
+    actual_type text;
+  BEGIN
+    SELECT format_type(atttypid, atttypmod) INTO actual_type
+    FROM pg_attribute
+    WHERE attrelid = '<%= table %>'::regclass AND attname = '<%= column %>' AND NOT attisdropped;
+
+    IF actual_type IS DISTINCT FROM 'character varying(<%= from %>)' THEN
+      RAISE EXCEPTION 'expected <%= table %>.<%= column %> to be character varying(<%= from %>), found %', actual_type;
+    END IF;
+  END $$;
+
+  ALTER TABLE <%= table %> ALTER COLUMN "<%= column %>" TYPE <%= to_type_sql %>;
+SQL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - GoCardless Engineering
@@ -112,6 +112,7 @@ files:
 - lib/nandi/instructions/create_table.rb
 - lib/nandi/instructions/drop_constraint.rb
 - lib/nandi/instructions/drop_table.rb
+- lib/nandi/instructions/extend_varchar_column_limit.rb
 - lib/nandi/instructions/irreversible_migration.rb
 - lib/nandi/instructions/remove_column.rb
 - lib/nandi/instructions/remove_index.rb
@@ -155,6 +156,7 @@ files:
 - lib/templates/nandi/renderers/active_record/instructions/create_table/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/drop_constraint/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/drop_table/show.rb.erb
+- lib/templates/nandi/renderers/active_record/instructions/extend_varchar_column_limit/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/irreversible_migration/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/remove_column/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/remove_index/show.rb.erb
@@ -180,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.9
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Fear-free migrations for PostgreSQL
 test_files: []