Ruby China 社区 Gem 节点

WhereableScope: 把 scope 用作 where 參數

mizuhashi — Thu, 29 Jan 2026 13:56:51 +0800

https://github.com/onyxblade/whereable_scope

例子：

class Order < ActiveRecord::Base
  has_one :order_address
  has_one :address, through: :order_address

  scope :by_address, ->(address) { joins(:order_address).where(order_addresses: { address: address }) }

  # 把by_address scope註冊為可用的where參數
  whereable_scope :by_address, as: :address
end

# 現在你可以：
Order.where(address: address)

僅供娛樂

做了一个嵌套表单的 gem

hungle — Wed, 21 Jun 2023 18:31:32 +0800

我做了一个 gem，使用 Stimulus JS 处理动态嵌套表单。
这个 gem 与Cocoon 相似，但不需要 jQuery 库。
Github 地址：https://github.com/hungle00/rondo_form

欢迎试用和 star!!!

用纯 Ruby 实现了国密 SM2 密码算法

numbcoder — Wed, 10 May 2023 17:10:54 +0800

OpenSSL 自 1.1.1 之后，已经加入了国密标准 SM2/SM3/SM4 算法实现，但是 Ruby 标准库中对 OpenSSL 只是做了一个通用的封装，很多特殊的算法调用需要自己去封装 C API。比如 SM2 就是基于 ECC（椭圆加密算法）的非对称加密算法，同时还能数字签名，Ruby 并没有封装 SM2 的具体 API，好在已经封装了 OpenSSL 中 ECC 和 BigNumber 相关的操作，实现起来比别的语言要省心很多。

Github 地址：https://github.com/numbcoder/sm2-crypto

算法实现基于国家密码管理局发布的 SM2 椭圆曲线公钥密码算法，详细用法可以参照 Readme 和测试用例

基本用法：

require 'sm2_crypto'

# 生成密钥对
keypair = OpenSSL::PKey::EC.generate("SM2")
private_key = keypair.private_key.to_s(2)
public_key = keypair.public_key.to_octet_string(:uncompressed)

# 加密
message = "Hello, SM2 encryption!"
encrypted_data = SM2Crypto.encrypt(public_key, message)
# 解密
decrypted_message = SM2Crypto.decrypt(private_key, encrypted_data)

# 签名
sign = SM2Crypto.sign(private_key, message)
# 验签
SM2Crypto.verify(public_key, message, sign)

SM3/SM4 是通用实现，可以直接调用，无需自己封装

# SM3 摘要算法：
OpenSSL::Digest.new("sm3", "abc").to_s
# => "66c7f0f462eeedd9d1f2d46bdc10e4e24167c4875cf2f7a2297da02b8f4ba8e0"

SM4 对称加解密

def sm4_decrypt(key, data)
  decipher = OpenSSL::Cipher.new("sm4-ecb")
  decipher.decrypt
  decipher.key = key

  decipher.update(data) + decipher.final
end

def sm4_encrypt(key, data)
  cipher = OpenSSL::Cipher.new("sm4-ecb")
  cipher.encrypt
  cipher.key = key

  cipher.update(data) + cipher.final
end

Camille：让前端和 Rails 进行类型安全的通信

mizuhashi — Mon, 20 Mar 2023 08:47:51 +0800

之前在 https://ruby-china.org/topics/42643 这个帖子提到过在 Rails 端生成带类型的 API 调用函数，来让前后端通信实现类型安全，现在终于做成成品 gem 了。

Github Repo: https://github.com/onyxblade/camille

用 Rails 做 API server 的时候，我们返回的 json 是没有经过类型检查的，这样即使前端用上了 typescript，我们也不能保证 Rails 返回的 JSON 是预期的结构和类型。于是我做了这个 gem 来在 Rails 端定义 API 接口的类型，并生成 ts 的调用函数，这样调用的参数和返回就都是类型安全的了。

简而言之它的作用就是可以给 controller action 的 params 和 response 加上类型，例如对一个books#create action，可以通过下面的代码加上类型：

using Camille::Syntax

class Camille::Schemas::Books < Camille::Schema
  include Camille::Types

  post :create do
    params(
      book: {
        name: String,
        author: String,
        retail_price: Decimal
      }
    )
    response(Boolean)
  end
end

然后可以生成前端的调用函数：

// This file is automatically generated.
import request from './request'

export type DateTime = string
export type Decimal = number

export default {
  books: {
    create(params: {book: {name: string, author: string, retailPrice: Decimal}}): Promise<boolean>{ return request('post', '/books/create', params) },
  },
}

这样前端可以通过下面的方式调用：

const bool = await endpoints.books.create({
  book: {
    name: 'Metaprogramming Ruby',
    author: 'Paolo Perrotta',
    retailPrice: 27.95
  }
})

这个调用的参数和返回值都是类型安全的，如果前端出错了 TS 会给出提示，后端出错则会被运行时检查查出来。同时请求的 path 也是不需要程序员管理的，程序员只要调用函数就好，Camille 会确保请求被正确的 action 处理。

https://github.com/onyxblade/camille-tutorial 这里有一个 step by step 的 tutorial，感兴趣的也可以看看。

Camille 目前做到了支持 typescript 的除了 enum 和 utility types 的绝大部分类型语法（utility types 支持 omit 和 pick），基本是一模一样的，在这个过程中用到了至今还没见有人用过的 refinement，算是比较好玩的一点。具体的语法列表可以参见 https://github.com/onyxblade/camille#available-syntax-for-types 。

欢迎试用和反馈，如果有需要的 feature requests 也可以加上。

CommitGPT

Peter — Mon, 27 Feb 2023 20:52:41 +0800

A CLI that writes your git commit messages for you with AI. Never write a commit message again.

https://github.com/ZPVIP/commitgpt

欢迎 star, PR

carrierwave-aliyun 可以生成 oss 智能媒体链接吗

txbleehom — Mon, 05 Sep 2022 10:56:00 +0800

使用 carrierwave-aliyun 生成下载链接没问题，但是现在需要使用 oss 的智能媒体服务在线预览文件，按照文档要求加了对应的参数就是不对，这种是不是不能用 carrierwave-aliyun，看 gem 包好像只实现了缩略图的功能

下载链接（https://xxx.oss-cn-shanghai.aliyuncs.com/attachments/demo.xlsx?x-oss-process=imm%2Fpreviewdoc%2Ccopy_1&Expires=1662347160&OSSAccessKeyId=xxxx&Signature=xxx）加了这个参数结果不对提示如下

命令行词典 ecdict 更新，Gem 一键安装，支持中文搜索英文，增强英文补全

ccmywish — Thu, 24 Mar 2022 13:23:57 +0800

ecdict

源代码：

之前的帖子

https://ruby-china.org/topics/40512

以前的 ecdict 是写了几个脚本来安装的，过程很繁琐，且容易出错。现在更新直接可以用 RubyGems 安装。并且，功能上比之前加强许多，比如新增对中文的搜索，对英文补全的加强。

gem install ecdict

📚 ecdict dictionary (Ruby Powered)

命令行端的离线词典ecdict，提供中英文双模式查询，支持 REPL 交互式查询，安装仅需要一个命令，其过程不需要外网。数据源包含 340 万单词，由项目skywind3000/ECDICT提供。支持 Linux，Windows，macOS.

若您有新的想法，发现了存在的/潜在的问题、可改善的地方 (比如对 REPL 的交互性优化)，又或者您想要参与开发以及日常维护，请您在issues 处反馈，并请阅读CONTRIBUTING.md

安装

gem install ecdict

依赖

Ruby
SQLite3

若 Windows 上安装 gem sqlite3 失败，请翻到最下方查看解决方法

使用

ecdict: A courteous cli translator.

usage:

  ecdict word      => 查询单词word
  ecdict -r        => 启动ecdict repl交互式查询，输入exit或Ctrl-C/D退出
  ecdict -c  中文  => 搜索中文单词对应的英文单词
  ecdict -cp 中文  => 搜索中文短语对应的英文短语
  ecdict -i        => 下载ecdict词典数据并安装
  ecdict -v        => 打印此Gem版本号
  ecdict -h        => 打印此帮助
  ecdict -d        => 清空词典数据

Troubleshoot

Windows 下安装 Gem sqlite3 失败

下载安装 sqlite 源代码 sqlite-amalgamation-xxxx.zip 解压到某文件夹如 D:\sqlite-src.
运行 gem install sqlite3 -- --with-sqlite3-lib=D:\sqlite-src

Rails PG Extras - PG 性能检查工具

hjiangwen — Sun, 13 Mar 2022 10:39:24 +0800

Gem 介绍

rails-pg-extras 是一个 PG 性能检查工具，基于 pg 内置的统计视图。作者是一名 Rails 以及 PG 性能咨询顾问。一般小团队都没有 DBA，后端开发用这个 gem 就能检查出一些问题～

rails-pg-extras 提供了以下功能（我只列出了使用频率高的）：

统计情况
- 查看各表、索引大小以及行数
- 查看各表的使用情况（多少顺序扫描）
- 查看各表的缓存命中率（pg 的内存缓存放在 shared_buffers 中）
- 未使用的索引（删掉它们）
- null 值比例高的索引（把它们替换成非 null 的 partial index）
pg 实时情况
- long running query
- blocking query

下一步

这个 gem 只能基于 pg 内置的统计视图，查看 PG 最新的状态。但是我们通常对比历史数据，才能知道系统的好坏：1000qps 是好还是坏？以下这些商业工具就是基于统计视图，提供了时间序列的查看方式：

因为有历史数据，我们就能查够查看系统的 Top SQL，比如：吞吐量最大的 query、最慢的 query、最耗 IO 的 query。这是 new relic 没提供的功能，new relic 只能查 top table，没有 query 粒度的监控。比如你在 new relic 只知道 users 表请求量最大，这些 query 来自哪些 API/job，但是你不知道具体是哪些 query

参考

https://pawelurbanek.com/postgresql-fix-performance

。。。未完待续，要出门了

彩蛋

我贡献的一个 PR被采纳了。🎉 记录我的第二次开源贡献～

searchkick 用法问题

bighuzi — Thu, 23 Dec 2021 22:58:48 +0800

1, 索引


searchkick index_name: "user, callbacks: :async, deep_paging: true, case_sensitive: true, settings: { number_of_replicas: 2}

search_data

def search_data #指定查询索引
     attributes.merge(product_data)
 end

3: 问题. i. 是不是 searchkick 每次重建索引，mappings 都有可能会不一样，因为删掉索引后，重建，有时候某些字段搜索不了了。大家都是如何处理的， ii. 大约 2 亿数据首次 build 如何能加快速度，据说每几分钟能 build 进百万数据。

@Rei 大佬们能否指点一二...

Error installing sinatra [已解决]

sevk — Wed, 10 Nov 2021 12:34:02 +0800


ERROR:  Error installing sinatra:
    invalid gem: package metadata is missing in /home/kk/.gem/ruby/3.0.0/cache/sinatra-2.1.0.gem
➜  ~ ruby -v
ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]

Sequel Migration 指北

tablecell — Tue, 05 Oct 2021 22:17:14 +0800

首先安装 sequel

gem install sequel -NV

sequel 的 migration 类似 Rakefile 执行 task 不用生成类文件

migration 文件命名规则有两种方式

001_xxx.rb
timestamp_xxx.rb

第一种按 i++ 递增可以 1-9 或者 01-99 一般 999 以内应该够了

第二种按以时间戳递增跟 rails 类似

xxx 是可以是任意的文件名这里以用 Sequel 开发招聘网站为例介绍第一种

新建 migration 目录存放迁移文件

md mig

新建 migration 文件招聘需要发布标题需要 title 字段

vi mig/001_+title.rb

Sequel.migration do
  change do
    create_table(:jobs) do
      primary_key :id, unique: true
      String :title, null: false
    end
  end
end

执行 migration
sequel -m mig sqlite://jobs.db

其中 -m 参数是指 migration 目录后面跟数据库 dsn

招聘需要有接收简历的邮箱再增加一个字段 email

vi mig/002_+email.rb

Sequel.migration do
  change do
    add_column :jobs,:email,String 
  end
end

格式也很好记外层不变 migration do/change do (复制粘贴即可)
里层 action :表名， :字段名，数据类型

action 也是简单的动宾结构 add/drop/rename _ column/index/view

招聘需要发布薪资再增加一个字段 salary

vi mig/003_+salary.rb

Sequel.migration do
  change do
    add_column :jobs,:salary,Integer 
  end
end

薪资一般是区间，要设置两个字段，这就需要调整原来的表结构

可以把原来的 salary 删除用 drap_column 然后用 add_column 再新增两个

或者用改名这里用改名 rename_column

vi mig/004_salary!salarybase.rb

Sequel.migration do
  change do
    rename_column :jobs,:salary,:salarybase
  end
end

再增加一个 salarytop

vi mig/005_+salarytop.rb

Sequel.migration do
  change do
    add_column :jobs,:salarytop,Integer
  end
end

如果想回滚直接用-M 指定序号比如

sequel -m mig -M 001 sqlite://jobs.db

就回到初始建表的状态

sequel -m mig -M 005 sqlite://jobs.db

就直接到从 001 执行到 005

-M 执行的过程很象看片来回拖进度条

记住 -m -M 两个参数就能执行大部分常用的操作了

sequel + rack 做的招聘网站 https://github.com/tablecell/myrack

别人安装 gem 的时间，用 sequel 已经把网站做好了

haml 和 slim 有什么不同吗?

tablecell — Sun, 12 Sep 2021 14:34:48 +0800

看起来好象就是 haml 在 slim 标签前面加了个%

怎么格式化 rack 的 @env

tablecell — Wed, 08 Sep 2021 14:18:28 +0800

象 "rack.input"=>#<Rack::Lint::InputWrapper 这种是不符合 json 格式，常用的 json 格式化工具也用不了

rescue 为什么不处理 SQLite3::SQLException 异常

tablecell — Tue, 07 Sep 2021 22:41:04 +0800

require "sqlite3"
require "sequel"
DB = Sequel.sqlite  # memroy

if true
  DB.create_table :posts do
    primary_key :id
    String :email, null: false
  end
end
Post = DB[:posts]

begin
  row = Post.insert(mail: "xx@qq.com")
rescue SQLite3::SQLException => e
  puts e
end

执行会输出异常栈，SQLite3::SQLException: table posts has no column named mail 但不执行 rescue 代码块

gem 不安装能检测到冲突吗？

tablecell — Tue, 31 Aug 2021 23:39:11 +0800

一个 gem 依赖十几个 gem 但最后要用的就是最后一个，安装到第 8 个提示版本不对或者有冲突虽然 1-7 已经安装成功，然并没有卵用

Rails 好用常用 gem 汇总

flchenhp — Fri, 27 Aug 2021 11:45:51 +0800

原文链接，原文展示效果更佳哦～

好用的 Gem 列表

本页用于介绍 Ruby 社区里面那些特别热门的 Gem，以下 Gem 可以在 rubygems.org 找到。

实用的 RubyGems 排名站点 www.ruby-toolbox.com

前端常用

bootstrap 来自 Twitter 的 Bootstrap，是一套完成的前台 CSS 框架。以简洁，优雅著称于世。被无数攻城狮所青睐，又让无数程序猿审美疲劳。

font-awesome-sass icon 图标

simple_form 和 Formtastic Rails 为我们带来和一改传统的表单构件方式，但是经过实际的使用，我们渐渐发觉这样依然还是不够“敏捷”，我们需要更加简便并具有更细致规范的表单，所以有了 Formtastic，它用起来比 Rails 默认的 form 更加简洁，但是却具有更多的功能，你可以为每个字段设定 help-text 放到文本框下面，并可以走 I18n 的方式设置语言，具体参见 Railscasts 上面对于 Formtastic 的介绍。而 simple_form 和 Formtastic 功能类似，但它的写法还要简单一些。

ClientSideValidations 现在越来越多网站为了改善用户体验，使用 JavaScript 来进行客户端验证。对于程序员来说，也因此增加多一份工作。而往往客户端的验证逻辑跟服务端的验证逻辑几乎一样，如果要另外再写一次验证代码，实在不够 DRY，client_side_validations 正是为解决此问题要出现。client_side_validations 会读取服务端的验证逻辑并生成对应的客户端验证逻辑（依赖 jQuery），让你几乎不用增加任何前端代码就可实现客户验证。

bootstrap-datepicker-rails bootstrap 风格的日历

select2-rails: 下拉提示 select 框（支持前端和后端）

会员系统常用

Devise 用于快速构建用户功能，如：注册，登陆，个人设置，找回密码... 同时 Ruby 社区有各类和账号体系的库可以很容易和 Devise 打通。

RuCaptcha 图片验证码，安全、简单、易用，无依赖。

rolify Very simple Roles library without any authorization enforcement supporting scope on resource obje

CanCanCan 一些应用中会用到为不同用户设定不同功能的权限，你可以试试 CanCanCan 这个 Gem 他可以帮你制定一套完善的方案，Railscasts 上有使用介绍。

如果 Devise 一样，CanCanCan 在 Ruby 社区也是非常流行，所以和它有关的实现非常多，你能很容易找到资料。

OmniAuth 如果你需要在项目中实现三方平台（如：Twitter, Facebook, 新浪微博，腾讯 QQ）账号登陆的支持，那你需要用上它。

omniauth-weibo-oauth2 omniauth-qq-connect omniauth-wechat-oauth2

Doorkeeper 前面说了 OmniAuth 介入 OAuth 2 的服务，有时候你可能需要自己建立一个 OAuth 2 服务，作为提供商，这个时候 Doorkeeper 可以帮到你。

china_sms：短信平台接口， https://github.com/saberma/china_sms wechat-rails：帮助开发者方便地在 Rails 环境中集成微信公众平台提供的所有服务 rqrcode：生成二维码

内容功能常用

will_paginate 和 Kaminari 分页，几乎所有 Rails App 都在用，其中 will_paginate 比较老，应用案例较多，kaminari 更新，性能和兼容性更好

Carrierwave 和 Paperclip 这两个都是上传组件，Paperclip 是老牌产品了，也是几乎绝大多数项目都有在用它，它可以帮你处理上传图片，裁减，定义不同的图片尺寸，几乎很完美。而 Carrierwave 是后起之秀，功能和 Paperclip 差不多，但它还可以管理除图片之外的东西，而且灵活性更高（ruby-china 就是用它）。国内的各大云存储服务都已经有了 Carrierwave 的支持，例如 carrierwave-aliyun, carrierwave-upyun。

WiceGrid 表格控件，针对 ActiveRecord，超级强大，支持任意字段排序，过滤，具体看它的 Demo.

elasticsearch-rails 实现全文搜索或搜索有关的功能，目前要数 Elasticsearch 最火，它也有 Ruby 的实现。

Ransack
常用的搜索插件

social-share-button 分享功能

ancestry 树形结果的方式存储，可以看作是一对多、多对多的扩展

by_star 这是一个辅助 ActiveRecord 的组件，让你可以简单的实现按某年，某月，某日，或者星期几，来查询数据，用起来非常简单，省下麻烦的条件组合，此外，它还可以查询上一篇，下一篇类似的功能。

lazy_high_charts 当前绘图 JS 库中 Highcharts 非常优秀，rubyist 使用这个 gem 来管理和编写需要的图。

rmagick
图片处理确保安装了 ImageMagick，rmagick 是 ImageMagick 的中间件，用于对图片进行切割等操作。mini-magick 稳定，占用内存小，但是功能比 rmagick 少

acts_as_list 给 model 中的对象进行排序记录在 position 字段中

chinese_pinyin 转化汉字为拼音 eg: Pinyin.t("中国") => "zhongguo"

acts-as-taggable-on 管理标签的插件

spreadsheet 操作电子表格

china_city 省市区级联

aasm ruby 状态机

awesome_nested_set Model 多层类别

内容输入

redcarpet Markdown 标记语言

后台管理

active_admin 后台管理框架

部署

capistrano 项目自动化部署

开发测试常用

RailsSettingsCached 项目经常会有一些配置信息，你需要一个库帮你管理。

annotate 在 model 类的顶部或者底部，插入数据库表的描述，方便查看

faker 生成假数据

pry 简单强大的调试工具，轻量级的工具。直接在终端调试方便又直接

Better Errors 它用一个更好的，更有用的错误页替换标准的 Rails 错误页面，对 Rack middleware 也同样有效。·Railscasts 也有相应的介绍。

Seed Fu 强大的 seed

Grape 随着 Mobile App 的增多，很多时候我们在做用 Rails 做 API Base 项目时，rails 自带的 C 和 V 层显得过于繁杂，grape 可以帮助我们快速的构建和 Rails 完美融合的 API 接口。

Faraday HTTP Client 支持多种方式

rails_best_practices 编写代码总有方圆，费心费力写文档，还不如用这个工具来控制代码质量。

daemon-spawn 将一些事情作为 daemon 来启动，可以类似 Debian 的 service foo start 比如用来管理 Resque 的启动和重启，会变得很简单。

rest-client：Http 客户端

生产运维性能常用

Whenever Linux 里面有 Cron 可以帮助我们定期执行一些任务，但是 Cron 手动写起来很是麻烦，尤其是前面时间周期的定义，Whenever 可以帮助我们用更人性化的方式编写 Cron 任务，具体参见 Railscasts 上面关于 Whenever 的介绍。

Sidekiq, Resque 和 Delayed_job 有时候一些任务的执行会很慢，而这些任务我们并不要求需要马上返回结果 (比如：发送邮件，生成图片缩略图)，那我们可以选择将这些任务放到后台执行，以便于页面不会长时间等待执行。

god Ruby 进程监控工具

second_level_cache ActiveRecord 二级缓存插件，装上他你可以无缝的实现对 ActiveRecord 数据的二级缓存。

paper_trail 记录 model 数据的变化

爬虫常用

Nokogiri 采集数据是我们需要解析复杂的 HTML 结构，从中获得需要的数据，Nokogiri 可以帮助我们完美的处理不同网页上面不同的 HTML 结构，并且有很好的编码处理能力，用它你不用担心页面是 GB2312 还是 GBK 还是 UTF-8，它都很很好的处理，解析结构可以用类似 jQuery 的 CSS Selector 的方式查找，很是方便。曾经用过 Ruby 的好几个类似插件，最终发现 Nokogiri 才是最好的。

SEO 优化

sitemap_generator 生成网站的 sitemap.xml 文件

参考文章

2021 Rails-carrierwave 通过 api 上传音频实例

dayudodo — Sat, 21 Aug 2021 20:02:55 +0800

carrierwave 是 rails 中可以上传文件的工具库，虽然 rails 在 5.2 版本之后已经提供了 active storage，更安全、功能强大，但 carrierwave 用起来比较简单，适合小的项目。

本文要讲的是使用 api 来上传音频文件到 rails 服务器的办法。

carrierwave 官网地址

https://github.com/carrierwaveuploader/carrierwave

star: 8.6k

根据 ruby toolbox 统计，其在文件上传中排名第二，第一的 paperclip 已经停更了。

首先，在 Gemfile 中添加

gem 'carrierwave'

安装好

bundle install

生成一个音频上传类

rails generate uploader Soundfile

会保存在 app/uploaders/soundfile_uploader.rb 中，其内容如下：

class SoundfileUploader < CarrierWave::Uploader::Base
  # Include RMagick or MiniMagick support:
  # include CarrierWave::RMagick
  # include CarrierWave::MiniMagick

  # Choose what kind of storage to use for this uploader:
  storage :file
  # storage :fog

  # Override the directory where uploaded files will be stored.
  # This is a sensible default for uploaders that are meant to be mounted:
  def store_dir
     "storage/#{model.class.to_s.underscore}/#{mounted_as}"
  end

  # Provide a default URL as a default if there hasn't been a file uploaded:
  # def default_url(*args)
  #   # For Rails 3.1+ asset pipeline compatibility:
  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
  #
  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
  # end

  # Process files as they are uploaded:
  # process scale: [200, 300]
  #
  # def scale(width, height)
  #   # do something
  # end

  # Create different versions of your uploaded files:
  # version :thumb do
  #   process resize_to_fit: [50, 50]
  # end

  # Add an allowlist of extensions which are allowed to be uploaded.
  # For images you might use something like this:
  # def extension_allowlist
  #   %w(jpg jpeg gif png)
  # end

  # Override the filename of the uploaded files:
  # Avoid using model.id or version_name here, see uploader/store.rb for details.
  # def filename
  #   if original_filename
  #     original_filename.force_encoding 'UTF-8'
  #   end
  # end
end

storage

指定了你要保存文档的位置，我是想把文件上传后保存到服务器中，所以 storage :file 并不需要改动。如果想保存到云存储中，请参考官方文档。

store_dir

里面你可以设置成自己想要保存的路径，其默认是保存在 public 目录下，类似于这样：public/storage/practice/文件名，这样上传之后是可以通过 url 来访问的，可以根据你自己的需求调整。也可以使用绝对路径，比如/home/user/storage，请确认你有对应的权限。

建立关联

我想给练习添加一个音频

rails g migration add_soundfile_to_practices soundfile:string
rails db:migrate

db/migrate/20210818034921_add_soundfile_to_practices.rb内容如下：

class AddSoundfileToPractices < ActiveRecord::Migration[6.0]
  def change
    add_column :practices, :soundfile, :string
  end
end

在 practice.rb 中建立关联

记得要使用 mount_uploader, 如果是多个文件，需要使用 mount_uploaders, 后面多个 S！

class Practice < ApplicationRecord
    belongs_to :user
    belongs_to :pth_sentence
    mount_uploader :soundfile, SoundfileUploader
end

Controller

app/controllers/practices_controller.rb中主要代码

def new
  @practice = Practice.new
end

def create
  @practice =  Practice.new(practice_params)
  if @practice.save
    render json: { status: 'success', msg: '创建成功' }
  else
    render :new
  end
end

def practice_params
  prms =
    params.require(:practice).permit(
      :user_id,
      :pth_sentence_id,
      :soundfile
    )
  # prms[:soundfiles].first.headers.force_encoding 'utf-8'
  prms
end

routes

routes.rb 中要有路由

resources :practices

测试 web 上传

如果你使用 web 上传，那么可以在 views 中这样来写（app/views/practices/_form.html.erb）：

<%= form_for(@practice) do |f| %>
  <%= f.text_field 'user_id' %>
  <%= f.text_field 'pth_sentence_id' %>
  <%= f.file_field :soundfile %>
  <%= f.submit %>
<% end %>

测试 API 上传

参数要组装成 rails 需要的格式，类名 [属性]，客户端我用的是 uniapp, 所以用 uniapp 来举例。

uni.uploadFile({
    url: `http://192.168.1.8:3000/practices`, 
    name: 'practice[soundfile]',
    filePath:this.voicePath,
    formData: {
        'practice[user_id]': 1,
        'practice[pth_sentence_id]': 30,
    },
    success: (uploadFileRes) => {
        console.log(uploadFileRes);
    },
    fail: (msg) => {
        console.log(msg.error)
    }
});

uniapp 提供了 uploadFile 的 API：

filePath 是要上传的文件名称
name 是参数名称，注意其写法为 practice[soundfile]，要与 model 中对应
其它参数写在 formData 中。

测试成功，文件已经上传到指定的目录中

观察后台，可以看到 soundfile 已经保存好了。

[1] pry(main)> u= User.find 6
  User Load (0.2ms)  SELECT `users`.* FROM `users` WHERE `users`.`id` = 6 LIMIT 1
=> #<User id: 6, email: "c6@c6.com", created_at: "2021-08-18 03:25:59", updated_at: "2021-08-18 03:25:59", phone: "13317555983", name: "king1", title: nil>
[2] pry(main)> u.practices.last
  Practice Load (0.2ms)  SELECT `practices`.* FROM `practices` WHERE `practices`.`user_id` = 6 ORDER BY `practices`.`id` DESC LIMIT 1
=> #<Practice:0x00007f9c9c83dca0
 id: 8,
 user_id: 6,
 pth_sentence_id: 44,
 local_sound: nil,
 comment: nil,
 created_at: Thu, 19 Aug 2021 09:58:42 CST +08:00,
 updated_at: Thu, 19 Aug 2021 09:58:42 CST +08:00,
 soundfile: "07-最后他选择了后者_.mp3">

常见用法

可用 url

[4] pry(main)> u.practices.last.soundfile.url
  Practice Load (0.4ms)  SELECT `practices`.* FROM `practices` WHERE `practices`.`user_id` = 6 ORDER BY `practices`.`id` DESC LIMIT 1
=> "/storage/practice/soundfile/07-%E6%9C%80%E5%90%8E%E4%BB%96%E9%80%89%E6%8B%A9%E4%BA%86%E5%90%8E%E8%80%85_.mp3"

服务器路径

[5] pry(main)> u.practices.last.soundfile.current_path
  Practice Load (0.5ms)  SELECT `practices`.* FROM `practices` WHERE `practices`.`user_id` = 6 ORDER BY `practices`.`id` DESC LIMIT 1
=> "/home/study/funny_words/public/storage/practice/soundfile/07-最后他选择了后者_.mp3"

可能出现的错误

1, no implicit conversion of nil into String

使用 mount_uploaders, sssss, 复数！我恨复数，我恨复数，我恨复数。

2, Encoding::UndefinedConversionError "\xE6" from ASCII-8BIT to UTF-8

编码问题导致的，经分析，是 headers 中的 filename 编码有问题，见上图 (吐槽：外国人开发的工具总是容易产生国际化问题)，经搜索官网 issues，可能的解决办法如下。

1、application.rb 中添加 config.encoding = "utf-8"

2、在 practices_controller.rb 的 practice_params 中添加 prms[:soundfile].first.headers.force_encoding 'utf-8'

def practice_params
  prms =
    params.require(:practice).permit(
      :user_id,
      :pth_sentence_id,
      :soundfile
    )
  prms[:soundfile].headers.force_encoding 'utf-8'
  prms
end

这样就会把 headers 强制转成 utf-8 编码。

3, Can't verify CSRF token authenticity

使用 API 上传的时候，可能会遇到 CSRF 问题，这是为了防止一些网络攻击，可以通过在 application.rb 中添加

config.action_controller.default_protect_from_forgery = false

来关闭此项检查，这样开发时就方便喽。注意！在生产环境中要使用其它安全令牌比如 jwt 来进行合法用户校验。

运行环境

ruby 2.6.5, rails 6.0.4, mysql 5.7(utf8mb4)

求教, Ruby 的 Git 操作库, Rugged 如何执行 git pull?

clownfish — Fri, 28 May 2021 15:31:16 +0800

我正在使用 Rugged, 但是好像不支持 git pull, 我想知道如何完全替换掉这个命令， git fetch 执行了之后如何做 git merge?

rspec5 一览大文

imanner — Fri, 14 May 2021 19:02:05 +0800

安装

添加到 Gemfile

$ echo 'gem "rspec-rails", group: [:development, :test]' >> Gemfile

安装

$ bundle install

初始化成为默认测试框架

$ rails generate rspec:install

运行测试

$ rails spec

或者

$ rspec spec --format documentation

测试框架

# spec/failing_spec.rb
require "rails_helper"

# 配置
RSpec.configure do |config|
  config.xxx
  ...
end

# 类级别命名空间
RSpec.describe "类名", :type => :类型 do
  # 使用内部的匿名控制器
  controller do
    def 方法名
      # 实现
    end
  end

  before(:context) do
    @widget = Widget.create!
  end

  after(:context) do
    @widget.destroy
  end

  # 类的方法级别命名空间
  # describe "请求方法 方法名" 
  describe "GET index" do
    before(:context) do
      @widget = Widget.create!
    end

    after(:context) do
      @widget.destroy
    end

    # 具体的测试用例 允许多个，包含成功的和失败的
    it "raises an error" do
      # 具体实现
      get :index
    end
  end
end

内置创建器

$ rails generate rspec:model user
$ rails generate rspec:controller api::v1::users

生成文件 spec/models/user_spec.rb

更多的 specs 标签支持：

scaffold
model
controller
- rails g rspec:controller api::v1::users
helper
view
mailer
integration
feature
job
channel
generator
mailbox
request
system

事务

rspec 默认开启事务，这样可以保证测试完成后自动清空数据库。当然可以使用其他 gem 来完成这个功能，例如 database_cleaner 。

当运行 rails generate rspec:install, 在文件 spec/rails_helper.rb 中默认引入了系列配置：

RSpec.configure do |config|
  config.use_transactional_fixtures = true
end

禁用事务

RSpec.configure do |config|
  config.use_transactional_fixtures = false
end

利用 `before` 关键字实现自动回滚的控制

自动回滚：任何在 before(:example) 定义的数据在执行完测试后都会自动清空。

describe Widget do
before(:example) do
  @widget = Widget.create
end

it "does something" do
  expect(@widget).to do_something
end

it "does something else" do
  expect(@widget).to do_something_else
end
end

@widget 在每个 it 中都会被重新创建，所以互不干扰。

手动控制：在 before(:context) 中创建的数据则不会自动回滚。你可以利用before(:context) 创建多个方法的公用数据。下面是几个原则：

一定要定义 after(:context) 来手动删除数据：
```
before(:context) do
  @widget = Widget.create!
end

after(:context) do
  @widget.destroy
end
```
否则你的数据会一直存在有可能影响其他测试。

一定要使用 before(:example) 刷新数据。

before(:context) do
  @widget = Widget.create!
end

before(:example) do
  @widget.reload
end

目录结构建议

rspec 的目录规范

模块	所在目录
`Model specs`	`spec/models`
`Controller specs`	`spec/controllers`
`Request specs`	`spec/requests` 或者 `integration` 或者`api`
`Feature specs`	`spec/features`
`View specs`	`spec/views`
`Helper specs`	`spec/helpers`
`Mailer specs`	`spec/mailers`
`Routing specs`	`spec/routing`
`Job specs`	`spec/jobs`
`System specs`	`spec/system`

当然开发人员可以任意自定义目录结构，这个时候就需要明确的说明当前的测试是针对那个模块儿。如何指定呢？使用type, 在 rspec 中可用的 type 类型有：

模块	使用类型标示
`Model specs`	`type: :model`
`Controller specs`	`type: :controller`
`Request specs`	`type: :request`
`Feature specs`	`type: :feature`
`View specs`	`type: :view`
`Helper specs`	`type: :helper`
`Mailer specs`	`type: :mailer`
`Routing specs`	`type: :routing`
`Job specs`	`type: :job`
`System specs`	`type: :system`

举个例子：

# spec/legacy/things_controller_spec.rb
# 明确表明了要测试的类型
RSpec.describe ThingsController, type: :controller do
  describe "GET index" do
    # Examples
  end
end

自动识别类型

如果目录的安排是按照 rspec 规范的目录，可以通过配置自动的识别类型

# spec/rails_helper.rb
RSpec.configure do |config|
  config.infer_spec_type_from_file_location!
end

但是如果是自定义目录，也可以这样做：

# set `:type` for serializers directory
RSpec.configure do |config|
  config.define_derived_metadata(:file_path => Regexp.new('/spec/serializers/')) do |metadata|
    metadata[:type] = :serializer
  end
end

建议

强烈推荐按照规范罗列目录，例如：

app
├── controllers
│   ├── application_controller.rb
│   └── books_controller.rb
├── helpers
│   ├── application_helper.rb
│   └── books_helper.rb
├── models
│   ├── author.rb
│   └── book.rb
└── views
    ├── books
    └── layouts
lib
├── country_map.rb
├── development_mail_interceptor.rb
├── enviroment_mail_interceptor.rb
└── tasks
    └── irc.rake
spec
├── controllers
│   └── books_controller_spec.rb
├── country_map_spec.rb
├── features
│   └── tracking_book_delivery_spec.rb
├── helpers
│   └── books_helper_spec.rb
├── models
│   ├── author_spec.rb
│   └── book_spec.rb
├── rails_helper.rb
├── requests
│   └── books_spec.rb
├── routing
│   └── books_routing_spec.rb
├── spec_helper.rb
├── tasks
│   └── irc_spec.rb
└── views
    └── books

场景

自动识别测试类型，添加 type

#spec/functional/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  it "responds successfully" do
    get :index
    expect(response.status).to eq(200)
  end
end

非 Rails 应用就不要添加 type

#spec/ledger/entry_spec.rb
require "spec_helper"

Entry = Struct.new(:description, :us_cents)

RSpec.describe Entry do
  it "has a description" do
    is_expected.to respond_to(:description)
  end
end

从文件位置推断规范类型会添加适当的元数据

#spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.configure do |config|
  config.infer_spec_type_from_file_location!
end

RSpec.describe WidgetsController do
  it "responds successfully" do
    get :index
    expect(response.status).to eq(200)
  end
end

# spec/routing/duckduck_routing_spec.rb
require "rails_helper"

Rails.application.routes.draw do
  get "/example" => redirect("http://example.com")
end

RSpec.configure do |config|
  config.infer_spec_type_from_file_location!
end

# Due to limitations in the Rails routing test framework, routes that
# perform redirects must actually be tested via request specs
RSpec.describe "/example", :type => :request do
  it "redirects to example.com" do
    get "/example"
    expect(response).to redirect_to("http://example.com")
  end
end

Backtrace 过滤

Rails 中有些 gem 会让失败输出的 backtrace 信息会被过滤和简化，我们可以通过配置让失败的输出全部的 backtrace：

RSpec.configure do |config|
  config.filter_rails_from_backtrace!
end

局部使用 `filter_rails_from_backtrace!`

# spec/failing_spec.rb
require "rails_helper"

RSpec.configure do |config|
  config.filter_rails_from_backtrace!
end

RSpec.describe "Controller", :type => :controller do
  # 使用内部的匿名控制器
  controller do
    def index
      raise "Something went wrong."
    end
  end

  describe "GET index" do
    it "raises an error" do
      get :index
    end
  end
end

为模型编写 rspec

模型的 rspec 是 ActiveSupport :: TestCase 的美化包装，并且包括所有它提供的行为和断言，以及 RSpec 自身的行为和期望。

例子：

require "rails_helper"
# 模型是：Post， 明确指定了type
RSpec.describe Post, :type => :model do
  # 命名空间是 with 2 or more comments
  context "with 2 or more comments" do
    # 真正的测试
    it "orders them in reverse chronologically" do
      # 调用create方法创建了一个 post
      post = Post.create!
      # 创建一个回复
      comment1 = post.comments.create!(:body => "first comment")
      # 创建第二个回复
      comment2 = post.comments.create!(:body => "second comment")
      # 期望所有回复中 comment2, comment1相等
      expect(post.reload.comments).to eq([comment2, comment1])
    end
  end
end

事务的例子

默认使用事务

# spec/models/widget_spec.rb
require "rails_helper"

# 验证模型 Widget
RSpec.describe Widget, :type => :model do
  # 没有数据
  it "has none to begin with" do
    expect(Widget.count).to eq 0
  end

  # 添加一个
  it "has one after adding one" do
    Widget.create
    expect(Widget.count).to eq 1
  end

  # 因为有事务 所以这个数据是独立的  也成立
  it "has none after one was created in a previous example" do
    expect(Widget.count).to eq 0
  end
end

运行测试：

$ rspec spec/models/widget_spec.rb

应该都通过。

明确指定事务开启

#spec/models/widget_spec.rb
require "rails_helper"

RSpec.configure do |c|
  c.use_transactional_examples = true
end

RSpec.describe Widget, :type => :model do
  it "has none to begin with" do
    expect(Widget.count).to eq 0
  end

  it "has one after adding one" do
    Widget.create
    expect(Widget.count).to eq 1
  end

  it "has none after one was created in a previous example" do
    expect(Widget.count).to eq 0
  end
end

运行测试：

$ rspec spec/models/widget_spec.rb

应该都通过。

明确禁用事务

#spec/models/widget_spec.rb" with:
require "rails_helper"

RSpec.configure do |c|
  # 关闭事务 
  c.use_transactional_examples = false
  # 设定公用值
  c.order = "defined"
end

RSpec.describe Widget, :type => :model do
  it "has none to begin with" do
    expect(Widget.count).to eq 0
  end

  it "has one after adding one" do
    Widget.create
    expect(Widget.count).to eq 1
  end

  it "has one after one was created in a previous example" do
    expect(Widget.count).to eq 1
  end

  # 利用after删除
  after(:all) { Widget.destroy_all }
end

运行测试：

$ rspec spec/models/widget_spec.rb

应该都通过。

使用 fixture 预定值

#spec/models/thing_spec.rb
require "rails_helper"

RSpec.describe Thing, :type => :model do
  fixtures :things
  it "fixture method defined" do
    things(:one)
  end
end


#spec/fixtures/things.yml
one:
  name: MyString

运行测试：

$ rspec spec/models/thing_spec.rb

应该都通过。

支持 double

默认情况下，rspec 验证的 double 不支持动态方法。而 instance_double.rspec-rails 通过扩展的方法为列启用了此支持。

例子：

# spec/models/widget_spec.rb
require "rails_helper"

RSpec.describe Widget, :type => :model do
  it "has one after adding one" do
    # 假造一个对象Widget 属性为name
    instance_double("Widget", :name => "my name")
  end
end

为控制器编写 rspec

controller spec 继承自 ActionController::TestCase::Behavior, 允许你发送 http 请求并获取相应的期望：

rendered templates
redirects
controller 与 view 共用的实例变量
cookies

可以像这样制定结果：

标准匹配： (expect(response.status).to eq(200))
标准断言： (assert_equal 200, response.status)
rails 断言 (assert_response 200)

rails-specific 匹配器：

期望渲染了模板

expect(response).to render_template(:new)   # wraps assert_template

期望执行了重定向

expect(response).to redirect_to(location)   # wraps assert_redirected_to

期望得到指定的状态值

expect(response).to have_http_status(:created)

期待新创建了对象

expect(assigns(:widget)).to be_a_new(Widget)

简单实例：

RSpec.describe TeamsController do
  describe "GET index" do
    it "assigns @teams" do
      team = Team.create
      get :index
      expect(assigns(:teams)).to eq([team])
    end

    it "renders the index template" do
      get :index
      expect(response).to render_template("index")
    end
  end
end

指定头信息

require "rails_helper"

RSpec.describe TeamsController, type: :controller do
  describe "GET index" do
    it "returns a 200" do
      # 添加头信息
      request.headers["Authorization"] = "foo"
      # 请求show方法
      get :show
      # 期待返回值是 200
      expect(response).to have_http_status(:ok)
    end
  end
end

controller 相关

简单实例

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  describe "GET index" do
    it "has a 200 status code" do
      get :index
      # 期待状态码的值是 200
      expect(response.status).to eq(200)
    end
  end
end

运行测试

$ rspec spec

all 通过测试

测试返回值的数据类型

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  describe "responds to" do
    it "responds to html by default" do
      post :create, :params => { :widget => { :name => "Any Name" } }
      # 返回值为类型为 "text/html"
      expect(response.content_type).to eq "text/html"
    end

    it "responds to custom formats when provided in the params" do
      post :create, :params => { :widget => { :name => "Any Name" }, :format => :json }
      # 返回值为类型为 "text/html"
      expect(response.content_type).to eq "application/json"
    end
  end
end

运行测试

$ rspec spec

all 通过测试

指定请求参数的数据类型

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  describe "responds to" do
    it "responds to html by default" do
      post :create, :params => { :widget => { :name => "Any Name" } }
      expect(response.content_type).to eq "text/html"
    end

    it "responds to custom formats when provided in the params" do
      # 设定请求参数类型为 json
      post :create, :params => { :widget => { :name => "Any Name" }, :format => :json }
      expect(response.content_type).to eq "application/json"
    end
  end
end

运行测试

$ rspec spec

all 通过测试

测试返回值的数据编码类型

#spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  describe "responds to" do
    it "responds to html by default" do
      post :create, :params => { :widget => { :name => "Any Name" } }
      # 编码类型为 text/html; charset=utf-8
      expect(response.content_type).to eq "text/html; charset=utf-8"
    end

    it "responds to custom formats when provided in the params" do
      post :create, :params => { :widget => { :name => "Any Name" }, :format => :json }
      # 编码类型为 application/json; charset=utf-8
      expect(response.content_type).to eq "application/json; charset=utf-8"
    end
  end
end

运行测试

$ rspec spec

all 通过测试

测试返回值的 media_type

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  describe "responds to" do
    it "responds to html by default" do
      post :create, :params => { :widget => { :name => "Any Name" } }
      #media_type 为 text/html
      expect(response.media_type).to eq "text/html"
    end

    it "responds to custom formats when provided in the params" do
      post :create, :params => { :widget => { :name => "Any Name" }, :format => :json }
      expect(response.media_type).to eq "application/json"
    end
  end
end

运行测试

$ rspec spec

all 通过测试

指定具体的视图文件

期望通过控制器动作呈现的模板（通过）

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  describe "index" do
    it "renders the index template" do
      get :index
      # 测试渲染了指定的 index 模板
      expect(response).to render_template("index")
      # 测试返回值为 “”
      expect(response.body).to eq ""
    end
    it "renders the widgets/index template" do
      get :index
      expect(response).to render_template("widgets/index")
      expect(response.body).to eq ""
    end
  end
end

运行测试

$ rspec spec

all 通过测试

期望控制器操作未呈现的模板（失败）

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  describe "index" do
    it "renders the 'new' template" do
      get :index
      expect(response).to render_template("new")
    end
  end
end

运行测试

$ rspec spec

没有通过测试

期望在运行时更改视图路径时呈现空模板（通过）

# spec/controllers/things_controller_spec.rb
require "rails_helper"

RSpec.describe ThingsController, :type => :controller do
  describe "custom_action" do
    it "renders an empty custom_action template" do
      # 更改视图路径
      controller.prepend_view_path 'app/views'
      controller.append_view_path 'app/views'
      get :custom_action
      expect(response).to render_template("custom_action")
      expect(response.body).to eq ""
    end
  end
end


#app/controllers/things_controller.rb
class ThingsController < ActionController::Base
  layout false
  def custom_action
  end
end

#app/views/things/custom_action.html.erb
# 空文件

运行测试

$ rspec spec

all 通过测试

在运行时更改视图路径时，期望模板使用 render_views 渲染实际模板（通过）

# spec/controllers/things_controller_spec.rb
require "rails_helper"

RSpec.describe ThingsController, :type => :controller do
  render_views

  it "renders the real custom_action template" do
    controller.prepend_view_path 'app/views'
    get :custom_action
    expect(response).to render_template("custom_action")
    expect(response.body).to match(/template for a custom action/)
  end
end

运行测试

$ rspec spec

all 通过测试

匹配渲染绘图内容

直接在单个组中进行 render_views

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  render_views

  describe "GET index" do
    it "has a widgets related heading" do
      get :index
      expect(response.body).to match /<h1>.*widgets/im
    end
  end
end

运行测试

$ rspec spec

all 通过测试

在嵌套组中打开和关闭 render_views

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController, :type => :controller do
  context "with render_views" do
    render_views

    describe "GET index" do
      it "renders the actual template" do
        get :index
        expect(response.body).to match /<h1>.*widgets/im
      end
    end

    context "with render_views(false) nested in a group with render_views" do
      render_views false

      describe "GET index" do
        it "renders the RSpec generated template" do
          get :index
          expect(response.body).to eq("")
        end
      end
    end
  end

  context "without render_views" do
    describe "GET index" do
      it "renders the RSpec generated template" do
        get :index
        expect(response.body).to eq("")
      end
    end
  end

  context "with render_views again" do
    render_views

    describe "GET index" do
      it "renders the actual template" do
        get :index
        expect(response.body).to match /<h1>.*widgets/im
      end
    end
  end
end

运行测试

$ rspec spec --order default --format documentation
WidgetsController
  with render_views
    GET index
      renders the actual template
    with render_views(false) nested in a group with render_views
      GET index
        renders the RSpec generated template
  without render_views
    GET index
      renders the RSpec generated template
  with render_views again
    GET index
      renders the actual template

all 通过测试

全局 render_views

# spec/support/render_views.rb" with:
RSpec.configure do |config|
  config.render_views
end


# spec/controllers/widgets_controller_spec.rb
require "rails_helper"
require "support/render_views"

RSpec.describe WidgetsController, :type => :controller do
  describe "GET index" do
    it "renders the index template" do
      get :index
      expect(response.body).to match /<h1>.*widgets/im
    end
  end
end

运行测试

$ rspec spec

all 通过测试

匿名控制器

使用 controller 方法定义一个匿名控制器，该匿名控制器将从传入的参数所描述的类继承。这对于指定类似全局错误处理的行为很有用。

要指定其他基类，您可以将该类显式传递给 controller 方法：

controller(BaseController)

您还可以禁用基本类型推断，在这种情况下，匿名控制器将默认继承自 ApplicationController 方法而不是所描述的类。

RSpec.configure do |c|
  # 禁用基本类型推断
  c.infer_base_class_for_anonymous_controllers = false
end

RSpec.describe BaseController, :type => :controller do
    # ApplicationController
    controller do
    def index; end

    # this normally creates an anonymous `BaseController` subclass,
    # however since `infer_base_class_for_anonymous_controllers` is
    # disabled, it creates a subclass of `ApplicationController`
  end
end

使用重定向处理在ApplicationController中指定的错误

# spec/controllers/application_controller_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base
  class AccessDenied < StandardError; end

  rescue_from AccessDenied, :with => :access_denied

private

  def access_denied
    redirect_to "/401.html"
  end
end

RSpec.describe ApplicationController, :type => :controller do
  controller do
    def index
      raise ApplicationController::AccessDenied
    end
  end

  describe "handling AccessDenied exceptions" do
    it "redirects to the /401.html page" do
      get :index
      expect(response).to redirect_to("/401.html")
    end
  end
end

运行测试

$ rspec spec

all 通过测试

使用 render 处理在ApplicationController中指定的错误

# spec/controllers/application_controller_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base
  class AccessDenied < StandardError; end

  rescue_from AccessDenied, :with => :access_denied

private

  def access_denied
    render "errors/401"
  end
end

RSpec.describe ApplicationController, :type => :controller do
  controller do
    def index
      raise ApplicationController::AccessDenied
    end
  end

  describe "handling AccessDenied exceptions" do
    it "renders the errors/401 template" do
      get :index
      expect(response).to render_template("errors/401")
    end
  end
end

运行测试

$ rspec spec

all 通过测试

使用 render_template 处理在ApplicationController中指定的错误

# spec/controllers/application_controller_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base
  class AccessDenied < StandardError; end

  rescue_from AccessDenied, :with => :access_denied

private

  def access_denied
    render :file => "errors/401"
  end
end

RSpec.describe ApplicationController, :type => :controller do
  controller do
    def index
      raise ApplicationController::AccessDenied
    end
  end

  describe "handling AccessDenied exceptions" do
    it "renders the errors/401 template" do
      get :index
      expect(response).to render_template("errors/401")
    end
  end
end

运行测试

$ rspec spec

all 通过测试

使用子类处理在ApplicationController中指定的错误

# spec/controllers/application_controller_subclass_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base
  class AccessDenied < StandardError; end
end

class FoosController < ApplicationController

  rescue_from ApplicationController::AccessDenied, with: :access_denied

private

  def access_denied
    redirect_to "/401.html"
  end
end

RSpec.describe FoosController, :type => :controller do
  controller(FoosController) do
    def index
      raise ApplicationController::AccessDenied
    end
  end

  describe "handling AccessDenied exceptions" do
    it "redirects to the /401.html page" do
      get :index
      expect(response).to redirect_to("/401.html")
    end
  end
end

运行测试

$ rspec spec

all 通过测试

从描述的类中推断基类

# spec/controllers/base_class_can_be_inferred_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base; end

class FoosController < ApplicationController; end

RSpec.describe FoosController, :type => :controller do
  controller do
    def index
      render :plain => "Hello World"
    end
  end

  it "creates anonymous controller derived from FoosController" do
    expect(controller).to be_a_kind_of(FoosController)
  end
end

运行测试

$ rspec spec

all 通过测试

在描述的类中使用name和controller_name

# spec/controllers/get_name_and_controller_name_from_described_class_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base; end
class FoosController < ApplicationController; end

RSpec.describe "Access controller names", :type => :controller do
  controller FoosController do
    def index
      @name = self.class.name
      @controller_name = controller_name
      render :plain => "Hello World"
    end
  end

  before do
    get :index
  end

  it "gets the class name as described" do
    expect(assigns[:name]).to eq('FoosController')
  end

  it "gets the controller_name as described" do
    expect(assigns[:controller_name]).to eq('foos')
  end
end

运行测试

$ rspec spec

all 通过测试

在基类中调用around_filter和around_action

# spec/controllers/application_controller_around_filter_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base
  around_action :an_around_filter

  def an_around_filter
    @callback_invoked = true
    yield
  end
end

RSpec.describe ApplicationController, :type => :controller do
  controller do
    def index
      render :plain => ""
    end
  end

  it "invokes the callback" do
    get :index

    expect(assigns[:callback_invoked]).to be_truthy
  end
end

运行测试

$ rspec spec

all 通过测试

匿名控制器仅创建资源路由

# spec/controllers/application_controller_spec.rb
require "rails_helper"

if defined?(ActionController::UrlGenerationError)
  ExpectedRoutingError = ActionController::UrlGenerationError
else
  ExpectedRoutingError = ActionController::RoutingError
end

RSpec.describe ApplicationController, :type => :controller do
  controller do
    def index
      render :plain => "index called"
    end

    def create
      render :plain => "create called"
    end

    def new
      render :plain => "new called"
    end

    def show
      render :plain => "show called"
    end

    def edit
      render :plain => "edit called"
    end

    def update
      render :plain => "update called"
    end

    def destroy
      render :plain => "destroy called"
    end

    def willerror
      render :plain => "will not render"
    end
  end

  describe "#index" do
    it "responds to GET" do
      get :index
      expect(response.body).to eq "index called"
    end

    it "also responds to POST" do
      post :index
      expect(response.body).to eq "index called"
    end

    it "also responds to PUT" do
      put :index
      expect(response.body).to eq "index called"
    end

    it "also responds to DELETE" do
      delete :index
      expect(response.body).to eq "index called"
    end
  end

  describe "#create" do
    it "responds to POST" do
      post :create
      expect(response.body).to eq "create called"
    end

    # And the rest...
    %w{get post put delete}.each do |calltype|
      it "responds to #{calltype}" do
        send(calltype, :create)
        expect(response.body).to eq "create called"
      end
    end
  end

  describe "#new" do
    it "responds to GET" do
      get :new
      expect(response.body).to eq "new called"
    end

    # And the rest...
    %w{get post put delete}.each do |calltype|
      it "responds to #{calltype}" do
        send(calltype, :new)
        expect(response.body).to eq "new called"
      end
    end
  end

  describe "#edit" do
    it "responds to GET" do
      get :edit, :params => { :id => "anyid" }
      expect(response.body).to eq "edit called"
    end

    it "requires the :id parameter" do
      expect { get :edit }.to raise_error(ExpectedRoutingError)
    end

    # And the rest...
    %w{get post put delete}.each do |calltype|
      it "responds to #{calltype}" do
        send(calltype, :edit, :params => {:id => "anyid"})
        expect(response.body).to eq "edit called"
      end
    end
  end

  describe "#show" do
    it "responds to GET" do
      get :show, :params => { :id => "anyid" }
      expect(response.body).to eq "show called"
    end

    it "requires the :id parameter" do
      expect { get :show }.to raise_error(ExpectedRoutingError)
    end

    # And the rest...
    %w{get post put delete}.each do |calltype|
      it "responds to #{calltype}" do
        send(calltype, :show, :params => {:id => "anyid"})
        expect(response.body).to eq "show called"
      end
    end
  end

  describe "#update" do
    it "responds to PUT" do
      put :update, :params => { :id => "anyid" }
      expect(response.body).to eq "update called"
    end

    it "requires the :id parameter" do
      expect { put :update }.to raise_error(ExpectedRoutingError)
    end

    # And the rest...
    %w{get post put delete}.each do |calltype|
      it "responds to #{calltype}" do
        send(calltype, :update, :params =>  {:id => "anyid"})
        expect(response.body).to eq "update called"
      end
    end
  end

  describe "#destroy" do
    it "responds to DELETE" do
      delete :destroy, :params => { :id => "anyid" }
      expect(response.body).to eq "destroy called"
    end

    it "requires the :id parameter" do
      expect { delete :destroy }.to raise_error(ExpectedRoutingError)
    end

    # And the rest...
    %w{get post put delete}.each do |calltype|
      it "responds to #{calltype}" do
        send(calltype, :destroy, :params => {:id => "anyid"})
        expect(response.body).to eq "destroy called"
      end
    end
  end

  describe "#willerror" do
    it "cannot be called" do
      expect { get :willerror }.to raise_error(ExpectedRoutingError)
    end
  end
end

运行测试

$ rspec spec

all 通过测试

为不从应用程序控制器继承的匿名控制器创建自定义路由

# spec/controllers/other_controller_spec.rb
require "rails_helper"
class OtherController < ActionController::Base
end

RSpec.describe OtherController, :type => :controller do
  controller do
    def custom
      render :plain => "custom called"
    end
  end

  specify "manually draw the route to request a custom action" do
    routes.draw { get "custom" => "other#custom" }

    get :custom
    expect(response.body).to eq "custom called"
  end
end

运行测试

$ rspec spec

all 通过测试

为定义的控制器创建自定义路由

# spec/controllers/application_controller_spec.rb
require "rails_helper"

class FoosController < ApplicationController; end

RSpec.describe ApplicationController, :type => :controller do
  controller FoosController do
    def custom
      render :plain => "custom called"
    end
  end

  specify "manually draw the route to request a custom action" do
    routes.draw { get "custom" => "foos#custom" }

    get :custom
    expect(response.body).to eq "custom called"
  end
end

运行测试

$ rspec spec

all 通过测试

与命名空间控制器一起使用

# spec/controllers/namespaced_controller_spec.rb
require "rails_helper"

class ApplicationController < ActionController::Base; end

module Outer
  module Inner
    class FoosController < ApplicationController; end
  end
end

RSpec.describe Outer::Inner::FoosController, :type => :controller do
  controller do
    def index
      @name = self.class.name
      @controller_name = controller_name
      render :plain => "Hello World"
    end
  end

  it "creates anonymous controller derived from the namespace" do
    expect(controller).to be_a_kind_of(Outer::Inner::FoosController)
  end

  it "gets the class name as described" do
    expect{ get :index }.to change{
      assigns[:name]
    }.to eq('Outer::Inner::FoosController')
  end

  it "gets the controller_name as described" do
    expect{ get :index }.to change{
      assigns[:controller_name]
    }.to eq('foos')
  end
end

运行测试

$ rspec spec

all 通过测试

参阅被测控制器中的应用程序路由

# spec/controllers/application_controller_spec.rb
require "rails_helper"

Rails.application.routes.draw do
  match "/login" => "sessions#new", :as => "login", :via => "get"
end

RSpec.describe ApplicationController, :type => :controller do
  controller do
    def index
      redirect_to login_url
    end
  end

  it "redirects to the login page" do
    get :index
    expect(response).to redirect_to("/login")
  end
end

运行测试

$ rspec spec

all 通过测试

忽略 rescue

使用bypass_rescue可以绕过两个 Rails 对错误的默认处理控制器动作，以及使用 screw_from 声明的任何自定义处理。

这使您可以指定引发异常的详细信息。

背景

# spec/controllers/gadgets_controller_spec_context.rb
class AccessDenied < StandardError; end

class ApplicationController < ActionController::Base
  rescue_from AccessDenied, :with => :access_denied

  private

  def access_denied
    redirect_to "/401.html"
  end
end

使用rescue_from处理标准异常

# spec/controllers/gadgets_controller_spec.rb
require "rails_helper"

require 'controllers/gadgets_controller_spec_context'

RSpec.describe GadgetsController, :type => :controller do
  before do
    def controller.index
      raise AccessDenied
    end
  end

  describe "index" do
    it "redirects to the /401.html page" do
      get :index
      expect(response).to redirect_to("/401.html")
    end
  end
end

运行测试

$ rspec spec/controllers/gadgets_controller_spec.rb

all 通过测试

使用bypass_rescue绕过rescue_from处理

# spec/controllers/gadgets_controller_spec.rb
require "rails_helper"

require 'controllers/gadgets_controller_spec_context'

RSpec.describe GadgetsController, :type => :controller do
  before do
    def controller.index
      raise AccessDenied
    end
  end

  describe "index" do
    it "raises AccessDenied" do
      bypass_rescue
      # 断言抛出异常
      expect { get :index }.to raise_error(AccessDenied)
    end
  end
end

运行测试

$ rspec spec/controllers/gadgets_controller_spec.rb

all 通过测试

路由控制

指定路由引擎

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

# A very simple Rails engine
module MyEngine
  class Engine < ::Rails::Engine
    isolate_namespace MyEngine
  end

  Engine.routes.draw do
    resources :widgets, :only => [:show] do
      get :random, :on => :collection
    end
  end

  class WidgetsController < ::ActionController::Base
    def random
      @random_widget = Widget.all.shuffle.first
      redirect_to widget_path(@random_widget)
    end

    def show
      @widget = Widget.find(params[:id])
      render :text => @widget.name
    end
  end
end

RSpec.describe MyEngine::WidgetsController, :type => :controller do
  routes { MyEngine::Engine.routes }

  it "redirects to a random widget" do
    widget1 = Widget.create!(:name => "Widget 1")
    widget2 = Widget.create!(:name => "Widget 2")

    get :random
    expect(response).to be_redirect
    expect(response).to redirect_to(assigns(:random_widget))
  end
end

运行测试

$ rspec spec

all 通过测试

Cookies

测试在控制器中清除 cookie 的值

# spec/controllers/application_controller_spec.rb
require "rails_helper"

RSpec.describe ApplicationController, :type => :controller do
  controller do
    def clear_cookie
      cookies.delete(:user_name)
      head :ok
    end
  end

  before do
    routes.draw { get "clear_cookie" => "anonymous#clear_cookie" }
  end

  it "clear cookie's value 'user_name'" do
    cookies[:user_name] = "Sam"

    get :clear_cookie

    expect(cookies[:user_name]).to eq nil
  end
end

运行测试

$ rspec spec

all 通过测试

设置请求头

不推荐直接在控制器中设置请求头，如果非要设置，请使用下面的 request.headers 方法

设置请求头

# spec/controllers/application_controller_spec.rb
require "rails_helper"

RSpec.describe ApplicationController, type: :controller do
  controller do
    def show
      if request.headers["Authorization"] == "foo"
        head :ok
      else
        head :forbidden
      end
    end
  end

  before do
    routes.draw { get "show" => "anonymous#show" }
  end

  context "valid Authorization header" do
    it "returns a 200" do
      request.headers["Authorization"] = "foo"

      get :show

      expect(response).to have_http_status(:ok)
    end
  end

  context "invalid Authorization header" do
    it "returns a 403" do
      request.headers["Authorization"] = "bar"

      get :show

      expect(response).to have_http_status(:forbidden)
    end
  end
end

运行测试

$ rspec spec

all 通过测试

期望值匹配

rspec-rails 提供了许多自定义匹配器，其中大多数是 rspec 的用于 Rails 的断言装饰器。所以完全兼容 Rails 默认的断言方式。

关于兼容性，例如：

# rails 写法
assert_equal 403, response.status
assert_response 403
# rspec写法
expect(response).to have_http_status(403)

完全等价

Be_a_new 新建

四个 be_a_new 示例

# spec/models/widget_spec.rb
require "rails_helper"

RSpec.describe Widget do
  context "when initialized" do
    subject(:widget) { Widget.new }

    it "is a new widget" do
      expect(widget).to be_a_new(Widget)
    end

    it "is not a new string" do
      expect(widget).not_to be_a_new(String)
    end
  end

  context "when saved" do
    subject(:widget) { Widget.create }

    it "is not a new widget" do
      expect(widget).not_to be_a_new(Widget)
    end

    it "is not a new string" do
      expect(widget).not_to be_a_new(String)
    end
  end
end

运行测试

$ rspec spec/models/widget_spec.rb

all 通过测试

Render_template

3 种 render_template 示例

# spec/controllers/gadgets_spec.rb
require "rails_helper"

RSpec.describe GadgetsController do
  describe "GET #index" do
    subject { get :index }

    it "renders the index template" do
      expect(subject).to render_template(:index)
      expect(subject).to render_template("index")
      expect(subject).to render_template("gadgets/index")
    end

    it "does not render a different template" do
      expect(subject).to_not render_template("gadgets/show")
    end
  end
end

运行测试

$ rspec spec/controllers/gadgets_spec.rb

all 通过测试

指定 layout

# spec/controllers/gadgets_spec.rb
require "rails_helper"

RSpec.describe GadgetsController do
  describe "GET #index" do
    subject { get :index }

    it "renders the application layout" do
      expect(subject).to render_template("layouts/application")
    end

    it "does not render a different layout" do
      expect(subject).to_not render_template("layouts/admin")
    end
  end
end

运行测试

$ rspec spec/controllers/gadgets_spec.rb

all 通过测试

视图中使用

# spec/views/gadgets/index.html.erb_spec.rb
require "rails_helper"

RSpec.describe "gadgets/index" do
  it "renders the index template" do
    assign(:gadgets, [Gadget.create!])
    render

    expect(view).to render_template(:index)
    expect(view).to render_template("index")
    expect(view).to render_template("gadgets/index")
  end

  it "does not render a different template" do
    expect(view).to_not render_template("gadgets/show")
  end
end

运行测试

$ rspec spec/views

all 通过测试

Redirect_to

4 种 redirect_to 示例

# spec/controllers/widgets_controller_spec.rb
require "rails_helper"

RSpec.describe WidgetsController do

  describe "#create" do
    subject { post :create, :params => { :widget => { :name => "Foo" } } }

    it "redirects to widget_url(@widget)" do
      expect(subject).to redirect_to(widget_url(assigns(:widget)))
    end

    it "redirects_to :action => :show" do
      expect(subject).to redirect_to :action => :show,
                                     :id => assigns(:widget).id
    end

    it "redirects_to(@widget)" do
      expect(subject).to redirect_to(assigns(:widget))
    end

    it "redirects_to /widgets/:id" do
      expect(subject).to redirect_to("/widgets/#{assigns(:widget).id}")
    end
  end
end

运行测试

$  rspec spec/controllers/widgets_controller_spec.rb

all 通过测试

have_http_status

检查数字状态码

# spec/controllers/application_controller_spec.rb
require "rails_helper"

RSpec.describe ApplicationController, :type => :controller do

  controller do
    def index
      render :json => {}, :status => 209
    end
  end

  describe "GET #index" do
    it "returns a 209 custom status code" do
      get :index
      expect(response).to have_http_status(209)
    end
  end

end

运行测试

$  rspec spec

all 通过测试

检查符号状态码

# spec/controllers/application_controller_spec.rb
require "rails_helper"

RSpec.describe ApplicationController, :type => :controller do

  controller do
    def index
      render :json => {}, :status => :see_other
    end
  end

  describe "GET #index" do
    it "returns a :see_other status code" do
      get :index
      expect(response).to have_http_status(:see_other)
    end
  end

end

运行测试

$  rspec spec

all 通过测试

检查通用符号状态类型

# spec/controllers/application_controller_spec.rb
require "rails_helper"

RSpec.describe ApplicationController, :type => :controller do

  controller do
    def index
      render :json => {}, :status => :bad_gateway
    end
  end

  describe "GET #index" do
    it "returns a some type of error status code" do
      get :index
      expect(response).to have_http_status(:error)
    end
  end

end

运行测试

$  rspec spec

all 通过测试

在控制器中使用

# spec/controllers/gadgets_spec.rb
require "rails_helper"

RSpec.describe GadgetsController, :type => :controller do

  describe "GET #index" do
    it "returns a 200 OK status" do
      get :index
      expect(response).to have_http_status(:ok)
    end
  end

end

运行测试

$  rspec spec/controllers/gadgets_spec.rb

all 通过测试

在 request 中使用

# spec/requests/gadgets/widget_management_spec.rb
require "rails_helper"

RSpec.describe "Widget management", :type => :request do

  it "creates a Widget and redirects to the Widget's page" do
    get "/widgets/new"
    expect(response).to have_http_status(:ok)

    post "/widgets", :params => { :widget => {:name => "My Widget"} }
    expect(response).to have_http_status(302)

    follow_redirect!

    expect(response).to have_http_status(:success)
  end

end

运行测试

$  rspec spec/requests

all 通过测试

在 feature 中使用

# spec/features/widget_management_spec.rb
require "rails_helper"

RSpec.feature "Widget management", :type => :feature do

  scenario "User creates a new widget" do
    visit "/widgets/new"
    expect(page).to have_http_status(200)

    click_button "Create Widget"

    expect(page).to have_http_status(:success)
  end

end

运行测试

$  rspec spec/features/widget_management_spec.rb

all 通过测试

match_array

实例

# spec/models/widget_spec.rb
require "rails_helper"

RSpec.describe Widget do
  let!(:widgets) { Array.new(3) { Widget.create } }

  subject { Widget.all }

  it "returns all widgets in any order" do
    expect(subject).to match_array(widgets)
  end
end

运行测试

$ rspec spec/models/widget_spec.rb

all 通过测试

Have_been_enqueued

检查指定的任务是否在排队

检查任务的类名

# spec/jobs/upload_backups_job_spec.rb
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_enqueued
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

检查任务传参

# spec/jobs/upload_backups_job_spec.rb
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later("users-backup.txt", "products-backup.txt")
    expect(UploadBackupsJob).to(
      have_been_enqueued.with("users-backup.txt", "products-backup.txt")
    )
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

检查任务排队时间

# spec/jobs/upload_backups_job_spec.rb"
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.set(:wait_until => Date.tomorrow.noon).perform_later
    expect(UploadBackupsJob).to have_been_enqueued.at(Date.tomorrow.noon)
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

检查没有等待的工作

# spec/jobs/upload_backups_job_spec.rb
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_enqueued.at(:no_wait)
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

检查任务队列名称

# spec/jobs/upload_backups_job_spec.rb" with:
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with enqueued job" do
    ActiveJob::Base.queue_adapter = :test
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_enqueued.on_queue("default")
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

Have_been_performed

检查任务是否已经执行

检查任务类名

# spec/jobs/upload_backups_job_spec.rb
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_performed
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

检查任务参数

# spec/jobs/upload_backups_job_spec.rb
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    UploadBackupsJob.perform_later("users-backup.txt", "products-backup.txt")
    expect(UploadBackupsJob).to(
      have_been_performed.with("users-backup.txt", "products-backup.txt")
    )
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

检查任务执行时间

# spec/jobs/upload_backups_job_spec.rb
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    ActiveJob::Base.queue_adapter.perform_enqueued_at_jobs = true
    UploadBackupsJob.set(:wait_until => Date.tomorrow.noon).perform_later
    expect(UploadBackupsJob).to have_been_performed.at(Date.tomorrow.noon)
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

检查任务队列名

# spec/jobs/upload_backups_job_spec.rb
require "rails_helper"

RSpec.describe UploadBackupsJob do
  it "matches with performed job" do
    ActiveJob::Base.queue_adapter = :test
    ActiveJob::Base.queue_adapter.perform_enqueued_jobs = true
    UploadBackupsJob.perform_later
    expect(UploadBackupsJob).to have_been_performed.on_queue("default")
  end
end

运行测试

$ rspec spec/jobs/upload_backups_job_spec.rb

all 通过测试

request rspec

Request spec

使用 Rails 内部方法管理 Widget

# spec/requests/widget_management_spec.rb
require "rails_helper"

RSpec.describe "Widget management", :type => :request do

  it "creates a Widget and redirects to the Widget's page" do
    get "/widgets/new"
    expect(response).to render_template(:new)

    post "/widgets", :params => { :widget => {:name => "My Widget"} }

    expect(response).to redirect_to(assigns(:widget))
    follow_redirect!

    expect(response).to render_template(:show)
    expect(response.body).to include("Widget was successfully created.")
  end

  it "does not render a different template" do
    get "/widgets/new"
    expect(response).to_not render_template(:show)
  end
end

运行测试

$ rspec spec/requests/widget_management_spec.rb

all 通过测试

发送 json 请求数据

# spec/requests/widget_management_spec.rb
require "rails_helper"

RSpec.describe "Widget management", :type => :request do

  it "creates a Widget" do
    # 设置请求头
    headers = { "ACCEPT" => "application/json" }
    # 设置响应数据格式
    post "/widgets", :params => { :widget => {:name => "My Widget"} }, :headers => headers

    expect(response.content_type).to eq("application/json")
    expect(response).to have_http_status(:created)
  end

end

运行测试

$ rspec spec/requests/widget_management_spec.rb

all 通过测试

请求 json 响应数据

# spec/requests/widget_management_spec.rb
require "rails_helper"

RSpec.describe "Widget management", :type => :request do
  it "creates a Widget" do
    headers = { "ACCEPT" => "application/json" }
    post "/widgets", :params => { :widget => {:name => "My Widget"} }, :headers => headers

    expect(response.content_type).to eq("application/json; charset=utf-8")
    expect(response).to have_http_status(:created)
  end
end

运行测试

$ rspec spec/requests/widget_management_spec.rb

all 通过测试

请求 json 数据

# spec/requests/widget_management_spec.rb
require "rails_helper"

RSpec.describe "Widget management", :type => :request do

  it "creates a Widget and redirects to the Widget's page" do
    # 设置请求数据的格式
    headers = { "CONTENT_TYPE" => "application/json" }
    post "/widgets", :params => '{ "widget": { "name":"My Widget" } }', :headers => headers
    expect(response).to redirect_to(assigns(:widget))
  end

end

运行测试

$ rspec spec/requests/widget_management_spec.rb

all 通过测试

使用路由辅助方法

# spec/requests/widgets_spec.rb
require "rails_helper"

# 简单的 Rails engine
module MyEngine
  class Engine < ::Rails::Engine
    isolate_namespace MyEngine
  end

  class LinksController < ::ActionController::Base
    def index
      render plain: 'hit_engine_route'
    end
  end
end

MyEngine::Engine.routes.draw do
  resources :links, :only => [:index]
end

Rails.application.routes.draw do
  mount MyEngine::Engine => "/my_engine"
end

module MyEngine
  RSpec.describe "Links", :type => :request do
    include Engine.routes.url_helpers

    it "redirects to a random widget" do
      # 允许使用 辅助方法访问
      get links_path
      expect(response.body).to eq('hit_engine_route')
    end
  end
end

运行测试

$ rspec spec

all 通过测试

Mailer specs

URL helpers

使用 url 辅助方法的默认参数

# config/initializers/mailer_defaults.rb
Rails.configuration.action_mailer.default_url_options = { :host => 'example.com' }


# spec/mailers/notifications_spec.rb
require 'rails_helper'

RSpec.describe NotificationsMailer, :type => :mailer do
  it 'should have access to URL helpers' do
    expect { gadgets_url }.not_to raise_error
  end
end

运行测试

$ rspec spec

all 通过测试

使用 url 辅助方法，不使用默认参数

# config/initializers/mailer_defaults.rb
# no default options

#spec/mailers/notifications_spec.rb
require 'rails_helper'

RSpec.describe NotificationsMailer, :type => :mailer do
  it 'should have access to URL helpers' do
    expect { gadgets_url :host => 'example.com' }.not_to raise_error
    expect { gadgets_url }.to raise_error
  end
end

运行测试

$ rspec spec

all 通过测试

Mailer

简单实例

# spec/mailers/notifications_mailer_spec.rb" with:
require "rails_helper"

# 最外层的架构快
# RSpec.describe 类名, :type => :类型 do
RSpec.describe NotificationsMailer, :type => :mailer do
  # 一个 describe 块
  describe "notify" do
    let(:mail) { NotificationsMailer.signup }
  # 一个测试用例
    it "renders the headers" do
      # expect(值).to eq(等于的值)
      expect(mail.subject).to eq("Signup")
      expect(mail.to).to eq(["to@example.org"])
      expect(mail.from).to eq(["from@example.com"])
    end
  # 一个测试用例
    it "renders the body" do
      expect(mail.body.encoded).to match("Hi")
    end
  end
end

运行测试

$ rspec spec

all 通过测试

File fixture

Rails 5 新增 file fixture 对象。

稳进默认存储路径：spec/fixtures/files

File fixtures 代表了 +Pathname+ 对象，使用很简单。

实例：

file_fixture("example.txt").read # get the file's content
file_fixture("example.mp3").size # get the file size

通过配置可以改变默认文件位置

RSpec.configure do |config|
  config.file_fixture_path = "spec/custom_directory"
end

读取文件内容

# spec/fixtures/files/sample.txt
Hello


# spec/lib/file_spec.rb
require "rails_helper"

RSpec.describe "file" do
  it "reads sample file" do
    #期待.读取文件的内容.为 等于("hello")
    expect(file_fixture("sample.txt").read).to eq("Hello")
  end
end

运行测试

$ rspec spec/lib/file_spec.rb

all 通过测试

Ruby China 社区 Gem 节点

WhereableScope: 把 scope 用作 where 參數

推荐一个让页面支持 live reload 的 Gem —— rails_live_reload

做了一个嵌套表单的 gem

用纯 Ruby 实现了国密 SM2 密码算法

Camille：让前端和 Rails 进行类型安全的通信

CommitGPT

carrierwave-aliyun 可以生成 oss 智能媒体链接吗

命令行词典 ecdict 更新，Gem 一键安装，支持中文搜索英文，增强英文补全

ecdict

安装

依赖

使用

Troubleshoot

Rails PG Extras - PG 性能检查工具

Gem 介绍

下一步

参考

彩蛋

searchkick 用法问题

Error installing sinatra [已解决]

Sequel Migration 指北

haml 和 slim 有什么不同吗?

怎么格式化 rack 的 @env

rescue 为什么不处理 SQLite3::SQLException 异常

gem 不安装能检测到冲突吗？

Rails 好用常用 gem 汇总

原文链接，原文展示效果更佳哦～

好用的 Gem 列表

前端常用

会员系统常用

内容功能常用

内容输入

后台管理

部署

开发测试常用

生产运维性能常用

爬虫常用

SEO 优化

参考文章

2021 Rails-carrierwave 通过 api 上传音频实例

carrierwave 官网地址

storage

store_dir

建立关联

Controller

routes

测试 web 上传

测试 API 上传

常见用法

可用 url

服务器路径

可能出现的错误

1, no implicit conversion of nil into String

2, Encoding::UndefinedConversionError "\xE6" from ASCII-8BIT to UTF-8

3, Can't verify CSRF token authenticity

运行环境

求教, Ruby 的 Git 操作库, Rugged 如何执行 git pull?

rspec5 一览大文

安装

添加到 Gemfile

安装

初始化成为默认测试框架

运行测试

或者

测试框架

内置创建器

事务

禁用事务

利用 before 关键字实现自动回滚的控制

目录结构建议

rspec 的目录规范

自动识别类型

建议

场景

Backtrace 过滤

局部使用 filter_rails_from_backtrace!

为模型编写 rspec

事务的例子

支持 double

利用 `before` 关键字实现自动回滚的控制

局部使用 `filter_rails_from_backtrace!`