base-domain
Version:
simple module to help build Domain-Driven Design
416 lines (327 loc) • 12.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>src/lib/facade.coffee</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="icon" href="../assets/favicon.ico">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="" width="117" height="52"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: </em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Base.html">Base</a></li>
<li><a href="../classes/BaseDict.html">BaseDict</a></li>
<li><a href="../classes/BaseFactory.html">BaseFactory</a></li>
<li><a href="../classes/BaseList.html">BaseList</a></li>
<li><a href="../classes/BaseModel.html">BaseModel</a></li>
<li><a href="../classes/BaseRepository.html">BaseRepository</a></li>
<li><a href="../classes/DictFactory.html">DictFactory</a></li>
<li><a href="../classes/DomainError.html">DomainError</a></li>
<li><a href="../classes/Entity.html">Entity</a></li>
<li><a href="../classes/Facade.html">Facade</a></li>
<li><a href="../classes/Fixture.html">Fixture</a></li>
<li><a href="../classes/FixtureModel.html">FixtureModel</a></li>
<li><a href="../classes/Includer.html">Includer</a></li>
<li><a href="../classes/ListFactory.html">ListFactory</a></li>
<li><a href="../classes/MasterRepository.html">MasterRepository</a></li>
<li><a href="../classes/PropInfo.html">PropInfo</a></li>
<li><a href="../classes/ResourceClientInterface.html">ResourceClientInterface</a></li>
<li><a href="../classes/TypeInfo.html">TypeInfo</a></li>
<li><a href="../classes/Util.html">Util</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/base-domain.html">base-domain</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1 class="file-heading">File: src/lib/facade.coffee</h1>
<div class="file">
<pre class="code prettyprint linenums">
require('es6-promise').polyfill()
copy = require('copy-class').copy
{ camelize, requireFile } = require './util'
getProto = Object.getPrototypeOf ? (obj) -> obj.__proto__
###*
Facade class of DDD pattern.
- create instance of factories
- create instance of repositories
@class Facade
@module base-domain
###
class Facade
###*
create instance of Facade
@method createInstance
@static
@param {Object} [options]
@return {Facade}
###
@createInstance: (options= {}) ->
Constructor = @
return new Constructor(options)
###*
constructor
@constructor
@param {String} [options]
@param {String} [options.dirname="."] path where domain definition files are included
###
constructor: (options) ->
@classes = {}
@dirname = options.dirname ? '.'
@init()
# for base-domainify. keep it empty
init: ->
###*
load master tables
@method loadMasterTables
@return {Promise}
###
loadMasterTables: (modelNames...) ->
Promise.all (@getRepository(modelName).load?() for modelName in modelNames)
###*
get a model class
@method getModel
@param {String} name
@return {Class}
###
getModel: (name) ->
return @require(name)
###*
get a factory class
ISSUE: user will never know load failure
@method getFactory
@param {String} name
@param {Boolean} [useAnonymousWhenFailed=false]
@return {Function}
###
getFactory: (name, useAnonymousWhenFailed = off) ->
try
return @require("#{name}-factory")
catch e
throw e if not useAnonymousWhenFailed
AnonymousFactory = Facade.BaseFactory.getAnonymousClass(name)
@addClass("#{name}-factory", AnonymousFactory, true)
###*
get a repository class
@method getRepository
@param {String} name
@return {Class}
###
getRepository: (name) ->
return @require("#{name}-repository")
###*
create a factory instance
@method createFactory
@param {String} name
@param {Boolean} [useAnonymousWhenFailed=false]
@return {BaseFactory}
###
createFactory: (name, useAnonymousWhenFailed = off) ->
FactoryClass = @getFactory(name, useAnonymousWhenFailed)
return new FactoryClass()
###*
create a repository instance
@method createRepository
@param {String} name
@param {Object} [options]
@return {BaseRepository}
###
createRepository: (name, options) ->
@create("#{name}-repository", options)
###*
read a file and returns class
@method require
@private
@param {String} name
@return {Function}
###
require: (name) ->
return @classes[name] if @classes[name]?
file = "#{@dirname}/#{name}"
klass = requireFile file
@addClass name, klass
###*
check existence of the class of the given name
@method hasClass
@param {String} name
@return {Function}
###
hasClass: (name) ->
try
@require(name)
return true
catch e
return false
###*
add copied class to facade.
the class is acquired by @require(name)
attaches getFacade() method (for both class and instance)
@method addClass
@private
@param {String} name
@param {Function} klass
@param {Boolean} skipNameValidation validate class name is compatible with the name to register
@return {Function}
###
addClass: (name, klass, skipNameValidation = false) ->
if skipNameValidation
camelCasedName = camelize name
else
if klass.getName() isnt name
throw @error """given class should be named '#{klass.getName()}',
but '#{name}' given."""
camelCasedName = klass.name
ParentClass = getProto(klass::).constructor
if @constructor.isBaseClass ParentClass
Class = copy(klass, camelCasedName)
else
CopiedParentClass = @require ParentClass.getName()
Class = copy(klass, camelCasedName, CopiedParentClass)
facade = @
Class.getFacade = -> facade
Class::getFacade = -> facade
@classes[name] = Class
###*
read a file and returns the instance of the file's class
@method create
@private
@param {String} name
@param {Object} [options]
@return {BaseFactory}
###
create: (name, options) ->
DomainClass = @require(name)
return new DomainClass(options)
###*
create instance of DomainError
@method error
@param {String} reason reason of the error
@param {String} [message]
@return {Error}
###
error: (reason, message) ->
DomainError = @constructor.DomainError
return new DomainError(reason, message)
###*
check if given object is instance of DomainError
@method isDomainError
@param {Error} e
@return {Boolean}
###
isDomainError: (e) ->
DomainError = @constructor.DomainError
return e instanceof DomainError
###*
insert fixture data
(Node.js only)
@method insertFixtures
@param {Object} [options]
@param {String} [options.dataDir='./data'] directory to have fixture data files
@param {String} [options.tsvDir='./tsv'] directory to have TSV files
@param {Array(String)} [options.models=null] model names to insert. default: all models
@return {Promise(Object)} dataPool inserted data
###
insertFixtures: (options = {}) ->
Fixture = require './fixture'
fixture = new Fixture(@, options)
fixture.insert(options.models).then ->
return fixture.dataPool
###*
check the given class is registered in facade
@method isBaseClass
@static
@param {Function} klass
@return {Boolean}
###
@isBaseClass: (klass) ->
(klass is @[klass.name]) or
(klass is @DomainError) or
(@[klass.name]?.toString() is klass.toString())
###*
registers the given class as a base class
@method registerBaseClass
@static
@param {Function} klass
###
@registerBaseClass: (klass) -> @[klass.name] = klass
@Base : require './base'
@BaseModel : require './base-model'
@Entity : require './entity'
@BaseList : require './base-list'
@BaseDict : require './base-dict'
@BaseFactory : require './base-factory'
@ListFactory : require './list-factory'
@DictFactory : require './dict-factory'
@BaseRepository : require './base-repository'
@MasterRepository : require './master-repository'
@DomainError : require './domain-error'
module.exports = Facade
</pre>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>