nandi 0.8.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9c08faeee8155ae5b0e5357cabca63c2f31bfd65fb464e16991b47c4b9cab75
-  data.tar.gz: 0e408aa01adaf0ce11560acef08d899c208d2c4e3afdd31b3fb9777a0d0b2408
+  metadata.gz: 6e1e64259650cb225c127f8a89c899464864a9d5ca76fb4abd58d48c6930e624
+  data.tar.gz: 41ef391e7da05c3997a13adf87ff5aa032fd6a46762d4cc7263c691d179ed237
 SHA512:
-  metadata.gz: fe9b90ee4085d5f7d208e481f9ae4fca325f87ab37ff7b3c1a74063adbe65a7777ab66e8afbb8b4d18408362ef1c71f88884eeab6643c19ffd3e8de3f98b007f
-  data.tar.gz: fdbca6280d8c5299661b78fa1163593f903605c056337c3e55b3ca512370717fa7c8af97bfe055393205a6c15fe224aa32a97616dfec8fb118daf39a10b42ca0
+  metadata.gz: 1672112e9464d5f8cefd75477cd7cdbae2d05822b0544d9f9240140b55121171e8f7e4183b09a5fcb2ab0d240e701aa891faebb5e99bafd5e4e764e2079e4f9d
+  data.tar.gz: 490135828100e636745efc67dfece39f04506ce18b135ab7487041b0929302b59973ae2848b7eef899dbd347050767c0f20fb3e1bdca73d0228d4e19c84e1279

data/README.md

@@ -4,7 +4,7 @@ Friendly Postgres migrations for people who don't want to take down their databa
 
 ## Supported
 
-- Ruby 2.4 or above
+- Ruby 2.5 or above
 - Rails 5.2 or above
 - Postgres 11 or above
 
@@ -161,11 +161,11 @@ We now have three new migration files:
 
 class AddReferenceOnFoosToBars < Nandi::Migration
   def up
-    add_reference :foos, :bar
+    add_column :foos, :bar_id, :bigint
   end
 
   def down
-    remove_reference :foos, :bar
+    remove_column :foos, :bar_id
   end
 end
 
@@ -202,10 +202,10 @@ class AddReferenceOnFoosToBars < ActiveRecord::Migration[5.2]
   set_statement_timeout(1_500)
 
   def up
-    add_reference(:foos, :bar)
+    add_column(:foos, :bar_id, :bigint)
   end
   def down
-    remove_reference(:foos, :bar)
+    remove_column(:foos, :bar_id)
   end
 end
 
@@ -268,10 +268,9 @@ Add a foreign key constraint. The generated SQL will include the NOT VALID param
 ### `#add_index(table, fields, **kwargs)`
 Adds a new index to the database.
 
-Nandi will:
-
+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
-- use the `BTREE` index type which is the safest to create.
+- 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.
 
@@ -287,7 +286,7 @@ 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!
+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.

data/exe/nandi-enforce

@@ -31,6 +31,6 @@ OptionParser.new do |o|
   end
 end.parse!
 
-enforcer = Nandi::SafeMigrationEnforcer.new(opts)
+enforcer = Nandi::SafeMigrationEnforcer.new(**opts)
 
 enforcer.run

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

@@ -11,7 +11,7 @@ module Nandi
     argument :target, type: :string
     class_option :name, type: :string
     class_option :column, type: :string
-    class_option :type, type: :string
+    class_option :type, type: :string, default: "bigint"
     class_option :no_create_column, type: :boolean
     class_option :validation_timeout, type: :numeric, default: 15 * 60 * 1000
 
@@ -61,11 +61,11 @@ module Nandi
     private
 
     def type
-      options["type"]&.to_sym
+      options["type"].to_sym
     end
 
     def reference_name
-      target.singularize.to_sym
+      "#{target.singularize}_id".to_sym
     end
 
     def base_path

data/lib/generators/nandi/foreign_key/templates/add_reference.rb

@@ -2,10 +2,10 @@
 
 class <%= add_reference_name.camelize %> < Nandi::Migration
   def up
-    add_reference <%= format_value(table) %>, <%= format_value(reference_name) %><% if type %>, type: <%= format_value(type) %><% end %>
+    add_column <%= format_value(table) %>, <%= format_value(reference_name) %>, <%= format_value(type) %>
   end
 
   def down
-    remove_reference <%= format_value(table) %>, <%= format_value(reference_name) %>
+    remove_column <%= format_value(table) %>, <%= format_value(reference_name) %>
   end
 end

data/lib/nandi/formatting.rb

@@ -64,7 +64,7 @@ module Nandi
         key = if k.is_a?(Symbol)
                 symbol_key(k)
               else
-                format_value(k) + " =>"
+                "#{format_value(k)} =>"
               end
         "#{key} #{format_value(v)}"
       end

data/lib/nandi/instructions/add_index.rb

@@ -21,11 +21,10 @@ module Nandi
           name: name,
 
           # Overrides and extra options
-          **@extra_args,
+          **extra_args_with_default_index_type,
 
           # Mandatory values
           algorithm: :concurrently,
-          using: :btree,
         }
       end
 
@@ -38,13 +37,19 @@ module Nandi
       private
 
       def name
-        :"idx_#{table.to_s}_on_#{field_names}"
+        :"idx_#{table}_on_#{field_names}"
       end
 
       def field_names
         field_names = fields.respond_to?(:map) ? fields.map(&:to_s).join("_") : fields
         field_names.to_s.scan(/\w+/).join("_")
       end
+
+      def extra_args_with_default_index_type
+        {
+          using: :btree,
+        }.merge(@extra_args)
+      end
     end
   end
 end

data/lib/nandi/instructions/add_reference.rb

@@ -3,12 +3,13 @@
 module Nandi
   module Instructions
     class AddReference
+      DEFAULT_EXTRA_ARGS = { index: false }.freeze
       attr_reader :table, :ref_name, :extra_args
 
       def initialize(table:, ref_name:, **kwargs)
         @table = table
         @ref_name = ref_name
-        @extra_args = kwargs
+        @extra_args = DEFAULT_EXTRA_ARGS.merge(kwargs)
       end
 
       def procedure

data/lib/nandi/lockfile.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/core_ext/hash/indifferent_access"
+require "digest"
 
 module Nandi
   class Lockfile
@@ -42,7 +43,26 @@ module Nandi
       end
 
       def persist!
-        File.write(path, lockfile.to_h.deep_stringify_keys.to_yaml)
+        # This is a somewhat ridiculous trick to avoid merge conflicts in git.
+        #
+        # Normally, new migrations are added to the bottom of the Nandi lockfile.
+        # This is relatively unfriendly to git's merge algorithm, and means that
+        # if someone merges a pull request with a completely unrelated migration,
+        # you'll have to rebase to get yours merged as the last line of the file
+        # will be seen as a conflict (both branches added content there).
+        #
+        # This is in contrast to something like Gemfile.lock, where changes tend
+        # to be distributed throughout the file. The idea behind sorting by
+        # SHA-256 hash is to distribute new Nandi lockfile entries evenly, but
+        # also stably through the file. It needs to be stable or we'd have even
+        # worse merge conflict problems (e.g. if we randomised the order on
+        # writing the file, the whole thing would conflict pretty much every time
+        # it was regenerated).
+        content = Hash[lockfile.to_h.deep_stringify_keys.sort_by do |k, _|
+          Digest::SHA256.hexdigest(k)
+        end].to_yaml
+
+        File.write(path, content)
       end
 
       def path

data/lib/nandi/migration.rb

@@ -43,6 +43,7 @@ module Nandi
 
     class << self
       attr_reader :lock_timeout, :statement_timeout
+
       # For sake both of correspondence with Postgres syntax and familiarity
       # with activerecord-safe_migrations's identically named macros, we
       # disable this cop.
@@ -111,7 +112,7 @@ module Nandi
     # 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
-    # * use the `BTREE` index type which is the safest to create.
+    # * 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

data/lib/nandi/validation/add_reference_validator.rb

@@ -16,16 +16,28 @@ module Nandi
       end
 
       def call
-        foreign_key = instruction.extra_args.fetch(:foreign_key) { false }
-
-        assert(
-          !foreign_key,
-          foreign_key_message,
+        foreign_key = instruction.extra_args.fetch(:foreign_key, false)
+        index = instruction.extra_args.fetch(:index, false)
+
+        collect_errors(
+          assert(
+            !foreign_key,
+            foreign_key_message,
+          ),
+          assert(
+            !index,
+            index_message,
+          ),
         )
       end
 
       private
 
+      def index_message
+        "Indexing a reference column on creation can make the table unavailable." \
+          "Use the `add_index` method in a separate migration to index the column."
+      end
+
       def foreign_key_message
         "Adding a foreign key constraint must be done in two separate migrations. " \
           "Use the `add_foreign_key` and `validate_foreign_key` methods, or the " \

data/lib/nandi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.11.1
 platform: ruby
 authors:
-- James Turley
-autorequire: 
+- GoCardless Engineering
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2021-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.14
+        version: 2.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.14
+        version: 2.15.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -140,16 +140,22 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        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: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.61'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.61'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -206,9 +212,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+description:
 email:
-- jamesturley@gocardless.com
+- engineering@gocardless.com
 executables:
 - nandi-enforce
 extensions: []
@@ -276,6 +282,7 @@ files:
 - lib/nandi/validation/result.rb
 - lib/nandi/validation/timeout_validator.rb
 - lib/nandi/validator.rb
+- lib/nandi/version.rb
 - lib/templates/nandi/renderers/active_record/generate/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/add_check_constraint/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/add_column/show.rb.erb
@@ -292,10 +299,11 @@ files:
 - lib/templates/nandi/renderers/active_record/instructions/remove_not_null_constraint/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/remove_reference/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/validate_constraint/show.rb.erb
-homepage: 
-licenses: []
+homepage: https://github.com/gocardless/nandi
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -303,15 +311,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Fear-free migrations for PostgreSQL
 test_files: []