开源项目 `unit-record` 使用文档

开源项目 unit-record 使用文档

unit-recordEnables testing ActiveRecord classes without hitting the database.项目地址:https://gitcode.com/gh_mirrors/un/unit-record

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

unit-record/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── helpers/
├── config/
│   ├── application.rb
│   ├── database.yml
│   └── routes.rb
├── db/
│   ├── migrate/
│   └── seeds.rb
├── lib/
│   └── tasks/
├── public/
│   ├── images/
│   ├── javascripts/
│   └── stylesheets/
└── test/
    ├── controllers/
    ├── models/
    └── test_helper.rb

目录结构介绍

• app/: 包含应用程序的主要代码，包括控制器、模型、视图和辅助方法。
  • controllers/: 存放控制器文件。
  • models/: 存放模型文件。
  • views/: 存放视图文件。
  • helpers/: 存放辅助方法文件。
• config/: 包含应用程序的配置文件。
  • application.rb: 应用程序的主要配置文件。
  • database.yml: 数据库配置文件。
  • routes.rb: 路由配置文件。
• db/: 包含数据库相关文件。
  • migrate/: 存放数据库迁移文件。
  • seeds.rb: 数据库种子文件。
• lib/: 包含自定义库和任务。
  • tasks/: 存放自定义任务文件。
• public/: 包含公共资源文件。
  • images/: 存放图片文件。
  • javascripts/: 存放JavaScript文件。
  • stylesheets/: 存放CSS文件。
• test/: 包含测试文件。
  • controllers/: 存放控制器测试文件。
  • models/: 存放模型测试文件。
  • test_helper.rb: 测试辅助文件。

2. 项目的启动文件介绍

项目的启动文件主要是 config/application.rb。这个文件包含了应用程序的基本配置，如应用程序名称、环境设置等。

# config/application.rb
require_relative "boot"

require "rails"
# Pick the frameworks you want:
require "active_model/railtie"
require "active_job/railtie"
require "active_record/railtie"
require "active_storage/engine"
require "action_controller/railtie"
require "action_mailer/railtie"
require "action_mailbox/engine"
require "action_text/engine"
require "action_view/railtie"
require "action_cable/engine"
require "rails/test_unit/railtie"

# Require the gems listed in Gemfile, including any gems
# you've limited to :test, :development, or :production.
Bundler.require(*Rails.groups)

module UnitRecord
  class Application < Rails::Application
    # Initialize configuration defaults for originally generated Rails version.
    config.load_defaults 6.1

    # Configuration for the application, engines, and railties goes here.
    #
    # These settings can be overridden in specific environments using the files
    # in config/environments, which are processed later.
    #
    # config.time_zone = "Central Time (US & Canada)"
    # config.eager_load_paths << Rails.root.join("extras")
  end
end

3. 项目的配置文件介绍

数据库配置文件

数据库配置文件 config/database.yml 包含了数据库的连接信息，如数据库名称、用户名、密码等。

# config/database.yml
default: &default
  adapter: sqlite3
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000

development:
  <<: *default
  database: db/development.sqlite3

test:
  <<: *default
  database: db/test.sqlite3

production:
  <<: *default
  database: db/production.sqlite3

路由配置文件

路由配置文件 config/routes.rb 定义了应用程序的URL路由规则。

unit-recordEnables testing ActiveRecord classes without hitting the database.项目地址:https://gitcode.com/gh_mirrors/un/unit-record