base-domain/src/lib/base-sync-repository.coffee

simple module to help build Domain-Driven Design

'use strict'

BaseRepository = require './base-repository'

###*
sync repository
@class BaseSyncRepository
@extends BaseRepository
@module base-domain
###
class BaseSyncRepository extends BaseRepository

    @isSync: true

    ###*
    returns the result of the function

    @return {any}
    @protected
    ###
    resolve: (result, fn) ->

        return fn.call(@, result)


    ###*
    get entities by ID.

    @method getByIds
    @public
    @param {Array(String|Number)} ids
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Array(Entity)} entities
    ###
    getByIds: (ids, options) ->

        (@get(id, options) for id in ids).filter (model) -> model?


    # following are all comments, for yuidoc

    ###*
    Update or insert a model instance

    @method save
    @public
    @param {Entity|Object} entity
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Entity} entity (the same instance from input, if entity given,)
    ###

    ###*
    get object by id.

    @method get
    @public
    @param {String|Number} id
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Entity} entity
    ###

    ###*
    alias for get()

    @method getById
    @public
    @param {String|Number} id
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Entity} entity
    ###

    ###*
    get diff from perpetuation layer

    @method getDiff
    @public
    @param {Entity} entity
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Object} diff
    ###

    ###*
    get all entities

    @method getAll
    @return {Array(Entity)} array of entities
    ###

    ###*
    Find all model instances that match params

    @method query
    @public
    @param {Object} [params] query parameters
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Array(Entity)} array of entities
    ###

    ###*
    Find one model instance that matches params, Same as query, but limited to one result

    @method singleQuery
    @public
    @param {Object} [params] query parameters
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Entity|} entity
    ###

    ###*
    Destroy the given entity (which must have "id" value)

    @method delete
    @public
    @param {Entity} entity
    @param {ResourceClientInterface} [client=@client]
    @return {Boolean} isDeleted
    ###

    ###*
    Update set of attributes.

    @method update
    @public
    @param {String|Number} id of the entity to update
    @param {Object} data key-value pair to update (notice: this must not be instance of Entity)
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Entity} updated entity
    ###
    ###*
    Update set of attributes and returns newly-updated props (other than `props`)

    @method updateProps
    @public
    @param {Entity} entity
    @param {Object} props key-value pair to update (notice: this must not be instance of Entity)
    @param {Object} [options]
    @param {ResourceClientInterface} [options.client=@client]
    @return {Object} updated props
    ###

module.exports = BaseSyncRepository