Clearance 开源项目教程

Clearance 开源项目教程

clearanceRails authentication with email & password.项目地址:https://gitcode.com/gh_mirrors/cl/clearance

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

Clearance 是一个用于 Rails 应用的简单认证系统。以下是其主要目录结构及其介绍：

clearance/
├── app/
│   ├── controllers/
│   │   └── clearance/
│   │       ├── sessions_controller.rb
│   │       └── users_controller.rb
│   ├── models/
│   │   └── user.rb
│   └── views/
│       └── clearance/
│           ├── sessions/
│           │   └── new.html.erb
│           └── users/
│               └── new.html.erb
├── config/
│   ├── initializers/
│   │   └── clearance.rb
│   └── routes.rb
├── db/
│   └── migrate/
│       └── ...
├── lib/
│   └── clearance/
│       └── password.rb
├── spec/
│   └── clearance/
│       ├── clearance_spec.rb
│       └── features/
│           └── sign_in_out_spec.rb
└── Gemfile

• app/：包含应用程序的控制器、模型和视图。
  • controllers/clearance/：包含处理用户认证的控制器。
  • models/：包含用户模型。
  • views/clearance/：包含用户认证相关的视图。
• config/：包含应用程序的配置文件。
  • initializers/clearance.rb：Clearance 的配置文件。
  • routes.rb：应用程序的路由配置。
• db/migrate/：包含数据库迁移文件。
• lib/clearance/：包含 Clearance 的辅助模块。
• spec/：包含测试文件。
• Gemfile：包含项目依赖的 Gem 文件。

2. 项目的启动文件介绍

Clearance 项目的启动文件主要是 config/initializers/clearance.rb。这个文件包含了 Clearance 的配置选项，例如设置邮件发送者、重定向路径等。

Clearance.configure do |config|
  config.mailer_sender = 'reply@example.com'
  config.redirect_url = '/'
end

3. 项目的配置文件介绍

Clearance 的配置文件 config/initializers/clearance.rb 允许开发者自定义认证系统的各种行为。以下是一些常见的配置选项：

• mailer_sender：设置邮件发送者的地址。
• redirect_url：设置用户登录后的重定向路径。
• password_strategy：设置密码策略。
• cookie_expiration：设置 Cookie 的过期时间。

Clearance.configure do |config|
  config.mailer_sender = 'reply@example.com'
  config.redirect_url = '/'
  config.password_strategy = Clearance::PasswordStrategies::BCrypt
  config.cookie_expiration = lambda { 1.year.from_now.utc }
end

通过这些配置选项，开发者可以根据自己的需求调整 Clearance 的行为。

clearanceRails authentication with email & password.项目地址:https://gitcode.com/gh_mirrors/cl/clearance