diff --git a/packages/strings/.npmignore b/packages/strings/.npmignore new file mode 100644 index 0000000000..d703bda97a --- /dev/null +++ b/packages/strings/.npmignore @@ -0,0 +1,10 @@ +build +coverage +dev +doc +src* +test +.nyc_output +tsconfig.json +*.tgz +*.html diff --git a/packages/strings/LICENSE b/packages/strings/LICENSE new file mode 100644 index 0000000000..8dada3edaf --- /dev/null +++ b/packages/strings/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/packages/strings/README.md b/packages/strings/README.md new file mode 100644 index 0000000000..689e9735cc --- /dev/null +++ b/packages/strings/README.md @@ -0,0 +1,41 @@ +# @thi.ng/strings + +[![npm (scoped)](https://img.shields.io/npm/v/@thi.ng/strings.svg)](https://www.npmjs.com/package/@thi.ng/strings) + +This project is part of the +[@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo. + + + +- [About](#about) +- [Installation](#installation) +- [Usage examples](#usage-examples) +- [Authors](#authors) +- [License](#license) + + + +## About + +Various higher-order, but low-level string formatting & utility +functions, some memoized. WIP / Alpha. + +## Installation + +```bash +yarn add @thi.ng/strings +``` + +## Usage examples + +```ts +import * as str from "@thi.ng/strings"; +``` + +## Authors + +- Karsten Schmidt + +## License + +© 2018 Karsten Schmidt // Apache Software License 2.0 diff --git a/packages/strings/package.json b/packages/strings/package.json new file mode 100644 index 0000000000..0ca1930bef --- /dev/null +++ b/packages/strings/package.json @@ -0,0 +1,46 @@ +{ + "name": "@thi.ng/strings", + "version": "0.0.1", + "description": "Various string formatting & utility functions", + "main": "./index.js", + "typings": "./index.d.ts", + "repository": { + "type": "git", + "url": "https://github.com/thi-ng/umbrella.git" + }, + "homepage": "https://github.com/thi-ng/umbrella/tree/master/packages/format", + "author": "Karsten Schmidt ", + "license": "Apache-2.0", + "scripts": { + "build": "yarn run clean && tsc --declaration", + "clean": "rm -rf *.js *.d.ts .nyc_output build coverage doc", + "cover": "yarn test && nyc report --reporter=lcov", + "doc": "node_modules/.bin/typedoc --mode modules --out doc src", + "pub": "yarn run build && yarn publish --access public", + "test": "rm -rf build && tsc -p test && nyc mocha build/test/*.js" + }, + "devDependencies": { + "@types/mocha": "^5.2.5", + "@types/node": "^10.5.5", + "mocha": "^5.2.0", + "nyc": "^12.0.2", + "typedoc": "^0.11.1", + "typescript": "^3.0.1" + }, + "dependencies": { + "@thi.ng/memoize": "^0.0.1" + }, + "keywords": [ + "ES6", + "format", + "functional", + "higher order", + "padding", + "number", + "string", + "typescript" + ], + "publishConfig": { + "access": "public" + } +} \ No newline at end of file diff --git a/packages/strings/src/api.ts b/packages/strings/src/api.ts new file mode 100644 index 0000000000..f7b027b5bb --- /dev/null +++ b/packages/strings/src/api.ts @@ -0,0 +1 @@ +export type Stringer = (x: T) => string; diff --git a/packages/strings/src/case.ts b/packages/strings/src/case.ts new file mode 100644 index 0000000000..53cd218387 --- /dev/null +++ b/packages/strings/src/case.ts @@ -0,0 +1,25 @@ +import { Stringer } from "./api"; + +/** + * Uppercase string formatter. + * + * @param x string to transform + */ +export const upper: Stringer = + (x: string) => x.toUpperCase(); + +/** + * Lowercase string formatter. + * + * @param x string to transform + */ +export const lower: Stringer = + (x: string) => x.toLowerCase(); + +/** + * String formatter which capitalizes first character. + * + * @param x string to transform + */ +export const capitalize: Stringer = + (x: string) => x[0].toUpperCase() + x.substr(1); diff --git a/packages/strings/src/center.ts b/packages/strings/src/center.ts new file mode 100644 index 0000000000..82e4fa586d --- /dev/null +++ b/packages/strings/src/center.ts @@ -0,0 +1,21 @@ +import { memoizeJ } from "@thi.ng/memoize/memoizej"; + +import { Stringer } from "./api"; +import { repeat } from "./repeat"; + +/** + * @param n target length + * @param ch pad character(s) + */ +export const center: (n: number, ch?: string | number) => Stringer = + memoizeJ>((n, ch = " ") => { + const buf = repeat(ch, ((n + 1) & ~1) / 2); + return (x: any) => { + if (x == null) return buf; + x = x.toString(); + const r = (n - x.length) / 2; + return x.length < n ? + buf.substr(0, r) + x + buf.substr(0, r + ((n & 1) === (x.length & 1) ? 0 : 1)) : + x; + } + }); diff --git a/packages/strings/src/float.ts b/packages/strings/src/float.ts new file mode 100644 index 0000000000..d38dd99846 --- /dev/null +++ b/packages/strings/src/float.ts @@ -0,0 +1,14 @@ +import { memoizeJ } from "@thi.ng/memoize/memoizej"; + +import { Stringer } from "./api"; + +/** + * Returns `Stringer` which formats numbers to given precision. + * + * @param len number of fractional digits + * @kind function + */ +export const float = memoizeJ( + (prec: number): Stringer => + (x: number) => x.toFixed(prec) +); diff --git a/packages/strings/src/format.ts b/packages/strings/src/format.ts new file mode 100644 index 0000000000..cb3f15c0c9 --- /dev/null +++ b/packages/strings/src/format.ts @@ -0,0 +1,15 @@ +export const format = (fmt: any[], ...args: any[]) => { + const acc: any[] = []; + for (let i = 0, j = 0, n = fmt.length; i < n; i++) { + const f = fmt[i]; + const t = typeof f; + acc.push( + t === "function" ? + f(args[j++]) : + t === "object" ? + f[args[j++]] : + f + ); + } + return acc.join(""); +}; diff --git a/packages/strings/src/index.ts b/packages/strings/src/index.ts new file mode 100644 index 0000000000..6abe1783b5 --- /dev/null +++ b/packages/strings/src/index.ts @@ -0,0 +1,12 @@ +export * from "./api"; +export * from "./case"; +export * from "./center"; +export * from "./float"; +export * from "./format"; +export * from "./pad-left"; +export * from "./pad-right"; +export * from "./parse"; +export * from "./percent"; +export * from "./radix"; +export * from "./repeat"; +export * from "./truncate"; diff --git a/packages/strings/src/pad-left.ts b/packages/strings/src/pad-left.ts new file mode 100644 index 0000000000..9f77c0153f --- /dev/null +++ b/packages/strings/src/pad-left.ts @@ -0,0 +1,17 @@ +import { memoizeJ } from "@thi.ng/memoize/memoizej"; + +import { Stringer } from "./api"; +import { repeat } from "./repeat"; + +/** + * @param n target length + * @param ch pad character(s) + */ +export const padLeft: (n: number, ch?: string | number) => Stringer = + memoizeJ>((n, ch = " ") => { + const buf = repeat(ch, n); + return (x: any) => + x != null ? + (x = x.toString(), x.length < n ? buf.substr(x.length) + x : x) : + buf; + }); diff --git a/packages/strings/src/pad-right.ts b/packages/strings/src/pad-right.ts new file mode 100644 index 0000000000..2b2ff2e29f --- /dev/null +++ b/packages/strings/src/pad-right.ts @@ -0,0 +1,17 @@ +import { memoizeJ } from "@thi.ng/memoize/memoizej"; + +import { Stringer } from "./api"; +import { repeat } from "./repeat"; + +/** + * @param n target length + * @param ch pad character(s) + */ +export const padRight: (n: number, ch?: string | number) => Stringer = + memoizeJ>((n, ch = " ") => { + const buf = repeat(ch, n); + return (x: any) => + x != null ? + (x = x.toString(), x.length < n ? x + buf.substr(x.length) : x) : + buf; + }); diff --git a/packages/strings/src/parse.ts b/packages/strings/src/parse.ts new file mode 100644 index 0000000000..efaef03f42 --- /dev/null +++ b/packages/strings/src/parse.ts @@ -0,0 +1,9 @@ +export const parseInt = (x: string, defaultVal = 0, radix = 10) => { + const n = parseInt(x, radix); + return isNaN(n) ? defaultVal : n; +}; + +export const parseFloat = (x: string, defaultVal = 0) => { + const n = parseFloat(x); + return isNaN(n) ? defaultVal : n; +}; diff --git a/packages/strings/src/percent.ts b/packages/strings/src/percent.ts new file mode 100644 index 0000000000..cd6bd93645 --- /dev/null +++ b/packages/strings/src/percent.ts @@ -0,0 +1,10 @@ +import { Stringer } from "./api"; + +/** + * Returns `Stringer` which formats given fractions as percentage (e.g. + * `0.1234 => 12.34%`). + * + * @param prec number of fractional digits (default: 0) + */ +export const percent = (prec = 0): Stringer => + (x: number) => (x * 100).toFixed(prec) + "%"; diff --git a/packages/strings/src/radix.ts b/packages/strings/src/radix.ts new file mode 100644 index 0000000000..bd57d0e49a --- /dev/null +++ b/packages/strings/src/radix.ts @@ -0,0 +1,27 @@ +import { memoizeJ } from "@thi.ng/memoize/memoizej"; + +import { Stringer } from "./api"; +import { repeat } from "./repeat"; + +/** + * Returns a `Stringer` which formats given numbers to `radix` and `len`. + * + * @param radix + * @param len + */ +export const radix: (radix: number, len: number) => Stringer = + memoizeJ( + (radix: number, n: number) => { + const buf = repeat("0", n); + return (x: any) => { + x = (x >>> 0).toString(radix); + return x.length < n ? buf.substr(x.length) + x : x; + }; + } + ); + +export const B8 = radix(2, 8); +export const U8 = radix(16, 2); +export const U16 = radix(16, 4); +export const U32 = radix(16, 8); +export const U64 = (hi: number, lo: number) => U32(hi) + U32(lo); diff --git a/packages/strings/src/repeat.ts b/packages/strings/src/repeat.ts new file mode 100644 index 0000000000..8a5101500a --- /dev/null +++ b/packages/strings/src/repeat.ts @@ -0,0 +1,9 @@ +import { memoizeJ } from "@thi.ng/memoize/memoizej"; + +/** + * @param ch character + * @param n repeat count + */ +export const repeat = memoizeJ( + (ch: string, n: number) => new Array(n).fill(ch).join("") +); diff --git a/packages/strings/src/truncate.ts b/packages/strings/src/truncate.ts new file mode 100644 index 0000000000..c470a25fd1 --- /dev/null +++ b/packages/strings/src/truncate.ts @@ -0,0 +1,12 @@ +import { memoizeJ } from "@thi.ng/memoize/memoizej"; + +import { Stringer } from "./api"; + +export const truncate: (n: number, suffix?: string) => Stringer = + memoizeJ( + (n: number, suffix = "") => + (x) => + x.length > n ? + x.substr(0, n - suffix.length) + suffix : + x + ); diff --git a/packages/strings/test/index.ts b/packages/strings/test/index.ts new file mode 100644 index 0000000000..dac73b9054 --- /dev/null +++ b/packages/strings/test/index.ts @@ -0,0 +1,26 @@ +import * as assert from "assert"; +import * as str from "../src/index"; + +describe("strings", () => { + it("padLeft", () => { + assert.equal(str.padLeft(4)(undefined), " "); + assert.equal(str.padLeft(4, "0")(null), "0000"); + assert.equal(str.padLeft(4)(1), " 1"); + assert.equal(str.padLeft(4)(12), " 12"); + assert.equal(str.padLeft(4)(123), " 123"); + assert.equal(str.padLeft(4)(1234), "1234"); + assert.equal(str.padLeft(4)(12345), "12345"); + assert.strictEqual(str.padLeft(5), str.padLeft(5)); + }); + + it("padr", () => { + assert.equal(str.padRight(4)(undefined), " "); + assert.equal(str.padRight(4, "0")(null), "0000"); + assert.equal(str.padRight(4)(1), "1 "); + assert.equal(str.padRight(4)(12), "12 "); + assert.equal(str.padRight(4)(123), "123 "); + assert.equal(str.padRight(4)(1234), "1234"); + assert.equal(str.padRight(4)(12345), "12345"); + assert.strictEqual(str.padRight(5), str.padRight(5)); + }); +}); diff --git a/packages/strings/test/tsconfig.json b/packages/strings/test/tsconfig.json new file mode 100644 index 0000000000..bcf29ace54 --- /dev/null +++ b/packages/strings/test/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "../../../tsconfig.json", + "compilerOptions": { + "outDir": "../build" + }, + "include": [ + "./**/*.ts", + "../src/**/*.ts" + ] +} diff --git a/packages/strings/tsconfig.json b/packages/strings/tsconfig.json new file mode 100644 index 0000000000..bd6481a5a6 --- /dev/null +++ b/packages/strings/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "." + }, + "include": [ + "./src/**/*.ts" + ] +}