Change pluck to be more prop-like #293
Conversation
| eq(S.pluck(Array, 'x', [{x: vm.runInNewContext('[0]')}]), [S.Just([0])]); | ||
| eq(S.pluck(vm.runInNewContext('Array'), 'x', [{x: [0]}]), [S.Just([0])]); | ||
| eq(S.pluck('x', [{x: vm.runInNewContext('[0]')}]), [[0]]); | ||
| eq(S.pluck(vm.runInNewContext("'x'"), [{x: [0]}]), [[0]]); |
There was a problem hiding this comment.
These vm test are no longer relevant. Let's remove them.
| //. Takes a property name and an array of objects and returns an array in | ||
| //. which each element is the value of the specified property of the | ||
| //. corresponding object. If for some reason the object lacks the specified | ||
| //. property, a type error is thrown. |
There was a problem hiding this comment.
I'd like to leverage the documentation for existing functions:
Combines [`map`][R.map] and [`prop`](#prop). `pluck(k, xs)` is equivalent
to `map(prop(k), xs)`.
[R.map]: http://ramdajs.com/docs/#map
There was a problem hiding this comment.
Yes, and let's remember to change R.map to S.map when we release 0.12.
| return xs.map(function(obj, idx) { | ||
| if (key in Object(obj)) return obj[key]; | ||
| throw new TypeError('‘pluck’ expected object at index ' + idx + ' to ' + | ||
| 'have a property named ‘' + key + '’; ' + |
There was a problem hiding this comment.
Let's move ' to ' down one line for more pleasing line wrapping (saving one concatenation operation in the process).
| function pluck(typeRep, key, xs) { | ||
| return xs.map(function(x) { return get(typeRep, key, x); }); | ||
| function pluck(key, xs) { | ||
| return xs.map(function(obj, idx) { |
There was a problem hiding this comment.
I like to see an element of xs referred to as x.
Strictly speaking this is not refactoring since we're changing the function's behaviour. Would you mind updating the commit message and pull request title? |
svozza
changed the title
| @@ -3500,6 +3500,7 @@ | |||
| //. [R.equals]: http://ramdajs.com/docs/#equals | |||
| //. [Ramda]: http://ramdajs.com/ | |||
| //. [RegexFlags]: https://github.com/sanctuary-js/sanctuary-def#regexflags | |||
| //. [R.map]: http://ramdajs.com/docs/#map | |||
There was a problem hiding this comment.
Could you insert this line after [R.equals] instead? I like to type vip:sort u in Vim to sort this "paragraph", so keeping this list sorted will avoid noise in future diffs.
| //. | ||
| //. See also [`get`](#get). | ||
| //. Combines [`map`][R.map] and [`prop`](#prop). `pluck(k, xs)` is equivalent | ||
| //. to `map(prop(k), xs)`. |
There was a problem hiding this comment.
Shall we add See also [`pluck`](#pluck). to the prop docstring?
|
🌳 |
|
It's good to be back. ;) |
Closes #291