Renamed `#have_same_file_content_like` matcher #555

xtrasimplicity · 2018-03-20T21:18:45Z

Summary

Removed have_same_file_content_like and a_file_with_same_content_like matchers, and added have_same_file_content_as and a_file_with_same_content_as, as per #485. The previous methods are deprecated in the HEAD of the still branch.

Details

Motivation and Context

To make it easier to understand what the matcher does.

How Has This Been Tested?

Added specs to ensure that the renamed methods are called.

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Refactoring (cleanup of codebase without changing any existing functionality)
Update documentation

Checklist:

I've added tests for my code
My change requires a change to the documentation.
I have updated the documentation accordingly.

xtrasimplicity · 2018-03-21T07:30:13Z

@mvz It looks like the following code (as of Commit 69e89bd) works perfectly when I run it on cucumber v3.1.0, but fails with the following error on v2.99.0.

# Deprecated matchers
module DeprecatedMatchers
  def have_same_file_content_like(expected)
    RSpec.deprecate('`have_same_file_content_like`', replacement: '`have_same_file_content_as`')

    have_same_file_content_as(expected)
  end

  def a_file_with_same_content_like(expected)
    RSpec.deprecate('`a_file_with_same_content_like`', replacement: '`a_file_with_same_content_as`')

    a_file_with_same_content_as(expected)
  end
end

RSpec.configure do |config|
  config.include DeprecatedMatchers
end

Feature: Existence

  Scenario: Existence                                       # features/non-existence.feature:2
    Given a file named "foo" with:                          # /home/andrew/Development/Projects/aruba/lib/aruba/cucumber/file.rb:23
      """
      hello world
      """
    And a file named "bar" with:                            # /home/andrew/Development/Projects/aruba/lib/aruba/cucumber/file.rb:23
      """
      hello world
      """
    And a file named "nonbar" with:                         # /home/andrew/Development/Projects/aruba/lib/aruba/cucumber/file.rb:23
      """
      hello another world
      """
    Then the file "foo" should be equal to file "bar"       # /home/andrew/Development/Projects/aruba/lib/aruba/cucumber/file.rb:175
      expected foo to respond to `has_same_file_content_like?` (RSpec::Expectations::ExpectationNotMetError)
      /home/andrew/Development/Projects/aruba/lib/aruba/cucumber/file.rb:179:in `/^(?:a|the) file(?: named)? "([^"]*)" should (not )?be equal to file "([^"]*)"/'
      /home/andrew/Development/Projects/aruba/lib/aruba/platforms/local_environment.rb:22:in `call'
      /home/andrew/Development/Projects/aruba/lib/aruba/platforms/unix_platform.rb:78:in `with_environment'
      /home/andrew/Development/Projects/aruba/lib/aruba/api/core.rb:186:in `with_environment'
      /home/andrew/Development/Projects/aruba/lib/aruba/cucumber/hooks.rb:7:in `block in <top (required)>'
      features/non-existence.feature:15:in `Then the file "foo" should be equal to file "bar"'
    And the file "foo" should not be equal to file "nonbar" # /home/andrew/Development/Projects/aruba/lib/aruba/cucumber/file.rb:175

Failing Scenarios:
cucumber features/non-existence.feature:2 # Scenario: Existence

1 scenario (1 failed)
5 steps (1 failed, 1 skipped, 3 passed)
0m0.020s

The tests themselves will require a number of changes before we can upgrade cucumber to 3.1.0. Everything works if I remove the RSpec.configure block and move the methods out of DeprecatedMatchers, but I'm not happy with doing that as it feels a little too hack-y. Any ideas?

…chers.

xtrasimplicity · 2018-03-21T07:55:29Z

Scratch that. RSpec::Matchers.send(:include ...) to the rescue! 👍

xtrasimplicity · 2018-03-24T03:16:16Z

@mvz Are you happy for me to merge this?

mvz · 2018-03-24T06:42:39Z

@xtrasimplicity I'll have a look this weekend.

mvz

Can you rebase this onto still so we deprecate in the 0.14.x series? That way we don't introduce deprecations in the upcoming 1.0 release. On master, it would just be the straight rename.

mvz · 2018-03-24T08:29:49Z

lib/aruba/matchers/file/have_same_file_content.rb

+RSpec::Matchers.alias_matcher :a_file_with_same_content_as, :have_same_file_content_as
+
+# Deprecated matchers
+module DeprecatedMatchers


I think we can safely deprecate these in the 0.14.x series, and drop them entirely for 1.0.

Sounds good to me. I'll rebase this when I get a moment.

mvz · 2018-03-24T08:33:33Z

spec/aruba/matchers/file_spec.rb

            .to raise_error RSpec::Expectations::ExpectationNotMetError
        end
      end
    end
  end

+  describe "to have_same_file_content_like" do
+    it 'calls have_same_file_content_as' do
+      expect(self).to receive(:have_same_file_content_as)


Can we test this some other way? Mocking self can lead to all kinds of breakage down the line.

I think you can just test these matchers by using them as intended (though less extensively than the main tests above).

Yep, I'll change this over, too. Thanks for reviewing! :)

You're welcome!

mvz · 2018-03-24T09:00:03Z

(I removed the Reviewable badge since Aruba doesn't use it in general.)

xtrasimplicity · 2018-03-25T06:30:18Z

I've just applied these changes to the still branch, in a new PR:
#557
I'll close this PR off. @mvz Could I please get you to take a look at the other PR?

Thanks!

…branch).

olleolleolle · 2018-04-01T04:47:34Z

Thanks for keeping this alive, it’s a change which adds clarity to the testing activity - everyone needs their head clear for that activity.

mvz · 2018-04-01T06:28:28Z

LGTM!

Deprecated both matchers.

e7e7771

xtrasimplicity requested a review from mvz March 20, 2018 21:18

xtrasimplicity changed the title ~~Renamed #have_same_file_content_like matcher~~ [WIP] Renamed #have_same_file_content_like matcher Mar 20, 2018

Fixing RSpec configuration issues.

69e89bd

xtrasimplicity added the status: work in progress label Mar 21, 2018

Clearly a module isn't the way to go...

f6f3137

xtrasimplicity added 2 commits March 21, 2018 18:43

The DeprecatedMatchers module works... if I inject it into RSpec::Mat…

3b4dc32

…chers.

Updated links in changelog.

e7cee51

xtrasimplicity added status: needs review and removed status: work in progress labels Mar 22, 2018

xtrasimplicity changed the title ~~[WIP] Renamed #have_same_file_content_like matcher~~ Renamed #have_same_file_content_like matcher Mar 24, 2018

mvz reviewed Mar 24, 2018

View reviewed changes

xtrasimplicity self-assigned this Mar 24, 2018

xtrasimplicity added status: work in progress and removed status: needs review labels Mar 24, 2018

xtrasimplicity mentioned this pull request Mar 25, 2018

Still Branch: Deprecated have_same_file_content_like and a_file_with_same_content_like matchers #557

Merged

8 tasks

xtrasimplicity closed this Mar 25, 2018

xtrasimplicity reopened this Mar 31, 2018

xtrasimplicity added 2 commits April 1, 2018 12:22

Removed deprecated methods entirely (they're deprecated on the still …

b49be75

…branch).

Updated changelog

faf66a5

Removed unnecessary spec

395b2b4

mvz approved these changes Apr 1, 2018

View reviewed changes

xtrasimplicity merged commit 53741ea into cucumber:master Apr 1, 2018

xtrasimplicity deleted the Feature/RenameHaveSameFileContentLikeMatcher branch April 1, 2018 08:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Renamed `#have_same_file_content_like` matcher #555

Renamed `#have_same_file_content_like` matcher #555

xtrasimplicity commented Mar 20, 2018 •

edited

Loading

xtrasimplicity commented Mar 21, 2018 •

edited

Loading

xtrasimplicity commented Mar 21, 2018

xtrasimplicity commented Mar 24, 2018

mvz commented Mar 24, 2018

mvz left a comment

mvz Mar 24, 2018

xtrasimplicity Mar 24, 2018

mvz Mar 24, 2018

xtrasimplicity Mar 24, 2018

mvz Mar 24, 2018

mvz commented Mar 24, 2018

xtrasimplicity commented Mar 25, 2018

olleolleolle commented Apr 1, 2018

mvz commented Apr 1, 2018

Renamed #have_same_file_content_like matcher #555

Renamed #have_same_file_content_like matcher #555

Conversation

xtrasimplicity commented Mar 20, 2018 • edited Loading

Summary

Details

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

xtrasimplicity commented Mar 21, 2018 • edited Loading

xtrasimplicity commented Mar 21, 2018

xtrasimplicity commented Mar 24, 2018

mvz commented Mar 24, 2018

mvz left a comment

Choose a reason for hiding this comment

mvz Mar 24, 2018

Choose a reason for hiding this comment

xtrasimplicity Mar 24, 2018

Choose a reason for hiding this comment

mvz Mar 24, 2018

Choose a reason for hiding this comment

xtrasimplicity Mar 24, 2018

Choose a reason for hiding this comment

mvz Mar 24, 2018

Choose a reason for hiding this comment

mvz commented Mar 24, 2018

xtrasimplicity commented Mar 25, 2018

olleolleolle commented Apr 1, 2018

mvz commented Apr 1, 2018

Renamed `#have_same_file_content_like` matcher #555

Renamed `#have_same_file_content_like` matcher #555

xtrasimplicity commented Mar 20, 2018 •

edited

Loading

xtrasimplicity commented Mar 21, 2018 •

edited

Loading