dotty - npm Package Compare versions

Comparing version 0.0.2 to 0.1.0

example.js

@@ -37,4 +37,5 @@ var dotty = require("./lib/index");
 console.log(dotty.deepKeys(object));
-console.log(dotty.deepKeys(object).map(function(e) { return e.join("."); }));
+console.log(dotty.deepKeys(object, {leavesOnly: true}));
+console.log(dotty.deepKeys(object, {leavesOnly: true, asStrings: true}));
 
 console.log(object);

lib/index.js

@@ -84,4 +84,7 @@ //
 //
+// If an action function is specified, that action will be applied to each
+// match. Action params are value, parent and key.
+//
 
-var search = module.exports.search = function search(object, path) {
+var search = module.exports.search = function search(object, path, action) {
   if (typeof path === "string") {
@@ -112,5 +115,11 @@ path = path.split(".");
   if (path.length === 0) {
-    return Object.keys(object).filter(key.test.bind(key)).map(function(k) { return object[k]; });
+    return Object.keys(object).filter(key.test.bind(key)).map(function(k) {
+      var value = object[k];
+      if(action){
+        action(value, object, k);
+      }
+      return value;
+    });
   } else {
-    return Array.prototype.concat.apply([], Object.keys(object).filter(key.test.bind(key)).map(function(k) { return search(object[k], path); }));
+    return Array.prototype.concat.apply([], Object.keys(object).filter(key.test.bind(key)).map(function(k) { return search(object[k], path, action); }));
   }
@@ -120,2 +129,14 @@ };
 //
+// Perform a search and remove the matched keys.
+// The return value is the same object argument with modifications.
+//
+
+var removeSearch = module.exports.removeSearch = function removeSearch(object, path){
+  search(object, path, function(value, object, key){
+    delete object[key];
+  });
+  return object;
+};
+
+//
 // The first two arguments for `put` are the same as `exists` and `get`.
@@ -216,3 +237,5 @@ //
 
-var deepKeys = module.exports.deepKeys = function deepKeys(object, prefix) {
+var deepKeys = module.exports.deepKeys = function deepKeys(object, options, prefix) {
+  options = options || {};
+
   if (typeof prefix === "undefined") {
@@ -229,10 +252,16 @@ prefix = [];
 
-    keys.push(prefix.concat([k]));
+    if (!options.leavesOnly || typeof object[k] !== "object") {
+      keys.push(prefix.concat([k]));
+    }
 
     if (typeof object[k] === "object" && object[k] !== null) {
-      keys = keys.concat(deepKeys(object[k], prefix.concat([k])));
+      keys = keys.concat(deepKeys(object[k], {leavesOnly: options.leavesOnly}, prefix.concat([k])));
     }
   }
 
+  if (options.asStrings) {
+    keys = keys.map(function(e) { return e.join("."); });
+  }
+
   return keys;
 };

LICENSE.md

@@ -0,0 +0,0 @@ Copyright (c) 2012, Deoxxa Development

package.json

 {
   "name": "dotty",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Access properties of nested objects using dot-path notation",
@@ -8,3 +8,3 @@ "main": "lib/index.js",
     "test": "vows",
-    "prepublish": "docco lib/*"
+    "prepare": "docco \"./lib/index.js\""
   },
@@ -23,7 +23,7 @@ "repository": {
   "author": "Conrad Pankoff <[e-mail]> (http://www.fknsrs.biz/)",
-  "license": "BSD",
+  "license": "BSD-3-Clause",
   "devDependencies": {
-    "vows": "~0.7.0",
-    "docco": "~0.6.2"
+    "vows": "^0.8.0",
+    "docco": "^0.8.0"
   }
 }

README.md

@@ -1,2 +0,2 @@
-Dotty [![build status](https://secure.travis-ci.org/deoxxa/dotty.png)](http://travis-ci.org/deoxxa/dotty)
+Dotty [![build status](https://secure.travis-ci.org/deoxxa/dotty.png)](http://travis-ci.org/deoxxa/dotty) [![npm](https://img.shields.io/npm/v/dotty.svg)](https://www.npmjs.com/package/dotty)
 =====
@@ -16,3 +16,3 @@
 
-Here's a link to the [npm](https://npmjs.org/package/dotty) page. 
+Here's a link to the [npm](https://npmjs.org/package/dotty) page.
 
@@ -50,3 +50,3 @@ npm install dotty
 console.log(dotty.get(object, "a.b.z")); // undefined
-console.log(dotty.get(object, ["a", "b", "z"])); // undefine
+console.log(dotty.get(object, ["a", "b", "z"])); // undefined
 
@@ -61,2 +61,5 @@ dotty.put(object, "a.b.hello", "hi");
 console.log(dotty.search(object, ["a", "*", /..+/]));
+console.log(dotty.search(object, 'a.b.*', function(value, parent, key){
+	parent[key] = value + '!';
+}));
 
@@ -66,4 +69,7 @@ console.log(dotty.remove(object, "a.b.x"));
 
+console.log(dotty.removeSearch(object, 'a.*.x'));
+
 console.log(dotty.deepKeys(object));
-console.log(dotty.deepKeys(object).map(function(e) { return e.join("."); }));
+console.log(dotty.deepKeys(object, {leavesOnly: true}));
+console.log(dotty.deepKeys(object, {leavesOnly: true, asStrings: true}));
 
@@ -70,0 +76,0 @@ console.log(object);

test/exists-test.js

@@ -0,0 +0,0 @@ var dotty = require("../lib/index"),

test/get-test.js

@@ -0,0 +0,0 @@ var dotty = require("../lib/index"),

test/put-test.js

@@ -0,0 +0,0 @@ var dotty = require("../lib/index"),

test/remove-test.js

@@ -0,0 +0,0 @@ var dotty = require("../lib/index"),

test/search-test.js

@@ -0,0 +0,0 @@ var dotty = require("../lib/index"),

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

502840

increased by25.55%

Number of package files

28

increased by16.67%

Number of medium license alerts

0

decreased by-100%

Lines of code

1533

increased by13.89%

Number of lines in readme file

86

increased by7.5%

No dependency changes