lanes 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c48fe1ac2eaf85a9771acba612806120af0168b
-  data.tar.gz: 815755b8f6e731e8a85f6a02ed443a1ef676e9cf
+  metadata.gz: bc96c5119c604258c8b8f4c2ceb3c8c3028519bc
+  data.tar.gz: 4f4f8fd4254620611174e393070c68c257b13790
 SHA512:
-  metadata.gz: 7d868609cfbac56dbd4e6ed6e4ca02284acd12c7e0cbea3145748b1a0726dd7e9bb8267eaa0c5ac436844297acc15a612fa6a07cb03e800f5e50d0a6f68c0e93
-  data.tar.gz: 844e24f045c8896fb405e20570edc981a7dcc04a3167316b9741090b42f2bc33767837b49a4d6589c60e747937d4f2410d989ce4c8891676ee757f3264ed53cd
+  metadata.gz: f54221e4207bc547a4aaf6015f28c41991c4347fe2bcf328a8bc5b335c480a2c1b48837a63b55993368ee4529cac2165e966cda612d06a0d52dee1aa28592742
+  data.tar.gz: f7fcb100561a1345cb2280853531b5e12a44ed52a96656e4328581a798bf1b5b54ad4355e54e037f2e26e7d0fa7f90a1c071c990c0f479b34731fb65c4cce43f

data/README.md

@@ -6,6 +6,25 @@ Read more at [lanesframework.org](http://lanesframework.org/)
 
 It's extracted from the Stockor ERP application and is still very much a work in progress.
 
+Some of it's features are:
+
+* **Integrated web server**: Sinatra is used internally with RESTful routes auto-created for each model. This frees the developer from the hassel of integrating disparate systems and allows Lanes to provide tools that are guaranteed to work together.
+
+* **Rich JSON requests**: Clients can perform ad-hoc querys against server-side data and the the reply format can be extensively customized. Operators are provided for specifying which fields and associations are included in the result set, as well as ordering and pagination support. It's also easy to write custom query operators. ActiveRecord is used internally to eager-load associations in order to prevent N+1 queries.
+
+* **Real-Time data updates**: Whenever a CRUD operation is performed on a model, the web-server will relay the event to client observers that have registered for updates. By default a model is registered for updates whenever it's bound to a view, which works to prevent unwanted updates and allows records to be garbage collected. Updates are performed by long-pulling via the message-bus gem. A client-side identity map is also used so that only one copy of the model for a given id exists and is updated.
+
+* **Next-Gen web-framework**: Derived from ampersand state, the web framework completely written in CoffeeScript and uses defined properties to implement data getter and setters. This means that it's IE 9+ only. It's heavily influenced by Backbone, Ampersand and a bit of Marrionette.
+
+* **Integrated continual testing environment**: When ran in development mode, Lanes watches for file changes and runs the appropriate spec for both your client and server code automatically. Minispec is utilized for the Ruby models, and client code tested via Jasmine.
+
+* **Role-driven security**: Models can be marked as readable, writeable, or deletable for roles. Additionally, fields can be marked as read-only or invisible to prevent unauthorized access.
+
+* **Extendible**:  Extensions can be registered with the framework and will be automatically compiled and included in builds. Components are loaded on-demand and are not included unless an extension requires them. Lanes also dynamically loads the Javascript and CSS for screens on-demand immediatly before they are displayed.
+
+* **Embeddable and Responsive**: Designed from the ground up to be embeddable in hostile environments. All code is non-conflicting and wrapped in closures. Sass is auto-namespaced. Detect changes in it's container's size and relay them to clasess for responsive layouts. A modified Bootstrap based css layout can optionally be loaded which will provide a responsive grid that's bound to the container's size, not the documents.
+
+
 ## Contributing
 
 The standard instructions are always good:

data/client/lanes/access/Extension.coffee

@@ -0,0 +1,19 @@
+class Lanes.Access.Extension extends Lanes.Extensions.Base
+
+    identifier: "lanes-access"
+
+    setBootstrapData: (data)->
+        Lanes.current_user = new Lanes.Models.User
+
+        Lanes.Models.Roles.all = new Lanes.Models.Roles(
+            _.map( data.roles, (role)->
+                { id: role.toLowerCase(), name: role }
+            )
+        )
+        if data.user
+            Lanes.current_user.set(data.user)
+        if data.access
+            Lanes.current_user.access_data = data.access
+
+    onAvailable: (view)->
+        Lanes.Access.createLoginDialog(view)

data/client/lanes/access/LoginDialog.coffee

@@ -0,0 +1,47 @@
+class Lanes.Access.LoginDialog extends Lanes.Components.ModalDialog
+
+    bodyTemplateName: 'login-dialog'
+    templatePrefix: 'lanes/access'
+    hideOnBackdropClick: false
+    showHideButton: false
+    hideOnEsc: false
+
+    size: 'md'
+    title: 'Please sign in …'
+    FILE: FILE
+
+    domEvents:
+        'click .btn-primary': 'onLogin'
+
+    buttons:
+        login: { label: 'Login', type: 'primary' }
+
+    ui:
+        l: '#LoginField',
+        pw: '#PasswordField'
+        alert: '.alert'
+
+    initialize: (options)->
+        super
+        this.listenToAndRun(Lanes.current_user, 'change:isLoggedIn', this.onUserChange)
+
+    onUserChange: ->
+        this.toggleShown(!Lanes.current_user.isLoggedIn)
+
+    onLogin: (ev)->
+        msg = this.ui.alert.hide()
+        mask = new Lanes.Views.TimedMask(this.$el, "Attempting Login …")
+        session = Lanes.Models.User.attemptLogin( @ui.l.val(), @ui.pw.val(), {
+            scope: this
+            success: ->
+                mask.displaySuccess("Login Success!")
+            error: ->
+                msg.show().text(session.lastServerMessage )
+                mask.displayFailure(session.lastServerMessage)
+        })
+
+    onShown: -> @ui.l.focus()
+
+
+Lanes.Access.createLoginDialog = (view)->
+    new Lanes.Access.LoginDialog( parent: view )

data/client/lanes/access/Roles.coffee

@@ -0,0 +1,88 @@
+class Role extends Lanes.Models.BasicModel
+    props:
+        id:     'string'
+        name:   'string'
+        member: { type: 'boolean', default: false }
+
+
+class Lanes.Models.Roles extends Lanes.Models.BasicCollection
+    model: Role
+    comparator: 'name'
+
+
+class UserRole
+    constructor: (config={})->
+        @type = config.type
+        for method in RWD
+            this[method] = _.map(config[method],klassFor)
+
+    can: (type,model)->
+        -1 != this[type].indexOf(model)
+
+    decodeLockedFields: (fields, previous={})->
+        decoded = _.extend({}, previous)
+        for lock in fields
+            if klass = klassFor(lock.type)
+                decoded[ klass ] = locks = {}
+                locks[field] = grants for field, grants of lock.locks
+        decoded
+
+RWD = ['read','write','delete']
+
+
+# The admin is special and can do anything
+class Administrator
+    constructor: ->
+        UserRole.prototype.constructor.apply(this,arguments)
+    can: -> true
+
+    decodeLockedFields: ->
+        {}
+
+RoleMap = {
+    "administrator": Administrator
+}
+
+
+class Lanes.Models.UserRoleSet
+
+    constructor: (access={})->
+        _.defaults(access, { roles: [], locked_fields: [] })
+        @roles = []
+        @locked_fields = {}
+        for role in access.roles
+            klass = RoleMap[role.type] || UserRole
+            role = new klass(role)
+            @roles.push( role )
+            @locked_fields = role.decodeLockedFields(access.locked_fields, @locked_fields)
+
+    can:(method,model,field)->
+        if model instanceof Lanes.Models.Base
+            model = model.constructor
+
+        if field && ( locks = @locked_fields[model] ) && ( grants = locks[field] )
+            for grant in grants
+                if grant.only && grant.only != method
+                    return this.testModelAccess(method,model)
+                else
+                    for role in @roles
+                        return true if role.type == grant.role
+            return false
+        else
+            return this.testModelAccess(method,model)
+
+    testModelAccess:(method,model)->
+        !!_.detect( @roles, (role)->role.can(method,model) )
+
+    canRead:(model,field)->
+        this.can('read',model,field)
+
+    canWrite:(model,field)->
+        this.can('write',model,field)
+
+    canDelete:(model)->
+        this.can('delete',model)
+
+klassFor = (identifier)->
+    Lanes.u.getPath(identifier) ||
+        Lanes.warn("Model #{identifier} not found for role")

data/client/lanes/access/User.coffee

@@ -0,0 +1,72 @@
+class Lanes.Models.User extends Lanes.Models.Base
+
+    constructor: (attributes,access)->
+        super
+        this.access_data = access
+
+    api_path: 'users'
+    derived:
+        roles:
+            deps: ['role_names', 'access_data']
+            fn: -> new Lanes.Models.UserRoleSet( @access_data )
+        isLoggedIn:
+            deps:['id'], fn: -> !!this.id
+        allRoles:
+            deps: ['role_names', 'access_data']
+            fn: ->
+                role_data = Lanes.Models.Roles.all?.toJSON() || []
+                roles = new Lanes.Models.Roles( role_data )
+                _.each( this.role_names, (name)->
+                    roles.get(name)?.member = true
+                )
+                roles
+
+    session:
+        access_data: 'object'
+
+    props:
+        id:         { type: "integer", required:true }
+        login:       'string'
+        name:        'string'
+        email:       'string'
+        role_names: { type: 'array', default: -> [] }
+        options:     'object'
+        password:    'string'
+
+    canRead: (model,field)  -> this.roles.canRead(model,field)
+    canWrite: (model,field) -> this.roles.canWrite(model,field)
+    canDelete: (model)      -> this.roles.canDelete(model)
+
+    logout: ->
+        session = new Session( id: this.id )
+        session
+            .destroy()
+            .then =>
+                _.each(@attributes, (value,key)=> @set(key, null) )
+
+    setLoginData: (attrs, access)->
+        this.access_data = access
+        this.set(attrs)
+
+    @attemptLogin: (login, password, options)->
+        session = new Session( login: login, password: password )
+        success = options.success
+        session.save(_.extend(options,{
+            success: (reply)->
+                Lanes.current_user.setLoginData(session.user, session.access)
+                success.apply(options.scope, arguments)
+        }))
+        session
+
+class Lanes.Models.UserCollection extends Lanes.Models.Collection
+    model: Lanes.Models.User
+
+
+class Session extends Lanes.Models.Base
+    api_path: 'user-session'
+    props:
+        id:         'integer'
+        login:      'string'
+        password:   'string'
+        access:     'object'
+        user:       'object'

data/client/lanes/access/index.js

@@ -0,0 +1,5 @@
+//=require ./User
+//=require ./Roles
+//=require ./LoginDialog
+//=require ./login-dialog
+//=require ./Extension

data/client/lanes/access/login-dialog.html

@@ -0,0 +1,16 @@
+<div class="row">
+  <div style="display:none" class="alert alert-danger" role="alert"></div>
+  <div class="<%= h.grid_offsets(0,2) %> <%= h.grid_widths 12, 8%>">
+        <form role="form">
+            <div class="form-group">
+                <label for="LoginField">Login</label>
+                <input type="email" id="LoginField" value="admin" class="form-control login" placeholder="Enter Login">
+            </div>
+            <div class="form-group">
+                <label for="PasswordField">Password <a href="/sessions/forgot_password">(forgot password)</a></label>
+                <input type="password" id="PasswordField" value="password" class="form-control password" placeholder="Password">
+            </div>
+
+        </form>
+    </div>
+</div>

data/client/lanes/access/screens/user-management/GridUserEditor.coffee

@@ -0,0 +1,25 @@
+class Lanes.Access.Screens.UserManagement.GridUserEditor extends Lanes.Components.Grid.PopOverEditor
+
+    writeTemplateName: 'user-management/grid-popover-editor'
+    templatePrefix: 'lanes/access/screens'
+
+    writeTemplateData: ->
+        { columns: _.reject(this.grid.columnDefinitions,(f)-> f.field=='role_names') }
+
+    subviews:
+        roles:
+            component: 'SelectField'
+            model: 'model'
+            options: 'roleOptions'
+
+    roleOptions: ->
+        { multiple: true, data: this.model.allRoles, mappings:{ title: 'name', selected: 'member' } }
+
+    constructor: (options={})->
+        super( _.extend(options,{formBindings: true}) )
+
+    persistFields: ->
+        @model.set({
+            role_names: _.pluck(this.$('select option:selected'), 'value'),
+            password:  this.$('input[name=password]').val()
+        })

data/client/lanes/access/screens/user-management/UserManagement.coffee

@@ -0,0 +1,24 @@
+class Lanes.Access.Screens.UserManagement extends Lanes.Screens.Base
+
+    templateName: 'user-management/screen'
+    templatePrefix: 'lanes/access/screens'
+    FILE: FILE
+
+    subviews:
+        grid:
+            component: 'Grid'
+            options: 'gridOptions'
+
+    gridOptions: ->
+        {
+            recordQuery: new Lanes.Models.Query({
+                modelClass: Lanes.Models.User,
+                fields: [ 'login', 'name', 'email', 'role_names' ]
+            }),
+            editorConfig: {}
+            editRecords: true
+            editingController: Lanes.Access.Screens.UserManagement.GridUserEditor
+            selectionMode: 'single',
+            addRecords: true
+            deleteRecords: true
+        }

data/client/lanes/access/screens/user-management/grid-popover-editor.html

@@ -0,0 +1,33 @@
+<form class="user-edit form-horizontal" role="form">
+<% for field in @columns: %>
+  <div class="form-group">
+    <label for="field-<%= field.field %>" class="col-sm-3 control-label"><%= field.title %></label>
+    <div class="col-sm-9">
+      <input type="text" name="<%= field.field %>" class="form-control" id="field-<%= field.field %>" placeholder="">
+    </div>
+  </div>
+<% end %>
+
+  <div class="form-group">
+    <label for="field-password" class="col-sm-3 control-label">Roles</label>
+    <div class="col-sm-9">
+      <div data-hook="roles"></div>
+    </div>
+  </div>
+
+  <div class="form-group">
+    <label for="field-password" class="col-sm-3 control-label">Password</label>
+    <div class="col-sm-9">
+      <input type="password" name="password" class="form-control" id="field-password" placeholder="">
+    </div>
+  </div>
+
+  <div class="buttons">
+    <button type="button" class="btn btn-default cancel">
+      <i class="icon-cancel-circle"> Cancel</i>
+    </button>
+    <button type="button" class="btn btn-primary save">
+      <i class="icon-save"> Save</i>
+    </button>
+  </div>
+</form>

data/client/lanes/access/screens/user-management/index.js

@@ -0,0 +1,3 @@
+//= require ./UserManagement
+//= require ./GridUserEditor
+//= require_tree .

data/client/lanes/access/screens/user-management/index.scss

@@ -0,0 +1,7 @@
+.lanes {
+
+    .grid-popover-editor {
+        width: 350px;
+    }
+
+}

data/client/lanes/access/screens/user-management/screen.html

@@ -0,0 +1,7 @@
+<div class="users">
+  <h3>Manage User Accounts</h3>
+
+  <div class="grid" data-hook="grid">
+  </div>
+
+</div>

data/client/lanes/components/Base.coffee

@@ -1,10 +1,12 @@
 class BaseComponent
+    abstractClass: true
 
     constructor: (options={})->
         super
         @access ||= this.calculate_access()
 
     session:
+        field_name: { 'string', setOnce: true }
         access:
             type: 'string',
             values: ['read','write','none']
@@ -15,7 +17,7 @@ class BaseComponent
 
     emptyTemplateName: -> this.writeTemplate()
     readTemplateName:  -> this.writeTemplate()
-    writeTemplateName: -> 'lanes/views/empty-span'
+    writeTemplateName: -> 'empty-span'
 
     renderContextFree: ->
         tmpl = if this.writeAble
@@ -24,11 +26,8 @@ class BaseComponent
             'readTemplate'
         else
             'emptyTemplate'
-
         this.replaceEl( this.renderTemplateMethod(tmpl) );
 
-    templatePrefix: -> this.FILE.extensionName.toLowerCase() + "/components/"
-
     calculate_access:->
         if ! @field_name || Lanes.Views.RenderContext.canWrite(@field_name)
             'write'

data/client/lanes/components/enabled.js.erb

@@ -1,3 +1,5 @@
 <% Lanes::Components.enabled_with_dependencies(self) do | component |
     require_asset "lanes/components/#{component}"
 end %>
+
+<% Lanes::Screen.uncache_file_on_update(self) %>

data/client/lanes/components/grid/Editor.coffee

@@ -3,7 +3,7 @@ class Lanes.Components.Grid.Editor extends Lanes.Components.Base
     session:
         grid: 'object' # n.b. - not 'state'.  Doing so causes stack overflow since grid also has a 'editor' session var
 
-    events:
+    domEvents:
         'click .save':   'saveChanges'
         'click .cancel': 'cancelEditing'
 

data/client/lanes/components/grid/Grid.coffee

@@ -8,8 +8,9 @@ _.extend( Lanes.$.fn.dataTableExt.oStdClasses,{
 
 
 class Lanes.Components.Grid extends Lanes.Components.Base
+    FILE: FILE
 
-    events:
+    domEvents:
         'click button.refresh': 'reload'
         'click button.delete':  'deleteRow'
         'click button.create':  'addRow'
@@ -17,7 +18,7 @@ class Lanes.Components.Grid extends Lanes.Components.Base
         'cancel-edit': 'onCancelEdit'
         'order.dt table': 'onSort'
 
-    writeTemplateName: 'grid/template'
+    writeTemplateName: 'template'
 
     writeTemplateData: ->
         data = { grid: this, buttons: ['refresh'] }
@@ -31,7 +32,8 @@ class Lanes.Components.Grid extends Lanes.Components.Base
                 @recordQuery.fields.map(this._makeField, this)
 
         modelClass:
-             deps:['recordQuery'], fn:-> @recordQuery.model_class
+             deps:['recordQuery'], fn:->
+                 @recordQuery?.modelClass
 
         singleSelectMode:
              deps:['selectionMode'], fn:-> @selectionMode == 'single'
@@ -48,7 +50,8 @@ class Lanes.Components.Grid extends Lanes.Components.Base
         editingController:  'any' # either string or constructor fn
 
     initialize: ->
-        this.listenTo(this.viewport,'change:screen_enu_size', this.delayedWidthReset)
+        if this.viewport
+            this.listenTo(this.viewport,'change:screen_enu_size', this.adjustColumnWidth)
         unless Lanes.current_user.canWrite(this.modelClass)
             this.editRecords = false
             this.addRecords  = false
@@ -76,7 +79,7 @@ class Lanes.Components.Grid extends Lanes.Components.Base
 
     unselect: (row)->
         this.$el.trigger('unselect-row', [@modelForRow(row), {row:row}])
-        row.removeClass('active')
+        Lanes.dom.removeClass(row,'active')
 
     beginEdit: (row,ev)->
         return false unless model = this.modelForRow(row)
@@ -116,14 +119,14 @@ class Lanes.Components.Grid extends Lanes.Components.Base
         row = this.$(ev.target).closest('tr')
         if this.editRecords
             this.beginEdit(row,ev)
-        else if @singleSelectMode
-            this.unselect(row) for row in this.$('tr .active')
+        if @singleSelectMode
+            this.unselect(selected) for selected in this.$('tr.active')
+
+        if row.hasClass('active')
+            this.unselect(row)
         else
-            if row.hasClass('active')
-                this.unselect(row)
-            else
-                row.addClass('active')
-                this.$el.trigger('select-row', {model:model, row:row} ) if model = this.modelForRow(row)
+            row.addClass('active')
+            this.$el.trigger('select-row', model, row ) if model = this.modelForRow(row)
 
     updateRow: (row, model)->
         row.attr('id', model.id)
@@ -135,17 +138,14 @@ class Lanes.Components.Grid extends Lanes.Components.Base
         return data.model if data.model?.isModel
         attrs = if row.attr('id') then { id: parseInt(row.attr('id')) } else {}
         for field,i in @columnDefinitions
-            attrs[field.field] = data[i]
+            attrs[field.id] = data[i]
         data.model = new @modelClass(attrs,ignoreUnsaved:true)
 
-    delayedGridConfiguration: ->
-        _.delay( =>
-            @dt_api.columns.adjust()
-        ,500 )
+    adjustColumnWidth: ->
+        @dt_api.columns.adjust()
+
 
-    render: ->
-        super
-        responsiveHelper = undefined;
+    onRender: ->
         breakpointDefinition = {
             tablet: 1024,
             phone : 480
@@ -161,7 +161,7 @@ class Lanes.Components.Grid extends Lanes.Components.Base
             oScroller: { loadingIndicator: true }
             ajax:
                 url: @recordQuery.url + ".json"
-                data: (d)=>@buildModels(d)
+                data: (d)=>@buildQuery(d)
                 dataSrc: (d)->
                     d.recordsFiltered = d.recordsTotal = d.total
                     row.DT_RowId = row.shift() for row in d.data
@@ -172,19 +172,18 @@ class Lanes.Components.Grid extends Lanes.Components.Base
             columns: @columnDefinitions
         )
         this.dt_api = this.dataTable.api()
-        this.delayedGridConfiguration()
         this
 
-    buildModels: (d)->
+    buildQuery: (d)->
         params = {
             o: {}, s: d.start, l: d.length||100, df:'array',
-            f: ['id'].concat(_.pluck(@columnDefinitions, 'field'))
+            f: ['id'].concat(_.pluck(@columnDefinitions, 'id'))
         }
         if ! _.isEmpty( query = @recordQuery.asParams() )
             params['q']=query
         for order in d.order
             column = @recordQuery.fields.at(order.column)
-            params['o'][column.field] = order.dir
+            params['o'][column.id] = order.dir
         params
 
 
@@ -192,10 +191,10 @@ class Lanes.Components.Grid extends Lanes.Components.Base
         align = switch query_field.type
             when 'integer','bigdec' then 'r'
             else 'l'
-        { title: query_field.title, field: query_field.field, className: align, "targets": [ index ] }
+        { title: query_field.title, id: query_field.id, className: align, "targets": [ index ] }
 
     _dataFromModel: (model)->
         data = []
         for field,i in @columnDefinitions
-            data.push( model.get(field.field) || '' )
+            data.push( model.get(field.id) || '' )
         data

data/client/lanes/components/grid/template.html

@@ -1,4 +1,4 @@
-<div class="lanes-grid">
+<div class="lanes-grid grid">
   <% if @grid.editRecords: %><%= h.toolbar( buttons: @buttons ) %><% end %>
   <table cellspacing="0" width="100%"></table>
 </div>