开源项目 `artsy/garner` 使用教程

开源项目 artsy/garner 使用教程

garnerA set of Rack middleware and cache helpers that implement various caching strategies.项目地址:https://gitcode.com/gh_mirrors/ga/garner

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

garner/
├── bin/
│   └── garner
├── lib/
│   ├── garner
│   │   ├── cache.rb
│   │   ├── config.rb
│   │   └── strategies.rb
│   └── garner.rb
├── spec/
│   ├── garner_spec.rb
│   └── spec_helper.rb
├── .gitignore
├── .rspec
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
└── garner.gemspec

• bin/: 包含项目的可执行文件。
• lib/: 包含项目的主要代码。
  • garner/: 包含核心功能文件。
    • cache.rb: 缓存逻辑。
    • config.rb: 配置逻辑。
    • strategies.rb: 缓存策略。
  • garner.rb: 主入口文件。
• spec/: 包含测试文件。
  • garner_spec.rb: 主要测试文件。
  • spec_helper.rb: 测试辅助文件。
• .gitignore: Git 忽略文件配置。
• .rspec: RSpec 配置文件。
• Gemfile: 依赖管理文件。
• Gemfile.lock: 依赖锁定文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• garner.gemspec: 项目 gem 规范文件。

2. 项目的启动文件介绍

项目的启动文件是 lib/garner.rb。这个文件是项目的入口点，负责加载项目的核心功能和配置。

require "garner/version"
require "garner/cache"
require "garner/config"
require "garner/strategies"

module Garner
  # 项目初始化代码
end

3. 项目的配置文件介绍

项目的配置文件是 lib/garner/config.rb。这个文件定义了项目的配置选项和默认值。

module Garner
  class Config
    attr_accessor :cache_store, :default_ttl

    def initialize
      @cache_store = :memory_store
      @default_ttl = 3600
    end
  end

  def self.config
    @config ||= Config.new
  end

  def self.configure
    yield(config) if block_given?
  end
end

通过这个配置文件，可以设置缓存存储方式和默认的缓存时间。例如：

Garner.configure do |config|
  config.cache_store = :redis_store
  config.default_ttl = 7200
end

以上是 artsy/garner 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

garnerA set of Rack middleware and cache helpers that implement various caching strategies.项目地址:https://gitcode.com/gh_mirrors/ga/garner