diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..ef5ea46 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,22 @@ +# .editorconfig +# +# Copyright (c) 2015 Charlike Mike Reagent, contributors. +# Released under the MIT license. +# + +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[*.php] +indent_size = 4 + +[*.md] +insert_final_newline = false +trim_trailing_whitespace = false diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b243f55 --- /dev/null +++ b/.gitignore @@ -0,0 +1,56 @@ +# .gitignore +# +# Copyright (c) 2015 Charlike Mike Reagent, contributors. +# Released under the MIT license. +# + +# Always-ignore dirs # +# #################### +_gh_pages +node_modules +bower_components +components +vendor +build +dest +dist +src +lib-cov +coverage +nbproject +cache +temp +tmp +put-value + +# Packages # +# ########## +*.7z +*.dmg +*.gz +*.iso +*.jar +*.rar +*.tar +*.zip + +# OS, Logs and databases # +# ######################### +*.pid +*.dat +*.log +*.sql +*.sqlite +*~ +~* + +# Another files # +# ############### +Icon? +.DS_Store* +Thumbs.db +ehthumbs.db +Desktop.ini +npm-debug.log +.directory +._* diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..1ec1310 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,25 @@ +language: "node_js" +sudo: false + +node_js: + - "0.10" + - "0.12" + - "1" + - "2" + +notifications: + email: + on_success: never + on_failure: never + +before_script: + - npm install standard + - standard + +script: + - npm install istanbul + - istanbul cover test.js + +after_success: + - npm install coveralls + - cat ./coverage/lcov.info | coveralls diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..e784c18 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,4 @@ + + +## 0.0.0 - 2015-06-25 +- first commits \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5312165 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing Guidelines + +Contributions are always welcome! + +**Before spending lots of time on something, ask for feedback on your idea first!** + +Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations. + + +## Installing + +Fork and clone the repo, then `npm install` to install all dependencies and `npm test` to ensure all is okey before you start anything. + + +## Testing + +Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem). + +## Code Style + +[![standard][standard-image]][standard-url] + +This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. You are encouraged to install it globally. `npm test` runs `standard` so you don't have to! + +``` +npm i standard -g +``` + +It is intentional to don't have `standard`, `istanbul` and `coveralls` in the devDependencies. Travis will handle all that stuffs. That approach will save bandwidth also installing and development time. + +[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg +[standard-url]: https://github.com/feross/standard \ No newline at end of file diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..2856afd --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# The MIT License + +Copyright (c) 2015 [Charlike Make Reagent](http://j.mp/1stW47C) + +> Permission is hereby granted, free of charge, to any person obtaining a copy +> of this software and associated documentation files (the "Software"), to deal +> in the Software without restriction, including without limitation the rights +> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +> copies of the Software, and to permit persons to whom the Software is +> furnished to do so, subject to the following conditions: +> +> The above copyright notice and this permission notice shall be included in +> all copies or substantial portions of the Software. +> +> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +> SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 3f88e3e..bd0f715 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,85 @@ -# put-value -Update only existing values from an object, works with dot notation paths like `a.b.c` and support deep nesting. +# put-value [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url] + +> Update only existing values from an object, works with dot notation paths like `a.b.c` and support deep nesting. + +[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url] + + +## Features +- updates value of `key` only if `key` exists +- updates only existing values of `obj` when object is given to `key` +- because `set-value` **update** values if exist and **add** if not exist +- returns empty object if `obj` is not an object +- returns modified object otherwise +- returns original object if `key` is not an object or string + + +## Install +``` +npm i put-value --save +npm test +``` + + +## Usage +> For more use-cases see the [tests](./test.js) + +```js +var put = require('put-value') +``` + + +## Contributing + +Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/put-value/issues/new). +But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines. + + +## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url] + +[![tunnckocore.tk][author-www-img]][author-www-url] [![keybase tunnckocore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url] + + +[npmjs-url]: https://www.npmjs.com/package/put-value +[npmjs-img]: https://img.shields.io/npm/v/put-value.svg?label=put-value + +[license-url]: https://github.com/tunnckoCore/put-value/blob/master/LICENSE.md +[license-img]: https://img.shields.io/badge/license-MIT-blue.svg + + +[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/put-value +[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/put-value.svg + +[travis-url]: https://travis-ci.org/tunnckoCore/put-value +[travis-img]: https://img.shields.io/travis/tunnckoCore/put-value.svg + +[coveralls-url]: https://coveralls.io/r/tunnckoCore/put-value +[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/put-value.svg + +[david-url]: https://david-dm.org/tunnckoCore/put-value +[david-img]: https://img.shields.io/david/tunnckoCore/put-value.svg + +[standard-url]: https://github.com/feross/standard +[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg + + +[author-www-url]: http://www.tunnckocore.tk +[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg + +[keybase-url]: https://keybase.io/tunnckocore +[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg + +[author-npm-url]: https://www.npmjs.com/~tunnckocore +[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg + +[author-twitter-url]: https://twitter.com/tunnckoCore +[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg + +[author-github-url]: https://github.com/tunnckoCore +[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg + +[freenode-url]: http://webchat.freenode.net/?channels=charlike +[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg + +[new-message-url]: https://github.com/tunnckoCore/messages +[new-message-img]: https://img.shields.io/badge/send%20me-message-green.svg diff --git a/index.js b/index.js new file mode 100644 index 0000000..7eb2e74 --- /dev/null +++ b/index.js @@ -0,0 +1,39 @@ +/*! + * put-value + * + * Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk) + * Released under the MIT license. + */ + +'use strict' + +var lazy = require('lazy-cache')(require) +var isObject = lazy('isobject') +var hasOwn = lazy('has-own-deep') +var assign = lazy('assign-deep') +var kindOf = lazy('kind-of') +var set = lazy('set-value') + +module.exports = function putValue (obj, key, value) { + if (!isObject()(obj)) { + return {} + } + var type = kindOf()(key) + if (type !== 'string' && type !== 'object') { + return obj + } + if (type === 'object') { + obj = assign()(obj, key) + return obj + } + if (key.indexOf('.') === -1) { + if (obj.hasOwnProperty(key)) { + obj[key] = value + } + return obj + } + if (hasOwn()(obj, key)) { + set()(obj, key) + } + return obj +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..e9293ad --- /dev/null +++ b/package.json @@ -0,0 +1,24 @@ +{ + "name": "put-value", + "version": "0.0.0", + "description": "Update only existing values from an object, works with dot notation paths like `a.b.c` and support deep nesting.", + "repository": "tunnckoCore/put-value", + "author": "Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)", + "main": "index.js", + "license": "MIT", + "scripts": { + "test": "standard && node test.js" + }, + "dependencies": { + "assign-deep": "~0.1.2", + "has-own-deep": "~0.1.4", + "isobject": "~1.0.0", + "kind-of": "~2.0.0", + "lazy-cache": "~0.1.0", + "set-value": "~0.2.0" + }, + "devDependencies": { + "assertit": "^0.1.0" + }, + "keywords": [] +} diff --git a/test.js b/test.js new file mode 100644 index 0000000..f5b74e5 --- /dev/null +++ b/test.js @@ -0,0 +1,17 @@ +/*! + * put-value + * + * Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk) + * Released under the MIT license. + */ + +/* jshint asi:true */ + +'use strict' + +// var test = require('assertit') +// var put = require('./index') + +// test('put-value:', function () { +// // body +// })