hmvc v0.0.25
hmvc
A hierarchical mvc framework for node.js. I created this framework in order to create my bachelor degree project.
Simple login application:
##Instalation
npm install hmvc##Usage In order to function properly hmvc require this structure in every module(example login module):
{module name}
|
--css
|
-- login.css
|
--javascript
|
-- login.js
-- login.io.js // handles server requests
|
--mvc
|
--controllers
|
-- login.js // should only be a class like modules.export = function LoginController() {...}
-- login.io.js // handles client requests
|
--models
|
--views
|
-- login.html
#####P.S: you don't have to make a .io.js file if you don't want but i recommend separating the request from client to server and viceversa, from the client code and server code. The .io.js file are just a abstract level over the request so you can easily change the request names. An other method will be to put a labels file somewhere in client and server. You shouldn't have horcoded request in client or server because it becomes harder to debug when the application starts to scale and very rigid to changes. Another workaround will be to use nested functions like socket.emit('',function(){}); //This P.S. is not part of the framework is only a indication.
To call a controller from a module you can write:
module.{moduleName}.controller.{function}() // the main controller
module.{moduleName}.controllers.{class}.{function}() // specific controllerExample if you have a module named login and a controller in this module named LoginController you can call:
module.login.controller.loadPage();
module.login.controllers.LoginController.loadPage();
For a view you will have
module.{moduleName}.view which is a object with the functions:
- path ( a function that get's the view absolute path )
- render ( renders a view with a renderer like ejs.render, must be specified in hmvc constructor params)
- getLang ( return a file with multilanguage support, must be specified in hmvc constructor params)And if you have multiple views:
module.{moduleName}.views.{viewName} // views are considered only files with .html extensions
For a model you will need to intializate a object with the new keyword.
var model = new module.{moduleName}.model(); // for one
var model = new module.{moduleName}.models.{modelName}. // for multipleP.S : the name is not the filename *.js but the class inside that have module.exports.
##Ejs Application structure
Simple app
|
-- modules
test
|
--mvc
|
--controllers
|
--test.js
--test.io.js
--views
|
--test.html
layout
|
--mvc
|
--views
|
index.html
-- node_modules
-- app.jsthe main file(app.js)
Hmvc = require('hmvc');
express = require('express');
ejs = require('ejs');
var app = express();
app.configure(function () {
app.engine('.html', require('ejs').__express);
app.set('view engine', 'html');
app.use(express.static(__dirname + '/plugins/'));
});
hmvc = new Hmvc({app:app,view_extension:'html'});
hmvc.loadModules(__dirname+"/modules");
var modules = hmvc.modules;
app.listen(7076);test.js file
module.exports = function TestController(modules,_this){
this.load = function(res){
res.render('test'); // in this case you will need to ensure that are no name conflicts in multiple modules
//res.render(modules.test.view.path());// in this case you don't
//res.render(modules.test.view.path(),{modules:modules}) // if you want the modules in the view, this is made automatically in render function of view object, but this works only with websockets see example for more info.
}
};test.io.js file
module.exports = function TestIOController(modules,_this){
_this.app.get('/test',function(req,res){
modules.test.controller.load(res);
});
};test.html file
<html>
<head></head>
<body>
This is a test
</body>
</html>P.S in _this are send the parameters that you give to hmvc constructor except for langfile and sqlStatements which are reserved.
##Jade The differences between jade and ejs application are only in view and main file(app.js) app.js
Hmvc = require('hmvc');
express = require('express');
ejs = require('jade');
var app = express();
app.configure(function () {
app.set('view engine', 'jade');
app.use(express.static(__dirname + '/plugins/'));
});
hmvc = new Hmvc({app:app,view_extension:'jade'});
hmvc.loadModules(__dirname+"/modules");
var modules = hmvc.modules;
app.listen(7076);test.jade
html
head
body
This is a test
=modules.test.view.path()##EjsWebsocket the main file(app.js)
Hmvc = require('hmvc');
express = require('express.io');
ejs = require('ejs');
var app = express().http().io();
app.configure(function () {
app.engine('.html', require('ejs').__express);
app.set('view engine', 'html');
app.use(express.static(__dirname + '/plugins/'));
});
hmvc = new Hmvc({app:app,renderer:ejs.render,view_extension:'html'});
hmvc.loadModules(__dirname+"/modules");
var modules = hmvc.modules;
app.get('/',function(req,res){
res.render(modules.layout.view.path(),{
javascripts:modules.javascripts
});
});
app.listen(7076);test.io.js(server)
module.exports = function TestIOController(modules,_this){
_this.app.io.route('test:create',function(req){
modules.test.controller.load(req.io);
});
};test.js(server)
module.exports = function TestController(modules){
this.load = function(socket){
socket.emit("test:created",modules.test.view.render({}));
}
};test.io.js(client)
function TestIO(socket){
socket.on('test:created',function(data){
$("#test_container").html(data);
});
this.create = function(){
socket.emit('test:create');
};
}test.js(client)
function Test(){
window.testIO = new TestIO(socket);
testIO.create();
}
var test = new Test();test.html file
<html>
<head></head>
<body>
This is a test ejs <%= modules.test.view.path() %>
</body>
</html>index.html file
<html>
<head>
<script language="javascript" src="jquery/jquery.js"></script>
<script src="/socket.io/socket.io.js"></script>
<script language="javascript">
var socket = io.connect();
</script>
<% javascripts.forEach(function(javascript){ %>
<script type="text/javascript" src="<%= javascript %>"></script>
<% }) %>
<script>
$(document).ready(function(){
window.test = new test(); // the object should be singleton
});
</script>
</head>
<body>
<div id='test_container'></div>
</body>
</html>##JadeWebsocket In jade the differences appear only in app.js and views.
app.js
Hmvc = require('hmvc');
express = require('express.io');
jade = require('jade');
var app = express().http().io();
app.configure(function () {
app.set('view engine', 'jade');
app.use(express.static(__dirname + '/plugins/'));
});
hmvc = new Hmvc({app:app,renderer:jade.render,view_extension:'jade'});
hmvc.loadModules(__dirname+"/modules");
var modules = hmvc.modules;
app.get('/',function(req,res){
res.render(modules.layout.views.imba.path(),{
javascripts:modules.javascripts
});
});
app.listen(7076);index.jade
html
head
script(src='jquery/jquery.js')
script(src='/socket.io/socket.io.js')
script(type='text/javascript').
var socket = io.connect();
each javascript,i in javascripts
script(src=javascript)
script(type='text/javascript').
$(document).ready(function(){
Test();
Test.load();
});
body
#test_containertest.jade
html
head
body
div This is a test
= modules.test.view.path()license
The MIT License (MIT)
Copyright (c) 2014 Paraschiv Alexandru Nicolae
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.