nandi 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1da0a62d10387d4dc47b1b00045d351559d8c3a6a08b9f3de2ad029b7948e0da
-  data.tar.gz: f56710ba940ee97e004113b9d96aa6a5e4cc34b963f9c2d5dcbd8d3ae6c4b893
+  metadata.gz: 6e12cc00673e41d4494ea444a6a44524cca908c7bda4a315bd681dbec9cf7563
+  data.tar.gz: 29f0803224e74092b1bce4eaa673cc811bde033e0b9cd72359390094e34a62f9
 SHA512:
-  metadata.gz: 5f9a1879fa3f414c020703cf521200a1d436f2af0da8b7051beadd91bbadf9556f3e811eef17d842e54b8c962b4051529f347b8900dda3ffe5c887bc4565928f
-  data.tar.gz: fcbbc52d37437d8052016e3ff1182f3b603994ab002827ef7e6fbb182ee2a816ff383abde467f0c12f99da54141cbe8ffccb99748950143d047f04233e220733
+  metadata.gz: 9987773dcba43ad2750a7c2ea9fcb2640d9ced6ede820ef43d49bd4ee155b55d2b23bddaf0a88569067d6ab4b2730f40d95e5c1e1589786a71bb355f4ef4d682
+  data.tar.gz: 13804be5be06737df766ee92f7afa52da870553183566c6fdfa25522883accbcbfe624013cf4411aca1da0f199b549650e17e638796a7b4f2dfc53ec1c8a0080

data/README.md

@@ -4,7 +4,7 @@ Friendly Postgres migrations for people who don't want to take down their databa
 
 ## Supported
 
-- Ruby 2.5 or above
+- Ruby 2.6 or above
 - Rails 5.2 or above
 - Postgres 11 or above
 
@@ -356,16 +356,16 @@ db/safe_migrations/20190424123727_add_foreign_key_on_bars_to_foos.rb
 db/safe_migrations/20190424123728_validate_foreign_key_on_bars_to_foos.rb
 ```
 
-If you're adding the constraint to a column that already exists, you can use the `--no-column` flag to skip the first migration:
+If you're adding the constraint to a column that already exists, you can use the `--no-create-column` flag to skip the first migration:
 
 ```
-rails generate nandi:foreign_key foos bars --no-column
+rails generate nandi:foreign_key foos bars --no-create-column
 ```
 
 If your foreign key column is named differently, you can override it with the `--column` flag as seen in this example:
 
 ```
-rails generate nandi:foreign_key foos bar --no-column --column special_bar_ids
+rails generate nandi:foreign_key foos bar --no-create-column --column special_bar_ids
 ```
 
 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:

data/lib/generators/nandi/index/USAGE

@@ -0,0 +1,31 @@
+Description:
+    Generates new database indices
+
+Example:
+    rails generate nandi:index table_name index_col
+
+    This will create:
+        db/safe_migrations/20190424123727_add_index_on_index_col_to_table_name.rb
+
+    or
+
+    rails generate nandi:index table_name_1,table_name_2 index_col
+
+    This will create:
+        db/safe_migrations/20190424123727_add_index_on_index_col_to_table_name_1.rb
+        db/safe_migrations/20190424123728_add_index_on_index_col_to_table_name_2.rb
+
+    or
+
+    rails generate nandi:index table_name index_col_1,index_col_2
+
+    This will create:
+        db/safe_migrations/20190424123727_add_index_on_index_col_1_index_col_2_to_table_name.rb
+
+    or
+
+    rails generate nandi:index table_name index_col --index_name bespoke_idx_name
+
+    This will create:
+        db/safe_migrations/20190424123727_add_index_on_index_col_to_table_name.rb
+    with the specified bespoke index name

data/lib/generators/nandi/index/index_generator.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "nandi/formatting"
+
+module Nandi
+  class IndexGenerator < Rails::Generators::Base
+    include Nandi::Formatting
+
+    argument :tables, type: :string
+    argument :columns, type: :string
+    class_option :index_name, type: :string
+
+    source_root File.expand_path("templates", __dir__)
+
+    attr_reader :add_index_name, :index_name, :table, :columns
+
+    def add_index
+      tables_list = tables.split(",")
+      @columns = columns.split(",")
+
+      tables_list.each_with_index do |table, idx|
+        next if table.empty?
+
+        @table = table.to_sym
+
+        @add_index_name = "add_index_on_#{columns.join('_')}_to_#{table}"
+        @index_name = (
+          override_index_name || "idx_#{table}_on_#{columns.join('_')}"
+        ).to_sym
+
+        template(
+          "add_index.rb",
+          "#{base_path}/#{timestamp(idx)}_#{add_index_name}.rb",
+        )
+      end
+    end
+
+    private
+
+    def timestamp(offset = 0)
+      (Time.now.utc + offset).strftime("%Y%m%d%H%M%S")
+    end
+
+    def base_path
+      Nandi.config.migration_directory || "db/safe_migrations"
+    end
+
+    def override_index_name
+      options["index_name"]&.to_sym
+    end
+  end
+end

data/lib/generators/nandi/index/templates/add_index.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class <%= add_index_name.camelize %> < Nandi::Migration
+  def up
+    add_index <%= format_value(table) %>,
+              %i<%= format_value(columns).tr('"', '') %>,
+              name: <%= format_value(index_name) %>
+  end
+
+  def down
+    remove_index <%= format_value(table) %>,
+                 %i<%= format_value(columns).tr('"', '') %>
+  end
+end

data/lib/nandi/compiled_migration.rb

@@ -24,7 +24,7 @@ module Nandi
 
       unless validation.valid?
         raise InvalidMigrationError, "Migration #{source_file_path} " \
-          "is not valid:\n#{validation.error_list}"
+                                     "is not valid:\n#{validation.error_list}"
       end
 
       self

data/lib/nandi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - GoCardless Engineering
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.25.0
+        version: 3.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.25.0
+        version: 3.3.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +234,9 @@ files:
 - lib/generators/nandi/foreign_key/templates/add_foreign_key.rb
 - lib/generators/nandi/foreign_key/templates/add_reference.rb
 - lib/generators/nandi/foreign_key/templates/validate_foreign_key.rb
+- lib/generators/nandi/index/USAGE
+- lib/generators/nandi/index/index_generator.rb
+- lib/generators/nandi/index/templates/add_index.rb
 - lib/generators/nandi/migration/USAGE
 - lib/generators/nandi/migration/migration_generator.rb
 - lib/generators/nandi/migration/templates/migration.rb
@@ -302,7 +305,8 @@ files:
 homepage: https://github.com/gocardless/nandi
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -311,7 +315,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="