object-manage

object-manage 
=============

Kado

STOP AND READ THIS

A new package is available to handle all your JavaScript needs.
See kado.org for details.

Summary

A library for managing javascript objects and offering common getter, setter, merge support.

Works great for managing config objects and libraries that have options.

Installation

``
$ npm install object-manage
`

Usage

This helper is generally meant to be implemented into higher level API's. As such usage is
simple.

ObjectManage is also an event emitter that allows the internal data object to be watched
and augmented manually.

`js
var ObjectManage = require('object-manage')

//construct
var obj = new ObjectManage({box: 'square'})

//watch data
var mydata = {}
obj.$on('load',function(data){
mydata = data
})

//load in data
obj.$load({foo: 'bar'})

//set a path
obj.$set('bas.boo','foo1')

//get a path
obj.$get('bas') //{boo: 'foo1'}
obj.$get('bas.boo') //'foo1'

//access data directly
console.log(obj.bas.boo) //'foo1'

//check if a path exists
obj.$exists('bas') //true
obj.$exists('badkey') //false

//remove a path
obj.$remove('bas')
obj.$exists('bas') //false

//reset
obj.$reset()


//path as an array
obj.$set(['foo','test'],'yes')
obj.$get('foo.test') //yes

//see paths currently in object
obj.$getPaths() // ['foo','foo.test']

//clone the object
var clone = ObjectManage.$clone(obj)

//create a new object
var obj2 = {foo: 'test'}

//extend that object
obj2 = ObjectManage.$extend(obj2)

//remove extension
obj2 = obj2.$strip()

`

Inheritance

It is also useful to use ObjectManage as a super constructor for libraries with options.

Here is a quick example

`js
var ObjectManage = require('object-manage')
, util = require('util')

var myObj = function(data){
ObjectManage.call(this,data)
}
util.inherits(myObj,ObjectManage)

myObj.prototype.$foo = function(){
console.log(this.data) //this.data managed by ObjectManage
}
`

Path Normalization

Paths can be passed in many different formats to allow for more programatic usage
of object-manage.

$3

The most common path format is a dot separated set of paths separated by a period.
This is also the internal format that all others normalize to.

Example
`js
var path = 'level1.level2.level3'
obj.$get(path)
`

$3

An array of path parts can also be passed

Example
`js
var path = ['level1','level2','level3']
obj.$get(path)
`

$3

A function may be passed that returns a string

Example
`js
var path = function(){
return 'level1.level2.level3'
}
obj.$get(path)
`

The function can also return an array of parts

Example
`js
var path = function(){
return ['level1','level2','level3']
}
obj.$get(path)
`

$3

An object that has a toString method can also be used.

Example
`js
var path = {
toString: function(){
return 'level1.level2.level3'
}
}
obj.$get(path)
`

Storage

By default object-manage uses an internal memory storage. However this can
easily be changed to use a storage driver to persist the instance.

$3

* Memory
* Redis

$3

`js
var handle = 'uuid'
var obj = new ObjectManage()
obj.$storage({
driver: 'redis',
options: {
host: '127.0.0.1',
port: 6379,
secret: 'xyz'
}
})
obj.$restore(handle)
obj.$set('foo',1)
obj.$save(function(err,handle){
if(err) throw err
console.log(handle)
})
`

$3

#### Storage Setup

To set the storage driver and options use the setStorage method. This method will
automatically save the current object to the newly set options so data can still
be passed to the constructor. If a string is passed it will be treated as the driver
name and will not pass any options to the driver which assumes default.

`js
var obj = new ObjectManage()
obj.$storage('redis') // redis with default options
obj.$storage('memory') // revert back to the default
obj.$storage({
driver: 'redis',
options: {
host: '127.0.0.1',
port: 6379,
secret: 'xyz'
},
ready: function(err){
if(err) throw err
console.log('redis is ready')
}
})
`

Storage setup also returns the instance so it can be chained on to the constructor.

`js
var obj = new ObjectManage().storage('redis')
obj.$set('foo','yes')
obj.$save(function(err){
if(err) throw err
process.exit()
})
`

#### Save

Saves the state of the object into the storage driver.

If no handle is set using the setHandle() method then a handle
will be automatically generated as a UUID. This handle is made available
to the callback of the save function and will be available through the
getHandle() method once the save has been initiated.

`js
var obj = new ObjectManage()
obj.$storage('redis')
obj.foo = 1
obj.$save(function(err,handle,data){
if(err) throw err
console.log(handle) //prints the instance id
console.log(data.foo) //1
})
`

#### Instance Handle

To get the handle used to identify the instance use the getHandle method.
The handle is automatically generated when a new instance is saved and no handle
has been set.

`js
var obj = new ObjectManage()
console.log(obj.$getHandle()) //prints the instance handle
`

To set a custom handle used to identify the instance use the setHandle method.

`js
var obj = new ObjectManage()
obj.$storage('redis')
obj.$setHandle('foo')
obj.$set('bar','baz')
obj.$save(function(err,handle,data){
if(err) throw err
console.log(handle) //foo
console.log(data.bar) //baz
})
`

#### Restore

To retrieve a saved instance of an object use the restore method.

`js
var handle = 'uuid'
var obj = new ObjectManage().$storage('redis')
obj.$restore(handle,function(err,data){
if(err) throw err
console.log(data)
})
`

$3

Implementing user space drivers is simple as well.

Create a driver.

`js
var myStorageDriver = ObjectManage.StorageDriver.create('myStorageDriver')
var store = {}
myStorageDriver.prototype.setup = function(options){
//connect here
}
myStorageDriver.prototype.save = function(handle,data,next){
//save here
store[handle] = data
next()
}
myStorageDriver.prototype.restore = function(handle,next){
//restore here
next(null,store[handle])
}
myStorageDriver.prototype.flush = function(handle,next){
//flush here
delete store[handle]
next()
}
`

Using the driver

`js
var obj = new ObjectManage().$storage(new myStorageDriver())
`

Implement Custom Merge Package

It is also possible to implement one's own merging function.

`js
var ObjectManage = require('object-manage')
ObjectManage.prototype.$merge = function(obj1,obj2){
var mergedObject = obj2
return mergedObject
}
`

NOTICE Be careful when changing this as it can have unexpected results on other packages
that may depend on ObjectManage. It would be best to only override the merge value of the
specific instance rather than the prototype.

Validation

In order for object-manage to be useful in more hostile environments.
It allows for validation functions to be defined per instance.

Quick example of a validation function for setting values

`js
var obj = new ObjectManage()
obj.$validateSet = function(path,value){
//your validation code here that calls one of the below functions
//erroneous method that still processes the action
this.warn('should have passed a boolean',value)
//erroneous methods that will halt processing of the action
this.drop('value must be boolean')
this.reject('value must be boolean')
//will throw an exception that must be caught in user space
this.error('something bad happened')
//non erroneous return methods
this.ok(value)
//or
return value
}
`

$3

The following callbacks are available.

* $validateGet ObjectManage.$validateGet -- Validate get directives
* $validateSet ObjectManage.$validateSet -- Validate set directives
* $validateExists ObjectManage.$validateExists -- Validate exists directives
* $validateRemove ObjectManage.$validateRemove -- Validate remove directives
* $validateLoad ObjectManage.$validateLoad -- Validate load directives

$3

There are 5 verbs used to handle exceptions

* drop -- Silently drop the set/get operation (returns undefined for get, set returns true)
* reject -- Actively reject the set/get operation and issue an error back to the setter/getter
* warn -- Accept the get/set request but still issue an error to the user.
* error -- Treated like a regular exception and will be thrown upwards.
* ok -- Only accepts the value to returned for processing

API Reference

$3

The constructor sets up the object to be managed and accepts
the a arbitrary numbers of arguments that get passed to ObjectManage.load()

`js
var data = {foo: 'foo'}
var inst = new ObjectManage(data)
`

NOTE If watching data via the load event is desired data
should not be passed to the construct as it will be impossible to
listen for the load event.

$3

Load is used to merge an argument object into the main object.

`js
var inst = new ObjectManage()
inst.$load({mykey: 'mydata'})
inst.$load({mykey2: 'mydata2'})
`

Load will also accept an arbitrary numbers of objects that will
be merged on top of each other in order.

`js
var data1 = {test1: 'val1', test2: 'val2'}
, data2 = {test3: 'val3', test4: 'val4'}
, data3 = {test5: {test6: 'val6'}}
var inst = new ObjectManage()
inst.$load(data1,data2,data3)
`

$3

Set will recursively set a path given by a string using dot notation.

`js
var isnt = new ObjectManage()
inst.$set('mykey','mydata') //{mykey: 'mydata'}
inst.$set('mykey2.data','mydata') //{mykey: 'mydata', mykey2: {data: 'mydata'}}
`

$3

Get will recursively set a path given by a string using dot notation.

`js
var isnt = new ObjectManage({mykey: 'mydata', mykey2: {data: 'mydata'}})
inst.$get('mykey') //'mydata'
inst.$get('mykey2.data') //'mydata
`

$3

Check if a path exists

NOTE This uses hasOwnProperty() method of the object so is safe
to return an accurate value even when a path is set to undefined

`js
var inst = new ObjectManage({mykey: 'myvalue'})
inst.$exists('mykey') //true
inst.$exists('mykey2') //false
`

$3

Remove a path and all its children

This uses delete object[property] and does not just set the property
to undefined

`js
var inst = new ObjectManage({mykey: {mykey2: 'myvalue'}})
inst.$exists('mykey.mykey2') //true
inst.$remove('mykey') //true
inst.$exists('mykey.mykey') //false
`

$3

This will take a userspace object and count the depth of the object.

`js
var inst = new ObjectManage()
var obj = {foo: {foo: {foo: 'baz'}}}
inst.$countDepth(obj) //3
`

$3

It may be useful to be able to iterate the paths that are contained within the managed
object.

In order to do this use the ObjectManage.getPaths() method.

Example
`js
var obj = new ObjectManage()
obj.$load({foo: {bar: 'baz'}})
obj.$getPaths() // ['foo','foo.bar']
``

Static Methods

$3

Strip returns only the data from an instance of ObjectManage

$3

Extract returns only the internals from an instance of ObjectManage

$3

Extend returns a new instance of ObjectManage populated with obj

$3

* When passed a scalar object returns a reference broken clone of it
* When passed an instance of ObjectManage returns a new reference broken ObjectManage

$3

Counts the depth of the object up to maxDepth and returns that number.
If maxDepth is omitted it will be set to 50

Events

$3

Fired when a set is processed on the managed object

* path -- Path to be set
* value -- Value to be set to the path
* valid -- If a validation function was used this is the validity of that result (boolean)

`js
var obj = new require('object-manage')()
obj.$on('set',function(path,value,valid){
valid = valid ? 'valid' : 'invalid'
console.log('a ' + valid + ' value of (' + value + ') set to (' + path + ')')
})
obj.$set('foo','bar')
`

$3

Fired when a get is processed on the managed object

* path -- Path to be retrieved
* value -- Value of the path retrieved
** valid -- If a validation function was used this is the validity of that result (boolean)

`js
var obj = new require('object-manage')()
obj.$on('get',function(path,value){
console.log(value + ' was retrieved from ' + path)
})
obj.$get('foo')
`

$3

Fired when an exists operation is performed

* path -- Path that is being checked for existance
* exists -- Result of exists check (boolean)

`js
var obj = new require('object-manage')()
obj.$on('exists',function(path,exists){
var does = exists ? 'does' : 'does not'
console.log('checked if ' + path + ' exists and it ' + does)
})
obj.$exists('foo')
`

$3

Fired when an remove operation is performed

* path -- Path that is being checked for existance
* removed -- Result of removal operation (boolean)

`js
var obj = new require('object-manage')()
obj.$on('exists',function(path,removed){
var successfully = removed ? 'successfully' : 'unsuccessfully'
console.log(successfully + ' removed path (' + path + ')')
})
obj.$remove('foo')
`

$3

Fired when a load and merge is performed on the managed object

* data -- Result of the load and merge

`js
var obj = new require('object-manage')()
obj.$on('load',function(data){
console.log('a merge was performed and the resulting data: ' + data)
})
obj.$load({foo: 'bar'})
`

$3

Fired when a handle is generated for the instance

`js
var obj = new require('object-manage')()
obj.$on('generateHandle',function(handle){
console.log('a handle was generated: ' + handle)
})
obj.$generateHandle()
`

$3

Fired when a save to the storage driver is called

`js
var obj = new require('object-manage')()
obj.$on('save',function(err,handle,data){
if(err) throw err
console.log(handle) //foo
console.log(data.foo) //yes
})
obj.$set('foo','yes')
obj.$setHandle('foo')
obj.$save()
`

$3

Fired when a restore to the storage driver is called

`js
var obj = new require('object-manage')()
obj.$on('restore',function(err,data){
if(err) throw err
console.log(data.foo) //yes
})
obj.$restore('foo')
`

$3

Fired when a flush to the storage driver is called

`js
var obj = new require('object-manage')()
obj.$on('flush',function(err){
if(err) throw err
console.log('flushed instance')
})
obj.$restore('foo')
obj.$flush()
`

$3

Fired when there is a validation drop

* verb -- The current action type (get,set)
* message -- The warning message
* path -- Path of the property being operated on
* value -- The value being operated on

`js
var obj = new require('object-manage')()
obj.$on('drop',function(verb,message,path,value){
console.log('object-manage drop [' + verb + ':' + path + ']: ' + message)
})
obj.$validateSet = function(path,value){
this.drop('not accepting anything')
}
obj.$set('foo','will drop') //returns true
`

$3

Fired when there is a validation reject

* verb -- The current action type (get,set)
* message -- The warning message
* path -- Path of the property being operated on
* value -- The value being operated on

`js
var obj = new require('object-manage')()
obj.$on('reject',function(verb,message,path,value){
console.log('object-manage reject [' + verb + ':' + path + ']: ' + message)
})
obj.$validateSet = function(path,value){
this.reject('not accepting anything')
}
obj.$set('foo','will drop') //returns false
`

$3

Fired when there is a set/get/merge warning.

* verb -- The current action type (get,set,merge)
* message -- The warning message
* path -- Path of the property being operated on (blank during merge warnings)
* value -- The value being operated on (the value being merged in during a merge warning)

`js
var obj = new require('object-manage')()
obj.$on('warn',function(verb,message,path,value){
console.log('object-manage warning [' + verb + ']: ' + message)
})
obj.$load(overlyDeepObject)
`

$3

Fired when there is a set/get/merge error.

* verb -- The current action type (get,set,merge)
* message -- The warning message
* path -- Path of the property being operated on (blank during merge warnings)
* value -- The value being operated on (the value being merged in during a merge warning)

`js
var obj = new require('object-manage')()
obj.$on('error',function(verb,message,path,value){
console.log('object-manage error [' + verb + ']: ' + message)
})
obj.$load(overlyDeepObject)
`

Changelog

$3

* Update the following dependencies
* redis 2.8.x → 3.0.x
* uuid 3.3.x → 7.0.x
* chai 4.1.x → 4.2.x
* mocha 5.2.x → 7.1.x
* Add notice about Kado for future use.

$3

* Update dependencies
* Fix security vulnerabilities in dependencies
* Node requirement changes to 4.x or greater
* Remove the ability to use merge-recursive from the core package as it
contains a security vulnerability and the author has not published a fix.

$3

* Update dependencies
* Updated support for latest Node.js versions
* Dropped support for Node.js < 4.x (however older versions should still work!)
* Releasing 1.0.0 to prove the long term stability of this package.

$3

* Update dependencies
* Test against all major node versions
* Enable support for 0.8.x

$3

* Completely rewritten API
* Data no stored directly in the main object
* Methods all renamed and prefixed with $ eg obj.get -> obj.$get
* Dropped support for Node 0.8.x
* Overall code cleanup with gjslint standards
* Addition of several static helpers such as: $strip, $extract, $clone, $extend, $countDepth

#### Upgrade Notes

##### > 0.8.x

As of 0.8.x the API was completely reimagined so that ObjectManage would only extend the object.
Allowing it to be passed and used like any other object but with extended functionality.

This breaks all implementations of the 0.7.x branch which has been split to be maintained separately.

The main change is that the ObjectManage.data storage object has been moved to the root and all the
extension methods are now prefixed with $ eg: var obj = new ObjectManage(); obj.$get('foo');

$3

* Fixes #3 where object length would be mistaken for object depth. Also uses a quicker depth counting function.

$3

* Fixes #2 load and the constructor now accept multiple arguments rather than an array of objects.
The previous would cause problems when passing an actual array to the object manager. This change breaks
backwards compatibility and will require upgraded code that passes arrays of objects.
* Added feature to print the topology of a managed object in an array of dot separated paths.
Use ObjectManage.getPaths()

$3

* Added support for storage drivers
* Added reset method
* Added path normalization

$3

* Fixed small prototype issue with .merge being set to Object instead of ObjectManage

$3

* ObjectManage is now an event emitter that fires events for watching data see README for event types
* object-merge selected as the default merge package.
* Added switchable merger type based on desired environment.
* Added testing against circular referenced objects
* ObjectManage will not modify objects passed into and are decoupled when using object-merge
* ObjectManage.merge prototype function added so the merger can be overridden to allow customised usage.
* Validation now supported on get, set, exists, load, and remove.
* Organized tests into groups for easier future additions.

$3

* Added max depth warning for recursive objects that would normally throw Maximum call stack exceeded
* Added extensive testing against object size testing and warnings
* Even if maxDepth is exceeded the merge will still be attempted but is likely to fail with a
Maximum call stack exceeded error
* Max depth is adjustable using the ObjectManage.maxDepth property
* Added ObjectManage.countDepth(object) to check object depth
* Changed merging package to merge-recursive this
will now maintain associations to parent objects so that libraries can establish a pointer to the managed object
eg: var obj = new ObjectManage(); var watched = obj.data

$3

* No argument to get() now returns the entire object
* Testing added against recursive merging

$3

* Small fix to make sure ObjectManage.data is always an object

$3

* Changed from merge to object-merge to allow for recursive merging
* Made private functions more robust to non-sane input

$3

* Updated package.json

$3

* Added ObjectManage.exists()
* Added ObjectManage.remove()

$3

* Initial Release

License

MIT licensed see LICENSE.md`