nandi 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9c08faeee8155ae5b0e5357cabca63c2f31bfd65fb464e16991b47c4b9cab75
-  data.tar.gz: 0e408aa01adaf0ce11560acef08d899c208d2c4e3afdd31b3fb9777a0d0b2408
+  metadata.gz: ba61fdd052ec58212031846c92ad947cb1f7cb8c033271b101f5973a2b7074f6
+  data.tar.gz: b0c30216fb5544927d1d3b47ef0ad87d935a9ea8859c37a8779662a65f88d9f5
 SHA512:
-  metadata.gz: fe9b90ee4085d5f7d208e481f9ae4fca325f87ab37ff7b3c1a74063adbe65a7777ab66e8afbb8b4d18408362ef1c71f88884eeab6643c19ffd3e8de3f98b007f
-  data.tar.gz: fdbca6280d8c5299661b78fa1163593f903605c056337c3e55b3ca512370717fa7c8af97bfe055393205a6c15fe224aa32a97616dfec8fb118daf39a10b42ca0
+  metadata.gz: f4c0ecfcb5e1a84c4a8b2e0721f4e48a8abff3f6bde78f04184544e9004987a4f155eebb3342b780fc793bc2d5104a8a98d7d25c6fcc9f8da43cdd70e0b5f9fd
+  data.tar.gz: aedffb405097c5d9e988e001eab0c929ed0fab64b1b9b04a534051fa59aa16634c3c9071bf5daf31b7c416bfa94679b020685bd8c201c78d0552ebbcf60e0a75

data/README.md

@@ -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
 
@@ -286,12 +286,6 @@ create_table :widgets do |t|
 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!
-
-### `#remove_reference(table, ref_name, **extra_args)`
-Removes a reference column.
-
 ### `#remove_column(table, name, **extra_args)`
 Remove an existing column.
 

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/instructions.rb

@@ -5,8 +5,6 @@ require "nandi/instructions/remove_index"
 require "nandi/instructions/create_table"
 require "nandi/instructions/drop_table"
 require "nandi/instructions/add_column"
-require "nandi/instructions/add_reference"
-require "nandi/instructions/remove_reference"
 require "nandi/instructions/remove_column"
 require "nandi/instructions/add_foreign_key"
 require "nandi/instructions/drop_constraint"

data/lib/nandi/migration.rb

@@ -188,31 +188,6 @@ module Nandi
       )
     end
 
-    # 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!
-    # @param table [Symbol, String] The name of the table to add the column to
-    # @param ref_name [Symbol, String] The referenced column name
-    # @param kwargs [Hash] Arbitrary options to be passed to the backend.
-    def add_reference(table, ref_name, **kwargs)
-      current_instructions << Instructions::AddReference.new(
-        table: table,
-        ref_name: ref_name,
-        **kwargs,
-      )
-    end
-
-    # Removes a reference column.
-    # @param table [Symbol, String] The name of the table to remove the reference from
-    # @param ref_name [Symbol, String] The referenced column name
-    # @param kwargs [Hash] Arbitrary options to be passed to the backend.
-    def remove_reference(table, ref_name, **kwargs)
-      current_instructions << Instructions::RemoveReference.new(
-        table: table,
-        ref_name: ref_name,
-        **kwargs,
-      )
-    end
-
     # Remove an existing column.
     # @param table [Symbol, String] The name of the table to remove the column
     #   from.

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

@@ -82,18 +82,6 @@ module Nandi
           formatted_property :extra_args
         end
 
-        class AddReferenceCell < Base
-          formatted_property :table
-          formatted_property :ref_name
-          formatted_property :extra_args
-        end
-
-        class RemoveReferenceCell < Base
-          formatted_property :table
-          formatted_property :ref_name
-          formatted_property :extra_args
-        end
-
         class RemoveColumnCell < Base
           formatted_property :table
           formatted_property :name

data/lib/nandi/validation.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "nandi/validation/add_column_validator"
-require "nandi/validation/add_reference_validator"
 require "nandi/validation/remove_index_validator"
 require "nandi/validation/each_validator"
 require "nandi/validation/result"

data/lib/nandi/validation/each_validator.rb

@@ -21,8 +21,6 @@ module Nandi
           RemoveIndexValidator.call(instruction)
         when :add_column
           AddColumnValidator.call(instruction)
-        when :add_reference
-          AddReferenceValidator.call(instruction)
         else
           success
         end

data/lib/nandi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nandi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
-- James Turley
+- GoCardless Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +142,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -208,7 +214,7 @@ dependencies:
         version: '0.9'
 description: 
 email:
-- jamesturley@gocardless.com
+- engineering@gocardless.com
 executables:
 - nandi-enforce
 extensions: []
@@ -246,7 +252,6 @@ files:
 - lib/nandi/instructions/add_column.rb
 - lib/nandi/instructions/add_foreign_key.rb
 - lib/nandi/instructions/add_index.rb
-- lib/nandi/instructions/add_reference.rb
 - lib/nandi/instructions/change_column_default.rb
 - lib/nandi/instructions/create_table.rb
 - lib/nandi/instructions/drop_constraint.rb
@@ -255,7 +260,6 @@ files:
 - lib/nandi/instructions/remove_column.rb
 - lib/nandi/instructions/remove_index.rb
 - lib/nandi/instructions/remove_not_null_constraint.rb
-- lib/nandi/instructions/remove_reference.rb
 - lib/nandi/instructions/validate_constraint.rb
 - lib/nandi/lockfile.rb
 - lib/nandi/migration.rb
@@ -269,19 +273,18 @@ files:
 - lib/nandi/timeout_policies/concurrent.rb
 - lib/nandi/validation.rb
 - lib/nandi/validation/add_column_validator.rb
-- lib/nandi/validation/add_reference_validator.rb
 - lib/nandi/validation/each_validator.rb
 - lib/nandi/validation/failure_helpers.rb
 - lib/nandi/validation/remove_index_validator.rb
 - 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
 - lib/templates/nandi/renderers/active_record/instructions/add_foreign_key/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/add_index/show.rb.erb
-- lib/templates/nandi/renderers/active_record/instructions/add_reference/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/change_column_default/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/create_table/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/drop_constraint/show.rb.erb
@@ -290,10 +293,10 @@ files:
 - lib/templates/nandi/renderers/active_record/instructions/remove_column/show.rb.erb
 - lib/templates/nandi/renderers/active_record/instructions/remove_index/show.rb.erb
 - 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: 
 rdoc_options: []

data/lib/nandi/instructions/add_reference.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Nandi
-  module Instructions
-    class AddReference
-      attr_reader :table, :ref_name, :extra_args
-
-      def initialize(table:, ref_name:, **kwargs)
-        @table = table
-        @ref_name = ref_name
-        @extra_args = kwargs
-      end
-
-      def procedure
-        :add_reference
-      end
-
-      def lock
-        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
-      end
-    end
-  end
-end

data/lib/nandi/instructions/remove_reference.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Nandi
-  module Instructions
-    class RemoveReference
-      attr_reader :table, :ref_name, :extra_args
-
-      def initialize(table:, ref_name:, **kwargs)
-        @table = table
-        @ref_name = ref_name
-        @extra_args = kwargs
-      end
-
-      def procedure
-        :remove_reference
-      end
-
-      def lock
-        Nandi::Migration::LockWeights::ACCESS_EXCLUSIVE
-      end
-    end
-  end
-end

data/lib/nandi/validation/add_reference_validator.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require "nandi/validation/failure_helpers"
-
-module Nandi
-  module Validation
-    class AddReferenceValidator
-      include Nandi::Validation::FailureHelpers
-
-      def self.call(instruction)
-        new(instruction).call
-      end
-
-      def initialize(instruction)
-        @instruction = instruction
-      end
-
-      def call
-        foreign_key = instruction.extra_args.fetch(:foreign_key) { false }
-
-        assert(
-          !foreign_key,
-          foreign_key_message,
-        )
-      end
-
-      private
-
-      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 " \
-          "nandi:foreign_key generator, to do this."
-      end
-
-      attr_reader :instruction
-    end
-  end
-end

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

@@ -1,5 +0,0 @@
-add_reference(
-  <%= table %>,
-  <%= ref_name %>,
-  <%= extra_args %>
-)

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

@@ -1,5 +0,0 @@
-remove_reference(
-  <%= table %>,
-  <%= ref_name %>,
-  <%= extra_args %>
-)