py8765 / bearcat Goto Github PK

Bearcat is a POJOs based application framework which provides a lightweight container for writing simple, maintainable node.js. Bearcat provides an infrastructural backbone to manage business objects so that developers can focus on application-level business logic. Bearcat enables you to build applications from "plain old javaScript object"(POJO) and to apply enterprise services non-invasively to POJOs.

###Simple POJOs + Configuration metadatas = Elastic, maintainable system

• Homepage: http://bearcatnode.github.io/bearcat/
• Mailing list: https://groups.google.com/group/bearcatnode/
• Wiki: https://github.com/bearcatnode/bearcat/wiki/
• Issues: https://github.com/bearcatnode/bearcat/issues/
• Tags: nodejs, POJO, IoC, AOP, consistent configuration

• Dependency injection implementated Inversion of Control (IoC) to manage POJOs
• AOP based declarative middleware services
• Consistent development and configuration

• Simple meta configuration and POJOs
• Lightweight: high development efficiency based on node.js
• Reuseable: POJOs can be used to any development environment
• Invasive: there's no dependence on a container API
• Modular: you just use only those parts that you need
• One stop shop: no need for a dedicated Singleton or factory for every object etc
• Easy to mock objects for unit test based on IoC

• Good reference materials: full docs, many examples includes web todo, realtime app
• well-tested: test cases coverage is over 95%

• Custom features: you can add custom codes to container

POJO is an acronym for Plain Old Java Object, you can refer to POJO wikipedia. It is mostly used in Java Platform which is used to emphasize that a given object is an ordinary Java Object, not a special object.
In Node, what is POJO ?
It must be Plain Old JavaScript Object, which is simple, ordinary, and not anonymous.
To be not anonymous, it must have Constructor function.
So POJO can be like this:

var POJO = function() {
	this.props = null;
}

POJO.prototype.method = function() {
	
}

module.exports = POJO;

• POJO is simple, everyone can write it
• POJO makes development consistently, all your codes is POJOs
• POJO makes it friendly to document

Running bearcat is quite simple, all you have to do is to write simple POJOs and simple configuration metadatas like context.json, after this, passing context.json paths to bearcat, and run it, then all your POJOs will be magicly turned into an elastic, maintainable system.

var Bearcat = require('bearcat');
var contextPath = require.resolve('./context.json');

var bearcat = Bearcat.createApp([contextPath]);
bearcat.start(function(){
   var helloBearcat = bearcat.getBean('helloBearcat'); // get bean
   helloBearcat.hello(); // call the method
});

Codes written by simple POJOs and simple configuration metadatas can be run without Bearcat, however, in this case, you should have to do a lot of things by yourself, like handling dependency, configuration

more bearcat apis can be refered to bearcat-api

(The MIT License)

Copyright (c) fantasyni and other contributors

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.