Projecturo_2

Goal

A lightweight implimentation of dot syntax string searching as an NPM installable module.

Project History

This project was originally at https://gist.github.com/vance/706b58081f55eeacd1b4 this was not pulled directly to avoid future naming convensions with NPM (as this was unkown at the time for the author).

Installing with NPM

Get the lastest version via NPM and install it globally

npm install -g vance-dot-path-search

Running with browserify

An alternate to running in REPL might be to install browserfy and loading test.html in the browser. You can test quickly with test.html.

browserify dotPathTests.js -o bundleDotPath.js

Initializing a Search String

Invoke the module constuctor with dotPathModule('trunk.branch.attribute'). This will return an object that you can supply a search term to.

Searching on object

Once you've initialized your object, you can search for an object match as defined in the string.

You can obtain the value of the search with dotPathModule({trunk : { branch : { attribute: 'hooray!' }}})

Putting it all together

var dotpath = require('dotPathModule')

var find = dotpath('trunk.branch.atribute')

var found = find({trunk: {branch: {attribute: "hooray!"} }})

console.log(found) // outputs "hooray!"

var not_found = find({}) || find() || find(null)

console.log(not_found) // outputs undefined because there's no match

Testing the dotPathModule

Included with the module download/install is a test.js file. Running from the project directory you can perform a number of tests. It is on the roadmap to include these test executions in the package.json to make our lives easier. Exceptions will be thrown if the tests do not pass.

Included tests are testProjectRequirements() and testEqualityWithValue(value) where the supplied object will be tested with strict equivalence.

shouldFail("nope") will make sure the try/catch block does not break the abstraction. As long as you don't supply yep as the parameter, it will throw an exception when executed.