设置RSpec来测试gem(不是Rails) [英] Set up RSpec to test a gem (not Rails)

问题描述

使用添加的rspec-rails生成器可以很容易地设置RSpec来测试Rails应用程序.但是，如何添加RSpec来测试开发中的gem?我没有使用珠宝商或类似工具.我只是使用Bundler( bundle gem my_gem )来设置新gem的结构，并手动编辑* .gemspec.我还向gemspec添加了 s.add_development_dependency"rspec"，> = 2.0.0&" 并进行了捆绑安装.

It is pretty easy with the added generator of rspec-rails to set up RSpec for testing a Rails application. But how about adding RSpec for testing a gem in development? I am not using jeweler or such tools. I just used Bundler (bundle gem my_gem) to setup the structure for the new gem and edit the *.gemspec manually. I also added s.add_development_dependency "rspec", ">= 2.0.0" to gemspec and did a bundle install.

是否有一些不错的教程，接下来如何使RSpec工作?

Is there some nice tutorial what to do next to get RSpec working?

推荐答案

我已经更新了此答案以匹配当前的最佳做法:

I've updated this answer to match current best practices:

Bundler完美支持宝石开发.如果要创建宝石，则Gemfile中需要的 only 内容如下:

Bundler supports gem development perfectly. If you are creating a gem, the only thing you need to have in your Gemfile is the following:

source "https://rubygems.org"
gemspec

这告诉Bundler在运行 bundle install 时在gemspec文件中查找依赖项.

This tells Bundler to look inside your gemspec file for the dependencies when you run bundle install.

接下来，请确保RSpec是您gem的开发依赖项.编辑gemspec，使其显示为:

Next up, make sure that RSpec is a development dependency of your gem. Edit the gemspec so it reads:

spec.add_development_dependency "rspec"

接下来，创建 spec/spec_helper.rb 并添加类似内容:

Next, create spec/spec_helper.rb and add something like:

require 'bundler/setup'
Bundler.setup

require 'your_gem_name' # and any other gems you need

RSpec.configure do |config|
  # some (optional) config here
end

前两行告诉Bundler仅在gemspec中加载宝石.当您在自己的计算机上安装自己的gem时，这将迫使您的规范使用当前的代码，而不是您单独安装的版本.

The first two lines tell Bundler to load only the gems inside your gemspec. When you install your own gem on your own machine, this will force your specs to use your current code, not the version you have installed separately.

创建一个规范，例如 spec/foobar_spec.rb :

require 'spec_helper'
describe Foobar do
  pending "write it"
end

可选:添加 .rspec 文件作为默认选项，并将其放在gem的根路径中:

Optional: add a .rspec file for default options and put it in your gem's root path:

--color
--format documentation

最后:运行规格:

$ rspec spec/foobar_spec.rb

这篇关于设置RSpec来测试gem(不是Rails)的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！