gengojs

Gengo.js

Visit Gengojs.com for installation, configuration, and documentation. Also, feel free to fork gengo and the site to add more languages and locale support!

If you would like to see more examples other than the ones on gengojs.com then check out the tests there's 127 possible ways to gengo!

##Acknowledgements gengo was made possible by:

• locale
• App Root Path
• Moment.js
• Numeral.js
• underscore.js
• sprintf.js
• xml2js

#Change Log

0.2.17

• Updated readme
• gengojs.com has been updated for 0.2.16 but will be re-updated and tested with alpha.
• Working on 0.3.x aka alpha.

An alien invasion happened between 0.2.17 and alpha 0.2.20. oh well, we'll proceed from alpha 0.2.20

####Alpha

For previous notes on changes, see CHANGELOG.md

alpha 0.2.20

• Added more tests (all 127 passing)
• You can also run individual tests:
  • npm run functions - checks the functionality
  • npm run cookies - checks if cookies work
  • npm run libs - checks if moment and numeral (in progess) works
  • npm run routes - checks if routing works
• You can now use a basic locale automator/creator. Just run npm run factory.
• Changed locale naming convention from 'en_US' to 'en-US' (you may use 'en-US', 'en_us', or 'en-us' and gengo will sanitize and return it in the form of [a-z]-[A-Z]) Note that you will need to rename your definitions to 'en-US' etc.
• Bug fix with locale not really doing anything. Changed the locale parsing engine to the same one used in i18n library so credits to @mashpie. But no worries it wasn't as bad as yesterday's 'bash bug' and not as bad as 'heartbleed'.
• Moment.js and Numeral.js are now public.
  • You can also have a global and local version of moment and numeral by simply passing an object like so:

//use the gengo version of moment and numeral
__.moment({locale:'ja'}).format('dddd'); //Will print today in Japanese
__.numeral({locale: 'ja'}, 25).format('$0.00'); //will print in Japanese yen

• You can now change the cookie locale name in config. Use cookiename. Default is 'locale'.
• Reduced the number of gengo modules. core, locale, and lib have been moved to gengo.
• Fixed bug issue with universe not working properly.
• Better error handling for the most part.

alpha.gengo.js is now moving to omega phase after this release.

####Omega

The file has been renamed to omega.gengo.js

omega 0.2.21

• Updated readme

• Added mustache as dependency.

omega 0.2.22

• Updated readme

omega 0.2.23

• Fixed typo for default directory
• Small clean up with JSHint

omega 0.2.24

• Replaced dot notation parsing engine, credits to rhalff
• Replaced markdown engine which fixes a minor bug.
• Removed a few try catch statements that caused issues to the core.
• Updated readme

omega 0.2.25

• Router module can now accept urls that contain versions in the following format: \d{1,2}(\.)\d{1,2}((\.)\d{1,2})?$ Note that adding 'v' before the numbers does not matter just as long its in the form.
• If you want to use multiline line in JSON. Just create the text in the following form and it will work:

//ja.js
module.exports = {
    "index": {
        "something": [
        "line1",
        " line2",
        " line3",
        ].join('\n'),
        "so forth and so on": "something"
    }
};

omega 0.2.26

• Updated readme
• Fixed a bug in locale engine where cookie could set something that shouldn't be set.
• Fixed a bug in phrase parser where try catch wouldn't let parser return the original phrase if route results didn't exists

####gengo 0.3.26 Release

• gengo is now at v0.3! If you want to continue to use v0.2 just change the require path to gengojs/legacy/v0.2/gengo.js
• Changed test's gengo path.

0.3.27

• Fixed bug when a browser with requesting a foreign locale would not change the site.

0.3.28

• Removed removed the global moment and numeral since it's now part of gengo.
• Updated readme
• Updated gengojs.com for v0.3.

0.3.29

• Fixed bug in phrase parser when router is enabled. The parser will get the translated version when its suppose to return the original phrase.

0.3.30

• Removed accept-language npm module from the dependants
• Fixed isssue if result in phrase parser is undefined to just return the phrase.
• All tests still pass
• Discovered that gengo works in Sails.js smoothly in a test app (still testing). It will look like this in config/http.js:

/**
 * HTTP Server Settings
 * (sails.config.http)
 *
 * Configuration for the underlying HTTP server in Sails.
 * Only applies to HTTP requests (not WebSockets)
 *
 * For more information on configuration, check out:
 * http://sailsjs.org/#/documentation/reference/sails.config/sails.config.http.html
 */
require('gengojs').config({
  default: 'en-US',
  directory: require('app-root-path') + "/config/locales/",
  debug:{
    level: ['warn', 'debug']
  }
});
module.exports.http = {

  /****************************************************************************
  *                                                                           *
  * Express middleware to use for every Sails request. To add custom          *
  * middleware to the mix, add a function to the middleware config object and *
  * add its key to the "order" array. The $custom key is reserved for         *
  * backwards-compatibility with Sails v0.9.x apps that use the               *
  * `customMiddleware` config option.                                         *
  *                                                                           *
  ****************************************************************************/

   middleware: {

  /***************************************************************************
  *                                                                          *
  * The order in which middleware should be run for HTTP request. (the Sails *
  * router is invoked by the "router" middleware below.)                     *
  *                                                                          *
  ***************************************************************************/
    __: require('gengojs').init,

    order: [
      'startRequestTimer',
      'cookieParser',
      'session',
      'myRequestLogger',
      'bodyParser',
      'handleBodyParserError',
      "__",
      'compress',
      'methodOverride',
      'poweredBy',
      '$custom',
      'router',
      'www',
      'favicon',
      '404',
      '500'
    ],

  /****************************************************************************
  *                                                                           *
  * Example custom middleware; logs each request to the console.              *
  *                                                                           *
  ****************************************************************************/

    // myRequestLogger: function (req, res, next) {
    //     console.log("Requested :: ", req.method, req.url);
    //     return next();
    // }


  /***************************************************************************
  *                                                                          *
  * The body parser that will handle incoming multipart HTTP requests. By    *
  * default as of v0.10, Sails uses                                          *
  * [skipper](http://github.com/balderdashy/skipper). See                    *
  * http://www.senchalabs.org/connect/multipart.html for other options.      *
  *                                                                          *
  ***************************************************************************/

    // bodyParser: require('skipper')

   },

  /***************************************************************************
  *                                                                          *
  * The number of seconds to cache flat files on disk being served by        *
  * Express static middleware (by default, these files are in `.tmp/public`) *
  *                                                                          *
  * The HTTP static cache is only active in a 'production' environment,      *
  * since that's the only time Express will cache flat-files.                *
  *                                                                          *
  ***************************************************************************/

  // cache: 31557600000
};