ClassJS
-----


Business and Data Access layers for browsers or nodejs

Documentation

##### Install

- NodeJS
- Standalone: `` $ npm install atma-class ` ` var Class = require('atma-class') `
- AtmaPackage
- Browser
- ` `

-----
- Attributes Overview
- Serialization
- Collections
- Persistence
- RESTful
- Local Storage
- MongoDB
- MySQL _in progress_
- Repository
- Static Functions
- Validation
- Classes
- Deferred
- EventEmitter





$3



Class definition object is a simple prototype object, but with Attributes it is possible to add or change some functionality of the resulted class, like inheritance, overrides, persistance, validation and some more.

`javascript
Class({
/*
* instanceof also works on deep inheritances
\*/
Base: < Function > BaseConstructor,
/*
* Same as base, but instanceof wont work,
* as instanceof allows linear inheritance only
\*/
Extends: < Function | Object | Array > Mixins
/*
* constructor of a class - if has inheritance,
* also all constructors will be called
\*/
Construct: < Function > function(){}
/*
* Static functions of a created Class
* User.key()
\*/
Static: < Object > { key: function(){} }
/*
* RESTfull/LocalStorage/MongoDB serialization/deserialization
\*/
Store: <| Class.Remote('/user/:id')
| Class.LocalStore('user')
| Class.MongoStore.Single('users')
| Class.MongoStore.Collection('users') / use in Class.Collection / |>
/*
* Override any Base or Extended Function
* Using this object, there will be access to overriden function
* via this.super();
\*/
Override: < Object > {
some: function(){

// default arguments
this.super(arguments);

// overriden arguments
this.super(arg1, arg2);
}
},
Self: {
/*
* Functions, that are always bound to the instance of the class
* e.g. setTimeout(this.foo, 1000);
\*/
foo: function(){}
},
Validate: {
/*
* @see validation section
* e.g.
* var foo = new Foo();
* foo.user = null;
* var error = Class.validate(foo);
\*/
user: function(val){
if (val == null)
return 'Username is not defined';
}
},
/*
* Private properties with the underscore contract.
* Such properties wont be serialized
\*/
'_property': null,

/*
* Other class functions/properties
* This Object is then transformed into prototype object of
* a class.
\*/
...
});
`

$3

A Class instance can be serialized to or deserialiazed from a string or simple JSON object. For this to happen, the instance schould be inherited from a Serialization class.
`javascript
var Foo = Class({
Base: Class.Serializable,
...
});
var foo = new Foo({baz: 'Baz'});
foo.baz === 'Baz';
`
There could be also some meta specified
`javascript
var Foo = Class({
Base: Class.Serializable({
// constructor deserialization, e.g.:
'date': Date,

// use entity from ClassJS IoC Repository
'article': 'Article',

// same
'user': {
deserialize: User
},

// skip property
'none': {
serialize: null
},

// rename property when de-/serializing
'myKey': {
key: 'yourKey'
}
})
});

var jsonStr = '{"date":"2014-03-27T23:33:45.594Z","user":{"name":"baz"},"yourKey":5}';
var foo = new Foo(jsonStr);

foo.date instanceof Date //> true
foo.user instanceof User //> true
foo.myKey === 5 //> true
`

$3

Creates Array-like Object with all class features

`javascript
var Users = Class.Collection(User, {
// ... Class Definition Object, e.g. Remote
Store: Class.Remote('/api/users?location={?country}')
});

var list = Users
.fetch({country: 'DE'});
.done(function(obj){

list === obj
list.length
list[0]
// user instance
list.first({age: '>20', genre: 'm'});
// collection instance
list.where({age: '>20'});
list.where(function(x){ return x.age > 20 });
// mutator
list.remove({age: '<5'});
// storage
list.save();
// mutator + storage
list.del({age: '<5'});
});
`

$3

Storage Interface is same for all types, so you can easily switch between local storage, Ajax or MongoDB.

#### Remote

_async - extends Class.Deferred_

`javascript
var User = Class({
Base: Class.Serializable,
Store: Class.Remote('/user/:id')
});

// resolve user (GET)
var user = User
.fetch({id: 5})
.done(onSuccess)
.fail(onFail)
.always(onComplete)
.then(onSuccess, onFail);

// update (PUT) or Save (POST) - (look for existance of id/_id properties);
user.name = 'X';
user
.save()
.done(onSuccess)
.fail(onFail)
.always(onComplete);

// Remove (DELETE)
user
.del()
.done(onSuccess)
.fail(onFail)
.always(onComplete)

// patch object (PATCH) - MongoDB update query syntax is used
user
.patch({
$inc: { 'visits': 1 },
$set: { 'current.date' : new Date }
});

// Static service comunication
var user = new User({
username: 'baz'
age: 40
});
Class
.Remote
.send('/user/publish', 'put', user)
.done(function(responseJSON){

});
`

More route samples can be found from tests Route Tests

#### LocalStore
_sync, as localStorage is synchronous - but also inherits from Class.Deferred_
`javascript
var Settings = Class({
Base: Class.Serializable,
Store: Class.LocalStore('app/settings'),
points: 5
});
var setts = new Settings;
// get
setts.fetch();
// save or update
setts.points = 10;
setts.save();
// remove
setts.del();
// patch
setts.patch({
$inc: { points: 1 }
});
`

#### MongoDB

`javascript
// settings:
Class.MongoStore.settings({
db: 'myDBName',
ip: '127.0.0.1' // <- default
port: 27017 // <- default
});
//

var User = Class({
Base: Class.Serializable,
Store: Class.MongoStore.Single('users'),
username: ''
});
var Users = Class.Collection(User, {
Store: Class.MongoStore.Collection('users')
});

var user = User
.fetch({ username: 'bar' })
// .fetch({ age: '>10' })
// .fetch({ age: { $gt: 10 }})
.done(function(user_){
user === user_
})
.fail(function(error){})

// Complex queries with options. (Use $query from MongoDB API)
Users
.fetch({
$query:{
name: 'Smith'
age: {
$gte: 40
}
},
$orderby:{
surname: -1
}
}, {
fields: { name: 1 },
skip: 0,
limit: 10
})
.done(function(users){});

user.username = 'foo'
// save or update if _id is present.
user
.save()
.done(callback)
.fail(callback)
.always(callback)
;
// delete
user
.del()
.done(callback)
.fail(callback)
.always(callback);
// patch
user
.patch({
$inc: { age: 1 }
});

// Any MongoDB queries:

// 1) Get MongoDB db object
Class
.MongoStore
.resolveDb()
.done(function(db){
// do smth with the database
})
.fail(onError);

// 2) Get MongoDB collection object
User
.resolveCollection()
.done(function(collection){
// do smth with the collection object
})
.fail(onError)
;
`

All work with the database is encapsulated, so you do not need even to connect to the database,
just apply settings and with the first query the connection will be established.

##### Indexes
`javascript
var User = Class({
Base: Class.Serializable,
Store: Class.MongoStore.Single({
collection: 'users',
indexes: [
// simple index
{ qux: 1}
// compound index
{
bar: 1,
baz: 1
},
// with options
[{ username: 1 }, { unique: true }]
]
})
});
// ensure indexes
Class
.MongoStore
.ensureIndexes(User) //=> Deferred

// as all indexes being tracked, you can apply all indexes at once
Class
.MongoStore
.ensureIndexesAll() //=> Deferred

`

##### Advanced connections and settings:
`javascript
Class
.MongoStore
.settings({
connection: 'mongodb://localhost:30000,localhost:30001,localhost:30002/myDatabase',

// redefine options, defaults are:
params: {
auto_reconnect: true,
native_parser: true,
w: 1
}
})
`

##### Profiler
Enable profiler to catch all slow, unindexed queries and updates.
`javascript
Class
.MongoStore
.profiler
.toggle(true, {
slowLimit: 200,
onDetect: function(QueryInfo),

// add additional slow query detector,
// return true if this should be added to collection
detector: function(MongoDB_Plan):Boolean
});

QueryInfo = {
coll: 'String current name',
query: 'Object query wich was performed',
params: {
reason: 'slow|unindexed'
},
plan: MongoDB_Plan
};

// get all slow queries
Class
.MongoStore
.profiler
.getData(): Array
`

$3

_Namespaces_ When declaring a Class, it can be stored in the repository object for simpler access.

MaskJS.Node profits of this feature to automatically serialize _(server-side)_ and deserialize _(browser)_ class instances.
`javascript

var User = Class('User', ClassDefinition);

User === Class('User') === Class.Model.User;

// redefine the repository object
Class.cfg('ModelHost', window.Model = {});

User === Class('User') === Model.User;
`

$3

- Class.validate(object [, ?validationModel, ?isStrict]) #

- validationModel - _(@see Validation)_ - is not required, if instance/object has Validate attribute.
- isStrict - Boolean - return error if object contains property, which is not defined in validationModel

returns error object if the instance is invalid or nothing (void 0) if is ok.

- Class.properties(Ctor | instance) #

return hash of all properties with types if known.

- Class.keys(instance) #

return array of properties (_without methods and private props_)

- Class.stringify(instance) #

Serializes the instance. If class has name, the name is included, for later deserialization and initialization

- Class.parse(string) #

Deserializes instance. e.g - serialize models on NodeJS, pass them to the front-end and restore the models there.
`javascript
var User = Class('User', {
Base: Class.Serializable,
name: '',
log: function(){ console.log(this.name) };
});
var user = new User({name: 'baz'});
user.log(); //> 'baz'

var str = Class.stringify(user) //> {"name":"baz","__$class__":"User"}
...

var user = Class.parse(str);
user.log() //> 'baz'
`

$3

Validation Model
`javascript
{
// required, not empty string
foo: 'string',
// required, of type number
foo: 'number',
// required, validate with regexp
age: /^\d+$/,
// required, custom check function (return 'nothing' if ok)
number: function(value){
if (value % 2 !== 0)
return 'Only even numbers';
}
// optional. Same value types as by 'required'
'?baz': 'number',
// unexpect. Same value types as by 'required'
'-quz': null,
// validate subobject
jokers: {
left: 'number',
right: 'number'
},
// validate arrays
collection: [ {_id: 'string', username: 'string'} ]
}
`

- Class Validation

`javascript
var Foo = Class({
Validate: ValidationModel
});
var foo = new Foo;
var error = Class.validate(foo);
`
- Simple object validation

`javascript
var user = { username: 'foo' }
var error = Class.validate(user, ValidationModel);
`

$3

There are some classes you can start to use.

#### Deferred
Promise/Defer implementation

Usage example
`javascript
// 1) Create deferrable class
var X = Class({
Base: Class.Deferred,
// ... class properties
});
var dfr = new X;

// 2) Create simple deferrable object
var dfr = new Class.Deferred;

// 3) Create simple deferrable object with factory function
var dfr = Class.Deferred.run(function(dfr){
// perform async operations
});

// 3) Create deferrable delegate
var fn = Class.Deferred.create(function(dfr, foo){
// ...
dfr.resolve(foo);
}));

var dfr = fn('foo');

// 4) Memoize deferrable delegate (with same arguments function is called only once)
var fn = Class.Deferred.memoize(function(dfr, foo){
// ...
dfr.resolve(foo);
}));

var dfr1 = fn('foo');
var dfr2 = fn('foo');
dfr1 === dfr2; //> true


Deferred __proto__ {
// callbacks are called once
done : function(callback):Self,
fail : function(callback):Self,
always: function(callback):Self,

resolve: function(...args):Self,
reject : function(...args):Self

// reset deferred object and move to unresolved state
defer : function():Self

pipe : Function
// pipe Self states to this deferred instance
= function(Deferred):Self

// Returns new Deferred which depends on Filter functions
// @see Filter meta
= function(doneFilter, failFilter): new Deferred

// create the delegate function, which will resolve or reject the deferred object when called,
// first argument
pipeCallback: function(): function

// alias to .pipe(function, function)
then : function(doneFilter, dailFilter):new Deferred,

// check state
isResolved: function():Boolean,
isRejected: function():Boolean
isBusy : function():Boolean
};

doneFilter/failFilter : Function
// modify or override
// pipe and then deferreds are resolved then with this modified values
= function(): Any

// return another Deferred array to listen for
// pipe and then deferreds are bound to this deferred return value
= function(): Deferred


Deferred __static__ {
create: function(fn:function):Function,
run: function(fn:function):Deferred,
memoize: function(fn:function):Deferred
};
`

#### EventEmitter
`javascript
var X = Class({
Extends: Class.EventEmitter,
//...
});
new X();
new Class.EventEmitter;

EventEmitter __proto__ {
emit: function(...args):Self,
// alias to emit fn
trigger: function(...args):Self,

on: function(event, callback):Self,
once: function(event, callback):Self,
off: function(event, callback):Self,

// create Function which trigger specific event when is called
// fn(...args) ~~ x.trigger(event, ...args);
pipe: function(event): function

}
`

#### Run tests and build
`bash
$ npm install
$ npm test

build

$ atma
``
----
(c) 2014 MIT