Allow Range#=== and Range#cover? on Range #32938

utilum · 2018-05-20T19:21:19Z

ruby/ruby@989e07c features switching Range#=== to use internal r_cover_p
instead of rubyland include?. This breaks expected behavior of
ActiveSupport::CoreExt::Range documented since at least 8b67a02.

This patch adds overrides on Range#cover? and Range#=== and places all
three in a single module, CompareWithRange.
See failures at:
https://travis-ci.org/rails/rails/jobs/380939901#L1224-L1247

rails-bot · 2018-05-20T19:21:22Z

r? @kamipo

(@rails-bot has picked a reviewer for you, use r? to override)

matthewd · 2018-05-21T14:19:35Z

If we go with this (see parallel discussion in #32945), I think we should also address cover?, and keep all three in the same file.

utilum · 2018-05-21T16:40:15Z

Thank you both.

I've added cover? and moved all three into a single file, in module RangeCompareWithRange.

Better?

utilum · 2018-05-21T17:16:35Z

PS: What do you think about moving overlaps? in with the others?

eugeneius · 2018-05-21T22:58:31Z

guides/source/active_support_core_extensions.md

@@ -2889,9 +2889,9 @@ As the example depicts, the `:db` format generates a `BETWEEN` SQL clause. That

 NOTE: Defined in `active_support/core_ext/range/conversions.rb`.

-### `include?`
+### `===`, `include?`, and `range?`


range? -> cover?

Yes! of course.

eugeneius · 2018-05-21T23:06:17Z

activesupport/lib/active_support/core_ext/range/include_range.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true


The existence of this file is documented, and users may depend on it:

http://guides.rubyonrails.org/v5.2.0/active_support_core_extensions.html#include-questionmark

If we want to remove it, it needs a deprecation cycle first. Here's an example of how that might look:

https://github.com/rails/rails/blob/64c88fb5d2caf3c34742a07394ac68b8377c4936/activesupport/lib/active_support/core_ext/object/to_json.rb

Thank you. Done.

eugeneius · 2018-05-22T12:10:26Z

activesupport/CHANGELOG.md

+
+    ruby/ruby@989e07c features switching `Range#===` to use internal
+    `r_cover_p` instead of rubyland `include?`. This breaks expected behavior
+    of `ActiveSupport::CoreExt::Range` documented since at least 8b67a02.


This is excellent detail for anyone interested in why the change was necessary, but the changelog should be a high level description of what changed from the user's perspective - it's probably sufficient to say that Range#cover? can now be given a range like Range#=== and Range#include?, and Range#=== works correctly when given a range on Ruby 2.6.

Cleaned up. I hope I did not go too far by also removing the module name.

I think that's the right call - users don't interact with the module directly, they just call the methods that it modifies.

eugeneius · 2018-05-22T12:11:06Z

activesupport/lib/active_support/core_ext/range/include_range.rb

-    end
-  end
-end
+ActiveSupport::Deprecation.warn "You have required `active_support/core_ext/range/include_range`. " \


Every other file in Active Support that emits a deprecation requires active_support/deprecation first; we should do the same here.

eugeneius · 2018-05-22T12:11:10Z

guides/source/active_support_core_extensions.md


-The methods `Range#include?` and `Range#===` say whether some value falls between the ends of a given instance:
+The methods `Range#===`, `Range#include?` and `Range#cover?` say whether some value falls between the ends of a given instance:


http://guides.rubyonrails.org/v5.2.0/api_documentation_guidelines.html#oxford-comma

Please use the Oxford comma ("red, white, and blue", instead of "red, white and blue").

🤓

Oxford in a comma, it's serious ;)

ruby/ruby@989e07c features switching `Range#===` to use internal `r_cover_p` instead of rubyland `include?`. This breaks expected behavior of `ActiveSupport::CoreExt::Range` documented since at least 8b67a02. This patch adds overrides on `Range#cover?` and `Range#===` and places all three in a single module, `CompareWithRange`. *Requiring core_ext/range/include_range now causes a deprecation warnning*

eugeneius · 2018-05-22T12:51:15Z

activesupport/CHANGELOG.md

+*   Allow Range#=== and Range#cover? on Range
+
+    `Range#cover?` can now accept a range argument like `Range#include` and
+    `Range===`. `Range#===` works correctly on Ruby 2.6. `Range#include?` is moved


There's a missing # in Range=== here.

eugeneius · 2018-05-22T12:51:54Z

activesupport/CHANGELOG.md

+
+    To use: `require "active_support/core_ext/compare_range"`.
+
+    *Requiring core_ext/range/include_range now causes a deprecation warnning*


"warnning" -> "warning"

Can you also add active_support/ to the start of the filename, to match the example above?

We're telling the user that requiring this file is deprecated, but not what they need to do instead - it's pretty easy to infer that they should now require active_support/core_ext/compare_range, but ideally we'd explicitly state that.

Right on.
Sorry about all the typos.

eugeneius · 2018-05-22T13:05:25Z

What do you think about moving overlaps? in with the others?

I'd recommend leaving it where it is, mostly just to avoid inflicting the mild inconvenience of a deprecation warning on anyone cherry-picking that file on its own.

eugeneius · 2018-05-22T13:48:23Z

activesupport/CHANGELOG.md

@@ -1,3 +1,14 @@
+*   Allow Range#=== and Range#cover? on Range
+
+    `Range#cover?` can now accept a range argument like `Range#include` and


Range#include -> Range#include?

eugeneius · 2018-05-22T13:48:27Z

activesupport/CHANGELOG.md

+    `Range#===`. `Range#===` works correctly on Ruby 2.6. `Range#include?` is moved
+    into a new file, with these two methods.
+
+    *Requiring active_support_core_ext/range/include_range now causes a deprecation warning*


active_support_core_ext -> active_support/core_ext

"now causes a deprecation warning" -> "is now deprecated"

eugeneius · 2018-05-22T13:48:33Z

activesupport/CHANGELOG.md

+    into a new file, with these two methods.
+
+    *Requiring active_support_core_ext/range/include_range now causes a deprecation warning*
+    *Use `require "active_support/core_ext/compare_range"` instead.*


active_support/core_ext/compare_range -> active_support/core_ext/range/compare_range

Allow Range#=== and Range#cover? on Range

rails-bot assigned kamipo May 20, 2018

utilum force-pushed the range_case_equality branch 2 times, most recently from fc2b7a0 to 10fdc28 Compare May 20, 2018 20:25

eugeneius mentioned this pull request May 21, 2018

Range#=== behavior changes in Ruby 2.6 revision 63453 triggers 3 failures #32945

Closed

utilum force-pushed the range_case_equality branch 2 times, most recently from 9e6472e to 5104fb1 Compare May 21, 2018 16:38

utilum force-pushed the range_case_equality branch from 5104fb1 to a26abf6 Compare May 21, 2018 16:51

utilum changed the title ~~Allow Range#=== on Range~~ Allow Range#=== and Range#cover? on Range May 21, 2018

utilum force-pushed the range_case_equality branch 3 times, most recently from bf54f75 to 4e6dd71 Compare May 21, 2018 22:28

eugeneius reviewed May 21, 2018

View reviewed changes

utilum force-pushed the range_case_equality branch 5 times, most recently from 26f95f8 to a2e9e5d Compare May 22, 2018 05:23

eugeneius reviewed May 22, 2018

View reviewed changes

utilum force-pushed the range_case_equality branch from a2e9e5d to fccf3ad Compare May 22, 2018 12:39

eugeneius reviewed May 22, 2018

View reviewed changes

utilum force-pushed the range_case_equality branch from fccf3ad to 634f848 Compare May 22, 2018 13:19

eugeneius reviewed May 22, 2018

View reviewed changes

add CHANGELOG/Doc

e04a79e

utilum force-pushed the range_case_equality branch from 634f848 to e04a79e Compare May 22, 2018 14:03

eugeneius approved these changes May 22, 2018

View reviewed changes

rafaelfranca merged commit fa9d01d into rails:master May 22, 2018

utilum deleted the range_case_equality branch May 22, 2018 20:56

yahonda mentioned this pull request Dec 16, 2018

Ruby 2.6 suport for 5-2-stable branch #34720

Merged

yahonda pushed a commit to yahonda/rails that referenced this pull request Dec 24, 2018

Merge pull request rails#32938 from utilum/range_case_equality

bd24ef6

Allow Range#=== and Range#cover? on Range

owst mentioned this pull request Mar 28, 2019

Fix bug in Range comparisons when comparing to excluded-end Range #35776

Merged

dependabot bot mentioned this pull request Oct 29, 2019

Bump activesupport from 4.0.12 to 5.2.3 rubiety/validates_lengths_from_database#28

Closed

dependabot bot mentioned this pull request Nov 16, 2019

Bump activesupport from 4.2.0 to 5.2.3 spraints/ccc-production#10

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow Range#=== and Range#cover? on Range #32938

Allow Range#=== and Range#cover? on Range #32938

utilum commented May 20, 2018 •

edited

Loading

rails-bot commented May 20, 2018

matthewd commented May 21, 2018

utilum commented May 21, 2018

utilum commented May 21, 2018

eugeneius May 21, 2018

utilum May 22, 2018

eugeneius May 21, 2018

utilum May 22, 2018

eugeneius May 22, 2018

utilum May 22, 2018

eugeneius May 22, 2018

eugeneius May 22, 2018

utilum May 22, 2018

eugeneius May 22, 2018

utilum May 22, 2018

eugeneius May 22, 2018

eugeneius May 22, 2018

eugeneius May 22, 2018

utilum May 22, 2018

eugeneius commented May 22, 2018

eugeneius May 22, 2018

utilum May 22, 2018

eugeneius May 22, 2018

eugeneius May 22, 2018

utilum May 22, 2018

eugeneius May 22, 2018

utilum May 22, 2018


		The methods `Range#include?` and `Range#===` say whether some value falls between the ends of a given instance:
		The methods `Range#===`, `Range#include?` and `Range#cover?` say whether some value falls between the ends of a given instance:


		To use: `require "active_support/core_ext/compare_range"`.

		Requiring core_ext/range/include_range now causes a deprecation warnning

		@@ -1,3 +1,14 @@
		* Allow Range#=== and Range#cover? on Range

		`Range#cover?` can now accept a range argument like `Range#include` and

Allow Range#=== and Range#cover? on Range #32938

Allow Range#=== and Range#cover? on Range #32938

Conversation

utilum commented May 20, 2018 • edited Loading

rails-bot commented May 20, 2018

matthewd commented May 21, 2018

utilum commented May 21, 2018

utilum commented May 21, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eugeneius commented May 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

utilum commented May 20, 2018 •

edited

Loading