add direction abbr options with tests

1 files changed, 28 insertions, 12 deletions

diff --git a/lib/address.js b/lib/address.js
index 5d98554e..21e14ff6 100644
--- a/lib/address.js
+++ b/lib/address.js
@@ -231,46 +231,62 @@ function Address (faker) {
    *  direction
    *
    * @method faker.address.direction
+   * @param {Boolean} useAbbr return direction abbreviation. defaults to false
    */
-  this.direction = function () {
-    return faker.random.arrayElement(faker.definitions.address.direction);
+  this.direction = function (useAbbr) {
+    if (typeof useAbbr === 'undefined' || useAbbr === false) {
+      return faker.random.arrayElement(faker.definitions.address.direction);
+    }
+    return faker.random.arrayElement(faker.definitions.address.direction_abbr);
   }
 
   this.direction.schema = {
-    "description": "Generates a direction.",
-    "sampleResults": ["NW", "S", "SW", "E"]
+    "description": "Generates a direction. Use optional useAbbr bool to return abbrevation",
+    "sampleResults": ["Northwest", "South", "SW", "E"]
   };
 
   /**
    * cardinal direction
    *
    * @method faker.address.cardinalDirection
+   * @param {Boolean} useAbbr return direction abbreviation. defaults to false
    */
-  this.cardinalDirection = function () {
+  this.cardinalDirection = function (useAbbr) {
+    if (typeof useAbbr === 'undefined' || useAbbr === false) {
+      return (
+        faker.random.arrayElement(faker.definitions.address.direction.slice(0, 4))
+      );
+    }
     return (
-      faker.random.arrayElement(faker.definitions.address.direction.slice(0, 4))
+      faker.random.arrayElement(faker.definitions.address.direction_abbr.slice(0, 4))
     );
   }
 
   this.cardinalDirection.schema = {
-    "description": "Generates a cardinal direction.",
-    "sampleResults": ["N", "S", "E", "W"]
+    "description": "Generates a cardinal direction. Use optional useAbbr boolean to return abbrevation",
+    "sampleResults": ["North", "South", "E", "W"]
   };
 
   /**
    * ordinal direction
    *
    * @method faker.address.ordinalDirection
+   * @param {Boolean} useAbbr return direction abbreviation. defaults to false
    */
-  this.ordinalDirection = function () {
+  this.ordinalDirection = function (useAbbr) {
+    if (typeof useAbbr === 'undefined' || useAbbr === false) {
+      return (
+        faker.random.arrayElement(faker.definitions.address.direction.slice(4, 8))
+      );
+    }
     return (
-      faker.random.arrayElement(faker.definitions.address.direction.slice(4, 8))
+      faker.random.arrayElement(faker.definitions.address.direction_abbr.slice(4, 8))
     );
   }
 
   this.ordinalDirection.schema = {
-    "description": "Generates an ordinal direction.",
-    "sampleResults": ["NW", "SE", "SW", "NE"]
+    "description": "Generates an ordinal direction. Use optional useAbbr boolean to return abbrevation",
+    "sampleResults": ["Northwest", "Southeast", "SW", "NE"]
   };
 
   return this;