opal-rspec 0.8.0.alpha3 → 1.0.0.alpha1

data/rspec-expectations/upstream/features/custom_matchers/define_matcher.feature

@@ -1,9 +1,10 @@
-Feature: define matcher
+Feature: Define a custom matcher
 
-  rspec-expectations provides a DSL for defining custom matchers. These are often useful for
-  expressing expectations in the domain of your application.
+  rspec-expectations provides a DSL for defining custom matchers. These are often useful for expressing expectations in the domain of your application.
 
-  Scenario: define a matcher with default messages
+  Behind the scenes `RSpec::Matchers.define` evaluates the `define` block in the context of a singleton class. If you need to write a more complex matcher and would like to use the `Class`-approach yourself, please head over to our `API`-documentation and read [the docs](http://rspec.info/documentation/latest/rspec-expectations/RSpec/Matchers/MatcherProtocol.html) about the `MatcherProtocol`.
+
+  Scenario: Define a matcher with default messages
     Given a file named "matcher_with_default_message_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -35,8 +36,8 @@ Feature: define matcher
     When I run `rspec ./matcher_with_default_message_spec.rb --format documentation`
     Then the exit status should not be 0
 
-    And the output should contain "should be a multiple of 3"
-    And the output should contain "should not be a multiple of 4"
+    And the output should contain "is expected to be a multiple of 3"
+    And the output should contain "is expected not to be a multiple of 4"
     And the output should contain "Failure/Error: it { is_expected.to be_a_multiple_of(4) }"
     And the output should contain "Failure/Error: it { is_expected.not_to be_a_multiple_of(3) }"
 
@@ -44,7 +45,7 @@ Feature: define matcher
     And the output should contain "expected 9 to be a multiple of 4"
     And the output should contain "expected 9 not to be a multiple of 3"
 
-  Scenario: overriding the failure_message
+  Scenario: Overriding the failure_message
     Given a file named "matcher_with_failure_message_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -68,7 +69,7 @@ Feature: define matcher
     And the stdout should contain "1 example, 1 failure"
     And the stdout should contain "expected that 9 would be a multiple of 4"
 
-  Scenario: overriding the failure_message_when_negated
+  Scenario: Overriding the failure_message_when_negated
     Given a file named "matcher_with_failure_for_message_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -92,7 +93,7 @@ Feature: define matcher
     And the stdout should contain "1 example, 1 failure"
     And the stdout should contain "expected that 9 would not be a multiple of 3"
 
-  Scenario: overriding the description
+  Scenario: Overriding the description
     Given a file named "matcher_overriding_description_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -117,10 +118,10 @@ Feature: define matcher
     When I run `rspec ./matcher_overriding_description_spec.rb --format documentation`
     Then the exit status should be 0
     And the stdout should contain "2 examples, 0 failures"
-    And the stdout should contain "should be multiple of 3"
-    And the stdout should contain "should not be multiple of 4"
+    And the stdout should contain "is expected to be multiple of 3"
+    And the stdout should contain "is expected not to be multiple of 4"
 
-  Scenario: with no args
+  Scenario: With no args
     Given a file named "matcher_with_no_args_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -142,9 +143,9 @@ Feature: define matcher
     When I run `rspec ./matcher_with_no_args_spec.rb --format documentation`
     Then the exit status should be 0
     And the stdout should contain "1 example, 0 failures"
-    And the stdout should contain "should have 7 fingers"
+    And the stdout should contain "is expected to have 7 fingers"
 
-  Scenario: with multiple args
+  Scenario: With multiple args
     Given a file named "matcher_with_multiple_args_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -162,9 +163,31 @@ Feature: define matcher
     When I run `rspec ./matcher_with_multiple_args_spec.rb --format documentation`
     Then the exit status should be 0
     And the stdout should contain "1 example, 0 failures"
-    And the stdout should contain "should be the sum of 1, 2, 3, and 4"
+    And the stdout should contain "is expected to be the sum of 1, 2, 3, and 4"
+
+  Scenario: With a block arg
+    Given a file named "matcher_with_block_arg_spec.rb" with:
+      """ruby
+      require 'rspec/expectations'
+
+      RSpec::Matchers.define :be_lazily_equal_to do
+        match do |obj|
+          obj == block_arg.call
+        end
+
+        description { "be lazily equal to #{block_arg.call}" }
+      end
+
+      RSpec.describe 10 do
+        it { is_expected.to be_lazily_equal_to { 10 } }
+      end
+      """
+    When I run `rspec ./matcher_with_block_arg_spec.rb --format documentation`
+    Then the exit status should be 0
+    And the stdout should contain "1 example, 0 failures"
+    And the stdout should contain "is expected to be lazily equal to 10"
 
-  Scenario: with helper methods
+  Scenario: With helper methods
     Given a file named "matcher_with_internal_helper_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -189,7 +212,7 @@ Feature: define matcher
     Then the exit status should be 0
     And the stdout should contain "1 example, 0 failures"
 
-  Scenario: scoped in a module
+  Scenario: Scoped in a module
     Given a file named "scoped_matcher_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -221,7 +244,7 @@ Feature: define matcher
     When I run `rspec ./scoped_matcher_spec.rb`
     Then the stdout should contain "2 examples, 0 failures"
 
-  Scenario: scoped in an example group
+  Scenario: Scoped in an example group
     Given a file named "scoped_matcher_spec.rb" with:
       """ruby
       require 'rspec/expectations'
@@ -254,7 +277,7 @@ Feature: define matcher
     When I run `rspec scoped_matcher_spec.rb`
     Then the output should contain "3 examples, 0 failures"
 
-  Scenario: matcher with separate logic for should and should_not
+  Scenario: Matcher with separate logic for expect().to and expect().not_to
     Given a file named "matcher_with_separate_should_not_logic_spec.rb" with:
       """ruby
       RSpec::Matchers.define :contain do |*expected|
@@ -282,7 +305,7 @@ Feature: define matcher
       | expected [1, 2, 3] to contain 1 and 4     |
       | expected [1, 2, 3] not to contain 1 and 4 |
 
-  Scenario: use define_method to create a helper method with access to matcher params
+  Scenario: Use define_method to create a helper method with access to matcher params
     Given a file named "define_method_spec.rb" with:
       """ruby
       RSpec::Matchers.define :be_a_multiple_of do |expected|
@@ -307,7 +330,7 @@ Feature: define matcher
       | expected 9 to be a multiple of 2     |
       | expected 9 not to be a multiple of 3 |
 
-  Scenario: include a module with helper methods in the matcher
+  Scenario: Include a module with helper methods in the matcher
     Given a file named "include_module_spec.rb" with:
       """ruby
       module MatcherHelpers
@@ -335,3 +358,132 @@ Feature: define matcher
       | 4 examples, 2 failures               |
       | expected 9 to be a multiple of 2     |
       | expected 9 not to be a multiple of 3 |
+
+  Scenario: Using values_match? to compare values and/or compound matchers.
+
+    Given a file named "compare_values_spec.rb" with:
+      """ruby
+      RSpec::Matchers.define :have_content do |expected|
+        match do |actual|
+          # The order of arguments is important for `values_match?`, e.g.
+          # especially if your matcher should handle `Regexp`-objects
+          # (`/regex/`): First comes the `expected` value, second the `actual`
+          # one.
+          values_match? expected, actual
+        end
+      end
+
+      RSpec.describe 'a' do
+        it { is_expected.to have_content 'a' }
+      end
+
+      RSpec.describe 'a' do
+        it { is_expected.to have_content /a/ }
+      end
+
+      RSpec.describe 'a' do
+        it { is_expected.to have_content a_string_starting_with('a') }
+      end
+      """
+    When I run `rspec ./compare_values_spec.rb --format documentation`
+    Then the exit status should be 0
+
+  Scenario: Error handling
+
+    Make sure your matcher returns either `true` or `false`. Take care to handle exceptions appropriately in your matcher, e.g. most cases you might want your matcher to return `false` if an exception - e.g. ArgumentError - occures, but there might be edge cases where you want to pass the exception to the user.
+
+    You should handle each `StandardError` with care! Do not handle them all in one.
+
+    ```ruby
+    match do |actual|
+      begin
+        '[...] Some code'
+      rescue ArgumentError
+        false
+      end
+    end
+    ```
+
+    Given a file named "error_handling_spec.rb" with:
+      """ruby
+      class CustomClass; end
+
+      RSpec::Matchers.define :is_lower_than do |expected|
+        match do |actual|
+          begin
+            actual < expected
+          rescue ArgumentError
+            false
+          end
+        end
+      end
+
+      RSpec.describe 1 do
+        it { is_expected.to is_lower_than 2 }
+      end
+
+      RSpec.describe 1 do
+        it { is_expected.not_to is_lower_than 'a' }
+      end
+
+      RSpec.describe CustomClass do
+        it { expect { is_expected.not_to is_lower_than 2 }.to raise_error NoMethodError }
+      end
+
+      """
+    When I run `rspec ./error_handling_spec.rb --format documentation`
+    Then the exit status should be 0
+
+  Scenario: Define aliases for your matcher
+
+    If you want your matcher to be readable in different contexts, you can use the `.alias_matcher`-method to provide an alias for your matcher.
+
+    Given a file named "alias_spec.rb" with:
+      """ruby
+      RSpec::Matchers.define :be_a_multiple_of do |expected|
+        match do |actual|
+          actual % expected == 0
+        end
+      end
+
+      RSpec::Matchers.alias_matcher :be_n_of , :be_a_multiple_of
+
+      RSpec.describe 9 do
+        it { is_expected.to be_n_of(3) }
+      end
+      """
+    When I run `rspec ./alias_spec.rb --format documentation`
+    Then the exit status should be 0
+
+  Scenario: With expectation errors that bubble up
+
+    By default the match block will swallow expectation errors (e.g. caused by using an expectation such as `expect(1).to eq 2`), if you wish to allow these to bubble up, pass in the option `:notify_expectation_failures => true`.
+
+    Given a file named "bubbling_expectation_errors_spec.rb" with:
+      """ruby
+      RSpec::Matchers.define :be_a_palindrome do
+        match(:notify_expectation_failures => true) do |actual|
+          expect(actual).to be_a(String)
+          expect(actual.reverse).to eq(actual)
+        end
+      end
+
+      RSpec.describe "a custom matcher that bubbles up expectation errors" do
+        it "bubbles expectation errors" do
+          expect("carriage").to be_a_palindrome
+        end
+      end
+      """
+    When I run `rspec bubbling_expectation_errors_spec.rb`
+    Then the output should contain all of these:
+      | Failures:                                                                           |
+
+      |   1) a custom matcher that bubbles up expectation errors bubbles expectation errors |
+      |      Failure/Error: expect(actual.reverse).to eq(actual)                            |
+
+      |        expected: "carriage"                                                         |
+      |             got: "egairrac"                                                         |
+
+      |        (compared using ==)                                                          |
+      |      # ./bubbling_expectation_errors_spec.rb:4                                      |
+      |      # ./bubbling_expectation_errors_spec.rb:10                                     |

data/rspec-expectations/upstream/features/custom_matchers/define_matcher_with_fluent_interface.feature

@@ -21,7 +21,26 @@ Feature: define matcher with fluent interface
       """
     When I run `rspec between_spec.rb --format documentation`
     Then the output should contain "1 example, 0 failures"
-    And  the output should contain "should be bigger than 4"
+    And  the output should contain "is expected to be bigger than 4"
+
+  Scenario: chained setter
+    Given a file named "between_spec.rb" with:
+      """ruby
+      RSpec::Matchers.define :be_bigger_than do |first|
+        match do |actual|
+          (actual > first) && (actual < second)
+        end
+
+        chain :and_smaller_than, :second
+      end
+
+      RSpec.describe 5 do
+        it { is_expected.to be_bigger_than(4).and_smaller_than(6) }
+      end
+      """
+    When I run `rspec between_spec.rb --format documentation`
+    Then the output should contain "1 example, 0 failures"
+    And  the output should contain "is expected to be bigger than 4"
 
     Scenario: include_chain_clauses_in_custom_matcher_descriptions configured to true, and chained method with argument
       Given a file named "between_spec.rb" with:
@@ -48,4 +67,4 @@ Feature: define matcher with fluent interface
         """
       When I run `rspec between_spec.rb --format documentation`
       Then the output should contain "1 example, 0 failures"
-      And  the output should contain "should be bigger than 4 and smaller than 6"
+      And  the output should contain "is expected to be bigger than 4 and smaller than 6"

data/rspec-expectations/upstream/features/define_negated_matcher.feature

@@ -3,6 +3,7 @@ Feature: Define negated matcher
   You can use `RSpec::Matchers.define_negated_matcher` to define a negated version of
   an existing matcher. This is particularly useful in composed matcher expressions.
 
+  @skip-when-ripper-unsupported
   Scenario: Composed negated matcher expression
     Given a file named "composed_negated_expression_spec.rb" with:
       """ruby
@@ -26,4 +27,4 @@ Feature: Define negated matcher
       | 2 examples, 1 failure                                                                                  |
       |  1) A negated matcher provides a good failure message based on the name                                |
       |     Failure/Error: expect { list.delete(1) }.to change { list }.to(an_array_excluding 5)               |
-      |       expected result to have changed to an array excluding 5, but is now [2, 3, 4, 5, 6, 7, 8, 9, 10] |
+      |       expected `list` to have changed to an array excluding 5, but is now [2, 3, 4, 5, 6, 7, 8, 9, 10] |

data/rspec-expectations/upstream/features/diffing.feature

@@ -32,7 +32,35 @@ Feature: diffing
                   string
       """
 
-  Scenario: diff for a multiline string and a regexp
+  @skip-when-diff-lcs-1.3
+  Scenario: diff for a multiline string and a regexp on diff-lcs 1.4
+    Given a file named "example_spec.rb" with:
+      """ruby
+      RSpec.describe "a multiline string" do
+        it "is like another string" do
+          expected = /expected/m
+          actual = <<-ACTUAL
+      this is the
+        actual
+          string
+      ACTUAL
+          expect(actual).to match expected
+        end
+      end
+      """
+    When I run `rspec example_spec.rb`
+    Then the output should contain:
+      """
+             Diff:
+             @@ -1,3 +1,5 @@
+             -/expected/m
+             +this is the
+             +  actual
+             +    string
+      """
+
+  @skip-when-diff-lcs-1.4
+  Scenario: diff for a multiline string and a regexp on diff-lcs 1.3
     Given a file named "example_spec.rb" with:
       """ruby
       RSpec.describe "a multiline string" do

data/rspec-expectations/upstream/features/implicit_docstrings.feature

@@ -23,15 +23,15 @@ Feature: implicit docstrings
 
     When I run `rspec ./implicit_docstrings_spec.rb -fdoc`
 
-    Then the output should contain "should be < 5"
-    And the output should contain "should include 2"
-    And the output should contain "should respond to #size"
+    Then the output should contain "is expected to be < 5"
+    And the output should contain "is expected to include 2"
+    And the output should contain "is expected to respond to #size"
 
   Scenario: run failing examples
     Given a file named "failing_implicit_docstrings_spec.rb" with:
     """ruby
     RSpec.describe "Failing examples with no descriptions" do
-      # description is auto-generated as "to equal(5)" based on the last #expect
+      # description is auto-generated per the last executed expectation
       specify do
         expect(3).to equal(2)
         expect(5).to equal(5)
@@ -45,7 +45,7 @@ Feature: implicit docstrings
 
     When I run `rspec ./failing_implicit_docstrings_spec.rb -fdoc`
 
-    Then the output should contain "should equal 2"
-    And the output should contain "should be > 5"
-    And the output should contain "should include 4"
-    And the output should contain "should not respond to #size"
+    Then the output should contain "is expected to equal 2"
+    And the output should contain "is expected to be > 5"
+    And the output should contain "is expected to include 4"
+    And the output should contain "is expected not to respond to #size"

data/rspec-expectations/upstream/features/step_definitions/additional_cli_steps.rb

@@ -1,22 +1,26 @@
 # Useful for when the output is slightly different on different versions of ruby
 Then /^the output should contain "([^"]*)" or "([^"]*)"$/ do |string1, string2|
-  unless [string1, string2].any? { |s| all_output =~ regexp(s) }
-    fail %Q{Neither "#{string1}" or "#{string2}" were found in:\n#{all_output}}
+  unless [string1, string2].any? { |s| all_output.include?(s) }
+    fail %(Neither "#{string1}" or "#{string2}" were found in:\n#{all_output})
   end
 end
 
 Then /^the output should contain all of these:$/ do |table|
   table.raw.flatten.each do |string|
-    assert_partial_output(string, all_output)
+    if RUBY_VERSION == '1.8.7' && string =~ /\{.+=>.+\}/
+      warn "Skipping checking #{string} on 1.8.7 because hash ordering is not consistent"
+    else
+      expect(all_output).to include_output_string string
+    end
   end
 end
 
 Then /^the example(?:s)? should(?: all)? pass$/ do
-  step %q{the output should contain "0 failures"}
-  step %q{the exit status should be 0}
+  step 'the output should contain "0 failures"'
+  step 'the exit status should be 0'
 end
 
 Then /^the example should fail$/ do
-  step %q{the output should contain "1 failure"}
-  step %q{the exit status should not be 0}
+  step 'the output should contain "1 failure"'
+  step 'the exit status should not be 0'
 end

data/rspec-expectations/upstream/features/support/diff_lcs_versions.rb

@@ -0,0 +1,25 @@
+require 'diff-lcs'
+
+Around "@skip-when-diff-lcs-1.4" do |scenario, block|
+  if Diff::LCS::VERSION >= '1.4'
+    skip_this_scenario "Skipping scenario #{scenario.name} on `diff-lcs` v#{Diff::LCS::VERSION}"
+  else
+    block.call
+  end
+end
+
+Around "@skip-when-diff-lcs-1.4.3" do |scenario, block|
+  if Diff::LCS::VERSION =~ /1\.4\.3/
+    skip_this_scenario "Skipping scenario #{scenario.name} on `diff-lcs` v#{Diff::LCS::VERSION}"
+  else
+    block.call
+  end
+end
+
+Around "@skip-when-diff-lcs-1.3" do |scenario, block|
+  if Diff::LCS::VERSION < '1.4'
+    skip_this_scenario "Skipping scenario #{scenario.name} on `diff-lcs` v#{Diff::LCS::VERSION}"
+  else
+    block.call
+  end
+end

data/rspec-expectations/upstream/features/support/disallow_certain_apis.rb

@@ -3,8 +3,9 @@
 
 if defined?(Cucumber)
   require 'shellwords'
-  Before('~@allow-disallowed-api') do
-    set_env('SPEC_OPTS', "-r#{Shellwords.escape(__FILE__)}")
+  tag = !defined?(::RUBY_ENGINE_VERSION) || (::RUBY_ENGINE_VERSION < '2.0.0') ? '~@allow-disallowed-api': 'not @allow-disallowed-api'
+  Before(tag) do
+    set_environment_variable('SPEC_OPTS', "-r#{Shellwords.escape(__FILE__)}")
   end
 else
   module DisallowOneLinerShould
@@ -31,4 +32,3 @@ else
     rspec.include DisallowOneLinerShould
   end
 end
-

data/rspec-expectations/upstream/features/support/env.rb

@@ -1,21 +1,21 @@
 require 'aruba/cucumber'
 
-Before do
+Aruba.configure do |config|
   if RUBY_PLATFORM =~ /java/ || defined?(Rubinius)
-    @aruba_timeout_seconds = 60
+    config.exit_timeout = 60
   else
-    @aruba_timeout_seconds = 10
+    config.exit_timeout = 10
   end
 end
 
-Aruba.configure do |config|
-  config.before_cmd do |cmd|
-    set_env('JRUBY_OPTS', "-X-C #{ENV['JRUBY_OPTS']}") # disable JIT since these processes are so short lived
+Before do
+  if RUBY_PLATFORM == 'java'
+    # disable JIT since these processes are so short lived
+    set_environment_variable('JRUBY_OPTS', "-X-C #{ENV['JRUBY_OPTS']}")
   end
-end if RUBY_PLATFORM == 'java'
 
-Aruba.configure do |config|
-  config.before_cmd do |cmd|
-    set_env('RBXOPT', "-Xint=true #{ENV['RBXOPT']}") # disable JIT since these processes are so short lived
+  if defined?(Rubinius)
+    # disable JIT since these processes are so short lived
+    set_environment_variable('RBXOPT', "-Xint=true #{ENV['RBXOPT']}")
   end
-end if defined?(Rubinius)
+end

data/rspec-expectations/upstream/features/support/rubinius.rb

@@ -1,6 +1,6 @@
 # Required until https://github.com/rubinius/rubinius/issues/2430 is resolved
 ENV['RBXOPT'] = "#{ENV["RBXOPT"]} -Xcompiler.no_rbc"
 
-Around "@unsupported-on-rbx" do |scenario, block|
+Around "@unsupported-on-rbx" do |_scenario, block|
   block.call unless defined?(Rubinius)
 end

data/rspec-expectations/upstream/features/support/ruby_features.rb

@@ -0,0 +1,39 @@
+Around "@skip-when-splat-args-unsupported" do |scenario, block|
+  require 'rspec/support/ruby_features'
+
+  if ::RSpec::Support::RubyFeatures.optional_and_splat_args_supported?
+    block.call
+  else
+    skip_this_scenario "Skipping scenario #{scenario.name} because splat arguments are not supported"
+  end
+end
+
+Around "@skip-when-keyword-args-unsupported" do |scenario, block|
+  require 'rspec/support/ruby_features'
+
+  if ::RSpec::Support::RubyFeatures.kw_args_supported?
+    block.call
+  else
+    skip_this_scenario "Skipping scenario #{scenario.name} because keyword arguments are not supported"
+  end
+end
+
+Around "@skip-when-required-keyword-args-unsupported" do |scenario, block|
+  require 'rspec/support/ruby_features'
+
+  if ::RSpec::Support::RubyFeatures.required_kw_args_supported?
+    block.call
+  else
+    skip_this_scenario "Skipping scenario #{scenario.name} because required keyword arguments are not supported"
+  end
+end
+
+Around "@skip-when-ripper-unsupported" do |scenario, block|
+  require 'rspec/support/ruby_features'
+
+  if ::RSpec::Support::RubyFeatures.ripper_supported?
+    block.call
+  else
+    skip_this_scenario "Skipping scenario #{scenario.name} because Ripper is not supported"
+  end
+end

data/rspec-expectations/upstream/features/syntax_configuration.feature

@@ -6,7 +6,7 @@ Feature: Syntax Configuration
   of code in order to set an expectation on it.
 
   There's also an older `should`-based syntax, which relies upon `should` being
-  monkey-patched onto every object in the system.However, this syntax can at times lead to
+  monkey-patched onto every object in the system. However, this syntax can at times lead to
   some surprising failures, since RSpec does not own every object in the system and cannot
   guarantee that it will always work consistently.
 
@@ -50,8 +50,8 @@ Feature: Syntax Configuration
     Given a file named "spec/spec_helper.rb" with:
       """ruby
       RSpec.configure do |config|
-        config.expect_with :rspec do |c|
-          c.syntax = :expect
+        config.expect_with :rspec do |expectations|
+          expectations.syntax = :expect
         end
       end
       """
@@ -64,11 +64,11 @@ Feature: Syntax Configuration
     Given a file named "spec/spec_helper.rb" with:
       """ruby
       RSpec.configure do |config|
-        config.expect_with :rspec do |c|
-          c.syntax = :should
+        config.expect_with :rspec do |expectations|
+          expectations.syntax = :should
         end
-        config.mock_with :rspec do |c|
-          c.syntax = :should
+        config.mock_with :rspec do |mocks|
+          mocks.syntax = :should
         end
       end
       """
@@ -81,8 +81,8 @@ Feature: Syntax Configuration
     Given a file named "spec/spec_helper.rb" with:
       """ruby
       RSpec.configure do |config|
-        config.expect_with :rspec do |c|
-          c.syntax = [:should, :expect]
+        config.expect_with :rspec do |expectations|
+          expectations.syntax = [:should, :expect]
         end
       end
       """