Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change matcher protocol #373

Merged
merged 16 commits into from
Dec 3, 2013
Merged

Change matcher protocol #373

merged 16 commits into from
Dec 3, 2013

Conversation

myronmarston
Copy link
Member

This is a first pass for #270. I'm pretty happy with it so far but there's still RSpec::Matcher.last_should to update. if this get s LGTM from another rspec core member I'll go ahead and merge w/o that; otherwise I'll add that to this PR.

@myronmarston
Copy link
Member Author

BTW, one thing you'll notice I'm doing differently here: I'm adding deprecation warnings to 3.0 rather than breaking things in 3.0 and adding deprecations to 2.99. While it would be nice to make the breaking change in 3.0 and not keep some old cruft around, these API changes are very likely to affect some extension gems (such as shoulda). I don't want users blocked from upgrading to 3.0 because of extension gems they use relying on the old APIs -- thus, I thought it best to retain support for the old protocol in 3.x. We'll plan to drop it in 4.0.

One thing that may surprise users is that they can get warning-free on 2.99, upgrade to 3.0, and then still get warnings. We'll need to make it clear that getting warning free on 2.99 means that their test suite should run on 3.0 w/o any failures, but it does not imply it will run w/o any deprecations.

@myronmarston
Copy link
Member Author

I've decided to do the RSpec::Matchers.last_should change in a separate PR. It doesn't need the same "deprecate in 3.0 because extension gems might rely on it" treatment, so it'll be simpler to do that as a separate change

@myronmarston
Use new simplecov setup method from rspec-support.
135e3eb
@myronmarston
Rename failure message APIs.
bfe9202 
- failure_message_for_should => failure_message
- failure_message_for_should_not => failure_message_when_negated

Given that we are moving away from `should`,
it would be odd to keep them in these APIs.
@myronmarston
match_for_should_not => match_when_negated.
37ab95c
@myronmarston
Remove old RSpec 1 compatibility shim.
7dacd67 
I'll be adding a new one.
@myronmarston
Provide deprecation warnings for matchers written against the old pro…
1cca56e 
…tocol.
@myronmarston
Label some classes as private.
5335df5
@myronmarston
Refactor duplication out of positive/negative handler.
ef10165
@myronmarston
Don't print deprecations when the matcher works on 2.x and 3.x.
fab4a13
@myronmarston
Rename method rspec_3_matcher_from => modern_matcher_from.
bfe0424
@myronmarston
Rephrase old doc strings.
7db9540
@myronmarston
Add deprecations for old matcher DSL methods.
cd0d347
@myronmarston
Consider a legacy matcher to be a matcher.
131a13a
@myronmarston
Update changelog.
0cb82ff
@myronmarston
Update gemspec description.
f60685d
@myronmarston
Rewrite YARD docs in terms of expect rather than should.
68f5bff
@myronmarston
Correct docs.
a0f0149
@JonRowe
Copy link
Member

JonRowe commented Dec 2, 2013

LGTM but I did find the block syntax you used for the matcher adapters a bit confusing at first...

@myronmarston
Copy link
Member Author

LGTM but I did find the block syntax you used for the matcher adapters a bit confusing at first...

To what are you referring? I'm not seeing any blocks involved in the legacy matcher adapters...

@JonRowe
Copy link
Member

JonRowe commented Dec 2, 2013

I'm referring to L30 and the corresponding L46-51 L59-68 etc

@myronmarston
Copy link
Member Author

I'm referring to L30 and the corresponding L46-51 L59-68 etc

Ah, that. That's the positive/negative handler, not the matcher adapters (hence my confusion).

Anyhow, take a look at ef10165 (and the contents of handler.rb before that file) -- that's simply to reduce duplication (there was a lot!). I'm certainly open to better ways to solve that problem, though: got any ideas?

@JonRowe
Copy link
Member

JonRowe commented Dec 3, 2013

Sort of but I think merge this as is, and then I might have a go at refactoring it.

myronmarston added a commit that referenced this pull request Dec 3, 2013
@myronmarston
Merge pull request #373 from rspec/change-matcher-protocol
b9e21b9 
Change matcher protocol
@myronmarston myronmarston merged commit b9e21b9 into master Dec 3, 2013
@myronmarston myronmarston deleted the change-matcher-protocol branch December 3, 2013 00:10
@myronmarston
Copy link
Member Author

Done.

This was referenced Dec 3, 2013
Merged
Closed
@yujinakayama yujinakayama mentioned this pull request Dec 4, 2013
Closed
@JonRowe JonRowe mentioned this pull request Dec 4, 2013
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@myronmarston @JonRowe