feat: implements trim, upper tags and allows tags to be composed

Author: customcommander

README.md

@@ -1,17 +1,41 @@
 ## API
 
-* <a name="#hide"></a>hide - _Hides interpolated values_
+* <a name="hide">hide</a> - _Hides interpolated values_
+* <a name="trim">trim</a> - _Trim interpolated values_
+* <a name="upper">upper</a> - _Uppercase interpolated values_
 
-### hide
+### <a name="#hide"></a>hide
 
-Hides interpolated values
 
 The `hide` tag replaces all interpolated values with 'xxx':
 
 ```javascript
 hide`Hi ${name}, you credit card number is ${cc_num}`
 //=> "Hi xxx, you credit card number is xxx"
 ```
+### <a name="#trim"></a>trim
+
+
+Trim all interpolated values if they are strings.
+Non-string values are left as is.
+
+```javascript
+const name = '   John    ';
+trim`My name is ${name}!`;
+//=> "My name is John!"
+```
+### <a name="#upper"></a>upper
+
+
+Uppercase all interpolated values if they are strings.
+Non-string values are left as is.
+
+```javascript
+const name = 'john';
+const age = 40;
+upper`My name is ${name} and I am ${age} years old`
+//=> "My name is JOHN and I am 40 years old"
+```
 
 ## Contributing
 

index.js

@@ -1,5 +1,19 @@
+const tag_function = require('./src/utils/tag_function');
+const join = require('./src/utils/join');
+const intersperse = require('./src/utils/intersperse');
+const compose = require('./src/utils/compose');
 const hide = require('./src/hide');
+const trim = require('./src/trim');
+const upper = require('./src/upper');
 
-module.exports = {
-  hide
-};
+const tag = (...fns) =>
+  (strs, ...vals) =>
+    compose(join(''), ...fns.map(tag_function.unwrap))
+      (intersperse(strs, vals));
+
+tag.hide = tag_function(hide);
+tag.trim = tag_function(trim);
+tag.upper = tag_function(upper);
+tag.of = tag_function;
+
+module.exports = tag;

index.test.js

@@ -0,0 +1,35 @@
+const test = require('tape');
+const tag = require('./');
+const {trim, upper} = tag;
+
+test('tag: can compose other tags', t => {
+  t.plan(1);
+
+  const foo = '  foo  ';
+  const bar = '  bar  ';
+
+  t.is
+    ( tag(upper, trim)`foo=${foo}, bar=${bar}`
+    , "foo=FOO, bar=BAR"
+    );
+});
+
+test('tag: can compose user-defined tags', t => {
+  t.plan(1);
+
+  const foo = '  foo  ';
+  const bar = '  bar  ';
+
+  const myTag =
+    tag.of(
+      (l, x, r) =>
+        [ '|'
+        , x
+        , '|'
+        ]);
+
+  t.is
+    ( tag(upper, myTag, trim)`foo=${foo}, bar=${bar}`
+    , "|FOO|BAR|"
+    );
+});

package.json

@@ -11,7 +11,7 @@
   "author": "customcommander <hello@spinjs.com>",
   "license": "MIT",
   "scripts": {
-    "test": "tape src/*.test.js",
+    "test": "tape index.test.js src/*.test.js",
     "doc": "make README.md"
   },
   "devDependencies": {

src/hide.js

@@ -21,17 +21,6 @@
  * SOFTWARE.
  */
 
-const {intersperse, constant} = require('./utils');
-
-const hide = (strings, ...values) =>
-  intersperse
-    ( strings
-    , values.map
-        ( constant('xxx')
-        )
-    )
-    .join('');
-
 /**
  * Hides interpolated values
  *
@@ -42,4 +31,9 @@ const hide = (strings, ...values) =>
  * //=> "Hi xxx, you credit card number is xxx"
  * ```
  */
-module.exports = hide;
+module.exports =
+  (l, x, r) =>
+    [ l
+    , 'xxx'
+    , r
+    ];

src/hide.test.js

@@ -1,11 +1,14 @@
 const test = require('tape');
-const sut = require('./hide');
+const { hide } = require('../');
 
 test('hide: hides all values', t => {
   t.plan(1);
 
   const foo = 'foo';
   const bar = 'bar';
 
-  t.is( sut`foo=${foo}, bar=${bar}`, "foo=xxx, bar=xxx");
+  t.is
+    ( hide`foo=${foo}, bar=${bar}`
+    , "foo=xxx, bar=xxx"
+    );
 });

src/trim.js

@@ -0,0 +1,43 @@
+/**
+ * @license
+ * Copyright (c) 2019 Julien Gonzalez
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * Trim interpolated values
+ *
+ * Trim all interpolated values if they are strings.
+ * Non-string values are left as is.
+ *
+ * ```javascript
+ * const name = '   John    ';
+ * trim`My name is ${name}!`;
+ * //=> "My name is John!"
+ * ```
+ */
+module.exports =
+  (l, x, r) =>
+    [ l
+    , typeof x === 'string'
+        ? x.trim()
+        : x
+    , r
+    ]

src/trim.test.js

@@ -0,0 +1,14 @@
+const test = require('tape');
+const { trim } = require('../');
+
+test('trim: trim all values', t => {
+  t.plan(1);
+
+  const foo = ' f oo ';
+  const bar = ' b ar ';
+
+  t.is
+    ( trim`foo=${foo} , bar=${bar} `
+    , "foo=f oo , bar=b ar "
+    );
+});

src/upper.js

@@ -0,0 +1,44 @@
+/**
+ * @license
+ * Copyright (c) 2019 Julien Gonzalez
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+/**
+ * Uppercase interpolated values
+ *
+ * Uppercase all interpolated values if they are strings.
+ * Non-string values are left as is.
+ *
+ * ```javascript
+ * const name = 'john';
+ * const age = 40;
+ * upper`My name is ${name} and I am ${age} years old`
+ * //=> "My name is JOHN and I am 40 years old"
+ * ```
+ */
+module.exports =
+  (l, x, r) =>
+    [ l
+    , typeof x === 'string'
+        ? x.toUpperCase()
+        : x
+    , r
+    ];

src/upper.test.js

@@ -0,0 +1,14 @@
+const test = require('tape');
+const { upper } = require('../');
+
+test('upper: uppercase all values', t => {
+  t.plan(1);
+
+  const foo = 'foo';
+  const bar = 'bar';
+
+  t.is
+    ( upper`foo=${foo}, bar=${bar}`
+    , "foo=FOO, bar=BAR"
+    );
+});