[FEATURE ember-runtime-enumerable-includes] Implements Array.includes and deprecates Array.contains #13553

bmeurant · 2016-05-24T18:00:15Z

TODO :

Implement Enumerable.includes
Implement Array.includes
Deprecate contains under feature flag
Replace usages of contains by includes
Update docs, guides (Update documentation to move from contains to includes guides#1439) & API. To be merged once feature enabled.
Write deprecation guide (Add Enumerable.contains to deprecation guide website#2600) & add url in deprecate call
Rebase / squash

alexspeller · 2016-05-24T18:02:13Z

Oh awesome, thanks for getting this implementation done!

bmeurant · 2016-05-24T18:13:08Z

Here is a first proposal for emberjs/rfcs#136. Work is in progress and feedbacks expected.

I made the asumption that we have to keep Enumerable & Array APIs consistent and then have to provide a consistent includes method in Enumerable (with no index). Let me know if this is not expected.

Aliasing contains with the new includes method can break some existing apps because, according to the spec (https://tc39.github.io/ecma262/2016/#sec-array.prototype.includes), includes relies on the SameValueZero algorithm and actual contains relies on strict equality leading to differences in NaN detections (I will document it). Can we still make this ?

mixonic · 2016-05-24T18:44:57Z

@bmeurant Thanks :-)

contains should not be aliased to includes. Contains should keep its current implementation, and we can deprecate it though we will likely do that in a separate PR. In this PR it should simply retain its current behavior.

bmeurant · 2016-05-24T19:54:52Z

@mixonic thx for your feedback.

I updated this PR to keep current implementation for Enumerable.contains & Array.contains.

we can deprecate it though we will likely do that in a separate PR

Does it means that I should also remove @deprecated and deprecation warning for now ?

rwjblue · 2016-05-24T22:12:22Z

I believe that the deprecation should be included here when the feature flag is enabled.

mixonic · 2016-05-24T22:58:36Z

@rwjblue I am easily convinced, was just erring on the conservative side. @bmeurant please include the deprecation behind the feature flag! :-)

bmeurant · 2016-05-25T08:59:59Z

@mixonic I added feature flag and move deprecation behind it. Let me know if I forgotten something.

I also removed @deprecated from API because contains is not actually deprecated if feature is not enabled, right ?

But I was wondering: doing that, users will loose the information that contains will be deprecated soon and that they should use includes instead. Is it exists a way to provide this kind of information in APIs ?

mixonic · 2016-05-27T11:27:20Z

@bmeurant Yeah the documentation may require some followup tweaks. Feature flagging things like the @deprecated flag is tricky :-/. I think you should feel free to create a followup issue of things to do once the feature is "go'd" for beta.

mixonic · 2016-05-27T11:28:15Z

FEATURES.md

+
+* `ember-runtime-enumerable-contains`
+
+Deprecates `Enumerable.contains` and `Array.contains` in favor of `Enumerable.includes` and `Array.includes` 


Again here I lean toward Enumerable#contains, per emberjs/website#2600 (comment). It is a Rubyish approach, curious if there are other thoughts.

I think Enumerable#contains is the convention in Ember even though it was originally a rubyism - at least it has the advantage that it's not valid syntax for something that is completely different

(See for example the changelog where it's used extensively)

mixonic · 2016-05-27T11:42:40Z

@bmeurant heh, there are no tests for Array#contains?! Can you add one asserting basic behavior and the deprecation please?

This is looking pretty good after some tweaks!

mixonic · 2016-05-27T11:46:00Z

packages/ember-runtime/lib/mixins/array.js

+    @return {Boolean} `true` if object is found in the array.
+    @public
+  */
+  includes(obj, startAt) {


This function (and the enumerable one) must be added only when the feature flag is enabled. For example:

let ArrayMixin = Mixin.create(Enumerable, { /* snip */ }); if (isEnabled('ember-runtime-enumerable-includes')) { ArrayMixin.reopen({ includes(obj, startAt) { /* ... */ } }); } export default ArrayMixin;

bmeurant · 2016-05-27T13:04:27Z

Thx for feedbacks, I'll work on it ASAP

bmeurant · 2016-05-27T13:28:48Z

It seemed to me that Array#contains tests are also imported and run from Enumerable#contains tests. Did I miss something ?

mixonic · 2016-05-27T15:44:36Z

Ah I see @bmeurant :-) right there is no contains on arrays, only on enumerable 👍

bmeurant · 2016-05-27T18:45:23Z

I wanted to add a test to verify assertion calling Enumerable#includes with a second argument but, because tests defined on Enumerable are also run on Array suites, I did not find a good way to do it. Any advice ?

bmeurant · 2016-05-27T19:58:58Z

packages/ember-runtime/lib/mixins/enumerable.js

@@ -811,7 +820,9 @@ var Enumerable = Mixin.create({
    @public
  */
  without(value) {


I think we have a problem line 832 during k !== value. If the feature is enabled, without becomes inconsistent because NaN !== NaN is true

bmeurant · 2016-05-27T21:06:52Z

packages/ember-runtime/lib/mixins/enumerable.js

+      return found;
+    },
+
+    without(value) {


I prefered replacing without behind feature flag to not add multiple isEnabled calls in original method

mixonic · 2016-05-30T17:21:21Z

@bmeurant it seems ok to add a test for contains without an offset in packages/ember-runtime/tests/mixins/enumerable_test.js, since it only impacts enumerables.

mixonic · 2016-05-30T17:21:53Z

Thanks for your continued work on this 😄 it looks really close, and quite nice!

mixonic · 2016-05-30T22:30:13Z

Looking nice. A rebase/squash to some number is semantically meaningful commits (one or more) would be great, each prefixed with [FEATURE ember-runtime-enumerable-includes] would be great.

bmeurant · 2016-05-30T23:28:37Z

Done 👌

homu · 2016-06-01T16:12:05Z

☔ The latest upstream changes (presumably #13328) made this pull request unmergeable. Please resolve the merge conflicts.

mixonic · 2016-06-03T17:58:44Z

Looks pretty great to me @bmeurant! Thank you! I'll get someone else on core to review and we can with their 👍

rwjblue · 2016-06-03T17:59:40Z

packages/ember-runtime/lib/mixins/array.js

+      var len = get(this, 'length');
+      var idx, currentObj;
+
+      if (Ember.isNone(startAt)) {


Should not use the global here (Ember.isNone), if we need isNone it should be imported. Can we just do the null / undefined check ourselves?

@rwjblue using the global here was surely a mistake, sorry. isNone is already imported and used in slice. I'll update. But why do you prefer to not use imported isNone and doing null / undefined check ourselves in this case?

Anyway, explicit null check is unnecessary as we only iterating on idx = startAt. I removed it.

rwjblue · 2016-06-03T18:02:03Z

This looks good, only one small tweak and this is good to go...

…udes and deprecate Enumerable#contains

mixonic · 2016-06-04T12:37:38Z

This is great! Thank you @bmeurant!

rwjblue · 2016-08-25T14:50:27Z

FYI - I created https://github.com/rwjblue/ember-runtime-enumerable-includes-polyfill to make this a bit easier for addons to avoid deprecations, use the newer syntax, and continue to support older versions of Ember.

Update documentation to move from contains to includes Related to emberjs/ember.js#13553. To be merged when feature has been released.

This is required as .contains seems to be deprecated in ember-3. See emberjs/ember.js#13553 for more information

bmeurant force-pushed the master branch from ca2adbd to 9f524a7 Compare May 24, 2016 19:33

bmeurant force-pushed the master branch from 9f524a7 to 790b09d Compare May 25, 2016 08:50

bmeurant force-pushed the master branch from 790b09d to 0194493 Compare May 25, 2016 11:38

bmeurant mentioned this pull request May 25, 2016

Add Enumerable.contains to deprecation guide emberjs/website#2600

Merged

bmeurant force-pushed the master branch from 0194493 to c6e1b34 Compare May 25, 2016 12:13

bmeurant changed the title ~~[WIP][FEATURE contains-to-includes] Implements Array.includes and deprecates Array.contains~~ [FEATURE contains-to-includes] Implements Array.includes and deprecates Array.contains May 25, 2016

bmeurant mentioned this pull request May 25, 2016

Update documentation to move from contains to includes emberjs/guides#1439

Merged

bmeurant force-pushed the master branch from c6e1b34 to 99440b1 Compare May 25, 2016 19:24

mixonic reviewed May 27, 2016
View reviewed changes

bmeurant force-pushed the master branch from a6c495a to f3e3a29 Compare May 27, 2016 19:33

bmeurant force-pushed the master branch from f3e3a29 to 62ef570 Compare May 27, 2016 19:53

bmeurant reviewed May 27, 2016
View reviewed changes

bmeurant force-pushed the master branch from 62ef570 to c01984c Compare May 27, 2016 20:40

bmeurant reviewed May 27, 2016
View reviewed changes

bmeurant force-pushed the master branch from c01984c to e2d37c4 Compare May 30, 2016 21:45

mixonic changed the title ~~[FEATURE contains-to-includes] Implements Array.includes and deprecates Array.contains~~ [FEATURE ember-runtime-enumerable-includes] Implements Array.includes and deprecates Array.contains May 30, 2016

bmeurant force-pushed the master branch from e2d37c4 to bbd1f5c Compare May 30, 2016 23:00

bmeurant force-pushed the master branch from bbd1f5c to 1b19212 Compare June 2, 2016 08:34

rwjblue reviewed Jun 3, 2016
View reviewed changes

[FEATURE ember-runtime-enumerable-includes] Introduce Enumerable#incl…

732e907

…udes and deprecate Enumerable#contains

bmeurant force-pushed the master branch from 1b19212 to 732e907 Compare June 4, 2016 08:34

mixonic merged commit b0332ef into emberjs:master Jun 4, 2016

homu mentioned this pull request Jun 4, 2016

ESLint #13549

Merged

2 tasks

bmeurant mentioned this pull request Jul 5, 2016

Update api doc for Enumerable#contains to flag it as deprecated #13790

Merged

homu added a commit to emberjs/guides that referenced this pull request Oct 18, 2016

Auto merge of #1439 - bmeurant:master, r=locks

abbc6c7

Update documentation to move from contains to includes Related to emberjs/ember.js#13553. To be merged when feature has been released.

ecksun pushed a commit to Manetos/ember-searchable-select that referenced this pull request Sep 4, 2018

Migrate to use Array.includes from .contains

b4cc1df

This is required as .contains seems to be deprecated in ember-3. See emberjs/ember.js#13553 for more information

ecksun mentioned this pull request Sep 4, 2018

Migrate to use Array.includes from .contains tedconf/ember-searchable-select#54

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FEATURE ember-runtime-enumerable-includes] Implements Array.includes and deprecates Array.contains #13553

[FEATURE ember-runtime-enumerable-includes] Implements Array.includes and deprecates Array.contains #13553

bmeurant commented May 24, 2016 •

edited

Loading

alexspeller commented May 24, 2016

bmeurant commented May 24, 2016

mixonic commented May 24, 2016

bmeurant commented May 24, 2016

rwjblue commented May 24, 2016

mixonic commented May 24, 2016

bmeurant commented May 25, 2016 •

edited

Loading

mixonic commented May 27, 2016

mixonic May 27, 2016

alexspeller May 27, 2016 •

edited

Loading

mixonic commented May 27, 2016

mixonic May 27, 2016

bmeurant commented May 27, 2016

bmeurant commented May 27, 2016 •

edited

Loading

mixonic commented May 27, 2016

bmeurant commented May 27, 2016

bmeurant May 27, 2016 •

edited

Loading

bmeurant May 27, 2016

mixonic May 30, 2016

mixonic commented May 30, 2016

mixonic commented May 30, 2016

mixonic commented May 30, 2016

bmeurant commented May 30, 2016

homu commented Jun 1, 2016

mixonic commented Jun 3, 2016

rwjblue Jun 3, 2016

bmeurant Jun 4, 2016

bmeurant Jun 4, 2016

rwjblue commented Jun 3, 2016

mixonic commented Jun 4, 2016

rwjblue commented Aug 25, 2016


		* `ember-runtime-enumerable-contains`

		Deprecates `Enumerable.contains` and `Array.contains` in favor of `Enumerable.includes` and `Array.includes`

[FEATURE ember-runtime-enumerable-includes] Implements Array.includes and deprecates Array.contains #13553

[FEATURE ember-runtime-enumerable-includes] Implements Array.includes and deprecates Array.contains #13553

Conversation

bmeurant commented May 24, 2016 • edited Loading

alexspeller commented May 24, 2016

bmeurant commented May 24, 2016

mixonic commented May 24, 2016

bmeurant commented May 24, 2016

rwjblue commented May 24, 2016

mixonic commented May 24, 2016

bmeurant commented May 25, 2016 • edited Loading

mixonic commented May 27, 2016

mixonic May 27, 2016

Choose a reason for hiding this comment

alexspeller May 27, 2016 • edited Loading

Choose a reason for hiding this comment

mixonic commented May 27, 2016

mixonic May 27, 2016

Choose a reason for hiding this comment

bmeurant commented May 27, 2016

bmeurant commented May 27, 2016 • edited Loading

mixonic commented May 27, 2016

bmeurant commented May 27, 2016

bmeurant May 27, 2016 • edited Loading

Choose a reason for hiding this comment

bmeurant May 27, 2016

Choose a reason for hiding this comment

mixonic May 30, 2016

Choose a reason for hiding this comment

mixonic commented May 30, 2016

mixonic commented May 30, 2016

mixonic commented May 30, 2016

bmeurant commented May 30, 2016

homu commented Jun 1, 2016

mixonic commented Jun 3, 2016

rwjblue Jun 3, 2016

Choose a reason for hiding this comment

bmeurant Jun 4, 2016

Choose a reason for hiding this comment

bmeurant Jun 4, 2016

Choose a reason for hiding this comment

rwjblue commented Jun 3, 2016

mixonic commented Jun 4, 2016

rwjblue commented Aug 25, 2016

bmeurant commented May 24, 2016 •

edited

Loading

bmeurant commented May 25, 2016 •

edited

Loading

alexspeller May 27, 2016 •

edited

Loading

bmeurant commented May 27, 2016 •

edited

Loading

bmeurant May 27, 2016 •

edited

Loading