开源项目 Marginalia 使用教程

开源项目 Marginalia 使用教程

marginaliaAttach comments to ActiveRecord's SQL queries项目地址:https://gitcode.com/gh_mirrors/ma/marginalia

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

Marginalia 项目的目录结构如下：

marginalia/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
├── config/
│   ├── application.rb
│   ├── database.yml
├── db/
│   ├── migrate/
│   ├── seeds.rb
├── lib/
│   ├── tasks/
├── public/
│   ├── images/
│   ├── javascripts/
│   ├── stylesheets/
├── spec/
│   ├── controllers/
│   ├── models/
│   ├── views/
├── Gemfile
├── Gemfile.lock
├── Rakefile
└── README.md

目录介绍

• app/: 包含应用程序的主要代码，分为 controllers、models 和 views 三个子目录。
• config/: 包含应用程序的配置文件，如 application.rb 和 database.yml。
• db/: 包含数据库相关的文件，如迁移文件和种子数据。
• lib/: 包含自定义库和任务。
• public/: 包含静态文件，如图片、JavaScript 和样式表。
• spec/: 包含测试代码。
• Gemfile 和 Gemfile.lock: 定义项目的依赖关系。
• Rakefile: 定义 Rake 任务。
• README.md: 项目说明文档。

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 Marginalia
  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/ 目录下，包括：

config/application.rb

如上所述，这是应用程序的主配置文件，包含基本配置和环境设置。

config/database.yml

这是数据库配置文件，定义了不同环境下的数据库连接信息。

default: &default
  adapter: postgresql
  encoding: unicode
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>

development:
  <<: *default
  database: marginalia_development

test:
  <<: *default
  database: marginalia_test

production:
  <<: *default
  database: marginalia_production
  username: marginalia
  password: <%= ENV['MARGINALIA_DATABASE_PASSWORD'] %>

config/environments/

该目录包含不同环境的配置文件，如 development.rb、test.rb 和 production.rb，分别定义了开发、测试和生产环境的特定配置。

# config/environments/development.rb
Rails.application.configure do
  # Settings specified here will take precedence over those in config/application.rb.

  # In the development environment your application's code is reloaded on

marginaliaAttach comments to ActiveRecord's SQL queries项目地址:https://gitcode.com/gh_mirrors/ma/marginalia