rspec-given 3.0.0.beta.3 → 3.0.0.beta.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 526253bf084bd3ed7a442a2dc8a2e5049f62dc76
-  data.tar.gz: 5bcbfbda442a3588713463696a3ac9994de455f9
+  metadata.gz: 5ca5bc4ebba5ec0c35f8d71a594441d748f8a7d4
+  data.tar.gz: a70613b7f9b6dacdbab6c5b9bd88e1d73d7d07e8
 SHA512:
-  metadata.gz: 73e39a4a291dff30c8692cb19dca897acbb7cdcf02ef2b363948bc864d4b3d8bcea29cfb1bd3aa7df760700dc89f9637877b42cf95643d32c7fdcacb9dae399b
-  data.tar.gz: c33ee265c7a6f7c7ce6325607b836cad9d87766ff6801c55b2933587b6efcc298a2a6b8152df41986a0b28fee39c7561da8fe71cb270f121225697650b952701
+  metadata.gz: 09fe70ee6a76b187e6f3aa583bc5bb02faac92571ef7ae80ecfcf7c018b12f89b10f7c18508e01d4425ab888b9ead56abf5644b1ca2d967c6cc01860e82b1762
+  data.tar.gz: 1311f64f6f5db5514281cd43540053bb6b0e28554bf95489b56f96b0bc74271e09bbea217277dbf54a13d9b426e1d3b1cf60a0c9a4013f8847da43582081d6b0

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/examples/loader.rb

@@ -1,4 +1,3 @@
 ARGV.each do |fn|
-  puts "Loading #{fn} ..."
   load fn
 end

data/examples/minitest/assert_raises_spec.rb

@@ -0,0 +1,25 @@
+require 'minitest/given'
+require 'minitest/autorun'
+
+describe "stacks" do
+  context "when it fails" do
+    When(:result) { fail StandardError, "Oops" }
+
+    Then { result.must_raise(StandardError, /oops/i) }
+    Then {
+      assert_raises(StandardError, /oops/i) do
+        result.die
+      end
+    }
+    Then { result == Failure() }
+    Then { result == Failure(StandardError) }
+  end
+
+  context "when it does not fail" do
+    When(:result) { :ok }
+
+    Then { result != Failure() }
+    Then { result != Failure(StandardError) }
+  end
+
+end

data/spec/lib/given/evaluator_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe "Environmental Access" do
+  use_natural_assertions false
   X = 1
   Given(:a) { 2 }
   FauxThen { X + a }
@@ -14,6 +15,7 @@ end
 module Nested
   X = 1
   describe "Environmental Access with Nested modules" do
+    use_natural_assertions false
     Given(:a) { 2 }
     FauxThen { X + a }
     Then { block_result.should == 3 }
@@ -24,6 +26,7 @@ module Nested
 end
 
 describe "Evaluator with error object" do
+  use_natural_assertions false
   FauxThen { 1 }
   When(:result) { ev.eval_string("fail 'XYZ'") }
   Then { result.class.should == Given::EvalErr }

data/spec/lib/given/failure_matcher_spec.rb

@@ -8,6 +8,8 @@ module FailureMatcherSpec
   NotMetError = RSpec::Expectations::ExpectationNotMetError
 
   describe Given::FailureMatcher do
+    use_natural_assertions_if_supported
+
     Given(:error) { CustomError.new("CUSTOM") }
 
     Given(:failure_result) { Given::Failure.new(error) }
@@ -65,13 +67,17 @@ module FailureMatcherSpec
     end
 
     describe "==" do
-      Then { failure_result == Failure(CustomError) }
+      Then { failure_result       == Failure() }
+      Then { failure_result       == Failure(CustomError) }
+      Then { Failure()            == failure_result }
       Then { Failure(CustomError) == failure_result }
     end
 
     describe "!=" do
       Then { failure_result != Failure(SubError) }
-      Then { Failure(SubError) == failure_result }
+      Then { Failure(SubError) != failure_result }
+      Then { Failure() != nil }
+      Then { nil != Failure() }
     end
   end
 end

data/spec/lib/given/failure_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 require 'given/failure'
 
 describe Given::Failure do
-  OtherError = Class.new(StandardError)
+  Given(:other_error) { Class.new(StandardError) }
+  Given(:custom_error) { Class.new(StandardError) }
 
   Given(:exception) { StandardError.new("Oops") }
   Given(:failure) { Given::Failure.new(exception) }
@@ -26,24 +27,23 @@ describe Given::Failure do
   end
 
   describe "== have_failed" do
+    use_natural_assertions_if_supported
     Then { failure == have_failed(StandardError, "Oops") }
     Then { failure == have_failed(StandardError) }
     Then { failure == have_failed }
   end
 
-  describe "!= have_failed" do
-    Then { failure != have_failed() }
-  end
-
   describe "== Failure" do
+    use_natural_assertions_if_supported
     Then { failure == Failure(StandardError, "Oops") }
     Then { failure == Failure(StandardError) }
     Then { failure == Failure() }
   end
 
   describe "!= Failure" do
+    use_natural_assertions_if_supported
     Then { expect { failure != Object.new }.to raise_error(StandardError) }
-    Then { failure != Failure() }
+    Then { failure != Failure(other_error) }
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-given
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.3
+  version: 3.0.0.beta.4
 platform: ruby
 authors:
 - Jim Weirich
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta.3
+        version: 3.0.0.beta.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta.3
+        version: 3.0.0.beta.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +91,7 @@ files:
 - examples/integration/invariant_spec.rb
 - examples/integration/then_spec.rb
 - examples/loader.rb
+- examples/minitest/assert_raises_spec.rb
 - examples/minitest_helper.rb
 - examples/other/line_example.rb
 - examples/stack/stack.rb