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

[RFC#236] Deprecate String prototype extensions #19234

Merged
merged 4 commits into from
Nov 11, 2020
Merged

[RFC#236] Deprecate String prototype extensions #19234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ec07cdc
deprecate String prototype extensions
locks Oct 27, 2020
591be24
point deprecation to ember-source
locks Oct 27, 2020
6e1c963
expect prototype extension deprecation in tests
locks Oct 27, 2020
1af2d49
annotated String.prototype extensions as deprecated
locks Oct 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 35 additions & 21 deletions packages/@ember/string/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export { getStrings as _getStrings, setStrings as _setStrings } from './lib/stri

import { ENV } from '@ember/-internals/environment';
import { Cache } from '@ember/-internals/utils';
import { deprecate } from '@ember/debug';
import { getString } from './lib/string_registry';

const STRING_DASHERIZE_REGEXP = /[ _]/g;
Expand Down Expand Up @@ -279,6 +280,26 @@ export function capitalize(str: string): string {
}

if (ENV.EXTEND_PROTOTYPES.String) {
let deprecateEmberStringPrototypeExtension = function (
name: string,
fn: (utility: string, ...options: any) => string | string[],
message = `String prototype extensions are deprecated. Please import ${name} from '@ember/string' instead.`
) {
return function (this: string) {
deprecate(message, false, {
id: 'ember-string.prototype-extensions',
for: 'ember-source',
since: {
available: '3.24',
},
until: '4.0.0',
url: 'https://deprecations.emberjs.com/v3.x/#toc_ember-string-prototype_extensions',
});

return fn(this, ...arguments);
};
};

Object.defineProperties(String.prototype, {
/**
See [String.w](/ember/release/classes/String/methods/w?anchor=w).
Expand All @@ -287,14 +308,13 @@ if (ENV.EXTEND_PROTOTYPES.String) {
@for @ember/string
@static
@private
@deprecated
*/
w: {
configurable: true,
enumerable: false,
writeable: true,
value() {
return w(this);
},
value: deprecateEmberStringPrototypeExtension('w', w),
},

/**
Expand All @@ -321,14 +341,13 @@ if (ENV.EXTEND_PROTOTYPES.String) {
@for @ember/string
@static
@private
@deprecated
*/
camelize: {
configurable: true,
enumerable: false,
writeable: true,
value() {
return camelize(this);
},
value: deprecateEmberStringPrototypeExtension('camelize', camelize),
},

/**
Expand All @@ -338,14 +357,13 @@ if (ENV.EXTEND_PROTOTYPES.String) {
@for @ember/string
@static
@private
@deprecated
*/
decamelize: {
configurable: true,
enumerable: false,
writeable: true,
value() {
return decamelize(this);
},
value: deprecateEmberStringPrototypeExtension('decamelize', decamelize),
},

/**
Expand All @@ -355,14 +373,13 @@ if (ENV.EXTEND_PROTOTYPES.String) {
@for @ember/string
@static
@private
@deprecated
*/
dasherize: {
configurable: true,
enumerable: false,
writeable: true,
value() {
return dasherize(this);
},
value: deprecateEmberStringPrototypeExtension('dasherize', dasherize),
},

/**
Expand All @@ -372,14 +389,13 @@ if (ENV.EXTEND_PROTOTYPES.String) {
@for @ember/string
@static
@private
@deprecated
*/
underscore: {
configurable: true,
enumerable: false,
writeable: true,
value() {
return underscore(this);
},
value: deprecateEmberStringPrototypeExtension('underscore', underscore),
},

/**
Expand All @@ -389,14 +405,13 @@ if (ENV.EXTEND_PROTOTYPES.String) {
@for @ember/string
@static
@private
@deprecated
*/
classify: {
configurable: true,
enumerable: false,
writeable: true,
value() {
return classify(this);
},
value: deprecateEmberStringPrototypeExtension('classify', classify),
},

/**
Expand All @@ -406,14 +421,13 @@ if (ENV.EXTEND_PROTOTYPES.String) {
@for @ember/string
@static
@private
@deprecated
*/
capitalize: {
configurable: true,
enumerable: false,
writeable: true,
value() {
return capitalize(this);
},
value: deprecateEmberStringPrototypeExtension('capitalize', capitalize),
},
});
}
4 changes: 3 additions & 1 deletion packages/@ember/string/tests/camelize_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
function test(assert, given, expected, description) {
assert.deepEqual(camelize(given), expected, description);
if (ENV.EXTEND_PROTOTYPES.String) {
assert.deepEqual(given.camelize(), expected, description);
expectDeprecation(() => {
assert.deepEqual(given.camelize(), expected, description);
}, /String prototype extensions are deprecated/);
}
}

Expand Down
4 changes: 3 additions & 1 deletion packages/@ember/string/tests/capitalize_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
function test(assert, given, expected, description) {
assert.deepEqual(capitalize(given), expected, description);
if (ENV.EXTEND_PROTOTYPES.String) {
assert.deepEqual(given.capitalize(), expected, description);
expectDeprecation(() => {
assert.deepEqual(given.capitalize(), expected, description);
}, /String prototype extensions are deprecated/);
}
}

Expand Down
4 changes: 3 additions & 1 deletion packages/@ember/string/tests/classify_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
function test(assert, given, expected, description) {
assert.deepEqual(classify(given), expected, description);
if (ENV.EXTEND_PROTOTYPES.String) {
assert.deepEqual(given.classify(), expected, description);
expectDeprecation(() => {
assert.deepEqual(given.classify(), expected, description);
}, /String prototype extensions are deprecated/);
}
}

Expand Down
4 changes: 3 additions & 1 deletion packages/@ember/string/tests/dasherize_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
function test(assert, given, expected, description) {
assert.deepEqual(dasherize(given), expected, description);
if (ENV.EXTEND_PROTOTYPES.String) {
assert.deepEqual(given.dasherize(), expected, description);
expectDeprecation(() => {
assert.deepEqual(given.dasherize(), expected, description);
}, /String prototype extensions are deprecated/);
}
}

Expand Down
4 changes: 3 additions & 1 deletion packages/@ember/string/tests/decamelize_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
function test(assert, given, expected, description) {
assert.deepEqual(decamelize(given), expected, description);
if (ENV.EXTEND_PROTOTYPES.String) {
assert.deepEqual(given.decamelize(), expected, description);
expectDeprecation(() => {
assert.deepEqual(given.decamelize(), expected, description);
}, /String prototype extensions are deprecated/);
}
}

Expand Down
4 changes: 3 additions & 1 deletion packages/@ember/string/tests/underscore_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
function test(assert, given, expected, description) {
assert.deepEqual(underscore(given), expected, description);
if (ENV.EXTEND_PROTOTYPES.String) {
assert.deepEqual(given.underscore(), expected, description);
expectDeprecation(() => {
assert.deepEqual(given.underscore(), expected, description);
}, /String prototype extensions are deprecated/);
}
}

Expand Down
4 changes: 3 additions & 1 deletion packages/@ember/string/tests/w_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ import { moduleFor, AbstractTestCase } from 'internal-test-helpers';
function test(assert, given, expected, description) {
assert.deepEqual(w(given), expected, description);
if (ENV.EXTEND_PROTOTYPES.String) {
assert.deepEqual(given.w(), expected, description);
expectDeprecation(() => {
assert.deepEqual(given.w(), expected, description);
}, /String prototype extensions are deprecated/);
}
}

Expand Down