From b51ed717961ff487657a461860c83c91c2650427 Mon Sep 17 00:00:00 2001 From: Jaco Greeff Date: Wed, 28 Oct 2020 13:52:40 +0100 Subject: [PATCH] string* takes in String (class) inputs (#732) --- CHANGELOG.md | 3 +++ packages/util/src/string/camelCase.spec.ts | 6 ++++++ packages/util/src/string/camelCase.ts | 11 +++++++++-- packages/util/src/string/lowerFirst.spec.ts | 6 ++++++ packages/util/src/string/lowerFirst.ts | 3 ++- packages/util/src/string/shorten.spec.ts | 6 ++++++ packages/util/src/string/shorten.ts | 6 +++--- packages/util/src/string/toHex.spec.ts | 6 ++++++ packages/util/src/string/toHex.ts | 3 ++- packages/util/src/string/toU8a.spec.ts | 12 +++++++++--- packages/util/src/string/toU8a.ts | 5 +++-- packages/util/src/string/upperFirst.spec.ts | 6 ++++++ packages/util/src/string/upperFirst.ts | 3 ++- 13 files changed, 63 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ce1861d88..f06a57ebe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,9 @@ Changes: - Remove the use of `chalk` (logger) for less overall dependencies +- `string*` utilities now also allows `String` (class) inputs +- Align bip39 use with wasm-crypto for English-only wordlist, default, non supplied) +- Adjust elliptic imports for explicit paths (allows tree-shaking) ## 3.6.1 Oct 18, 2020 diff --git a/packages/util/src/string/camelCase.spec.ts b/packages/util/src/string/camelCase.spec.ts index cf6139b50..bf1a134c3 100644 --- a/packages/util/src/string/camelCase.spec.ts +++ b/packages/util/src/string/camelCase.spec.ts @@ -9,4 +9,10 @@ describe('stringCamelCase', (): void => { stringCamelCase('Snake_case') ).toBe('snakeCase'); }); + + it('works correctly for String (class', (): void => { + expect( + stringCamelCase(String('Snake_case')) + ).toBe('snakeCase'); + }); }); diff --git a/packages/util/src/string/camelCase.ts b/packages/util/src/string/camelCase.ts index e2b8edcd7..b572e3ee6 100644 --- a/packages/util/src/string/camelCase.ts +++ b/packages/util/src/string/camelCase.ts @@ -1,6 +1,13 @@ // Copyright 2017-2020 @polkadot/util authors & contributors // SPDX-License-Identifier: Apache-2.0 -import stringCamelCase from 'camelcase'; +import camelcase from 'camelcase'; -export default stringCamelCase; +/** + * @name stringCamelCase + * @summary Convert a dash/dot/underscore/space separated string/String to camelCase + */ +// eslint-disable-next-line @typescript-eslint/ban-types +export default function stringCamelCase (value: string | String): string { + return camelcase(value.toString()); +} diff --git a/packages/util/src/string/lowerFirst.spec.ts b/packages/util/src/string/lowerFirst.spec.ts index 9b0abec6c..ab919d693 100644 --- a/packages/util/src/string/lowerFirst.spec.ts +++ b/packages/util/src/string/lowerFirst.spec.ts @@ -10,6 +10,12 @@ describe('stringLowerFirst', (): void => { ).toBe('aBC'); }); + it("lowers the first letter if it's a capital letter (String)", (): void => { + expect( + stringLowerFirst(String('ABC')) + ).toBe('aBC'); + }); + it("lowers the first letter if it's a lowercase letter", (): void => { expect( stringLowerFirst('abc') diff --git a/packages/util/src/string/lowerFirst.ts b/packages/util/src/string/lowerFirst.ts index 52e7cf871..c94b98e73 100644 --- a/packages/util/src/string/lowerFirst.ts +++ b/packages/util/src/string/lowerFirst.ts @@ -15,7 +15,8 @@ * stringLowerFirst('ABC'); // => 'aBC' * ``` */ -export default function stringLowerFirst (value?: string | null): string { +// eslint-disable-next-line @typescript-eslint/ban-types +export default function stringLowerFirst (value?: string | String | null): string { return value ? value.charAt(0).toLowerCase() + value.slice(1) : ''; diff --git a/packages/util/src/string/shorten.spec.ts b/packages/util/src/string/shorten.spec.ts index a7bfe8900..df343c3cb 100644 --- a/packages/util/src/string/shorten.spec.ts +++ b/packages/util/src/string/shorten.spec.ts @@ -15,4 +15,10 @@ describe('stringShorten', (): void => { stringShorten('0123456789', 3) ).toEqual('012…789'); }); + + it('returns the shortened value when > maxLength (String)', (): void => { + expect( + stringShorten(String('0123456789'), 3) + ).toEqual('012…789'); + }); }); diff --git a/packages/util/src/string/shorten.ts b/packages/util/src/string/shorten.ts index 4ea0549db..7f4447740 100644 --- a/packages/util/src/string/shorten.ts +++ b/packages/util/src/string/shorten.ts @@ -15,10 +15,10 @@ * stringShorten('1234567890', 2); // => 12..90 * ``` */ -// eslint-disable-next-line @typescript-eslint/no-explicit-any -export default function stringShorten (value: string, prefixLength = 6): string { +// eslint-disable-next-line @typescript-eslint/ban-types +export default function stringShorten (value: String | string, prefixLength = 6): string { if (value.length <= 2 + 2 * prefixLength) { - return value; + return value.toString(); } return `${value.substr(0, prefixLength)}…${value.slice(-prefixLength)}`; diff --git a/packages/util/src/string/toHex.spec.ts b/packages/util/src/string/toHex.spec.ts index 20d8f0950..e093d51e0 100644 --- a/packages/util/src/string/toHex.spec.ts +++ b/packages/util/src/string/toHex.spec.ts @@ -15,4 +15,10 @@ describe('hexToString', (): void => { stringToHex('hello') ).toEqual('0x68656c6c6f'); }); + + it('converts to a hex from String', (): void => { + expect( + stringToHex(String('hello')) + ).toEqual('0x68656c6c6f'); + }); }); diff --git a/packages/util/src/string/toHex.ts b/packages/util/src/string/toHex.ts index 022987051..fd7cd540c 100644 --- a/packages/util/src/string/toHex.ts +++ b/packages/util/src/string/toHex.ts @@ -18,7 +18,8 @@ import stringToU8a from './toU8a'; * stringToU8a('hello'); // 0x68656c6c6f * ``` */ -export default function stringToHex (value?: string): string { +// eslint-disable-next-line @typescript-eslint/ban-types +export default function stringToHex (value?: String | string): string { return u8aToHex( stringToU8a(value) ); diff --git a/packages/util/src/string/toU8a.spec.ts b/packages/util/src/string/toU8a.spec.ts index 54614db39..a5a6968a2 100644 --- a/packages/util/src/string/toU8a.spec.ts +++ b/packages/util/src/string/toU8a.spec.ts @@ -3,6 +3,8 @@ import { stringToU8a } from '..'; +const RUSS_HELLO = new Uint8Array([208, 159, 209, 128, 208, 184, 208, 178, 208, 181, 209, 130, 44, 32, 208, 188, 208, 184, 209, 128, 33]); + describe('stringToU8a', (): void => { it('decodes to an empty string for undefined', (): void => { expect( @@ -13,8 +15,12 @@ describe('stringToU8a', (): void => { it('encodes the string correctly', (): void => { expect( stringToU8a('Привет, мир!') - ).toEqual( - new Uint8Array([208, 159, 209, 128, 208, 184, 208, 178, 208, 181, 209, 130, 44, 32, 208, 188, 208, 184, 209, 128, 33]) - ); + ).toEqual(RUSS_HELLO); + }); + + it('encodes the string correctly (String)', (): void => { + expect( + stringToU8a(String('Привет, мир!')) + ).toEqual(RUSS_HELLO); }); }); diff --git a/packages/util/src/string/toU8a.ts b/packages/util/src/string/toU8a.ts index f348a21c7..275e8f141 100644 --- a/packages/util/src/string/toU8a.ts +++ b/packages/util/src/string/toU8a.ts @@ -19,8 +19,9 @@ const encoder = new TextEncoder(); * stringToU8a('hello'); // [0x68, 0x65, 0x6c, 0x6c, 0x6f] * ``` */ -export default function stringToU8a (value?: string): Uint8Array { +// eslint-disable-next-line @typescript-eslint/ban-types +export default function stringToU8a (value?: String | string): Uint8Array { return value - ? encoder.encode(value) + ? encoder.encode(value.toString()) : new Uint8Array(); } diff --git a/packages/util/src/string/upperFirst.spec.ts b/packages/util/src/string/upperFirst.spec.ts index c60576d9f..b56945757 100644 --- a/packages/util/src/string/upperFirst.spec.ts +++ b/packages/util/src/string/upperFirst.spec.ts @@ -16,6 +16,12 @@ describe('stringUpperFirst', (): void => { ).toBe('Abc'); }); + it("uppers the first letter if it's a lowercase letter (String)", (): void => { + expect( + stringUpperFirst(String('abc')) + ).toBe('Abc'); + }); + it('returns undefined as empty', (): void => { expect( stringUpperFirst() diff --git a/packages/util/src/string/upperFirst.ts b/packages/util/src/string/upperFirst.ts index d81e3797a..2d97ae022 100644 --- a/packages/util/src/string/upperFirst.ts +++ b/packages/util/src/string/upperFirst.ts @@ -15,7 +15,8 @@ * stringUpperFirst('abc'); // => 'Abc' * ``` */ -export default function stringUpperFirst (value?: string | null): string { +// eslint-disable-next-line @typescript-eslint/ban-types +export default function stringUpperFirst (value?: String | string | null): string { return value ? value.charAt(0).toUpperCase() + value.slice(1) : '';