neat-pages 0.0.2 → 0.1.0

data/README.md

@@ -1,7 +1,7 @@
 Neat Pages [![Build Status](https://secure.travis-ci.org/demarque/neat-pages.png?branch=master)](http://travis-ci.org/demarque/neat-pages)
 ===============
 
-A simple pagination API to paginate Mongoid Models or any other stuff...
+A simple pagination API to paginate Mongoid Models.
 
 Install
 -------
@@ -19,13 +19,89 @@ In your Gemfile:
 gem 'neat-pages'
 ```
 
+
+Setup
+-----
+
+First you need to link the assets.
+
+In your css manifest put : ``` require neat_pages ```
+
+In your javascript manifest put : ``` require neat_pages ```
+
+You only need to require the javascript if you use the AJAX functionnality.
+
+That's it.
+
+
 Usage
 -----
 
-COMING SOON
+
+Examples
+--------
+
+### Minimal integration
+
+In your controller *(app/controllers/products_controller.rb)*
+
+```ruby
+  def index
+    paginate
+
+    @products = Product.all.paginate(pagination)
+  end
+```
+
+In your view *(app/views/products/index.html.erb)*
+
+```erb
+  <%= render 'products', products: @products %>
+  <%= neat_pages_navigation %>
+```
+
+
+### Summon the power of AJAX
+
+In your controller *(app/controllers/products_controller.rb)*
+
+```ruby
+  def index
+    paginate
+
+    @products = Product.all.paginate(pagination)
+  end
+```
+
+In your view *(app/views/products/index.html.erb)*
+
+```erb
+  <%= neat_pages_ajax_items 'products', products: @products %>
+  <%= neat_pages_navigation %>
+```
+
+Create the file *app/views/products/index.neatpage.erb* and place the following code in it.
+
+```erb
+  <% self.formats = ["html"] %>
+  <%= render 'products', products: @products %>
+```
+
+
+Locales
+-------
+
+If you want to translate the text in the pagination helpers, just add the following keys in i18n.
+
+```yml
+  fr:
+    neat_pages:
+      next_page: Page suivante
+      previous_page: Page précédente
+```
 
 
 Copyright
 ---------
 
-Copyright (c) 2012 De Marque inc. See LICENSE for further details.
+Copyright (c) 2013 De Marque inc. See LICENSE for further details.

data/Rakefile

@@ -8,4 +8,4 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
-task :default => :spec
+task default: :spec

data/app/assets/javascripts/neat_pages/base.coffee

@@ -0,0 +1,138 @@
+class NeatPage
+  constructor: () ->
+    @initPagination()
+
+    $(window).hashchange () => @loadPage @getPageFromHash()
+
+    $('#neat-pages-navigation li.next a').click (e) => @nextPage() ; return false
+    $('#neat-pages-navigation li.previous a').click (e) => @previousPage() ; return false
+    $('#neat-pages-navigation li.page a').click (e) => @thatPage $(e.target) ; return false
+
+
+
+  cachePage: (noPage) ->
+    url = @getPage(noPage).attr('href').replace('?', '.neatpage?')
+    $.get(url, (data) => @cachePages[noPage] = data)
+
+
+  cacheNextPage: () ->
+    noNextPage = @getPageFromHash() + 1
+
+    @cachePage noNextPage if noNextPage < @totalPages() and not @pageIsCached noNextPage
+
+
+  centerPages: () ->
+    current = @currentPageNumber()
+    totalPageLink = $('#neat-pages-navigation li.page:visible').length
+    halfTotalPageLink = totalPageLink/2
+
+    start = if current > halfTotalPageLink then current - halfTotalPageLink + 1 else 1
+    finish = if current >= @totalPages() - halfTotalPageLink then @totalPages() else (start + totalPageLink - 1)
+    start = (finish - totalPageLink + 1) if start - finish < totalPageLink - 1
+    start = 1 if start < 1
+
+    $('#neat-pages-navigation li.page').hide()
+    @getPage(page).closest('li').show() for page in [start..finish]
+
+
+  currentPage: () -> $('#neat-pages-navigation li.page.selected a')
+
+  currentPageNumber: () -> Number(@currentPage().data('page'))
+
+  getPage: (noPage) -> $('#neat-pages-navigation li.page a[data-page="' + noPage + '"]')
+
+  getPageFromHash: () ->
+    page = 1
+
+    if location.hash.indexOf('page-') isnt -1
+      selection = Number(location.hash.replace('#page-', ''))
+      page = selection if selection > 0 and selection <= @totalPages()
+
+    return page
+
+
+  initPagination: () ->
+    @cachePages = []
+    @cachePages[@currentPageNumber()] = $('#neat-pages-ajax-wrapper').html()
+    @cacheNextPage()
+
+    # When starting from a page that is not 1. (EX: Press Refresh or Back)
+    if @getPageFromHash() != 1
+      $('#neat-pages-ajax-wrapper').hide()
+      @loadPage @getPageFromHash()
+
+
+
+  loadPage: (noPage) ->
+    $('#neat-pages-ajax-wrapper').css( opacity: 0.5 )
+    @updateNav Number(noPage)
+    @updateStatus()
+
+    if @pageIsCached noPage
+      @updatePage @cachePages[noPage], noPage
+    else
+      url = @getPage(noPage).attr('href').replace('?', '.neatpage?')
+      $.get(url, (data) => @updatePage data, noPage)
+
+
+  moveIsDisabled: (direction) -> $('#neat-pages-navigation li.' + direction).hasClass('disabled')
+
+  nextPage: () -> @updateHash @currentPageNumber() + 1 if not @moveIsDisabled 'next'
+
+  pageIsCached: (noPage) -> if @cachePages[noPage] then true else false
+
+  perPage: () -> Number($('#neat-pages-navigation').data('per-page'))
+
+  previousPage: () -> @updateHash @currentPageNumber() - 1 if not @moveIsDisabled 'previous'
+
+  thatPage: (link) -> @updateHash link.data('page') if not link.closest('li').hasClass('selected')
+
+  totalItems: () -> Number($('#neat-pages-navigation').data('total-items'))
+
+  totalPages: () -> Number($('#neat-pages-navigation').data('total-pages'))
+
+  updateHash: (noPage) -> location.href = '#page-' + noPage
+
+  updateNav: (noPage) ->
+    $('#neat-pages-navigation li.page').removeClass('selected')
+    @getPage(noPage).closest('li').addClass('selected')
+    $('#neat-pages-navigation li.move').removeClass('disabled')
+
+    if noPage <= 1
+      $('#neat-pages-navigation li.previous').addClass('disabled')
+      $('#neat-pages-navigation li.previous a').attr('href', '#')
+    else
+      $('#neat-pages-navigation li.previous a').attr('href', @getPage(noPage-1).attr('href'))
+
+    if noPage >= @totalPages()
+      $('#neat-pages-navigation li.next').addClass('disabled')
+      $('#neat-pages-navigation li.next a').attr('href', '#')
+    else
+      $('#neat-pages-navigation li.next a').attr('href', @getPage(noPage+1).attr('href'))
+
+    @centerPages()
+
+
+  updatePage: (data, noPage) ->
+    @cachePages[noPage] = data if not @pageIsCached noPage
+
+    $('#neat-pages-ajax-wrapper').hide()
+    $('#neat-pages-ajax-wrapper').css( opacity: 1 )
+    $('#neat-pages-ajax-wrapper').html(data)
+    $('#neat-pages-ajax-wrapper').fadeIn(300)
+
+    $('#neat-pages-navigation').trigger 'change'
+
+    @cacheNextPage()
+
+
+  updateStatus: () ->
+    from = ((@currentPageNumber()-1) * @perPage()) + 1
+    to = from + @perPage() - 1
+    to = @totalItems if to > @totalItems()
+
+    $('#neat-pages-status').find('span.from').html(from)
+    $('#neat-pages-status').find('span.to').html(to)
+
+
+$ -> new NeatPage if $('#neat-pages-navigation').length > 0

data/app/assets/javascripts/neat_pages/index.js

@@ -0,0 +1,3 @@
+//= require jquery.hashchange.min
+//= require ./base
+

data/app/assets/stylesheets/neat_pages/base.css.scss

@@ -0,0 +1,24 @@
+/****************************************************************************
+* STANDARD
+****************************************************************************/
+ul#neat-pages-navigation{border-top:1px solid #ddd;clear:both;padding-top:30px;text-align:center;width:100%;
+  li{background:none;border:0;display:inline-block;font-size:12px;margin:0px 2px 0px 0px;
+    a{background:#fff;border:solid 1px #eee;color:#555;font-size:12px;font-weight:normal;margin-right:2px;padding:5px 9px;text-decoration:none;}
+    a:hover{border:solid 1px #ccc;color:#000;}
+  }
+  li.page.selected a{background:#ccc;border:1px solid #777;color:#222;font-weight:normal;padding:5px 9px;}
+  li.move.disabled a{background-color:#eee;border:solid 1px #DEDEDE;color:#aaa;cursor:default;}
+}
+
+/****************************************************************************
+* LIGHT
+****************************************************************************/
+ul#neat-pages-navigation.light{
+  li.page{display:none;float:left;height:1px;position:absolute;visibility:hidden;width:1px;}
+  li.move{display:block;}
+  li.move.disabled{display:none;}
+  li.move.previous{float:left;margin-left:5%;}
+  li.move.next{float:right;margin-right:5%;}
+}
+
+

data/app/assets/stylesheets/neat_pages/index.css

@@ -0,0 +1,3 @@
+/*
+*= require ./base
+*/

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  neat_pages:
+    next_page: Next
+    previous_page: Previous

data/config/locales/fr.yml

@@ -0,0 +1,4 @@
+fr:
+  neat_pages:
+    next_page: Suivante
+    previous_page: Précédente

data/lib/neat-pages.rb

@@ -2,7 +2,8 @@ module NeatPages
 
 end
 
+require "neat_pages/engine"
 require 'neat_pages/base'
-require 'neat_pages/helpers'
 require 'neat_pages/errors'
 require 'neat_pages/implants'
+

data/lib/neat_pages/base.rb

@@ -11,7 +11,7 @@ module NeatPages
     # CONSTRUCTOR
     #*************************************************************************************
     def initialize(current_page, options={})
-      options = { :per_page => 10, :total_items => 0 }.merge(options)
+      options = { per_page: 10, total_items: 0 }.merge(options)
 
       @per_page = options[:per_page].to_i
       @total_items = options[:total_items]
@@ -25,24 +25,10 @@ module NeatPages
     #*************************************************************************************
     # PUBLIC INSTANCE METHODS
     #*************************************************************************************
-    def activate_helpers(base_url='', params={})
-      @helpers = NeatPages::Helpers.new(self, base_url, params)
-    end
-
     def empty?
       @total_items == 0
     end
 
-    def helpers
-      if @helpers
-        @helpers
-      else
-        raise 'You must activate the helpers by calling "activate_helpers".'
-      end
-    end
-
-    alias_method :h, :helpers
-
     def limit
       @per_page
     end

data/lib/neat_pages/engine.rb

@@ -0,0 +1,5 @@
+module NeatPages
+  class Engine < Rails::Engine
+    #auto wire
+  end
+end

data/lib/neat_pages/helpers.rb

@@ -1,75 +1,27 @@
-# encoding : utf-8
-module NeatPages
-  #*************************************************************************************
-  # TOCOMMENT
-  #*************************************************************************************
-  class Helpers
-    #*************************************************************************************
-    # CONSTRUCTOR
-    #*************************************************************************************
-    def initialize(pagination, base_url, params)
-      @pagination = pagination
-      @base_url = base_url
-      @params = params
-    end
-
-
-    #*************************************************************************************
-    # PUBLIC INSTANCE METHODS
-    #*************************************************************************************
-    def navigation
-      if paginated?
-        content = ''
-        content << navigation_link('previous') if previous?
-        content << navigation_link('next') if next?
-
-        return "<div class=\"pagination\">#{content.html_safe}</div>".html_safe
-      else
-        return ''
-      end
-    end
-
-    def status
-      return '' if empty? or out_of_bound?
-
-      from = offset
-      to = from + per_page
-      to = total_items if to > total_items
-
-      return "#{from+1} #{t('to')} #{to}/#{total_items}"
-    end
-
-    private
-
-    #*************************************************************************************
-    # PRIVATE INSTANCE METHODS
-    #*************************************************************************************
-    def navigation_link(direction)
-      label_str = direction == 'next' ? "#{t('page_next')} »" : "« #{t('page_previous')}"
-
-      link_url = path_to(send("#{direction}_page"))
-
-      return "<a href=\"#{link_url}\" class=\"#{direction}\">#{label_str}</a>".html_safe
-    end
-
-    def path_to(page)
-      qs = ["page=#{page}"]
+module NeatPages::Helpers
+  def neat_pages_ajax_items(partial_path, options={})
+    ('<div id="neat-pages-ajax-wrapper" class="first-load">' + render(partial_path, options) + '</div>').html_safe
+  end
 
-      @params.each { |k,v| qs << "#{k}=#{v}" if k != 'page' }
+  def neat_pages_base_url
+    request.protocol + request.host + request.path_info
+  end
 
-      return @base_url + '?' + qs.join("&")
-    end
+  def neat_pages_base_params
+    request.env['action_dispatch.request.query_parameters']
+  end
 
-    def t(text_path)
-      (defined? I18n) ? I18n.t("neat_pages.#{text_path}") : text_path
-    end
+  def neat_pages_navigation(options={})
+    NeatPages::Helpers::Navigation.new(pagination, neat_pages_base_url, neat_pages_base_params).generate(options)
+  end
 
-    def method_missing(*args, &block)
-      if @pagination.respond_to? args.first
-        return @pagination.send *args, &block
-      else
-        raise NoMethodError.new("undefined local variable or method '#{args.first}' for #{self.class}")
-      end
-    end
+  def neat_pages_status
+    NeatPages::Helpers::Status.new(pagination, neat_pages_base_url, neat_pages_base_params).generate
   end
+
+  ::ActionView::Base.send :include, self
 end
+
+require 'neat_pages/helpers/builder'
+require 'neat_pages/helpers/navigation'
+require 'neat_pages/helpers/status'

data/lib/neat_pages/helpers/builder.rb

@@ -0,0 +1,47 @@
+class NeatPages::Helpers::Builder
+  def initialize(pagination, base_url, params)
+    @pagination = pagination
+    @base_url = base_url
+    @params = params
+
+    reset_builder
+  end
+
+  def b(str='')
+    @builder << str
+
+    return @builder.html_safe
+  end
+
+  def li(content, css_class='', hidden=false)
+    attributes = 'class="' + css_class + '" '
+    attributes << 'style="display:none"' if hidden
+
+    return "<li #{attributes}>#{content}</li>"
+  end
+
+  def path_to(page)
+    qs = ["page=#{page}"]
+
+    @params.each { |k,v| qs << "#{k}=#{v}" if k != 'page' }
+
+    return @base_url + '?' + qs.join("&")
+  end
+
+  def reset_builder
+    @builder = ''
+  end
+
+  def t(text_path)
+    (defined? I18n) ? I18n.t("neat_pages.#{text_path}") : text_path
+  end
+
+  def method_missing(*args, &block)
+    if @pagination.respond_to? args.first
+      return @pagination.send *args, &block
+    else
+      raise NoMethodError.new("undefined local variable or method '#{args.first}' for #{self.class}")
+    end
+  end
+
+end

data/lib/neat_pages/helpers/navigation.rb

@@ -0,0 +1,88 @@
+class NeatPages::Helpers::Navigation < NeatPages::Helpers::Builder
+  def generate(options={})
+    options = { format: :standard }.merge(options)
+
+    return '' if not paginated?
+
+    reset_builder
+
+    return case options[:format]
+      when :light then navigation_light
+      else navigation_standard
+    end
+  end
+
+  private
+
+  def link_to(label, no_page, options={})
+    options = { class: '' }.merge(options)
+
+    url = (no_page == '#' ? '#' : path_to(no_page))
+
+    return "<a href=\"#{url}\" data-page=\"#{no_page}\" class=\"#{options[:class]}\">#{label}</a>"
+  end
+
+  def link_to_page(no_page)
+    link_to no_page, no_page
+  end
+
+  def navigation_attributes
+    {
+      "id" => "neat-pages-navigation",
+      "data-neat-pages-control=" => "navigation",
+      "data-per-page" => per_page,
+      "data-total-items" => total_items,
+      "data-total-pages" => total_pages
+    }.map{ |k,v| "#{k}=\"#{v}\"" }.join(' ')
+  end
+
+  def navigation_label(direction)
+    (direction == 'next' ? "#{t('next_page')} &raquo;" : "&laquo; #{t('previous_page')}").html_safe
+  end
+
+  def navigation_list_link(direction, enabled)
+    list_class = enabled ? '' : 'disabled'
+    content = enabled ? navigation_link(direction) : link_to(navigation_label(direction), '#', class: direction)
+
+    b li(content, "move #{direction} #{list_class}")
+  end
+
+  def navigation_light
+    b '<ul class="light" ' + navigation_attributes + '>'
+    navigation_list_link 'previous', previous?
+    navigation_page_items(10)
+    navigation_list_link 'next', next?
+    b '</ul>'
+
+    return b
+  end
+
+  def navigation_link(direction)
+    link_to(navigation_label(direction), send("#{direction}_page"), class: direction)
+  end
+
+  def navigation_page_items(nbr_items=10)
+    half_nbr_items = nbr_items / 2
+
+    start = current_page > half_nbr_items ? (current_page - half_nbr_items + 1) : 1
+    finish = current_page >= total_pages - half_nbr_items ? total_pages : (start + nbr_items - 1)
+    start = (finish - nbr_items + 1) if start - finish < nbr_items
+    start = 1 if start < 1
+
+    (1..total_pages).each do |i|
+      hidden = (i < start or i > finish)
+      b (current_page == i ? li(link_to_page(i), 'page selected') : li(link_to_page(i), 'page', hidden))
+    end
+  end
+
+  def navigation_standard
+    b '<ul class="standard" ' + navigation_attributes + '>'
+    navigation_list_link 'previous', previous?
+    navigation_page_items(10)
+    navigation_list_link 'next', next?
+    b '</ul>'
+
+    return b
+  end
+
+end

data/lib/neat_pages/helpers/status.rb

@@ -0,0 +1,30 @@
+class NeatPages::Helpers::Status < NeatPages::Helpers::Builder
+  def generate
+    return '' if empty? or out_of_bound?
+
+    from, to = get_from_to_data
+
+    return build_status from, to
+  end
+
+  def build_status(from, to)
+    reset_builder
+
+    b '<span data-neat-pages-control="status" id="neat-pages-status">'
+    b "<span class=\"from\">#{from+1}</span>"
+    b " #{t('to')} "
+    b "<span class=\"to\">#{to}</span>/"
+    b "<span class=\"total\">#{total_items}</span>"
+    b '</span>'
+
+    return b
+  end
+
+  def get_from_to_data
+    from = offset
+    to = from + per_page
+    to = total_items if to > total_items
+
+    return [from, to]
+  end
+end

data/lib/neat_pages/implants/action_controller_implant.rb

@@ -3,31 +3,24 @@ module NeatPages::Implants::ActionControllerImplant
 
   included do
     append_after_filter :set_pagination_header
-    helper_method :pagination, :pagination_helpers
-    rescue_from NeatPages::OutOfBound, :with => :render_out_of_bound
-  end
 
-  def paginate(options={})
-    options.reverse_merge!(:per_page => 20)
+    helper_method :pagination
 
-    base_current_url = request.protocol + request.host + request.path_info
+    rescue_from NeatPages::OutOfBound, with: :render_out_of_bound
+  end
 
-    neat_pages = NeatPages::Base.new(params[:page], options)
-    neat_pages.activate_helpers(base_current_url, request.env['action_dispatch.request.query_parameters'])
+  def paginate(options={})
+    options.reverse_merge! per_page: 20
 
-    @_env['neat_pages'] = neat_pages
+    @_env['neat_pages'] = NeatPages::Base.new(params[:page], options)
   end
 
   def pagination
     @_env['neat_pages']
   end
 
-  def pagination_helpers
-    pagination.helpers
-  end
-
   def render_out_of_bound
-    render :text => "out_of_bound", :status => 404
+    render text: "out_of_bound", status: 404
   end
 
   def set_pagination_header

data/lib/neat_pages/implants/railtie.rb

@@ -2,12 +2,21 @@ require 'neat_pages/implants/action_controller_implant'
 
 module NeatPages::Implants
   class Railtie < Rails::Railtie
-    initializer "neat_pages" do |app|
-
+    initializer "neat-pages" do |app|
       ActiveSupport.on_load :action_controller do
         include NeatPages::Implants::ActionControllerImplant
       end
 
+      ActiveSupport.on_load :action_view do
+        require 'neat_pages/helpers'
+      end
+
+      Mime::Type.register "text/html", :neatpage if not Mime::Type.lookup_by_extension :neatpage
     end
   end
 end
+
+dir = File.expand_path(File.dirname(__FILE__))
+
+I18n.load_path << File.join(dir, '../../../config/locales', 'fr.yml')
+

data/spec/neat_pages/base_spec.rb

@@ -6,7 +6,7 @@ describe NeatPages::Base do
   #*************************************************************************************
   describe "#empty?" do
     context "with a 20 items pagination" do
-      specify { NeatPages::Base.new(0, :total_items => 20).should_not be_empty }
+      specify { NeatPages::Base.new(0, total_items: 20).should_not be_empty }
     end
 
     context "with a 0 item pagination" do
@@ -16,109 +16,109 @@ describe NeatPages::Base do
 
   describe "#next_page" do
     context "with a 100 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).next_page.should eql 2 }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 100).next_page.should eql 2 }
     end
 
     context "with a 100 items pagination starting at page 3 and having 15 items per page" do
-      specify { NeatPages::Base.new(3, :per_page => 15, :total_items => 100).next_page.should eql 4 }
+      specify { NeatPages::Base.new(3, per_page: 15, total_items: 100).next_page.should eql 4 }
     end
 
     context "with a 5 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 5).next_page.should eql 1 }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 5).next_page.should eql 1 }
     end
   end
 
   describe "#next?" do
     context "with a 100 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).should be_next }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 100).should be_next }
     end
 
     context "with a 5 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 5).should_not be_next }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 5).should_not be_next }
     end
   end
 
   describe "#offset" do
     context "with a 100 items pagination starting at page 1 and having 10 items per page" do
-      specify { NeatPages::Base.new(1, :per_page => 10, :total_items => 100).offset.should eql 0 }
+      specify { NeatPages::Base.new(1, per_page: 10, total_items: 100).offset.should eql 0 }
     end
 
     context "with a 100 items pagination starting at page 4 and having 15 items per page" do
-      specify { NeatPages::Base.new(4, :per_page => 15, :total_items => 100).offset.should eql 45 }
+      specify { NeatPages::Base.new(4, per_page: 15, total_items: 100).offset.should eql 45 }
     end
 
     context "with a 100 items pagination starting at page 999 and having 15 items per page" do
-      specify { NeatPages::Base.new(999, :per_page => 15, :total_items => 100).offset.should eql 101 }
+      specify { NeatPages::Base.new(999, per_page: 15, total_items: 100).offset.should eql 101 }
     end
   end
 
   describe "#out_of_bound?" do
     context "with a 100 items pagination starting at page 1 and having 10 items per page" do
-      specify { NeatPages::Base.new(1, :per_page => 10, :total_items => 100).should_not be_out_of_bound }
+      specify { NeatPages::Base.new(1, per_page: 10, total_items: 100).should_not be_out_of_bound }
     end
 
     context "with a 100 items pagination starting at page 11 and having 10 items per page" do
-      specify { NeatPages::Base.new(11, :per_page => 10, :total_items => 100).should be_out_of_bound }
+      specify { NeatPages::Base.new(11, per_page: 10, total_items: 100).should be_out_of_bound }
     end
   end
 
   describe "#previous_page" do
     context "with a 100 items pagination starting at page 5 and having 10 items per page" do
-      specify { NeatPages::Base.new(5, :per_page => 10, :total_items => 100).previous_page.should eql 4 }
+      specify { NeatPages::Base.new(5, per_page: 10, total_items: 100).previous_page.should eql 4 }
     end
 
     context "with a 100 items pagination starting at page 3 and having 15 items per page" do
-      specify { NeatPages::Base.new(3, :per_page => 15, :total_items => 100).previous_page.should eql 2 }
+      specify { NeatPages::Base.new(3, per_page: 15, total_items: 100).previous_page.should eql 2 }
     end
 
     context "with a 50 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 50).previous_page.should eql 1 }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 50).previous_page.should eql 1 }
     end
   end
 
   describe "#previous" do
     context "with a 100 items pagination starting at page 5 and having 10 items per page" do
-      specify { NeatPages::Base.new(5, :per_page => 10, :total_items => 100).should be_previous }
+      specify { NeatPages::Base.new(5, per_page: 10, total_items: 100).should be_previous }
     end
 
     context "with a 50 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 50).should_not be_previous }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 50).should_not be_previous }
     end
   end
 
   describe "#previous?" do
     context "with a 100 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).should_not be_previous }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 100).should_not be_previous }
     end
 
     context "with a 100 items pagination starting at page 2 and having 10 items per page" do
-      specify { NeatPages::Base.new(2, :per_page => 10, :total_items => 100).should be_previous }
+      specify { NeatPages::Base.new(2, per_page: 10, total_items: 100).should be_previous }
     end
 
     context "with a 5 items pagination starting at 0 and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 5).should_not be_previous }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 5).should_not be_previous }
     end
   end
 
   describe "#response_headers" do
     context "with a 200 items pagination starting at page 1 and having 10 items per page" do
-      subject { NeatPages::Base.new(1, :per_page => 10, :total_items => 200).response_headers }
+      subject { NeatPages::Base.new(1, per_page: 10, total_items: 200).response_headers }
 
       its(:length) { should eql 4 }
       its(['X-Total-Items']) { should eql '200' }
       its(['X-Total-Pages']) { should eql '20' }
-      its(['X-Per-Page']) { should eql '10' }
+      its(['X-Per-Page']) { should eql '10' }#
       its(['X-Current-Page']) { should eql '1' }
     end
   end
 
   describe "#total_pages" do
     context "with a 100 items pagination and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).total_pages.should eql 10 }
+      specify { NeatPages::Base.new(0, per_page: 10, total_items: 100).total_pages.should eql 10 }
     end
 
     context "with a 0 items pagination and having 10 items per page" do
-      specify { NeatPages::Base.new(0, :per_page => 10).total_pages.should eql 1 }
+      specify { NeatPages::Base.new(0, per_page: 10).total_pages.should eql 1 }
     end
   end
 end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require "rubygems"
 require "bundler/setup"
 
 require 'rspec'
+require 'rails'
 
 require File.expand_path('../../lib/neat-pages', __FILE__)
 

data/vendor/assets/javascripts/jquery.hashchange.min.js

@@ -0,0 +1,9 @@
+/*
+ * jQuery hashchange event - v1.3 - 7/21/2010
+ * http://benalman.com/projects/jquery-hashchange-plugin/
+ *
+ * Copyright (c) 2010 "Cowboy" Ben Alman
+ * Dual licensed under the MIT and GPL licenses.
+ * http://benalman.com/about/license/
+ */
+(function($,e,b){var c="hashchange",h=document,f,g=$.event.special,i=h.documentMode,d="on"+c in e&&(i===b||i>7);function a(j){j=j||location.href;return"#"+j.replace(/^[^#]*#?(.*)$/,"$1")}$.fn[c]=function(j){return j?this.bind(c,j):this.trigger(c)};$.fn[c].delay=50;g[c]=$.extend(g[c],{setup:function(){if(d){return false}$(f.start)},teardown:function(){if(d){return false}$(f.stop)}});f=(function(){var j={},p,m=a(),k=function(q){return q},l=k,o=k;j.start=function(){p||n()};j.stop=function(){p&&clearTimeout(p);p=b};function n(){var r=a(),q=o(m);if(r!==m){l(m=r,q);$(e).trigger(c)}else{if(q!==m){location.href=location.href.replace(/#.*/,"")+q}}p=setTimeout(n,$.fn[c].delay)}$.browser.msie&&!d&&(function(){var q,r;j.start=function(){if(!q){r=$.fn[c].src;r=r&&r+a();q=$('<iframe tabindex="-1" title="empty"/>').hide().one("load",function(){r||l(a());n()}).attr("src",r||"javascript:0").insertAfter("body")[0].contentWindow;h.onpropertychange=function(){try{if(event.propertyName==="title"){q.document.title=h.title}}catch(s){}}}};j.stop=k;o=function(){return a(q.location.href)};l=function(v,s){var u=q.document,t=$.fn[c].domain;if(v!==s){u.title=h.title;u.open();t&&u.write('<script>document.domain="'+t+'"<\/script>');u.close();q.location.hash=v}}})();return j})()})(jQuery,this);

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neat-pages
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,30 +9,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-16 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2151882000 !ruby/object:Gem::Requirement
-    none: false
+  requirement: &2159931860 !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.7
-  type: :development
+    none: false
   prerelease: false
-  version_requirements: *2151882000
+  type: :development
+  name: rake
+  version_requirements: *2159931860
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2151880820 !ruby/object:Gem::Requirement
-    none: false
+  requirement: &2159930740 !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '2.0'
+    none: false
+  prerelease: false
   type: :development
+  name: rspec
+  version_requirements: *2159930740
+- !ruby/object:Gem::Dependency
+  requirement: &2159929800 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
   prerelease: false
-  version_requirements: *2151880820
+  type: :development
+  name: rails
+  version_requirements: *2159929800
 description: ''
 email:
 - sebastien@demarque.com
@@ -42,9 +53,19 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
+- app/assets/javascripts/neat_pages/base.coffee
+- app/assets/javascripts/neat_pages/index.js
+- app/assets/stylesheets/neat_pages/base.css.scss
+- app/assets/stylesheets/neat_pages/index.css
+- config/locales/en.yml
+- config/locales/fr.yml
 - lib/neat-pages.rb
 - lib/neat_pages/base.rb
+- lib/neat_pages/engine.rb
 - lib/neat_pages/errors.rb
+- lib/neat_pages/helpers/builder.rb
+- lib/neat_pages/helpers/navigation.rb
+- lib/neat_pages/helpers/status.rb
 - lib/neat_pages/helpers.rb
 - lib/neat_pages/implants/action_controller_implant.rb
 - lib/neat_pages/implants/mongoid_implant.rb
@@ -52,8 +73,8 @@ files:
 - lib/neat_pages/implants.rb
 - spec/neat-pages_spec.rb
 - spec/neat_pages/base_spec.rb
-- spec/neat_pages/helpers_spec.rb
 - spec/spec_helper.rb
+- vendor/assets/javascripts/jquery.hashchange.min.js
 - LICENSE
 - README.md
 - Rakefile
@@ -66,21 +87,22 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: neat-pages
-rubygems_version: 1.8.17
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: ''
 test_files: []
+has_rdoc: 

data/spec/neat_pages/helpers_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-
-describe NeatPages::Helpers do
-  describe "#status" do
-    context "with a 100 items pagination starting at 0 and having 10 items per page" do
-      let(:neat_pages) { NeatPages::Base.new(0, :per_page => 10, :total_items => 100) }
-
-      before { neat_pages.activate_helpers }
-
-      specify { neat_pages.helpers.status.should eql "1 to 10/100" }
-    end
-
-    context "with a 23 items pagination starting at page 3 and having 10 items per page" do
-      let(:neat_pages) { NeatPages::Base.new(3, :per_page => 10, :total_items => 23) }
-
-      before { neat_pages.activate_helpers }
-
-      specify { neat_pages.helpers.status.should eql "21 to 23/23" }
-    end
-
-    context "with a 0 items pagination starting at 0 and having 10 items per page" do
-      let(:neat_pages) { NeatPages::Base.new(0, :per_page => 10, :total_items => 0) }
-
-      before { neat_pages.activate_helpers }
-
-      specify { neat_pages.helpers.status.should be_empty }
-    end
-  end
-end