ActiveRecord::PostgresEnum 项目教程
1. 项目的目录结构及介绍
activerecord-postgres_enum/
├── bin/
├── lib/
│ ├── activerecord-postgres_enum/
│ │ ├── migrations.rb
│ │ ├── schema_dumper.rb
│ │ └── version.rb
│ └── activerecord-postgres_enum.rb
├── spec/
├── .gitignore
├── .rspec
├── .standard.yml
├── Appraisals
├── CODE_OF_CONDUCT.md
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
├── activerecord-postgres_enum.gemspec
├── dip.yml
├── docker-compose.yml
├── lefthook-local.dip_example.yml
├── lefthook.yml
目录结构介绍
bin/
: 包含项目的可执行文件。lib/
: 包含项目的主要代码文件。activerecord-postgres_enum/
: 包含项目的核心功能实现。migrations.rb
: 迁移文件支持。schema_dumper.rb
: 模式导出支持。version.rb
: 版本信息。
activerecord-postgres_enum.rb
: 项目的主入口文件。
spec/
: 包含项目的测试文件。.gitignore
: Git 忽略文件配置。.rspec
: RSpec 配置文件。.standard.yml
: 代码风格配置文件。Appraisals
: 多版本测试配置文件。CODE_OF_CONDUCT.md
: 行为准则文件。Gemfile
: 依赖管理文件。LICENSE.txt
: 许可证文件。README.md
: 项目说明文件。Rakefile
: Rake 任务配置文件。activerecord-postgres_enum.gemspec
: 项目 gem 配置文件。dip.yml
: Dip 配置文件。docker-compose.yml
: Docker 配置文件。lefthook-local.dip_example.yml
: Lefthook 本地配置示例文件。lefthook.yml
: Lefthook 配置文件。
2. 项目的启动文件介绍
项目的启动文件是 lib/activerecord-postgres_enum.rb
,它负责加载项目所需的所有模块和文件。
require "active_record"
require "activerecord-postgres_enum/version"
require "activerecord-postgres_enum/migrations"
require "activerecord-postgres_enum/schema_dumper"
module ActiveRecord
module PostgresEnum
end
end
启动文件介绍
require "active_record"
: 加载 ActiveRecord 库。require "activerecord-postgres_enum/version"
: 加载版本信息文件。require "activerecord-postgres_enum/migrations"
: 加载迁移支持文件。require "activerecord-postgres_enum/schema_dumper"
: 加载模式导出支持文件。module ActiveRecord::PostgresEnum
: 定义主模块。
3. 项目的配置文件介绍
Gemfile
Gemfile
是项目的依赖管理文件,定义了项目运行所需的所有 gem 依赖。
source "https://rubygems.org"
gem "activerecord", ">= 5.2"
gem "pg", ">= 0"
group :development, :test do
gem "appraisal", "~> 2.2"
gem "bundler", ">= 1.16"
gem "combustion", "~> 1.1"
gem "pry-byebug", "~> 3"
gem "rake", "~> 13.0"
gem "rspec-rails", "~> 5.0"
gem "standard", "~> 1.1"
end
activerecord-postgres_enum.gemspec
activerecord-postgres_enum.gemspec
是项目的 gem 配置文件,定义了 gem 的元数据和依赖。
Gem::Specification.new do |spec|
spec.name = "activerecord-postgres_enum"
spec.version = ActiveRecord::Post