gina 0.0.9-p91b → 0.1.1-alpha.2

package/{core → framework/v0.1.1-alpha.2/core}/status.codes

@@ -50,6 +50,14 @@
     "429": "Too Many Requests",
     "431": "Request Header Fields Too Large",
     "451": "Unavailable For Legal Reasons",
+    
+    // Extended Ngnix 4xx codes
+    "444": "No Response",
+    "495": "SSL Certificate Error",
+    "496": "SSL Certificate Required",
+    "497": "HTTP Request Sent to HTTPS Port",
+    "498": "Token expired/invalid",
+    "499": "Client Closed Request", 
 
     "500": "Internal Server Error",
     "501": "Not Implemented",

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/config/app.json

@@ -0,0 +1,6 @@
+// bundle needs to be restarted on changes !!
+{
+  "name": "{bundle}",
+  "version": "0.0.1",
+  "greeting": "Hello World !"
+}

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/config/routing.json

@@ -0,0 +1,11 @@
+// bundle needs to be restarted on changes !!
+{  
+  "homepage": {
+    "namespace": "content",
+    "url": "/",
+    "method": "GET",
+    "param": {
+      "control": "home"
+    }
+  }
+}

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/config/settings.json

@@ -0,0 +1,9 @@
+// bundle needs to be restarted on changes !!
+{
+    "region": {
+        "code": "en_CM",
+        "shortCode": "en",
+        "date": "yyyy/mm/dd",
+        "timeZone": "Africa/Douala"
+    }
+}

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/config/settings.server.json

@@ -0,0 +1,30 @@
+// bundle needs to be restarted on changes !!
+{
+    "webroot": "/{bundle}" // do not forget to add a coma here if you add other options ;)
+    /**
+    * `webrootAutoredirect` settings
+    * Default is `true`: set to false if you have describe a redirection rule from your `routing.json`
+    */
+    // "webrootAutoredirect": false,
+    
+    /**
+    * `template` settings
+    * Default is `false`: will automatically be set to `true` when you add a view/template (`false` is right for APIs only)
+    */
+    // "template": false 
+    
+    /**
+    * `response` settings
+    * This section is mostly used to setup CORS
+    */
+    // "response": {
+            // CORS settings sample
+    //     "header": {
+    //         "access-control-allow-origin": "{bundle}@{project}, https://checkout.stripe.com",
+    //         "access-control-allow-headers": "X-Requested-With", // To allow AJAX request
+    //         "access-control-allow-methods": "POST, GET, OPTIONS",
+    //         "access-control-allow-credentials": true,
+    //         "vary": "Origin"
+    //     }
+    // }
+}

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/config/templates.json

@@ -0,0 +1,42 @@
+// bundle needs to be restarted on changes !!
+{
+    // common definitions : will apply for all templates
+    "_common": {
+        // by default, or it will load `layout.html` if exists or `nolayout.html`(from the framework assets)
+        "layout": "{templatesPath}/html/layout/main.html",
+        // means that the file name of the template is the same as the route name
+        // You can override it through the routing.json
+        "routeNameAsFilenameEnabled": true,
+        "http-metas": {
+            "content-type": "text/html"
+        },
+        // global css - Will fetch from {bundle}/public
+        "stylesheets": [
+            {
+                "url": "/css/default.css"
+            }
+        ],
+        "javascriptsDeferEnabled": true,
+        "javascripts": [
+            // "/js/vendor/jquery/jquery-3.1.0.min.js",
+            // "/js/vendor/modernizr-2.8.3.min.js",
+            "/handlers/main.js"
+        ]
+    },
+
+    "home": {
+        // If you want to exclude all global css
+        //"stylesheetsExcluded": "*",        
+        // If you also want to get rid of `gina` definitions, use "**" while excluding
+        
+        // local css - Will fetch from {bundle}/public
+        "stylesheets": [
+            {
+                "url": "/css/home.css"
+            }
+        ]
+        
+        // If you want to exclude all global js
+        //"javascriptsExcluded": "*"
+    }
+}

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/controllers/controller.content.js

@@ -0,0 +1,39 @@
+//Imports goes here.
+
+/**
+ * {Bundle}ContentController
+ * Here are handled all contents
+ * */
+function {Bundle}ContentController() {
+    var self = this;
+    // get config/app.json content
+    var appConf = this.getConfig('app');
+
+    /**
+     * Home action
+     *
+     * @param {object} req
+     * @param {object} res
+     * @callback [next]
+     * */
+    this.home = function(req, res) {
+        var data = {
+            msg: appConf.greeting
+        };
+        
+        self.renderJSON(data);
+
+        // use this to render errors
+        // self.throwError( new Error('Error sample') );
+    }
+
+    // The onReady Event is called when the controller is loaded
+    // You can use this to define, overwrite and customise default controller methods & even swig filters
+    //this.onReady = function(req, res, next){
+    //    // e.g: Define a setup function that you call when the controller is ready
+    //    //setup(req, res, next)
+    //    // Or better, you can just complete and reuse the `setup.js` and call self.setup(req, res, next)
+    //}
+};
+
+module.exports = {Bundle}ContentController

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/controllers/controller.js

@@ -0,0 +1,30 @@
+//Imports goes here.
+
+/**
+ * {Bundle}Controller
+ * This controller is inherited by all the namespace controllers.
+ * This means that all public methods written here are reusable by the other controllers
+ * without calling `require` in case you decide to add a namespace.
+ * It is strongly advised to use namespaces to organize you code :
+ * E.g.:
+ *      gina namespace:add {bundle}/blogpost @{project}
+ *      gina namespace:add {bundle}/account @{project}
+ *      ...
+ * */
+function {Bundle}Controller() {
+    var self = this;
+    // get config/app.json content
+    // var appConf = this.getConfig('app');
+
+    
+
+    // The onReady Event is called when the controller is loaded
+    // You can use this to define, overwrite and customise default controller methods & swig filters
+    this.onReady = function(req, res, next){
+       // e.g: Define a `setup` function (inside this coontroller) that you can call when the controller is ready
+       // Or better, you can just complete and reuse the `setup.js` and call self.setup(req, res, next)
+       self.setup(req, res, next)
+    }
+};
+
+module.exports = {Bundle}Controller

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle/controllers/setup.js

@@ -0,0 +1,111 @@
+//Imports goes here.
+// var md = require('marked'); // visit: https://github.com/jmcmanus/pagedown-extra
+// var utils   = require('gina').utils;
+// var merge   = utils.merge;
+
+/**
+ * Setup Class
+ * Allows you to extend setup to all your controllers
+ * Most of the things you can do inside a controller, you can do it here
+ *
+ * E.g.: use it inside the controller `onReady` by calling `self.setup(req, res, next)`
+ *
+ *
+ * @param {object} req
+ * @param {object} res
+ * @callback [next]
+ * */
+function SetupClass(req, res, next){
+    // get `app` config
+    // var conf = this.getConfig('app')
+
+    // defining filters
+    var swig = this.engine;
+    
+    /**
+     * Inherited filters from Gina are:
+     * [ getWebroot ]
+     * Will get the current webroot
+     *  e.g.:
+     *      {{ '' | getWebroot() }}
+     * 
+     * [ getUrl ]
+     * Will tranlate a route name to an url
+     *  e.g.:
+     *      <a href="{{ '/homepage' | getUrl() }}">Homepage</a>
+     *      <a href="{{ 'users-add' | getUrl({ id: user.id }) }}">Add User</a>
+     *      <a href="{{ 'users-edit' | getUrl({ id: user.id }) }}">Edit user</a>
+     *      <a href="{{ 'users-get-empty' | getUrl({ id: '' }) }}">Get empty</a>
+     *      <a href="{{ 'users-list' | getUrl(null, 'http://domain.com') }}">Display all users</a>
+     *      <a href="{{ '/dashboard' | getUrl(null, 'admin') }}">Go to admin bundle's dashboard page</a>
+     *      <a href="{{ 'home@admin' | getUrl() }}">Go to admin bundle's dashboard page</a>      
+     * 
+     * [ length ]
+     *  Extends default Swig `length` filter
+     *  
+     * [ nl2br ]
+     * Will replace all `\n` by `<br/>`
+     *  e.g.:
+     *      {{ contact.address | nl2br }}
+     */
+    
+    
+    /**
+     * Sample of a swig filter to render markdown content
+     * To activate this code, you will need :
+     * 1) to install `marked` dependency : npm install marked --save
+     * 2) uncomment imports on the top of this script
+     * 3) uncomment the following filter definition
+     */    
+    // // default markdown options
+    // var markdownOpt = { // visit: https://github.com/jmcmanus/pagedown-extra
+    //     //renderer    : mdRenderer,
+    //     gfm         : true, // Enable GitHub flavored markdown.
+    //     tables      : false,
+    //     breaks      : true, // Enable GFM line breaks. This option requires the gfm option to be true.
+    //     pedantic    : false, // Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.
+    //     // deprecated since version 0.7.0
+    //     // sanitize    : false, // Sanitize the output. Ignore any HTML that has been input.
+    //     smartLists  : true, // Use smarter list behavior than the original markdown. May eventually be default with the old behavior moved into pedantic.
+    //     smartypants : false // Use "smart" typograhic punctuation for things like quotes and dashes.
+    // };
+
+    // md.setOptions(markdownOpt);
+    
+    // var setupSwigFilters = function(swig) {
+        
+    //     if ( typeof(swig) == 'undefined' ) return;
+        
+    //     /*
+    //     * markdown filter
+    //     * Usage:
+    //     *      <p>{{ 'once **apuon** a time\nthere was a princess' | markdown('strong','em') }}"</p>
+    //     *
+    //     * @param {string} text - markdown text string
+    //     *
+    //     * @returns {string} html
+    //     */
+    //    swig.setFilter('markdownToHtml', function (text, options) {
+
+    //         if ( typeof(text) != 'undefined' ) { // found
+
+    //             if ( typeof(options) != 'undefined' ) {
+    //                 options = merge(options, markdownOpt);
+
+    //                 md.setOptions(options);
+    //             }
+
+    //             return md(text)
+    //         }
+
+    //         return text
+    //     });
+    // }
+    
+    if (swig && typeof(setupSwigFilters) != 'undefined') { // not always available: redirect, xhr requests
+        setupSwigFilters(swig)
+    }
+
+};
+
+module.exports = SetupClass

package/{core/template/samples/bundle → framework/v0.1.1-alpha.2/core/template/boilerplate/bundle_namespace}/controllers/controller.js

@@ -1,23 +1,25 @@
 //Imports goes here.
 
 /**
- * {Bundle}Controller
+ * {Bundle}{Namespace}Controller
  * */
-function {Bundle}Controller() {
+function {Bundle}{Namespace}Controller() {
     var self = this;
     // get config/app.json content
     // var appConf = this.getConfig('app');
 
     /**
-     * Init default action
+     * Default action
      *
      * @param {object} req
      * @param {object} res
      * @callback [next]
      * */
-    this.init = function(req, res) {
-        console.log('got init action');
-        self.renderJSON({ status: '200', msg: 'hello world !' })
+    this.default = function(req, res) {
+        self.renderJSON({ status: '200', msg: 'hello world !' });
+
+        // use this to render errors
+        // self.throwError( new Error('Error sample') );
     }
 
     // The onReady Event is called when the controller is loaded
@@ -29,4 +31,4 @@ function {Bundle}Controller() {
     //}
 };
 
-module.exports = {Bundle}Controller
+module.exports = {Bundle}{Namespace}Controller

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle_public/js/vendor/readme.md

@@ -0,0 +1 @@
+Vendor is used for dependecies like `jquery.min.js`

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle_public/readme.md

@@ -0,0 +1 @@
+`public` is the public directory.

package/framework/v0.1.1-alpha.2/core/template/boilerplate/bundle_templates/handlers/main.js

@@ -0,0 +1,24 @@
+/**
+ * {Bundle} Main handler
+ */
+
+// requires are put here
+ 
+ var {Bundle}Handler = ( function on{Bundle}MainHandled() {
+     var self                = {}
+     ;
+ 
+     var init = function() {
+ 
+         // Define global handlers/bindings here
+         
+         handle();
+     }
+ 
+ 
+     var handle = function () {
+         console.debug('Main {Bundle} handler loaded !');         
+     };
+     
+     init();
+ })();

package/{core/template/views/html/layout.html → framework/v0.1.1-alpha.2/core/template/boilerplate/bundle_templates/html/layout/main.html}

@@ -9,8 +9,8 @@
         <meta name="robots" content="index, follow, noarchive">
         <meta name="distribution" content="global">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
-        {{ page.stylesheets }}
-        {{ page.scripts }}
+        {{ page.view.stylesheets }}
+        {{ page.view.scripts }}
     </head>
     <body>
         {{ page.content }}

package/{core → framework/v0.1.1-alpha.2/core}/template/command/gina.tpl

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 /*
  * This file is part of the gina package.
- * Copyright (c) 2016 Rhinostone <gina@rhinostone.com>
+ * Copyright (c) 2009-2022 Rhinostone <contact@gina.io>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.

package/framework/v0.1.1-alpha.2/core/template/conf/env.json

@@ -0,0 +1,76 @@
+{
+  "_comment": "Please, don't touch this.",
+  "defEnv": "dev",
+  "logLevels": [
+    "silly",
+    "trace",
+    "info",
+    "debug",
+    "warn",
+    "error"
+  ],
+  "defExt": "",
+  "mountPath": "{executionPath}/bundles",
+  "globalTmpPath": "{executionPath}/tmp",
+  "logsPath": "{executionPath}/logs",
+  "{bundle}": {
+    "{env}": {
+      "projectPath": "{executionPath}",
+      "bundlesPath": "{executionPath}/bundles",
+      "bundlePath": "{bundlesPath}/{bundle}",
+      "sharedPath": "{executionPath}/shared",
+      "cachePath": "{executionPath}/cache",
+      "connectorsPath": "{frameworkDir}/core/connectors",
+      "cronsPath": "{bundlesPath}/{bundle}/crons",
+      "modelsPath": "{bundlesPath}/{bundle}/models",
+      "libPath": "{bundlesPath}/{bundle}/lib",
+      "releases": "{executionPath}/releases",
+      "sources": "{executionPath}/src",
+      "tmpPath": "{executionPath}/tmp",
+      "publicPath": "{bundlesPath}/{bundle}/public",
+      "templatesPath": "{bundlesPath}/{bundle}/templates",
+      "handlersPath": "{bundlesPath}/{bundle}/templates/handlers",
+      "watchers": "{bundlesPath}/{bundle}/watchers",
+      "workersPath": "{bundlesPath}/{bundle}/workers",
+      "template": false,
+      "server": {
+        "engine": "isaac",
+        "webroot": "/",
+        "webrootAutoredirect": true,
+        // "credentials": {
+        //   "_comment": "SSL Credentials: private key & certificate samples to use for HTTPS scheme & HTTP/2.0 protocol",
+        //   "privateKey": "{projectPath}/ssl/server.key",
+        //   "certificate": "{projectPath}/ssl/server.crt",
+        //   "allowHTTP1": true
+        // },
+        "response": {
+          "header": {
+            "accept-language": "en-US,en;q=0.8,fr;q=0.6",
+            "X-Powered-By": "Gina I/O - v{version}"
+            // See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
+            // See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Vary
+          }
+        }
+      },
+      "encoding": "utf8",
+      "files": [
+        "app",
+        "connectors",
+        "routing",
+        "settings",
+        "statics",
+        "templates",
+        "watchers"
+      ],
+      "contexts": {
+        "paths": {}
+      }
+    }
+  },
+  "system": {},
+  "log": [
+    {
+      "path": "/logs/gina"
+    }
+  ]
+}

package/{core/template/conf/project.json → framework/v0.1.1-alpha.2/core/template/conf/manifest.json}

@@ -1,4 +1,5 @@
 {
   "name": "{project}",
+  "version": "{version}",
   "bundles": {}
 }

package/{core → framework/v0.1.1-alpha.2/core}/template/conf/package.json

@@ -3,9 +3,9 @@
   "version": "0.0.1",
   "description": "{project} is a nice project !",
   "dependencies": {
-    "gina" : ""
+    "gina" : "{gina_version}"
   },
   "engine": [
-    "node >=0.10.22"
+    "node >={node_version}"
   ]
 }

package/framework/v0.1.1-alpha.2/core/template/conf/settings.json

@@ -0,0 +1,92 @@
+{
+  "server": {
+    "engine": "isaac",
+    "credentials": {
+      "_comment": "Project ENV override: SSL Credentials: private key & certificate",
+      "privateKey": "{GINA_HOMEDIR}/certificates/scopes/{scope}/{host}/private.key",
+      "certificate": "{GINA_HOMEDIR}/certificates/scopes/{scope}/{host}/certificate.crt",
+      "ca": "{GINA_HOMEDIR}/certificates/scopes/{scope}/{host}/ca_bundle.crt",
+      "allowHTTP1": true
+    },
+    // refers to server.js, lib.routing & controller.js
+    "supportedRequestMethods": {
+      "body": {},
+      "get": {},
+      "post": {},
+      "put": {},
+      "delete": {},
+      "files": []
+      // https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods
+      // ? connect, head, options, trace, patch, cookies, copy
+    }
+  },
+  "upload": {
+    "_comment": "for more details, check out https://github.com/mscdex/busboy",
+    "encoding": "utf8",
+    "tmpPath": "{tmpPath}",
+    "maxFieldsSize": "2MB", // for all uploads by default - can be redefined under the group
+    "maxFields": 1000, // number of assets when isMultipleAllowed - can be redifined under the group
+    // timeout for tmp files removal - can be redifined under the group
+    // will be ignored by server if set to 0 or false
+    // but you will have to setup a cron to remove files from tmp dir
+    // eg.: (int) 5000 for 5 sec
+    // eg.: (string) 10m for 10 minutes
+    // eg.: (int) 0 to disable autoTmpCleanupTimeout
+    // eg.: (boolean) false to disable autoTmpCleanupTimeout
+    "autoTmpCleanupTimeout": false,
+    // You need to set groups in order to enable uploads
+    "groups": {
+      "untagged": {
+        "path": "{tmpPath}",
+        "allowedExtensions": "*", // or [ "jpg", "jpeg", "png", "svg" ]
+        "isMultipleAllowed": false
+        // optional sample
+        // ,
+        // "filePrefix": "$designId_",
+        // "subFolder": "/$ownerId_$companyId",
+        // "maxFieldsSize": "512K"
+      }
+    }
+  },
+  "cache": {},
+  "engine.io": {
+    "port": 8888
+  },
+  "livereload": {},
+  "locale": {
+    "preferedLanguages": [ "en-US" ],
+    "region": "EN",
+    "firstDayOfWeek": 1,
+    "calendar": "gregorian",
+    "temperature": "celsius",
+    "number": {
+      "grouping": null,
+      "decimal": "."
+    },
+    "currency": {
+      "code": "usd",
+      "grouping": null,
+      "decimal": "."
+    },
+    "measurementUnits": "metric",
+    "dateFormat": {
+      "short": "mm/dd/yyyy",
+      "medium": "mmm d, yyyy",
+      "long": "mmmm d, yyyy",
+      "full": "dddd, mmmm d, yyyy"
+    },
+    "24HourTimeFormat": true,
+    "timeFormat": {
+      "default": {
+        "short": "h:MM:ss",
+        "medium": "h:MM:ss",
+        "long": "h:MM:ss TT"
+      },
+      "24H": {
+        "short": "HH:MM",
+        "medium": "HH:MM:ss",
+        "long": "HH:MM:ss TT"
+      }
+    }
+  }
+}

package/framework/v0.1.1-alpha.2/core/template/conf/statics.json

@@ -0,0 +1,10 @@
+{
+  //"favicon.ico": "{templatesPath}/favicon.ico",
+  //"favicons": "{templatesPath}/favicons",
+  "html": "{templatesPath}/html",  // used for templating
+  "sass": "{templatesPath}/sass",  // used for templating
+  "handlers": "{handlersPath}",  // used for templating
+  //"common": "{sharedPath}", 
+  "css/vendor/gina": "{gina}/framework/v{version}/core/asset/js/plugin/dist",
+  "js/vendor/gina": "{gina}/framework/v{version}/core/asset/js/plugin/dist"
+}

package/framework/v0.1.1-alpha.2/core/template/conf/templates.json

@@ -0,0 +1,37 @@
+{
+  "_common": {
+    // if layout == "" or layout == false => isWithoutLayout will be set to `true`
+    "layout": "{templatesPath}/html/layout.html",
+    "noLayout": "{gina}/framework/v{version}/core/asset/html/nolayout.html", 
+    "templates": "{templatesPath}", // only if hasView() - deprecated
+    "html": "{templatesPath}/html",  // only if hasView()
+    "theme": "default_theme", // only if hasView()
+    "forms": "{bundlePath}/forms",
+    "handlers": "{templatesPath}/handlers",
+    "routeNameAsFilenameEnabled": true,
+    "ginaEnabled": true, // set to false, this will exclude gina assets from being loaded
+    "pluginLoader": "{src:{gina}/framework/v{version}/core/asset/js/plugin/dist/gina.onload.min.js}",
+    "http-metas": {
+      "content-type": "text/html"
+    },
+    "stylesheets": [
+      {
+        "name"      : "gina",
+        "media"     : "all",
+        "rel"       : "stylesheet",
+        "type"      : "text/css",
+        "url"       : "/css/vendor/gina/gina.min.css",
+        "isCommon"  : true
+      }
+    ],
+    "javascriptsDeferEnabled": true, // will place scripts in defer mode in the head by default. If false, will place in the footer
+    "javascripts": [
+      {
+        "name"      : "gina",
+        "type"      : "text/javascript",
+        "url"       : "/js/vendor/gina/gina.min.js",
+        "isCommon"  : true
+      }
+    ]
+  }
+}