rspec-block_is_expected 1.0.4 → 1.0.6

data/README.md

@@ -1,35 +1,138 @@
 # Rspec::BlockIsExpected
 
-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.
-
+<div id="badges">
+
+[![CI Build][🚎dl-cwfi]][🚎dl-cwf]
+[![Test Coverage][🔑cc-covi]][🔑cc-cov]
+[![Maintainability][🔑cc-mnti]][🔑cc-mnt]
+[![Depfu][🔑depfui]][🔑depfu]
+
+[🚎dl-cwf]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/current.yml
+[🚎dl-cwfi]: https://github.com/pboling/rspec-block_is_expected/actions/workflows/current.yml/badge.svg
+
+[comment]: <> ( 🔑 KEYED LINKS )
+
+[🔑cc-mnt]: https://codeclimate.com/github/pboling/rspec-block_is_expected/maintainability
+[🔑cc-mnti]: https://api.codeclimate.com/v1/badges/ca0a12604ecc19f5e76d/maintainability
+[🔑cc-cov]: https://codeclimate.com/github/pboling/rspec-block_is_expected/test_coverage
+[🔑cc-covi]: https://api.codeclimate.com/v1/badges/ca0a12604ecc19f5e76d/test_coverage
+[🔑depfu]: https://depfu.com/github/pboling/rspec-block_is_expected?project_id=5865
+[🔑depfui]: https://badges.depfu.com/badges/79867e590f063376f40b031a1447c215/count.svg
+
+-----
+
+[![Liberapay Patrons][⛳liberapay-img]][⛳liberapay]
+[![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor]
+
+<span class="badge-buymeacoffee">
+<a href="https://ko-fi.com/O5O86SNP4" target='_blank' title="Donate to my FLOSS or refugee efforts at ko-fi.com"><img src="https://img.shields.io/badge/buy%20me%20coffee-donate-yellow.svg" alt="Buy me coffee donation button" /></a>
+</span>
+<span class="badge-patreon">
+<a href="https://patreon.com/galtzo" title="Donate to my FLOSS or refugee efforts using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a>
+</span>
+
+</div>
+
+[⛳liberapay-img]: https://img.shields.io/liberapay/patrons/pboling.svg?logo=liberapay
+[⛳liberapay]: https://liberapay.com/pboling/donate
+[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
+[🖇sponsor]: https://github.com/sponsors/pboling
+
+This gem does ~~five~~, _three sir_, five things.
+
+1. Provides `block_is_expected` to set expectations on the result of running the `subject` as a block.
+2. Provides, via shared example groups, shortcut RSpec macros for setting an expectation on errors being raised (or not).
+    ```ruby
+    it_behaves_like "block_is_expected to not raise"
+    it_behaves_like "block_is_expected to raise error", RuntimeError
+    ```
+3. Provides RSpec negated matchers that can be used with `block_is_expected`:
+    ```ruby
+    not_change
+    not_raise_error
+    ```
+    And two others that are so generally useful I end up defining them on every project:
+    ```ruby
+    not_include
+    not_eq
+    ```
+
+## Just show me the money
+
+First, configure in your rspec helper, or similar:
 ```ruby
-subject { Integer(nil) }
-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                 |  [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) |
-| download rank           |  [![Downloads Today](https://img.shields.io/gem/rd/rspec-block_is_expected.svg)](https://github.com/pboling/rspec-block_is_expected) |
-| version                 |  [![Version](https://img.shields.io/gem/v/rspec-block_is_expected.svg)](https://rubygems.org/gems/rspec-block_is_expected) |
-| dependencies            |  [![Depfu](https://badges.depfu.com/badges/272ce0df3bc6df5cbea9354e2c3b65af/count.svg)](https://depfu.com/github/pboling/rspec-block_is_expected?project_id=5614) |
-| continuous integration  |  [![Build Status](https://travis-ci.org/pboling/rspec-block_is_expected.svg?branch=master)](https://travis-ci.org/pboling/rspec-block_is_expected) |
-| test coverage           |  [![Test Coverage](https://api.codeclimate.com/v1/badges/ca0a12604ecc19f5e76d/test_coverage)](https://codeclimate.com/github/pboling/rspec-block_is_expected/test_coverage) |
-| maintainability         |  [![Maintainability](https://api.codeclimate.com/v1/badges/ca0a12604ecc19f5e76d/maintainability)](https://codeclimate.com/github/pboling/rspec-block_is_expected/maintainability) |
-| code triage             |  [![Open Source Helpers](https://www.codetriage.com/pboling/rspec-block_is_expected/badges/users.svg)](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), [![Tweet Peter](https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow)](http://twitter.com/galtzo)|
-
-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/).
+require "rspec/block_is_expected"
+```
+
+Then,
+
+1. Custom expectation on result of subject as block
+    ```ruby
+    subject { Integer("1") }
+    it("raises") { block_is_expected.to(not_raise_error) }
+    ```
+2. Subject will not raise an exception
+    ```ruby
+    subject { Integer("1") }
+    it_behaves_like "block_is_expected to not raise"
+    ```
+3. Subject will raise an exception
+    ```ruby
+    subject { Integer(nil) }
+    it_behaves_like "block_is_expected to raise error", TypeError
+    ```
+
+| Project                        | `bundle add rspec-block_is_expected --group test`                                                                                                                                                                                            |
+|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| name, license, docs, standards | [![RubyGems.org][⛳️name-img]][⛳️gem] [![License: MIT][🖇src-license-img]][🖇src-license] [![RubyDoc.info][🚎yard-img]][🚎yard] [![SemVer 2.0.0][🧮semver-img]][🧮semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] |
+| version & activity             | [![Gem Version][⛳️version-img]][⛳️gem] [![Total Downloads][🖇DL-total-img]][⛳️gem] [![Download Rank][🏘DL-rank-img]][⛳️gem]                                                                                                                  |
+| dependencies                   | [![Depfu][🔑depfui]][🔑depfu]                                                                                                                                                                                                                |
+| continuous integration         | [![CI Build][🚎dl-cwfi]][🚎dl-cwf] [![Heads][🖐hwfi]][🖐hwf] [![Style][🧮swfi]][🧮swf]                                                                                                                                                       |
+| test coverage                  | [![Test Coverage][🔑cc-covi]][🔑cc-cov]                                                                                                                                                                                                      |
+| maintainability                | [![Maintainability](https://api.codeclimate.com/v1/badges/ca0a12604ecc19f5e76d/maintainability)](https://codeclimate.com/github/pboling/rspec-block_is_expected/maintainability)                                                             |
+| code triage                    | [![Open Source Helpers](https://www.codetriage.com/pboling/rspec-block_is_expected/badges/users.svg)](https://www.codetriage.com/pboling/rspec-block_is_expected)                                                                            |
+| homepage                       | [on Github.com][homepage], [on Railsbling.com][blogpage]                                                                                                                                                                                     |
+| documentation                  | [on RDoc.info][documentation]                                                                                                                                                                                                                |
+| `...` 💖                       | [![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay], [🧊][🧊berg], [🛖][🛖hut], [🧪][🧪lab], [🌏][aboutme], [👼][angellist], [⚗️][devto], [![Tweet @galtzo][followme]][twitter]                                                         |
+
+<!--
+The link tokens in the following sections should be kept ordered by the row and badge numbering scheme
+-->
+
+<!-- 1️⃣ name, license, docs -->
+[⛳️gem]: https://rubygems.org/gems/rspec-block_is_expected
+[⛳️name-img]: https://img.shields.io/badge/name-rspec--block__is__expected-brightgreen.svg?style=flat
+[🖇src-license]: https://opensource.org/licenses/MIT
+[🖇src-license-img]: https://img.shields.io/badge/License-MIT-green.svg
+[🚎yard]: https://www.rubydoc.info/gems/rspec-block_is_expected
+[🚎yard-img]: https://img.shields.io/badge/documentation-rubydoc-brightgreen.svg?style=flat
+[🧮semver]: http://semver.org/
+[🧮semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
+[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
+[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
+
+<!-- 2️⃣ version & activity -->
+[⛳️version-img]: http://img.shields.io/gem/v/rspec-block_is_expected.svg
+[🖇DL-total-img]: https://img.shields.io/gem/dt/rspec-block_is_expected.svg
+[🏘DL-rank-img]: https://img.shields.io/gem/rt/rspec-block_is_expected.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/).
+
+## Ruby Compatibility
+Supports the same versions of Ruby that RSpec does, 1.8.7 - current ruby-head,
+as well as the JRuby equivalents.
 
 ## 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:
@@ -46,7 +149,7 @@ There is no configuration needed if you your test suite loads the bundle group (
 
 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
@@ -56,15 +159,15 @@ 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
@@ -72,28 +175,28 @@ RSpec::Matchers.define_negated_matcher :not_raise_error, :raise_error
 You have a module like this:
 
 ```ruby
-module MyTasks
-  def my_rakelib
-    Rake.add_rakelib('bananas')
-  end
-  module_function :my_rakelib
-end
+    module MyTasks
+      def my_rakelib
+        Rake.add_rakelib("bananas")
+      end
+      module_function :my_rakelib
+    end
 ```
 
 You have a spec like this:
 
 ```ruby
-require 'rake'
-
-RSpec.describe(MyTasks) 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])
+    require "rake"
+
+    RSpec.describe(MyTasks) 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]))
+        end
+      end
     end
-  end
-end
 ```
 
 ### Integration with RuboCop
@@ -115,36 +218,46 @@ inherit_gem:
 The spec suite for this gem has some examples of usage, lightly edited here.
 
 ```ruby
-RSpec.describe 'TestyMcTest' do
-  context 'errors raised' do
-    subject { Integer(nil) }
-    it('can be tested') do
-      # Where you used to have:
-      # expect { subject }.to raise_error(TypeError)
-      block_is_expected.to raise_error(TypeError)
-    end
-  end
-  context 'execution' do
-    let(:mutex) { Mutex.new }
-    subject { mutex.lock }
-    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)
-    end
-  end
-  context 'changed state' do
-    let(:mutex) { Mutex.new }
-    subject { mutex.lock }
-    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)
+    RSpec.describe("TestyMcTest") do
+      context "errors raised" do
+        subject { Integer(nil) }
+        it("can be tested") do
+          # Where you used to have:
+          # expect { subject }.to raise_error(TypeError)
+          block_is_expected.to(raise_error(TypeError))
+        end
+      end
+      context "execution" do
+        let(:mutex) { Mutex.new }
+        subject { mutex.lock }
+        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))
+        end
+      end
+      context "changed state" do
+        let(:mutex) { Mutex.new }
+        subject { mutex.lock }
+        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))
+        end
+      end
     end
-  end
-end
+```
+
+## Switch 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
@@ -155,26 +268,40 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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
+
+### Running Specs
+
+The basic compatibility matrix:
+```sh
+appraisal install
+appraisal rake test
+```
+
+Sometimes also:
+```sh
+BUNDLE_GEMFILE=gemfiles/vanilla.gemfile appraisal update
+```
+
+NOTE: This results in bad paths to the gemspec.
+`gemspec path: "../../"` needs to be replaced with `gemspec :path => "../"` in each Appraisal gemfile.
 
-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.
+Except, is unlikely to be possible to install all of the supported Rubies & Railsies in a single container...
+See the various github action workflows for more inspiration on running certain oldies.
 
 ## 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
 
@@ -190,29 +317,39 @@ dependency on this gem using the [Pessimistic Version Constraint][pvc] with two
 
 For example in a `Gemfile`:
 
-    gem 'rspec-block_is_expected', '~> 1.0', group: :test
+```ruby
+gem "rspec-block_is_expected", "~> 1.0", :group => [:development, :test]
+```
 
 or in a `gemspec`
 
-    spec.add_development_dependency 'rspec-block_is_expected', '~> 1.0'
+```ruby
+spec.add_development_dependency("rspec-block_is_expected", "~> 1.0")
+```
 
 ## Legal
 
-* MIT License - See [LICENSE][license] file in this project [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+* Copyright © 2018, 2020, 2023 - 2024 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
 
-* Copyright (c) 2018, 2020, 2023 [Peter H. Boling][peterboling] of [Rails Bling][railsbling]
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](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/
+[conduct]: CODE_OF_CONDUCT.md
+[contributing]: CONTRIBUTING.md
+[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

data/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+| Version  | Supported |
+|----------|-----------|
+| 1.latest | ✅         |
+
+## Reporting a Vulnerability
+
+Peter Boling is the primary maintainer of this gem. Please find a way
+to [contact him directly](https://railsbling.com/contact) to report the issue. Include as much relevant information as
+possible.

data/lib/rspec/block_is_expected/matchers/not.rb

@@ -1,4 +1,4 @@
-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)

data/lib/rspec/block_is_expected/rspec.rb

@@ -1,8 +1,8 @@
-require 'rspec/core'
-begin
-  RSpec.configure do |c|
-    c.include Rspec::BlockIsExpected
-  end
-rescue NameError
-  # Rspec really should be loaded by now...
+require "rspec/core"
+require "rspec/block_is_expected/matchers/not"
+
+RSpec.configure do |c|
+  c.include(Rspec::BlockIsExpected)
 end
+require "rspec/block_is_expected/shared_examples/block_does_not_raise_examples"
+require "rspec/block_is_expected/shared_examples/block_raises_error_examples"

data/lib/rspec/block_is_expected/shared_examples/block_does_not_raise_examples.rb

@@ -0,0 +1,5 @@
+RSpec.shared_examples_for("block_is_expected to not raise") do
+  it "does not raise error" do
+    block_is_expected.not_to(raise_error)
+  end
+end

data/lib/rspec/block_is_expected/shared_examples/block_raises_error_examples.rb

@@ -0,0 +1,5 @@
+RSpec.shared_examples_for("block_is_expected to raise error") do |*error_args|
+  it "raises error #{error_args.inspect}" do
+    block_is_expected.to(raise_error(*error_args))
+  end
+end

data/lib/rspec/block_is_expected/version.rb

@@ -1,5 +1,5 @@
 module Rspec
   module BlockIsExpected
-    VERSION = '1.0.4'.freeze
+    VERSION = "1.0.6".freeze
   end
 end

data/lib/rspec/block_is_expected.rb

@@ -1,5 +1,5 @@
-require 'rspec/block_is_expected/version'
-require 'rspec/block_is_expected/rspec'
+require "rspec/block_is_expected/version"
+require "rspec/block_is_expected/rspec"
 
 module Rspec
   # Namespace of this library