coffee-mix

Mixins support for CoffeeScript

npm install coffee-mix
14 downloads in the last week
28 downloads in the last month

coffee-mix

Mixins support for CoffeeScript compatible with Codo and inspired by The Little Book on CoffeeScript.

Install

npm install -s coffee-mix

Usage

Extend this class and call it's static and dynamic helpers as shown below.

{CoffeeMix} = require 'coffee-mix'


# Class mixin
Extension =
  classMethod: ->
  # Method that will be invoked
  # in class context
  extended: ->

# Instance mixin
Inclusion =
  instanceMethod: ->
  # And this one is for instances
  # prototype context
  included: ->

# Class and instance mixin
Consern =
  classProperties:
    classConsern: -> @
  instanceProperties:
    instanceConsern: -> @
  # Will be invoked in class context
  conserned: ->

# Object mixin
Integration =
  objectMethod: ->
  # Method that will be invoked
  # in instance context
  integrated: ->

# Attachable mixin
Attachment =
  # This property will be attached
  # via setter and getter
  attachmentMember: "attachment's member"
  # Will be called in mixin context
  attachmentMethod: ->
  # Will be invoked in instance context
  attached: (acceptor) ->


class Acceptor extends CoffeeMix
  # Bind property helpers to current class
  get = => @get arguments...
  set = => @set arguments...

  # Define properties
  @get property: -> @_property
  @set property: (property) -> @_property = property

  @include Inclusion, 'Inclusion options'
  @extend Extension, 'Extension options'
  @consern Consern, 'Consern options'

  constructor: (attachment, integration) ->
    @$attach attachment, 'Attachment options'
    @$integrate integration, 'Integration options'

Documentation

You can find API docs here.

License

(The MIT License)

Copyright (C) 2013 Mikhail Zyatin https://github.com/Sitin/ With contributions by several individuals: https://github.com/Sitin/coffee-mix/graphs/contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you