Merge pull request react-ga#402 from hilezir/dev

add options.redactEmail, fix react-ga#144

.nvmrc

@@ -1 +1 @@
-8.9.0
+12.13.1

README.md

@@ -118,6 +118,7 @@ ReactGA.initialize([{
 |options.testMode| `Boolean`. Optional. Defaults to `false`. Enables test mode. See [here](https://github.com/react-ga/react-ga#test-mode) for more information.|
 |options.standardImplementation| `Boolean`. Optional. Defaults to `false`. Enables loading GA as google expects it. See [here](https://github.com/react-ga/react-ga#standard-implementation) for more information.|
 |options.useExistingGa| `Boolean`. Optional. Skips call to `window.ga()`, assuming you have manually run it.
+|options.redactEmail| `Boolean`. Optional. Defaults to `true`. Enables redacting a email as the string that in "Event Category" and "Event Action".
 
 If you are having additional troubles and setting `debug = true` shows as working please try using the [Chrome GA Debugger Extension](https://chrome.google.com/webstore/detail/google-analytics-debugger/jnkmfdileelhofjcijamephohjechhna).
 This will help you figure out if your implementation is off or your GA Settings are not correct.

package.json

@@ -89,8 +89,8 @@
     "react": "^15.6.2",
     "react-addons-test-utils": "^15.0.1",
     "react-dom": "^15.0.1",
-    "react-router": "4.4.0",
-    "react-router-dom": "4.4.0",
+    "react-router": "^5.1.2",
+    "react-router-dom": "^5.1.2",
     "rewire": "^2.5.2",
     "should": "^12.0.0",
     "sinon": "^3.2.1",

src/core.js

@@ -24,6 +24,7 @@ let _debug = false;
 let _titleCase = true;
 let _testMode = false;
 let _alwaysSendToDefaultTracker = true;
+let _redactEmail = true;
 
 const internalGa = (...args) => {
   if (_testMode) return TestModeAPI.ga(...args);
@@ -33,7 +34,7 @@ const internalGa = (...args) => {
 };
 
 function _format(s) {
-  return format(s, _titleCase);
+  return format(s, _titleCase, _redactEmail);
 }
 
 function _gaCommand(trackerNames, ...args) {
@@ -68,6 +69,10 @@ function _initialize(gaTrackingID, options) {
       _titleCase = false;
     }
 
+    if (options.redactEmail === false) {
+      _redactEmail = false;
+    }
+
     if (options.useExistingGa) {
       return;
     }

src/utils/format.js

@@ -1,18 +1,16 @@
-import mightBeEmail from './mightBeEmail';
+import redactEmail from './redactEmail';
 import toTitleCase from './toTitleCase';
-import warn from './console/warn';
 
-const redacted = 'REDACTED (Potential Email Address)';
+export default function format(s = '', titleCase, redactingEmail = true) {
+  let _str = s || '';
 
-export default function format(s, titleCase) {
-  if (mightBeEmail(s)) {
-    warn('This arg looks like an email address, redacting.');
-    return redacted;
+  if (titleCase) {
+    _str = toTitleCase(s);
   }
 
-  if (titleCase) {
-    return toTitleCase(s);
+  if (redactingEmail) {
+    _str = redactEmail(_str);
   }
 
-  return s;
+  return _str;
 }

src/utils/redactEmail.js

@@ -0,0 +1,13 @@
+import warn from './console/warn';
+import mightBeEmail from './mightBeEmail';
+
+const redacted = 'REDACTED (Potential Email Address)';
+
+export default function redactEmail(string) {
+  if (mightBeEmail(string)) {
+    warn('This arg looks like an email address, redacting.');
+    return redacted;
+  }
+
+  return string;
+}

test/utils/format.test.js

@@ -4,6 +4,14 @@ import sinon from 'sinon';
 import format from '../../src/utils/format';
 
 describe('format()', function () {
+  it('should not format when redactingEmail is false', function () {
+    const titleCase = false;
+    const redactingEmail = false;
+    format('[email protected]', titleCase, redactingEmail).should.eql('[email protected]');
+    format('[email protected]', titleCase, redactingEmail).should.eql('[email protected]');
+    format('[email protected]', titleCase, redactingEmail).should.eql('[email protected]');
+  });
+
   it('should not format email addresses', function () {
     sinon.stub(console, 'warn');
     console.warn.callCount.should.eql(0);

types/index.d.ts

@@ -65,6 +65,8 @@ export interface InitializeOptions {
     gaOptions?: GaOptions;
     alwaysSendToDefaultTracker?: boolean;
     standardImplementation?: boolean;
+    /** Optional. Defaults to `true`. Enables redacting a email as the string that in "Event Category" and "Event Action". */
+    redactEmail?: boolean;
     useExistingGa?: boolean;
 }