Merge pull request #20924 from wagenet/kill-comparable

[Next] Kill Comparable

Author: wagenet

broccoli/amd-compat-entrypoints/ember.debug.js

@@ -62,9 +62,6 @@ d(
   emberinternalsRuntimeLibMixinsActionHandler
 );
 
-import * as emberinternalsRuntimeLibMixinsComparable from '@ember/-internals/runtime/lib/mixins/comparable';
-d('@ember/-internals/runtime/lib/mixins/comparable', emberinternalsRuntimeLibMixinsComparable);
-
 import * as emberinternalsRuntimeLibMixinsContainerProxy from '@ember/-internals/runtime/lib/mixins/container_proxy';
 d(
   '@ember/-internals/runtime/lib/mixins/container_proxy',

package.json

@@ -204,7 +204,6 @@
       "@ember/-internals/runtime/index.js": "ember-source/@ember/-internals/runtime/index.js",
       "@ember/-internals/runtime/lib/ext/rsvp.js": "ember-source/@ember/-internals/runtime/lib/ext/rsvp.js",
       "@ember/-internals/runtime/lib/mixins/action_handler.js": "ember-source/@ember/-internals/runtime/lib/mixins/action_handler.js",
-      "@ember/-internals/runtime/lib/mixins/comparable.js": "ember-source/@ember/-internals/runtime/lib/mixins/comparable.js",
       "@ember/-internals/runtime/lib/mixins/container_proxy.js": "ember-source/@ember/-internals/runtime/lib/mixins/container_proxy.js",
       "@ember/-internals/runtime/lib/mixins/registry_proxy.js": "ember-source/@ember/-internals/runtime/lib/mixins/registry_proxy.js",
       "@ember/-internals/runtime/lib/mixins/target_action_support.js": "ember-source/@ember/-internals/runtime/lib/mixins/target_action_support.js",

packages/@ember/-internals/runtime/index.ts

@@ -1,6 +1,5 @@
 export { default as RegistryProxyMixin } from './lib/mixins/registry_proxy';
 export { default as ContainerProxyMixin } from './lib/mixins/container_proxy';
-export { default as Comparable } from './lib/mixins/comparable';
 export { default as ActionHandler } from './lib/mixins/action_handler';
 export { default as MutableEnumerable } from '@ember/enumerable/mutable';
 export { default as TargetActionSupport } from './lib/mixins/target_action_support';

packages/@ember/-internals/runtime/lib/mixins/comparable.ts

@@ -1,6 +1,5 @@
 import type { TypeName } from './type-of';
 import typeOf from './type-of';
-import { Comparable } from '@ember/-internals/runtime';
 import { assert } from '@ember/debug';
 
 const TYPE_ORDER: Record<TypeName, number> = {
@@ -104,15 +103,6 @@ export default function compare<T>(v: T, w: T): Compare {
   let type1 = typeOf(v);
   let type2 = typeOf(w);
 
-  if (type1 === 'instance' && isComparable(v) && v.constructor.compare) {
-    return v.constructor.compare(v, w);
-  }
-
-  if (type2 === 'instance' && isComparable(w) && w.constructor.compare) {
-    // SAFETY: Multiplying by a negative just changes the sign
-    return (w.constructor.compare(w, v) * -1) as Compare;
-  }
-
   let res = spaceship(TYPE_ORDER[type1], TYPE_ORDER[type2]);
 
   if (res !== 0) {
@@ -149,9 +139,6 @@ export default function compare<T>(v: T, w: T): Compare {
       return spaceship(vLen, wLen);
     }
     case 'instance':
-      if (isComparable(v) && v.compare) {
-        return v.compare(v, w);
-      }
       return 0;
 
     case 'date':
@@ -162,11 +149,3 @@ export default function compare<T>(v: T, w: T): Compare {
       return 0;
   }
 }
-
-interface ComparableConstructor {
-  constructor: Comparable;
-}
-
-function isComparable(value: unknown): value is Comparable & ComparableConstructor {
-  return Comparable.detect(value);
-}

packages/@ember/-internals/runtime/tests/mixins/comparable_test.js

@@ -1,16 +1,8 @@
 import { compare, typeOf } from '@ember/utils';
 import EmberObject from '@ember/object';
-import { Comparable } from '@ember/-internals/runtime';
 import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
 
 let data = [];
-let Comp = EmberObject.extend(Comparable);
-
-Comp.reopenClass({
-  compare(obj) {
-    return obj.get('val');
-  },
-});
 
 moduleFor(
   'Ember.compare()',
@@ -62,27 +54,5 @@ moduleFor(
         }
       }
     }
-
-    ['@test comparables should return values in the range of -1, 0, 1'](assert) {
-      let negOne = Comp.create({
-        val: -1,
-      });
-
-      let zero = Comp.create({
-        val: 0,
-      });
-
-      let one = Comp.create({
-        val: 1,
-      });
-
-      assert.equal(compare(negOne, 'a'), -1, 'First item comparable - returns -1 (not negated)');
-      assert.equal(compare(zero, 'b'), 0, 'First item comparable - returns  0 (not negated)');
-      assert.equal(compare(one, 'c'), 1, 'First item comparable - returns  1 (not negated)');
-
-      assert.equal(compare('a', negOne), 1, 'Second item comparable - returns -1 (negated)');
-      assert.equal(compare('b', zero), 0, 'Second item comparable - returns  0 (negated)');
-      assert.equal(compare('c', one), -1, 'Second item comparable - returns  1 (negated)');
-    }
   }
 );

packages/@ember/utils/lib/compare.ts

@@ -48,7 +48,6 @@ import {
   RegistryProxyMixin,
   ContainerProxyMixin,
   RSVP as _RSVP,
-  Comparable as InternalComparable,
   ActionHandler as InternalActionHandler,
 } from '@ember/-internals/runtime';
 import {
@@ -183,8 +182,6 @@ namespace Ember {
   export const _RegistryProxyMixin = RegistryProxyMixin;
   export const ActionHandler = InternalActionHandler;
   export type ActionHandler = InternalActionHandler;
-  export const Comparable = InternalComparable;
-  export type Comparable = InternalComparable;
 
   // ****@ember/-internals/view****
   export const ComponentLookup = views.ComponentLookup;

packages/@ember/utils/tests/compare_test.js

@@ -333,7 +333,6 @@ let allExports = [
   ['_Input', '@ember/-internals/glimmer', 'Input', test56],
   ['_RegistryProxyMixin', '@ember/-internals/runtime', 'RegistryProxyMixin', test57],
   ['_ContainerProxyMixin', '@ember/-internals/runtime', 'ContainerProxyMixin', test57],
-  ['Comparable', '@ember/-internals/runtime', null, test57],
   ['ActionHandler', '@ember/-internals/runtime', null, test57],
   ['MutableEnumerable', '@ember/-internals/runtime', null, test57],
   ['controllerFor', '@ember/-internals/routing', null, test58],