Rspec::PendingFor
Easiest to just show you:
it('blah is blah') do
pending_for(:engine => 'rbx')
pending_for(:engine => 'ruby', :versions => '2.1.5')
pending_for(:engine => 'jruby', :versions => '2.2.2', :reason => 'due to a bug in Ruby')
pending_for(:engine => 'ruby', :versions => '2.0.0', :reason => "because I don't have the time")
expect('blah').to eq 'blah'
end
Requires Ruby 1.8.7+ (same as RSPec, any engine)
Project | Rspec::PendingFor |
---|---|
gem name | rspec-pending_for |
license | |
download rank | |
version | |
dependencies | |
CI > ruby 2.0.0 | |
CI <= ruby 2.0.0 | |
test coverage | |
maintainability | |
code triage | |
homepage | on Github.com, on Railsbling.com |
documentation | on RDoc.info |
Spread ~♡ⓛⓞⓥⓔ♡~ | 🌏, 👼, :shipit:, , 🌹 |
Installation
Add this line to your application's Gemfile:
gem 'rspec-pending_for'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rspec-pending_for
Usage
The gem auto-configures itself for use in your Rspec suite. Just add this line to yous spec_helper.rb
:
require 'rspec/pending_for'
To mark a spec pending for a specific ruby engine, and/or versions:
it('blah is blah') do
pending_for(:engine => 'ruby', :versions => '2.1.5')
expect('blah').to eq 'blah'
end
To skip a spec for a specific ruby engine, and/or versions:
it('blah is blah') do
skip_for(:engine => 'ruby', :versions => '2.1.5')
expect('blah').to eq 'blah'
end
To mark a spec pending for all versions of a given engine:
it('blah is blah') do
pending_for(:engine => 'jruby')
expect('blah').to eq 'blah'
end
To mark a spec pending for a custom reason (overriding the default message):
it('blah is blah') do
pending_for(:engine => 'jruby', :reason => 'This does not work on JRuby')
expect('blah').to eq 'blah'
end
To mark a spec pending or skipped for multiple engines and versions, just what you would expect:
it('blah is blah') do
skip_for(:engine => 'jruby', :reason => 'This does not work on JRuby so skipping for now') # All JRuby versions will be skipped
pending_for(:engine => 'rbx', :reason => 'This does not work on Rubinius so pending for now') # All rbx versions will be pending
pending_for(:engine => 'ruby', :versions => %w(1.9.3 2.0.0 2.1.0)) # uses the default message
expect('blah').to eq 'blah'
end
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Authors
Peter H. Boling of Rails Bling is the author.
Contributors
See the Network View and the CHANGELOG
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Create new Pull Request
Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/rspec-pending_for. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
Code of Conduct
Everyone interacting in the Rspec::PendingFor project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
Versioning
This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.
As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision.
For example:
For example in a Gemfile
:
gem 'rspec-pending_for', '~> 0.1', group: :test
or in a gemspec
spec.add_dependency 'rspec-pending_for', '~> 0.1'
Legal
- MIT License - See LICENSE file in this project
- Copyright (c) 2015 - 2018 Peter H. Boling of Rails Bling