nandi 0.8.0

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/nandi-enforce

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler"
+Bundler.setup(:default)
+
+require "optparse"
+
+require_relative "../lib/nandi"
+require_relative "../lib/nandi/safe_migration_enforcer"
+
+opts = {}
+OptionParser.new do |o|
+  o.on("--safe-migration-dir DIR", "directory containing Nandi migrations") do |v|
+    opts[:safe_migration_dir] = v
+  end
+  o.on("--ar-migration-dir DIR", "directory containing ActiveRecord migrations") do |v|
+    opts[:ar_migration_dir] = v
+  end
+  o.on("--require PATH", "file to require before execution") do |v|
+    opts[:require_path] = v
+  end
+  o.on("--files FILE_SPEC",
+       "Files to compile for check - eg, all, git-diff, 201901010101") do |v|
+    opts[:files] = v
+  end
+  o.on("-h", "--help") do
+    puts o
+    exit
+  end
+end.parse!
+
+enforcer = Nandi::SafeMigrationEnforcer.new(opts)
+
+enforcer.run

data/lib/generators/nandi/check_constraint/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Generates two new database migrations which will safely add an arbitrary
+    check constraint and validate it separately.
+
+Example:
+    rails generate nandi:check_constraint foos baz_or_quux_not_null
+
+    This will create:
+        db/safe_migrations/20190424123727_add_check_constraint_baz_or_quux_not_null_on_foos.rb
+        db/safe_migrations/20190424123728_validate_check_constraint_baz_or_quux_not_null_on_foos.rb
+
+Example:
+    rails generate nandi:check_constraint foos baz_or_quux_not_null --validation-timeout 20000
+
+    This will create:
+        db/safe_migrations/20190424123727_add_check_constraint_baz_or_quux_not_null_on_foos.rb
+        db/safe_migrations/20190424123728_validate_check_constraint_baz_or_quux_not_null_on_foos.rb
+
+    The statement timeout in the second migration will be set to 20,000ms.

data/lib/generators/nandi/check_constraint/check_constraint_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "nandi/formatting"
+
+module Nandi
+  class CheckConstraintGenerator < Rails::Generators::Base
+    include Nandi::Formatting
+
+    argument :table, type: :string
+    argument :name, type: :string
+    class_option :validation_timeout, type: :numeric, default: 15 * 60 * 1000
+
+    source_root File.expand_path("templates", __dir__)
+
+    attr_reader :add_check_constraint_name, :validate_check_constraint_name
+
+    def add_check_constraint
+      self.table = table.to_sym
+      self.name = name.to_sym
+
+      @add_check_constraint_name = "add_check_constraint_#{name}_on_#{table}"
+
+      template(
+        "add_check_constraint.rb",
+        "#{base_path}/#{timestamp}_#{add_check_constraint_name}.rb",
+      )
+    end
+
+    def validate_check_constraint
+      self.table = table.to_sym
+      self.name = name.to_sym
+
+      @validate_check_constraint_name = "validate_check_constraint_#{name}_on_#{table}"
+
+      template(
+        "validate_check_constraint.rb",
+        "#{base_path}/#{timestamp(1)}_#{validate_check_constraint_name}.rb",
+      )
+    end
+
+    private
+
+    def base_path
+      Nandi.config.migration_directory || "db/safe_migrations"
+    end
+
+    def timestamp(offset = 0)
+      (Time.now.utc + offset).strftime("%Y%m%d%H%M%S")
+    end
+  end
+end

data/lib/generators/nandi/check_constraint/templates/add_check_constraint.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class <%= add_check_constraint_name.camelize %> < Nandi::Migration
+  def up
+    add_check_constraint <%= format_value(table) %>,
+                         <%= format_value(name) %>,
+                         <<~SQL
+                           -- foo IS NOT NULL OR bar IS NOT NULL
+                         SQL
+  end
+
+  def down
+    drop_constraint <%= format_value(table) %>, <%= format_value(name) %>
+  end
+end

data/lib/generators/nandi/check_constraint/templates/validate_check_constraint.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class <%= validate_check_constraint_name.camelize %> < Nandi::Migration
+  def up
+    validate_constraint <%= format_value(table) %>, <%= format_value(name) %>
+  end
+
+  def down; end
+end

data/lib/generators/nandi/compile/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Takes all files from the db/nandi directory and turns
+    them into ActiveRecordmigration files.
+
+Examples:
+    rails generate nandi:compile
+        compiles all migrations that have changed since last git commit
+
+    rails generate nandi:compile --files all
+        compiles all migrations ever
+
+    rails generate nandi:compile --files 20190101010101
+        compiles specific migration
+
+    rails generate nandi:compile --files 20190101
+        compiles all migrations from January 1st 2019
+
+    rails generate nandi:compile --files >=20190101
+        compiles all migrations from January 1st 2019 and after

data/lib/generators/nandi/compile/compile_generator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "nandi"
+require "nandi/migration"
+require "nandi/file_matcher"
+require "nandi/lockfile"
+
+module Nandi
+  class CompileGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :files,
+                 type: :string,
+                 default: Nandi.config.compile_files,
+                 desc: <<-DESC
+                 Files to compile. May be one of the following:
+                 -- 'all' compiles all files
+                 -- 'git-diff' only changed
+                 -- a full or partial version timestamp, eg '20190101010101', '20190101'
+                 -- a timestamp range , eg '>=20190101010101'
+                 DESC
+
+    def compile_migration_files
+      Nandi.compile(files: files) do |results|
+        results.each do |result|
+          Nandi::Lockfile.add(
+            file_name: result.file_name,
+            source_digest: result.source_digest,
+            compiled_digest: result.compiled_digest,
+          )
+
+          unless result.migration_unchanged?
+            create_file result.output_path, result.body, force: true
+          end
+        end
+      end
+
+      Nandi::Lockfile.persist!
+    end
+
+    private
+
+    def safe_migrations_dir
+      if Nandi.config.migration_directory.nil?
+        Rails.root.join("db", "safe_migrations").to_s
+      else
+        File.expand_path(Nandi.config.migration_directory)
+      end
+    end
+
+    def output_path
+      Nandi.config.output_directory || "db/migrate"
+    end
+
+    def files
+      safe_migration_files = Dir.chdir(safe_migrations_dir) { Dir["*.rb"] }
+      FileMatcher.call(files: safe_migration_files, spec: options["files"]).
+        map { |file| File.join(safe_migrations_dir, file) }
+    end
+  end
+end

data/lib/generators/nandi/foreign_key/USAGE

@@ -0,0 +1,47 @@
+Description:
+    Generates two new database migrations which will safely add a foreign key
+    constraint and validate it separately.
+
+Example:
+    rails generate nandi:foreign_key foos bars
+
+    This will create:
+        db/safe_migrations/20190424123727_add_reference_on_bars_to_foos.rb
+        db/safe_migrations/20190424123728_add_foreign_key_on_bars_to_foos.rb
+        db/safe_migrations/20190424123729_validate_foreign_key_on_bars_to_foos.rb
+
+    These migrations will create a new column on the table foos called bar_id, a
+    new foreign key constraint on that column against the id column of bars, and
+    validate that constraint separately.
+
+Example:
+    rails generate nandi:foreign_key foos bars --type text
+
+    This will create:
+        db/safe_migrations/20190424123727_add_reference_on_bars_to_foos.rb
+        db/safe_migrations/20190424123728_add_foreign_key_on_bars_to_foos.rb
+        db/safe_migrations/20190424123729_validate_foreign_key_on_bars_to_foos.rb
+
+    These migrations will create a new text column on the table foos called bar_id,
+    a new foreign key constraint on that column against the id column of bars, and
+    validate that constraint separately.
+
+Example:
+    rails generate nandi:foreign_key foos bars --no-create-column
+
+    This will create:
+        db/safe_migrations/20190424123727_add_foreign_key_on_bars_to_foos.rb
+        db/safe_migrations/20190424123728_validate_foreign_key_on_bars_to_foos.rb
+
+    Assumes that there is a column on table foos called bar_id that points to bars.
+    Will create an FK constraint called foos_bars_fk.
+
+Example:
+    rails generate nandi:foreign_key foos bars --column special_bar_id --name my_fk
+
+    This will create:
+        db/safe_migrations/20190424123727_add_foreign_key_on_bars_to_foos.rb
+        db/safe_migrations/20190424123728_validate_foreign_key_on_bars_to_foos.rb
+
+    Assumes that there is a column on table foos called special_bar_id that points to
+    bars. Will create an FK constraint called my_fk

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "nandi/formatting"
+
+module Nandi
+  class ForeignKeyGenerator < Rails::Generators::Base
+    include Nandi::Formatting
+
+    argument :table, type: :string
+    argument :target, type: :string
+    class_option :name, type: :string
+    class_option :column, type: :string
+    class_option :type, type: :string
+    class_option :no_create_column, type: :boolean
+    class_option :validation_timeout, type: :numeric, default: 15 * 60 * 1000
+
+    source_root File.expand_path("templates", __dir__)
+
+    attr_reader :add_reference_name,
+                :add_foreign_key_name,
+                :validate_foreign_key_name
+
+    def add_reference
+      return if options["no_create_column"]
+
+      self.table = table.to_sym
+
+      @add_reference_name = "add_reference_on_#{table}_to_#{target}"
+
+      template(
+        "add_reference.rb",
+        "#{base_path}/#{timestamp}_#{add_reference_name}.rb",
+      )
+    end
+
+    def add_foreign_key
+      self.table = table.to_sym
+      self.target = target.to_sym
+
+      @add_foreign_key_name = "add_foreign_key_on_#{table}_to_#{target}"
+
+      template(
+        "add_foreign_key.rb",
+        "#{base_path}/#{timestamp(1)}_#{add_foreign_key_name}.rb",
+      )
+    end
+
+    def validate_foreign_key
+      self.table = table.to_sym
+      self.target = target.to_sym
+
+      @validate_foreign_key_name = "validate_foreign_key_on_#{table}_to_#{target}"
+
+      template(
+        "validate_foreign_key.rb",
+        "#{base_path}/#{timestamp(2)}_#{validate_foreign_key_name}.rb",
+      )
+    end
+
+    private
+
+    def type
+      options["type"]&.to_sym
+    end
+
+    def reference_name
+      target.singularize.to_sym
+    end
+
+    def base_path
+      Nandi.config.migration_directory || "db/safe_migrations"
+    end
+
+    def timestamp(offset = 0)
+      (Time.now.utc + offset).strftime("%Y%m%d%H%M%S")
+    end
+
+    def name
+      options["name"]&.to_sym || :"#{@table}_#{@target}_fk"
+    end
+
+    def column
+      options["column"]&.to_sym
+    end
+
+    def any_options?
+      options["name"] || options["column"]
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class <%= add_foreign_key_name.camelize %> < Nandi::Migration
+  def up
+    add_foreign_key <%= format_value(table) %>, <%= format_value(target) %><% if any_options? %>,
+        <% if column %>column: <%= format_value(column) %><% end %><% if column && name %>,<% end %>
+        <% if name %>name: <%= format_value(name) %><% end %> <% end %>
+  end
+
+  def down
+    drop_constraint <%= format_value(table) %>, <%= format_value(name) %>
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+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 %>
+  end
+
+  def down
+    remove_reference <%= format_value(table) %>, <%= format_value(reference_name) %>
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class <%= validate_foreign_key_name.camelize %> < Nandi::Migration
+  def up
+    validate_constraint <%= format_value(@table) %>, <%= format_value(name) %>
+  end
+
+  def down; end
+end

data/lib/generators/nandi/migration/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a new database migration which uses the
+    nandi DSL in db/nandi
+
+Example:
+    rails generate nandi:migration add_stuff_to_things
+
+    This will create:
+        db/safe_migrations/20190424123727_add_stuff_to_things.rb

data/lib/generators/nandi/migration/migration_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Nandi
+  class MigrationGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+
+    def create_migration_file
+      timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+
+      template(
+        "migration.rb",
+        "#{base_path}/#{timestamp}_#{file_name.underscore}.rb",
+      )
+    end
+
+    private
+
+    def base_path
+      Nandi.config.migration_directory || "db/safe_migrations"
+    end
+  end
+end