Remove propertyDeep, propertyDeepOf, and resultDeep in favor of deep property path support in existing methods.

lodash.src.js

@@ -1855,7 +1855,7 @@
         return baseMatches(func);
       }
       return typeof thisArg == 'undefined'
-        ? baseProperty(func + '')
+        ? property(func)
         : baseMatchesProperty(func + '', thisArg);
     }
 
@@ -2598,28 +2598,9 @@
       };
     }
 
-    /**
+    function basePropertyDeep(path) {
-     * The base implementation of `_.propertyDeep` which does not coerce `keys` to strings.
-     *
-     * @private
-     * @param {string[]} keys Keys that specify the property to get.
-     * @returns {Function} Returns the new function.
-     */
-    function basePropertyDeep(keys) {
       return function(object) {
-        if (object == null) {
+        return object == null ? undefined : getPath(object, path);
-          return undefined;
-        }
-        var index = -1,
-            length = keys.length;
-
-        while (++index < length) {
-          object = object[keys[index]];
-          if (object == null) {
-            return undefined;
-          }
-        }
-        return object;
       };
     }
 
@@ -4071,6 +4052,23 @@
       return collection ? result(collection, target, fromIndex) : result;
     }
 
+    function getPath(object, path) {
+      var index = -1,
+          length = path.length;
+
+      while (++index < length) {
+        object = object[path[index]];
+        if (object == null) {
+          return object;
+        }
+      }
+      return object;
+    }
+
+    function getProperty(object, path) {
+      return isKey(path) ? object[path] : getPath(object, toPath(path));
+    }
+
     /**
      * Gets the view, applying any `transforms` to the `start` and `end` positions.
      *
@@ -4218,6 +4216,10 @@
       return false;
     }
 
+    function isKey(value) {
+      return typeof value == 'string' && value.indexOf('.') < 0;
+    }
+
     /**
      * Checks if `func` has a lazy counterpart.
      *
@@ -4514,6 +4516,10 @@
       return isObject(value) ? value : Object(value);
     }
 
+    function toPath(value) {
+      return isArray(value) ? value : (value + '').split('.');
+    }
+
     /**
      * Converts `value` to an object if it is not one.
      *
@@ -6832,7 +6838,7 @@
      * // => [36, 40] (iteration order is not guaranteed)
      */
     function pluck(collection, key) {
-      return map(collection, baseProperty(key));
+      return map(collection, property(key));
     }
 
     /**
@@ -9793,7 +9799,7 @@
      * @memberOf _
      * @category Object
      * @param {Object} object The object to query.
-     * @param {string} key The key of the property to resolve.
+     * @param {string} path The path of the property to resolve.
      * @param {*} [defaultValue] The value returned if the property value
      *  resolves to `undefined`.
      * @returns {*} Returns the resolved value.
@@ -9813,53 +9819,14 @@
      * _.result(object, 'status', _.constant('busy'));
      * // => 'busy'
      */
-    function result(object, key, defaultValue) {
+    function result(object, path, defaultValue) {
-      var value = object == null ? undefined : object[key];
+      var value = object == null ? undefined : getProperty(object, path);
       if (typeof value == 'undefined') {
         value = defaultValue;
       }
       return isFunction(value) ? value.call(object) : value;
     }
 
-    /**
-     * Resolves the value of `keyPath` on `object`. If any values along `keyPath`
-     * is a function it is invoked with the `this` binding of `object` and its
-     * result is used to resolve the remainder of the `keyPath` rather than the
-     * function itself. If at any point along the `keyPath` the value is
-     * `undefined` the `defaultValue` is returned.
-     *
-     * @static
-     * @memberOf _
-     * @category Object
-     * @param {Object} object The object to query.
-     * @param {array} keyPath The key path of the properties to resolve.
-     * @param {*} [defaultValue] The value returned if the property value
-     *  resolves to `undefined`.
-     * @returns {*} Returns the resolved value.
-     * @example
-     *
-     * var object = {
-     *  'user': 'fred',
-     *  'dates': { 'birthdate': '03/17/1988', anniversary: '07/29/2012' }
-     * };
-     *
-     * _.resultDeep(object, ['user']);
-     * // => 'fred'
-     *
-     * _.resultDeep(object, ['user', 'dates', 'anniversary']);
-     * // => '07/29/2012'
-     *
-     * _.resultDeep(object, ['status', 'timestamp'], _.constant('busy'));
-     * // => 'busy'
-     */
-    function resultDeep(object, keyPath, defaultValue) {
-      arrayEach(dropRight(keyPath), function(key) {
-        object = result(object, key);
-        return object != null;
-      });
-      return result(object, last(keyPath), defaultValue);
-    }
-
     /**
      * An alternative to `_.reduce`; this method transforms `object` to a new
      * `accumulator` object which is the result of running each of its own enumerable
@@ -11242,12 +11209,12 @@
     }
 
     /**
-     * Creates a function which returns the property value of `key` on a given object.
+     * Creates a function which returns the property value of `path` on a given object.
      *
      * @static
      * @memberOf _
      * @category Utility
-     * @param {string} key The key of the property to get.
+     * @param {string} path The path of the property to get.
      * @returns {Function} Returns the new function.
      * @example
      *
@@ -11264,40 +11231,13 @@
      * _.pluck(_.sortBy(users, getName), 'user');
      * // => ['barney', 'fred']
      */
-    function property(key) {
+    function property(path) {
-      return baseProperty(key + '');
+      return isKey(path) ? baseProperty(path) : basePropertyDeep(toPath(path));
-    }
-
-    /**
-     * This function is like `_.property` except it takes a `keys` array to get nested property.
-     * @static
-     * @memberOf _
-     * @category Utility
-     * @param {string[]} keys Keys that specify the property to get.
-     * @returns {Function} Returns the new function.
-     * @example
-     *
-     * var users = [
-     *   { 'user': { 'name': 'fred' } },
-     *   { 'user': { 'name': 'barney', 'age': 36 } }
-     * ];
-     *
-     * var getName = _.propertyDeep(['user', 'name']);
-     * var getAge  = _.propertyDeep(['user', 'age']);
-     *
-     * _.map(users, getName);
-     * // => ['fred', 'barney']
-     *
-     * _.map(users, getAge);
-     * // => [undefined, 36]
-     */
-    function propertyDeep(keys) {
-      return basePropertyDeep(arrayMap(keys || [], baseToString));
     }
 
     /**
      * The opposite of `_.property`; this method creates a function which returns
-     * the property value of a given key on `object`.
+     * the property value of a given path on `object`.
      *
      * @static
      * @memberOf _
@@ -11315,38 +11255,8 @@
      * // => ['b', 'c', 'a']
      */
     function propertyOf(object) {
-      return function(key) {
+      return function(path) {
-        return object == null ? undefined : object[key];
+        return object == null ? undefined : getProperty(object, path);
-      };
-    }
-
-    /**
-     * The opposite of `_.propertyDeep`; this method creates a function which returns
-     * the property value of a given key path on `object`.
-     *
-     * @static
-     * @memberOf _
-     * @category Utility
-     * @param {Object} object The object to inspect.
-     * @returns {Function} Returns the new function.
-     * @example
-     *
-     * var users = [
-     *   { user: 'fredrick', nickname: 'fred' },
-     *   { user: 'bernard', nickname: 'barney' }
-     * ];
-     *
-     * var propertyOfUsers = _.propertyDeepOf(users);
-     *
-     * propertyOfUsers([0, 'nickname']);
-     * // => 'fred'
-     *
-     * propertyOfUsers([1, 'name']);
-     * // => 'bernard'
-     */
-    function propertyDeepOf(object) {
-      return function(keyPath) {
-        return resultDeep(object, keyPath);
       };
     }
 
@@ -11733,9 +11643,7 @@
     lodash.pick = pick;
     lodash.pluck = pluck;
     lodash.property = property;
-    lodash.propertyDeep = propertyDeep;
     lodash.propertyOf = propertyOf;
-    lodash.propertyDeepOf = propertyDeepOf;
     lodash.pull = pull;
     lodash.pullAt = pullAt;
     lodash.range = range;
@@ -11855,7 +11763,6 @@
     lodash.reduceRight = reduceRight;
     lodash.repeat = repeat;
     lodash.result = result;
-    lodash.resultDeep = resultDeep;
     lodash.runInContext = runInContext;
     lodash.size = size;
     lodash.snakeCase = snakeCase;
@@ -12001,7 +11908,7 @@
     // Add `LazyWrapper` methods for `_.pluck` and `_.where`.
     arrayEach(['pluck', 'where'], function(methodName, index) {
       var operationName = index ? 'filter' : 'map',
-          createCallback = index ? baseMatches : baseProperty;
+          createCallback = index ? baseMatches : property;
 
       LazyWrapper.prototype[methodName] = function(value) {
         return this[operationName](createCallback(value));

test/test.js

@@ -11588,58 +11588,6 @@
 
   /*--------------------------------------------------------------------------*/
 
-  QUnit.module('lodash.propertyDeep');
-
-  (function() {
-    test('should create a function that plucks a property value of a given object', 3, function() {
-      var object = { 'a': [1, 2], 'b': 3 },
-          prop = _.propertyDeep(['a', 1]);
-
-      strictEqual(prop.length, 1);
-      strictEqual(prop(object), 2);
-
-      prop = _.propertyDeep(['b']);
-      strictEqual(prop(object), 3);
-    });
-
-    test('should work with non-string `prop` arguments', 1, function() {
-      var prop = _.propertyDeep([1]);
-      strictEqual(prop([1, 2, 3]), 2);
-    });
-
-    test('should return a function even for falsey values', 1, function() {
-      var pass = true;
-
-      _.each(falsey, function(keys) {
-        pass = typeof _.propertyDeep(keys) == 'function'
-      });
-
-      ok(pass);
-    });
-
-    test('should pluck inherited property values', 1, function() {
-      function Foo() { this.a = 1; }
-      Foo.prototype.b = 2;
-
-      var prop = _.propertyDeep(['b']);
-      strictEqual(prop(new Foo), 2);
-    });
-
-    test('should work when `object` is nullish', 1, function() {
-      var values = [, null, undefined],
-          expected = _.map(values, _.constant(undefined));
-
-      var actual = _.map(values, function(value, index) {
-        var prop = _.propertyDeep(['a']);
-        return index ? prop(value) : prop();
-      });
-
-      deepEqual(actual, expected);
-    });
-  }());
-
-  /*--------------------------------------------------------------------------*/
-
   QUnit.module('lodash.propertyOf');
 
   (function() {
@@ -11675,41 +11623,6 @@
 
   /*--------------------------------------------------------------------------*/
 
-  QUnit.module('lodash.propertyDeepOf');
-
-  (function() {
-    test('should create a function that plucks a property value of a given key', 3, function() {
-      var object = { 'a': 1, 'b': 2 },
-          propOf = _.propertyDeepOf(object);
-
-      strictEqual(propOf.length, 1);
-      strictEqual(propOf(['a']), 1);
-      strictEqual(propOf(['b']), 2);
-    });
-
-    test('should pluck inherited property values', 1, function() {
-      function Foo() { this.a = 1; }
-      Foo.prototype.b = 2;
-
-      var propOf = _.propertyDeepOf(new Foo);
-      strictEqual(propOf(['b']), 2);
-    });
-
-    test('should work when `object` is nullish', 1, function() {
-      var values = [, null, undefined],
-          expected = _.map(values, _.constant(undefined));
-
-      var actual = _.map(values, function(value, index) {
-        var propOf = index ? _.propertyDeepOf(value) : _.propertyDeepOf();
-        return propOf(['a']);
-      });
-
-      deepEqual(actual, expected);
-    });
-  }());
-
-  /*--------------------------------------------------------------------------*/
-
   QUnit.module('lodash.pull');
 
   (function() {
@@ -12588,52 +12501,6 @@
 
   /*--------------------------------------------------------------------------*/
 
-  QUnit.module('lodash.resultDeep');
-
-  (function() {
-    var object = {
-      'a': { d: 1 },
-      'b': null,
-      'c': function() { return this.a; }
-    };
-
-    test('should resolve property values', 4, function() {
-      strictEqual(_.resultDeep(object, ['a', 'd']), 1);
-      strictEqual(_.resultDeep(object, ['b']), null);
-      strictEqual(_.resultDeep(object, ['c', 'd']), 1);
-      strictEqual(_.resultDeep(object, ['d']), undefined);
-    });
-
-    test('should return `undefined` when `object` is nullish', 2, function() {
-      strictEqual(_.resultDeep(null, ['a']), undefined);
-      strictEqual(_.resultDeep(undefined, ['a']), undefined);
-    });
-
-    test('should return the specified default value for undefined properties', 1, function() {
-      var values = empties.concat(true, new Date, 1, /x/, 'a');
-
-      var expected = _.transform(values, function(result, value) {
-        result.push(value, value);
-      });
-
-      var actual = _.transform(values, function(result, value) {
-        result.push(
-          _.resultDeep(object, ['d'], value),
-          _.resultDeep(null, ['d'], value)
-        );
-      });
-
-      deepEqual(actual, expected);
-    });
-
-    test('should execute default function values', 1, function() {
-      var actual = _.resultDeep(object, ['d'], object.c);
-      strictEqual(actual, object.a);
-    });
-  }());
-
-  /*--------------------------------------------------------------------------*/
-
   QUnit.module('lodash.rest');
 
   (function() {
@@ -16668,7 +16535,7 @@
 
     var acceptFalsey = _.difference(allMethods, rejectFalsey);
 
-    test('should accept falsey arguments', 216, function() {
+    test('should accept falsey arguments', 213, function() {
       var emptyArrays = _.map(falsey, _.constant([])),
           isExposed = '_' in root,
           oldDash = root._;