neat-pages 0.1.7 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59f1070651e4d23adb8f0301c9da861318a9383c
+  data.tar.gz: 84d03414625e89ae07971611b489c3ef39ea2ce7
+SHA512:
+  metadata.gz: ed1ab0e93b1510b1cf8a0be03b3e5efa7d1c5b368dc8601916f116265a4aca0845ddb9de1d079fdcd956b48c3dcbac0e1c92dec9f091528d211557b992ba455f
+  data.tar.gz: fc131f2eed332101da8a660a4288d66a2c4147e8eb52addda5d039a2464203c87c4237c1fe37d28a645166121814627307270b6e01810a30dfcc46e2786cd785

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+.metrics
+.rspec
+Gemfile.lock
+coverage/*
+pkg/*
+spec/dummy/log
+tmp/*

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in neat-pages.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 De Marque inc.
+Copyright (c) 2013 De Marque inc.
 
 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:
 

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)
+Neat Pages [![Build Status](https://secure.travis-ci.org/alchimikweb/neat-pages.png?branch=master)](http://travis-ci.org/alchimikweb/neat-pages) [![Code Climate](https://codeclimate.com/github/alchimikweb/neat-pages.png)](https://codeclimate.com/github/alchimikweb/neat-pages) [![Coverage Status](https://coveralls.io/repos/alchimikweb/neat-pages/badge.png)](https://coveralls.io/r/alchimikweb/neat-pages)
 ===============
 
-A simple pagination API to paginate Mongoid Models.
+A simple pagination API to paginate Mongoid models.
 
 Install
 -------
@@ -10,10 +10,7 @@ Install
 gem install neat-pages
 ```
 
-Rails 3
--------
-
-In your Gemfile:
+or add the following line to Gemfile:
 
 ```ruby
 gem 'neat-pages'
@@ -29,7 +26,7 @@ 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.
+You only need to require the javascript if you use the AJAX functionality.
 
 That's it.
 
@@ -37,15 +34,11 @@ That's it.
 Usage
 -----
 
-
-Examples
---------
-
 ### Minimal integration
 
-In your controller *(app/controllers/products_controller.rb)*
-
 ```ruby
+  # app/controllers/products_controller.rb
+
   def index
     paginate
 
@@ -53,29 +46,29 @@ In your controller *(app/controllers/products_controller.rb)*
   end
 ```
 
-In your view *(app/views/products/index.html.erb)*
-
 ```erb
+  <%# app/views/products/index.html.erb %>
+
   <%= render 'products', products: @products %>
   <%= neat_pages_navigation %>
 ```
 
 
-### Summon the power of AJAX
-
-In your controller *(app/controllers/products_controller.rb)*
+### Summon the power of AJAX pagination
 
 ```ruby
+  # app/controllers/products_controller.rb
+
   def index
-    paginate
+    paginate per_page: 50 # Default is 20
 
     @products = Product.all.paginate(pagination)
   end
 ```
 
-In your view *(app/views/products/index.html.erb)*
-
 ```erb
+  <%# app/views/products/index.html.erb %>
+
   <%= neat_pages_ajax_items 'products', products: @products %>
   <%= neat_pages_navigation %>
 ```
@@ -83,10 +76,53 @@ In your view *(app/views/products/index.html.erb)*
 Create the file *app/views/products/index.neatpage.erb* and place the following code in it.
 
 ```erb
+  <%# app/views/products/index.neatpage.erb %>
+
   <% self.formats = ["html"] %>
   <%= render 'products', products: @products %>
 ```
-### Events
+
+### Automatically paginate your Web Services
+
+For every request that called the method ```paginate```, the header's response will contain the following data :
+
+```
+  X-Total-Items=200;
+  X-Total-Pages=20;
+  X-Per-Page=10;
+  X-Current-Page=3;
+```
+
+### Out of Bound
+
+If the page requested is out of bound, the controller method ```render_out_of_bound``` will be called.
+This method will render the text 'out_of_bound' with a status 404. If you want, you can override it like this :
+
+
+```ruby
+  # app/controllers/application_controller.rb
+
+  def render_out_of_bound
+    render text: 'My custom code', status: 404
+  end
+```
+
+### Helper Methods
+
+```neat_pages_ajax_items(partial_path, options={})```
+
+Activate the ajax pagination. See the previous example.
+
+
+``` neat_pages_navigation ```
+
+Generate a page navigation. (ex: < 1 2 3 4 >)
+
+``` neat_pages_status ```
+
+Generate the current state of the pagination (ex: 30 to 40 / 200)
+
+### Javascript Events
 
 #### `neat_pages:update`
 

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

@@ -12,7 +12,14 @@ class NeatPage
         $('#neat-pages-navigation li.page a').click (e) => @thatPage $(e.target) ; return false
 
 
-  buildURL: (noPage) -> encodeURI(@getPage(noPage).attr('href').replace('?', '.neatpage?'))
+  buildURL: (noPage) ->
+    url = @getPage(noPage).attr('href')
+
+    if window.location.pathname is '/' or window.location.pathname is ''
+      encodeURI(url + '&format=neatpage')
+    else
+      encodeURI(url.replace('?', '.neatpage?'))
+
 
   cachePage: (noPage) -> $.get(@buildURL(noPage), (data) => @cachePages[noPage] = data)
 

data/lib/.reek

@@ -0,0 +1,12 @@
+---
+DuplicateMethodCall:
+  allow_calls: ['options', 'params']
+  max_calls: 3
+IrresponsibleModule:
+  enabled: false
+TooManyStatements:
+  max_statements: 10
+UncommunicativeMethodName:
+  enabled: false
+UncommunicativeVariableName:
+  enabled: false

data/lib/neat-pages.rb

@@ -5,5 +5,6 @@ end
 require "neat_pages/engine"
 require 'neat_pages/base'
 require 'neat_pages/errors'
-require 'neat_pages/implants'
+require 'neat_pages/railtie'
+
 

data/lib/neat_pages/base.rb

@@ -10,13 +10,13 @@ module NeatPages
     #*************************************************************************************
     # CONSTRUCTOR
     #*************************************************************************************
-    def initialize(current_page, options={})
+    def initialize(current_page_param, options={})
       options = { per_page: 10, total_items: 0 }.merge(options)
 
       @per_page = options[:per_page].to_i
       @total_items = options[:total_items]
 
-      @current_page = init_current_page(current_page)
+      init_current_page current_page_param
 
       @out_of_bound = init_out_of_bound
     end
@@ -89,11 +89,9 @@ module NeatPages
     #*************************************************************************************
     # PRIVATE INSTANCE METHODS
     #*************************************************************************************
-    def init_current_page(current_page)
-      current_page = current_page.to_i
-      current_page = 1 if current_page == 0
-
-      return current_page
+    def init_current_page(current_page_param)
+      @current_page = current_page_param.to_i
+      @current_page = 1 if @current_page == 0
     end
 
     def init_out_of_bound

data/lib/neat_pages/engine.rb

@@ -1,5 +1,7 @@
 module NeatPages
+  #*************************************************************************************
+  # Make the gem behave as an engine.
+  #*************************************************************************************
   class Engine < Rails::Engine
-    #auto wire
   end
 end

data/lib/neat_pages/errors.rb

@@ -1,4 +1,13 @@
 module NeatPages
+  #*************************************************************************************
+  # Error that will be raised if the page called is out of bound.
+  #*************************************************************************************
   class OutOfBound < StandardError
   end
+
+  #*************************************************************************************
+  # Error that will be raised if the pagination isn't initialized
+  #*************************************************************************************
+  class Uninitalized < StandardError
+  end
 end

data/lib/neat_pages/helpers.rb

@@ -1,22 +1,20 @@
+#*************************************************************************************
+# Insert a bunch of helper methods in the ActionView::Base of a Rails project.
+#*************************************************************************************
 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
-
-  def neat_pages_base_url
-    "#{request.protocol}#{request.host}#{request.port == 80 ? '' : ':' + request.port.to_s}#{request.path_info}"
-  end
+    options = { wrapper: :div }.merge(options)
 
-  def neat_pages_base_params
-    request.env['action_dispatch.request.query_parameters']
+    ("<#{options[:wrapper]} id=\"neat-pages-ajax-wrapper\" class=\"first-load\">" + render(partial_path, options) + "</#{options[:wrapper]}>").html_safe
   end
 
+  # DEPRECATED : The options parameter is deprecated. I left it here for backward compatibility. (2013-11-20)
   def neat_pages_navigation(options={})
-    NeatPages::Helpers::Navigation.new(pagination, neat_pages_base_url, neat_pages_base_params).generate(options)
+    NeatPages::Helpers::Navigation.new(pagination, request).generate
   end
 
   def neat_pages_status
-    NeatPages::Helpers::Status.new(pagination, neat_pages_base_url, neat_pages_base_params).generate
+    NeatPages::Helpers::Status.new(pagination, request).generate
   end
 
   ::ActionView::Base.send :include, self

data/lib/neat_pages/helpers/builder.rb

@@ -1,27 +1,40 @@
+#*************************************************************************************
+# Builder will help build a string of html output.
+#*************************************************************************************
 class NeatPages::Helpers::Builder
-  def initialize(pagination, base_url, params)
+  attr_reader :pagination
+
+  delegate :per_page,     to: :pagination
+  delegate :total_items,  to: :pagination
+
+  def initialize(pagination, request)
     @pagination = pagination
-    @base_url = base_url
-    @params = params
+    @base_url = generate_base_url_from_request(request)
+    @params = request.env['action_dispatch.request.query_parameters']
     @params.delete('utf8')
+
     reset_builder
   end
 
   def b(str='')
     @builder << str
 
-    return @builder.html_safe
+    @builder.html_safe
   end
 
-  def li(content, css_class='', hidden=false)
-    attributes = 'class="' + css_class + '" '
-    attributes << 'style="display:none"' if hidden
+  def li(content, css_class='', options={})
+    options = { hidden: false }.merge(options)
+
+    attributes = ' class="' + css_class + '"' if not css_class.empty?
+    attributes << ' style="display:none"' if options[:hidden]
 
-    return "<li #{attributes}>#{content}</li>"
+    b "<li#{attributes}>#{content}</li>"
   end
 
   def path_to(page)
-    return @base_url + '?' + @params.map { |k,v| "#{k}=#{v}"}.join('&') + "&page=#{page}"
+    qs = @params.map { |k,v| "#{k}=#{v}" if k != 'page' }.compact.join('&')
+
+    "#{@base_url}?#{qs}" + (qs.empty? ? '' : '&') + "page=#{page}"
   end
 
   def reset_builder
@@ -32,12 +45,9 @@ class NeatPages::Helpers::Builder
     (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
+  private
 
+  def generate_base_url_from_request(request)
+    "#{request.protocol}#{request.host}#{request.port == 80 ? '' : ':' + request.port.to_s}#{request.path_info}"
+  end
 end

data/lib/neat_pages/helpers/navigation.rb

@@ -1,15 +1,25 @@
+#*************************************************************************************
+# Navigation take care of generating the html code for the pagination navigation.
+#
+# Output Example
+#
+# < Previous | 1 | 2 | 3 | Next >
+#*************************************************************************************
 class NeatPages::Helpers::Navigation < NeatPages::Helpers::Builder
-  def generate(options={})
-    options = { format: :standard }.merge(options)
-
+  delegate :current_page,   to: :pagination
+  delegate :next?,          to: :pagination
+  delegate :next_page,      to: :pagination
+  delegate :paginated?,     to: :pagination
+  delegate :previous?,      to: :pagination
+  delegate :previous_page,  to: :pagination
+  delegate :total_pages,    to: :pagination
+
+  def generate
     return '' if not paginated?
 
     reset_builder
 
-    return case options[:format]
-      when :light then navigation_light
-      else navigation_standard
-    end
+    navigation_standard
   end
 
   private
@@ -17,9 +27,11 @@ class NeatPages::Helpers::Navigation < NeatPages::Helpers::Builder
   def link_to(label, no_page, options={})
     options = { class: '' }.merge(options)
 
-    url = (no_page == '#' ? '#' : path_to(no_page))
+    attributes = { "data-page" => no_page }
+    attributes["href"] = (no_page == '#' ? '#' : path_to(no_page))
+    attributes["class"] = options[:class] if not options[:class].blank?
 
-    return "<a href=\"#{url}\" data-page=\"#{no_page}\" class=\"#{options[:class]}\">#{label}</a>"
+    return "<a " + attributes.map{ |k,v| "#{k}=\"#{v}\"" }.join(" ") + ">#{label}</a>"
   end
 
   def link_to_page(no_page)
@@ -44,17 +56,7 @@ class NeatPages::Helpers::Navigation < NeatPages::Helpers::Builder
     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
+    li(content, "move #{direction} #{list_class}")
   end
 
   def navigation_link(direction)
@@ -62,16 +64,15 @@ class NeatPages::Helpers::Navigation < NeatPages::Helpers::Builder
   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
+    start, finish = get_bounds_of_pages nbr_items
 
     (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))
+      if current_page == i
+        li link_to_page(i), 'page selected'
+      else
+        li link_to_page(i), 'page', hidden: hidden
+      end
     end
   end
 
@@ -85,4 +86,15 @@ class NeatPages::Helpers::Navigation < NeatPages::Helpers::Builder
     return b
   end
 
+  def get_bounds_of_pages(nbr_items)
+    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
+
+    return [start, finish]
+  end
+
 end