Merge pull request #53 from jaebradley/symbol-service

Symbol service - Adds support for OSes that don't support emojis

Author: jaebradley

src/executables/uber-price.js

@@ -3,9 +3,9 @@
 /* eslint-disable no-console */
 
 import program from 'commander';
-import emoji from 'node-emoji';
 
 import CommandExecutionService from '../services/CommandExecutionService';
+import SymbolService from '../services/symbols/SymbolService';
 
 const isUberError = error =>
   error.name === 'Uber Error' &&
@@ -20,6 +20,8 @@ const isDistanceExceededError = error =>
 
 const service = new CommandExecutionService();
 
+const symbolService = new SymbolService();
+
 program
   .option('-s, --start <start>', 'specify start address')
   .option('-e, --end <end>', 'specify end address')
@@ -31,7 +33,7 @@ try {
     .then(table => console.log(table))
     .catch((e) => {
       if (isDistanceExceededError(e)) {
-        console.log(`Maximum distance of ${emoji.get('100')}  miles exceeded between start address: ${program.start} and end address: ${program.end}`);
+        console.log(`Maximum distance of ${symbolService.getMaximumDistanceSymbol()}  miles exceeded between start address: ${program.start} and end address: ${program.end}`);
       } else {
         console.error('Could not get price estimates');
       }

src/services/CommandExecutionService.js

@@ -8,17 +8,19 @@ import TripPriceEstimateRowFormatter from './tables/TripPriceEstimateRowFormatte
 import TripPriceEstimatesTableBuilder from './tables/builders/TripPriceEstimatesTableBuilder';
 import PickupTimeEstimatesTableRowsBuilder from './tables/PickupTimeEstimatesTableRowsBuilder';
 import PickupTimeEstimatesTableBuilder from './tables/builders/PickupTimeEstimatesTableBuilder';
+import SymbolService from './symbols/SymbolService';
 
 export default class CommandExecutionService {
   constructor() {
     this.uberService = new UberService();
     this.distanceConverter = new DistanceConverter();
     this.durationConverter = new DurationConverter();
+    this.symbolService = new SymbolService();
     this.durationFormatter = new DurationFormatter(this.durationConverter);
-    this.tripPriceEstimateRowFormatter = new TripPriceEstimateRowFormatter(this.distanceConverter, this.durationFormatter); // eslint-disable-line max-len
-    this.tripPriceEstimatesTableBuilder = new TripPriceEstimatesTableBuilder(this.tripPriceEstimateRowFormatter); // eslint-disable-line max-len
-    this.pickupTimeEstimatesTableRowsBuilder = new PickupTimeEstimatesTableRowsBuilder(this.durationFormatter); // eslint-disable-line max-len
-    this.pickupTimeEstimatesTableBuilder = new PickupTimeEstimatesTableBuilder(this.pickupTimeEstimatesTableRowsBuilder); // eslint-disable-line max-len
+    this.tripPriceEstimateRowFormatter = new TripPriceEstimateRowFormatter(this.distanceConverter, this.durationFormatter, this.symbolService); // eslint-disable-line max-len
+    this.tripPriceEstimatesTableBuilder = new TripPriceEstimatesTableBuilder(this.tripPriceEstimateRowFormatter, this.symbolService); // eslint-disable-line max-len
+    this.pickupTimeEstimatesTableRowsBuilder = new PickupTimeEstimatesTableRowsBuilder(this.durationFormatter, this.symbolService); // eslint-disable-line max-len
+    this.pickupTimeEstimatesTableBuilder = new PickupTimeEstimatesTableBuilder(this.pickupTimeEstimatesTableRowsBuilder, this.symbolService); // eslint-disable-line max-len
   }
 
   executePriceEstimates(startAddress, endAddress, distanceUnitName) {

src/services/symbols/BaseSymbolService.js

@@ -0,0 +1,41 @@
+export default class BaseSymbolService {
+  getVehicleSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getPriceSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getTripDistanceSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getDurationSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getSurgeSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getNotApplicableSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getSurgePresentSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getDestinationSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getOriginSymbol() {
+    throw new Error('Not implemented');
+  }
+
+  getMaximumDistanceSymbol() {
+    throw new Error('Not implemented');
+  }
+}

src/services/symbols/EmojiService.js

@@ -0,0 +1,46 @@
+import emoji from 'node-emoji';
+
+import BaseSymbolService from './BaseSymbolService';
+
+
+export default class EmojiService extends BaseSymbolService {
+  getVehicleSymbol() {
+    return emoji.get('oncoming_automobile');
+  }
+
+  getPriceSymbol() {
+    return emoji.get('money_with_wings');
+  }
+
+  getTripDistanceSymbol() {
+    return emoji.get('arrows_clockwise');
+  }
+
+  getDurationSymbol() {
+    return emoji.get('hourglass_flowing_sand');
+  }
+
+  getSurgeSymbol() {
+    return emoji.get('boom');
+  }
+
+  getNotApplicableSymbol() {
+    return emoji.get('no_entry_sign');
+  }
+
+  getSurgePresentSymbol() {
+    return emoji.get('grimacing');
+  }
+
+  getDestinationSymbol() {
+    return emoji.get('end');
+  }
+
+  getOriginSymbol() {
+    return emoji.get('round_pushpin');
+  }
+
+  getMaximumDistanceSymbol() {
+    return emoji.get('100');
+  }
+}

src/services/symbols/SymbolService.js

@@ -0,0 +1,62 @@
+import { List } from 'immutable';
+
+import BaseSymbolService from './BaseSymbolService';
+import EmojiService from './EmojiService';
+import TextSymbolService from './TextSymbolService';
+
+export default class SymbolService extends BaseSymbolService {
+  constructor() {
+    super();
+    this.client = SymbolService.areEmojisSupported() ?
+                    new EmojiService() :
+                    new TextSymbolService();
+  }
+
+  static areEmojisSupported() {
+    return SymbolService.getEmojiSupportedOperatingSystems().contains(process.platform);
+  }
+
+  static getEmojiSupportedOperatingSystems() {
+    return List.of('darwin');
+  }
+
+  getVehicleSymbol() {
+    return this.client.getVehicleSymbol();
+  }
+
+  getPriceSymbol() {
+    return this.client.getPriceSymbol();
+  }
+
+  getTripDistanceSymbol() {
+    return this.client.getTripDistanceSymbol();
+  }
+
+  getDurationSymbol() {
+    return this.client.getDurationSymbol();
+  }
+
+  getSurgeSymbol() {
+    return this.client.getSurgeSymbol();
+  }
+
+  getNotApplicableSymbol() {
+    return this.client.getNotApplicableSymbol();
+  }
+
+  getSurgePresentSymbol() {
+    return this.client.getSurgePresentSymbol();
+  }
+
+  getDestinationSymbol() {
+    return this.client.getDestinationSymbol();
+  }
+
+  getOriginSymbol() {
+    return this.client.getOriginSymbol();
+  }
+
+  getMaximumDistanceSymbol() {
+    return this.client.getMaximumDistanceSymbol();
+  }
+}

src/services/symbols/TextSymbolService.js

@@ -0,0 +1,43 @@
+import BaseSymbolService from './BaseSymbolService';
+
+export default class TextSymbolService extends BaseSymbolService {
+  getVehicleSymbol() {
+    return 'Vehicle';
+  }
+
+  getPriceSymbol() {
+    return 'Price';
+  }
+
+  getTripDistanceSymbol() {
+    return 'Distance';
+  }
+
+  getDurationSymbol() {
+    return 'Duration';
+  }
+
+  getSurgeSymbol() {
+    return ' *';
+  }
+
+  getNotApplicableSymbol() {
+    return 'N/A';
+  }
+
+  getSurgePresentSymbol() {
+    return ':-(';
+  }
+
+  getDestinationSymbol() {
+    return 'Destination';
+  }
+
+  getOriginSymbol() {
+    return 'Origin';
+  }
+
+  getMaximumDistanceSymbol() {
+    return '100';
+  }
+}

src/services/tables/TripPriceEstimateRowFormatter.js

@@ -1,17 +1,19 @@
-import emoji from 'node-emoji';
+import CurrencySymbol from 'currency-symbol-map';
+
 import { List, Map } from 'immutable';
 
 import DistanceUnit from '../../data/DistanceUnit';
 
 export default class TripPriceEstimateRowFormatter {
-  constructor(distanceConverter, durationFormatter) {
+  constructor(distanceConverter, durationFormatter, symbolService) {
     const distanceUnitAbbreviations = {};
     distanceUnitAbbreviations[DistanceUnit.MILE.name] = 'mi';
     distanceUnitAbbreviations[DistanceUnit.KILOMETER.name] = 'km';
 
     this.distanceUnitAbbreviations = Map(distanceUnitAbbreviations);
     this.distanceConverter = distanceConverter;
     this.durationFormatter = durationFormatter;
+    this.symbolService = symbolService;
   }
 
   format(estimate, rowDistanceUnit) {
@@ -44,11 +46,9 @@ export default class TripPriceEstimateRowFormatter {
   }
 
   formatSurgeMultiplier(surgeMultiplier) {
-    if (surgeMultiplier > 1) {
-      return `${surgeMultiplier}x ${emoji.get('grimacing')}`;
-    }
-
-    return emoji.get('no_entry_sign');
+    return surgeMultiplier > 1 ?
+      `${surgeMultiplier}x ${this.symbolService.getSurgePresentSymbol()}` :
+      this.symbolService.getNotApplicableSymbol();
   }
 
   getDistanceUnitAbbreviation(unit) {

src/services/tables/builders/PickupTimeEstimatesTableBuilder.js

@@ -1,10 +1,10 @@
 import Table from 'cli-table2';
 import { List, Map } from 'immutable';
-import emoji from 'node-emoji';
 
 export default class PickupTimeEstimatesTableBuilder {
-  constructor(rowsBuilder) {
+  constructor(rowsBuilder, symbolService) {
     this.rowsBuilder = rowsBuilder;
+    this.symbolService = symbolService;
   }
 
   build(estimates) {
@@ -15,16 +15,16 @@ export default class PickupTimeEstimatesTableBuilder {
 
   getTableHeaders() {
     return List.of(
-      emoji.get('hourglass_flowing_sand'),
-      emoji.get('oncoming_automobile'),
+      this.symbolService.getDurationSymbol(),
+      this.symbolService.getVehicleSymbol(),
     );
   }
 
   getFormattedLocation(locationName) {
     return List.of(
       Map({
         colSpan: 2,
-        content: `${emoji.get('round_pushpin')} ${locationName}`,
+        content: `${this.symbolService.getOriginSymbol()} ${locationName}`,
         hAlign: 'center',
       }),
     );

src/services/tables/builders/TripPriceEstimatesTableBuilder.js

@@ -1,10 +1,10 @@
 import Table from 'cli-table2';
 import { List, Map } from 'immutable';
-import emoji from 'node-emoji';
 
 export default class TripPriceEstimatesTableBuilder {
-  constructor(rowFormatter) {
+  constructor(rowFormatter, symbolService) {
     this.rowFormatter = rowFormatter;
+    this.symbolService = symbolService;
   }
 
   build(estimates, presentationDistanceUnit) {
@@ -21,11 +21,11 @@ export default class TripPriceEstimatesTableBuilder {
 
   getTableHeaders() {
     return List.of(
-      emoji.get('oncoming_automobile'),
-      emoji.get('money_with_wings'),
-      emoji.get('arrows_clockwise'),
-      emoji.get('hourglass_flowing_sand'),
-      `${emoji.get('boom')} Surge${emoji.get('boom')}`,
+      this.symbolService.getVehicleSymbol(),
+      this.symbolService.getPriceSymbol(),
+      this.symbolService.getTripDistanceSymbol(),
+      this.symbolService.getDurationSymbol(),
+      `${this.symbolService.getSurgeSymbol()} Surge${this.symbolService.getSurgeSymbol()}`,
     );
   }
 
@@ -37,15 +37,10 @@ export default class TripPriceEstimatesTableBuilder {
   }
 
   buildLocationRow(name, isEnd) {
-    let symbol = emoji.get('round_pushpin');
-    if (isEnd) {
-      symbol = emoji.get('end');
-    }
-
     return List.of(
       Map({
         colSpan: 1,
-        content: symbol,
+        content: this.getEndSymbol(isEnd),
         hAlign: 'center',
       }),
       Map({
@@ -54,4 +49,10 @@ export default class TripPriceEstimatesTableBuilder {
       }),
     );
   }
+
+  getEndSymbol(isEnd) {
+    return isEnd ?
+      this.symbolService.getDestinationSymbol() :
+      this.symbolService.getOriginSymbol();
+  }
 }