neat-rails 0.2.0 → 0.5.0

data/lib/neat/rails/version.rb

@@ -1,5 +1,5 @@
 module Neat
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.5.0"
   end
 end

data/vendor/assets/javascripts/neat/collection_editor.coffee

@@ -15,13 +15,12 @@ KEYS = {
 #   viewPath - by default this is set to resource
 #
 class window.Neat.CollectionEditor extends Backbone.View
-  sortOrder: 'asc'
-  sortAliases: {}
   templateOptions: {}
-  pageSize: 30
   useKeyboardToChangeRows: true
   cancelOnEsc: true
   saveOnEnter: true
+  renderer: "Basic"
+  rendererOptions: {}
 
   initialize: ->
     @keyDownHandlers = {}
@@ -36,41 +35,15 @@ class window.Neat.CollectionEditor extends Backbone.View
     @debug "looking for template at #{"#{@viewPath}/index"}"
     @template = @template ? Neat.template["#{@viewPath}/index"]
 
-    @paginator = new window.Lail.PaginatedList [],
-      page_size: if window.Neat.forPrint then Infinity else @pageSize
-      always_show: false
-    @paginator.onPageChange _.bind(@renderPage, @)
-
-    @collection.bind 'reset',   @__reset, @
-    @collection.bind 'add',     @__add, @
-    @collection.bind 'remove',  @__remove, @
-
-    # We need to rerender the page if a model's attributes
-    # have changed just in case this would affect how the
-    # models are sorted.
-    #
-    # !todo: perhaps we can be smarter here and only listen
-    # for changes to the attribute the view is sorted on.
-    #
-    # We don't want to redraw the page every time a model
-    # has changed. If an old transaction is deleted, a very
-    # large number of more recent transactions' running
-    # balances could be updated very rapidly. Redrawing the
-    # page will slow things down dramatically.
-    #
-    # Instead, redraw the page 500ms after a model has changed.
-    #
-    # This allows us to wait for activity to die down
-    # and to redraw the page when it's more likely the system
-    # has settled into new state.
-    #
-    @delayedRerender = new Lail.DelayedAction(_.bind(@rerenderPage, @), delay: 500)
-    @collection.bind 'change', =>
-      @delayedRerender.trigger() if @sortedBy
-
-    # If the view's headers are 'a' tags, this view will try
-    # to sort the collection using the header tags.
-    $(@el).delegate '.header a', 'click', _.bind(@sort, @)
+    # For backwards-compatibility
+    @rendererOptions.pageSize = @pageSize if @pageSize?
+
+    rendererKlass = @renderer
+    rendererKlass = Neat.Renderer[rendererKlass] if _.isString(rendererKlass)
+    @_renderer = new rendererKlass(@, @collection, @rendererOptions)
+
+    @_renderer.afterRender _.bind(@afterRender, @)
+
     $(@el).delegate '.editor', 'keydown', _.bind(@onKeyDown, @)
 
     if @cancelOnEsc
@@ -83,37 +56,19 @@ class window.Neat.CollectionEditor extends Backbone.View
       @keyDownHandlers['UP']     = -> @edit @prevView()
       @keyDownHandlers['DOWN']   = -> @edit @nextView()
 
-    @views = []
     @viewInEdit = null
     @templateOptions = {}
 
-  repaginate: ->
-    @rerenderPage(1)
 
-  rerenderPage: (page)->
-    page = @paginator.getCurrentPage() unless _.isNumber(page)
-    if @sortedBy
-      sortField = @sortField(@sortedBy)
-      items = @collection.sortBy (model)->
-        val = model.get(sortField) || ''
-        if _.isString(val) then val.toLowerCase() else val
-      items.reverse() if @sortOrder == 'desc'
-    else
-      items = @collection.toArray()
-    @paginator.init items, page
 
 
   render: ->
     $el = $(@el)
     $el.html @template(@context())
     $el.cssHover '.neat-row.neat-interactive'
+    @$ul = $(@el).find("##{@resource}")
 
-    @afterRender()
-
-    @updateSortStyle() if @sortedBy
-
-    @paginator.renderPaginationIn($el.find('.pagination'))
-    @repaginate()
+    @_renderer.renderTo @$ul
     @
 
   context: ->
@@ -122,32 +77,21 @@ class window.Neat.CollectionEditor extends Backbone.View
   afterRender: ->
     @
 
-  renderPage: ->
-    alt = false
-    $ul = $(@el).find("##{@resource}").empty() # e.g. $('#calendars')
-    @views = []
+  buildViewFor: (model) ->
     self = @
-
-    $(@el).find('.extended-pagination').html(@paginator.renderExtendedPagination())
-
-    for model in @paginator.getCurrentSet()
-      view = @constructModelView # e.g. window.CalendarView
-        resource: @resource
-        viewPath: @viewPath
-        model: model
-        templateOptions: @templateOptions
-      view.bind 'edit:begin', -> self.beforeEdit.call(self, @)
-      view.bind 'edit:end', -> self.afterEdit.call(self, @)
-
-      @views.push(view)
-
-      $el = $(view.render().el)
-      $el.toggleClass 'alt', !(alt = !alt)
-      $ul.append $el
-    @
+    view = @constructModelView
+      resource: @resource
+      viewPath: @viewPath
+      model: model
+      templateOptions: @templateOptions
+    view.bind 'edit:begin', -> self.beforeEdit.call(self, @)
+    view.bind 'edit:end', -> self.afterEdit.call(self, @)
+    view
 
   constructModelView: (options) ->
-    new @modelView options
+    viewClass = @modelView
+    viewClass = viewClass(options.model) if _.isFunction(viewClass) and !(viewClass.prototype instanceof Neat.ModelEditor)
+    new viewClass(options)
 
 
   beforeEdit: (view)->
@@ -162,33 +106,6 @@ class window.Neat.CollectionEditor extends Backbone.View
 
 
 
-  sort: (e)->
-    e.preventDefault()
-    e.stopImmediatePropagation()
-    sortBy = $(e.target).closest('a').attr('class').substring(@singular.length + 1)
-    @log "sort by #{sortBy} [#{@sortField(sortBy)}]"
-    if @sortedBy == sortBy
-      @sortOrder = if @sortOrder == 'asc' then 'desc' else 'asc'
-    else
-      @removeSortStyle @sortedBy
-      @sortedBy = sortBy
-    @repaginate()
-    @updateSortStyle()
-    false
-
-  removeSortStyle: (field)->
-
-  updateSortStyle: ()->
-    @removeSortStyle @sortedBy
-
-  getHeader: (field)->
-    $(@el).find(".header > .#{@singular}-#{field}")
-
-  sortField: (field)->
-    @sortAliases[field] ? field
-
-
-
   onKeyDown: (e)->
     keyName = @identifyKey(e.keyCode)
     handler = @keyDownHandlers[keyName]
@@ -203,18 +120,21 @@ class window.Neat.CollectionEditor extends Backbone.View
     # i.e. return true if target is in a dropdown control like Chosen
     false
 
-
+  views: ->
+    @_renderer.views
 
   nextView: ->
-    @views[@indexOfViewInEdit() + 1]
+    @views()[@indexOfViewInEdit() + 1]
 
   prevView: ->
-    @views[@indexOfViewInEdit() - 1]
+    @views()[@indexOfViewInEdit() - 1]
 
   indexOfViewInEdit: ->
-    _.indexOf @views, @viewInEdit
+    _.indexOf @views(), @viewInEdit
 
   edit: (view)->
+    if view instanceof Backbone.Model
+      view = @_renderer.findViewForModel(view)
     if view
       @viewInEdit?.save()
       view.edit()
@@ -224,18 +144,6 @@ class window.Neat.CollectionEditor extends Backbone.View
     @viewInEdit?.cancelEdit()
 
 
-
-  __reset: ->
-    @render()
-
-  __add: ->
-    @rerenderPage()
-
-  __remove: ->
-    @rerenderPage()
-
-
-
   debug: (o...)->
     @log(o...) if Neat.debug
 

data/vendor/assets/javascripts/neat/lib/jquery_extensions.coffee

@@ -1,5 +1,5 @@
 $.fn.extend
-  cssHover: (selector)->
+  cssHover: (selector) ->
     if arguments.length == 0
       @hover(
         -> $(@).addClass('hovered'),
@@ -11,5 +11,13 @@ $.fn.extend
         else
           $(@).removeClass('hovered')
 
-  isIn: (selector)->
+  isIn: (selector) ->
     @is(selector) or (@parents(selector).length > 0)
+
+  insertBeforeChildOrAppendTo: (parent, selector) ->
+    $parent = $ parent
+    $insertionPoint = $parent.children(selector)
+    if $insertionPoint.length > 0
+      $insertionPoint.before @
+    else
+      $parent.append @

data/vendor/assets/javascripts/neat/lib/scroll_handler.coffee

@@ -0,0 +1,33 @@
+class @Neat.ScrollHandler
+  _.extend @prototype, Backbone.Events
+
+  constructor: (options={})->
+    @$viewPort = $(options.viewPort ? window)
+    @$document = $(document)
+    @$viewPort.scroll _.bind(@_windowWasScrolled, @)
+
+  _viewportHeight: ->
+    @$viewPort.height()
+
+  _documentHeight: ->
+    if $.isWindow @$viewPort[0]
+      @$document.height()
+    else
+      @$viewPort[0].scrollHeight
+
+  _windowWasScrolled: ->
+    viewportHeight = @_viewportHeight()
+    documentHeight = @_documentHeight()
+
+    scrollTop = @$viewPort.scrollTop()
+    scrollMax = documentHeight - viewportHeight
+    progress = scrollTop / scrollMax
+    distanceFromBottom = scrollTop - scrollMax
+
+    return if scrollMax <= 0
+
+    @trigger "scroll",
+      scrollTop: scrollTop
+      scrollMax: scrollMax
+      progress: progress
+      distanceFromBottom: distanceFromBottom

data/vendor/assets/javascripts/neat/model_editor.coffee

@@ -1,6 +1,7 @@
 class window.Neat.ModelEditor extends Backbone.View
   tagName: 'li'
   className: 'neat-row neat-interactive neat-editable'
+  waitOnSave: true
 
   initialize: (options)->
     options = options ? {}
@@ -82,7 +83,7 @@ class window.Neat.ModelEditor extends Backbone.View
       previousAttributes = @model.toJSON()
 
       @model.save attributes,
-        wait: true
+        wait: @waitOnSave
         success: =>
           for attribute, newValue of attributes
             @debug "  . #{attribute} changed from ", previousAttributes[attribute], " to ", @model.get(attribute)
@@ -94,26 +95,42 @@ class window.Neat.ModelEditor extends Backbone.View
   okToSave: (attributes)->
     true
 
-  attributesFromForm: ($el)->
+  attributesFromForm: ($el) ->
     attrs = {}
     $el.find('input, select, textarea').each ->
-      elem = $(this)
+      elem = $(@)
       name = elem.attr('name')
-      if name
-        elemType = elem.attr('type')
-        value = elem.val()
-
-        if name.substr(-2) == '[]'
-          name = name.substring(0, name.length - 2)
-          attrs[name] = attrs[name] || []
-          attrs[name].push elem.val()
-
-        else if elemType == 'checkbox' || elemType == 'radio'
-          attrs[name] = '' if typeof(attrs[name]) == 'undefined'
-          attrs[name] = value if elem.prop('checked')
-
-        else
-          attrs[name] = value
+      elemType = elem.attr('type')
+      value = elem.val()
+      return true unless name
+
+      # Parse out nested objects as represented in names
+      # person[address][zip]=63303 should be serialized to:
+      # person:
+      #   address:
+      #     zip: 63303
+      parts = _.without(name.split(/\[([^\]]+)\]/), '')
+      name = parts.pop()
+      isArray = false
+      while name is '[]'
+        isArray = true
+        name = parts.pop()
+      context = attrs
+      for part in parts
+        context = context[part] or (context[part] = {})
+
+      if (elemType == 'checkbox' || elemType == 'radio') && !elem.prop('checked')
+        return true
+
+      if isArray
+        # select with multiple=true will return
+        # an array of selected values, so we don't
+        # need to nest that array in another array
+        value = [value] unless _.isArray(value)
+        value = (context[name] || []).concat(value)
+
+      context[name] = value
+      true # Don't break out of the loop
     attrs
 
   destroy: (e)->
@@ -123,8 +140,8 @@ class window.Neat.ModelEditor extends Backbone.View
 
       @model.destroy
         wait: true
-        success: => @onDestroySuccess
-        error: _.bind(@onSaveError, @)
+        success: _.bind(@onDestroySuccess, @)
+        error: _.bind(@onDestroyError, @)
       @endEdit()
 
   confirmDestroy: (resource, callback)->

data/vendor/assets/javascripts/neat/renderer/basic.coffee

@@ -0,0 +1,102 @@
+class window.Neat.Renderer.Basic
+
+  constructor: (@view, @collection, @options) ->
+    @collection.bind 'reset',   @_collectionHasBeenReset, @
+    @collection.bind 'sort',    @_collectionHasBeenSorted, @
+    @collection.bind 'add',     @_modelHasBeenAddedToCollection, @
+    @collection.bind 'remove',  @_modelHasBeenRemovedFromCollection, @
+    @collection.bind 'change',  @_modelHasBeenChanged, @
+    @views = []
+    @observer = new Observer()
+
+  renderTo: (@$ul) ->
+    @views = []
+    @_render()
+
+  findViewForModel: (model)->
+    @views[@_indexOfViewForModel(model)]
+
+  afterRender: (callback) ->
+    @observer.observe "after_render", callback
+
+  _render: ->
+    # Doesn't need to render anything else like pagination controls on the view
+    # Just needs the @$ul that it should render views to
+    @_renderVisibleModels()
+
+  _renderVisibleModels: ->
+    visibleModels = @_visibleModels()
+
+    # Remove views that no longer correspond to visible models.
+    viewIndex = 0
+    while viewIndex < @views.length
+      if _.contains(visibleModels, @views[viewIndex].model)
+        viewIndex += 1
+      else
+        @_removeView(viewIndex)
+
+    # Add views for newly-visible models; and coerce views
+    # (and their corresponding DOM elements) to show up in
+    # the same order as the visible models.
+    for model, index in visibleModels
+      viewIndex = @_indexOfViewForModel(model)
+      if viewIndex >= 0
+        @_moveView(viewIndex, index) unless viewIndex is index
+      else
+        @_insertView @view.buildViewFor(model), index
+
+    @observer.fire "after_render"
+    @
+
+  _insertView: (view, newIndex) ->
+    view.render()
+    $(view.el).insertBeforeChildOrAppendTo @$ul, ".neat-row:eq(#{newIndex})"
+    @views.splice(newIndex, 0, view)
+    @_viewAddedAt(view, newIndex)
+
+  _moveView: (oldIndex, newIndex) ->
+    $el = $ @views[oldIndex].el
+    $el.detach().insertBeforeChildOrAppendTo @$ul, ".neat-row:eq(#{newIndex})"
+
+    view = @views.splice(oldIndex, 1)[0]
+    @views.splice(newIndex, 0, view)
+    @_viewRemovedAt(view, oldIndex)
+    @_viewAddedAt(view, newIndex)
+
+  _removeView: (oldIndex) ->
+    @views[oldIndex].remove()
+    view = @views.splice(oldIndex, 1)[0]
+    @_viewRemovedAt(view, oldIndex)
+
+
+
+  _viewAddedAt: (view, index) ->
+    # do nothing
+
+  _viewRemovedAt: (view, index) ->
+    # do nothing
+
+
+
+  _visibleModels: ->
+    @collection.toArray()
+
+  _indexOfViewForModel: (model)->
+    _.findIndex @views, (view)-> view.model.cid is model.cid
+
+
+
+  _collectionHasBeenReset: ->
+    @_render()
+
+  _collectionHasBeenSorted: ->
+    @_render()
+
+  _modelHasBeenAddedToCollection: ->
+    @_render()
+
+  _modelHasBeenRemovedFromCollection: ->
+    @_render()
+
+  _modelHasBeenChanged: (model) ->
+    # do nothing

data/vendor/assets/javascripts/neat/renderer/infinite_reveal.coffee

@@ -0,0 +1,37 @@
+class window.Neat.Renderer.InfiniteReveal extends window.Neat.Renderer.Basic
+
+  constructor: (@view, @collection, @options) ->
+    super
+    @scrollHandler = new Neat.ScrollHandler()
+    @scrollHandler.on "scroll", _.bind(@_windowHasBeenScrolled, @)
+
+    @sensitivity = @options.sensitivity ? 5
+    @pageSize = @options.pageSize ? 50
+
+
+
+  _render: ->
+    @_setMaxItems @pageSize
+    super
+
+  _visibleModels: ->
+    @collection.models[0...@maxItems]
+
+  _loadMore: ->
+    Neat.logger.log "[Neat.Renderer.InfiniteReveal] loading..."
+    @_setMaxItems @maxItems + @pageSize
+    @_renderVisibleModels()
+
+  _thereIsMore: ->
+    @collection.length > @maxItems
+
+
+
+  _setMaxItems: (value) ->
+    @maxItems = Math.min value, @collection.length
+
+  _windowHasBeenScrolled: (e) ->
+    return unless @_thereIsMore()
+    return unless Math.abs(e.distanceFromBottom) <= @sensitivity
+    return unless @view.$el.is(':visible')
+    @_loadMore()

data/vendor/assets/javascripts/neat/renderer/paginated.coffee

@@ -0,0 +1,41 @@
+class window.Neat.Renderer.Paginated extends window.Neat.Renderer.Basic
+
+  constructor: (@view, @collection, @options) ->
+    super
+    @paginator = new window.Lail.PaginatedList [],
+      page_size: if window.Neat.forPrint then Infinity else @options.pageSize
+      always_show: false
+    @paginator.onPageChange _.bind(@_renderPage, @)
+
+
+
+  _render: ->
+    @paginator.renderPaginationIn(@view.$el.find('.pagination'))
+    @_repaginate()
+
+  _repaginate: ->
+    @_rerenderPage(1)
+
+  _rerenderPage: (page)->
+    page = @paginator.getCurrentPage() unless _.isNumber(page)
+    items = @collection.toArray()
+    @paginator.init items, page
+
+  _renderPage: ->
+    @view.$el.find('.extended-pagination').html(@paginator.renderExtendedPagination())
+    @_renderVisibleModels()
+
+  _visibleModels: ->
+    @paginator.getCurrentSet()
+
+  _collectionHasBeenSorted: ->
+    @_repaginate()
+
+  _modelHasBeenAddedToCollection: ->
+    @_rerenderPage()
+
+  _modelHasBeenRemovedFromCollection: ->
+    @_rerenderPage()
+
+  _modelHasBeenChanged: ->
+    @_rerenderPage()

data/vendor/assets/javascripts/neat.js

@@ -8,12 +8,16 @@
 //= require ./neat/lib/inflect
 //= require ./neat/lib/observer
 //= require ./neat/lib/paginated_list
-//= require ./neat/lib/delayed_action
 //= require ./neat/lib/jquery_extensions
+//= require ./neat/lib/scroll_handler
+//= require ./neat/renderer/basic
+//= require ./neat/renderer/paginated
+//= require ./neat/renderer/infinite_reveal
 //= require ./neat/collection_editor
 //= require ./neat/model_editor
 
 window.Neat = window.Neat || {}
+window.Neat.Renderer = window.Neat.Renderer || {}
 window.Neat.debug = true;
 window.Neat.logger = {
   log: function() {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neat-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -47,12 +47,15 @@ files:
 - neat-rails.gemspec
 - vendor/assets/javascripts/neat.js
 - vendor/assets/javascripts/neat/collection_editor.coffee
-- vendor/assets/javascripts/neat/lib/delayed_action.js
 - vendor/assets/javascripts/neat/lib/inflect.js
 - vendor/assets/javascripts/neat/lib/jquery_extensions.coffee
 - vendor/assets/javascripts/neat/lib/observer.js
 - vendor/assets/javascripts/neat/lib/paginated_list.js
+- vendor/assets/javascripts/neat/lib/scroll_handler.coffee
 - vendor/assets/javascripts/neat/model_editor.coffee
+- vendor/assets/javascripts/neat/renderer/basic.coffee
+- vendor/assets/javascripts/neat/renderer/infinite_reveal.coffee
+- vendor/assets/javascripts/neat/renderer/paginated.coffee
 homepage: ''
 licenses: []
 post_install_message: 
@@ -67,7 +70,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2435929593431474536
+      hash: -2190152860109017268
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -76,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2435929593431474536
+      hash: -2190152860109017268
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2

data/vendor/assets/javascripts/neat/lib/delayed_action.js

@@ -1,49 +0,0 @@
-var Lail; if(!Lail) Lail={};
-Lail.DelayedAction = function(callback, options) {
-  // !todo: paste John Resig's code
-
-  options = options || {};
-  var self           = this,
-      delay          = options.delay || 1000,
-      steps          = options.steps || 10,
-      intervalPeriod = delay / steps,
-      counter        = 0,
-      _params,
-      _interval;
-
-  this.trigger = function(params) {
-    _params = params;
-    restartCountdown();
-  }
-
-  function restartCountdown() {
-    counter = steps;
-    if(!_interval) {
-      _interval = setInterval(countdown, intervalPeriod);
-    }
-  }
-
-  function countdown() {
-    if(counter > 0) {
-      counter = counter - 1;
-    } else {
-      stopCountdown()
-      fireCallback();
-    }
-  }
-
-  function stopCountdown() {
-    if(_interval) {
-      clearInterval(_interval);
-      _interval = null;
-    }
-  }
-
-  function fireCallback() {
-    try {
-      callback(_params);
-    } catch(e) {
-      App.debug(e);
-    }
-  }
-}