given_core 3.0.0.beta.3 → 3.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04ca5be81485061fc57dc73c2e1f8a4a86f799ca
-  data.tar.gz: 02862c5068077231c9f0dad7df109e0540851750
+  metadata.gz: bb2de1d0ef168f096a0c169b3e7374c7ba30d785
+  data.tar.gz: e7ad7adad7bcafbedc3b7b71de4fa76a55d23c3f
 SHA512:
-  metadata.gz: 425cb795b6a34c8226e9576696b2f01a8e0aea8089f2a3b96a8ffa351b0efe1df090f14eda3f31e58e92b8aed658b0677c58946b3a777114313a0b56944a9966
-  data.tar.gz: 65db4132658c4285db274b064f463c8a6c8ccb4d58f2f7f561adc61f0dad1277998f9f9f43ec5c4082915f43ea5cf00928c6496d8590bb28f218fbf3fe37e7b5
+  metadata.gz: c5ba77de5d6d12fc167409b9f492e358619ddf7749c44158ffa67043480e6eea3b0cca50afe4c860a9a1393e049817f6c0ffb1ab69a8fc9e37a84b9160d34515
+  data.tar.gz: a4693b820a814b98a485e232b42dfee6533aa4f069d208f363abe140f1656b9636ffa9b656d926fe622ac02af35b0b92023d67097dc2537386827faefc8aaf0a

data/README.md

@@ -1,4 +1,4 @@
-# rspec-given
+# Given/When/Then for RSpec and Minitest
 
 | Master |
 | :----: |
@@ -28,7 +28,7 @@ The rspec-given gem is the original given/when/then extension for
 RSpec. It now depends on a given_core gem for the basic functionality
 and then adds the RSpec specific code.
 
-* rspec-given now require RSpec version 2.12 or better.
+* rspec-given now requires RSpec version 2.12 or better.
 
 ### Minitest/Given
 
@@ -58,7 +58,7 @@ things to watch out for:
 
 ### Auto Selecting
 
-If you exclusively use natural assertions in your specs, it's quite
+If you use natural assertions exclusively in your specs, it's quite
 possible to write specs that run under both RSpec and Minitest::Spec.
 
 Use this at the start of your spec file:
@@ -94,22 +94,22 @@ describe Stack do
   end
 
   Given(:stack) { stack_with(initial_contents) }
-  Invariant { stack.empty?.should == (stack.depth == 0) }
+  Invariant { stack.empty? == (stack.depth == 0) }
 
   context "with no items" do
     Given(:initial_contents) { [] }
-    Then { stack.depth.should == 0 }
+    Then { stack.depth == 0 }
 
     context "when pushing" do
       When { stack.push(:an_item) }
 
-      Then { stack.depth.should == 1 }
-      Then { stack.top.should == :an_item }
+      Then { stack.depth == 1 }
+      Then { stack.top == :an_item }
     end
 
     context "when popping" do
       When(:result) { stack.pop }
-      Then { result.should have_failed(Stack::UnderflowError, /empty/) }
+      Then { result == Failure(Stack::UnderflowError, /empty/) }
     end
   end
 
@@ -119,8 +119,8 @@ describe Stack do
     context "when popping" do
       When(:pop_result) { stack.pop }
 
-      Then { pop_result.should == :an_item }
-      Then { stack.depth.should == 0 }
+      Then { pop_result == :an_item }
+      Then { stack.depth == 0 }
     end
   end
 
@@ -131,16 +131,16 @@ describe Stack do
     context "when pushing" do
       When { stack.push(:new_item) }
 
-      Then { stack.top.should == :new_item }
-      Then { stack.depth.should == original_depth + 1 }
+      Then { stack.top == :new_item }
+      Then { stack.depth == original_depth + 1 }
     end
 
     context "when popping" do
       When(:pop_result) { stack.pop }
 
-      Then { pop_result.should == :top_item }
-      Then { stack.top.should == :second_item }
-      Then { stack.depth.should == original_depth - 1 }
+      Then { pop_result == :top_item }
+      Then { stack.top == :second_item }
+      Then { stack.depth == original_depth - 1 }
     end
   end
 end
@@ -307,7 +307,7 @@ should use an empty _Then_ clause, like this:
 #### Then examples:
 
 ```ruby
-    Then { stack.should be_empty }
+    Then { stack.empty? }
 ```
 
 After the related block for the _When_ clause is run, the stack should
@@ -354,9 +354,9 @@ stick with _Then_ clauses.
 #### Then/And examples:
 
 ```ruby
-  Then { pop_result.should == :top_item }           # Required
-  And  { stack.top.should == :second_item }         # No Setup rerun
-  And  { stack.depth.should == original_depth - 1 } # ... for these
+  Then { pop_result == :top_item }           # Required
+  And  { stack.top == :second_item }         # No Setup rerun
+  And  { stack.depth == original_depth - 1 } # ... for these
 ```
 
 ### Invariant
@@ -420,29 +420,56 @@ clauses and _before_ blocks.
 
 ## Natural Assertions
 
-**NOTE:** <em>Natural assertions are currently an experimental feature
-of RSpec/Given. They are currently disabled by default, but can be
-enabled by a simple configuration option (see "use_natural_assertions"
-below).</em>
-
 RSpec/Given now supports the use of "natural assertions" in _Then_,
 _And_, and _Invariant_ blocks. Natural assertions are just Ruby
 conditionals, without the _should_ or _expect_ methods that RSpec
-provides. Here are the Then/And examples from above, but written using
-natural assertions:
+provides. Here are the Then/And examples showing natural assertions:
+
+### Using Natural Assertions
+
+```ruby
+  Then { stack.top == :second_item }
+  Then { stack.depth == original_depth - 1 }
+  Then { result == Failure(Stack::UnderflowError, /empty/) }
+```
+
+### Using RSpec expect().to
 
 ```ruby
-  Then { pop_result == :top_item }
-  And  { stack.top == :second_item }
-  And  { stack.depth == original_depth - 1 }
+  Then { expect(stack.top).to eq(:second_item) }
+  Then { expect(stack.depth).to eq(original_depth - 1) }
+  Then { expect(result).to have_failed(Stack::UnderflowError, /empty/) }
 ```
 
-Natural assertions must be enabled, either globally or on a per
-context basis, to be recognized.
+### Using Minitest asserts
 
-Here's a heads up: If you use natural assertions, but fail to enable
-them, all your specs will mysteriously pass. This is why the **red**
-part of _Red/Green/Refactor_ is so important.
+```ruby
+  Then { assert_equal :second_item, stack.top }
+  Then { assert_equal original_depth - 1, stack.depth }
+  Then {
+    assert_raises(Stack::UnderflowError, /empty/) do
+      result.call()
+    end
+  }
+```
+
+### Using Minitest expectations
+
+```ruby
+  Then { stack.top.must_equal :second_item }
+  Then { stack.depth.must_equal original_depth - 1}
+  Then { result.must_raise(Stack::UnderflowError, /empty/) }
+```
+
+### Disabling Natural Assertions
+
+Natural assertions may be disabled, either globally or on a per
+context basis. See the **configuration** section below to see how to
+disable natural assertions project wide.
+
+Here's a heads up: If you use natural assertions, but configure Given
+to disable them, then all your specs will mysteriously pass. This is
+why the **red** part of _Red/Green/Refactor_ is so important.
 
 ### Failure Messages with Natural Assertions
 
@@ -552,19 +579,18 @@ problems with And clauses.
 
 ### Mixing Natural Assertions and RSpec Assertions
 
-Natural assertions and RSpec assertions for the most part can be
-intermixed in a single test suite, even within a single context.
-Because there are a few corner cases that might cause problems, they
-must be explicitly enabled before they will be considered.
-
-To enable natural assertions in a context, call the
-_use_natural_assertions_ method in that context. For example:
+Natural assertions, RSpec should assertions and Minitest assertions
+can be intermixed in a single test suite, even within a single
+context.
 
 ```ruby
   context "Outer" do
-    use_natural_assertions
-
     context "Inner" do
+      Then { a == b }               # Natural Assertions
+      Then { a.should == b }        # RSpec style
+      Then { expect(a).to eq(b) }   # RSpec style
+      Then { assert_equal b, a }    # Minitest style
+      Then { a.must_equal b }       # Minitest style
     end
 
     context "Disabled" do
@@ -577,7 +603,7 @@ Both the _Outer_ and _Inner_ contexts will use natural assertions. The
 _Disabled_ context overrides the setting inherited from _Outer_ and
 will not process natural assertions.
 
-See the **configuration** section below to see how to enable natural
+See the **configuration** section below to see how to disable natural
 assertions project wide.
 
 ### Matchers and Natural Assertions
@@ -622,7 +648,7 @@ There are several ways of creating fuzzy numbers:
 
 * <code>about(n)</code> -- Same as <code>about(n).epsilon(10)</code>.
 
-When the file <code>rspec/given/fuzzy_shortcuts</code> is required,
+When the file <code>given/fuzzy_shortcuts</code> is required,
 the following unicode shortcut methods are added to Numeric to create
 fuzzy numbers.
 
@@ -648,7 +674,7 @@ For example, the following two Then clauses are equivalent:
     Then { result.should have_failed(StandardError, /message/) }
 
     # Using natural assertions
-    Then { result == have_failed(StandardError, /message/) }
+    Then { result == Failure(StandardError, /message/) }
 ```
 
 ### Processing Natural Assertions
@@ -662,7 +688,9 @@ following are true:
 1. The block returns false (blocks that return true pass the
    assertion and don't need a failure message).
 
-1. The block does not use RSpec's _should_ or _expect_ methods.
+1. The block does not use the native frameworks assertions or
+   expectations (e.g. RSpec's _should_ or _expect_ methods, or
+   Minitest's _assert\_xxx_ or _must\_xxx_ methods).
 
 Detecting that last point (the use of _should_ and _expect_) is done
 by modifying the RSpec runtime to report uses of _should_ and
@@ -672,11 +700,11 @@ _expect_.
 
 Natural assertions use the Ripper library to parse the failing
 condition and find all the sub-expression values upon a failure.
-Currently Ripper is not supported on JRuby 1.7.2. Charles Nutter has
-said that Ripper support is coming soon and may arrive as early as
-version 1.7.3. Until then, natural assertions are disabled when
-running under JRuby. Never fear, JRuby supports all the other features
-of rspec-given and will work just fine.
+Currently Ripper is not fully supported on JRuby 1.7.4. Charles Nutter
+has said that Ripper support is coming soon and may arrive soon. Until
+then, natural assertions are disabled when running under JRuby. Never
+fear, JRuby supports all the other features of rspec-given and will
+work just fine.
 
 ### Further Reading
 
@@ -697,7 +725,7 @@ the pretty output and wish to disable source code caching
 unconditionally, then add the following line to your spec helper file:
 
 ```ruby
-    RSpec::Given.source_caching_disabled = true
+    Given.source_caching_disabled = true
 ```
 
 Natural assertions are disabled by default. To globally configure
@@ -714,8 +742,8 @@ file:
 
 # License
 
-RSpec-Given is available under the MIT License.  See the MIT-LICENSE
-file in the source distribution.
+rspec-given, minitest-given and given_core are available under the MIT
+License. See the MIT-LICENSE file in the source distribution.
 
 # History
 

data/Rakefile

@@ -57,8 +57,11 @@ end
 
 EXAMPLES = FileList['examples/**/*_spec.rb'].
   exclude('examples/failing/*.rb').
+  exclude('examples/minitest/*.rb').
   exclude('examples/integration/failing/*.rb')
 
+MT_EXAMPLES = FileList['examples/minitest/**/*_spec.rb']
+
 unless Given::NATURAL_ASSERTIONS_SUPPORTED
   EXAMPLES.exclude("examples/stack/*.rb")
 end
@@ -80,7 +83,7 @@ end
 desc "Run the examples in Minitest"
 task :mt_examples do
   puts "Running examples (with Minitest)"
-  sh "ruby -Ilib:examples examples/loader.rb #{EXAMPLES}"
+  sh "ruby -Ilib:examples examples/loader.rb #{EXAMPLES} #{MT_EXAMPLES}"
 end
 
 desc "Run failing examples"

data/lib/given/extensions.rb

@@ -126,15 +126,19 @@ module Given
       @_Gvn_invariants ||= []
     end
 
-    def _Gvn_and_blocks
+    # List of the and blocks directly in the current describe/context
+    # block.
+    def _Gvn_and_blocks         # :nodoc:
       @_Gvn_and_blocks ||= []
     end
 
-    def _Gvn_context_info
+    # Context information ofr the current describe/context block.
+    def _Gvn_context_info       # :nodoc:
       @_Gvn_context_info ||= {}
     end
 
-    def _Gvn_lines
+    # Line extractor for the context.
+    def _Gvn_lines              # :nodoc:
       @_Gvn_lines ||= LineExtractor.new
     end
 
@@ -182,23 +186,34 @@ module Given
     #
     def When(*args, &block)
       if args.first.is_a?(Symbol)
-        let(args.first) do
-          begin
-            _gvn_establish_givens
-            instance_eval(&block)
-          rescue Given.pending_error => ex
-            raise
-          rescue Exception => ex
-            Failure.new(ex)
-          end
-        end
-        _Gvn_before do __send__(args.first) end
+        _Gvn_when_actions_with_capture(args.first, block)
       else
-        _Gvn_before do
+        _Gvn_when_actions(block)
+      end
+    end
+
+    # Normal When clause actions.
+    def _Gvn_when_actions(block)        # :nodoc:
+      _Gvn_before do
+        _gvn_establish_givens
+        instance_eval(&block)
+      end
+    end
+
+    # Normal When clause actions except that exceptions are captured
+    # in a Failure object.
+    def _Gvn_when_actions_with_capture(name, block) # :nodoc:
+      let(name) do
+        begin
           _gvn_establish_givens
           instance_eval(&block)
+        rescue Given.pending_error => ex
+          raise
+        rescue Exception => ex
+          Failure.new(ex)
         end
       end
+      _Gvn_before do __send__(name) end
     end
 
     # Provide an assertion about the specification.
@@ -211,14 +226,9 @@ module Given
     #   Then { ... assertion ... }
     #
     def Then(&block)
-      env = block.binding
-      file, line = eval "[__FILE__, __LINE__]", env
+      file, line = eval "[__FILE__, __LINE__]", block.binding
       description = _Gvn_lines.line(file, line) unless Given.source_caching_disabled
-      if description
-        cmd = "it(description)"
-      else
-        cmd = "specify"
-      end
+      cmd = description ? "it(description)" : "specify"
       eval %{#{cmd} do _gvn_then(&block) end}, binding, file, line
       _Gvn_context_info[:then_defined] = true
     end
@@ -229,11 +239,13 @@ module Given
       _Gvn_invariants << block
     end
 
+    # Provide an assertion that shares setup with a peer Then command.
     def And(&block)
       fail "And defined without a Then" unless _Gvn_context_info[:then_defined]
       _Gvn_and_blocks << block
     end
 
+    # Configure the use of natural assertions in this context.
     def use_natural_assertions(enabled=true)
       Given.ok_to_use_natural_assertions(enabled)
       _Gvn_context_info[:natural_assertions_enabled] = enabled

data/lib/given/failure.rb

@@ -6,6 +6,12 @@ module Given
   class Failure < BasicObject
     undef_method :==, :!=, :!
 
+    def must_raise(*args)
+      ::Minitest::Spec.current.assert_raises(*args) do
+        die
+      end
+    end
+
     def initialize(exception)
       @exception = exception
     end
@@ -49,7 +55,7 @@ module Given
 
     def failure_matcher?(other)
       other.is_a?(::Given::FailureMatcher) ||
-        other.is_a?(::RSpec::Given::HaveFailed::HaveFailedMatcher)
+        (defined?(::RSpec) && other.is_a?(::RSpec::Given::HaveFailed::HaveFailedMatcher))
     end
 
   end

data/lib/given/failure_matcher.rb

@@ -10,13 +10,29 @@ module Given
         @no_pattern = true
       elsif @expected_message_pattern.is_a?(String)
         @expected_message_pattern =
-          Regexp.new("\\A" + Regexp.quote(@expected_message_pattern) + "\\Z")
+          Regexp.new("\\A" + Regexp.quote(@expected_message_pattern) + "\\z")
+      end
+    end
+
+    def ==(other)
+      if other.respond_to?(:call)
+        matches?(other)
+      else
+        super
+      end
+    end
+
+    def !=(other)
+      if other.respond_to?(:call)
+        does_not_match?(other)
+      else
+        super
       end
     end
 
     def matches?(possible_failure)
       if possible_failure.respond_to?(:call)
-        make_sure_it_throws_an_exception(possible_failure)
+        match_or_fail(possible_failure)
       else
         Given.fail_with("#{description}, but nothing failed")
       end
@@ -24,34 +40,55 @@ module Given
 
     def does_not_match?(possible_failure)
       if possible_failure.respond_to?(:call)
-        false
+        mismatch_or_fail(possible_failure)
       else
         true
       end
     end
 
+    def inspect
+      result = "<Failure on #{@expected_exception_class}"
+      result << " matching #{@expected_message_pattern.inspect}" unless @no_pattern
+      result << ">"
+    end
+
     private
 
-    def make_sure_it_throws_an_exception(possible_failure)
+    def match_or_fail(possible_failure)
+      ex = extract_exception(possible_failure)
+      match_exception(ex) ||
+        Given.fail_with("#{description}, but got #{ex.inspect}")
+    end
+
+    def mismatch_or_fail(possible_failure)
+      ex = extract_exception(possible_failure)
+      (! match_exception(ex)) ||
+        Given.fail_with("#{unexpected_description}, but got #{ex.inspect}")
+    end
+
+    def match_exception(ex)
+      ex.is_a?(@expected_exception_class) && @expected_message_pattern =~ ex.message
+    end
+
+    def extract_exception(possible_failure)
       possible_failure.call
       Given.fail_with("Expected an exception")
+      return nil
     rescue Exception => ex
-      if ! ex.is_a?(@expected_exception_class)
-        Given.fail_with("#{description}, but got #{ex.inspect}")
-      elsif @expected_message_pattern !~ ex.message
-        Given.fail_with("#{description}, but got #{ex.inspect}")
-      else
-        true
-      end
+      return ex
     end
 
-    private
-
     def description
       result = "Expected failure with #{@expected_exception_class}"
       result << " matching #{@expected_message_pattern.inspect}" unless @no_pattern
       result
     end
+
+    def unexpected_description
+      result = "Did not expect failure with #{@expected_exception_class}"
+      result << " matching #{@expected_message_pattern.inspect}" unless @no_pattern
+      result
+    end
   end
 
   module FailureMethod

data/lib/given/minitest/configure.rb

@@ -1,6 +1,7 @@
 
 # Configure Minitest to use the Given extensions.
 
-Minitest::Spec.send(:extend, Given::ClassExtensions)
+Minitest::Spec.send(:extend,  Given::ClassExtensions)
 Minitest::Spec.send(:include, Given::FailureMethod)
 Minitest::Spec.send(:include, Given::InstanceExtensions)
+Given.use_natural_assertions if Given::NATURAL_ASSERTIONS_SUPPORTED

data/lib/given/rspec/configure.rb

@@ -15,5 +15,6 @@ RSpec.configure do |c|
     c.backtrace_clean_patterns << /lib\/rspec\/given/
   end
 
+  Given.use_natural_assertions if Given::NATURAL_ASSERTIONS_SUPPORTED
   Given.detect_formatters(c)
 end

data/lib/given/version.rb

@@ -5,7 +5,7 @@ module Given
     VERSION_MINOR = 0,
     VERSION_BUILD = 0,
     BETA = 'beta',
-    BETA_NUMBER = 3,
+    BETA_NUMBER = 4,
   ]
   VERSION = VERSION_NUMBERS.join(".")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: given_core
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.3
+  version: 3.0.0.beta.4
 platform: ruby
 authors:
 - Jim Weirich