luca 0.9.7 → 0.9.8

data/lib/generators/luca/application/application_generator.rb

@@ -10,16 +10,16 @@ module Luca
       argument :application_name, :type => :string, :default => "luca_app"
 
       def generate_controller
-        template "controller.rb", "app/controllers/#{application_name}_controller.rb"
+        template "controller.rb", "app/controllers/#{application_name.gsub(/-/,'_')}_controller.rb"
       end
 
       def generate_view
-        template "index.html.#{template_extension}", "app/views/#{application_name}/index.html.#{template_extension}"
+        template "index.html.#{template_extension}", "app/views/#{application_name.gsub(/-/,'_')}/index.html.#{template_extension}"
       end
 
       def generate_route
         sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
-        routing_code = "get '/#{application_name}', :to => '#{application_name}#index'"
+        routing_code = "get '/#{application_name}', :to => '#{application_name.gsub(/-/,'_')}#index'"
 
         in_root do
           inject_into_file 'config/routes.rb', "\n  #{routing_code}\n", { :after => sentinel, :verbose => false }
@@ -27,18 +27,22 @@ module Luca
       end
 
       def generate_javascript
-        file_extension = javascript_extension == :coffee ? "js.coffee" : "js"
-        template "javascripts/application.#{file_extension}", "app/assets/javascripts/#{application_name}/application.#{file_extension}"
+        file_extension = "coffee"
+        template "javascripts/application.#{file_extension}", "app/assets/javascripts/#{application_name}/#{ application_name }_application.#{file_extension}"
         template "javascripts/dependencies.#{file_extension}", "app/assets/javascripts/#{application_name}/dependencies.#{file_extension}"
         template "javascripts/index.#{file_extension}", "app/assets/javascripts/#{application_name}/index.#{file_extension}"
-        template "javascripts/router.#{file_extension}", "app/assets/javascripts/#{application_name}/router.#{file_extension}"
-        template "javascripts/main.#{file_extension}", "app/assets/javascripts/#{application_name}/views/main.#{file_extension}"
+        template "javascripts/router.#{file_extension}", "app/assets/javascripts/#{application_name}/lib/router.#{file_extension}"
+        template "javascripts/collection_manager.#{file_extension}", "app/assets/javascripts/#{application_name}/lib/collection_manager.#{file_extension}"
         template "javascripts/config.#{file_extension}", "app/assets/javascripts/#{application_name}/config.#{file_extension}"
-        template "javascripts/main.jst.ejs", "app/assets/javascripts/#{application_name}/templates/main.jst.ejs"
+        template "javascripts/home.jst.ejs", "app/assets/javascripts/#{application_name}/templates/pages/home.jst.ejs"
         
         empty_directory_with_gitkeep("app/assets/javascripts/#{application_name}/models")
         empty_directory_with_gitkeep("app/assets/javascripts/#{application_name}/collections")
+        empty_directory_with_gitkeep("app/assets/javascripts/#{application_name}/views")
+        empty_directory_with_gitkeep("app/assets/javascripts/#{application_name}/lib")
         empty_directory_with_gitkeep("app/assets/javascripts/#{application_name}/util")
+
+        empty_directory_with_gitkeep("app/assets/stylesheets/#{application_name}")
       end
 
       private

data/lib/generators/luca/application/templates/controller.rb

@@ -1,6 +1,4 @@
 class <%= application_class_name %>Controller < ApplicationController
-
   def index
   end
-  
 end

data/lib/generators/luca/application/templates/index.html.erb

@@ -1,7 +1,19 @@
 <div id='viewport'></div>
 
 <script type="text/javascript">
+  /* 
+    the bootstrap is where you should include serialized
+    models that you want to be available to your collections on
+    page load.  A collection will look for an array of models
+    at the property returned by that collection's cache_key() property.
+  */
   window.<%= javascript_namespace %>Bootstrap = {};
+  
+  /*
+    the base params will be included as query parameters for
+    any RESTful call to the API made by your collections.
+  */
+  window.<%= javascript_namespace %>BaseParams = {};
 </script>
   
 <%%= javascript_include_tag "<%= application_name %>/dependencies", "<%= application_name %>" %>

data/lib/generators/luca/application/templates/index.html.haml

@@ -2,5 +2,6 @@
 
 :javascript
   window.<%= javascript_namespace %>Bootstrap = {};
+  window.<%= javascript_namespace %>BaseParams = {};
 
 = javascript_include_tag "<%= application_name %>/dependencies", "<%= application_name %>"

data/lib/generators/luca/application/templates/javascripts/application.coffee

@@ -0,0 +1,18 @@
+application = <%= javascript_namespace %>.register      "<%= javascript_namespace %>.Application"
+
+application.extends                                     "Luca.Application" 
+
+application.defines
+  components:[
+    type: 'controller'
+    name: 'pages'
+    components:[
+      name: "home"
+      template: "pages/home"
+    ]
+  ]
+  el: '#viewport'
+  autoBoot: false
+  name: '<%= javascript_namespace %>App'
+  router:             "<%= javascript_namespace %>.Router"
+  collectionManager:  "<%= javascript_namespace %>CollectionManager"

data/lib/generators/luca/application/templates/javascripts/collection_manager.coffee

@@ -0,0 +1,2 @@
+class <%= javascript_namespace %>.CollectionManager extends Luca.CollectionManager
+  name: "primary"

data/lib/generators/luca/application/templates/javascripts/config.coffee

@@ -0,0 +1,3 @@
+Luca.initialize '<%= javascript_namespace %>',
+  modelBootstrap: window.<%= javascript_namespace %>Bootstrap
+  baseParams: window.<%= javascript_namespace %>BaseParams

data/lib/generators/luca/application/templates/javascripts/{dependencies.js.coffee → dependencies.coffee}

@@ -2,4 +2,5 @@
 #= require underscore-min
 #= require underscore-string.min
 #= require backbone-min
+#= require backbone-query.min
 #= require luca-ui.min

data/lib/generators/luca/application/templates/javascripts/home.jst.ejs

@@ -0,0 +1,2 @@
+Welcome.
+<a href="http://datapimp.com/luca">View the Documentation</a>

data/lib/generators/luca/application/templates/javascripts/index.coffee

@@ -0,0 +1,15 @@
+#= require ./config
+#= require_tree ./util
+#= require_tree ./lib
+#= require_tree ./templates
+#= require_tree ./models
+#= require_tree ./collections
+#= require_tree ./views
+
+#= require ./<%= application_name.gsub(/-/,'_') %>_application
+
+#= require_self
+
+<%= javascript_namespace %>.onReady ->
+  window.<%= javascript_namespace %>CollectionManager = new <%= javascript_namespace %>.CollectionManager();
+  (window.<%= javascript_namespace %>App = new <%= javascript_namespace %>.Application()).boot();

data/lib/generators/luca/application/templates/javascripts/router.coffee

@@ -0,0 +1,4 @@
+_.def('<%= javascript_namespace %>.Router').extends('Luca.Router').with
+
+  routes:
+    "" : <%= javascript_namespace %>.route("home") 

data/lib/luca/component_documentation.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+
+if __FILE__==$0
+  require 'pry'
+end
+
+class ComponentDocumentation
+  def initialize component_name
+    @component_name = component_name
+    file_root = ""
+    filename = @component_name.split('.')[1].downcase
+    @file_path = "#{file_root}/src/components/#{filename}.coffee"
+    @file_contents = File.open(file_path).read()
+  end
+
+  def method_data
+  end
+
+  def comments
+  end
+
+  def arguments
+
+  end
+end
+
+class DocumentationGenerator
+  FILE_ROOT = "/Users/alexsmith/Development/luca"
+  def initialize options={}
+    raise "Must pass options[:class_name]" if options[:class_name].nil?
+    raise "Myst pass options[:property]" if options[:property].nil?
+    @class_name = options[:class_name]
+    @property_name = options[:property]
+    load_target_file
+  end
+
+  def load_target_file
+    file_path = "#{FILE_ROOT}/src/components/#{@class_name}.coffee"
+    @file_contents = File.open(file_path).read()
+    @property_match = @file_contents.match(/(^\s*#.*$\n)*(\s*#{@property_name}\s*:\s*\(.*\)\s*-\>.*$)/)
+  end
+
+  def args
+    args = @property_match[0].match(/^\s*#{@property_name}\s*:\s*\((.*)\)\s*-\>.*$/)[1]
+    args = args.gsub(/\s/,'').split(',')
+    args.inject({}) do |memo, arg|
+      if default_args = arg.match(/^(.*)=(.+)/)
+        memo[default_args[1].to_sym] = default_args[2]
+      else
+        memo[arg.to_sym] = nil
+      end
+      memo
+    end
+  end
+
+  def comments
+    @comments = @property_match[0].match(/(^\s*#.*$\n)*/)[0]
+  end
+
+  def function_signature
+
+  end
+
+  def docs
+    @property_match[0]
+  end
+
+end
+
+if __FILE__==$0
+  pry
+end

data/lib/luca/rails/engine.rb

@@ -1,6 +1,10 @@
 module Luca
   module Rails
     class Engine < ::Rails::Engine
+      rake_tasks do
+        load "railties/luca/tasks.rake"
+      end 
+
       initializer "luca.register_template" do |app|
         app.assets.register_engine ".luca", Luca::Template
         Luca::TestHarness.set(:sprockets,app.assets)

data/lib/luca/rails/version.rb

@@ -1,6 +1,6 @@
 module Luca
   module Rails
-    VERSION = "0.9.7"
+    VERSION = '0.9.8' 
   end
 end
 

data/lib/luca.rb

@@ -1 +1 @@
-require 'luca/rails'
+require 'luca/rails'

data/lib/railties/luca/tasks.rake

@@ -0,0 +1,31 @@
+namespace :luca do
+  desc "Download the vendor dependencies for a luca app"
+  task :dependencies do
+    base = 'https://raw.github.com/datapimp/luca/master/assets/javascripts/dependencies/'
+
+    scripts = [
+      'underscore-min.js',
+      'underscore-string.min.js',
+      'bootstrap.min.js',
+      'backbone-min.js',
+      'backbone-query.min.js'
+    ]
+
+    scripts.each do |script|
+      puts "Downloading #{ script } from #{ base + script }"
+      `wget -q #{ base + script } > #{ Rails.root }/vendor/assets/javascripts/#{ script }` 
+    end
+
+    style_base =  "https://raw.github.com/datapimp/luca/master/assets/stylesheets/"
+
+    stylesheets = [
+      'bootstrap.min.css',
+      'bootstrap-responsive.min.css'
+    ]
+
+    stylesheets.each do |stylesheet|
+      puts "Downloading #{ stylesheet } from #{ style_base + stylesheet }"
+      `wget -q #{ style_base + stylesheet } > #{ Rails.root }/vendor/assets/dependencies/#{ stylesheet }` 
+    end  
+  end
+end

data/luca.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.add_dependency "railties", "~> 3.1"
   s.add_dependency "thor",     "~> 0.14"
   s.add_dependency "sinatra", ">= 0.9.2"
+  s.add_dependency "ejs"
   s.add_development_dependency "bundler", "~> 1.0.0"
   s.add_development_dependency "rails",   "~> 3.1"
 

data/spec/components/controller_spec.coffee

@@ -0,0 +1,62 @@
+describe 'The Controller Component', ->
+  beforeEach ->
+    controller = Luca.register  'Luca.components.SpecController'
+    controller.extends          'Luca.components.Controller' 
+    controller.defines
+      name: "spec_controller"
+      defaultCard: 'one'
+      rootComponent: true
+      components:[
+        name: "one"
+        type: "controller"
+        components:[
+          name: "alpha"
+        ,
+          name: "bravo"
+        ]
+      ,
+        name: "two"
+        type: "controller"
+        components:[
+          name: "charlie"
+        ,
+          name: "delta"
+        ]
+      ,
+        name: "three"
+        type: "controller"
+        components:[
+          name: "echo"
+        ]
+      ,
+        name: "four"
+        type: "view"
+      ]
+
+    @controller = new Luca.components.SpecController().render()
+
+  it "should track the names of its pages", ->
+    names = @controller.sectionNames()
+    expect( names... ).toEqual 'one', 'two', 'three', 'four'
+
+  it "should track the names of its controllers", ->
+    names = _( @controller.controllers() ).pluck 'name'
+    expect( names... ).toEqual 'one', 'two', 'three'
+
+  it "should be stateful", ->
+    expect( @controller.state ).toBeDefined()
+
+  it "should track the active page", -> 
+    @controller.navigate_to("two")
+    expect( @controller.activePage() ).toEqual 'two'
+
+  it "should track controller activation events", ->
+    two = @controller.navigate_to("two")
+    expect( two.activatedByController ).toBeTruthy()
+
+  it "should define a controllerPath method on each page", ->
+    expect( @controller.activeComponent().controllerPath ).toBeDefined()
+
+  it "should know the controller path", ->
+    path = @controller.activeComponent().controllerPath()
+    expect( path... ).toEqual "spec_controller", "one"

data/spec/components/form_view_spec.coffee

@@ -47,6 +47,10 @@ describe 'The Form View', ->
   it "should create a form", ->
     expect( @form ).toBeDefined()
 
+  it "should have access to all of the fields", ->
+    @form.render()
+    expect( @form.getFields().length ).toEqual 6
+
   it "should load the model", ->
     @form.loadModel(@model)
     expect( @form.currentModel() ).toEqual @model

data/spec/concerns/collection_event_bindings_spec.coffee

@@ -0,0 +1,15 @@
+describe 'Collection Event Bindings', ->
+  view = Luca.register("Luca.components.CollectionBindingView")
+  view.extends "Luca.View"
+  view.mixesIn  "CollectionEventBindings"
+  view.defines 
+    collection: new Luca.Collection()
+
+  xit "should allow me to bind to collection manager events"
+
+  it "should setup event relaying from the collection", ->
+    view = new Luca.components.CollectionBindingView()
+    for eventId in ["reset","add","remove","change"]
+      view.collection.trigger(eventId)
+      expect( view ).toHaveTriggered("collection:#{ eventId }")
+        

data/spec/concerns/dom_helpers_spec.coffee

@@ -6,11 +6,11 @@ describe 'The DOM Helpers module', ->
 
   describe "Auto Assigning Class Names", ->
     it "should apply the class of the component all the way up its hierarchy", ->
-      c = new Luca.core.Container()
+      c = new Luca.Container()
       expect( c.$el.is(".luca-container") ).toBeTruthy()
       expect( c.$el.is(".luca-panel") ).toBeTruthy()
 
     it "should leave out backbone and luca view classes", ->
-      c = new Luca.core.Container()
+      c = new Luca.Container()
       expect( c.$el.is(".luca-view") ).not.toBeTruthy()
       expect( c.$el.is(".backbone-view") ).not.toBeTruthy()

data/spec/concerns/filterable_spec.coffee

@@ -10,6 +10,9 @@ describe 'The Filterable Plugin', ->
     it 'should generate a Backbone.QueryCollection query payload', ->
       expect( @view.getFilterState().toQuery() ).toBeDefined()
 
+    it 'should generate a Backbone.QueryCollection options payload', ->
+      expect( @view.getFilterState().toOptions() ).toBeDefined()
+
     it "should have a toRemote method which merges params", ->
       expect( @view.getFilterState().toRemote() ).toBeDefined()
       
@@ -17,9 +20,6 @@ describe 'The Filterable Plugin', ->
       @view.applyFilter(filter:"value")
       expect( @view.getFilterState().toQuery().filter ).toEqual('value')
 
-    it 'should generate a Backbone.QueryCollection options payload', ->
-      expect( @view.getFilterState().toOptions() ).toBeDefined()
-
     it "should trigger a refresh event on filter change", ->
       @view.applyFilter(filter:"value")
-      expect( @view ).toHaveTriggered("refresh")
+      expect( @view ).toHaveTriggered("data:refresh")

data/spec/concerns/state_model_spec.coffee

@@ -0,0 +1,50 @@
+describe 'The State Model Concern', ->
+  view = Luca.register  "Luca.components.StatefulView"
+  view.extends          "Luca.View"
+  view.mixesIn          "StateModel"
+  view.defines
+    stateful:
+      key1: "val1"
+      key2: "val2"
+
+  it "should create a state model on the view", ->
+    view = new Luca.components.StatefulView()
+    expect( view.state ).toBeDefined()
+    expect( Luca.isBackboneModel(view.state) ).toEqual true
+
+  it "should delegate the get method on the state model to the view", ->
+    view = new Luca.components.StatefulView()
+    expect( view.get ).toBeDefined()
+    expect( view.get('key1') ).toEqual 'val1' 
+
+  it "should delegate the set method on the state model to the view", ->
+    view = new Luca.components.StatefulView()
+    view.set('key1','boom') 
+    expect( view.state.get('key1') ).toEqual 'boom' 
+
+  it "should apply the default state attributes", ->
+    view = new Luca.components.StatefulView()
+    expect( view.state.toJSON() ).toEqual key1:"val1", key2: "val2"
+
+  describe 'State Change Event Bindings', ->
+    it "should trigger state change events on the view", ->
+      view = new Luca.components.StatefulView()
+      view.set('key1','boom')
+      expect( view ).toHaveTriggered("state:change")
+
+    it "should trigger individual attribute change events on the view", ->
+      view = new Luca.components.StatefulView()
+      view.set('key1','boom')
+      expect( view ).toHaveTriggered("state:change:key1")
+
+    it "should respond to @stateChangeEvents configuration", ->
+      view = new Luca.components.StatefulView
+        onKeyChange: sinon.spy()
+        blah: sinon.spy()
+        stateChangeEvents:
+          "key1" : "onKeyChange" 
+          "key2" : "blah"
+
+      view.set('key1','boom')
+      expect( view.blah ).not.toHaveBeenCalled()
+      expect( view.onKeyChange ).toHaveBeenCalled()

data/spec/core/collection_spec.coffee

@@ -260,6 +260,31 @@ describe "The Model Bootstrap", ->
     expect( spy.called ).toBeTruthy()
 
 
+describe "Base Params on the URL Method", ->
+  beforeEach ->
+    @collection = new Luca.Collection [],
+      url: ()-> "/url/to/endpoint"    
+
+  afterEach ->
+    Luca.Collection.resetBaseParams()
+
+  it "should work with strings too", ->
+    collection = new Luca.Collection [], url: "/string/based/url"
+    expect( collection.url ).toEqual "/string/based/url"
+
+  it "should include base params in the url", ->
+    Luca.Collection.baseParams(base:"value")
+    expect( @collection.url() ).toEqual '/url/to/endpoint?base=value'
+    
+  it "should include params in the url", ->
+    @collection.applyParams(param:"value")
+    expect( @collection.url() ).toEqual '/url/to/endpoint?param=value'
+
+  it "should include one time params, in addition to base params", ->
+    Luca.Collection.baseParams(base:"value")
+    @collection.applyParams(one:"time")
+    expect( @collection.url() ).toEqual "/url/to/endpoint?base=value&one=time"
+
 
 
 

data/spec/core/container_spec.coffee

@@ -1,6 +1,6 @@
 describe 'The Luca Container', ->
   beforeEach ->
-    c = @container = new Luca.core.Container
+    c = @container = new Luca.Container
       defaults:
         defaultProperty: 'it_works'
       extensions:[
@@ -43,6 +43,8 @@ describe 'The Luca Container', ->
         ]
       ]
 
+    @container.on "before:attach", ()->
+      console.log "before attach", @, arguments
     @container.render()
 
   it "should create getter methods on the for components with roles", ->
@@ -98,7 +100,7 @@ describe 'The Luca Container', ->
 
 describe 'Component Inheritance and Customization', ->
   it "should accept an array for extensions configuration and join on position/index", ->
-    container = new Luca.core.Container
+    container = new Luca.Container
       extensions:[
         undefined
       ,
@@ -117,7 +119,7 @@ describe 'Component Inheritance and Customization', ->
     expect( container.getComponentTwo().name ).toEqual "custom_two"
 
   it "should accept an object for extensions configuration and join using role", ->
-    container = new Luca.core.Container
+    container = new Luca.Container
       extensions:
         component_one:
           name: "custom_one"
@@ -135,7 +137,7 @@ describe 'Component Inheritance and Customization', ->
 
 describe 'Component Event Binding', ->
   beforeEach ->
-    @container = new Luca.core.Container
+    @container = new Luca.Container
       componentEvents:
         "haha trigger:one"                  : "one"
         "alpha trigger:two"                 : "two"
@@ -162,7 +164,7 @@ describe 'Component Event Binding', ->
         @getGamma().trigger("after:render:gamma")
 
       registerComponentEvents: ()->
-        Luca.core.Container::registerComponentEvents.apply(@, arguments)
+        Luca.Container::registerComponentEvents.apply(@, arguments)
 
       components:[
         name: "component_alpha"
@@ -233,3 +235,53 @@ describe 'Component Event Binding', ->
   it "should accept component events with a component getter", ->
     @container.getAlphaComponent().trigger "trigger:three"
     expect(@container).toHaveTriggered("three")
+
+
+describe 'Parent Container Tracking', ->
+  nestedContainer = Luca.register("Luca.components.NestedSpec")
+  nestedContainer.extends("Luca.Container")
+  nestedContainer.defines
+    name: "nested_container"
+    components:[
+      type: "container"
+      name: "one",
+      role: "one"
+      components:[
+        type: "container"
+        role: "two"
+        name: "two"
+        components:[
+          name: "three"
+          role: "three"
+        ]
+      ]
+    ]
+
+  it "should not have a parent unless created by a container", ->
+    nestedContainer = (new Luca.components.NestedSpec()).render()
+    expect( nestedContainer.getParent ).not.toBeDefined()
+
+  it "should know the root", ->
+    nestedContainer = (new Luca.components.NestedSpec()).render()
+    one = nestedContainer.getOne()
+    expect( one.getRootComponent().name ).toEqual 'nested_container'
+
+  it "should know the root", ->
+    nestedContainer = (new Luca.components.NestedSpec()).render()
+    two = nestedContainer.getTwo()
+    expect( two.getRootComponent().name ).toEqual 'nested_container'
+
+  it "should know its parent", ->
+    nestedContainer = (new Luca.components.NestedSpec()).render()
+    one = nestedContainer.getOne()
+    expect( one.getParent().name ).toEqual 'nested_container' 
+
+  it "should know its parent", ->
+    nestedContainer = (new Luca.components.NestedSpec()).render()
+    two = nestedContainer.getTwo()
+    expect( two.getParent().name ).toEqual 'one' 
+
+  it "should know its parent", ->
+    nestedContainer = (new Luca.components.NestedSpec()).render()
+    three = nestedContainer.getThree()
+    expect( three.getParent().name ).toEqual 'two'