spine_paginator 0.1.0 → 0.1.1

data/src/spine.pagination_controller.coffee

@@ -0,0 +1,119 @@
+Spine  = @Spine or require('spine')
+
+###
+
+Usage
+
+see https://github.com/vkill/spine_paginator/examples/spine_pagination.coffee
+
+###
+
+
+class Spine.PaginationController extends Spine.Controller
+
+  @MODEL = null
+  @PER_PAGES = [10, 20, 30, 40]
+  @PAGINATE_EVENT = "paginate"
+  
+  @PAGE = 1
+  @PER_PAGE = null
+  @PAGINATION = null
+
+  constructor: ->
+    super
+    throw new Error("please defined class variable MODEL") unless @constructor.MODEL?
+    @constructor.PER_PAGE = @constructor.PER_PAGES[0]
+    throw new Error("please defined class variable PER_PAGES") unless @constructor.PER_PAGE?
+    @constructor.MODEL.bind @constructor.PAGINATE_EVENT, @render
+  
+  @refresh: ->
+    @PAGE = 1
+    @load()
+
+  @toPage: (page)->
+    @PAGE = page
+    @load()
+
+  @load: ->
+    pagination = @MODEL.page(@PAGE, {perPage: @PER_PAGE})
+    @PAGINATION = pagination
+    @MODEL.trigger(@PAGINATE_EVENT)
+
+
+  render: =>
+    pagination = @constructor.PAGINATION
+    if pagination.records.length > 0
+      @html @templateHtml()
+    else
+      @html @templateHtmlDataEmpty()
+
+  # 
+  # custom
+  # 
+  events:
+    'click a[data-page]': 'clickPage'
+  
+
+  clickPage: (e)->
+    e.preventDefault()
+
+    page = @getPageFromE(e)
+    return unless page?
+    @constructor.toPage(page)
+  
+  getPageFromE: (e) ->
+    $node = $(e.target)
+    return null if $node.parent('.disabled, .active').length > 0
+    _page = $node.data('page')
+
+    page = null
+    switch _page
+      when 'first'
+        page = @constructor.PAGINATION.firstPage()
+      when 'prev'
+        page = @constructor.PAGINATION.currentPage() - 1
+      when 'next'
+        page = @constructor.PAGINATION.currentPage() + 1
+      when 'last'
+        page = @constructor.PAGINATION.lastPage()
+      when 'gap'
+        page = null
+      else
+        page = _page
+    page
+  
+  templateHtmlDataEmpty: =>
+    ""
+  
+  templateHtml: ->
+    pagination = @constructor.PAGINATION
+    source = """
+      <div class="pagination pagination-small pull-right">
+        <ul>
+          <li {{#unless hasFirst}}class="disabled"{{/unless}}>
+            <a href="javascript:void(0);" data-page="first">first</a>
+          </li>
+          <li {{#unless hasPrev}}class="disabled"{{/unless}}>
+            <a href="javascript:void(0);" data-page="prev">prev</a>
+          </li>
+          {{#each pages}}
+            {{#if this.gap}}
+              <li class="disabled">
+                <a href="javascript:void(0);" data-page='gap'>...</a>
+              </li>
+            {{else}}
+              <li {{#if this.current}}class="active"{{/if}}>
+                <a href="javascript:void(0);" data-page={{this.number}}>{{this.number}}</a>
+              </li>
+            {{/if}}
+          {{/each}}
+          <li {{#unless hasNext}}class="disabled"{{/unless}}>
+            <a href='javascript:void(0);' data-page="next">next</a>
+          </li>
+          <li {{#unless hasLast}}class="disabled"{{/unless}}>
+            <a href='javascript:void(0);' data-page="last">last</a>
+          </li>
+        </ul>
+      </div>
+    """
+    Handlebars.compile(source)(pagination.locals)

data/src/spine.paginator.coffee

@@ -1,5 +1,13 @@
-Spine  = @Spine or require('spine')
-Model  = Spine.Model
+
+###
+  Usage
+
+  data = ({name: String.fromCharCode(num)} for num in ['a'.charCodeAt(0)..'z'.charCodeAt(0)])
+  pagination = new Paginator(data, 2, {perPage: 3})
+  pagination.records
+  pagination.locals
+  pagination.buttons
+###
 
 class Paginator
   @DEFAULT_PER_PAGE = 25
@@ -8,11 +16,22 @@ class Paginator
   @OUTER_WINDOW = 0
   @LEFT = 0
   @RIGHT = 0
+
+  @PAGE_TEXTS =
+    first: 'first'
+    prev: 'prev'
+    current: 'current'
+    next: 'next'
+    last: 'last'
+    gap: 'gap'
   
   constructor: (records, @_page, options={}) ->
+    records = [records] unless isArray(records)
+    @originalRecords = records
+    @totalCount = @originalRecords.length
+
     @_page = parseInt(@_page)
     @_page = 1 if isNaN(@_page) or @_page <= 0
-
     @_originalPage = @_page
 
     @perPage = options.perPage || @constructor.DEFAULT_PER_PAGE
@@ -28,9 +47,6 @@ class Paginator
     @right = options.right || @constructor.RIGHT
     @right = outer_window if @right == 0
 
-    @originalRecords = @cloneArray(records)
-    @totalCount = @originalRecords.length
-
     @skipbuildButtonsAndLocals = options.skipbuildButtonsAndLocals
 
     @records = []
@@ -70,29 +86,6 @@ class Paginator
 
   isLastPage: -> @currentPage() >= @lastPage()
 
-
-  pages: ->
-    currentPage = @currentPage()
-    firstPage = @firstPage()
-    lastPage = @lastPage()
-
-    _pages = []
-    last = null
-    for page in [firstPage..lastPage]
-      result = @buildPage(page, last, currentPage, firstPage, lastPage)
-      if result.isLeftOuter or result.isRightOuter or result.isInsideWindow
-        last = null
-      else
-        last = 'gap'
-      _pages.push result
-    _pages
-
-  curPage: ->
-    currentPage = @currentPage()
-    firstPage = @firstPage()
-    lastPage = @lastPage()
-    @buildPage(currentPage, null, currentPage, firstPage, lastPage)
-
   
   # private
 
@@ -116,7 +109,29 @@ class Paginator
     isLeftOuter: page <= @left
     isRightOuter: (lastPage - page) < @right
     isInsideWindow: Math.abs(currentPage - page) <= @window
-    isWasTruncated: last == 'gap'
+    isWasTruncated: last == @constructor.PAGE_TEXTS['gap']
+  
+  curPage: ->
+    currentPage = @currentPage()
+    firstPage = @firstPage()
+    lastPage = @lastPage()
+    @buildPage(currentPage, null, currentPage, firstPage, lastPage)
+
+  pages: ->
+    currentPage = @currentPage()
+    firstPage = @firstPage()
+    lastPage = @lastPage()
+
+    _pages = []
+    last = null
+    for page in [firstPage..lastPage]
+      result = @buildPage(page, last, currentPage, firstPage, lastPage)
+      if result.isLeftOuter or result.isRightOuter or result.isInsideWindow
+        last = null
+      else
+        last = @constructor.PAGE_TEXTS['gap']
+      _pages.push result
+    _pages
 
   buildButtonsAndLocals: ->
     _buttons = []
@@ -126,13 +141,13 @@ class Paginator
     pages = @pages()
 
     unless curPage.isFirst
-      _buttons.push('first')
+      _buttons.push(@constructor.PAGE_TEXTS['first'])
       _locals.hasFirst = true
     else
       _locals.hasFirst = false
 
     unless curPage.isFirst
-      _buttons.push('prev')
+      _buttons.push(@constructor.PAGE_TEXTS['prev'])
       _locals.hasPrev = true
     else
       _locals.hasPrev = false
@@ -141,24 +156,24 @@ class Paginator
     for page in pages
       if page.isLeftOuter or page.isRightOuter or page.isInsideWindow
         if page.isCurrent
-          _buttons.push('current')
+          _buttons.push(@constructor.PAGE_TEXTS['current'])
           _locals.pages.push({number: page.number, current: true})
         else
           _buttons.push(page.number)
           _locals.pages.push({number: page.number, current: false})
         
       else if !page.isWasTruncated
-        _buttons.push('gap')
+        _buttons.push(@constructor.PAGE_TEXTS['gap'])
         _locals.pages.push({number: page.number, gap: true})
 
     unless curPage.isLast
-      _buttons.push('next')
+      _buttons.push(@constructor.PAGE_TEXTS['next'])
       _locals.hasNext = true
     else
       _locals.hasNext = false
 
     unless curPage.isLast
-      _buttons.push('last')
+      _buttons.push(@constructor.PAGE_TEXTS['last'])
       _locals.hasLast = true
     else
       _locals.hasLast = false
@@ -174,26 +189,54 @@ class Paginator
     @buttons = _buttons
     @locals = _locals
 
-  cloneArray: (array) ->
-    (value.clone() for value in array)
-
-Extend =
-  _perPaginateRecords: -> @records
-  page: (n, options={})-> new Paginator(@_perPaginateRecords(), n, options)
-  
-Model.Paginator =
-  extended: ->
-    @extend Extend
+isArray = (value) ->
+  Object::toString.call(value) is '[object Array]'
 
-Spine.Paginator = Paginator
+Paginator.isArray = isArray
 
-# Usage
 # 
-# class App.MyModel extends Spine.Model
-#   @extend Spine.Model.Paginator
-# 
-# App.MyModel.fetch()
-# pagination = App.MyModel.page(6).per(10)
-# pagination.locals
+# if your want use window.Paginator, please set `window.MyPaginatorName = 'Paginator' ` before require this.
 # 
+if @MyPaginatorName?
+  @[@MyPaginatorName] = Paginator
+
+
+
+if @Spine?
+  ###
+  # Spine Usage
+
+  App = {}
+
+  class App.User extends Spine.Model
+    @configure 'User', 'name' 
+    @extend Spine.Model.Paginator
+
+  data = ({name: String.fromCharCode(num)} for num in ['a'.charCodeAt(0)..'z'.charCodeAt(0)])
+
+  App.User.refresh(data)
+  pagination = App.User.page(2).per(5) #or App.User.page(2, {perPage: 5})
+  pagination.records
+  pagination.locals
+  pagination.buttons
+  App.User.PAGINATION = pagination
+
+  ### 
+  Paginator.SpineModelExtend =
+    page: (n, options={})-> new Paginator(@_perPaginateRecords(), n, options)
+
+    # private
+    _perPaginateRecords: -> @all()
+
+  Spine  = @Spine
+  Spine.Paginator = Paginator
+
+  Spine.Model.Paginator =
+    extended: ->
+      @extend Paginator.SpineModelExtend
+  
+
+
+
+
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spine_paginator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-05-11 00:00:00.000000000 Z
 dependencies: []
 description: Paginator for Spine
 email:
@@ -21,22 +21,31 @@ files:
 - .gitignore
 - Gemfile
 - Gruntfile.coffee
-- LICENSE-MIT
 - LICENSE.txt
 - README.md
 - Rakefile
 - component.json
 - dist/.gitkeep
+- dist/spine.pagination_controller.js
+- dist/spine.pagination_controller.min.js
 - dist/spine.paginator.js
 - dist/spine.paginator.min.js
+- examples/spine_pagination.coffee
+- examples/spine_pagination.css
+- examples/spine_pagination.html
+- examples/spine_pagination.js
+- examples/spine_pagination.scss
+- examples/spine_pagination.slim
 - lib/spine_paginator.rb
 - lib/spine_paginator/railtie.rb
 - lib/spine_paginator/version.rb
 - package.json
 - spec/lib/.gitkeep
+- spec/lib/handlebars.js
 - spec/lib/spine.js
 - spec/spine.paginator/.gitkeep
 - spine_paginator.gemspec
+- src/spine.pagination_controller.coffee
 - src/spine.paginator.coffee
 homepage: https://github.com/vkill/spine_paginator
 licenses: []
@@ -64,5 +73,6 @@ specification_version: 3
 summary: Paginator for Spine
 test_files:
 - spec/lib/.gitkeep
+- spec/lib/handlebars.js
 - spec/lib/spine.js
 - spec/spine.paginator/.gitkeep

data/LICENSE-MIT

@@ -1,22 +0,0 @@
-Copyright (c) 2013 vkill
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.