luca 0.9.7 → 0.9.8

data/{src/tools → app/assets/javascripts/luca/development}/console.coffee

@@ -1,6 +1,6 @@
 developmentConsole = Luca.register    "Luca.tools.DevelopmentConsole"
 
-developmentConsole.extends            "Luca.core.Container"
+developmentConsole.extends            "Luca.Container"
 
 developmentConsole.defines
   className: "luca-ui-console"
@@ -188,11 +188,12 @@ Luca.util.launchers.developmentConsole = (name="luca-development-console")->
   @_lucaDevConsole = Luca name, ()=>
     @$el.append Backbone.View::make("div", id: "#{ name }-wrapper", class: "modal fade large")
 
-    console = new Luca.tools.DevelopmentConsole
+    dconsole = new Luca.tools.DevelopmentConsole
       name: name
       container: "##{ name }-wrapper"
 
-    console.render()
-    console.getCodeMirror().setHeight(602)
+    dconsole.render()
+    dconsole.getCodeMirror().setHeight(602)
 
-  @_lucaDevConsole.show()
+  @_lucaDevConsole.show()
+  Luca(name)

data/app/assets/javascripts/luca/development/index.coffee

@@ -0,0 +1,2 @@
+#= require ./code_mirror_field
+#= require ./console

data/{src → app/assets/javascripts/luca}/framework.coffee

@@ -1,25 +1,30 @@
-# the Luca() browser utility function is meant to be a smart wrapper around various
-# types of input which will return what the developer would expect given the
-# context it is used.
-(window || global).Luca = (payload, args...)->
+lucaUtilityHelper = (payload, args...)->
+  if arguments.length is 0 
+    return _( Luca.Application.instances ).values()?[0]
+
   if _.isString(payload) and result = Luca.cache(payload)
     return result
 
   if _.isString(payload) and result = Luca.find(payload)
     return result
 
+  if _.isString(payload) and result = Luca.registry.find(payload)
+    return result
+
+  if payload instanceof jQuery and result = Luca.find(payload)
+    return result
+
   if _.isObject(payload) and payload.ctype?
     return Luca.util.lazyComponent( payload )
 
-  if _.isObject(payload) and payload.defines and payload.extends
-    definition = payload.defines
-    inheritsFrom = payload.extends
-
   if _.isFunction( fallback = _(args).last() )
     return fallback()
 
+(window || global).Luca = ()-> lucaUtilityHelper.apply(@, arguments)
+
+Luca.VERSION = '0.9.8'
+
 _.extend Luca,
-  VERSION: "0.9.7"
   core: {}
   collections: {}
   containers: {}
@@ -31,49 +36,70 @@ _.extend Luca,
   registry:{}
   options: {}
   config: {}
+  logger: (trackerMessage)->
+    (args...)->
+      args.unshift( trackerMessage )
+      console.log(@, args)
+
+  getHelper: ()->
+    ()-> lucaUtilityHelper.apply(@, arguments)
 
 # for triggering / binding to component definitions
 _.extend Luca, Backbone.Events
 
-Luca.config.maintainStyleHierarchy = true
-Luca.config.maintainClassHierarchy = true
-Luca.config.autoApplyClassHierarchyAsCssClasses = true
-
-# When using Luca.define() should we automatically register
-# the component with the registry?
-Luca.autoRegister = Luca.config.autoRegister = true
-
-# if developmentMode is true, you have access to some neat development tools
-Luca.developmentMode = Luca.config.developmentMode = false
-
-# The Global Observer is very helpful in development
-# it observes every event triggered on every view, collection, model
-# and allows you to inspect / respond to them.  Use in production
-# may have performance impacts which has not been tested
-Luca.enableGlobalObserver = Luca.config.enableGlobalObserver = false
-
-# let's use the Twitter 2.0 Bootstrap Framework
-# for what it is best at, and not try to solve this
-# problem on our own!
-Luca.enableBootstrap = Luca.config.enableBootstrap = true
-
-Luca.config.enhancedViewProperties = true
-
-Luca.keys =
-  ENTER: 13
-  ESCAPE: 27
-  KEYLEFT: 37
-  KEYUP: 38
-  KEYRIGHT: 39
-  KEYDOWN: 40
-  SPACEBAR: 32
-  FORWARDSLASH: 191
-
-# build a reverse map
-Luca.keyMap = _( Luca.keys ).inject (memo, value, symbol)->
-  memo[value] = symbol.toLowerCase()
-  memo
-, {}
+Luca.setupCollectionSpace = (options={})->
+  {baseParams, modelBootstrap} = options
+
+  if baseParams? 
+    Luca.Collection.baseParams( baseParams )
+  else
+    Luca.warn('You should remember to set the base params for Luca.Collection class.  You can do this by defining a property or function on Luca.config.baseParams')
+
+  if modelBootstrap?
+    Luca.Collection.bootstrap( modelBootstrap )
+  else
+    Luca.warn("You should remember to set the model bootstrap location for Luca.Collection.  You can do this by defining a property or function on Luca.config.modelBootstrap")
+
+# Creates a basic Namespace for you to begin defining
+# your application and all of its components.
+Luca.initialize = (namespace, options={})->
+  defaults = 
+    views: {}
+    collections: {}
+    models: {}
+    components: {}
+    lib: {}
+    util: {}
+    concerns: {}
+    register: ()->
+      Luca.register.apply(@, arguments)
+    onReady: ()-> 
+      Luca.onReady.apply(@, arguments)
+    getApplication: ()->
+      Luca.getApplication?.apply(@, arguments)
+    getCollectionManager: ()->
+      Luca.CollectionManager.get?.apply(@, arguments)
+    route: Luca.routeHelper
+
+
+  object = {}
+  object[ namespace ] = _.extend(Luca.getHelper(), defaults)
+
+  _.extend(Luca.config, options)
+  _.extend (window || global), object
+
+  Luca.concern.namespace "#{ namespace }.concerns"
+  Luca.registry.namespace "#{ namespace }.views"
+  Luca.Collection.namespace "#{ namespace }.collections"
+
+  Luca.on "ready", ()->
+    Luca.setupCollectionSpace(options)
+
+Luca.onReady = (callback)->
+  Luca.define.close()
+  Luca.trigger("ready")
+
+  $ -> callback.apply(@, arguments)
 
 Luca.find = (el)->
   Luca( $(el).data('luca-id') )
@@ -137,48 +163,6 @@ Luca.parentClass = (obj, resolve=true)->
   if resolve then Luca.util.resolve(parent) else parent
 
 
-# This is a convenience method for accessing the templates
-# available to the client side app, either the ones which ship with Luca
-# available in Luca.templates ( these take precedence ) or
-# the app's own templates which are usually available in JST
-
-# optionally, passing in variables will compile the template for you, instead
-# of returning a reference to the function which you would then call yourself
-Luca.template = (template_name, variables)->
-  window.JST ||= {}
-
-  if _.isFunction(template_name)
-    return template_name(variables)
-
-  luca = Luca.templates?[ template_name ]
-  jst = JST?[ template_name ]
-
-  unless luca? or jst?
-    needle = new RegExp("#{ template_name }$")
-
-    luca = _( Luca.templates ).detect (fn,template_id)->
-      needle.exec( template_id )
-
-    jst = _( JST ).detect (fn,template_id)->
-      needle.exec( template_id )
-
-  throw "Could not find template named #{ template_name }" unless luca || jst
-
-  template = luca || jst
-
-  return template(variables) if variables?
-
-  template
-
-Luca.available_templates = (filter="")->
-  available = _( Luca.templates ).keys()
-
-  if filter.length > 0
-    _( available ).select (tmpl)-> tmpl.match(filter)
-  else
-    available
-
-
 UnderscoreExtensions =
   module: (base,module)->
     _.extend base, module

data/app/assets/javascripts/luca/index.coffee

@@ -0,0 +1,8 @@
+#= require_tree ./templates
+#= require ./framework
+#= require ./config
+#= require ./util
+#= require ./managers
+#= require ./core
+#= require ./containers
+#= require ./components

data/{src → app/assets/javascripts/luca}/managers/collection_manager.coffee

@@ -1,10 +1,9 @@
 class Luca.CollectionManager
   name: "primary"
 
-  collectionNamespace: Luca.Collection.namespace
-
   __collections: {}
 
+  autoStart: true
   relayEvents: true 
 
   constructor: (@options={})->
@@ -15,6 +14,8 @@ class Luca.CollectionManager
     if existing = Luca.CollectionManager.get?(@name)
       throw 'Attempt to create a collection manager with a name which already exists'
 
+    @collectionNamespace ||= Luca.util.read( Luca.Collection.namespace )  
+    
     Luca.CollectionManager.instances ||= {}
 
     _.extend @, Backbone.Events
@@ -29,7 +30,9 @@ class Luca.CollectionManager
     @state = new Luca.Model()
 
     if @initialCollections
-      handleInitialCollections.call(@)
+      @on "ready", handleInitialCollections, @
+
+    @trigger "ready" if @autoStart is true
 
   add: (key, collection)->
     @currentScope()[ key ] ||= collection
@@ -111,17 +114,23 @@ Luca.CollectionManager.destroyAll = ()->
 
 Luca.CollectionManager.loadCollectionsByName = (set, callback)->
   for name in set 
-    collection = @getOrCreate(name)
-    collection.once "reset", ()->
-      callback(collection)
-    collection.fetch()  
+    if collection = @getOrCreate(name)
+      collection.on "reset", ()->
+        callback(collection)
+        collection.unbind("reset", @)
 
+      collection.fetch()  
 
 #### Private Methods
 guessCollectionClass = (key)->
   classified = Luca.util.classify( key )
+
+  if _.isString( @collectionNamespace )
+    @collectionNamespace = Luca.util.resolve(@collectionNamespace)
+
   # support our naming convention of Books
   guess = (@collectionNamespace || (window || global) )[ classified ]
+
   # support naming covention like BooksCollection
   guess ||= (@collectionNamespace || (window || global) )[ "#{classified}Collection" ]
 

data/app/assets/javascripts/luca/managers/index.coffee

@@ -0,0 +1,2 @@
+#= require ./collection_manager
+#= require ./socket_manager

data/app/assets/javascripts/luca/managers/socket_manager.coffee

@@ -0,0 +1,66 @@
+# The SocketManager provides communication between a Websocket / Pubsub
+# system and routes messages through the application to instances
+# of the 
+class Luca.SocketManager extends Backbone.Model
+  defaults:
+    autoStart: true  
+    providerAvailable: false
+    ready: false
+    provider: "faye.js"
+
+  initialize: (@attributes={})->
+    @loadProviderSource() unless @providerAvailable() is true
+
+    Luca.Model::initialize?.apply(@, arguments)
+
+    model = @
+
+    connectOnReady = ()=> @connect() if @isReady()
+
+    model.on "change", ()->
+      connectOnReady()
+      model.unbind("change", @)
+
+    @on "ready", _.once ()=> @set('ready', true)
+
+    @trigger "change"
+
+  isReady: ()->
+    @get("ready") is true and @get("providerAvailable") is true
+
+  providerAvailable: ()->
+    providerTest = switch @get('provider')
+      when "socket.io"
+        "io"
+      when "faye.js"
+        "Faye.Client"
+
+    !!(Luca.util.resolve(providerTest)?)
+
+  connect: ()->
+    switch @get('provider')
+      when "socket.io"
+        @client = io.connect( @get('host') )
+      when "faye.js"
+        @client = new Faye.Client( @get('host')  + ( @get('namespace')  || "") )
+
+  providerSourceLoaded: ()-> 
+    @set "providerAvailable", true
+
+  providerSourceUrl: ()->
+    switch @get('provider')
+      when "socket.io" then "#{  @get('host')  }/socket.io/socket.io.js"
+      when "faye.js" then "#{  @get('host')  }/faye.js"
+
+  loadProviderSource: ()->
+    script = document.createElement 'script'
+    script.setAttribute "type", "text/javascript"
+    script.setAttribute "src", @providerSourceUrl()
+    script.onload = _.bind(@providerSourceLoaded,@)
+
+    if Luca.util.isIE()
+      script.onreadystatechange = ()=>
+        if script.readyState is "loaded"
+          @providerSourceLoaded()
+
+    document.getElementsByTagName('head')[0].appendChild script

data/{src → app/assets/javascripts/luca}/templates/fields/text_area_field.jst.ejs

@@ -2,7 +2,7 @@
   <%= label %>
 </label>
 <div class="controls">
- <textarea name="<%= input_name %>" style="<%= inputStyles %>" ><%= input_value %></textarea>
+ <textarea placeholder="<%= placeHolder %>" name="<%= input_name %>" style="<%= inputStyles %>" ><%= input_value %></textarea>
   <% if(helperText) { %>
   <p class="helper-text help-block">
     <%= helperText %>

data/{src → app/assets/javascripts/luca}/templates/fields/text_field.jst.ejs

@@ -6,7 +6,7 @@
 <% if( typeof(addOn) !== "undefined" ) { %>
   <span class="add-on"><%= addOn %></span>
 <% } %>
-<input type="text" name="<%= input_name %>" style="<%= inputStyles %>" value="<%= input_value %>" />
+<input type="text" placeholder="<%= placeHolder %>" name="<%= input_name %>" style="<%= inputStyles %>" value="<%= input_value %>" />
 <% if(helperText) { %>
 <p class="helper-text help-block">
   <%= helperText %>

data/app/assets/javascripts/luca/util/deprecations.coffee

@@ -0,0 +1,18 @@
+# For when I want to change the name of a component
+Luca.util.deprecateComponent = (previous, newName)-> 
+  msg = _.template "#{ previous } has been renamed to #{ newName }.  Please update your definitions."
+
+  Luca.registry.componentAliases[ newName ] ||= []
+  Luca.registry.componentAliases[ newName ].push( previous )
+
+  unless previous is newName
+    Luca.registry.deprecatedComponents[ previous ] = 
+      message: msg({previous,newName}) 
+      newName: newName
+
+Luca.util.checkDeprecationStatusOf = (componentName)->
+  if replacement = Luca.registry.deprecatedComponents[ componentName ]
+    Luca.log( replacement.message )
+    return replacement.newName
+
+  componentName

data/app/assets/javascripts/luca/util/index.coffee

@@ -0,0 +1,3 @@
+#= require ./luca
+#= require ./logging
+#= require ./deprecations

data/app/assets/javascripts/luca/util/logging.coffee

@@ -0,0 +1,15 @@
+Luca.warn = (args...)->
+  return unless Luca.config.showWarnings is true
+
+  if Luca.isComponent(@)
+    args.unshift( @identifier() )
+
+  args.unshift("Warning:")
+
+  console.log args...
+  
+Luca.log = (args...)->
+  if Luca.isComponent(@)
+    args.unshift( @identifier() )
+
+  console.log args...

data/{src/util.coffee → app/assets/javascripts/luca/util/luca.coffee}

@@ -2,14 +2,16 @@
 # and returns the value of window.deep.nested.value.  useful for defining
 # references on objects which don't yet exist, as strings, which get
 # evaluated at runtime when such references will be available
-Luca.util.resolve = (accessor, source_object)->
+Luca.util.resolve = (propertyReference, source_object)->
+  return propertyReference unless _.isString(propertyReference)
+
   try
     source_object ||= (window || global)
-    resolved = _( accessor.split(/\./) ).inject (obj,key)->
+    resolved = _( propertyReference.split(/\./) ).inject (obj,key)->
       obj = obj?[key]
     , source_object
   catch e
-    console.log "Error resolving", accessor, source_object
+    console.log "Error resolving", propertyReference, source_object
     throw e
     
   resolved
@@ -18,11 +20,18 @@ Luca.util.resolve = (accessor, source_object)->
 Luca.util.nestedValue = Luca.util.resolve
 
 Luca.util.argumentsLogger = (prompt)->
-  ()-> console.log prompt, arguments
+  ()-> console.log "#{ prompt } #{ @identifier?() }", arguments
 
 Luca.util.read = (property, args...)->
   if _.isFunction(property) then property.apply(@, args) else property
 
+Luca.util.readAll = (object={})->
+  processed = {}
+  for key, value of object
+    processed[key] = Luca.util.read(value)
+
+  processed  
+
 # turns a word like form_view into FormView
 Luca.util.classify = (string="")->
   _.string.camelize( _.string.capitalize( string ) )
@@ -165,3 +174,10 @@ Luca.util.setupHooksAdvanced = (set)->
 
       @on eventId, callback, @
 
+Luca.util.rejectBlanks = (object)->
+  processed = {}
+
+  for key, value of object when _.isBlank(value) isnt true
+    processed[key] = value 
+
+  processed

data/app/assets/javascripts/luca-ui.js

@@ -0,0 +1 @@
+//= require ./luca/index

data/app/assets/stylesheets/luca/components/form_view.scss

@@ -0,0 +1,7 @@
+.luca-form-view.label-align-top {
+  .luca-ui-field {
+    label, input, select, textarea {
+      display: block;
+    }
+  }
+}

data/app/assets/stylesheets/luca/development/index.css

@@ -0,0 +1,3 @@
+/*
+  *= require ./console
+*/

data/app/assets/stylesheets/luca/index.css

@@ -0,0 +1,4 @@
+/*
+ *= require ./components
+ *= require ./containers
+*/

data/app.rb

@@ -25,18 +25,16 @@ end
 class App < Sinatra::Base
   set :root, File.expand_path('../', __FILE__)
   set :sprockets, Sprockets::Environment.new(root)
-  set :precompile, [ /\w+\.(?!js|css).+/, /application.(css|js)$/ ]
   set :assets_prefix, 'assets'
   set :assets_path, File.join(root, 'public', assets_prefix)
 
   sprockets.register_engine '.luca', Luca::Template 
 
   configure do
-    sprockets.append_path(File.join(root, 'assets', 'stylesheets'))
-    sprockets.append_path(File.join(root, 'assets', 'javascripts'))
+    sprockets.append_path(File.join(root, 'app', 'assets', 'stylesheets'))
+    sprockets.append_path(File.join(root, 'app', 'assets', 'javascripts'))
     sprockets.append_path(File.join(root, 'vendor', 'assets', 'javascripts'))
     sprockets.append_path(File.join(root, 'vendor', 'assets', 'stylesheets'))
-    sprockets.append_path(File.join(root, 'assets', 'images'))
     sprockets.append_path(File.join(root, 'vendor', 'assets', 'images'))
 
     sprockets.context_class.instance_eval do