README.md in rspec-block_is_expected-1.0.4 vs README.md in rspec-block_is_expected-1.0.5
- old
+ new
@@ -2,36 +2,43 @@
This gem does one very simple thing very well. It allows you to use `block_is_expected` similarly to how you would use `is_expected` if a block was wrapping the subject. Supports the same versions of Ruby that RSpec does, 1.8.7 - current ruby-head, as well as the JRuby equivalents.
```ruby
subject { Integer(nil) }
-it('raises') { block_is_expected.to raise_error(TypeError) }
+it("raises") { block_is_expected.to(raise_error(TypeError)) }
```
-| Project | AnonymousActiveRecord |
-|------------------------ | ----------------------- |
-| gem name | [rspec-block_is_expected](https://rubygems.org/gems/rspec-block_is_expected) |
-| license | [](https://opensource.org/licenses/MIT) |
-| download rank | [](https://github.com/pboling/rspec-block_is_expected) |
-| version | [](https://rubygems.org/gems/rspec-block_is_expected) |
-| dependencies | [](https://depfu.com/github/pboling/rspec-block_is_expected?project_id=5614) |
-| continuous integration | [](https://travis-ci.org/pboling/rspec-block_is_expected) |
-| test coverage | [](https://codeclimate.com/github/pboling/rspec-block_is_expected/test_coverage) |
-| maintainability | [](https://codeclimate.com/github/pboling/rspec-block_is_expected/maintainability) |
-| code triage | [](https://www.codetriage.com/pboling/rspec-block_is_expected) |
-| homepage | [on Github.com][homepage], [on Railsbling.com][blogpage] |
-| documentation | [on RDoc.info][documentation] |
-| Spread ~♡ⓛⓞⓥⓔ♡~ | [🌏](https://about.me/peter.boling), [👼](https://angel.co/peter-boling), [:shipit:](http://coderwall.com/pboling), [](http://twitter.com/galtzo)|
+| Project | RSpec::BlockIsExpected |
+|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| gem name | [rspec-block_is_expected](https://rubygems.org/gems/rspec-block_is_expected) |
+| license | [](https://opensource.org/licenses/MIT) |
+| download rank | [](https://github.com/pboling/rspec-block_is_expected) |
+| version | [](https://rubygems.org/gems/rspec-block_is_expected) |
+| dependencies | [![Depfu][depfu-img]][depfu] |
+| continuous integration | [![Current][🚎cwfi]][🚎cwf] [![Heads][🖐hwfi]][🖐hwf] [![Style][🧮swfi]][🧮swf] |
+| test coverage | [![Test Coverage][cc-covi]][cc-cov] |
+| maintainability | [](https://codeclimate.com/github/pboling/rspec-block_is_expected/maintainability) |
+| code triage | [](https://www.codetriage.com/pboling/rspec-block_is_expected) |
+| homepage | [on Github.com][homepage], [on Railsbling.com][blogpage] |
+| documentation | [on RDoc.info][documentation] |
+| Spread ~♡ⓛⓞⓥⓔ♡~ | [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay], [🧊][🧊berg], [🛖][🛖hut], [🧪][🧪lab], [🌏][aboutme], [👼][angellist], [⚗️][devto], [![Tweet @galtzo][followme]][twitter] |
-If you only ever want to test subjects wrapped in blocks, and are comfortable with **losing** the standard `is_expected` behavior, see an alternative to this gem [here](https://github.com/christopheraue/ruby-rspec-is_expected_block/).
+[🚎cwf]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/current.yml
+[🚎cwfi]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/current.yml/badge.svg
+[🖐hwf]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/heads.yml
+[🖐hwfi]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/heads.yml/badge.svg
+[🧮swf]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/style.yml
+[🧮swfi]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/style.yml/badge.svg
+If you only _ever_ want to test subjects wrapped in blocks, and are comfortable with **losing** the standard `is_expected` behavior, see an alternative to this gem [here](https://github.com/christopheraue/ruby-rspec-is_expected_block/).
+
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'rspec-block_is_expected', :group => :test
+gem "rspec-block_is_expected", :group => :test
```
And then execute:
$ bundle
@@ -44,55 +51,55 @@
There is no configuration needed if you your test suite loads the bundle group (e.g. `test`) that you added the gem to.
Otherwise, you may load it manually near the top of your `spec_helper.rb`, and it will self configure.
```ruby
-require 'rspec/block_is_expected'
+require "rspec/block_is_expected"
```
### RSpec Matchers
`block_is_expected` can be used to chain expectations related to the block,
but `to_not` doesn't work with multiple expectations.
So negated matchers are required. A basic set of them are included with this gem, and can be loaded with:
```ruby
-require 'rspec/block_is_expected/matchers/not'
+require "rspec/block_is_expected/matchers/not"
```
This gives you the following matchers:
```ruby
-RSpec::Matchers.define_negated_matcher :not_change, :change
-RSpec::Matchers.define_negated_matcher :not_include, :include
-RSpec::Matchers.define_negated_matcher :not_eq, :eq
-RSpec::Matchers.define_negated_matcher :not_raise_error, :raise_error
+RSpec::Matchers.define_negated_matcher(:not_change, :change)
+RSpec::Matchers.define_negated_matcher(:not_include, :include)
+RSpec::Matchers.define_negated_matcher(:not_eq, :eq)
+RSpec::Matchers.define_negated_matcher(:not_raise_error, :raise_error)
```
#### Example
You have a module like this:
```ruby
module MyTasks
def my_rakelib
- Rake.add_rakelib('bananas')
+ Rake.add_rakelib("bananas")
end
module_function :my_rakelib
end
```
You have a spec like this:
```ruby
-require 'rake'
+require "rake"
RSpec.describe(MyTasks) do
- describe 'my_rakelib' do
+ describe "my_rakelib" do
subject(:my_rakelib) { described_class.my_rakelib }
- it 'updates rakelib' do
- block_is_expected.to not_raise_error &
- change { Rake.application.options.rakelib }.from(['rakelib']).to(%w[rakelib bananas])
+ it "updates rakelib" do
+ block_is_expected.to(not_raise_error &
+ change { Rake.application.options.rakelib }.from(["rakelib"]).to(%w[rakelib bananas]))
end
end
end
```
@@ -113,70 +120,75 @@
## Usage
The spec suite for this gem has some examples of usage, lightly edited here.
```ruby
-RSpec.describe 'TestyMcTest' do
- context 'errors raised' do
+RSpec.describe("TestyMcTest") do
+ context "errors raised" do
subject { Integer(nil) }
- it('can be tested') do
+ it("can be tested") do
# Where you used to have:
# expect { subject }.to raise_error(TypeError)
- block_is_expected.to raise_error(TypeError)
+ block_is_expected.to(raise_error(TypeError))
end
end
- context 'execution' do
+ context "execution" do
let(:mutex) { Mutex.new }
subject { mutex.lock }
- it('can change state') do
- expect(mutex.locked?).to eq(false)
+ it("can change state") do
+ expect(mutex.locked?).to(eq(false))
# Where you used to have:
# expect { subject }.to_not raise_error
- block_is_expected.to_not raise_error
- expect(mutex.locked?).to eq(true)
+ block_is_expected.to_not(raise_error)
+ expect(mutex.locked?).to(eq(true))
end
end
- context 'changed state' do
+ context "changed state" do
let(:mutex) { Mutex.new }
subject { mutex.lock }
- it('can be tested') do
+ it("can be tested") do
# Where you used to have:
# expect { subject }.to change { mutex.locked? }.from(false).to(true)
- block_is_expected.to change { mutex.locked? }.from(false).to(true)
+ block_is_expected.to(change { mutex.locked? }.from(false).to(true))
end
end
end
```
+## Switcch to `main` branch
+
+We recently migrated from `master` to `main` as the default branch. If this affected your local checkout:
+```shell
+git branch -m master main
+git fetch origin
+git branch -u origin/main main
+git remote set-head origin -a
+```
+
## 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](https://rubygems.org).
## Authors
-[Peter H. Boling][peterboling] of [Rails Bling][railsbling] is the author.
+* [Peter H. Boling][peterboling] of [Rails Bling][railsbling] is the author.
-## Contributors
+## Contributing
-See the [Network View](https://github.com/pboling/rspec-block_is_expected/network) and the [CHANGELOG](https://github.com/pboling/rspec-block_is_expected/blob/master/CHANGELOG.md)
+See [CONTRIBUTING.md][contributing].
+[contributing]: https://gitlab.com/pboling/rspec-block_is_expected/-/blob/main/CONTRIBUTING.md
## Contributing
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-6. Create new Pull Request
+See [CONTRIBUTING.md][contributing].
+[contributing]: https://gitlab.com/pboling/rspec-stubbed_env/-/blob/main/CONTRIBUTING.md
-Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/anonymous_active_record. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
## Code of Conduct
-Everyone interacting in the AnonymousActiveRecord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pboling/anonymous_active_record/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the AnonymousActiveRecord project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct][conduct].
## Versioning
This library aims to adhere to [Semantic Versioning 2.0.0][semver].
Violations of this scheme should be reported as bugs. Specifically,
@@ -188,31 +200,41 @@
As a result of this policy, you can (and should) specify a
dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision.
For example in a `Gemfile`:
- gem 'rspec-block_is_expected', '~> 1.0', group: :test
+ gem 'rspec-block_is_expected', '~> 1.0', group: [:development, :test]
or in a `gemspec`
spec.add_development_dependency 'rspec-block_is_expected', '~> 1.0'
## Legal
-* MIT License - See [LICENSE][license] file in this project [](https://opensource.org/licenses/MIT)
+* Copyright © 2018, 2020, 2023 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
-* Copyright (c) 2018, 2020, 2023 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
+[](https://opensource.org/licenses/MIT)
-[semver]: http://semver.org/
-[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[aboutme]: https://about.me/peter.boling
+[angellist]: https://angel.co/peter-boling
+[blogpage]: http://www.railsbling.com/tags/rspec-block_is_expected/
+[cc-cov]: https://codeclimate.com/github/pboling/rspec-block_is_expected/test_coverage
+[cc-covi]: https://api.codeclimate.com/v1/badges/ca0a12604ecc19f5e76d/test_coverage
+[conduct]: CODE_OF_CONDUCT.md
+[contributing]: CONTRIBUTING.md
+[depfu]: https://depfu.com/github/pboling/rspec-block_is_expected?project_id=5614
+[depfu-img]: https://badges.depfu.com/badges/272ce0df3bc6df5cbea9354e2c3b65af/count.svg
+[devto]: https://dev.to/galtzo
[documentation]: http://rdoc.info/github/pboling/rspec-block_is_expected/frames
+[followme]: https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow
[homepage]: https://github.com/pboling/rspec-block_is_expected
-[blogpage]: http://www.railsbling.com/tags/rspec-block_is_expected/
-[license]: LICENSE
-[railsbling]: http://www.railsbling.com
+[license]: LICENSE.txt
[peterboling]: https://about.me/peter.boling
-[refugees]: https://www.crowdrise.com/helprefugeeswithhopefortomorrowliberia/fundraiser/peterboling
-[gplus]: https://plus.google.com/+PeterBoling/posts
-[topcoder]: https://www.topcoder.com/members/pboling/
-[angellist]: https://angel.co/peter-boling
-[coderwall]: http://coderwall.com/pboling
+[pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
+[railsbling]: http://www.railsbling.com
+[semver]: http://semver.org/
[twitter]: http://twitter.com/galtzo
+[🧊berg]: https://codeberg.org/pboling
+[🛖hut]: https://sr.ht/~galtzo/
+[🧪lab]: https://gitlab.com/pboling
+[⛳liberapay]: https://liberapay.com/pboling/donate
+[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay