rspec-expect_to_make_changes 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bd5da54d4ca2fcb7f6a69d1a012bf919fc758195f42ce0bc1ef8c444e16f4925
+  data.tar.gz: 0c4f8c24bdae746382847c209b3016e79cc0b0f291eb67ae5fdde4b0150c8682
+SHA512:
+  metadata.gz: eb980db8d9d35ae30be288a4ab686c12f9755d1883853236ef810f93dbc89a45cdb85be97a8b1622d3cc8f4268751145ca7343e4376739616ea775ed5c30692b
+  data.tar.gz: ca024259d1e22c325103cb633cc73c3f60108c64fb1a4b919e524865f26b2d1b64ca47744074a88ebe7968749e756f3c397fc7dde153526fa551d25e4a9f37d3

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rspec-expect_to_make_changes.gemspec
+gemspec

data/License

@@ -0,0 +1,18 @@
+Copyright (c) 2020 Tyler Rick and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,213 @@
+# RSpec `expect {…}.to make_changes(…)`
+
+This small library makes it easy to test that a block makes a number of changes, without requiring
+you to deeply nest a bunch of `expect { }` blocks within each other or rewrite them as `change`
+matchers.
+
+Sure, you could just write add a list of regular RSpec expectations about how the state should be
+_before_ your action, and another list of expectations about how the state should be _after_ your
+action, and call that a "test for how your action changes the state".
+
+```ruby
+  expect(thing.a).to eq 1
+  expect(thing.b).to eq 2
+  expect(thing.c).to eq 3
+  perform_change
+  expect(thing.c).to eq 9
+  expect(thing.b).to eq -2
+  expect(thing.a).to eq 0
+```
+
+But often your expectations occur in _pairs_: a "before" and an "after": one for the state of
+something _before_ the action and a matching expectation for the state of the same thing _after_
+the action.
+
+As the number of pairs grows, it can be quite hard for the reader of your test to see which
+expectations are related, and how. It can also be hard for the writer of the test to maintain, esp.
+if they are relying on things like the order and proximity of the expectations alone to indicate a
+connection between related before/after expectations.
+
+The `make_changes` (and `before_and_after`) matchers provided by this library give you a tool to
+make it explicit and _extremely_ clear that those 2 expectations are a pair that are very tightly
+related.
+
+So instead of the above, you can rewrite it as explicit pairs like this:
+
+```ruby
+  expect {
+    perform_change
+  }.to make_changes([
+    ->{ expect(thing.a).to eq 1 },
+    ->{ expect(thing.a).to eq 0 },
+  ], [
+    ->{ expect(thing.b).to eq 2 },
+    ->{ expect(thing.b).to eq -2 },
+  ], [
+    ->{ expect(thing.c).to eq 9 },
+    ->{ expect(thing.c).to eq 9 },
+  ])
+```
+
+or, using `change` matchers, like this:
+
+```ruby
+  expect {
+    perform_change
+  }.to make_changes(
+    change { thing.a }.from(1).to(0),
+    change { thing.b }.from(2).to(-2),
+    change { thing.c }.from(3).to(9),
+  )
+```
+
+(or any combination of `[before_proc, after_proc]` arrays and `change` matchers)
+
+RSpec already provides a built-in matcher for expressing changes expected as a result of executing a
+block. And it works great for specifying single changes. You can even use it for specifying multiple
+changes:
+
+```ruby
+  expect {
+    expect {
+      expect {
+        perform_change
+      }.to change { thing.a }.from(1).to(0)
+    }.to change { thing.b }.from(2).to(-2)
+  }.to change { thing.c }.from(3).to(9)
+```
+
+Granted, that makes it _much_ clearer at a quick glance what changes are expected by your action.
+But it also has some drawbacks:
+
+1. You have to completely rewrite your expectations — which may have started out (as in our example)
+   as good old plain `expect(something).to eq something` expectations — into a _very_ different
+   `change()` matcher style.
+2. You end up with extra nesting, which can make your tests look a bit unwieldy and harder to read
+   than it needs to be.
+
+RSpec provides a pretty good solution to the nesting problem via its compound (`and`/`&`) matchers
+that let you combine several matchers together and treat them as one, so you can actually simplify
+that to just a single event block using just built-in RSpec:
+```ruby
+  expect {
+    perform_change
+  }.to (
+    change { thing.a }.from(1).to(0) &
+    change { thing.b }.from(2).to(-2) &
+    change { thing.c }.from(3).to(9)
+  )
+```
+
+`change` is often all you need for changes to primitive values. But it isn't always enough for
+doing more complex before/after checks. And it's not always convenient to rewrite existing
+expectations to a different (`change`) syntax.
+
+`make_changes` gives you the flexibility to either leave your before/after expectations as "regular"
+`expect`s or use the `change()` matcher style of expecting changes.
+
+This flexibility gives you the power and flexibility to lets you express some things that you simply
+couldn't express if you were limited to only the `change` matcher, such as things that you would
+normally use another specialized matcher for, such as expectations on arrays or hashes:
+
+```ruby
+  expect {
+    perform_change
+  }.to make_changes([
+    ->{ expect_too_close_to_pedestrians(car) },
+    ->{ expect_sufficient_proximity_from_pedestrians(car) },
+  ], [
+    ->{ expect(instance.tags).to match_array [:old_tag] },
+    ->{ expect(instance.tags).to match_array [:new_tag] },
+  ], [
+    ->{
+      expect(team.members).to     include user_1
+      expect(team.members).to_not include user_2
+    },
+    ->{ expect(team.members).to include user_1, user_2 },
+  ])
+```
+
+Although you _can_ define aliases and negated matchers to do things like this:
+
+```ruby
+RSpec::Matchers.alias_matcher          :an_array_including, :include
+RSpec::Matchers.define_negated_matcher :an_array_excluding, :include
+
+      array = ['food', 'water']
+      expect { array << 'spinach' }.to change { array }
+        .from( an_array_excluding('spinach') )
+        .to(   an_array_including('spinach') )
+```
+
+, it may not _always_ be possible, and requires you to define the needed matchers. Whereas
+`make_changes` allows you to simply use the "regular" matchers that you already know and love:
+
+```ruby
+    array = ['food', 'water']
+    expect { array << 'spinach' }.to make_changes([
+      ->{ expect(array).not_to include 'spinach' },
+      ->{ expect(array).to     include 'spinach' },
+    ])
+```
+
+It can sometimes be more readable or maintainable if you can just use/reuse regular expectations for
+your before/after checks.
+
+You might not even be checking for a change. You might simply want to assert that some invariant
+still holds both before _and_ after your action is performed.
+
+```ruby
+  expect {
+    perform_change
+  }.to check_all_before_and_after([
+    ->{ expect(car).to_not be_too_close },
+    ->{ expect(car).to_not be_too_close },
+  ])
+```
+
+That would be difficult or impossible to express using `change` matchers, since it's not a change.
+
+
+## `before_and_after` matcher
+
+In the examples above, if you pass an array to `make_changes` as one of the "expected changes", it
+actually converts that to a `before_and_after` matcher, and then `and`s together all of the
+"expected changes" into a single `Compound::And` matcher.
+
+If you wanted to, you can also use `before_and_after` directly, like:
+
+```ruby
+    expect { @instance.some_value = 6 }.to before_and_after(
+      -> { expect(@instance.some_value).to eq 5 },
+      -> { expect(@instance.some_value).to eq 6 }
+    )
+```
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-make_changes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-make_changes
+
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TylerRick/rspec-make_changes.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/expect_to_make_changes"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/expect_to_make_changes.rb

@@ -0,0 +1,10 @@
+require 'rspec/expect_to_make_changes/version'
+require 'rspec/matchers/make_changes'
+require 'rspec/matchers/before_and_after'
+
+module Rspec
+  module ExpectToMakeChanges
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/rspec/expect_to_make_changes/version.rb

@@ -0,0 +1,7 @@
+module Rspec
+  module ExpectToMakeChanges
+    def self.version
+      "0.1.1"
+    end
+  end
+end

data/lib/rspec/matchers/before_and_after.rb

@@ -0,0 +1,64 @@
+require 'rspec/matchers'
+
+module RSpec::Matchers
+  # Applied to a proc, specifies that its execution will cause some value to
+  # change.
+  #
+  # Allows you to run a pair of related checks — one before the change and one after the change.
+  # The checks can be any arbitrary RSpec expectations.
+  #
+  # @param [Proc] before_proc The expectation to check before making the change.
+  # @param [Proc] after_proc The expectation to check after making the change.
+  def before_and_after(before_proc, after_proc)
+    BeforeAndAfter.new(before_proc, after_proc)
+  end
+end
+RSpec::Matchers.alias_matcher :expect_before_and_after, :before_and_after
+RSpec::Matchers.alias_matcher :check_before_and_after,  :before_and_after
+
+# Modeled after RSpec::Matchers::BuiltIn::Change
+class BeforeAndAfter < RSpec::Matchers::BuiltIn::BaseMatcher
+  def initialize(before_proc, after_proc)
+    @before_proc = before_proc
+    @after_proc  = after_proc
+  end
+
+  def matches?(event_proc)
+    @event_proc = event_proc
+    perform_change(event_proc)
+  end
+
+  def supports_block_expectations?
+    true
+  end
+
+private
+
+  def perform_change(event_proc)
+    reraise_with_prefix 'before making the change:' do
+      @before_proc.call
+    end
+
+    return false unless Proc === event_proc
+    event_proc.call
+
+    reraise_with_prefix 'after making the change:' do
+      @after_proc.call
+    end
+    true
+  end
+
+  def reraise_with_prefix(prefix)
+    begin
+      yield
+    rescue RSpec::Expectations::ExpectationNotMetError
+      raise $!, "#{prefix}\n#{indent_multiline_message($!.message)}", $!.backtrace
+    end
+  end
+
+  def indent_multiline_message(message)
+    message.lines.map do |line|
+      line =~ /\S/ ? '   ' + line : line
+    end.join
+  end
+end

data/lib/rspec/matchers/fail_matchers.rb

@@ -0,0 +1,44 @@
+# Copied from rspec-expectations
+
+require 'rspec/expectations'
+
+module RSpec
+  module Matchers
+    # Matchers for testing RSpec matchers. Include them with:
+    #
+    #     require 'rspec/matchers/fail_matchers'
+    #     RSpec.configure do |config|
+    #       config.include RSpec::Matchers::FailMatchers
+    #     end
+    #
+    module FailMatchers
+      # Matches if an expectation fails
+      #
+      # @example
+      #   expect { some_expectation }.to fail
+      def fail(&block)
+        raise_error(RSpec::Expectations::ExpectationNotMetError, &block)
+      end
+
+      # Matches if an expectation fails with the provided message
+      #
+      # @example
+      #   expect { some_expectation }.to fail_with("some failure message")
+      #   expect { some_expectation }.to fail_with(/some failure message/)
+      def fail_with(message)
+        raise_error(RSpec::Expectations::ExpectationNotMetError, message)
+      end
+
+      # Matches if an expectation fails including the provided message
+      #
+      # @example
+      #   expect { some_expectation }.to fail_including("portion of some failure message")
+      def fail_including(*snippets)
+        raise_error(
+          RSpec::Expectations::ExpectationNotMetError,
+          a_string_including(*snippets)
+        )
+      end
+    end
+  end
+end

data/lib/rspec/matchers/make_changes.rb

@@ -0,0 +1,52 @@
+require 'rspec/matchers'
+require 'rspec/matchers/before_and_after'
+
+RSpec::Matchers.define :make_changes do |*expected_changes|
+  match(notify_expectation_failures: true) do |change_proc|
+    expected_changes.map! do |expected_change|
+      if Array === expected_change
+        before_and_after(*expected_change)
+      else
+        expected_change
+      end
+    end
+
+    compound = expected_changes.inject do |compound, expected_change|
+      compound & expected_change
+    end
+
+    # TODO: aggregate_failures do
+    expect(&change_proc).to compound
+    #end
+  end
+
+  failure_message do |subject|
+    " expected block to make changes:\n" +
+    " but it did not."
+  end
+
+  def description
+    super.sub(/\Amake changes */, '')
+  end
+
+  supports_block_expectations
+end
+
+RSpec::Matchers.alias_matcher :change_all, :check_all_before_and_after
+RSpec::Matchers.alias_matcher :check_all, :check_all_before_and_after
+RSpec::Matchers.alias_matcher :check_all_before_and_after, :make_changes
+
+=begin
+Original version before converting to an RSpec matcher, for posterity:
+
+  def expect_changes(action_proc, *expected_changes)
+    expected_changes.each.with_index do |expected_change, i|
+      expected_change.size == 2 or raise "expected expected_changes[#{i}] to be an array of 2 procs but its size was #{expected_change.size}"
+      expected_change[0].()
+    end
+    action_proc.()
+    expected_changes.each.with_index do |expected_change, i|
+      expected_change[1].()
+    end
+  end
+=end

data/rspec-expect_to_make_changes.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rspec/expect_to_make_changes/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-expect_to_make_changes"
+  spec.version       = Rspec::ExpectToMakeChanges.version
+  spec.authors       = ["Tyler Rick"]
+  spec.email         = ["tyler@tylerrick.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{expect {…}.to make_changes(…)}
+  spec.description   = %q{Makes it easy to test that a block makes a number of changes, without requiring you to deeply nest a bunch of `expect { }` blocks within each other or rewrite them as `change` matchers.}
+  spec.homepage      = "https://github.com/TylerRick/rspec-expect_to_make_changes"
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.metadata["source_code_uri"]}/blob/master/Changelog.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec-expectations"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-support"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: rspec-expect_to_make_changes
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tyler Rick
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes it easy to test that a block makes a number of changes, without
+  requiring you to deeply nest a bunch of `expect { }` blocks within each other or
+  rewrite them as `change` matchers.
+email:
+- tyler@tylerrick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Changelog.md
+- Gemfile
+- License
+- Rakefile
+- Readme.md
+- bin/console
+- bin/setup
+- lib/rspec/expect_to_make_changes.rb
+- lib/rspec/expect_to_make_changes/version.rb
+- lib/rspec/matchers/before_and_after.rb
+- lib/rspec/matchers/fail_matchers.rb
+- lib/rspec/matchers/make_changes.rb
+- rspec-expect_to_make_changes.gemspec
+homepage: https://github.com/TylerRick/rspec-expect_to_make_changes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/TylerRick/rspec-expect_to_make_changes
+  source_code_uri: https://github.com/TylerRick/rspec-expect_to_make_changes
+  changelog_uri: https://github.com/TylerRick/rspec-expect_to_make_changes/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: expect {…}.to make_changes(…)
+test_files: []