rspec-change_to_now 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91fa21b5de7d035ade4c3e75449d2aa869666083
-  data.tar.gz: 966af72e0e054cf7592dc580530b90c36a4974c2
+  metadata.gz: f8e18de5f1c633f028730dd7600213ac9aa54f21
+  data.tar.gz: 169e4f56eb8ace773989ca34e3a6bd101fd3b5bf
 SHA512:
-  metadata.gz: 2fbd80b7b3881e4368adc39d4fdbf2d60e72457ac2406b9d05e8b0db2739a55bf06ffad3cd31275e8f2e5b759db32535ac265c4a908396c520ed7f8e794a8b8a
-  data.tar.gz: 39d7852e10fa38a23c0ae6c6e9bc0aeef36ddd91582518071a77b1dce5575188a3bab82ff8cc651c523e544e6436dab4be3aed4e290f8f470029d5fd97dff148
+  metadata.gz: 9d2aa3673096f3e9c1d5df8ecf08f1e27aa9661265be953b56d12eedbd1d154235166ec55c1c9acef28fa302c37ef5b36ef419d82cd2814113a0dade8d3eaac3
+  data.tar.gz: f3da15d21ad66436057d4aa174546a8450d68825c9d0b145770c99b3ba8226138c2fdff3abe33d986a50be11f3216bdd7c359b4352d4d605fbe820512e5026be

data/Changelog.md

@@ -1,3 +1,8 @@
+### 1.1.0
+
+* Add `with_final_result` matcher that doesn't do precondition test
+* Correctly support `to_now` alongside `from` 
+
 ### 1.0.3
 
 Refer to 'detect' instead of 'include' in messages for detect matcher. 

data/README.md

@@ -23,6 +23,39 @@ Also supported are aliases for those who don't want to split their infinitives a
 * `to_now` can also be called as `now_to`
 * `not_to_now` can also be called `not_to`, `to_not`, `to_not_now` and `not_now_to` 
 
+## Overriding default RSpec behavior
+
+You can force the rspec `change` matcher to always use `to_now` instead of `to` by setting:
+
+```ruby
+RSpec::Matchers::ChangeToNow.override_to = true
+```
+
+
+## Testing without preconditions
+
+There are a couple of ways to prevent precondition checks if you don't want them for a particular expectation:
+
+1. Use `with_final_result` instead of `to_now` to check your results.  e.g.
+
+    ```ruby
+    it "initializes an empty list" do
+      list = nil
+      expect { list = [] }.with_final_result satisfy(&:empty)  
+    end
+    ```
+
+1. Explicitly specify a `from` value or matcher, either before or after your `to_now` statement:
+
+    ```ruby
+    it "initializes an empty list" do
+      list = nil
+      expect { list = [] }.from(nil).to_now satisfy(&:empty)
+      list = nil
+      expect { list = [] }.to_now satisfy(&:empty).from(nil)  
+    end
+    ```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/features/change_to_now.feature

@@ -14,16 +14,47 @@ Feature: expecting a matcher to change
     When I run rspec
     Then the examples should all pass
 
- Scenario: failures are correctly reported
+  Scenario: the result of a change block can be tested with `with_final_result` without invoking the precondition test
+    Given a file named "example_spec.rb" with:
+      """ruby
+
+        describe "creating a list" do
+          it "creates an empty list" do
+            list = nil
+            expect { list = [] }.to change { list }.with_final_result satisfy(&:empty?)
+          end
+        end
+      """
+    When I run rspec
+    Then the examples should all pass
+
+ Scenario: precondition failures are correctly reported
     Given a file named "example_spec.rb" with:
       """ruby
 
         describe "adding one" do
           it "adds one" do
-            x = 1
-            expect { x += 1 }.to change { x }.to_now eq 3
+            x = 2
+            expect { x += 1 }.to change { x }.to_now eq 2
+          end
+        end
+      """
+    When I run rspec
+    Then the output should contain "Failure/Error: expect { x += 1 }.to change { x }.to_now eq 2"
+    And the output should contain "expected result to have initially been ~(eq 2), but was 2"
+
+  Scenario: overriding RSpec `change { }.to` to behave like `change { }.to_now`
+    Given a file named "example_spec.rb" with:
+      """ruby
+        RSpec::Matchers::ChangeToNow.override_to = true
+
+        describe "adding one" do
+          it "adds one" do
+            x = 2
+            expect { x += 1 }.to change { x }.to eq 2
           end
         end
       """
     When I run rspec
-    Then the output should contain "Failure/Error: expect { x += 1 }.to change { x }.to_now eq 3"
+    Then the output should contain "Failure/Error: expect { x += 1 }.to change { x }.to eq 2"
+    And the output should contain "expected result to have initially been ~(eq 2), but was 2"

data/features/detect.feature

@@ -25,4 +25,4 @@ Feature: detect matcher
       """
     When I run rspec
     Then the output should contain "Failure/Error: expect([1]).to detect(&:even?)"
-      And the output should contain "expected [1] to include (satisfy block)"
+      And the output should contain "expected [1] to detect (satisfy block)"

data/lib/rspec/change_to_now/verify_argument_is_matcher.rb

@@ -0,0 +1,21 @@
+require 'rspec/core'
+require 'rspec/expectations'
+
+module RSpec
+  module Matchers
+    # Decorator that wraps a matcher and raises an error if the matcher is not a matcher.
+    #
+    # @api private
+    class VerifyArgumentIsMatcher < MatcherDelegator
+      # Forward messages on to the wrapped matcher, first verifying that this really is a matcher.
+      def method_missing(method, *args)
+        raise SyntaxError, "expects a matcher as an argument but got: #{base_matcher.inspect}" unless Matchers.is_a_matcher?(base_matcher)
+        base_matcher.send(method, *args)
+      end
+
+      def description(*args)
+        base_matcher.description(*args)
+      end
+    end
+  end
+end

data/lib/rspec/change_to_now/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module ChangeToNow
-    VERSION = "1.0.3"
+    VERSION = "1.1.0"
   end
 end

data/lib/rspec/change_to_now.rb

@@ -1,11 +1,28 @@
 require 'rspec/change_to_now/version'
 require 'rspec/change_to_now/detect'
 require 'rspec/change_to_now/negate'
+require 'rspec/change_to_now/verify_argument_is_matcher'
 require 'rspec/core'
 require 'rspec/expectations'
 
 module RSpec::Matchers
+  module ChangeToNowMatchers
+    private
+
+    # @private
+    def negate(matcher)
+      RSpec::Matchers::Negate.new(matcher)
+    end
+
+    # @private
+    def verify_argument_is_matcher(matcher)
+      RSpec::Matchers::VerifyArgumentIsMatcher.new(matcher)
+    end
+  end
+
   class BuiltIn::Change
+    include ChangeToNowMatchers
+
     # @api public
     # Passes if +matcher+ fails on the result of the change block before the expectation block and passes after.
     #
@@ -18,7 +35,8 @@ module RSpec::Matchers
     #   change {}.to_now eq(1)
     #   change {}.from(negate(eq(1))).to(eq(1))
     def to_now(matcher)
-      RSpec::Matchers::BuiltIn::ChangeToValue.new(@change_details, matcher).from(negate(matcher))
+      RSpec::Matchers::BuiltIn::ChangeToValue.new(@change_details, verify_argument_is_matcher(matcher)).
+        from(negate(verify_argument_is_matcher(matcher)))
     end
 
     # @api public
@@ -27,7 +45,8 @@ module RSpec::Matchers
     # @example
     #   expect({ @x = 1 }.to change { @x }.not_to_now eq 1
     def not_to_now(matcher)
-      RSpec::Matchers::BuiltIn::ChangeToValue.new(@change_details, negate(matcher)).from(matcher)
+      RSpec::Matchers::BuiltIn::ChangeToValue.new(@change_details, negate(verify_argument_is_matcher(matcher))).
+        from(verify_argument_is_matcher(matcher))
     end
 
     # @api public
@@ -45,11 +64,52 @@ module RSpec::Matchers
     # @api public
     alias_method :to_not_now, :not_to_now
 
-    private
+    # @private
+    alias_method :to_without_to_now, :to
 
     # @private
-    def negate(matcher)
-      RSpec::Matchers::Negate.new(matcher)
+    def to_with_to_now(expected)
+      if RSpec::Matchers::ChangeToNow.override_to && RSpec::Matchers.is_a_matcher?(expected)
+        to_now(expected)
+      else
+        to_without_to_now(expected)
+      end
+    end
+
+    # @private
+    alias_method :to, :to_with_to_now
+
+    # @api public
+    def with_final_result(expected)
+      to_without_to_now(expected)
+    end
+  end
+
+  class BuiltIn::ChangeFromValue
+    include ChangeToNowMatchers
+
+    def to_now(matcher)
+      RSpec::Matchers::BuiltIn::ChangeToValue.new(
+        @change_details,
+        verify_argument_is_matcher(matcher)
+      ).from(@expected_before)
+    end
+
+    def not_to_now(matcher)
+      RSpec::Matchers::BuiltIn::ChangeToValue.new(
+        @change_details,
+        negate(verify_argument_is_matcher(matcher))
+      ).from(@expected_before)
+    end
+
+    def with_final_result(expected)
+      to_without_to_now(expected)
+    end
+  end
+
+  class ChangeToNow
+    class << self
+      attr_accessor :override_to
     end
   end
 end

data/spec/rspec/change_to_now_spec.rb

@@ -37,27 +37,71 @@ module RSpec
           }.to change { number }.to_now eq 2
         }.to fail_matching("expected result to have initially been ~(eq 2), but was 2")
       end
+      it "raises an error when not passed a matcher" do
+        number = 1
+        expect {
+          expect {
+            number += 1
+          }.to change { }.to_now 2
+        }.to raise_error SyntaxError, /expects a matcher as an argument/
+      end
+
+      describe "after #from" do
+        it "passes without running the default inverse precondition check" do
+          list = nil
+          expect {
+            list = []
+          }.to change { list }.from(nil).to_now satisfy(&:empty?)
+        end
+
+        it "fails if the initial condition does not match" do
+          expect {
+            list = nil
+            expect {
+              list = []
+            }.to change { list }.from(1).to_now satisfy(&:empty?)
+          }.to fail_matching("expected result to have initially been 1, but was nil")
+        end
+      end
+
+      describe "before #from" do
+        it "passes without running the default inverse precondition check" do
+          list = nil
+          expect {
+            list = []
+          }.to change { list }.to_now(satisfy(&:empty?)).from(nil)
+        end
+
+        it "fails if the initial condition does not match" do
+          expect {
+            list = nil
+            expect {
+              list = []
+            }.to change { list }.to_now(satisfy(&:empty?)).from(1)
+          }.to fail_matching("expected result to have initially been 1, but was nil")
+        end
+      end
     end
 
-    describe "#not_to" do
+    describe "#not_to_now" do
       it "succeeds when the final expectation is met" do
         number = 1
         expect {
           number += 2
-        }.to change { number }.not_to eq 1
+        }.to change { number }.not_to_now eq 1
       end
       it "fails when there is no change" do
         number = 1
         expect {
           expect {
-          }.to change { number }.not_to eq 1
+          }.to change { number }.not_to_now eq 1
         }.to fail_matching("expected result to have changed to ~(eq 1) from eq 1, but did not change")
       end
       it "fails when the final expectation is already met" do
         number = 2
         expect {
           expect {
-          }.to change { number }.not_to eq 1
+          }.to change { number }.not_to_now eq 1
         }.to fail_matching("expected result to have initially been eq 1, but was 2")
       end
       it "fails when the final expectation is never met" do
@@ -65,9 +109,53 @@ module RSpec
         expect {
           expect {
             number = 4
-          }.to change { number }.not_to satisfy(&:even?)
+          }.to change { number }.not_to_now satisfy(&:even?)
         }.to fail_matching("expected result to have changed to ~(satisfy block), but is now 4")
       end
+      it "raises an error when not passed a matcher" do
+        number = 1
+        expect {
+          expect {
+            number += 1
+          }.to change { }.not_to_now 2
+        }.to raise_error SyntaxError, /expects a matcher as an argument/
+      end
+
+      describe "after #from" do
+        it "passes without running the default inverse precondition check" do
+          list = nil
+          expect {
+            list = [1]
+          }.to change { list }.from(nil).not_to_now satisfy(&:empty?)
+        end
+
+        it "fails if the initial condition does not match" do
+          expect {
+            list = nil
+            expect {
+              list = [1]
+            }.to change { list }.from(1).not_to_now satisfy(&:empty?)
+          }.to fail_matching("expected result to have initially been 1, but was nil")
+        end
+      end
+
+      describe "before #from" do
+        it "passes without running the default inverse precondition check" do
+          list = nil
+          expect {
+            list = [1]
+          }.to change { list }.not_to_now(satisfy(&:empty?)).from(nil)
+        end
+
+        it "fails if the initial condition does not match" do
+          expect {
+            list = nil
+            expect {
+              list = [1]
+            }.to change { list }.not_to_now(satisfy(&:empty?)).from(1)
+          }.to fail_matching("expected result to have initially been 1, but was nil")
+        end
+      end
     end
 
     describe "aliases" do
@@ -80,7 +168,7 @@ module RSpec
       end
 
       describe "negative cases" do
-        specify "#to_not is the same as #not_to" do
+        specify "#to_not is the same as #not_to_now" do
           expect { @x = 1 }.to change { @x }.to_not eq nil
         end
 
@@ -97,5 +185,109 @@ module RSpec
         end
       end
     end
+
+    describe "#with_final_result" do
+      before do
+        @x = nil
+      end
+
+      it "checks only the post condition not the precondition" do
+        expect { @x = [] }.to change { @x }.with_final_result satisfy(&:empty?)
+      end
+      describe "when passed an object" do
+        it "passes when the final object equals the result" do
+          expect { @x = 1 }.to change { @x }.with_final_result 1
+        end
+        it "fails when the final object does not equal the result" do
+          expect {
+            expect { @x = 1 }.to change { @x }.with_final_result 2
+          }.to fail_matching("expected result to have changed to 2, but is now 1")
+        end
+      end
+
+      it "behaves exactly like the original #to method" do
+        matcher = change { @x }
+        matcher_mock = double()
+        expect(matcher).to receive(:to_without_to_now).with(1).and_return(matcher_mock)
+        expect(matcher.with_final_result 1).to eq matcher_mock
+      end
+        
+      describe "after #from" do
+        it "behaves exactly like the original #to method" do
+          matcher = change { @x }.from 0
+          matcher_mock = double()
+          expect(matcher).to receive(:to_without_to_now).with(1).and_return(matcher_mock)
+          expect(matcher.with_final_result 1).to eq matcher_mock
+        end
+      end
+    end
+
+    describe "when #to has been overridden by the configuration setting" do
+      before do
+        allow(RSpec::Matchers::ChangeToNow).to receive(:override_to).and_return(true)
+      end
+
+      it "fails when the final expectation is already met" do
+        number = 2
+        expect {
+          expect {
+            number += 1
+          }.to change { number }.to eq 2
+        }.to fail_matching("expected result to have initially been ~(eq 2), but was 2")
+      end
+
+      it "still works with basic object matchers" do
+        number = 2
+        expect {
+          expect {
+            number += 1
+          }.to change { number }.to 2
+        }.to fail_matching("expected result to have changed to 2, but is now 3")
+      end
+
+      describe "if #from is specified first" do
+        let(:matcher) { change { @number }.from(1).to(eq 2) }
+
+        it "fails properly when the precondition is not met" do
+          @number = 2
+          expect {
+            expect {
+              @number += 1
+            }.to matcher
+          }.to fail_matching("expected result to have initially been 1, but was 2")
+        end
+
+        it "runs the change check if the precondition is met" do
+          @number = 1
+          expect {
+            expect {
+              @number += 2
+            }.to matcher
+          }.to fail_matching("expected result to have changed to eq 2, but is now 3")
+        end
+      end
+
+      describe "if #from is specified after #to" do
+        let(:matcher) { change { @number }.to(eq 2).from(1) }
+
+        it "fails properly when the precondition is not met" do
+          @number = 2
+          expect {
+            expect {
+              @number += 1
+            }.to matcher
+          }.to fail_matching("expected result to have initially been 1, but was 2")
+        end
+
+        it "runs the change check if the precondition is met" do
+          @number = 1
+          expect {
+            expect {
+              @number += 2
+            }.to matcher
+          }.to fail_matching("expected result to have changed to eq 2, but is now 3")
+        end
+      end
+    end
   end
 end

data/spec/rspec/verify_argument_is_matcher_spec.rb

@@ -0,0 +1,19 @@
+require_relative '../spec_helper'
+
+describe RSpec::Matchers::VerifyArgumentIsMatcher do
+  describe "when the argument is a matcher" do
+    it "delegates to the matcher" do
+      expect {
+        expect(1).to RSpec::Matchers::VerifyArgumentIsMatcher.new(eq 2)
+      }.to fail_matching(/expected: 2.*got: 1/m)
+    end
+  end
+
+  describe "when the argument is not a matcher" do
+    it "raises a syntax error when the matcher is evaluated" do
+      expect {
+        expect(1).to RSpec::Matchers::VerifyArgumentIsMatcher.new(2)
+      }.to raise_error SyntaxError, "expects a matcher as an argument but got: 2"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-change_to_now
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Andrew S. Brown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-02 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -175,12 +175,14 @@ files:
 - lib/rspec/change_to_now.rb
 - lib/rspec/change_to_now/detect.rb
 - lib/rspec/change_to_now/negate.rb
+- lib/rspec/change_to_now/verify_argument_is_matcher.rb
 - lib/rspec/change_to_now/version.rb
 - rspec-change_to_now.gemspec
 - script/test_all
 - spec/rspec/change_to_now_spec.rb
 - spec/rspec/detect_spec.rb
 - spec/rspec/negate_spec.rb
+- spec/rspec/verify_argument_is_matcher_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
 homepage: https://github.com/dontfidget/rspec-change_to_now
@@ -216,6 +218,7 @@ test_files:
 - spec/rspec/change_to_now_spec.rb
 - spec/rspec/detect_spec.rb
 - spec/rspec/negate_spec.rb
+- spec/rspec/verify_argument_is_matcher_spec.rb
 - spec/spec_helper.rb
 - spec/support/matchers.rb
 has_rdoc: