Chris@1295: # encoding: utf-8 Chris@1295: # Chris@1295: # Redmine - project management software Chris@1295: # Copyright (C) 2006-2013 Jean-Philippe Lang Chris@1295: # Chris@1295: # This program is free software; you can redistribute it and/or Chris@1295: # modify it under the terms of the GNU General Public License Chris@1295: # as published by the Free Software Foundation; either version 2 Chris@1295: # of the License, or (at your option) any later version. Chris@1295: # Chris@1295: # This program is distributed in the hope that it will be useful, Chris@1295: # but WITHOUT ANY WARRANTY; without even the implied warranty of Chris@1295: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Chris@1295: # GNU General Public License for more details. Chris@1295: # Chris@1295: # You should have received a copy of the GNU General Public License Chris@1295: # along with this program; if not, write to the Free Software Chris@1295: # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Chris@1295: Chris@1295: module Redmine Chris@1295: module Pagination Chris@1295: class Paginator Chris@1295: attr_reader :item_count, :per_page, :page, :page_param Chris@1295: Chris@1295: def initialize(*args) Chris@1295: if args.first.is_a?(ActionController::Base) Chris@1295: args.shift Chris@1295: ActiveSupport::Deprecation.warn "Paginator no longer takes a controller instance as the first argument. Remove it from #new arguments." Chris@1295: end Chris@1295: item_count, per_page, page, page_param = *args Chris@1295: Chris@1295: @item_count = item_count Chris@1295: @per_page = per_page Chris@1295: page = (page || 1).to_i Chris@1295: if page < 1 Chris@1295: page = 1 Chris@1295: end Chris@1295: @page = page Chris@1295: @page_param = page_param || :page Chris@1295: end Chris@1295: Chris@1295: def offset Chris@1295: (page - 1) * per_page Chris@1295: end Chris@1295: Chris@1295: def first_page Chris@1295: if item_count > 0 Chris@1295: 1 Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: def previous_page Chris@1295: if page > 1 Chris@1295: page - 1 Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: def next_page Chris@1295: if last_item < item_count Chris@1295: page + 1 Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: def last_page Chris@1295: if item_count > 0 Chris@1295: (item_count - 1) / per_page + 1 Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: def first_item Chris@1295: item_count == 0 ? 0 : (offset + 1) Chris@1295: end Chris@1295: Chris@1295: def last_item Chris@1295: l = first_item + per_page - 1 Chris@1295: l > item_count ? item_count : l Chris@1295: end Chris@1295: Chris@1295: def linked_pages Chris@1295: pages = [] Chris@1295: if item_count > 0 Chris@1295: pages += [first_page, page, last_page] Chris@1295: pages += ((page-2)..(page+2)).to_a.select {|p| p > first_page && p < last_page} Chris@1295: end Chris@1295: pages = pages.compact.uniq.sort Chris@1295: if pages.size > 1 Chris@1295: pages Chris@1295: else Chris@1295: [] Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: def items_per_page Chris@1295: ActiveSupport::Deprecation.warn "Paginator#items_per_page will be removed. Use #per_page instead." Chris@1295: per_page Chris@1295: end Chris@1295: Chris@1295: def current Chris@1295: ActiveSupport::Deprecation.warn "Paginator#current will be removed. Use .offset instead of .current.offset." Chris@1295: self Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: # Paginates the given scope or model. Returns a Paginator instance and Chris@1295: # the collection of objects for the current page. Chris@1295: # Chris@1295: # Options: Chris@1295: # :parameter name of the page parameter Chris@1295: # Chris@1295: # Examples: Chris@1295: # @user_pages, @users = paginate User.where(:status => 1) Chris@1295: # Chris@1295: def paginate(scope, options={}) Chris@1295: options = options.dup Chris@1295: finder_options = options.extract!( Chris@1295: :conditions, Chris@1295: :order, Chris@1295: :joins, Chris@1295: :include, Chris@1295: :select Chris@1295: ) Chris@1295: if scope.is_a?(Symbol) || finder_options.values.compact.any? Chris@1295: return deprecated_paginate(scope, finder_options, options) Chris@1295: end Chris@1295: Chris@1295: paginator = paginator(scope.count, options) Chris@1295: collection = scope.limit(paginator.per_page).offset(paginator.offset).to_a Chris@1295: Chris@1295: return paginator, collection Chris@1295: end Chris@1295: Chris@1295: def deprecated_paginate(arg, finder_options, options={}) Chris@1295: ActiveSupport::Deprecation.warn "#paginate with a Symbol and/or find options is depreceted and will be removed. Use a scope instead." Chris@1295: klass = arg.is_a?(Symbol) ? arg.to_s.classify.constantize : arg Chris@1295: scope = klass.scoped(finder_options) Chris@1295: paginate(scope, options) Chris@1295: end Chris@1295: Chris@1295: def paginator(item_count, options={}) Chris@1295: options.assert_valid_keys :parameter, :per_page Chris@1295: Chris@1295: page_param = options[:parameter] || :page Chris@1295: page = (params[page_param] || 1).to_i Chris@1295: per_page = options[:per_page] || per_page_option Chris@1295: Paginator.new(item_count, per_page, page, page_param) Chris@1295: end Chris@1295: Chris@1295: module Helper Chris@1295: include Redmine::I18n Chris@1295: Chris@1295: # Renders the pagination links for the given paginator. Chris@1295: # Chris@1295: # Options: Chris@1295: # :per_page_links if set to false, the "Per page" links are not rendered Chris@1295: # Chris@1295: def pagination_links_full(*args) Chris@1295: pagination_links_each(*args) do |text, parameters, options| Chris@1295: if block_given? Chris@1295: yield text, parameters, options Chris@1295: else Chris@1295: link_to text, params.merge(parameters), options Chris@1295: end Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: # Yields the given block with the text and parameters Chris@1295: # for each pagination link and returns a string that represents the links Chris@1295: def pagination_links_each(paginator, count=nil, options={}, &block) Chris@1295: options.assert_valid_keys :per_page_links Chris@1295: Chris@1295: per_page_links = options.delete(:per_page_links) Chris@1295: per_page_links = false if count.nil? Chris@1295: page_param = paginator.page_param Chris@1295: Chris@1295: html = '' Chris@1295: if paginator.previous_page Chris@1295: # \xc2\xab(utf-8) = « Chris@1295: text = "\xc2\xab " + l(:label_previous) Chris@1295: html << yield(text, {page_param => paginator.previous_page}, :class => 'previous') + ' ' Chris@1295: end Chris@1295: Chris@1295: previous = nil Chris@1295: paginator.linked_pages.each do |page| Chris@1295: if previous && previous != page - 1 Chris@1295: html << content_tag('span', '...', :class => 'spacer') + ' ' Chris@1295: end Chris@1295: if page == paginator.page Chris@1295: html << content_tag('span', page.to_s, :class => 'current page') Chris@1295: else Chris@1295: html << yield(page.to_s, {page_param => page}, :class => 'page') Chris@1295: end Chris@1295: html << ' ' Chris@1295: previous = page Chris@1295: end Chris@1295: Chris@1295: if paginator.next_page Chris@1295: # \xc2\xbb(utf-8) = » Chris@1295: text = l(:label_next) + " \xc2\xbb" Chris@1295: html << yield(text, {page_param => paginator.next_page}, :class => 'next') + ' ' Chris@1295: end Chris@1295: Chris@1295: html << content_tag('span', "(#{paginator.first_item}-#{paginator.last_item}/#{paginator.item_count})", :class => 'items') + ' ' Chris@1295: Chris@1295: if per_page_links != false && links = per_page_links(paginator, &block) Chris@1295: html << content_tag('span', links.to_s, :class => 'per-page') Chris@1295: end Chris@1295: Chris@1295: html.html_safe Chris@1295: end Chris@1295: Chris@1295: # Renders the "Per page" links. Chris@1295: def per_page_links(paginator, &block) Chris@1295: values = per_page_options(paginator.per_page, paginator.item_count) Chris@1295: if values.any? Chris@1295: links = values.collect do |n| Chris@1295: if n == paginator.per_page Chris@1295: content_tag('span', n.to_s) Chris@1295: else Chris@1295: yield(n, :per_page => n, paginator.page_param => nil) Chris@1295: end Chris@1295: end Chris@1295: l(:label_display_per_page, links.join(', ')).html_safe Chris@1295: end Chris@1295: end Chris@1295: Chris@1295: def per_page_options(selected=nil, item_count=nil) Chris@1295: options = Setting.per_page_options_array Chris@1295: if item_count && options.any? Chris@1295: if item_count > options.first Chris@1295: max = options.detect {|value| value >= item_count} || item_count Chris@1295: else Chris@1295: max = item_count Chris@1295: end Chris@1295: options = options.select {|value| value <= max || value == selected} Chris@1295: end Chris@1295: if options.empty? || (options.size == 1 && options.first == selected) Chris@1295: [] Chris@1295: else Chris@1295: options Chris@1295: end Chris@1295: end Chris@1295: end Chris@1295: end Chris@1295: end