Good Migrations 项目教程

1. 项目的目录结构及介绍

Good Migrations 是一个用于防止 Rails 应用在运行数据库迁移时自动加载应用代码的 gem。以下是项目的目录结构及其介绍：

good-migrations/
├── bin/
│   └── good_migrations
├── lib/
│   ├── good_migrations/
│   │   ├── railtie.rb
│   │   └── version.rb
│   └── good_migrations.rb
├── tasks/
│   └── good_migrations.rake
├── test/
│   ├── test_helper.rb
│   └── good_migrations_test.rb
├── .gitignore
├── CHANGELOG.md
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── README.md
├── Rakefile
└── good_migrations.gemspec

目录结构介绍

• bin/: 包含可执行文件 good_migrations，用于运行迁移任务。
• lib/: 包含项目的核心代码。
  • good_migrations/: 包含 railtie.rb 和 version.rb 文件，分别用于 Rails 集成和版本管理。
  • good_migrations.rb: 主入口文件。
• tasks/: 包含 Rake 任务文件 good_migrations.rake，用于定义迁移相关的任务。
• test/: 包含测试文件。
  • test_helper.rb: 测试辅助文件。
  • good_migrations_test.rb: 测试用例文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目变更日志。
• Gemfile: 项目依赖配置文件。
• Gemfile.lock: 依赖锁定文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目说明文件。
• Rakefile: Rake 任务配置文件。
• good_migrations.gemspec: gem 的规范文件。

2. 项目的启动文件介绍

Good Migrations 的启动文件主要位于 lib/good_migrations.rb 和 lib/good_migrations/railtie.rb 中。

lib/good_migrations.rb

这是 Good Migrations 的主入口文件，负责加载项目的核心功能。它通常会加载其他必要的文件和模块，并初始化 Rails 集成。

lib/good_migrations/railtie.rb

这个文件定义了 Rails 集成逻辑，确保 Good Migrations 能够在 Rails 应用启动时正确配置和运行。它通常会钩入 Rails 的生命周期事件，以便在适当的时间点执行迁移相关的操作。

3. 项目的配置文件介绍

Good Migrations 的配置主要通过 config/initializers/good_migrations.rb 文件进行。以下是一个示例配置文件：

# config/initializers/good_migrations.rb
GoodMigrations.config do |config|
  # 设置 `permit_autoloading_before` 将禁用 good_migrations
  # 对于指定时间之前的所有迁移
  # 除非你需要，否则不要设置此项
  #
  # 接受可解析的时间字符串以及 `Date` 和 `Time` 对象
  config.permit_autoloading_before = "20140728132502"
end

配置项介绍

• permit_autoloading_before: 设置一个时间点，在此时间点之前的迁移将禁用 Good Migrations 的自动加载阻止功能。这通常用于处理历史迁移中的特殊情况。

通过在 Rails 初始化器中配置 Good Migrations，可以确保在应用启动时正确应用这些配置，从而避免在运行迁移时自动加载应用代码。