rspec-given 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7a5e35ac4e4c52e92a6eb72ab2e89c559de6b74
-  data.tar.gz: 286b8e00e812c97b483ef6e0f448b49a6bea1589
+  metadata.gz: fc78c2338f9f6cb33f6f9e1d52410ded37c86fb6
+  data.tar.gz: 796e3a8e856caf2db72f095ed75c5c3ac82eb55e
 SHA512:
-  metadata.gz: e63113d97ec75f1e5482125b35160c0323ac1e6275953dfa1f133ecfbebc99d895d261cfc18700910f832d581ff79ad0fea8c3ae1f41848a7373263e4711fa3e
-  data.tar.gz: a7d0d7afed6b98aceb4248072a2e80ecc3140565216db3d18be45472ec99a3ebb49b102cd4f2ce1101cf883e339973c73bed3acee53987807dc1ed0b59ed17af
+  metadata.gz: c609d57feba6ca8ad85ea6ceb3132bcf275a9758a84519a9454a9cd471eb2378739b753be3e73ebd89fc272cee803d2b3bce50f71a7768e5dea8e2560d149b8b
+  data.tar.gz: 38b365c32c2a57dd23979ea9755edc955dab45a0f91fb27ffbad5f82e980132aeedf29f5ac3fe2cae7c9025da9e682561461d0aa9f071cda8702449c9a7f6cf6

data/README.md

@@ -4,7 +4,7 @@
 | :----: |
 | [![Master Build Status](https://secure.travis-ci.org/jimweirich/rspec-given.png?branch=master)](https://travis-ci.org/jimweirich/rspec-given) |
 
-Covering rspec-given, minitest-given, and given-core, version 3.0.0.
+Covering rspec-given, minitest-given, and given-core, version 3.1.0.
 
 rspec-given and minitest-given are extensions to your favorite testing
 framework to allow Given/When/Then notation when writing specs.
@@ -744,6 +744,70 @@ 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.
 
+### Non-Spec Assertions
+
+Given also provides three assertions meant to be used in
+non-test/non-spec code. For example, here is a square root function
+decked out with pre and post-condition assertions.
+
+```ruby
+require 'given/assertions'
+require 'given/fuzzy_number'
+
+include Given::Assertions
+include Given::Fuzzy
+
+def sqrt(n)
+  Precondition { n >= 0 }
+  result = Math.sqrt(n)
+  Postcondition { result ** 2 == about(n) }
+  result
+end
+```
+
+To use the non-testing assertions, you need to require the
+'given/assertions' file and then include the
+<code>Given::Assertions</code> module into what ever class is using
+the
+<code>Precondition</code>/<code>Postcondition</code>/<code>Assert</code>
+methods. The code block for these assertions should always be a
+regular Ruby true/false value (the <code>should</code> and
+<code>expect</code> methods from RSpec are not available).
+
+Note that this example also uses the fuzzy number matching, but that
+is not required for the assertions themselves.
+
+The assertion methods are:
+
+* <code>Precondition { bool }</code> -- If the block evaluates to
+  false (or nil), throw a Given::Assertions::PreconditionError.
+
+* <code>Postcondition { bool }</code> -- If the block evaluates to
+  false (or nil), throw a Given::Assertions::PostconditionError.
+
+* <code>Assert { bool }</code> -- If the block evaluates to
+  false (or nil), throw a Given::Assertions::AssertError.
+
+Both PreconditionError and PostconditionError are subclasses of
+AssertError.
+
+You can disable assertion checking with one of the following commands:
+
+* <code>Given::Assertions.enable_preconditions bool</code> --
+  Enable/Disable precondition assertions.
+  (default to enable)
+
+* <code>Given::Assertions.enable_postconditions bool</code> --
+  Enable/Disable postcondition assertions.
+  (default to enable)
+
+* <code>Given::Assertions.enable_asserts bool</code> --
+  Enable/Disable assert assertions. (default to enable)
+
+* <code>Given::Assertions.enable_all bool</code> --
+  Enable/Disable all assertions with a single command.
+  (default to enable)
+
 ### Further Reading
 
 Natural assertions were inspired by the [wrong assertion
@@ -782,13 +846,22 @@ License. See the MIT-LICENSE file in the source distribution.
 
 # History
 
+* Version 3.1.0
+
+  * Add support for Precondition/Postcondition/Assert in non-spec
+    code.
+
+* Version 3.0.1
+
+  * Add support for the === operation in natural assertions.
+
 * Version 3.0.0
 
   * Support for minitest added.
 
-  * Introduced gem given_core to contain the common logic between the
+  * Introduced gem given\_core to contain the common logic between the
     RSpec and Minitest versions. Both the rspec-given gem and the
-    minitest-given gem have a dependency on given_core.
+    minitest-given gem have a dependency on given\_core.
 
   * Natural assertions are now enabled by default.
 

data/Rakefile

@@ -44,9 +44,6 @@ end
 # Running examples ---------------------------------------------------
 
 desc "Run all the examples"
-task :examples => [:specs, :rs_examples]
-
-desc "Run the RSpec 2 specs and examples"
 task :examples => [:specs, :rs_examples, :mt_examples]
 
 desc "Run the specs"
@@ -55,7 +52,7 @@ task :specs do
   sh "rspec spec"
 end
 
-EXAMPLES = FileList['examples/**/*_spec.rb'].
+EXAMPLES = FileList['examples/**/*_spec.rb', 'examples/use_assertions.rb'].
   exclude('examples/failing/*.rb').
   exclude('examples/minitest/*.rb').
   exclude('examples/integration/failing/*.rb')
@@ -104,8 +101,9 @@ task :verify_rspec2 do
   end
 end
 
+desc "Check all files load properly when independenly loaded."
 task :load_check do
-  SRC_FILES = FileList['lib/rspec/given/*.rb'].exclude(%r(rspec1))
+  SRC_FILES = FileList['lib/given/*.rb'].exclude(%r(rspec1))
   SRC_FILES.each do |fn|
     sh %{ruby -Ilib -e 'load "#{fn}"'}
   end

data/examples/use_assertions.rb

@@ -0,0 +1,42 @@
+require 'given/assertions'
+require 'given/fuzzy_number'
+
+include Given::Assertions
+include Given::Fuzzy
+
+def sqrt(n)
+  Precondition { n >= 0 }
+  result = Math.sqrt(n)
+  Postcondition { result ** 2 == about(n) }
+  result
+end
+
+def sqrt_bad_postcondition(n)
+  Precondition { n >= 0 }
+  result = Math.sqrt(n)
+  Postcondition { result ** 2 == about(n+1) }
+  result
+end
+
+def use_assert(n)
+  Assert { n == 1 }
+end
+
+def should_fail
+  begin
+    yield
+    fail "Expected error"
+  rescue Given::Assertions::AssertError => ex
+    true
+  end
+end
+
+sqrt(1)
+sqrt(2)
+sqrt(0)
+
+should_fail { sqrt(-1) }
+should_fail { sqrt_bad_postcondition(1) }
+
+use_assert(1)
+should_fail { use_assert(0) }

data/spec/lib/given/assertions_spec.rb

@@ -0,0 +1,72 @@
+require 'rspec/given'
+require 'given/assertions'
+
+describe Given::Assertions do
+  Given { extend Given::Assertions }
+
+  describe "Assert { }" do
+    Given { Given::Assertions.enable_asserts }
+
+    context "with true assertion" do
+      When(:result) { Assert { true } }
+      Then { result != Failure() }
+    end
+
+    context "with false assertion" do
+      When(:result) {
+        Assert { false }
+      }
+      Then { result == Failure(Given::Assertions::AssertError, /Assert.*false/) }
+    end
+
+    context "when disabled" do
+      Given { Given::Assertions.enable_asserts false }
+      When(:result) { Assert { false } }
+      Then { result != Failure() }
+    end
+  end
+
+  describe "Precondition { }" do
+    Given { Given::Assertions.enable_preconditions }
+
+    context "with true assertion" do
+      When(:result) { Precondition { true } }
+      Then { result != Failure() }
+    end
+
+    context "with false assertion" do
+      When(:result) {
+        Precondition { false }
+      }
+      Then { result == Failure(Given::Assertions::PreconditionError, /Precondition.*false/) }
+    end
+
+    context "when disabled" do
+      Given { Given::Assertions.enable_preconditions false }
+      When(:result) { Precondition { false } }
+      Then { result != Failure() }
+    end
+  end
+
+  describe "Postcondition { }" do
+    Given { Given::Assertions.enable_preconditions }
+
+    context "with true assertion" do
+      When(:result) { Postcondition { true } }
+      Then { result != Failure() }
+    end
+
+    context "with false assertion" do
+      When(:result) {
+        Postcondition { false }
+      }
+      Then { result == Failure(Given::Assertions::PostconditionError, /Postcondition.*false/) }
+    end
+
+    context "when disabled" do
+      Given { Given::Assertions.enable_preconditions false }
+      When(:result) { Postcondition { false } }
+      Then { result != Failure() }
+    end
+  end
+end

data/spec/lib/given/binary_operation_spec.rb

@@ -11,6 +11,14 @@ describe Given::BinaryOperation do
     Then { binary.explain.should == "to equal" }
   end
 
+  context "with a valid binary sexp using ===" do
+    Given(:sexp) { [:binary,  [:@ident, "a"], :===, [:@ident, "b"]] }
+    Then { binary.left.should == [:@ident, "a"] }
+    Then { binary.operator.should == :=== }
+    Then { binary.right.should == [:@ident, "b"] }
+    Then { binary.explain.should == "to be matched by" }
+  end
+
   context "with a non-binary sexp" do
     Given(:sexp) { [:something_else] }
     Then { binary.should be_nil }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-given
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jim Weirich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: given_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,6 @@ files:
 - Gemfile.lock
 - MIT-LICENSE
 - README.md
-- README.old
 - Rakefile
 - TODO
 - lib/given.rb
@@ -62,6 +61,7 @@ files:
 - rakelib/preview.rake
 - test/before_test.rb
 - test/meme_test.rb
+- spec/lib/given/assertions_spec.rb
 - spec/lib/given/binary_operation_spec.rb
 - spec/lib/given/evaluator_spec.rb
 - spec/lib/given/ext/numeric_spec.rb
@@ -99,6 +99,7 @@ files:
 - examples/stack/stack.rb
 - examples/stack/stack_spec.rb
 - examples/stack/stack_spec1.rb
+- examples/use_assertions.rb
 - doc/main.rdoc
 homepage: http://github.com/jimweirich/rspec-given
 licenses:
@@ -126,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: given
-rubygems_version: 2.0.3
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Given/When/Then Specification Extensions for RSpec.

data/README.old

@@ -1,829 +0,0 @@
-# Given/When/Then for RSpec and Minitest
-
-| Master | Minispec |
-| :----: | :----: |
-| [![Master Build Status](https://secure.travis-ci.org/jimweirich/rspec-given.png?branch=master)](https://travis-ci.org/jimweirich/rspec-given) | [![Minispec Build Status](https://secure.travis-ci.org/jimweirich/rspec-given.png?branch=minispec)](https://travis-ci.org/jimweirich/rspec-given) |
-
-Covering rspec-given, minitest-given, and given-core, version 3.0.0.beta.1.
-
-rspec-given and minitest-given are extensions to your favorite testing
-framework to allow Given/When/Then notation when writing specs.
-
-# Why Given/When/Then
-
-RSpec has done a great job of making specifications more readable for
-humans. However, I really like the given/when/then nature of Cucumber
-stories and would like to follow the same structure in my unit tests.
-rspec-given (and now minitest-given) allows a simple given/when/then
-structure RSpec specifications.
-
-## Status
-
-* rspec-given is ready for production use.
-* minitest-given is experimental.
-
-### RSpec/Given
-
-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 requires RSpec version 2.12 or better.
-
-### Minitest/Given
-
-A new minitest-given gem allows Given/When/Then notation directly in
-Minitest::Spec specifications.
-
-To use minitest-given, just place the following require at the top of
-the file (or in a convenient spec_helper).
-
-```ruby
-require 'minitest/given'
-```
-
-All the features of rspec-given are available in minitest-given.
-
-When switching from RSpec/Given to Minitest/Given, here are some
-things to watch out for:
-
-* You need to use Minitest version 4.3 or better (yes, Minitest 5.x
-  should work as well).
-
-* Minitest/Given adds the missing "context" block to Minitest::Spec.
-
-* Only one before block is allowed in any given Minitest::Spec
-  describe block. This doesn't effect the number of Givens you are
-  allowed to use, but it may surprise if you are use to RSpec.
-
-### Auto Selecting
-
-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:
-
-```ruby
-if defined?(RSpec)
-  require 'rspec/given'
-else
-  require 'minitest/autorun'
-  require 'minitest/given'
-end
-```
-
-See
-[stack_spec.rb](https://github.com/jimweirich/rspec-given/blob/minispec/examples/stack/stack_spec.rb)
-and
-[example_helper.rb](https://github.com/jimweirich/rspec-given/blob/minispec/examples/example_helper.rb)
-
-## Installation
-
-### If you are using bundler
-
-Add `rspec-given` (or `minitest-given`) to the `:test` group in the `Gemfile`:
-
-```ruby
-group :test do
-  gem 'rspec-given'
-end
-```
-
-```ruby
-group :test do
-  gem 'minitest-given'
-end
-```
-
-Download and install:
-
-`$ bundle`
-
-Then just require `rspec/given` (or `minitest/given`) in the
-`spec_helper` of your project and it is ready to go.
-
-### If you are not using bundler
-
-Install the gem:
-
-`$ gem install rspec-given`
-
-or
-
-`$ gem install minitest-given`
-
-Then just require `rspec/given` (or `minitest/given`) in the
-`spec_helper` of your project and it is ready to go.
-
-## Example
-
-Here is a specification written in the rspec-given framework:
-
-```ruby
-require 'rspec/given'
-require 'spec_helper'
-require 'stack'
-
-describe Stack do
-  def stack_with(initial_contents)
-    stack = Stack.new
-    initial_contents.each do |item| stack.push(item) end
-    stack
-  end
-
-  Given(:stack) { stack_with(initial_contents) }
-  Invariant { stack.empty? == (stack.depth == 0) }
-
-  context "with no items" do
-    Given(:initial_contents) { [] }
-    Then { stack.depth == 0 }
-
-    context "when pushing" do
-      When { stack.push(:an_item) }
-
-      Then { stack.depth == 1 }
-      Then { stack.top == :an_item }
-    end
-
-    context "when popping" do
-      When(:result) { stack.pop }
-      Then { result == Failure(Stack::UnderflowError, /empty/) }
-    end
-  end
-
-  context "with one item" do
-    Given(:initial_contents) { [:an_item] }
-
-    context "when popping" do
-      When(:pop_result) { stack.pop }
-
-      Then { pop_result == :an_item }
-      Then { stack.depth == 0 }
-    end
-  end
-
-  context "with several items" do
-    Given(:initial_contents) { [:second_item, :top_item] }
-    Given!(:original_depth) { stack.depth }
-
-    context "when pushing" do
-      When { stack.push(:new_item) }
-
-      Then { stack.top == :new_item }
-      Then { stack.depth == original_depth + 1 }
-    end
-
-    context "when popping" do
-      When(:pop_result) { stack.pop }
-
-      Then { pop_result == :top_item }
-      Then { stack.top == :second_item }
-      Then { stack.depth == original_depth - 1 }
-    end
-  end
-end
-```
-
-Let's talk about the individual statements used in the Given
-framework.
-
-### Given
-
-The _Given_ section specifies a starting point, a set of preconditions
-that must be true before the code under test is allowed to be run.  In
-standard test frameworks the preconditions are established with a
-combination of setup methods (or :before actions in RSpec) and code in
-the test.
-
-In the example code above the preconditions are started with _Given_
-statements.  A top level _Given_ (that applies to the entire describe
-block) says that one of the preconditions is that there is a stack
-with some initial contents.
-
-Note that initial contents are not specified in the top level describe
-block, but are given in each of the nested contexts.  By pushing the
-definition of "initial_contents" into the nested contexts, we can vary
-them as needed for that particular context.
-
-A precondition in the form "Given(:var) {...}" creates an accessor
-method named "var".  The accessor is lazily initialized by the code
-block.  If you want a non-lazy given, use "Given!(:var) {...}".
-
-A precondition in the form "Given {...}" just executes the code block
-for side effects.  Since there is no accessor, the code block is
-executed immediately (i.e. no lazy evaluation).
-
-The preconditions are run in order of definition.  Nested contexts
-will inherit the preconditions from the enclosing context, with outer
-preconditions running before inner preconditions.
-
-#### Given examples:
-
-```ruby
-    Given(:stack) { Stack.new }
-```
-
-The block for the given clause is lazily run and its value bound to
-'stack' if 'stack' is ever referenced in the test.
-The first reference to 'stack' in the specification will cause the
-code block to execute. Futher references to 'stack' will reuse the
-previously generated value.
-
-```ruby
-    Given!(:original_size) { stack.size }
-```
-
-The code block is run unconditionally once before each test and the
-value of the block is bound to 'original_size'.  This form is useful
-when you want to record the value of something that might be affected
-by the When code.
-
-```ruby
-    Given { stack.clear }
-```
-
-The block for the given clause is run unconditionally once before each
-test. This form of given is used for code that is executed for side
-effects.
-
-### When
-
-The _When_ clause specifies the code to be tested ... oops, excuse me
-... specified.  After the preconditions in the given section are met,
-the when code block is run.
-
-In general there should not be more than one _When_ clause for a given
-direct context. However, a _When_ in an outer context will be run
-after all the _Givens_ but before the inner _When_. You can think of
-an outer _When_ as setting up additional given state for the inner
-_When_.
-
-E.g.
-
-```ruby
-    context "outer context" do
-      When { code specified in the outer context }
-      Then { assert something about the outer context }
-
-      context "inner context" do
-
-        # At this point, the _When_ of the outer context
-        # should be treated as a _Given_ of the inner context
-
-        When { code specified in the inner context }
-        Then { assert something about the inner context }
-      end
-    end
-```
-
-#### When examples:
-
-```ruby
-    When { stack.push(:item) }
-```
-
-The code block is executed once per test.  The effect of the _When{}_
-block is very similar to _Given{}_.  However, When is used to identify
-the particular code that is being specified in the current context or
-describe block.
-
-```ruby
-    When(:result) { stack.pop }
-```
-
-The code block is executed once per test and the value of the code
-block is bound to 'result'.  Use this form when the code under test
-returns a value that you wish to interrogate in the _Then_ code.
-
-If an exception occurs during the execution of the block for the When
-clause, the exception is caught and a failure object is bound to
-'result'. The failure can be checked in a then block with the
-'have_failed' matcher.
-
-The failure object will rethrow the captured exception if anything
-other than have_failed matcher is used on the failure object.
-
-For example, if the stack is empty when it is popped, then it is
-reasonable for pop to raise an UnderflowError. This is how you might
-specify that behavior:
-
-```ruby
-    When(:result) { stack.pop }
-    Then { result.should have_failed(UnderflowError, /empty/) }
-```
-
-Note that the arguments to the 'have_failed' matcher are the same as
-those given to the standard RSpec matcher 'raise_error'.
-
-### Then
-
-The _Then_ clauses are the postconditions of the specification. These
-then conditions must be true after the code under test (the _When_
-clause) is run.
-
-The code in the block of a _Then_ clause should be a single _should_
-assertion. Code in _Then_ clauses should not have any side effects.
-
-Let me repeat that: <b>_Then_ clauses should not have any side
-effects!</b> _Then_ clauses with side effects are erroneous. _Then_
-clauses need to be idempotent, so that running them once, twice, a
-hundred times, or never does not change the state of the program. (The
-same is true of _And_ and _Invariant_ clauses).
-
-In RSpec terms, a _Then_ clause forms a RSpec Example that runs in the
-context of an Example Group (defined by a describe or context clause).
-
-Each Example Group must have at least one _Then_ clause, otherwise
-there will be no examples to be run for that group. If all the
-assertions in an example group are done via Invariants, then the group
-should use an empty _Then_ clause, like this:
-
-```ruby
-    Then { }
-```
-
-#### Then examples:
-
-```ruby
-    Then { stack.empty? }
-```
-
-After the related block for the _When_ clause is run, the stack should
-be empty. If it is not empty, the test will fail.
-
-### And
-
-The _And_ clause is similar to _Then_, but does not form its own RSpec
-example. This means that _And_ clauses reuse the setup from a sibling
-_Then_ clause. Using a single _Then_ and multiple _And_ clauses in an
-example group means the setup for that group is run only once (for the
-_Then_ clause) and reused for all the _And_ clauses. This can be a
-significant speed savings where the setup for an example group is
-expensive.
-
-Some things to keep in mind about _And_ clauses:
-
-* There must be at least one _Then_ in the example group and it must
-  be declared before the _And_ clauses. Forgetting the _Then_ clause
-  is an error.
-
-* The code in the _And_ clause is run immediately after the first
-  (executed) _Then_ of an example group.
-
-* An assertion failure in a _Then_ clause or an _And_ clause will
-  cause all the subsequent _And_ clauses to be skipped.
-
-* Since _And_ clauses do not form their own RSpec examples, they are
-  not represented in the formatted output of RSpec. That means _And_
-  clauses do not produce dots in the Progress format, nor do they
-  appear in the documentation, html or textmate formats (options
-  -fhtml, -fdoc, or -ftextmate).
-
-* Like _Then_ clauses, _And_ clauses must be idempotent. That means
-  they should not execute any code that changes global program state.
-  (See the section on the _Then_ clause).
-
-The choice to use an _And_ clause is primarily a speed consideration.
-If an example group has expensive setup and there are a lot of _Then_
-clauses, then choosing to make some of the _Then_ clauses into _And_
-clauses will speed up the spec. Otherwise it is probably better to
-stick with _Then_ clauses.
-
-#### Then/And examples:
-
-```ruby
-  Then { pop_result == :top_item }           # Required
-  And  { stack.top == :second_item }         # No Setup rerun
-  And  { stack.depth == original_depth - 1 } # ... for these
-```
-
-### Invariant
-
-The _Invariant_ clause is a new idea that doesn't have an analog in
-RSpec or Test::Unit. The invariant allows you specify things that must
-always be true in the scope of the invariant. In the stack example, the method
-<tt>empty?</tt> is defined in term of <tt>size</tt>.
-
-```ruby
-  Invariant { stack.empty? == (stack.depth == 0) }
-```
-
-This invariant states that <code>empty?</code> is true if and only if
-the stack depth is zero, and that assertion is checked at every _Then_
-clause that is in the same scope.
-
-You can conceptually think of an _Invariant_ clause as a _Then_ block
-that automatically gets added to every _Then_ within its scope.
-Invariants nested within a context only apply to the _Then_ clauses
-that are in the scope of that context.
-
-Invariants that reference a _Given_ precondition accessor must only be
-used in contexts that define that accessor.
-
-Notes:
-
-* Since Invariants do not form their own RSpec example, they are not
-  represented in the RSpec formatted output (e.g. the '--format html'
-  option).
-
-## Execution Ordering
-
-When running the test for a specific _Then_ clause, the following will
-be true:
-
-* The non-lazy _Given_ clauses will be run in the order that they are
-  specified, from the outermost scope to the innermost scope
-  containing the _Then_. (The lazy _Given_ clauses will be run upon
-  demand).
-
-* All of the _Given_ clauses in all of the relevant scopes will run
-  before the first (outermost) _When_ clause in those same scopes.
-  That means that the _When_ code can assume that the givens have been
-  established, even if the givens are in a more nested scope than the
-  When.
-
-* _When_ clauses and RSpec _before_ blocks will be executed in the
-  order that they are specified, from the outermost block to the
-  innermost block. This makes _before_ blocks an excellent choice when
-  writing narrative tests to specify actions that happen between the
-  "whens" of a narrative-style test.
-
-Note that the ordering between _Given_ clauses and _before_ blocks are
-not strongly specified. Hoisting a _When_ clause out of an inner scope
-to an outer scope may change the order of execution between related
-_Given_ clauses and any _before_ blocks (hoisting the _When_ clause
-might cause the related _Given_ clauses to possibly run earlier).
-Because of this, do not split order dependent code between _Given_
-clauses and _before_ blocks.
-
-## Natural Assertions
-
-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 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 { 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/) }
-```
-
-### Using Minitest asserts
-
-```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
-
-Since natural assertions do not depend upon matchers, you don't get
-customized error messages from them. What you _do_ get is a complete
-analsysis of the expression that failed.
-
-For example, given the following failing specification:
-
-```ruby
-  Given.use_natural_assertions
-
-  describe "Natural Assertions" do
-    Given(:foo) { 1 }
-    Given(:bar) { 2 }
-    Then { foo + bar == 2 }
-  end
-```
-
-You would get:
-
-```
-  1) Natural Assertions
-     Failure/Error: Then { foo + bar == 2 }
-       Then expression failed at /Users/jim/working/git/rspec-given/examples/failing/sample_spec.rb:6
-       expected: 3
-       to equal: 2
-         false   <- foo + bar == 2
-         3       <- foo + bar
-         1       <- foo
-         2       <- bar
-     # ./examples/failing/sample_spec.rb:6:in `block in Then'
-```
-
-Notice how the failing expression "<code>foo+bar == 2</code>" was
-broken down into subexpressions and values for each subexpression.
-This gives you all the information you need to figure out exactly what
-part of the expression is causing the failure.
-
-Natural assertions will give additional information (e.g. "expected:
-3 to equal: 2") for top level expressions involving any of the
-comparison operators (==, !=, <, <=, >, >=) or matching operators (=~,
-!~).
-
-### Checking for exceptions with Natural Assertions
-
-If you wish to see if the result of a _When_ clause is an exception,
-you can use the following:
-
-```ruby
-    When(:result) { stack.pop }
-    Then { result == Failure(UnderflowError, /empty/) }
-```
-
-The <code>Failure()</code> method accepts the same arguments as
-<code>have_failed</code> and <code>raise_error</code>.
-
-### Caveats on Natural Assertions
-
-Keep the following in mind when using natural assertions.
-
-* Only a single expression/assertion per _Then_. The single expression
-  of the _Then_ block will be considered when determining pass/fail
-  for the assertion. If you _want_ to express a complex condition for
-  the _Then_, you need to use ||, && or some other logical operation
-  to join the conditions into a single expression (and the failure
-  message will break down the values for each part).
-
-* Then clauses need be **idempotent**. This is true in general, but it
-  is particularly important for natural assertions to obey this
-  restriction. This means that assertions in a Then clause should not
-  change anything. Since the Natural Assertion error message contains
-  the values of all the subexpressions, the expression and its
-  subexpressions will be evaluated multiple times. If the Then clause
-  is not idempotent, you will get changing answers as the
-  subexpressions are evaluated.
-
-That last point is important. If you write code like this:
-
-```ruby
-  # DO NOT WRITE CODE LIKE THIS
-  context "Incorrect non-idempotent conditions" do
-    Given(:ary) { [1, 2, 3] }
-    Then { ary.delete(1) == nil }
-  end
-```
-
-Then the assertion will fail (because <code>ary.delete(1)</code> will
-initially return 1). But when the error message is formated, the
-system reports that <code>ary.delete(1)</code> returns nil. You will
-scratch your head over that for a good while.
-
-Instead, move the state changing code into a _When(:result)_ block, then
-assert what you need to about :result. Something
-like this is good:
-
-```ruby
-  context "Correct idempotent conditions" do
-    Given(:ary) { [1, 2, 3] }
-    When(:result) { ary.delete(1) }
-    Then { result == nil }
-  end
-```
-
-It is good to note that non-idempotent assertions will also cause
-problems with And and Invariant clauses.
-
-### Mixing Natural Assertions and RSpec Assertions
-
-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
-    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
-      use_natural_assertions false
-    end
-  end
-```
-
-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 disable natural
-assertions project wide.
-
-### Matchers and Natural Assertions
-
-In RSpec, matchers are used to provide nice, readable error messages
-when an assertion is not met. Natural assertions provide
-self-explanatory failure messages for most things without requiring
-any special matchers from the programmer.
-
-In the rare case that some extra information would be helpful, it is
-useful to create special objects that respond to the == operator.
-
-#### Asserting Nearly Equal with Fuzzy Numbers
-
-Operations on floating point numbers rarely create numbers that are
-exactly equal, therefore it is useful to assert that two floating
-point numbers are nearly equal. We do that by creating a fuzzy number
-that has a looser interpretation of what it means to be equal.
-
-For example, the following asserts that the square root of 10 is about
-3.1523 with an accuracy of 1 percent.
-
-```ruby
-    Then { Math.sqrt(10) == about(3.1623).percent(1) }
-```
-
-As long as the real value of <code>Math.sqrt(10)</code> is within plus
-or minus 1% of 3.1623 (i.e. 3.1623 +/- 0.031623), then the assertion
-will pass.
-
-There are several ways of creating fuzzy numbers:
-
-* <code>about(n).delta(d)</code> -- A fuzzy number matching the range
-  (n-d)..(n+d)
-
-* <code>about(n).percent(p)</code> -- A fuzzy number matching the
-  range (n-(n*p/100)) .. (n+(n*p/100))
-
-* <code>about(n).epsilon(neps)</code> -- A fuzzy number matching the
-  range (n-(neps*e)) .. (n+(neps*e)), where e is the difference
-  between 1.0 and the next smallest floating point number.
-
-* <code>about(n)</code> -- Same as <code>about(n).epsilon(10)</code>.
-
-When the file <code>given/fuzzy_shortcuts</code> is required,
-the following unicode shortcut methods are added to Numeric to create
-fuzzy numbers.
-
-* <code>n.±(del)</code> is the same as <code>about(n).delta(del)</code>
-
-* <code>n.‰(percentage)</code> is the same as <code>about(n).percent(percentage)</code>
-
-* <code>n.€(neps)</code> is the same as <code>about(n).epsilon(neps)</code>
-
-* <code>n.±</code>, <code>n.‰</code>, and <code>n.€</code> are all
-  the same as <code>about(n)</code>
-
-#### Detecting Exceptions
-
-The RSpec matcher used for detecting exceptions will work with natural
-assertions out of the box. Just check for equality against the
-<code>Failure()</code> method return value.
-
-For example, the following two Then clauses are equivalent:
-
-```ruby
-    # Using an RSpec matcher
-    Then { result.should have_failed(StandardError, /message/) }
-
-    # Using natural assertions
-    Then { result == Failure(StandardError, /message/) }
-```
-
-### Processing Natural Assertions
-
-When natural assertions are enabled, they are only used if all of the
-following are true:
-
-1. The block does not throw an RSpec assertion failure (or any other
-   exception for that matter).
-
-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 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
-_expect_.
-
-### Platform Support
-
-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 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
-
-Natural assertions were inspired by the [wrong assertion
-library](http://rubygems.org/gems/wrong) by [Alex
-Chaffee](http://rubygems.org/profiles/alexch) and [Steve
-Conover](http://rubygems.org/profiles/sconoversf).
-
-## Configuration
-
-If the RSpec format option document, html or textmate is chosen,
-RSpec/Given will automatically add additional source code information to
-the examples to produce better looking output. If you don't care about
-the pretty output and wish to disable source code caching
-unconditionally, then add the following line to your spec helper file:
-
-```ruby
-    Given.source_caching_disabled = true
-```
-
-Natural assertions are disabled by default. To globally configure
-natural assertions, add one of the following lines to your spec_helper
-file:
-
-```ruby
-    Given.use_natural_assertions         # Enable natural assertions
-    Given.use_natural_assertions true    # Same as above
-    Given.use_natural_assertions false   # Disable natural assertions
-    Given.use_natural_assertions :always # Always process natural assertions
-                                         # ... even when should/expect are detected
-```
-
-# License
-
-rspec-given, minitest-given and given_core are available under the MIT
-License. See the MIT-LICENSE file in the source distribution.
-
-# History
-
-* Version 3.0.0
-
-  * Support for minitest added.
-
-  * Introduced gem given_core to contain the common logic between the
-    RSpec and Minitest versions. Both the rspec-given gem and the
-    minitest-given gem have a dependency on given_core.
-
-  * Natural assertions are now enabled by default.
-
-* Version 2.4.4
-
-  * Support for RSpec 2.13 added.
-
-* Version 2.4.3
-
-  * Better natural assertion messages when dealing with multi-line
-    output.
-
-* Version 2.4.2
-
-  * Minor adjustment to natural assertion error messages to better
-    handle multi-line values.
-
-  * Remove flog, flay and other development tools from the bundle and
-    gemspec. The Rakefile was updated to suggest installing them if
-    they are not there.
-
-* Version 2.4.1
-
-  * Fix bug where constants from nested modules were not properly
-    accessed.
-
-* Version 2.4.0
-
-  * Add fuzzy number helper methods (with unicode method shortcuts).
-
-  * Fix bug caused by blank lines in Thens.
-
-# Links
-
-* Github: [https://github.com/jimweirich/rspec-given](https://github.com/jimweirich/rspec-given)
-* Clone URL: git://github.com/jimweirich/rspec-given.git
-* Bug/Issue Reporting: [https://github.com/jimweirich/rspec-given/issues](https://github.com/jimweirich/rspec-given/issues)
-* Continuous Integration: [http://travis-ci.org/#!/jimweirich/rspec-given](http://travis-ci.org/#!/jimweirich/rspec-given)