From a08d67d7f11861e3373e057cbf36d1576865c1b8 Mon Sep 17 00:00:00 2001
From: Kelvin <ktay@moneytree.jp>
Date: Wed, 8 Jan 2020 18:27:38 +0900
Subject: [PATCH] refactor: change `string` method name to `text`

---
 lib/index.js       | 14 +++++++-------
 test/index.test.js | 20 ++++++++++----------
 2 files changed, 17 insertions(+), 17 deletions(-)

diff --git a/lib/index.js b/lib/index.js
index dab059c..96f9266 100644
--- a/lib/index.js
+++ b/lib/index.js
@@ -12,7 +12,7 @@ const assertMaskIsString = (str) => {
   }
 };
 
-const string = (str, mask = '*') => {
+const text = (str, mask = '*') => {
   assertSubjectIsString(str);
   assertMaskIsString(mask);
 
@@ -40,7 +40,7 @@ const domain = (str, mask = '*') => {
   const tldIndex = str.lastIndexOf('.');
   if (tldIndex === -1) {
     // not a domain name
-    return string(str, mask);
+    return text(str, mask);
   }
 
   const start = str.slice(0, tldIndex);
@@ -48,10 +48,10 @@ const domain = (str, mask = '*') => {
 
   if (start.length === 0 || end.length === 0) {
     // not a domain name
-    return string(str, mask);
+    return text(str, mask);
   }
 
-  return `${string(start, mask)}.${end}`;
+  return `${text(start, mask)}.${end}`;
 };
 
 const email = (str, mask = '*') => {
@@ -61,17 +61,17 @@ const email = (str, mask = '*') => {
 
   if (parts.length !== 2) {
     // not an email address
-    return string(str, mask);
+    return text(str, mask);
   }
 
   const [start, end] = parts;
 
-  return `${string(start, mask)}@${domain(end, mask)}`;
+  return `${text(start, mask)}@${domain(end, mask)}`;
 };
 
 
 module.exports = {
-  string,
+  text,
   domain,
   email
 };
diff --git a/test/index.test.js b/test/index.test.js
index fa850fe..d59d194 100644
--- a/test/index.test.js
+++ b/test/index.test.js
@@ -1,13 +1,13 @@
-const { string, domain, email } = require('..');
+const { text, domain, email } = require('..');
 
 describe('Mask PII', () => {
-  test('string', () => {
-    expect(string('')).toEqual('********');
-    expect(string('a')).toEqual('a********');
-    expect(string('Hello world')).toEqual('H********d');
-    expect(string('Hello world', '★')).toEqual('H★★★★★★★★d');
-    expect(string('Hello world', '#')).toEqual('H########d');
-    expect(string('Hello world', '##')).toEqual('H################d');
+  test('text', () => {
+    expect(text('')).toEqual('********');
+    expect(text('a')).toEqual('a********');
+    expect(text('Hello world')).toEqual('H********d');
+    expect(text('Hello world', '★')).toEqual('H★★★★★★★★d');
+    expect(text('Hello world', '#')).toEqual('H########d');
+    expect(text('Hello world', '##')).toEqual('H################d');
 
     // test bad input
 
@@ -24,7 +24,7 @@ describe('Mask PII', () => {
 
     for (const input of notStrings) {
       expect(() => {
-        string(input);        // bad subject
+        text(input);         // bad subject
       }).toThrow(new TypeError('Subject is not a string'));
 
       expect(() => {
@@ -41,7 +41,7 @@ describe('Mask PII', () => {
       }
 
       expect(() => {
-        string('abc', input); // bad mask
+        text('abc', input); // bad mask
       }).toThrow(new TypeError('Mask is not a string'));
     }
   });