@leansdk/leanrc/lib/mixins/NamespacedGatewayMixin.coffee

LeanRC is a MVC framework for creating graceful applications

# This file is part of LeanRC.
#
# LeanRC is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# LeanRC is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License
# along with LeanRC.  If not, see <https://www.gnu.org/licenses/>.

###
```coffee
Module = require 'Module'

module.exports = (App)->
  App::CrudGateway extends Module::Gateway
    @inheritProtected()
    @include Module::NamespacedGatewayMixin

    @module App

  return App::CrudGateway.initialize()
```

###

module.exports = (Module)->
  {
    PointerT
    FuncG, ListG, SubsetG, MaybeG
    EndpointInterface
    Gateway, Mixin
    Utils: { _, inflect, joi, statuses }
  } = Module::

  HTTP_NOT_FOUND    = statuses 'not found'
  HTTP_CONFLICT     = statuses 'conflict'
  UNAUTHORIZED      = statuses 'unauthorized'
  FORBIDDEN         = statuses 'forbidden'
  UPGRADE_REQUIRED  = statuses 'upgrade required'

  Module.defineMixin Mixin 'NamespacedGatewayMixin', (BaseClass = Gateway) ->
    class extends BaseClass
      @inheritProtected()

      ipoJoinedNamespacesMask = PointerT @private joinedNamespacesMask: MaybeG RegExp

      @public namespaces: FuncG([], ListG String),
        default: -> [
          'admining'
          'globaling'
          'guesting'
          'modeling'
          'personing'
          'sharing'
        ]

      @public joinedNamespacesMask: RegExp,
        get: -> @[ipoJoinedNamespacesMask] ? new RegExp "^(#{@namespaces().join '|'})_"

      @public getTrimmedEndpointName: FuncG([String, String], String),
        default: (asResourse, asAction) ->
          vsPath = "#{inflect.underscore asResourse}_#{asAction}_endpoint"
            .replace /\//g, '_'
            .replace /\_+/g, '_'
            .replace @joinedNamespacesMask, ''
          inflect.camelize vsPath

      @public getEndpoint: FuncG([String, String], SubsetG EndpointInterface),
        default: (asResourse, asAction) ->
          @getEndpointByName(@getEndpointName asResourse, asAction) ?
            @getEndpointByName(@getTrimmedEndpointName asResourse, asAction) ?
            @getStandardActionEndpoint asResourse, asAction

      @initializeMixin()