react-crossroads/src/components/Routes.coffee

Client side router for web applications built with React and utilizing the Flux architecture. The backing routing engine is CrossroadsJs.

React = require 'react'
RouteDefinition = require './RouteDefinition'
Redirect = require './Redirect'
merge = require 'react/lib/merge'
_ = require 'lodash'

TYPE = 'Routes'

_childrenValid = do ->
  VALID_TYPES = [
    'Route'
    'Routes'
    'DefaultRoute'
    'NotFoundRoute'
    'Redirect'
  ]

  validate = (props, propName, componentName) ->
    validChild = (child) ->
      unless child.type in VALID_TYPES
        return new Error "All children must be a proper type [Proper types: #{JSON.stringify VALID_TYPES}]"

    if _.isArray props[propName]
      return new Error 'Must provide at least one child' if props[propName].length == 0
      defaultCount = 0

      for child in props[propName]
        unless child?
          return new Error 'All child elements must be defined'

        if child.type == 'DefaultRoute'
          defaultCount += 1

        err = validChild child
        return err if err?

      return new Error 'Only one <DefaultRoute /> is allowed per <Routes /> container' if defaultCount > 1
    else
      err = validChild props[propName]
      return err if err?

  RouteDefinition.PropTypes.createChainableTypeChecker validate

_hasDefault = (children) -> _.any children, (child) -> child.type is 'DefaultRoute'

class Routes extends RouteDefinition
  type: TYPE

  constructor: (props, @children) ->
    defaultProps =
      handlerProps: {}
      exclude: false
      # TODO: Primarily here to participate in validation.... Do something better!
      children: @children

    @props = merge defaultProps, props
    @_hasDefault = _hasDefault(@children)
    @_hasPath = @props.path? || @props.name?

    super()

  propTypes:
    handler: RouteDefinition.PropTypes.componentClass
    path: React.PropTypes.string
    name: React.PropTypes.string
    handlerProps: React.PropTypes.object.isRequired
    children: _childrenValid.isRequired
    exclude: React.PropTypes.bool

  register: (parents, routePrefix, routeStore) ->
    @path = @buildPath @props, routePrefix

    @chain = [parents..., @]

    for child in @children
      child.register @chain, @path, routeStore

      if child.type == 'DefaultRoute'
        @defaultRoute = child

    shouldRegister = !@_hasDefault
    shouldRegister = shouldRegister and @_hasPath
    shouldRegister = shouldRegister and @props.handler?
    shouldRegister = shouldRegister and !@props.exclude
    # TODO: Added restriction prohibiting registration if a route has already been registered against this container's path
    # IE
    # ...
    # <Route path='/base' handler={BaseHandler} />
    # <Routes path='/base' handler={BaseHandlerParent}>
    #   ...
    # </Routes>
    # ...
    # The option currently exists to explicitly exclude the container, but there would be a console error without it

    if shouldRegister
      routeStore.register @
    else if @_hasDefault and !routeStore.hasRoute @name
      if @defaultRoute.path != @path
        @redirect = new Redirect
          fromPath: @path
          to: @defaultRoute.name

        @redirect.name = @name
        @redirect.register parents, routePrefix, routeStore
        @route = @redirect.route
      else
        routeStore.registerAlias @, @defaultRoute

  makePath: (params) ->
    if @route?
      @route.interpolate params
    else if @defaultRoute?
      @defaultRoute.makePath params
    else
      throw new Error 'This routes container was not registered, therefore there is no path to be made from it'

factory = (props, children...) -> new Routes props, _.flatten(children)
factory.type = 'Routes'

module.exports = factory