Question

使用添加的rspec-rails生成器来设置RSpec以测试Rails应用程序非常容易。但是如何添加RSpec来测试开发中的宝石？我不是在使用珠宝商或这样的工具。我只是使用Bundler（bundle gem my_gem）来设置新gem的结构并手动编辑* .gemspec。我还向gemspec添加了s.add_development_dependency "rspec", ">= 2.0.0"并执行了bundle install。

是否有一些很好的教程，接下来要做什么让RSpec工作？

Answer 1

我已更新此答案以符合当前的最佳做法：

Bundler完美支持宝石开发。如果您正在创建一个gem，那么您需要在Gemfile中拥有唯一的内容如下：

source "https://rubygems.org"
gemspec

这告诉Bundler在运行bundle install时查看gemspec文件中的依赖项。

接下来，确保RSpec是gem的开发依赖项。编辑gemspec，使其显示为：

spec.add_development_dependency "rspec"

接下来，创建spec/spec_helper.rb并添加如下内容：

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时，这将强制您的规范使用您当前的代码，而不是您单独安装的版本。

创建规范，例如spec/foobar_spec.rb：

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

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

--color
--format documentation

最后：运行规范：

$ rspec spec/foobar_spec.rb

Answer 2

Iain的解决方案效果很好！

如果您还想要一个Rakefile，这就是您所需要的：

require 'rspec/core/rake_task'

RSpec::Core::RakeTask.new(:spec)

# If you want to make this the default task
task default: :spec

检查RDoc中的RakeTask，了解可以选择传递给任务定义的各种选项。

Answer 3

您可以通过运行bundler gem --test=rspec my_gem使用rspec生成新的gem。没有额外的设置！

我总是忘记这一点。它在此实施：https://github.com/bundler/bundler/blob/33d2f67d56fe8bf00b0189c26125d27527ef1516/lib/bundler/cli/gem.rb#L36

Answer 4

这是一种便宜又简单（虽然不是官方推荐）的方式：

在你宝石的根目录中创建一个名为spec的目录，将你的规格放在那里。您可能已经安装了rspec，但如果不安装，只需执行gem install rspec并忘记Gemfiles和bundler。

接下来，您将制作一个规范，您需要告诉它您的应用程序在哪里，您的文件在哪里，并包含您要测试的文件（以及它具有的任何依赖项）：

# spec/awesome_gem/awesome.rb
APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
$: << File.join(APP_ROOT, 'lib/awesome_gem') # so rspec knows where your file could be
require 'some_file_in_the_above_dir' # this loads the class you want to test

describe AwesomeGem::Awesome do
  before do
    @dog = AwesomeGem::Awesome.new(name: 'woofer!')
  end
  it 'should have a name' do
    @dog.name.should eq 'woofer!'
  end
  context '#lick_things' do
    it 'should return the dog\'s name in a string' do
      @dog.lick_things.should include 'woofer!:'
    end
  end
end

打开终端并运行rspec：

~/awesome_gem $ rspec
..

Finished in 0.56 seconds
2 examples, 0 failures

如果您想要一些.rspec选项，请创建一个.rspec文件并将其放入gem的根路径中。我看起来像这样：

# .rspec
--format documentation --color --debug --fail-fast

简单，快速，整洁！

我喜欢这个，因为你根本不需要为你的项目添加任何依赖项，整个事情仍然非常快。 bundle exec减慢了一些事情，这是你必须要做的，以确保你一直使用相同版本的rspec。运行两次测试所花费的0.56秒是我的计算机加载rspec时占用的99％。运行数百个规格应该非常快。您可能遇到的唯一问题是，如果您更改了rspec的版本，并且新版本与您在测试中使用的某些功能不向后兼容，则可能需要重新编写一些测试。

如果您正在进行一次性规范或者有一些很好的理由不在您的gemspec中包含rspec，那么这很好，但是这对于启用共享或强制执行兼容性并不是很好。

设置RSpec来测试gem（不是Rails）

4 个答案: