rspec-given 3.7.1 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14d0de198be7793a1eba3670e46518ba7d9de736
-  data.tar.gz: 9619a055a17cecbc3709598469e5d1bbc2d958a6
+  metadata.gz: a4b2f4dfa0869eb20c5b477aafd2728f11cc8758
+  data.tar.gz: 832cf482cc2583f05420179b8734d85b89ebadc6
 SHA512:
-  metadata.gz: 407535da7a864a68299417569f2d928c47b59c1de753efbd50cb09f3e026feb5b631911cbc605044b2ee70bb136b777f86022df0d1a5ee757fde5316ea475fdd
-  data.tar.gz: 220105bfddd1b6e413509f72c30846f370296e70fe137244abbb688dbd9a2eec8b97444de13e91ddf7c64d06080fad2c148ba61a36db4705ab50270fdefe48d6
+  metadata.gz: 670739df226ed276d59dd21902994ff4b424481ed996a9e2f166a56e85e6df877f766575f32b431ed289f393ae0b27afb6bafdd98304a1ac30533d687fb53298
+  data.tar.gz: 730d1d3d3a1918c46dca275597377e77c8779058b5d5f2da9bf01d78026940668ec5ef3e7ff73eb2ca326e2450cb3972b6f178b8ddefdf6dee99234b5803a81e

data/Gemfile.lock

@@ -2,21 +2,21 @@ GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
-    minitest (5.7.0)
-    rake (10.4.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.1)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.0)
+    minitest (5.8.3)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.1)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
     sorcerer (1.0.2)
 
 PLATFORMS

data/README.md

@@ -4,7 +4,7 @@
 | :----: |
 | [![Master Build Status](https://secure.travis-ci.org/rspec-given/rspec-given.png?branch=master)](https://travis-ci.org/rspec-given/rspec-given) |
 
-Covering rspec-given, minitest-given, and given-core, version 3.7.0.
+Covering rspec-given, minitest-given, and given-core, version 3.8.0.
 
 rspec-given and minitest-given are extensions to your favorite testing
 framework to allow Given/When/Then notation when writing specs.
@@ -347,6 +347,17 @@ should use an empty _Then_ clause, like this:
     Then { }
 ```
 
+A _Then_ clause accepts arguments for user-defined RSpec metadata:
+
+```ruby
+    Then(:zippy, :foo => 17) { ... }
+```
+
+Metadata on _Then_ clauses is an RSpec-only feature. You can read more about
+metadata [in RSpec's
+documentation](https://www.relishapp.com/rspec/rspec-core/docs/metadata/user-defined-metadata).
+
+
 #### Then examples:
 
 ```ruby
@@ -760,12 +771,13 @@ _expect_.
 
 Given uses the Ripper library to parse the source lines and failing
 conditions to find all the sub-expression values upon a failure.
-Currently Ripper is not supported on Rubinius and versions of JRuby
-prior to JRuby-1.7.5.
 
-If you want to use a version of Ruby that does not support Ripper,
-then natural assertions will disabled. In addition, you should also
-disable source caching in the configuration (see the configuration
+If Ripper is not available, like on Rubinius and versions of JRuby prior to
+JRuby-1.7.5, detailed explanations of failures for natural assertions won't be
+available.  Natural assertions will still work, though.
+
+If you want to use a version of Ruby that does not support Ripper, then you
+should disable source caching in the configuration (see the configuration
 section below).
 
 ### Non-Spec Assertions
@@ -870,6 +882,14 @@ License. See the MIT-LICENSE file in the source distribution.
 
 # History
 
+* Version 3.8.0
+
+  * RSpec metadata can now be added to _Then_ clauses (see [#11](https://github.com/rspec-given/rspec-given/pull/11))
+  * Natural assertions now run on Rubinius and older versions of JRuby (see [#15](https://github.com/rspec-given/rspec-given/issues/15))
+    * WARNING: On these platforms, detailed failure explanations aren't available and source code snippets of Then clauses will only show the first line.
+    * WARNING: Assertions of void statements (e.g. `Then { }`) will fail only under runtimes lacking Ripper support
+  * `Given.ok_to_use_natural_assertions` was removed; the method was never properly supported as public, but it was publicly reachable
+
 * Version 3.7.1
 
   * Mixin Minitest extensions for both ActiveSupport::TestCase (when present) as well as for MiniTest::Spec (see [#8](https://github.com/rspec-given/rspec-given/pulls/8))

data/Rakefile

@@ -67,10 +67,6 @@ EXAMPLES = FileList['examples/**/*_spec.rb', 'examples/use_assertions.rb'].
 
 MT_EXAMPLES = FileList['examples/minitest-rails/**/*_spec.rb', 'examples/minitest/**/*_spec.rb']
 
-unless Given::NATURAL_ASSERTIONS_SUPPORTED
-  EXAMPLES.exclude("examples/stack/*.rb")
-end
-
 FAILING_EXAMPLES = FileList['examples/failing/**/*_spec.rb']
 
 desc "Run the RSpec specs and examples"

data/examples/integration/failing_messages_spec.rb

@@ -2,24 +2,28 @@ require 'example_helper'
 require 'open3'
 
 describe "Failing Messages" do
-  use_natural_assertions_if_supported
-
   IOS = Struct.new(:out, :err)
 
   def run_spec(filename)
-    inn, out, err, wait = Open3.popen3("rspec", "examples/integration/failing/#{filename}")
+    _inn, out, err, _wait = Open3.popen3(
+      "rspec", "examples/integration/failing/#{filename}",
+      # Ensure our `project_source_dirs` config is set when we shell out to RSpec.
+      "-rexample_helper"
+    )
     IOS.new(out.read, err.read)
   end
 
   When(:ios) { run_spec(failing_test) }
 
   context "when referencing constants from nested modules" do
+    skip_natural_assertions_if_not_supported
     Given(:failing_test) { "module_nesting_spec.rb" }
     Then { ios.err == "" }
     And { ios.out !~ /uninitialized constant RSpec::Given::InstanceExtensions::X/ }
   end
 
   context "when referencing undefined methods" do
+    skip_natural_assertions_if_not_supported
     Given(:failing_test) { "undefined_method_spec.rb" }
     Then { ios.err == "" }
     And { complains_xyz_is_not_in_scope?(ios.out) }
@@ -35,6 +39,7 @@ describe "Failing Messages" do
   end
 
   context "when breaking down expressions" do
+    skip_natural_assertions_if_not_supported
     Given(:failing_test) { "eval_subexpression_spec.rb" }
     Then { ios.err == "" }
     And  { ios.out =~ /false *<- array\[index\]\.upcase == value$/ }
@@ -51,8 +56,9 @@ describe "Failing Messages" do
   end
 
   context "with an oddly formatted then" do
+    skip_natural_assertions_if_not_supported
     Given(:failing_test) { "oddly_formatted_then.rb" }
-    Then { ios.out =~ /Failure\/Error: Then \{ result == \['a',$/ }
+    Then { ios.out =~ /Failure\/Error:\s*Then \{ result == \['a',$/ }
     And  { ios.out =~ /expected: "anything"/ }
     And  { ios.out =~ /to equal: \["a", "a"\]/ }
   end

data/examples/integration/then_spec.rb

@@ -11,11 +11,10 @@ end
 
 describe "Then" do
   context "empty thens with natural assertions" do
-    use_natural_assertions_if_supported
+    skip_natural_assertions_if_not_supported #<--we can't detect void statements
     Then { }
   end
   context "thens to_bool/true will pass" do
-    use_natural_assertions_if_supported
     Then { ToBool.new(true) }
   end
 end

data/examples/minitest_helper.rb

@@ -1,4 +1,3 @@
-
 module GivenAssertions
   def given_assert(cond)
     assert cond
@@ -23,13 +22,9 @@ module GivenAssertions
 end
 
 module NaturalAssertionControl
-  def use_natural_assertions_if_supported(enabled=true)
-    if enabled && ! Given::NATURAL_ASSERTIONS_SUPPORTED
-      Given {
-        skip "Natural assertions are not supported in JRuby"
-      }
-    else
-      use_natural_assertions(enabled)
+  def skip_natural_assertions_if_not_supported
+    if !Given::NATURAL_ASSERTIONS_SUPPORTED
+      Given { skip "This test requires a Ruby runtime with full natural assertions support." }
     end
   end
 end

data/examples/use_assertions.rb

@@ -1,47 +1,44 @@
 require 'given/module_methods'
 
-if Given::NATURAL_ASSERTIONS_SUPPORTED
+require 'given/assertions'
+require 'given/fuzzy_number'
 
-  require 'given/assertions'
-  require 'given/fuzzy_number'
+include Given::Assertions
+include Given::Fuzzy
 
-  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(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 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 use_assert(n)
+  Assert { n == 1 }
+end
 
-  def should_fail
-    begin
-      yield
-      fail "Expected error"
-    rescue Given::Assertions::AssertError => ex
-      true
-    end
+def should_fail
+  begin
+    yield
+    fail "Expected error"
+  rescue Given::Assertions::AssertError => ex
+    true
   end
+end
 
-  sqrt(1)
-  sqrt(2)
-  sqrt(0)
+sqrt(1)
+sqrt(2)
+sqrt(0)
 
-  should_fail { sqrt(-1) }
-  should_fail { sqrt_bad_postcondition(1) }
+should_fail { sqrt(-1) }
+should_fail { sqrt_bad_postcondition(1) }
 
-  use_assert(1)
-  should_fail { use_assert(0) }
-end
+use_assert(1)
+should_fail { use_assert(0) }

data/spec/lib/given/assertions_spec.rb

@@ -3,8 +3,6 @@ require 'rspec/given'
 require 'given/assertions'
 
 describe Given::Assertions do
-  use_natural_assertions_if_supported
-
   Given { extend Given::Assertions }
 
   describe "Assert { }" do

data/spec/lib/given/ext/numeric_spec.rb

@@ -4,7 +4,6 @@ require 'given'
 require 'given/fuzzy_shortcuts'
 
 describe "Numeric Extensions" do
-  use_natural_assertions_if_supported
 
   Given(:n) { 10 }
   Given(:about_n) { about(n) }

data/spec/lib/given/ext/numeric_specifications.rb

@@ -4,7 +4,6 @@ require 'rspec/given'
 require 'rspec/given/fuzzy_shortcuts'
 
 describe "Numeric Extensions" do
-  use_natural_assertions_if_supported
 
   Given(:n) { 10 }
   Given(:about_n) { about(n) }

data/spec/lib/given/extensions_spec.rb

@@ -187,18 +187,25 @@ describe Given::ClassExtensions do
     And { expect(trace).to eq([:given, :then, :and]) }
   end
 
+  describe "Adding metadata to Then & And (RSpec 2+)" do
+    Given(:test) { RSpec.respond_to?(:current_example) ? RSpec.method(:current_example) : method(:example) }
+    Then(:key => :val) { test.call.metadata[:key] == :val }
+    And { test.call.metadata[:key] == :val }
+
+    if rspec_3_or_later?
+      describe "Supporting default-to-true metadata symbols (RSpec 3 only)" do
+        Then(:magic, :foo => :bar) { test.call.metadata[:magic] == true }
+        And { test.call.metadata[:foo] == :bar }
+      end
+    end
+
+  end
 end
 
 describe "use_natural_assertions" do
-  context "when in JRuby" do
-    CONTEXT = self
+  CONTEXT = self
 
-    When(:result) { CONTEXT.use_natural_assertions }
+  When(:result) { CONTEXT.use_natural_assertions }
 
-    if ::Given::NATURAL_ASSERTIONS_SUPPORTED
-      Then { expect(result).to_not have_failed }
-    else
-      Then { expect(result).to have_failed(ArgumentError) }
-    end
-  end
+  Then { expect(result).to_not have_failed }
 end

data/spec/lib/given/failure_matcher_spec.rb

@@ -8,7 +8,6 @@ module FailureMatcherSpec
   NotMetError = RSpec::Expectations::ExpectationNotMetError
 
   describe Given::FailureMatcher do
-    use_natural_assertions_if_supported
 
     Given(:error) { CustomError.new("CUSTOM") }
 

data/spec/lib/given/failure_spec.rb

@@ -27,21 +27,18 @@ 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 "== 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(other_error) }
   end

data/spec/lib/given/fuzzy_number_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Given::Fuzzy::FuzzyNumber do
-  use_natural_assertions_if_supported
   include Given::Fuzzy
 
   describe "attributes" do

data/spec/lib/given/have_failed_spec.rb

@@ -61,7 +61,6 @@ module HaveFailedSpec
     end
 
     context "with natural assertions" do
-      use_natural_assertions_if_supported
 
       context "with failure" do
         When(:result) { fail CustomError, "Ouch" }

data/spec/lib/given/lexical_purity_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 LEXICAL_PURITY_GLOBAL_CONSTANT = 3
 
 describe "Lexical Purity" do
-  use_natural_assertions_if_supported
 
   A = 1
   Given(:avalue) { 1 }

data/spec/lib/given/line_extractor_spec.rb

@@ -44,6 +44,7 @@ module Given
     end
 
     context "when the Then is split over several lines with {}" do
+      skip_natural_assertions_if_not_supported
       Given(:input) {
         "describe 'foobar' do\n" +
         "  Then {\n" +
@@ -55,6 +56,7 @@ module Given
     end
 
     context "when the Then is has blank lines" do
+      skip_natural_assertions_if_not_supported
       Given(:input) {
         "describe 'foobar' do\n" +
         "  Then {\n\n" +
@@ -66,6 +68,7 @@ module Given
     end
 
     context "when the Then is split over several lines with do/end" do
+      skip_natural_assertions_if_not_supported
       Given(:input) {
         "describe 'foobar' do\n" +
         "  Then do\n" +
@@ -77,6 +80,7 @@ module Given
     end
 
     context "when the Then is oddly formatted" do
+      skip_natural_assertions_if_not_supported
       Given(:input) {
         "describe 'foobar' do\n" +
         "  Then { result == ['a',\n" +

data/spec/lib/given/module_methods_spec.rb

@@ -1,13 +1,7 @@
 require 'spec_helper'
 
 describe "RSpec::Given.use_natural_assertions" do
-  context "when in JRuby" do
-    When(:result) { ::Given.use_natural_assertions }
+  When(:result) { ::Given.use_natural_assertions }
 
-    if ::Given::NATURAL_ASSERTIONS_SUPPORTED
-      Then { expect(result).to_not have_failed }
-    else
-      Then { expect(result).to have_failed(ArgumentError) }
-    end
-  end
+  Then { expect(result).to_not have_failed }
 end

data/spec/lib/given/natural_assertion_spec.rb

@@ -1,13 +1,19 @@
 require 'rspec/given'
 require 'spec_helper'
 
-describe Given::NaturalAssertion do
-  before do
-    pending "Natural Assertions disabled for JRuby" unless Given::NATURAL_ASSERTIONS_SUPPORTED
+describe Given::NATURAL_ASSERTIONS_SUPPORTED do
+  if (defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx') || (defined?(JRUBY_VERSION) &&
+      Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('1.7.5'))
+    Then { Given::NATURAL_ASSERTIONS_SUPPORTED == false }
+  else
+    Then { Given::NATURAL_ASSERTIONS_SUPPORTED == true }
   end
+end
 
+describe Given::NaturalAssertion do
   describe "#content?" do
     context "with empty block" do
+      skip_natural_assertions_if_not_supported
       FauxThen { }
       Then { expect(na).to_not have_content }
     end
@@ -42,6 +48,7 @@ describe Given::NaturalAssertion do
   end
 
   describe "failure messages" do
+    skip_natural_assertions_if_not_supported
     let(:msg) { na.message }
     Invariant { expect(msg).to match(/^FauxThen expression/) }
 
@@ -167,7 +174,11 @@ describe Given::NaturalAssertion do
         ary[1] == 3
       }
       When(:result) { na.message }
-      Then { expect(result).to have_failed(Given::InvalidThenError, /multiple.*statements/i) }
+      if Given::NATURAL_ASSERTIONS_SUPPORTED
+        Then { expect(result).to have_failed(Given::InvalidThenError, /multiple.*statements/i) }
+      else
+        Then { expect(result).to match(/FauxThen expression failed/) }
+      end
     end
 
   end

data/spec/lib/given/options_spec.rb

@@ -24,12 +24,6 @@ describe "Configuration Options" do
   end
 
   describe "Global natural assertion configuration" do
-    unless Given::NATURAL_ASSERTIONS_SUPPORTED
-      before do
-        pending "Natural assertions are not supported in JRuby"
-      end
-    end
-
     before do
       Given.use_natural_assertions false
     end
@@ -46,7 +40,7 @@ describe "Configuration Options" do
       Then { expect(_gvn_need_na_message?(nassert)).to be_falsy }
 
       context "overridden locally" do
-        use_natural_assertions_if_supported
+        use_natural_assertions
         Then { expect(_gvn_need_na_message?(nassert)).to be_truthy }
       end
     end
@@ -120,7 +114,7 @@ describe "Configuration Options" do
       Then { expect(_gvn_need_na_message?(nassert)).to be_falsy }
 
       context "overridden locally" do
-        use_natural_assertions_if_supported(true)
+        use_natural_assertions
         Then { expect(_gvn_need_na_message?(nassert)).to be_truthy }
       end
 

data/spec/spec_helper.rb

@@ -1,4 +1,12 @@
 require 'rspec/given'
+RSpec.configure do |config|
+  # Before RSpec 3.4, RSpec would only print lines in failures from spec files.
+  # Starting in 3.4, it now prints lines from the new `project_source_dirs` config
+  # setting. We want it to print lines from our specs instead of printing
+  # `::RSpec::Expectations.fail_with(*args)` from within lib/given/rspec/framework.rb,
+  # so we remove `lib` from the directories here.
+  config.project_source_dirs -= ["lib"] if config.respond_to?(:project_source_dirs)
+end
 
 # Load the support modules.
 
@@ -26,3 +34,7 @@ end
 def given_assert_raises(error, pattern=nil, &block)
   expect(&block).to raise_error(error, pattern)
 end
+
+def rspec_3_or_later?
+  Gem::Version.new(RSpec::Version::STRING).segments[0] >= 3
+end

data/spec/support/natural_assertion_control.rb

@@ -1,15 +1,9 @@
 module NaturalAssertionControl
-  def use_natural_assertions_if_supported(enabled=true)
-    if enabled && ! Given::NATURAL_ASSERTIONS_SUPPORTED
-      Given {
-        pending "Natural assertions are not supported in JRuby"
-      }
-    else
-      use_natural_assertions(enabled)
+  def skip_natural_assertions_if_not_supported
+    if !Given::NATURAL_ASSERTIONS_SUPPORTED
+      Given { pending "This test requires a Ruby runtime with full natural assertions support." }
     end
   end
 end
 
-RSpec.configure do |c|
-  c.extend(NaturalAssertionControl)
-end
+RSpec.configure { |c| c.extend(NaturalAssertionControl) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-given
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.8.0
 platform: ruby
 authors:
 - Jim Weirich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2016-01-14 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.7.1
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.7.1
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: given
-rubygems_version: 2.2.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Given/When/Then Specification Extensions for RSpec.