assert_value 1.0 → 1.1

data/README.md

@@ -4,7 +4,9 @@ Checks that two values are same and "magically" replaces expected value
 with the actual in case the new behavior (and new actual value) is correct.
 Support two kind of arguments: string and code block.
 
-## String Example:
+This check works with both Test/Unit and RSpec. See documentation and examples below:
+
+## Testing String Values
 
 It is better to start with no expected value
 
@@ -24,9 +26,9 @@ If you accept the new value your test will be automatically modified to
         foo
     END
 
-## Block Example:
+## Testing Block Values
 
-assert_value supports code block as argument. If executed block raises exception then
+assert_value can take code block as an argument. If executed block raises exception then
 exception message is returned as actual value:
 
     assert_value do
@@ -48,7 +50,13 @@ After the new value is accepted you get
         nil + 1
     end
 
-## Options:
+## Testing Values Stored in Files
+
+Sometimes test string is too large to be inlined into the test source. Put it into the file instead:
+
+    assert_value "foo", log: 'test/log/reference.txt'
+
+## Additional Test/Unit Options:
 
     --no-interactive skips all questions and just reports failures
     --autoaccept prints diffs and automatically accepts all new actual values
@@ -66,6 +74,29 @@ In Ruby 1.9:
     ruby test/unit/foo_test.rb --autoaccept
     rake test TESTOPTS="--autoaccept"
 
+## RSpec
+
+In specs you can either call assert_value directly or use "be_same_value_as" matcher:
+
+    describe "spec with be_same_value_as matcher" do
+        it "compares with inline value" do
+            expect("foo").to be_same_value_as <<-END
+                foo
+            END
+        end
+
+        it "compares with inline block" do
+            expect { "foo" }.to be_same_value_as <<-END
+                foo
+            END
+        end
+
+        it "compares with value in file" do
+            expect("foo").to be_same_value_as(:log => 'test/logs/assert_value_with_files.log.ref')
+        end
+    end
+
+
 ## Canonicalization:
 
 Before comparing expected and actual strings, assert_value canonicalizes both using these rules:
@@ -90,6 +121,7 @@ In Ruby 1.9:
 
 ## Changelog
 
+- 1.1: RSpec support
 - 1.0: Rename to assert_value
 - 0.7: Support Ruby 1.9's MiniTest
 - 0.6: Support test execution on Mac

data/assert_value.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 SPEC = Gem::Specification.new do |s|
     s.name        = "assert_value"
-    s.version     = "1.0"
+    s.version     = "1.1"
     s.author      = "Pluron, Inc."
     s.email       = "support@pluron.com"
     s.homepage    = "http://github.com/acunote/assert_value"

data/lib/assert_value.rb

@@ -60,7 +60,7 @@ end
 module AssertValueAssertion
 
     def file_offsets
-      @file_offsets ||= Hash.new { |hash, key| hash[key] = {} }
+      @@file_offsets ||= Hash.new { |hash, key| hash[key] = {} }
     end
 
     # assert_value: assert which checks that two strings (expected and actual) are same
@@ -167,7 +167,9 @@ module AssertValueAssertion
     #   assert_value, run tests and they will fill expected values for you automatically
     def assert_value(*args)
         if block_given?
-            mode = :block
+            # rspec passes block to the expect() function, not to the matcher
+            # so string substitution should work as if assert_value is called with a string
+            mode = @rspec_matcher ? :scalar : :block
             expected = args[0]
             actual = ""
             begin
@@ -250,6 +252,10 @@ module AssertValueAssertion
         end
     end
 
+    def be_same_value_as(expected = nil)
+      BeSameValueAs.new(expected)
+    end
+
 private
 
     def succeed
@@ -282,7 +288,8 @@ private
     # change - what to do with expected value (:create_expected_string or :update_expected_string)
     # mode   - describes signature of assert_value call by type of main argument (:block or :scalar)
     def accept_string(actual, change, mode)
-        file, method, line = get_caller_location(:depth => 3)
+        depth = @rspec_matcher ? 6 : 3
+        file, method, line = get_caller_location(:depth => depth)
 
         # read source file, construct the new source, replacing everything
         # between "do" and "end" in assert_value's block
@@ -315,7 +322,8 @@ private
         if change == :create_expected_string 
             if mode == :scalar
                 # add second argument to assert_value if it's omitted
-                source[expected_text_start_line-1] = "#{source[expected_text_start_line-1].chop}, <<-END\n"
+                comma = "," unless @rspec_matcher
+                source[expected_text_start_line-1] = "#{source[expected_text_start_line-1].chop}#{comma} <<-END\n"
             elsif mode == :block
                 # add expected value as argument to assert_value before block call
                 source[expected_text_start_line-1] = source[expected_text_start_line-1].sub(/assert_value(\(.*?\))*/, "assert_value(<<-END)")
@@ -407,6 +415,33 @@ else
     end
 end
 
+# RSpec matcher for assert_value
+class BeSameValueAs
+    include AssertValueAssertion
+
+    def initialize(expected)
+        @expected = expected
+        @rspec_matcher = true
+    end
+
+    def matches?(target)
+      if target.is_a? Proc
+          assert_value @expected, &target
+      else
+          assert_value target, @expected
+      end
+    end
+
+    def failure_message_for_should
+        "expected to be the same"
+    end
+
+    def failure_message_for_should_not
+        "expected not to be the same"
+    end
+end
+
+
 if defined?(RSpec)
     RSpec.configure do |c|
         c.include AssertValueAssertion

data/test/assert_value_spec.rb

@@ -2,27 +2,42 @@ require 'assert_value'
 
 describe "Assert Value" do
 
-  it "compares with value in file" do
-    assert_value("foo", :log => 'test/logs/assert_value_with_files.log.ref')
-    expect(assert_value("foo", :log => 'test/logs/assert_value_with_files.log.ref')).to eq(true)
-  end
-
-  it "compares with value inlined in source file" do
-    assert_value "foo", <<-END
-        foo
-    END
-
-    expect(
-      assert_value "foo", <<-END
-          foo
-      END
-    ).to eq(true)
-
-    expect(assert_value(<<-END) do
-        foo
-    END
-      "foo"
-    end).to eq(true)
-  end
+    describe "true rspec blessed way" do
+        it "compares with inline value" do
+            expect("foo").to be_same_value_as <<-END
+                foo
+            END
+        end
+
+        it "compares with inline block" do
+            expect { "foo" }.to be_same_value_as <<-END
+                foo
+            END
+        end
+
+        it "compares with value in file" do
+            expect("foo").to be_same_value_as(:log => 'test/logs/assert_value_with_files.log.ref')
+        end
+    end
+
+    describe "test/unit way is also supported" do
+        it "compares with inline value" do
+            assert_value "foo", <<-END
+                foo
+            END
+        end
+
+        it "compares with inline block" do
+            assert_value(<<-END) do
+                foo
+            END
+                "foo"
+            end
+        end
+
+        it "compares with value in file" do
+            assert_value("foo", :log => 'test/logs/assert_value_with_files.log.ref')
+        end
+    end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assert_value
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies: []
 description: assert_value assertion
 email: support@pluron.com