has_secure_token 项目使用教程

has_secure_token 项目使用教程

has_secure_tokenCreate uniques random tokens for any model in ruby on rails. Backport of ActiveRecord::SecureToken 5 to AR 3.x and 4.x项目地址:https://gitcode.com/gh_mirrors/ha/has_secure_token

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

has_secure_token/
├── Gemfile
├── LICENSE.txt
├── README.md
├── Rakefile
├── gemfiles/
├── lib/
│   ├── has_secure_token.rb
│   └── has_secure_token/
│       └── version.rb
├── test/
│   ├── test_helper.rb
│   └── has_secure_token_test.rb
└── has_secure_token.gemspec

目录结构介绍

• Gemfile: 定义了项目所需的依赖。
• LICENSE.txt: 项目的许可证文件。
• README.md: 项目说明文档。
• Rakefile: 用于定义Rake任务。
• gemfiles/: 存放不同环境下的Gemfile。
• lib/: 核心代码目录。
  • has_secure_token.rb: 主文件，包含主要功能实现。
  • has_secure_token/version.rb: 版本信息文件。
• test/: 测试文件目录。
  • test_helper.rb: 测试辅助文件。
  • has_secure_token_test.rb: 主要测试文件。
• has_secure_token.gemspec: 项目的gemspec文件，定义了gem的详细信息。

2. 项目的启动文件介绍

项目的启动文件主要是 lib/has_secure_token.rb，该文件包含了 HasSecureToken 模块的定义，提供了生成唯一安全令牌的功能。

require "active_support/core_ext/securerandom"

module HasSecureToken
  extend ActiveSupport::Concern

  module ClassMethods
    def has_secure_token(attribute = :token, length: 24)
      define_method("regenerate_#{attribute}") do
        update! attribute => self.class.generate_unique_secure_token(length: length)
      end

      before_create do
        send("#{attribute}=", self.class.generate_unique_secure_token(length: length)) unless send(attribute).present?
      end
    end

    def generate_unique_secure_token(length: 24)
      SecureRandom.base58(length)
    end
  end
end

启动文件介绍

• require "active_support/core_ext/securerandom": 引入 SecureRandom 模块。
• module HasSecureToken: 定义了 HasSecureToken 模块。
• module ClassMethods: 定义了类方法，包括 has_secure_token 和 generate_unique_secure_token。
• define_method("regenerate_#{attribute}"): 定义了重新生成令牌的方法。
• before_create: 在创建对象之前生成令牌。

3. 项目的配置文件介绍

项目的配置文件主要是 has_secure_token.gemspec，该文件定义了gem的详细信息，包括名称、版本、作者、描述、依赖等。

Gem::Specification.new do |spec|
  spec.name          = "has_secure_token"
  spec.version       = HasSecureToken::VERSION
  spec.authors       = ["Roberto Miranda"]
  spec.email         = ["robertomiranda@hassecuretoken.com"]
  spec.summary       = %q{Create uniques random tokens for any model in ruby on rails.}
  spec.description   = %q{HasSecureToken provides an easy way to generate unique random tokens for any model in ruby on rails.}
  spec.homepage      = "https://github.com/robertomiranda/has_secure_token"
  spec.license       = "MIT"

  spec.files         = `git ls-files -z`.split("\x0")
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_development_dependency "bundler", "~> 1.7"
  spec.add_development_dependency "rake", "~> 10.0"
  spec.

has_secure_tokenCreate uniques random tokens for any model in ruby on rails. Backport of ActiveRecord::SecureToken 5 to AR 3.x and 4.x项目地址:https://gitcode.com/gh_mirrors/ha/has_secure_token