nandi 0.13.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e12cc00673e41d4494ea444a6a44524cca908c7bda4a315bd681dbec9cf7563
-  data.tar.gz: 29f0803224e74092b1bce4eaa673cc811bde033e0b9cd72359390094e34a62f9
+  metadata.gz: d3c09dc76de1e4d072270551a10f9f244ea4e9b79f4cdc2bb21069764e722724
+  data.tar.gz: a6f9af91f0fd1012d8734c75ba1289d2afea7217dab6b1c4d0e0fbba6c6be052
 SHA512:
-  metadata.gz: 9987773dcba43ad2750a7c2ea9fcb2640d9ced6ede820ef43d49bd4ee155b55d2b23bddaf0a88569067d6ab4b2730f40d95e5c1e1589786a71bb355f4ef4d682
-  data.tar.gz: 13804be5be06737df766ee92f7afa52da870553183566c6fdfa25522883accbcbfe624013cf4411aca1da0f199b549650e17e638796a7b4f2dfc53ec1c8a0080
+  metadata.gz: 75284ae3b4f85e75fe0293e16ecef39db7cbd68098044066a1dd5c2e9222518871b2f194d9d4bc936663ae11bb76d5d4e5c13931bf3d530fb196efe6d0d88bb4
+  data.tar.gz: 0a4bba3b7bce0c6888f21d327522789ad5ccff683aa34356fc5733d18d9b3ad61512a7955dd310ebad48e652497b2310c199def599fb1d469cd01a2124733f79

data/README.md

@@ -4,8 +4,8 @@ Friendly Postgres migrations for people who don't want to take down their databa
 
 ## Supported
 
-- Ruby 2.6 or above
-- Rails 5.2 or above
+- Ruby 3.2 or above
+- Rails 7.1 or above
 - Postgres 11 or above
 
 ## What does it do?
@@ -15,7 +15,7 @@ Nandi provides an alternative API to ActiveRecord's built-in Migration DSL for d
 ActiveRecord makes many changes easy. Unfortunately, that includes things that should be done with great care. Consider this migration, for example:
 
 ```rb
-class AddBarIDToFoos < ActiveRecord::Migration[5.2]
+class AddBarIDToFoos < ActiveRecord::Migration[8.0]
   def change
     add_reference :foos, :bars, foreign_key: true
   end
@@ -40,6 +40,7 @@ gem 'activerecord-safer_migrations' # Also required
 ```
 
 Generate a new migration:
+
 ```sh
 rails generate nandi:migration add_widgets
 ```
@@ -76,7 +77,7 @@ The result will sort of look like this:
 ```rb
 # db/migrate/20190606060606_add_widgets.rb
 
-class AddWidgets < ActiveRecord::Migration[5.2]
+class AddWidgets < ActiveRecord::Migration[8.0]
   set_lock_timeout(750)
   set_statement_timeout(1500)
 
@@ -121,7 +122,7 @@ end
 
 # db/migrate/20190606060606_add_widgets_index_on_name_and_price.rb
 
-class AddWidgetsIndexOnNameAndPrice < ActiveRecord::Migration[5.2]
+class AddWidgetsIndexOnNameAndPrice < ActiveRecord::Migration[8.0]
   set_lock_timeout(750)
   set_statement_timeout(1500)
 
@@ -197,7 +198,7 @@ Which, when compiled, takes care of things in the right order:
 ```rb
 # db/migrate/20190611124816_add_reference_on_foos_to_bars.rb
 
-class AddReferenceOnFoosToBars < ActiveRecord::Migration[5.2]
+class AddReferenceOnFoosToBars < ActiveRecord::Migration[8.0]
   set_lock_timeout(5_000)
   set_statement_timeout(1_500)
 
@@ -211,7 +212,7 @@ end
 
 # db/migrate/20190611124817_add_foreign_key_on_foos_to_bars.rb
 
-class AddForeignKeyOnFoosToBars < ActiveRecord::Migration[5.2]
+class AddForeignKeyOnFoosToBars < ActiveRecord::Migration[8.0]
   set_lock_timeout(750)
   set_statement_timeout(1500)
 
@@ -234,7 +235,7 @@ end
 
 # frozen_string_literal: true
 
-class ValidateForeignKeyOnFoosToBars < ActiveRecord::Migration[5.2]
+class ValidateForeignKeyOnFoosToBars < ActiveRecord::Migration[8.0]
   set_lock_timeout(750)
   set_statement_timeout(1500)
 
@@ -260,21 +261,26 @@ Override the default statement timeout for the duration of the migration. For mi
 ## Migration methods
 
 ### `#add_column(table, name, type, **kwargs)`
+
 Adds a new column. Nandi will explicitly set the column to be NULL, as validating a new NOT NULL constraint can be very expensive on large tables and cause availability issues.
 
 ### `#add_foreign_key(table, target, column: nil, name: nil)`
+
 Add a foreign key constraint. The generated SQL will include the NOT VALID parameter, which will prevent immediate validation of the constraint, which locks the target table for writes potentially for a long time. Use the separate #validate_constraint method, in a separate migration; this only takes a row-level lock as it scans through.
 
 ### `#add_index(table, fields, **kwargs)`
+
 Adds a new index to the database.
 
 Nandi will
+
 - add the `CONCURRENTLY` option, which means the change takes a less restrictive lock at the cost of not running in a DDL transaction
 - default to the `BTREE` index type, as it is commonly a good fit.
 
 Because index creation is particularly failure-prone, and because we cannot run in a transaction and therefore risk partially applied migrations that (in a Rails environment) require manual intervention, Nandi Validates that, if there is a add_index statement in the migration, it must be the only statement.
 
 ### `#create_table(table) {|columns_reader| ... }`
+
 Creates a new table. Yields a ColumnsReader object as a block, to allow adding columns.
 
 Examples:
@@ -286,33 +292,42 @@ end
 ```
 
 ### `#add_reference(table, ref_name, **extra_args)`
+
 Adds a new reference column. Nandi will validate that the foreign key flag is not set to true; use `add_foreign_key` and `validate_foreign_key` instead! Nandi will also set the `index: false` flag, as index creation is unsafe unless done concurrently in a separate migration.
 
 ### `#remove_reference(table, ref_name, **extra_args)`
+
 Removes a reference column.
 
 ### `#remove_column(table, name, **extra_args)`
+
 Remove an existing column.
 
 ### `#drop_constraint(table, name)`
+
 Drops an existing constraint.
 
 ### `#remove_not_null_constraint(table, column)`
+
 Drops an existing NOT NULL constraint. Please not that this migration is not safely reversible; to enforce NOT NULL like behaviour, use a CHECK constraint and validate it in a separate migration.
 
 ### `#change_column_default(table, column, value)`
+
 Changes the default value for this column when new rows are inserted into the table.
 
 ### `#remove_index(table, target)`
+
 Drop an index from the database.
 
 Nandi will add the `CONCURRENTLY` option, which means the change takes a less restrictive lock at the cost of not running in a DDL transaction.
 Because we cannot run in a transaction and therefore risk partially applied migrations that (in a Rails environment) require manual intervention, Nandi Validates that, if there is a remove_index statement in the migration, it must be the only statement.
 
 ### `#drop_table(table)`
+
 Drops an existing table.
 
 ### `#irreversible_migration`
+
 Raises `ActiveRecord::IrreversibleMigration` error.
 
 ## Generators
@@ -370,7 +385,6 @@ rails generate nandi:foreign_key foos bar --no-create-column --column special_ba
 
 We generate the name of your foreign key for you. If you want or need to override it (e.g. if it exceeds the max length of a constraint name in Postgres), you can use the `--name` flag:
 
-
 ```
 rails generate nandi:foreign_key foos bar --name my_fk
 ```
@@ -424,15 +438,18 @@ The default statement timeout for migrations that take permissive locks. Can be
 The default statement timeout for migrations that take ACCESS EXCLUSIVE locks. Can be overridden by way of the `set_statement_timeout` class method in a given migration. Default: 1500ms.
 
 ### `compile_files` (String)
+
 The files to compile when the compile generator is run. Default: `all`
 
 May be one of the following:
+
 - 'all' compiles all files
 - 'git-diff' only files changed since last commit
 - a full or partial version timestamp, eg '20190101010101', '20190101'
 - a timestamp range , eg '>=20190101010101'
 
 ### `lockfile_directory` (String)
+
 The directory where .nandilock.yml will be stored. Default: `db/` in working directory.
 
 #post_process {|migration| ... }

data/lib/generators/nandi/foreign_key/foreign_key_generator.rb

@@ -65,7 +65,7 @@ module Nandi
     end
 
     def reference_name
-      "#{target.singularize}_id".to_sym
+      :"#{target.singularize}_id"
     end
 
     def base_path

data/lib/nandi/file_matcher.rb

@@ -2,7 +2,7 @@
 
 module Nandi
   class FileMatcher
-    TIMESTAMP_REGEX = /\A(?<operator>>|>=)?(?<timestamp>\d+)\z/.freeze
+    TIMESTAMP_REGEX = /\A(?<operator>>|>=)?(?<timestamp>\d+)\z/
 
     def self.call(*args, **kwargs)
       new(*args, **kwargs).call

data/lib/nandi/formatting.rb

@@ -73,7 +73,7 @@ module Nandi
     def symbol_key(key)
       canonical = key.inspect
 
-      "#{canonical[1..-1]}:"
+      "#{canonical[1..]}:"
     end
   end
 end

data/lib/nandi/instructions/create_table.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "ostruct"
-
 module Nandi
   module Instructions
     class CreateTable
+      Column = Struct.new(:name, :type, :args, keyword_init: true)
+
       attr_reader :table, :columns, :timestamps_args, :extra_args
 
       def initialize(table:, columns_block:, **kwargs)
@@ -65,7 +65,7 @@ module Nandi
         end
 
         def column(name, type, **args)
-          @columns << OpenStruct.new(name: name, type: type, args: args)
+          @columns << Column.new(name: name, type: type, args: args)
         end
 
         def timestamps(**args)

data/lib/nandi/lockfile.rb

@@ -39,7 +39,7 @@ module Nandi
 
         Nandi::Lockfile.create! unless Nandi::Lockfile.file_present?
 
-        @lockfile = YAML.safe_load(File.read(path)).with_indifferent_access
+        @lockfile = YAML.safe_load_file(path).with_indifferent_access
       end
 
       def persist!

data/lib/nandi/migration.rb

@@ -357,9 +357,9 @@ module Nandi
       end.uniq
     end
 
-    def method_missing(name, *args, **kwargs, &block)
+    def method_missing(name, ...)
       if Nandi.config.custom_methods.key?(name)
-        invoke_custom_method(name, *args, **kwargs, &block)
+        invoke_custom_method(name, ...)
       else
         super
       end
@@ -381,9 +381,9 @@ module Nandi
       Nandi.config.access_exclusive_lock_timeout
     end
 
-    def invoke_custom_method(name, *args, **kwargs, &block)
+    def invoke_custom_method(name, ...)
       klass = Nandi.config.custom_methods[name]
-      current_instructions << klass.new(*args, **kwargs, &block)
+      current_instructions << klass.new(...)
     end
   end
 end

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

@@ -30,7 +30,7 @@ module Nandi
 
         def should_disable_ddl_transaction?
           [*up_instructions, *down_instructions].
-            select { |i| i.procedure.to_s.include?("index") }.any?
+            any? { |i| i.procedure.to_s.include?("index") }
         end
 
         def activerecord_version

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

@@ -3,7 +3,6 @@
 require "cells"
 require "tilt"
 require "nandi/formatting"
-require "ostruct"
 
 module Nandi
   module Renderers
@@ -61,7 +60,7 @@ module Nandi
 
           def columns
             model.columns.map do |c|
-              OpenStruct.new(
+              ::Nandi::Instructions::CreateTable::Column.new(
                 name: format_value(c.name),
                 type: format_value(c.type),
               ).tap do |col|

data/lib/nandi/timeout_policies/access_exclusive.rb

@@ -28,8 +28,8 @@ module Nandi
         assert(
           !migration.disable_statement_timeout? &&
           migration.statement_timeout <= statement_timeout_maximum,
-          "statement timeout must be at most #{statement_timeout_maximum}ms" \
-          " as it takes an ACCESS EXCLUSIVE lock",
+          "statement timeout must be at most #{statement_timeout_maximum}ms " \
+          "as it takes an ACCESS EXCLUSIVE lock",
         )
       end
 
@@ -37,8 +37,8 @@ module Nandi
         assert(
           !migration.disable_lock_timeout? &&
           migration.lock_timeout <= lock_timeout_maximum,
-          "lock timeout must be at most #{lock_timeout_maximum}ms" \
-          " as it takes an ACCESS EXCLUSIVE lock",
+          "lock timeout must be at most #{lock_timeout_maximum}ms " \
+          "as it takes an ACCESS EXCLUSIVE lock",
         )
       end
 

data/lib/nandi/timeout_policies/concurrent.rb

@@ -31,7 +31,7 @@ module Nandi
       def validate_statement_timeout
         assert(
           migration.disable_statement_timeout? || statement_timeout_high_enough,
-          "statement timeout for concurrent operations "\
+          "statement timeout for concurrent operations " \
           "must be at least #{minimum_statement_timeout}",
         )
       end
@@ -39,7 +39,7 @@ module Nandi
       def validate_lock_timeout
         assert(
           migration.disable_lock_timeout? || lock_timeout_high_enough,
-          "lock timeout for concurrent operations "\
+          "lock timeout for concurrent operations " \
           "must be at least #{minimum_lock_timeout}",
         )
       end

data/lib/nandi/validation/add_index_validator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "nandi/validation/failure_helpers"
+
+module Nandi
+  module Validation
+    class AddIndexValidator
+      include Nandi::Validation::FailureHelpers
+
+      def self.call(instruction)
+        new(instruction).call
+      end
+
+      def initialize(instruction)
+        @instruction = instruction
+      end
+
+      def call
+        assert(
+          not_using_hash_index?,
+          "add_index: Nandi does not support hash indexes. Hash indexes typically have " \
+          "very specialized use cases. Please revert to using a btree index, or proceed " \
+          "with the creation of this index without using Nandi.",
+        )
+      end
+
+      attr_reader :instruction
+
+      private
+
+      def not_using_hash_index?
+        instruction.extra_args[:using] != :hash
+      end
+    end
+  end
+end

data/lib/nandi/validation/each_validator.rb

@@ -17,6 +17,8 @@ module Nandi
 
       def call
         case instruction.procedure
+        when :add_index
+          AddIndexValidator.call(instruction)
         when :remove_index
           RemoveIndexValidator.call(instruction)
         when :add_column

data/lib/nandi/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,153 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.0'
-- !ruby/object:Gem::Dependency
-  name: gc_ruboconfig
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.3.0
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.2.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.2.3
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-description:
 email:
 - engineering@gocardless.com
 executables:
@@ -278,6 +130,7 @@ files:
 - lib/nandi/timeout_policies/concurrent.rb
 - lib/nandi/validation.rb
 - lib/nandi/validation/add_column_validator.rb
+- lib/nandi/validation/add_index_validator.rb
 - lib/nandi/validation/add_reference_validator.rb
 - lib/nandi/validation/each_validator.rb
 - lib/nandi/validation/failure_helpers.rb
@@ -307,7 +160,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -315,15 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Fear-free migrations for PostgreSQL
 test_files: []