FriendlyId 开源项目教程

FriendlyId 开源项目教程

friendly_idFriendlyId is the “Swiss Army bulldozer” of slugging and permalink plugins for ActiveRecord. It allows you to create pretty URL’s and work with human-friendly strings as if they were numeric ids for ActiveRecord models.项目地址:https://gitcode.com/gh_mirrors/fr/friendly_id

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

FriendlyId 是一个用于生成友好 URL 的 Ruby gem。以下是其主要目录结构及其介绍：

friendly_id/
├── app/
│   └── models/
│       └── friendly_id.rb
├── config/
│   └── initializers/
│       └── friendly_id.rb
├── lib/
│   ├── friendly_id/
│   │   ├── version.rb
│   │   └── ...
│   └── friendly_id.rb
├── spec/
│   └── ...
├── Gemfile
├── Gemfile.lock
├── README.md
└── friendly_id.gemspec

• app/models/friendly_id.rb: 包含与 FriendlyId 相关的模型定义。
• config/initializers/friendly_id.rb: 初始化配置文件。
• lib/friendly_id/: 包含核心功能的实现。
• spec/: 包含测试文件。
• Gemfile 和 Gemfile.lock: 依赖管理文件。
• README.md: 项目说明文档。
• friendly_id.gemspec: gem 的规范文件。

2. 项目的启动文件介绍

FriendlyId 的启动文件主要是 lib/friendly_id.rb，它负责加载 FriendlyId 的核心功能和相关依赖。

require "friendly_id/version"
require "friendly_id/configuration"
require "friendly_id/slug"
require "friendly_id/history"
require "friendly_id/scoped"
require "friendly_id/simple_i18n"
require "friendly_id/slug_generator"
require "friendly_id/tasks"
require "friendly_id/railtie" if defined?(Rails)

module FriendlyId
  # 核心模块定义
end

3. 项目的配置文件介绍

FriendlyId 的配置文件位于 config/initializers/friendly_id.rb，它允许用户自定义 FriendlyId 的行为。

FriendlyId.configure do |config|
  config.use :slugged
  config.use :finders
  config.use :history
  config.use :scoped
  config.use :simple_i18n

  config.slug_column = 'slug'
  config.slug_generator_class = FriendlyId::SlugGenerator
  config.sequence_separator = '-'
  config.allow_nil = false
  config.base = :name
end

• use: 指定要使用的 FriendlyId 插件。
• slug_column: 指定存储 slug 的列名。
• slug_generator_class: 指定 slug 生成器的类。
• sequence_separator: 指定序列分隔符。
• allow_nil: 允许 slug 为空。
• base: 指定生成 slug 的基础字段。

friendly_idFriendlyId is the “Swiss Army bulldozer” of slugging and permalink plugins for ActiveRecord. It allows you to create pretty URL’s and work with human-friendly strings as if they were numeric ids for ActiveRecord models.项目地址:https://gitcode.com/gh_mirrors/fr/friendly_id