formage - npm Package Compare versions

Comparing version 1.0.2 to 1.5.0

example/app.js

@@ -0,90 +1,46 @@
+'use strict';
+Error.stackTraceLimit = Infinity;
 var express = require('express'),
-    mongoose = require('mongoose'),
-    models = require('./models.js'),
-    forms = require('../forms.js');
+    http = require('http'),
+    path = require('path');
 
-mongoose.connect('mongodb://localhost/forms_test');
+require('../CompileTempletes.js');
 
 var app = express();
 
-app.use(express.bodyParser());
-app.use(express.methodOverride());
-app.set('views', require('path').join(__dirname, 'views'));
-app.use(express.static(require('path').join(__dirname, '..', 'static')));
+app.configure('all', function(){
+    app.set('port', process.env.PORT || 8080);
+    app.set('mongo', process.env.MONGO_URL || 'mongodb://localhost/formage-admin-example');
+    app.set("view options", { layout: false, pretty: true });
 
-//var adm = new admin.Admin('/admin',app);
+    app.use(express.favicon());
+    app.use(express.bodyParser());
+    app.use(express.methodOverride());
+    app.use(express.cookieParser('magical secret admin'));
+    app.use(express.cookieSession({cookie: { maxAge: 1000 * 60 * 60 *  24 }}));
+    app.use(express.static(path.join(__dirname, 'public')));
+    app.use(app.router);
+});
 
-//adm.register_admin('books',new admin.MongooseAdminResource(models.Book,{list_fields:['id','name','author']}));
-//adm.register_admin('authors',new admin.MongooseAdminResource(models.Author,{list_fields:['id','name']}));
-
-app.get('/', function (req, res) {
-    res.redirect('/new');
+app.configure('development', function() {
+    app.use(express.errorHandler());
 });
 
-app.all('/new', function (req, res) {
-    var form = new forms.MongooseForm(req, {
-        empty: function (err) {
-            res.render('form.ejs', {form: form});
-        },
-        success: function (err, result) {
-            res.send('saved');
-        },
-        error: function (err) {
-            res.render('form.ejs', {form: form});
-        }
-    }, models.Book);
+require('mongoose').connect(app.get('mongo'));
+//require('./admin')(app);
+var formage = require('../index');
+var admin = formage.init(app, express, require('./models'), {
+    title: 'Formage-Admin Example'
 });
 
-//app.post('/new',function(req,res)
-//{
-//    var form = new forms.MongooseForm(req,{},models.Book);
-//    form.is_valid(function(err,valid)
-//    {
-//        if(valid)
-//        {
-//            form.save(function(err,ent)
-//            {
-//                console.log(ent);
-//                res.send('saved');
-//            });
-//        }
-//        else
-//        {
-//            form.render_ready(function(err)
-//            {
-//                res.render('form.ejs',{form:form});
-//            });
-//        }
-//    });
-//});
+admin.registerAdminUserModel();
 
-app.post('/edit', function (req, res) {
-    models.Book.findOne({}, function (err, book) {
-        var form = new forms.MongooseForm(req, {instance: book}, models.Book);
-        form.is_valid(function (err, valid) {
-            if (valid) {
-                form.save(function (err, ent) {
-                    console.log(ent);
-                    res.send('saved');
-                });
-            }
-            else {
-                form.render_ready(function (err) {
-                    res.render('form.ejs', {form: form});
-                });
-            }
-        });
-    });
+app.get('/', function(req, res){
+    res.redirect('/admin');
 });
 
-app.get('/edit', function (req, res) {
-    models.Book.findOne({}, function (err, book) {
-        var form = new forms.MongooseForm(req, {instance: book, exclude: ['genre']}, models.Book);
-        form.render_ready(function (err) {
-            res.render('form.ejs', {form: form});
-        });
-    });
+http.createServer(app).listen(app.get('port'), function(){
+  console.log('Express server listening on port ' + app.get('port'));
 });
 
-app.listen(80);
-console.log('up');
+exports.app = app;

index.js

 'use strict';
-if (!module.parent) {
-    console.log("Do not call formage directly. require()-ing is required.");
-    process.exit(1);
-}
+if (!module.parent) console.error('Please don\'t call me directly.I am just the main app\'s minion.') || process.process.exit(1);
 
-var path = require('path');
+var MongooseAdmin = require('./MongooseAdmin.js'),
+    path = require('path'),
+    routes = require('./routes'),
+    express = require.main.require('express'),
+    ckeditorPath = require('node-ckeditor');
 
-module.exports.common = require('./common');
-module.exports.types = require('./mongoose-types');
-module.exports.forms = require('./forms');
-module.exports.fields = require('./fields');
-module.exports.widgets = require('./widgets');
 
-module.exports.statics_path = path.join(__dirname, 'public');
-module.mongoose_module = require.main.require('mongoose');
+exports.version = require(path.join(__dirname, 'package.json')).version;
+exports.forms = require('./forms');
+exports.init = require('./init');
+exports.loadApi = require('./AdminForm').loadApi;
+exports.AdminForm = require('./AdminForm').AdminForm;
 
-module.exports.setAmazonCredentials = module.exports.fields.setAmazonCredentials;
 
+// Create the admin singleton object
+exports.createAdmin = function(app, options) {
+    options = options || {};
+    var root = '/' + (options.root || 'admin');
 
-module.exports.serve_static = function(app, express) {
-    app.use('/', express.static(module.exports.statics_path));
+    console.log('\x1b[36mformage-admin\x1b[0m at path', root);
+    var admin = MongooseAdmin.singleton = new MongooseAdmin(app, root);
+    routes(MongooseAdmin, app, root);
+    return admin;
 };
 
-module.exports.loadTypes = function (mongoose) {
-    module.mongoose_module = module.exports.mongoose_module = module.exports.mongoose_module || mongoose;
-    exports.types.loadTypes(mongoose);
+
+// Serve static files
+exports.serve_static = function (app, express, options) {
+    options = options || {};
+    options.root = options.root || 'admin';
+
+    if (module._is_serving_static) return;
+    module._is_serving_static = true;
+
+    app.use('/' + options.root, express.static(path.join(__dirname, '/public')));
+    app.use('/' + options.root + '/ckeditor', express.static(ckeditorPath));
 };
 
-module.exports.register_models = function (models) {
-    module.models = module.exports.models = models;
-    module.exports.forms.set_models(models);
+
+var types_loaded;
+exports.loadTypes = function () {
+    if (types_loaded) return;
+    types_loaded = true;
+
+    exports.forms.loadTypes();
 };
 
-module.exports.registerModel = function (name, model) {
-    module.exports.forms.registerModel(name, model);
+
+
+exports.register_models = function (models) {
+    if (this._models_registered) return;
+    this._models_registered = true;
+
+    exports.forms.forms.set_models(models);
 };
+
+
+exports.set_amazon_credentials = module.exports.forms.set_amazon_credentials;

package.json

 {
   "name": "formage",
-  "description": "Forms creation from fields or from mongoose models",
-  "version": "1.0.2",
+  "description": "Admin GUI addon for mongoose and non mongoose projects on Express.js",
+  "version": "1.5.0",
+  "main": "index.js",
   "author": {
-    "name": "Ishai Jaffe",
-    "email": "[e-mail]"
+      "name": "Etai Peretz",
+      "email": "[e-mail]",
+      "url": "http://www.empeeric.com/"
   },
+  "contributors": [{
+      "name": "Ishai Jaffe",
+      "email": "[e-mail]"
+    },
+    {
+      "name": "Refael Ackermann",
+      "email": "[e-mail]",
+      "url": "http://www.empeeric.com/"
+    },
+    {
+      "name": "Alon Valadji",
+      "email": "[e-mail]",
+      "url": "http://www.empeeric.com/"
+    }
+  ],
   "dependencies": {
-    "sji": "",
-    "underscore": "",
+    "lodash": "",
     "async": "",
-    "cloudinary": ""
+    "cloudinary": "",
+    "nodestrum": "",
+    "node-ckeditor": ""
   },
   "devDependencies": {
+    "jade": "",
     "express": "",
-    "ejs": ""
+    "mongoose": ""
   },
-  "main": "index",
+  "bundleDependencies": [
+    "sji",
+    "nodestrum"
+  ],
   "keywords": [
-    "formage",
+    "admin",
     "forms",
     "mongoose",
-    "django"
+    "mongoose-gui"
   ],
   "repository": {
     "type": "git",
-    "url": "[e-mail]:etaypere/formage.git"
+    "url": "https://github.com/Empeeric/formage.git"
   },
+  "bugs": {
+    "url": "https://github.com/Empeeric/formage/issues"
+  },
+  "directories": {
+    "example": "./example"
+  },
   "engines": {
-    "node": ">= 0.8.0",
-    "npm": ">= 1.0.0"
+    "node": ">= 0.10.12",
+    "npm": ">= 1.2.28"
   }
 }

README.md

@@ -1,10 +0,63 @@
-Formage
-=======
+![](http://i.imgur.com/9vVHCPY.png) Formage Admin
+=============
 
-Form mage, forked from [forms](https://github.com/caolan/forms),
-used mainly by [formage-admin](https://github.com/Empeeric/formage-admin).
+[Bootstraped](http://twitter.github.com/bootstrap/) admin forms for [Mongoose](http://mongoosejs.com/),
+originally forked from [mongoose-admin](https://github.com/marccampbell/mongoose-admin).
 
-<hr />
+Usage
+-----
+`npm install formage-admin`
+
+```javascript
+var admin = require('formage-admin').init(app, express);
+```
+
+Also, look at `\example` directory.
+
+Some Options
+------------
+```javascript
+// model options
+model.label = 'My Songs';
+model.singular = 'Song';
+model.static = {
+   js: [ '/js/songs.js' ],
+   css: ['/css/songs.css' ]
+};
+model.formage = {
+    filters: ['artist', 'year'],
+    
+    // Additional actions on this model
+    actions: [
+       {
+          value: 'release',
+          label: 'Release',
+          func: function (user, ids, callback) {
+             console.log('You just released songs ' + ids);
+             callback();
+          }
+       }
+    ],
+    
+    // list of fields to be displayed by formage for this model
+    list: ['number', 'title', 'album', 'artist', 'year'],
+    
+    // list of order fields
+    order_by: ['-year', 'album', 'number'],
+    
+    // list of fields that must be populated (see http://mongoosejs.com/docs/api.html#document_Document-populate)
+    list_populate: ['album']
+};
+
+// one-document models
+model.single = true;
+
+// field options
+field.label = 'Song Title';
+```
+
+Sponsors
+========
 <a id="stormlogo" href="http://www.jetbrains.com/webstorm/" alt="Smart IDE for web development with HTML Editor, CSS &amp; JavaScript support" title="Smart IDE for web development with HTML Editor, CSS &amp; JavaScript support">
   ![](http://i.imgur.com/ynQ6c.png)
 </a>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Wildcard dependency

Quality

Package has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.

Found 3 instances in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 3 instances in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Wildcard dependency

Quality

Package has a dependency with a floating version range. This can cause issues if the dependency publishes a new major version.

Found 2 instances in 1 package

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Lines of code

27980

increased by63.49%

Number of low maintenance alerts

1

decreased by-50%

Number of lines in readme file

64

increased by481.82%

Worsened metrics

Total package byte prevSize

1339503

decreased by-52.08%

Dependency count

5

increased by25%

Dev dependency count

3

increased by50%

Number of package files

107

decreased by-60.81%

Number of medium maintenance alerts

1

increased byInfinity%

Number of medium quality alerts

6

increased by20%

Number of low supply chain risk alerts

9

increased by800%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedlodash@

• + Addednode-ckeditor@

• + Addednodestrum@

• + Addednode-ckeditor@4.5.9(transitive)

• + Addednodestrum@0.10.1(transitive)

• - Removedsji@

• - Removedunderscore@

• - Removedsji@0.0.1(transitive)

• - Removedunderscore@1.13.7(transitive)