README.md in rspec-pending_for-0.1.3 vs README.md in rspec-pending_for-0.1.4
- old
+ new
@@ -2,32 +2,47 @@
Easiest to just show you:
```ruby
it("blah is blah") do
- pending_for(engine: "ruby", version: "2.1.5")
- pending_for(engine: "jruby", version: "2.2.2")
+ 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.9+ (any engine)
-| Project | Rspec::PendingFor |
-|------------------------ | ------------------ |
-| gem name | rspec-pending_for |
-| license | MIT |
+| Project | Rspec::PendingFor |
+|------------------------ | ----------------- |
+| gem name | rspec-pending_for |
+| license | MIT |
+| expert support | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) |
+| download rank | [![Total Downloads](https://img.shields.io/gem/rt/rspec-pending_for.svg)](https://rubygems.org/gems/rspec-pending_for) |
| version | [![Gem Version](https://badge.fury.io/rb/rspec-pending_for.png)](http://badge.fury.io/rb/rspec-pending_for) |
| dependencies | [![Dependency Status](https://gemnasium.com/pboling/rspec-pending_for.png)](https://gemnasium.com/pboling/rspec-pending_for) |
| code quality | [![Code Climate](https://codeclimate.com/github/pboling/rspec-pending_for.png)](https://codeclimate.com/github/pboling/rspec-pending_for) |
| inline documenation | [![Inline docs](http://inch-ci.org/github/pboling/rspec-pending_for.png)](http://inch-ci.org/github/pboling/rspec-pending_for) |
| continuous integration | [![Build Status](https://secure.travis-ci.org/pboling/rspec-pending_for.png?branch=master)](https://travis-ci.org/pboling/rspec-pending_for) |
-| homepage | [https://github.com/pboling/rspec-pending_for][homepage] |
-| documentation | [http://rdoc.info/github/pboling/rspec-pending_for/frames][documentation] |
-| author | [Peter Boling](https://coderbits.com/pboling) |
-| Spread ~♡ⓛⓞⓥⓔ♡~ | [![Endorse Me](https://api.coderwall.com/pboling/endorsecount.png)](http://coderwall.com/pboling) |
+| test coverage | [![Coverage Status](https://coveralls.io/repos/pboling/rspec-pending_for/badge.png)](https://coveralls.io/r/pboling/rspec-pending_for) |
+| homepage | [on Github.com][homepage] |
+| documentation | [on Rdoc.info][documentation] |
+| live chat | [![Join the chat at https://gitter.im/pboling/rspec-pending_for](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/rspec-pending_for?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
+| author | Peter Boling ([Rubyish Blog](https://railsbling.com)) |
+| Spread ~♡ⓛⓞⓥⓔ♡~↝ | [on AngelList][angellist], [on Coderwall][coderwall] |
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+[railsbling]: http://www.railsbling.com
+[peterboling]: http://www.peterboling.com
+[angellist]: https://angel.co/peter-boling
+[coderwall]: http://coderwall.com/pboling
+[documentation]: http://rdoc.info/github/pboling/rspec-pending_for/frames
+[homepage]: https://github.com/pboling/rspec-pending_for
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -42,43 +57,47 @@
$ gem install rspec-pending_for
## Usage
-The gem auto-configures itself for use in your Rspec suite. Just use it!
+The gem auto-configures itself for use in your Rspec suite. Just add this line to yous `spec_helper.rb`:
+```ruby
+require 'rspec/pending_for'
+```
+
To mark a spec pending for a specific ruby engine, and/or versions:
```ruby
it("blah is blah") do
- pending_for(engine: "ruby", version: "2.1.5")
+ 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:
```ruby
it("blah is blah") do
- skip_for(engine: "ruby", version: "2.1.5")
+ 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:
```ruby
it("blah is blah") do
- skip_for(engine: "jruby")
+ pending_for(engine: "jruby")
expect("blah").to eq "blah"
end
```
To mark a spec pending for a custom reason (overriding the default message):
```ruby
it("blah is blah") do
- skip_for(engine: "jruby", reason: "This does not work on JRuby")
+ 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: