generator-bat

'use strict' ( ( factory ) -> if typeof exports is 'object' module.exports = factory( require( 'backbone' ) require( 'jquery' )<% if ( i18n ) { %> require( 'madlib-locale' )<% } %> require( 'madlib-settings' ) require( 'underscore' ) require( './views/index.coffee' ) ) else if typeof define is 'function' and define.amd define( [ 'backbone' 'jquery'<% if ( i18n ) { %> 'madlib-locale'<% } %> 'madlib-settings' 'underscore' './views/index.coffee' ], factory ) return )(( Backbone $<% if ( i18n ) { %> localeManager<% } %> settings _ Views... ) -> ###* # @author Raymond de Wit # @module App # @submodule Routers ### ###* # The app's main router. # # @class AppRouter # @extends Backbone.Router # @static ### class AppRouter extends Backbone.Router constructor: ( options = {} ) -> ## Create function handlers for routes that haven't yet got one. ## ## Created handlers will pass on to `@_openPage( ... )`: ## - Their route's matched url pattern; ## - The targeted view class of their route; ## - The url pattern's named arguments of their route; paramPattern = /[*:](\w+)/g routes = {} _( options.routes ? @routes ).each( ( handler, urlPattern ) => if ( @[ handler ] ? _.isFunction( handler ) ) ## Keep existing method. ## routes[ urlPattern ] = handler else if (( View = @viewMap[ handler ] )) ## Collect url pattern's parameter names. ## paramNames = ( matched[1] while (( matched = paramPattern.exec( urlPattern ) )) ) ## Create handler function. ## routes[ urlPattern ] = if paramNames.length () -> @_openPage( urlPattern, View, _.object( paramNames, arguments )) else () -> @_openPage( urlPattern, View ) else throw new Error( "Cannot create handler for '#{handler}'." ) return ) options.routes = routes super( options ) return ###* # Map url patterns to route handlers. # # A handler can either be: # - A function; # - The name of an existing method on the router; # - The value of one of the `require()`d view classes' `::viewName` property; # # In the latter case, a function will be created as the router is instantiated. # That function will collect parameters from the url pattern in a key-value mapping and pass these on to `@openPage()` along with the targeted view # class. # # @property routes # @type Object # @final ### routes: ## Routes that have methods: ## The value should be the name of a method on this router. ## ## - Currently, none - ## Routes that have views: ## The value should be that of the corresponding view's `viewName' property. ## '': 'index' ## A catchall route; save this one for last. ## ## Will divert unknown urls, navigating `@home()` instead. ## Alternatively, one could create a 404-not-found type of view class to handle these. ## '*catchall': 'home' ###* # Mapping of a each `require()`d View's `::viewName` property to its class. # # Each view class `require()`d is expected to have a `::viewName` class property. # Most routes in `AppRouter::routes` will map to these properties' values. # # @property viewMap # @type Object # @final ### viewMap: do () -> viewMap = {} viewMap[ View::viewName ] = View for View in Views return viewMap ###* # The url to redirect to when going `@home()`. # # @property homeUrl # @type String # @final # # @default '/' ### homeUrl: '/' ###* # Setup the router's internals. # # @method initialize # @protected ### initialize: () -> ###* # A handle on the router's main content container. # # @property $mainContent # @type jQuery # @protected # @final ### @$mainContent = settings.get( '$appRoot' ).find( '#main-content' ) ###* # A handle on the current View instance loaded into `@$mainContent` container. # # @property pageView # @type Backbone.View # @protected ### @pageView = null return ###* # Convenience method to re-render the current page. # Navigates `@home()` if no current @page exists. # # @method refresh ### refresh: () -> if ( @page ) @_openPage( @page... ) else @home() return ###* # Convenience method to navigate straight to the app's home state. # # @method home ### home: () -> @navigate( @homeUrl replace: true trigger: true ) return ###* # Convenience method to navigate a step back into history. # # @method back ### back: () -> Backbone.history.history.back() return ###* # Fork out to the default `Backbone.router`s `@navigate()`, except that a page reload is forced when navigating to the current fragment (normally a # no-op) and `options.trigger` has been given truthy value. # # @method navigate # # @param {Object} [options] # @param {Boolean} [options.trigger] ### navigate: ( fragment, options ) -> ## Force a reload when navigating to current fragment with a forced trigger. ## if ( options?.trigger and fragment is Backbone.history.fragment ) console.log( '[ROUTER] forcing current fragment reload.' ) Backbone.history.loadUrl( Backbone.history.fragment ) else super( arguments... ) return ###* # Set up shop, instantiate things like navigation views and such, start the `Backbone.history` global router. # # @method startApp # # @param {Object} [options] Any options you may want to pass on to `Backbone.history.start( options )`. ### startApp: ( options ) -> console.log( '[ROUTER] Starting application...' ) ## ## Additional setting up can be done here; instantiate views that aren't to be part of the main container, like navigation perhaps. ## ## Start the `Backbone.history` global router which will begin monitoring for url changes, causing all matching route handlers to be ## dispatched. ## Backbone.history.start( options ) return ###* # Set the browsers url equal to the current fragment with the supplied parameters replaced. # # Works by reconstructing the url from the route path for the supplied parameters combined with the ones # saved, and then @navigate()ing to it. # # @method youAreHere # @param {Object} paramsNew The parameters you want changed. # @param {Object} [options] Options passed on to @navigate(). ### youAreHere: ( paramsNew, options ) -> return unless @page? [ path, View, params ] = @page ## Update the current fragments parameters, ## And get a local handle on it. ## _( params ).extend( paramsNew ) ## Recreate a fragment url from the current fragment's route path pattern and the parameters ## fragment = path.replace( /// # (?: # Group but don't capture $ # A mandatory opening bracket, and: ( [^:\($]* ) # Optional text (zero or more characters that cannot be ':' '(' or ')' ); capture this text as 'before'. )? # When the parameter is NOT optional, the preceding group won't be there, so make the group optional. # [:*] # A colon (':') or asterisk ('*') indicates a parameter, followed by: ( \w+ ) # Its identifier (one or more alfanumeric characters); capture this identifier as 'key'. # (?: # Group but don't capture # Again, when a parameter is optional, it may be followed by: ( [^:]* ) # Text (zero or more characters that cannot be ':' '(' or ')' ); capture this text as 'after'. \) # A closing bracket is a must. )? # Unless the parameter was NOT optional of course, in which case the preceding group won't be there. # ///g # Repeat ( match, before, key, after ) -> ## Since the 'before' and 'after' are both optional in the regex, it must still be established ## that they either BOTH matched or opted-out. ## If only one matched, there's likely something wrong with the path pattern, and we will simply ## not touch what we've matched. param = params[ key ] return if before? unless after? then match else ( if param? then "#{ before }#{ encodeURIComponent( param ) }#{ after }" else '' ) else if after? then match else ( if param? then encodeURIComponent( param ) else '' ) ) @navigate( fragment, options ) return ###* # Load the `@$mainContent` container with an instance of the requested view class. # Either by simply re-rendering (with possibly changed parameters) the current instance if it is of the same class, or by creating a new instance to # replace the current one if they differ. # # @method _openPage # @protected # # @param {String} urlPattern The route's matched url pattern. # @param {Class} View The targeted view class of the matched route. # @param {Object} params A key-value mapping of the matched route's url pattern's parameters. # @param {String} [fragment] The current history entry's full url fragment. Used only on retries. ### _openPage: ( urlPattern, View, params, fragment ) -> ## Save for possible retries. ## @page = [ urlPattern, View, params, fragment or Backbone.history.fragment ] divert = undefined ## ## Here be code to determine possible diversions from the targeted View if needed. ## ## ... Set `divert` to another view class's `::viewName`. ## ## ---- if ( divert? ) ## Diverted-to views should be accessible by anyone. When that condition no longer holds, for *every* such view, consider turning _openPage() ## into a recursive function, so that the new view's accessibility requirements can be verified too. View = @viewMap[ divert ] params = undefined ## If `fragment` is set, this was effectively a retry after a diversion, and so the current url may need updating. ## @navigate( fragment, replace: true ) if ( fragment and fragment isnt Backbone.history.fragment ) if ( @pageView instanceof View ) ## The requested View has already been loaded; just re-`render()` the current instance. console.log( "[ROUTER] Updating page '#{@pageView.viewName}'.", params ) @pageView.render( params ) else console.log( "[ROUTER] Opening page '#{View::viewName}'.", params ) ## Cleanup previously active view if any. ## @pageView?.remove() ## Render and load the new view. ## @pageView = new View( _.extend( router: @ , params ) ) @$mainContent.append( @pageView.render( params ).$el ) ###* # Signal loading of the `@$mainContent` container with a view. # # @event open # # @param {Backbone.View} view The view instance currently loaded. # @param {Object} params A key-value mapping of the matched route's url pattern's parameters. ### @trigger( 'open', @pageView, params ) return<% if ( i18n ) { %> localeSwitch: ( locale ) -> localeManager.setLocale( locale ).then( () => settings.get( '$appRoot' ).attr( 'lang', locale ) settings.set( 'locale', locale ) @refresh() return () -> console.log( '[ROUTER] Failed to switch locale, do nothing...' ) return ) return<% } %> ## Export singleton. ## return new AppRouter() )