lanes 0.1.9 → 0.1.9.5

data/client/lanes/workspace/styles/tabs.scss

@@ -4,7 +4,7 @@
 
 .header-top {
 
-    
+
     .menu-container {
         position:absolute;
         left: 0;
@@ -16,16 +16,18 @@
         transition: all 0.15s ease-in-out 0s;
         overflow-x: visible;
         overflow-y: auto;
-        left: 200px;
+        left: 215px;
         right: 35px;
     }
 
-    /* &.with-screen-menu { */
-    /*   .menu-container { */
-    /*     left: 0px; */
-    /*   } */
-    /* } */
-
+    .screens-menu-toggle {
+        margin-left: 20px;
+        .icon {
+            @extend .icon;
+            @extend .icon-navicon;
+            @extend .icon-rotate-90;
+        }
+    }
 
     .active-screens {
         display: inline-block;
@@ -47,7 +49,6 @@
                 left:0px;
                 top: 1px;
                 min-width:3000px;
-                /* margin-left:12px; */
                 margin-top:0px;
 
                 li {
@@ -77,11 +78,11 @@
                     visibility: visible;
                 }
             }
-            
+
             .scroller-right{
                 float:right;
                 &:before {
-                    @extend .font-icon-display;
+                    @extend .icon;
                     @extend .icon-arrow-right:before;
                 }
             }
@@ -89,7 +90,7 @@
             .scroller-left {
                 float:left;
                 &:before {
-                    @extend .font-icon-display;
+                    @extend .icon;
                     @extend .icon-arrow-left:before;
                 }
             }
@@ -103,7 +104,7 @@
             overflow: hidden;
         }
         .screens-menu {
-            
+
         }
     }
 
@@ -121,7 +122,7 @@
     }
 
     .active-screens {
-        
+
         height: 45px;
         padding: 0 5px;
 
@@ -134,7 +135,7 @@
         .close {
             position: absolute;
             right: 7px;
-            top: 0px;    
+            top: 0px;
         }
 
         /* a { */

data/coffeelint.json

@@ -0,0 +1,49 @@
+{
+    "coffeelint": {
+        "transforms": [
+            "coffee-react-transform"
+        ]
+    },
+    "indentation": {
+        "level": "error",
+        "value": 4
+    },
+    "line_endings": {
+        "value": "unix",
+        "level": "error"
+    },
+    "arrow_spacing": {
+        "level": "error"
+    },
+    "no_empty_functions": {
+        "level": "error"
+    },
+    "no_empty_param_list": {
+        "level": "error"
+    },
+    "no_interpolation_in_single_quotes": {
+        "level": "error"
+    },
+    "no_throwing_strings": {
+        "level": "error"
+    },
+    "no_unnecessary_double_quotes": {
+        "level": "ignore"
+    },
+    "no_unnecessary_fat_arrows": {
+        "level": "error"
+    },
+    "prefer_english_operator": {
+        "level": "ignore"
+    },
+    "space_operators": {
+        "level": "error"
+    },
+    "spacing_after_comma": {
+        "level": "error"
+    },
+    "max_line_length": {
+        "value": 135,
+        "level": "error"
+    }
+}

data/config.ru

@@ -1,4 +1,5 @@
 require 'bundler'
 Bundler.require
 require 'lanes/api'
+
 run Lanes::API::Root

data/config/database.yml

@@ -1,9 +1,9 @@
 development:
   adapter: postgresql
-  database: lanes_dev
+  database: skr_dev
   host: /tmp
 
 test:
   adapter: postgresql
-  database: lanes_test
+  database: skr_dev
   host: /tmp

data/config/routes.rb

@@ -0,0 +1,7 @@
+require 'lanes/access/user'
+
+module Lanes
+    API.routes.draw do
+        resources User
+    end
+end

data/docs/command.md

@@ -60,13 +60,13 @@ Notable directories created are:
 
 # lanes generate
 
-Constructs either a model, view or screen.
+Constructs either a model, component or screen.
 
-## View
+## Component
 
-`lanes generate view <name>`
+`lanes generate component <name>`
 
-Will create a new view file, template and an accompanying spec.  By default the view will have no content, and it's template is composed of a single DIV.
+Will create a new component file along with an accompanying spec.  By default the content will only render a simple [I am a {class_name} component] message.
 
 
 ## Model
@@ -87,11 +87,9 @@ For instance, `lanes generate model comment user:references title:string{80} con
 
 `lanes generate screen <name>`
 
-In the Lanes lexicon, a screen is a View that has a few extra properties, "title" and "specification".  It is capable of being dynamically loaded and also consolidates pubsub events for all it's client views.
+In the Lanes lexicon, a screen is a Component that is able to be loaded on demand.  By default, the styles and Javascript code that make up a screen are not loaded as part of the applications main bundles.  Instead the screen is loaded on demand when the user clicks on a menu.
 
-The specification contains attributes that are checked to see if the logged in user can access the screen or not.  If they are not allowed access, then the screen will not be listed as available and they will not be able to load it or it's data.
-
-Remote data events for all subviews are applied by the view, and then bubble up to the screen.  This allows the screen to display a notification to the user alerting them that another user edited the data that is being currently displayed.
+Remote data events for all sub components bubble up to the screen.  This allows the screen to display a notification to the user alerting them that another user edited data that is being currently displayed somewhere on the view.
 
 # lanes update
 
@@ -109,3 +107,8 @@ When developing a data driven application, the data model usually undergoes seve
 
 Calls rake db:migrate for each extension that is loaded.  Since lanes extensions ship with migrations, this provides an easy way to install their data structures as well as keep them up to date.
 
+## Seed
+
+`lanes db seed`
+
+Calls rake db:seed for each extension that is loaded.  Often an extension will need to ship with certain default records.  This provides a way to provision them on install.  Commands can be placed in db/seeds.rb to be executed.

data/docs/model.md

@@ -9,17 +9,14 @@ Lanes provides a Lanes.Models.Base class that all other models extend from.
 A Model is an extension of [Ampersand State](http://ampersandjs.com/docs#ampersand-state), and supports all the features that AmpersandState does.
 
 <aside class="note">
-Unlike the Models in Backbonejs, Lanes' Models track thier "dirty" state.  This allows them to perform true HTTP "patch" requests and only send the attributes that have been modified to the server.  They can also be interogated and only saved if they contain unsaved data.
+Unlike the Models in Backbonejs, Lanes' Models track their "dirty" state.  This allows them to perform true HTTP "patch" requests and only send the attributes that have been modified to the server.  They can also be interogated and only saved if they contain unsaved data.
 </aside>
 
-Models also have associations, which are lazily instanciated and can be optionally fetched along with the model/collection.
-
-Models and collections use an Identity Map that stores models that are bound to {% doc_link view title:Views %%}
+Models also have associations, which are lazily instantiated and can be optionally fetched along with the model/collection.
 
 Model methods that make requests to the server can specify options to control what data is returned.  An explanation of the options can be found under [Request Options](#request-options)
 
 
-
 ### API Reference
 
 # @where

data/docs/react.md

@@ -0,0 +1,137 @@
+---
+title: React
+heading: Lanes.React.Component
+---
+
+Lanes uses [React](reactjs.com) for the view layer.  It provides an easy-to-use data bindings between it and the data layouer's {% doc_link model %}
+
+A simple example of a React component bound to a data model:
+
+``` coffee
+
+class MyView extends Lanes.React.Component
+
+    propTypes:
+        model: Lanes.PropTypes.Model.isRequired
+
+    render: ->
+        <h1>Hello {@model.name}</h1>
+
+```
+
+Note a few interesting things about this component compared to a standard React one.  The first is the non-standard "model" propType, and the second is the @model instance variable used in the `render` method.
+
+# propType validators
+
+As show above, Lanes provides validators for it's data types.  These include:
+
+
+  * `Lanes.PropTypes.Model` Verifies that the property is an instance of `Lanes.Models.Base`
+  * `Lanes.PropTypes.State` Checks that the property is an instance of `Lanes.Models.State`.  State objects are like models, but do not have the ability to be retreived from or saved to the server.  They're usefull for storing lightweight session objects.
+  * `Lanes.PropTypes.Collection` Like the models above but for collections.
+
+Each of the validators also has a `.isRequired` helper, just like React's built in ones.
+
+# dataObjects
+
+Lanes data bindings for components will be automatically setup for any prop that is named `model`.
+
+If a property named `model` is given, it will be mapped to the `@model` instance.  Other properties can also be setup by specifying attributes for `dataObject`  In this example, a '@bank` and `@customer` objects are mapped.
+
+``` coffee
+
+class MyView extends Lanes.React.Component
+
+    dataObjects:
+        bank: 'props'
+        customer: -> GlobalCustomer.lookup('foo')
+
+    render: ->
+        <h1>{@customer.name} has {@bank.balance}</h1>
+
+```
+
+As you can see, the bank mapping will be read from the props, while the customer uses a custom lookup strategy.  It's function will be called to obtain the value whenever the component is mounted.
+
+
+
+# events
+
+By default, Lanes will listen for all events on both models and collections.
+
+Every time the events fires, Lanes will call `setState` on the component, causing a re-render.  While React is great about making the re-render as efficient as possible, it can sometimes be a good idea to only listen for events that the compoent will be interested int.
+
+The events bound can be modified by using the `bindDataEvents` attribute.  For instance this component will only render when the name is changed.  This makes sense since that's the only attribute of the model that is used.
+
+
+``` coffee
+
+class MyView extends Lanes.React.Component
+
+    bindDataEvents:
+        model: 'change:name'
+
+
+    render: ->
+        <h1>Your name is: {@model.name}</h1>
+
+```
+
+The complete list of events Lanes listens to is:
+
+  * Models:
+    * `change`:   an attribute was modified
+    * `request`: A network request was began
+    * `sync`: The network request completed
+    * `invalid`: An attempted update failed validation
+    * `error`: An error was encountered, usually only fired during network access.
+  * Collections:
+    * `add`: A model was added
+    * `remove`: Model removed
+    * `change`: one of the models was changed
+    * `sort`: The collection was re-sorted
+    * `reset`: All models were removed
+    * `request`: A network request was started
+    * `sync`: Network request completed
+    * `error`: An error occured, usually during network access
+
+# setDataState
+
+When a bound event is fired for a model, Lanes will call setState on the model with the affected model as the key. Sometimes a component would rather have other information injected into state, or perhaps wants to selectively ignore some changes.
+
+Components can do so by implementing a `setDataState` method.  If this method exists, it is soley responsible for calling `setState` to trigger a `render`
+
+``` coffee
+
+class MyView extends Lanes.React.Component
+
+    setDataState: (newState) ->
+        if newState.model?.name == 'Bob'
+            this.setState(wasBob: true)
+
+    render: ->
+        <h1>Has Bob been seen? {if @state.wasBob then 'Yes' else 'No'}</h1>
+
+```
+
+# PubSub
+
+Publish/Subscribe often abbreviated as simply PubSub is a mechanism where amodel can subscribe to updates for itself and be notified when other users modify it.
+
+By default whenever a model is bound to a React component, Lanes will also subscribe that model to updates.  When model is unbound or the component is unmounted, Lanes will remove the model from receiving updates as well.  This applies only to Models, not State object or Collections.
+
+Set `pubsub: false` if Lanes should not bind any models, or to an object with keys for the models that should not be bound
+
+
+``` coffee
+
+class MyView extends Lanes.React.Component
+
+    pubsub:
+        model: false
+
+    # could also have just been:
+    pubsub: false
+
+
+```

data/lanes.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
     spec.add_dependency "rack_csrf",              "~> 2.5"
     spec.add_dependency "sprockets",              "~> 2.0"
     spec.add_dependency "coffee-script",          "~> 2.3"
+    spec.add_dependency "coffee-react",           "~> 3.0"
     spec.add_dependency "execjs",                 "~> 2.2"
     spec.add_dependency "thor",                   "~> 0.19"
     spec.add_dependency "sass",                   "~> 3.4"

data/lib/lanes.rb

@@ -1,9 +1,9 @@
 require 'active_record'
 
 require_relative "lanes/version"
-require_relative "lanes/logger"
 require_relative "lanes/environment"
 require_relative "lanes/configuration"
+require_relative "lanes/logger"
 if defined?(::Rails)
     require_relative "lanes/rails_engine"
 end

data/lib/lanes/access/authentication_provider.rb

@@ -13,6 +13,7 @@ module Lanes
                     if Lanes.env.test? && request.env['HTTP_X_TESTING_USER'].present?
                         Lanes::User.where(login: request.env['HTTP_X_TESTING_USER']).first
                     else
+                        return Lanes::User.first
                         Lanes::User.where(id: request.session['user_id']).first
                     end
                 )

data/lib/lanes/access/config/routes.rb

@@ -4,6 +4,8 @@ module Lanes
         post "/user-session.json" do
             wrap_reply do
                 user = User.where(login: data['login']).first
+                Lanes.logger.warn "Found User: #{user}"
+
                 if user && user.authenticate(data['password'])
                     session[:user_id] = user.id
                     { success: true, message: "Login succeeded", data: user.workspace_data }

data/lib/lanes/access/config/screens.rb

@@ -1,16 +1,19 @@
-Lanes::Screen.define "user-management" do | screen |
-    screen.title       = "User Management"
-    screen.description = "Add/Remove/Modify User Accounts"
-    screen.icon        = "icon-group"
-    screen.group_id    = "system-settings"
-    screen.model_class = "User"
-    screen.view_class  = "Lanes.Access.Screens.UserManagement"
-    screen.js  = 'lanes/access/screens/user-management.js'
-    screen.css = 'lanes/access/screens/user-management.css'
-end
-
 Lanes::Screen.define_group "system-settings" do | group |
     group.title       = "System Settings"
     group.description = "Modify system settings"
-    group.icon        = "icon-wrench"
+    group.icon        = "wrench"
+end
+
+Lanes::Screen.for_extension 'access' do | screens |
+    screens.define "user-management" do | screen |
+        screen.title       = "User Management"
+        screen.description = "Add/Remove/Modify User Accounts"
+        screen.icon        = "group"
+        screen.group_id    = "system-settings"
+        screen.model_class = "User"
+        screen.view_class  = "UserManagement"
+        screen.url_prefix  = 'lanes/access/screens'
+        screen.js  = 'user-management.js'
+        screen.css = 'user-management.css'
+    end
 end

data/lib/lanes/access/extension.rb

@@ -6,7 +6,7 @@ module Lanes
 
             identifier "lanes-access"
 
-            components 'modal', 'grid', 'select-field'
+            components 'grid', 'modal'
 
             root_path Pathname.new(__FILE__).dirname.expand_path
 
@@ -25,6 +25,7 @@ module Lanes
             def client_paths
                 []
             end
+
             def roles_for_client
                 Lanes::Access::Role.all_available.map do |role|
                     { id: role.to_s.demodulize.underscore, name: role.to_s.demodulize }