Module: Nandi

Defined in:
lib/nandi.rb,
lib/nandi/config.rb,
lib/nandi/version.rb,
lib/nandi/lockfile.rb,
lib/nandi/file_diff.rb,
lib/nandi/migration.rb,
lib/nandi/renderers.rb,
lib/nandi/validator.rb,
lib/nandi/formatting.rb,
lib/nandi/file_matcher.rb,
lib/nandi/instructions.rb,
lib/nandi/multi_database.rb,
lib/nandi/timeout_policies.rb,
lib/nandi/validation/result.rb,
lib/nandi/compiled_migration.rb,
lib/nandi/multi_db_generator.rb,
lib/nandi/migration_modifiers.rb,
lib/nandi/migration_violations.rb,
lib/nandi/instructions/add_index.rb,
lib/nandi/instructions/add_column.rb,
lib/nandi/instructions/drop_table.rb,
lib/nandi/renderers/active_record.rb,
lib/nandi/safe_migration_enforcer.rb,
lib/nandi/migration_modifiers/base.rb,
lib/nandi/instructions/create_table.rb,
lib/nandi/instructions/remove_index.rb,
lib/nandi/validation/each_validator.rb,
lib/nandi/instructions/add_reference.rb,
lib/nandi/instructions/remove_column.rb,
lib/nandi/validation/failure_helpers.rb,
lib/nandi/timeout_policies/concurrent.rb,
lib/nandi/instructions/add_foreign_key.rb,
lib/nandi/instructions/drop_constraint.rb,
lib/nandi/validation/timeout_validator.rb,
lib/nandi/instructions/remove_reference.rb,
lib/nandi/validation/add_index_validator.rb,
lib/nandi/validation/add_column_validator.rb,
lib/generators/nandi/index/index_generator.rb,
lib/nandi/instructions/validate_constraint.rb,
lib/nandi/renderers/active_record/generate.rb,
lib/nandi/instructions/add_check_constraint.rb,
lib/nandi/timeout_policies/access_exclusive.rb,
lib/nandi/validation/remove_index_validator.rb,
lib/nandi/instructions/change_column_default.rb,
lib/nandi/validation/add_reference_validator.rb,
lib/nandi/instructions/irreversible_migration.rb,
lib/generators/nandi/compile/compile_generator.rb,
lib/nandi/renderers/active_record/instructions.rb,
lib/nandi/instructions/remove_not_null_constraint.rb,
lib/generators/nandi/migration/migration_generator.rb,
lib/generators/nandi/foreign_key/foreign_key_generator.rb,
lib/nandi/migration_modifiers/create_table_validates_fks.rb,
lib/generators/nandi/not_null_check/not_null_check_generator.rb,
lib/generators/nandi/check_constraint/check_constraint_generator.rb

Defined Under Namespace

Modules: Formatting, Instructions, MigrationModifiers, MultiDbGenerator, Renderers, TimeoutPolicies, Validation Classes: CheckConstraintGenerator, CompileGenerator, CompiledMigration, Config, Error, FileDiff, FileMatcher, ForeignKeyGenerator, IndexGenerator, Lockfile, Migration, MigrationGenerator, MigrationViolations, MultiDatabase, NotNullCheckGenerator, SafeMigrationEnforcer, Validator

Constant Summary collapse

DEPRECATOR = 
ActiveSupport::Deprecation.new("4.0", "Nandi")
VERSION = 
"3.0.0"

Class Method Summary collapse

Class Method Details

.compile(files:, db_name: nil) {|compiled| ... } ⇒ Object

Yields:

  • (compiled) 


15
16
17
18
19
20
 
# File 'lib/nandi.rb', line 15

def compile(files:, db_name: nil)
  compiled = files.
    map { |f| CompiledMigration.build(file_name: f, db_name: db_name) }

  yield compiled
end

.config ⇒ Object 



31
32
33
 
# File 'lib/nandi.rb', line 31

def config
  @config ||= Config.new
end

.configure {|config| ... } ⇒ Object

Yields:



22
23
24
25
 
# File 'lib/nandi.rb', line 22

def configure
  yield config
  config.validate!
end

.validator ⇒ Object 



27
28
29
 
# File 'lib/nandi.rb', line 27

def validator
  Nandi::Validator
end