soyer

soyer ===========

npm install soyer
1 downloads in the last day
10 downloads in the last week
23 downloads in the last month

soyer

Build Status

Soyer is small lib for serverside use of Google Closure Templates with node.js.

Thanks to Daniel Pupius for soynode. I used this module as template and added the language support and removed the compile features.

Written in coffee-script

INFO: all examples are written in coffee-script

Install

  npm install soyer

Initialize module:

Soyer = require("soyer")
mySoyer = new Soyer( config )

mySoyer.load ( err, success )->
    if err
        throw err
    else
        console.log( "templates sucessfully loaded" )

config object description

  • path : ( String required )
    absolute path to the directory where the module can find compiled soy files.
  • soyFileExt : ( String optional: default = ".soy.js" )
    soy file extension to select only the compiled soy files.
  • languagesupport : ( Boolean optional: default = false )
    enable the language support. If true the following options are relevant.
  • defaultlang : ( String optional: default = "en-us" )
    the default language code if the passed code will not fit.
  • availibleLangs : ( Array optional: default = "[ "en-us", "de-de" ]" )
    a list of valid language codes
  • extractLang : ( Function optional )
    a method to extract the language-code out of the filename. The filename will be passed to the method and should return a valid language code.

Example

Soyer = require( "soyer" )

mySoyer = new Soyer
    path: path.resolve( __dirname, "../path/to/templates/" ) 

mySoyer.load ( err, success )->
    throw err if err

    rendered = mySoyer.render( "myNamespace.myTemplate", { param1: "abc" } )
    console.log( rendered )

Advanced example

# files in folder: template.soy, template.en.js, template.fr.js, template.de.js

Soyer = require( "soyer" )

mySoyer = new Soyer
    path: path.resolve( __dirname, "../path/to/templates/" ) 
    soyFileExt: ".js"
    languagesupport: true
    defaultlang: "de"
    availibleLangs: [ "en", "de", "fr" ]
    extractLang: ( file )->
        [ _name, _lang ] = file.split( "." )
        return _lang


mySoyer.load ( err, success )->
    throw err if err

    renderedDE = mySoyer.render( "myNamespace.myTemplate", "de" { param1: "deutsch" } )
    console.log( renderedDE )

    renderedEN = mySoyer.render( "myNamespace.myTemplate", "en" { param1: "english" } )
    console.log( renderedEN )

    renderedFR = mySoyer.render( "myNamespace.myTemplate", "fr" { param1: "fran├žais" } )
    console.log( renderedFR )

get a template method ( GET )

Get's a method to render a template.

mySoyer.get( name, [ lang ] ) Arguments :

  • name: ( String required )
    soy path of the template.
  • lang: ( String required )
    the language to render if languagesupport is activated.

Example

fnTemplate = mySoyer.get( "myNamespace.path.to.template" )

console.log( fnTemplate( { param1: "hello world" } ) )

render a template ( RENDER )

render a template immediately

mySoyer.get( name, [ lang ] ) Arguments :

  • name: ( String required )
    soy path of the template.
  • lang: ( String optional )
    the language to render if languagesupport is activated.
  • data: ( String optional: default = {} )
    template data.

Example

rendered = mySoyer.render( "myNamespace.path.to.template", { param1: "hello world" } )
console.log( rendered )

routing helper

usually you will use soyer within a routing framework like express.
In this case the server has to finish the loading of the templates before the first .render() is called.
So you can use the method routingWait to add a middleware and make sure the templates has been loaded until the first rendering starts.

To use it you just have to add and call the method [ your soyer instance ].routingWait() as middleware.
Buff This is designed to fit to express. But you can use it in other tools, too. You just have to make sure the last argument of your routing framework is the next method ( e.g. in express it's ( request, response, next ) ).

Example

express = require("express")
app = express.createServer()

Soyer = require("soyer")
mySoyer = new Soyer( config )
mySoyer.load ( err )->
    throw err if err
    return

app.get "/myroute/:id", mySoyer.routingWait(), ( req, res )->
    # do your stuff
    return

app.listen()

General info

To define a locale my best practice is a combination of language-code ISO 639 and country-code ISO 3166.
But you can define your own logic with this module.

Work in progress

soyer is work in progress. Your ideas, suggestions etc. are very welcome.

Changelog

0.3.0 Updated soyutils to version Dez. 2012

Release History

Version Date Description
v0.3.1 2013-12-04 Fixed bug to ignore hidden files ( prefixed with a . )
v0.3.0 2013-03-04 Updated soyutils to version Dez. 2012

License

(The MIT License)

Copyright (c) 2010 TCS <dev (at) tcs.de>

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.

npm loves you