annotate .svn/pristine/c2/c2cb8c7008cd50c99f1e1bcec32385aa815b5b9d.svn-base @ 1519:afce8026aaeb redmine-2.4-integration

Merge from branch "live"
author Chris Cannam
date Tue, 09 Sep 2014 09:34:53 +0100
parents e248c7af89ec
children
rev   line source
Chris@1494 1 # encoding: utf-8
Chris@1494 2 #
Chris@1494 3 # Redmine - project management software
Chris@1494 4 # Copyright (C) 2006-2014 Jean-Philippe Lang
Chris@1494 5 #
Chris@1494 6 # This program is free software; you can redistribute it and/or
Chris@1494 7 # modify it under the terms of the GNU General Public License
Chris@1494 8 # as published by the Free Software Foundation; either version 2
Chris@1494 9 # of the License, or (at your option) any later version.
Chris@1494 10 #
Chris@1494 11 # This program is distributed in the hope that it will be useful,
Chris@1494 12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
Chris@1494 13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Chris@1494 14 # GNU General Public License for more details.
Chris@1494 15 #
Chris@1494 16 # You should have received a copy of the GNU General Public License
Chris@1494 17 # along with this program; if not, write to the Free Software
Chris@1494 18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Chris@1494 19
Chris@1494 20 module Redmine
Chris@1494 21 module Pagination
Chris@1494 22 class Paginator
Chris@1494 23 attr_reader :item_count, :per_page, :page, :page_param
Chris@1494 24
Chris@1494 25 def initialize(*args)
Chris@1494 26 if args.first.is_a?(ActionController::Base)
Chris@1494 27 args.shift
Chris@1494 28 ActiveSupport::Deprecation.warn "Paginator no longer takes a controller instance as the first argument. Remove it from #new arguments."
Chris@1494 29 end
Chris@1494 30 item_count, per_page, page, page_param = *args
Chris@1494 31
Chris@1494 32 @item_count = item_count
Chris@1494 33 @per_page = per_page
Chris@1494 34 page = (page || 1).to_i
Chris@1494 35 if page < 1
Chris@1494 36 page = 1
Chris@1494 37 end
Chris@1494 38 @page = page
Chris@1494 39 @page_param = page_param || :page
Chris@1494 40 end
Chris@1494 41
Chris@1494 42 def offset
Chris@1494 43 (page - 1) * per_page
Chris@1494 44 end
Chris@1494 45
Chris@1494 46 def first_page
Chris@1494 47 if item_count > 0
Chris@1494 48 1
Chris@1494 49 end
Chris@1494 50 end
Chris@1494 51
Chris@1494 52 def previous_page
Chris@1494 53 if page > 1
Chris@1494 54 page - 1
Chris@1494 55 end
Chris@1494 56 end
Chris@1494 57
Chris@1494 58 def next_page
Chris@1494 59 if last_item < item_count
Chris@1494 60 page + 1
Chris@1494 61 end
Chris@1494 62 end
Chris@1494 63
Chris@1494 64 def last_page
Chris@1494 65 if item_count > 0
Chris@1494 66 (item_count - 1) / per_page + 1
Chris@1494 67 end
Chris@1494 68 end
Chris@1494 69
Chris@1494 70 def first_item
Chris@1494 71 item_count == 0 ? 0 : (offset + 1)
Chris@1494 72 end
Chris@1494 73
Chris@1494 74 def last_item
Chris@1494 75 l = first_item + per_page - 1
Chris@1494 76 l > item_count ? item_count : l
Chris@1494 77 end
Chris@1494 78
Chris@1494 79 def linked_pages
Chris@1494 80 pages = []
Chris@1494 81 if item_count > 0
Chris@1494 82 pages += [first_page, page, last_page]
Chris@1494 83 pages += ((page-2)..(page+2)).to_a.select {|p| p > first_page && p < last_page}
Chris@1494 84 end
Chris@1494 85 pages = pages.compact.uniq.sort
Chris@1494 86 if pages.size > 1
Chris@1494 87 pages
Chris@1494 88 else
Chris@1494 89 []
Chris@1494 90 end
Chris@1494 91 end
Chris@1494 92
Chris@1494 93 def items_per_page
Chris@1494 94 ActiveSupport::Deprecation.warn "Paginator#items_per_page will be removed. Use #per_page instead."
Chris@1494 95 per_page
Chris@1494 96 end
Chris@1494 97
Chris@1494 98 def current
Chris@1494 99 ActiveSupport::Deprecation.warn "Paginator#current will be removed. Use .offset instead of .current.offset."
Chris@1494 100 self
Chris@1494 101 end
Chris@1494 102 end
Chris@1494 103
Chris@1494 104 # Paginates the given scope or model. Returns a Paginator instance and
Chris@1494 105 # the collection of objects for the current page.
Chris@1494 106 #
Chris@1494 107 # Options:
Chris@1494 108 # :parameter name of the page parameter
Chris@1494 109 #
Chris@1494 110 # Examples:
Chris@1494 111 # @user_pages, @users = paginate User.where(:status => 1)
Chris@1494 112 #
Chris@1494 113 def paginate(scope, options={})
Chris@1494 114 options = options.dup
Chris@1494 115 finder_options = options.extract!(
Chris@1494 116 :conditions,
Chris@1494 117 :order,
Chris@1494 118 :joins,
Chris@1494 119 :include,
Chris@1494 120 :select
Chris@1494 121 )
Chris@1494 122 if scope.is_a?(Symbol) || finder_options.values.compact.any?
Chris@1494 123 return deprecated_paginate(scope, finder_options, options)
Chris@1494 124 end
Chris@1494 125
Chris@1494 126 paginator = paginator(scope.count, options)
Chris@1494 127 collection = scope.limit(paginator.per_page).offset(paginator.offset).to_a
Chris@1494 128
Chris@1494 129 return paginator, collection
Chris@1494 130 end
Chris@1494 131
Chris@1494 132 def deprecated_paginate(arg, finder_options, options={})
Chris@1494 133 ActiveSupport::Deprecation.warn "#paginate with a Symbol and/or find options is depreceted and will be removed. Use a scope instead."
Chris@1494 134 klass = arg.is_a?(Symbol) ? arg.to_s.classify.constantize : arg
Chris@1494 135 scope = klass.scoped(finder_options)
Chris@1494 136 paginate(scope, options)
Chris@1494 137 end
Chris@1494 138
Chris@1494 139 def paginator(item_count, options={})
Chris@1494 140 options.assert_valid_keys :parameter, :per_page
Chris@1494 141
Chris@1494 142 page_param = options[:parameter] || :page
Chris@1494 143 page = (params[page_param] || 1).to_i
Chris@1494 144 per_page = options[:per_page] || per_page_option
Chris@1494 145 Paginator.new(item_count, per_page, page, page_param)
Chris@1494 146 end
Chris@1494 147
Chris@1494 148 module Helper
Chris@1494 149 include Redmine::I18n
Chris@1494 150
Chris@1494 151 # Renders the pagination links for the given paginator.
Chris@1494 152 #
Chris@1494 153 # Options:
Chris@1494 154 # :per_page_links if set to false, the "Per page" links are not rendered
Chris@1494 155 #
Chris@1494 156 def pagination_links_full(*args)
Chris@1494 157 pagination_links_each(*args) do |text, parameters, options|
Chris@1494 158 if block_given?
Chris@1494 159 yield text, parameters, options
Chris@1494 160 else
Chris@1494 161 link_to text, params.merge(parameters), options
Chris@1494 162 end
Chris@1494 163 end
Chris@1494 164 end
Chris@1494 165
Chris@1494 166 # Yields the given block with the text and parameters
Chris@1494 167 # for each pagination link and returns a string that represents the links
Chris@1494 168 def pagination_links_each(paginator, count=nil, options={}, &block)
Chris@1494 169 options.assert_valid_keys :per_page_links
Chris@1494 170
Chris@1494 171 per_page_links = options.delete(:per_page_links)
Chris@1494 172 per_page_links = false if count.nil?
Chris@1494 173 page_param = paginator.page_param
Chris@1494 174
Chris@1494 175 html = ''
Chris@1494 176 if paginator.previous_page
Chris@1494 177 # \xc2\xab(utf-8) = &#171;
Chris@1494 178 text = "\xc2\xab " + l(:label_previous)
Chris@1494 179 html << yield(text, {page_param => paginator.previous_page}, :class => 'previous') + ' '
Chris@1494 180 end
Chris@1494 181
Chris@1494 182 previous = nil
Chris@1494 183 paginator.linked_pages.each do |page|
Chris@1494 184 if previous && previous != page - 1
Chris@1494 185 html << content_tag('span', '...', :class => 'spacer') + ' '
Chris@1494 186 end
Chris@1494 187 if page == paginator.page
Chris@1494 188 html << content_tag('span', page.to_s, :class => 'current page')
Chris@1494 189 else
Chris@1494 190 html << yield(page.to_s, {page_param => page}, :class => 'page')
Chris@1494 191 end
Chris@1494 192 html << ' '
Chris@1494 193 previous = page
Chris@1494 194 end
Chris@1494 195
Chris@1494 196 if paginator.next_page
Chris@1494 197 # \xc2\xbb(utf-8) = &#187;
Chris@1494 198 text = l(:label_next) + " \xc2\xbb"
Chris@1494 199 html << yield(text, {page_param => paginator.next_page}, :class => 'next') + ' '
Chris@1494 200 end
Chris@1494 201
Chris@1494 202 html << content_tag('span', "(#{paginator.first_item}-#{paginator.last_item}/#{paginator.item_count})", :class => 'items') + ' '
Chris@1494 203
Chris@1494 204 if per_page_links != false && links = per_page_links(paginator, &block)
Chris@1494 205 html << content_tag('span', links.to_s, :class => 'per-page')
Chris@1494 206 end
Chris@1494 207
Chris@1494 208 html.html_safe
Chris@1494 209 end
Chris@1494 210
Chris@1494 211 # Renders the "Per page" links.
Chris@1494 212 def per_page_links(paginator, &block)
Chris@1494 213 values = per_page_options(paginator.per_page, paginator.item_count)
Chris@1494 214 if values.any?
Chris@1494 215 links = values.collect do |n|
Chris@1494 216 if n == paginator.per_page
Chris@1494 217 content_tag('span', n.to_s)
Chris@1494 218 else
Chris@1494 219 yield(n, :per_page => n, paginator.page_param => nil)
Chris@1494 220 end
Chris@1494 221 end
Chris@1494 222 l(:label_display_per_page, links.join(', ')).html_safe
Chris@1494 223 end
Chris@1494 224 end
Chris@1494 225
Chris@1494 226 def per_page_options(selected=nil, item_count=nil)
Chris@1494 227 options = Setting.per_page_options_array
Chris@1494 228 if item_count && options.any?
Chris@1494 229 if item_count > options.first
Chris@1494 230 max = options.detect {|value| value >= item_count} || item_count
Chris@1494 231 else
Chris@1494 232 max = item_count
Chris@1494 233 end
Chris@1494 234 options = options.select {|value| value <= max || value == selected}
Chris@1494 235 end
Chris@1494 236 if options.empty? || (options.size == 1 && options.first == selected)
Chris@1494 237 []
Chris@1494 238 else
Chris@1494 239 options
Chris@1494 240 end
Chris@1494 241 end
Chris@1494 242 end
Chris@1494 243 end
Chris@1494 244 end