Rack-Dev-Mark 使用教程

Rack-Dev-Mark 使用教程

rack-dev-markShow dev mark on development env项目地址:https://gitcode.com/gh_mirrors/ra/rack-dev-mark

项目介绍

Rack-Dev-Mark 是一个用于在开发环境中标记应用的 Ruby gem。它可以帮助开发者区分开发环境和生产环境，通过在页面上添加特定的标记，如标题或 GitHub Fork 标签。这个项目适用于 Rack 应用、Middleman 和 Rails 应用。

项目快速启动

安装

首先，将以下代码添加到你的 Gemfile 中：

gem "rack-dev-mark"

然后运行：

bundle install

配置

对于 Rack 应用

在你的 Rack 应用中添加以下代码：

require 'rack/dev-mark'
use Rack::DevMark::Middleware
run MyApp

对于 Rails 应用

在 config/environments/development.rb 中添加：

Rails.application.configure do
  config.rack_dev_mark.enable = true
end

或者在 config/application.rb 中添加：

module MyApp
  class Application < Rails::Application
    config.rack_dev_mark.enable = Rails.env.production?
  end
end

应用案例和最佳实践

自定义环境字符串

你可以手动设置自定义的环境字符串：

module MyApp
  class Application < Rails::Application
    config.rack_dev_mark.env = 'foo'
  end
end

临时禁用标记

使用 skip_rack_dev_mark 控制器辅助方法可以临时禁用标记：

class FooController < ApplicationController
  skip_rack_dev_mark only: [:iframe]

  def index
    # Do something
  end

  def iframe
    # Do something
  end
end

典型生态项目

Rack-Dev-Mark 可以与其他 Rack 中间件和 Rails 插件结合使用，例如：

• Rack::Attack: 用于防止恶意请求。
• Rack::Deflater: 用于压缩响应内容。
• Rails::Dev::Cache: 用于在开发环境中启用缓存。

通过结合这些工具，可以进一步优化开发环境，提高开发效率。

rack-dev-markShow dev mark on development env项目地址:https://gitcode.com/gh_mirrors/ra/rack-dev-mark