luca 0.9.6 → 0.9.7

data/src/concerns.coffee

@@ -0,0 +1,70 @@
+Luca.concern = (mixinName)->
+  namespace = _( Luca.concern.namespaces ).detect (space)->
+    Luca.util.resolve(space)?[ mixinName ]?
+
+  namespace ||= "Luca.concerns"
+
+  resolved = Luca.util.resolve(namespace)[ mixinName ]
+
+  console.log "Could not find #{ mixinName } in ", Luca.concern.namespaces unless resolved?
+
+  resolved
+
+Luca.concern.namespaces = [
+  "Luca.concerns"
+]
+
+Luca.concern.namespace = (namespace)->
+  Luca.concern.namespaces.push(namespace)
+  Luca.concern.namespaces = _( Luca.concern.namespaces ).uniq()
+  
+Luca.concern.setup = ()->
+  if @concerns?.length > 0
+    for module in @concerns 
+      Luca.concern(module)?.__initializer?.call(@, @, module)  
+
+# Luca.decorate('Luca.View').with('Luca.concerns.MyCustomMixin')
+Luca.decorate = (target)->
+  try
+    if _.isString(target)
+      componentName = target
+      componentClass = Luca.util.resolve(componentName)
+
+    componentClass      = target if _.isFunction(target) 
+    componentPrototype  = componentClass.prototype 
+    componentName       = componentName || componentClass.displayName
+    componentName       ||= componentPrototype.displayName
+  catch e    
+    console.log e.message
+    console.log e.stack
+    console.log "Error calling Luca.decorate on ", componentClass, componentPrototype, componentName
+
+    throw(e)
+
+  return with: (mixinName)->
+    mixinDefinition = Luca.concern(mixinName)
+    mixinDefinition.__displayName ||= mixinName
+
+    mixinPrivates   = _( mixinDefinition ).chain().keys().select (key)-> 
+      "#{ key }".match(/^__/) or key is "classMethods"
+
+    sanitized   = _( mixinDefinition ).omit( mixinPrivates.value() )
+
+    _.extend(componentPrototype, sanitized)
+
+    if mixinDefinition.classMethods?
+      for method, fn of mixinDefinition.classMethods
+        componentClass[ method ] = _.bind(fn, componentClass)
+
+    # When a mixin is included, we may want to do things 
+    mixinDefinition?.__included?(componentName, componentClass, mixinDefinition)
+
+    superclassMixins = componentPrototype._superClass()::concerns
+
+    componentPrototype.concerns ||= []
+    componentPrototype.concerns.push( mixinName )
+    componentPrototype.concerns = componentPrototype.concerns.concat( superclassMixins )
+
+    componentPrototype.concerns = _( componentPrototype.concerns ).chain().uniq().compact().value()
+
+    componentPrototype

data/src/containers/tab_view.coffee

@@ -1,23 +1,20 @@
 _.def('Luca.containers.TabView').extends('Luca.containers.CardView').with
 
-  hooks:[
-    "before:select"
-    "after:select"
-  ]
-
-  componentType: 'tab_view'
-
-  className: 'luca-ui-tab-view tabbable'
+tabView = Luca.register       "Luca.containers.TabView"
+tabView.triggers              "before:select",
+                              "after:select"
 
+tabView.publicConfiguration
   tab_position: 'top'
-
   tabVerticalOffset: '50px'
 
+tabView.privateConfiguration
+  additionalClassNames: 'tabbable'
   navClass: "nav-tabs"
-
   bodyTemplate: "containers/tab_view"
   bodyEl: "div.tab-content"
 
+tabView.defines
   initialize: (@options={})->
     @navClass = "nav-list"if @navStyle is "list"
 

data/src/core/collection.coffee

@@ -91,6 +91,8 @@ collection.defines
     if models
       @reset models, silent: true, parse: options?.parse
 
+    Luca.concern.setup.call(@)
+
     @trigger "after:initialize"
 
   # Luca.Collections will append a query string to the URL
@@ -211,7 +213,7 @@ collection.defines
     # fetch will try to pull from the bootstrap if it is setup to do so
     # you can actually make the roundtrip to the server anyway if you pass
     # refresh = true in the options hash
-    return @bootstrap() if @cached_models().length and not options.refresh
+    return @bootstrap() if @cached_models().length and not (options.refresh is true or options.remote is true)
 
     url = if _.isFunction(@url) then @url() else @url
 
@@ -350,6 +352,20 @@ _.extend Luca.Collection.prototype,
 
     Backbone.View.prototype.trigger.apply @, arguments
 
+Luca.Collection._originalExtend = Backbone.Collection.extend
+
+Luca.Collection.extend = (definition={})->
+  # for backward compatibility
+  definition.concerns ||= definition.concerns if definition.concerns?
+
+  componentClass = Luca.Collection._originalExtend.call(@, definition)
+
+  if definition.concerns? and _.isArray( definition.concerns )
+    for module in definition.concerns
+      Luca.decorate( componentClass ).with( module )
+
+  componentClass
+
 # Always include these parameters in every request to your REST API.
 #
 # either specify a function which returns a hash, or just a normal hash

data/src/core/container.coffee

@@ -9,7 +9,7 @@ container.triggers                "before:components",
                                   "after:layout",
                                   "first:activation"
 
-container.defines                                  
+container.defines
   className: 'luca-ui-container'
 
   componentTag: 'div'
@@ -25,7 +25,7 @@ container.defines
   # @componentEvents provides declarative syntax for responding to events on
   # the components in this container.  the format of the syntax is very similar
   # to the other event binding helpers:
-  # 
+  #
   #   component_accessor component:trigger
   #
   # where component_accessor is either the name of the role, or a method on the container
@@ -115,6 +115,8 @@ container.defines
       applyDOMConfig.call(container, component, index)
 
   prepareComponents: ()->
+    container = @
+
     # accept components as an array of strings representing
     # the luca component type
     for component in @components when _.isString(component)
@@ -130,6 +132,26 @@ container.defines
         panel = @make(@componentTag, componentContainerElement, '')
         @$append( panel )
 
+      # if the container defines a @defaults property
+      # then we should make sure our child components inherit
+      # these values unless specifically defined
+      if container.defaults?
+        component = _.defaults(component, (container.defaults || {}))
+
+      # if the container defines an @extensions property as an array of
+      # configuration objects, then we will extend the component config with
+      # the object in the matching position of the @extensions array.
+      if _.isArray(container.extensions) and _.isObject(container.extensions?[ index ])
+        componentExtension = container.extensions[index]
+        component = _.extend(component, componentExtension)
+
+      # if the container defines an @extensions property as an object of nested hashes,
+      # then extensions is a key/value pair whose key represents the role of the component
+      # that we wish to extend / customize 
+      if component.role? and _.isObject(container.extensions) and _.isObject(container.extensions[component.role])
+        componentExtension = container.extensions[component.role]
+        component = _.extend(component, componentExtension)
+        
       unless component.container?
         component.container = "##{ componentContainerElement.id }" if @generateComponentElements
         component.container ||= @$bodyEl()
@@ -157,30 +179,31 @@ container.defines
       # adding the views @$el to the appropriate @container.
 
       # you can also just pass a string representing the component_type
-      component = if Luca.isBackboneView( object )
+      component = if Luca.isComponent( object )
         object
       else
         object.type ||= object.ctype
 
         if !object.type?
+          # TODO
+          # Add support for all of the various components property aliases
           if object.components?
             object.type = object.ctype = 'container'
           else
             object.type = object.ctype = Luca.defaultComponentType
 
-        # if the container defines a @defaults property
-        # then we should make sure our child components inherit
-        # these values unless specifically defined
-        object = _.defaults(object, (container.defaults || {}))
-
         created = Luca.util.lazyComponent( object )
 
       # if we're using base backbone views, then they don't extend themselves
       # with their passed options, so this is a workaround to get them to
       # pick up the container config property
-      if !component.container and component.options.container
+      if !component.container and component.options?.container
         component.container = component.options.container
 
+      if not component.container?
+        console.log component,index,@
+        console.error "could not assign container property to component on container #{ @name || @cid }"
+
       indexComponent( component ).at(index).in( @componentIndex )
 
       component
@@ -194,14 +217,14 @@ container.defines
   renderComponents: (@debugMode="")->
     @debug "container render components"
 
-    container = @ 
+    container = @
     _(@components).each (component)->
-      component.getParent = ()-> 
-        container 
+      component.getParent = ()->
+        container
 
       try
-        $( component.container ).append( component.el )
-        component.render() 
+        @$( component.container ).eq(0).append( component.el )
+        component.render()
       catch e
         console.log "Error Rendering Component #{ component.name || component.cid }", component
 
@@ -232,7 +255,7 @@ container.defines
   #### Underscore Methods For Working with Components
   _: ()-> _( @components )
 
-  pluck: (attribute)-> 
+  pluck: (attribute)->
     @_().pluck(attribute)
 
   invoke: (method)->
@@ -243,17 +266,17 @@ container.defines
 
   detect: (fn)->
     @_().detect(attribute)
-  
+
   reject: (fn)->
     @_().reject(fn)
 
   map: (fn)->
     @_().map(fn)
 
-  registerComponentEvents: ()->
+  registerComponentEvents: (eventList)->
     container = @
 
-    for listener, handler of (@componentEvents||{})
+    for listener, handler of (eventList || @componentEvents||{})
       [componentNameOrRole,eventId] = listener.split(' ')
 
       unless _.isFunction( @[handler] )
@@ -262,7 +285,7 @@ container.defines
 
       if componentNameOrRole is "*"
         @eachComponent (component)=> component.on(eventId, @[handler], container)
-      else 
+      else
         component = @findComponentForEventBinding( componentNameOrRole )
 
         unless component? and Luca.isComponent(component)
@@ -273,18 +296,18 @@ container.defines
 
 
   subContainers: ()->
-    @select (component)-> 
+    @select (component)->
       component.isContainer is true
 
   roles: ()->
     _( @allChildren() ).pluck('role')
-     
+
   allChildren: ()->
     children = @components
     grandchildren = _( @subContainers() ).invoke('allChildren')
-    @_allChildren ||= _([children,grandchildren]).chain().compact().flatten().uniq().value()
+    _([children,grandchildren]).chain().compact().flatten().value()
 
-  findComponentForEventBinding: (nameRoleOrGetter, deep=false)->
+  findComponentForEventBinding: (nameRoleOrGetter, deep=true)->
     @findComponentByName(nameRoleOrGetter, deep) || @findComponentByGetter( nameRoleOrGetter, deep ) || @findComponentByRole( nameRoleOrGetter, deep )
 
   findComponentByGetter: (getter, deep=false)->
@@ -293,7 +316,7 @@ container.defines
 
   findComponentByRole: (role,deep=false)->
     _( @allChildren() ).detect (component)->
-      component.role is role
+      component.role is role or component.type is role or component.ctype is role
 
   findComponentByName: (name, deep=false)->
     _( @allChildren() ).detect (component)->
@@ -311,7 +334,7 @@ container.defines
     return component if component
 
     if deep is true
-      sub_container = _( @components ).detect (component)-> 
+      sub_container = _( @components ).detect (component)->
         component?.findComponent?(needle, haystack, true)
 
       sub_container?.findComponent?(needle, haystack, true)
@@ -346,7 +369,7 @@ container.defines
 
   getRootComponent: ()->
     if @isRootComponent() then @ else @getParent().getRootComponent()
-    
+
 
   selectByAttribute: (attribute, value=undefined, deep=false)->
     components = _( @components ).map (component)->
@@ -365,7 +388,7 @@ container.defines
 
 # This is the method by which a container injects the rendered child views
 # into the DOM.  It will get passed the container object, and the component
-# that is being rendered.  
+# that is being rendered.
 Luca.core.Container.componentRenderer = (container, component)->
   attachMethod = $( component.container )[ component.attachWith || "append" ]
   attachMethod( component.render().el )
@@ -406,7 +429,6 @@ createGetterMethods = ()->
 
   _( childrenWithGetter ).each (component)->
     container[ component.getter ] ||= ()->
-      console.log "getter is being deprecated in favor of role" 
       console.log component.getter, component, container
       component
 
@@ -428,8 +450,11 @@ doComponents = ()->
   @trigger "before:render:components", @, @components
   @renderComponents()
   @trigger "after:components", @, @components
-  createGetterMethods.call(@)
-  createMethodsToGetComponentsByRole.call(@)  
+
+  unless @skipGetterMethods is true
+    createGetterMethods.call(@)
+    createMethodsToGetComponentsByRole.call(@)
+
   @registerComponentEvents()
 
 validateContainerConfiguration = ()->
@@ -447,4 +472,4 @@ indexComponent = (component)->
       if component.role?
         map.role_index[ component.role ] = index
       if component.name?
-        map.name_index[ component.name ] = index      
+        map.name_index[ component.name ] = index

data/src/core/field.coffee

@@ -1,26 +1,51 @@
-_.def('Luca.core.Field').extends('Luca.View').with
+field = Luca.register         "Luca.core.Field"
 
-  className: 'luca-ui-text-field luca-ui-field'
-
-  isField: true
+field.extends                 "Luca.View"
 
-  template: 'fields/text_field'
+field.triggers                "before:validation",
+                              "after:validation",
+                              "on:change"
 
+field.publicConfiguration   
   labelAlign: 'top'
-
-  hooks:[
-    "before:validation",
-    "after:validation",
-    "on:change"
-  ]
-
-  # see: http://twitter.github.com/bootstrap/base-css.html
+  className: 'luca-ui-text-field luca-ui-field'
   statuses: [
     "warning"
     "error"
     "success"
   ]
 
+field.publicInterface
+  disable: ()->
+    @getInputElement().attr('disabled', true)
+
+  enable: ()->
+    @getInputElement().attr('disabled', false)
+
+  getValue: ()->
+    raw = @getInputElement()?.attr('value')
+
+    return raw if _.str.isBlank( raw )
+
+    switch @valueType
+      when "integer" then parseInt(raw)
+      when "string" then "#{ raw }"
+      when "float" then parseFloat(raw)
+      else raw
+
+  setValue: (value)->
+    @getInputElement()?.attr('value', value)
+
+  updateState: (state)->
+    _( @statuses ).each (cls)=>
+      @$el.removeClass(cls)
+      @$el.addClass(state)
+
+field.privateConfiguration
+  isField: true
+  template: 'fields/text_field'
+
+field.defines
   initialize: (@options={})->
     _.extend @, @options
 
@@ -29,6 +54,7 @@ _.def('Luca.core.Field').extends('Luca.View').with
     @input_class ||= ""
     @input_type ||= ""
     @helperText ||= ""
+    @label = @name if not @label? or @label.length is 0
     @label ||= "*#{ @label }" if @required and not @label?.match(/^\*/)
     @inputStyles ||= ""
     @input_value ||= @value || ""
@@ -53,30 +79,5 @@ _.def('Luca.core.Field').extends('Luca.View').with
   change_handler: (e)->
     @trigger "on:change", @, e
 
-  disable: ()->
-    @getInputElement().attr('disabled', true)
-
-  enable: ()->
-    @getInputElement().attr('disabled', false)
-
-  getValue: ()->
-    raw = @getInputElement()?.attr('value')
-
-    return raw if _.str.isBlank( raw )
-
-    switch @valueType
-      when "integer" then parseInt(raw)
-      when "string" then "#{ raw }"
-      when "float" then parseFloat(raw)
-      else raw
-
-  setValue: (value)->
-    @getInputElement()?.attr('value', value)
-
   getInputElement: ()->
     @input ||= @$('input').eq(0)
-
-  updateState: (state)->
-    _( @statuses ).each (cls)=>
-      @$el.removeClass(cls)
-      @$el.addClass(state)

data/src/core/meta_data.coffee

@@ -0,0 +1,37 @@
+Luca.registry.componentMetaData = {}
+
+Luca.registry.getMetaDataFor = (componentName)->
+  new MetaDataProxy(Luca.registry.componentMetaData[ componentName ])
+
+Luca.registry.addMetaData = (componentName, key, value)->
+  data = Luca.registry.componentMetaData[ componentName ] ||= {}
+  data[ key ] = _(value).clone()
+  data
+
+
+class MetaDataProxy
+  constructor: (@meta={})->
+    @
+
+  superClass: ()->
+    Luca.util.resolve(@meta["super class name"])
+
+  componentDefinition: ()->
+    Luca.util.resolve(@meta["display name"])
+
+  styleHierarchy: ()->
+    list = _( @classHierarchy() ).map (cls)->
+      Luca.util.toCssClass(cls, 'views', 'components', 'core','fields','containers')
+
+    _( list ).without('backbone-view','luca-view')
+      
+  classHierarchy: ()->
+    list = [ @meta["display name"], @meta["super class name"]]
+
+    proxy = @superClass()?.prototype?.componentMetaData?()
+
+    until not proxy
+      list = list.concat( proxy?.classHierarchy() )
+      proxy = proxy.superClass()?.prototype?.componentMetaData?()
+
+    _( list ).uniq()

data/src/core/model.coffee

@@ -8,12 +8,13 @@ model.defines
   initialize: ()->
     Backbone.Model::initialize(@, arguments)
     setupComputedProperties.call(@)
+    Luca.concern.setup.call(@)
 
   read: (attr)->
     if _.isFunction(@[attr])
       @[attr].call(@)
     else
-      @get(attr)
+      @get(attr) || @[attr]
 
   get: (attr)->
     if @computed?.hasOwnProperty(attr)
@@ -37,3 +38,19 @@ setupComputedProperties = ()->
         @trigger "change:#{attr}"
         
       @trigger "change:#{attr}" if @has(dep) 
+
+
+Luca.Model._originalExtend = Backbone.Model.extend
+
+Luca.Model.extend = (definition={})->
+  # for backward compatibility
+  definition.concerns ||= definition.concerns if definition.concerns?
+
+  componentClass = Luca.Model._originalExtend.call(@, definition)
+  
+  if definition.concerns? and _.isArray( definition.concerns )
+    for module in definition.concerns
+      Luca.decorate( componentClass ).with( module )
+
+  componentClass
+

data/src/core/view.coffee

@@ -4,9 +4,9 @@ view.extends            "Backbone.View"
 
 # includes are extensions to the prototype, and have no special behavior
 view.includes           "Luca.Events",
-                        "Luca.modules.DomHelpers"
+                        "Luca.concerns.DomHelpers"
 
-# mixins are includes with special property / method conventions
+# concerns are includes with special property / method conventions
 # which customize the components through the use of __initializer and
 # __included method names.  These will be called every time an instance
 # is created, and the first time the mixin is used to enhance a component.
@@ -48,12 +48,10 @@ view.defines
 
     @setupHooks _( Luca.View::hooks.concat( @hooks ) ).uniq()
 
-    if @mixins?.length > 0
-      for module in @mixins 
-        Luca.mixin(module)?.__initializer?.call(@, @, module)
+    Luca.concern.setup.call(@)
 
     @delegateEvents()
-
+        
     @trigger "after:initialize", @
 
   #### Hooks or Auto Event Binding
@@ -69,18 +67,7 @@ view.defines
   # after:render      : afterRender()
   # after:initialize  : afterInitialize()
   # first:activation  : firstActivation()
-  setupHooks: (set)->
-    set ||= @hooks
-
-    _(set).each (eventId)=>
-      fn = Luca.util.hook( eventId )
-
-      callback = ()->
-        @[fn]?.apply @, arguments
-
-      callback = _.once(callback) if eventId?.match(/once:/)
-
-      @on eventId, callback, @
+  setupHooks: Luca.util.setupHooks
 
   registerEvent: (selector, handler)->
     @events ||= {}
@@ -90,13 +77,18 @@ view.defines
   definitionClass: ()->
     Luca.util.resolve(@displayName, window)?.prototype
 
-  collections: ()-> Luca.util.selectProperties( Luca.isBackboneCollection, @ )
-  models: ()-> Luca.util.selectProperties( Luca.isBackboneModel, @ )
-  views: ()-> Luca.util.selectProperties( Luca.isBackboneView, @ )
+  collections: ()-> 
+    Luca.util.selectProperties( Luca.isBackboneCollection, @ )
 
-  debug: ()->
+  models: ()-> 
+    Luca.util.selectProperties( Luca.isBackboneModel, @ )
+
+  views: ()-> 
+    Luca.util.selectProperties( Luca.isBackboneView, @ )
+
+  debug: (args...)->
     return unless @debugMode or window.LucaDebugMode?
-    console.log [(@name || @cid),message] for message in arguments
+    console.log [(@name || @cid), args...] 
 
   trigger: ()->
     if Luca.enableGlobalObserver
@@ -163,14 +155,18 @@ bindEventHandlers = (events={})->
     if _.isString(handler)
       _.bindAll @, handler
 
-Luca.View.extend = (definition)->
+Luca.View.deferrableEvent = "reset"
+
+Luca.View.extend = (definition={})->
   definition = Luca.View.renderWrapper( definition )
+  # for backward compatibility
+  definition.concerns ||= definition.concerns if definition.concerns?
 
-  if definition.mixins? and _.isArray( definition.mixins )
-    for module in definition.mixins
-      Luca.decorate( definition ).with( module )
+  componentClass = Luca.View._originalExtend.call(@, definition)
 
-  Luca.View._originalExtend.call(@, definition)
+  if definition.concerns? and _.isArray( definition.concerns )
+    for module in definition.concerns
+      Luca.decorate( componentClass ).with( module )
 
+  componentClass
 
-Luca.View.deferrableEvent = "reset"