kaminari 0.13.0 → 0.14.0

data/gemfiles/data_mapper_12.gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+gem 'railties', '>= 3.2.3'
+gem 'dm-core', '>= 1.2.0'
+gem 'dm-migrations', '>= 1.2.0'
+gem 'dm-aggregates', '>= 1.2.0'
+gem 'dm-transactions', '>= 1.2.0'
+gem 'dm-active_model', '>= 1.2.0'
+gem 'dm-sqlite-adapter', '>= 1.2.0'
+gem 'rspec-rails', '>= 2.0'
+
+gemspec :path => '../'

data/gemfiles/mongo_mapper.gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'railties', '>= 3.2.3'
+gem 'mongo_mapper', '>= 0.11.0'
+gem 'rspec-rails', '>= 2.0'
+
+gemspec :path => '../'

data/gemfiles/mongoid_24.gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'railties', '>= 3.2.3'
+gem 'mongoid', '~> 2.4.0'
+gem 'rspec-rails', '>= 2.0'
+
+gemspec :path => '../'

data/gemfiles/mongoid_30.gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gem 'railties', '>= 3.2.3'
+gem 'mongoid', '>= 3.0'
+gem 'rspec-rails', '>= 2.0'
+
+gemspec :path => '../'

data/gemfiles/sinatra.gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'activerecord', '>= 3.2.3', :require => 'active_record'
+gem 'sinatra', '>= 1.3'
+gem 'padrino-helpers', '>= 0.10.6.c'
+gem 'rack-test', '>= 0'
+gem 'sinatra-contrib', '>= 1.3'
+gem 'nokogiri', '>= 0'
+
+gemspec :path => '../'

data/kaminari.gemspec

@@ -21,28 +21,16 @@ Gem::Specification.new do |s|
 
   s.licenses = ['MIT']
 
-  %w{ activesupport actionpack railties }.each do |gem|
-    s.add_dependency gem, ['>= 3.0.0']
-  end
+  s.add_dependency 'activesupport', ['>= 3.0.0']
+  s.add_dependency 'actionpack', ['>= 3.0.0']
+
   s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'rake', ['>= 0']
   s.add_development_dependency 'sqlite3', ['>= 0']
-  %w{ activerecord activemodel }.each do |gem|
-    s.add_development_dependency gem, ['>= 3.0.0']
-  end
-  s.add_development_dependency 'sinatra', ['>= 1.3']
-  s.add_development_dependency 'mongoid', ['>= 2']
-  s.add_development_dependency 'mongo_mapper', ['>= 0.9']
-  s.add_development_dependency 'dm-core', ['>= 1.1.0']
-  s.add_development_dependency 'dm-migrations', ['>= 1.1.0']
-  s.add_development_dependency 'dm-aggregates', ['>= 1.1.0']
-  s.add_development_dependency 'dm-sqlite-adapter', ['>= 1.1.0']
+  s.add_development_dependency 'tzinfo', ['>= 0']
   s.add_development_dependency 'rspec', ['>= 0']
-  s.add_development_dependency 'rspec-rails', ['>= 0']
   s.add_development_dependency 'rr', ['>= 0']
   s.add_development_dependency 'capybara', ['>= 1.0']
   s.add_development_dependency 'database_cleaner', ['>= 0']
-  s.add_development_dependency 'padrino-helpers', ['~> 0.10']
-  s.add_development_dependency 'rack-test', ['>= 0']
-  s.add_development_dependency 'sinatra-contrib', ['~> 1.3']
-  s.add_development_dependency 'nokogiri', ['>= 0']
+  s.add_development_dependency 'rdoc', ['>= 0']
 end

data/lib/generators/kaminari/templates/kaminari_config.rb

@@ -1,5 +1,6 @@
 Kaminari.configure do |config|
   # config.default_per_page = 25
+  # config.max_per_page = nil
   # config.window = 4
   # config.outer_window = 0
   # config.left = 0

data/lib/kaminari.rb

@@ -1,73 +1,38 @@
 module Kaminari
-  def self.frameworks
-    frameworks = []
-    case
-      when rails?   then frameworks << 'rails'
-      when sinatra? then frameworks << 'sinatra/base'
-    end
-    frameworks
-  end
+end
 
-  def self.load_framework!
-    show_warning if frameworks.empty?
-    frameworks.each do |framework|
-      begin
-        require framework
-      rescue NameError => e
-        raise "Failed to load framework #{framework.inspect}. Have you added it to Gemfile?"
-      end
-    end
-  end
+# load Rails/Railtie
+begin
+  require 'rails'
+rescue LoadError
+  #do nothing
+end
 
-  def self.show_warning
-    $stderr.puts <<-EOC
+$stderr.puts <<-EOC if !defined?(Rails) && !defined?(Sinatra) && !defined?(Grape)
 warning: no framework detected.
 would you check out if your Gemfile appropriately configured?
 ---- e.g. ----
 when Rails:
-    gem 'rails'
     gem 'kaminari'
 
 when Sinatra/Padrino:
     gem 'kaminari', :require => 'kaminari/sinatra'
 
-    EOC
-  end
-
-  def self.load_kaminari!
-    require 'kaminari/config'
-    require 'kaminari/helpers/action_view_extension'
-    require 'kaminari/helpers/paginator'
-    require 'kaminari/models/page_scope_methods'
-    require 'kaminari/models/configuration_methods'
-  end
+when Grape:
+    gem 'kaminari', :require => 'kaminari/grape'
 
-  def self.hook!
-    load_framework!
-    load_kaminari!
-    require 'kaminari/hooks'
-    if rails?
-      require 'kaminari/railtie'
-      require 'kaminari/engine'
-    elsif sinatra?
-      require 'kaminari/sinatra'
-    else
-      Kaminari::Hooks.init!
-    end
-  end
+EOC
 
-  def self.load!
-    hook!
-  end
+# load Kaminari components
+require 'kaminari/config'
+require 'kaminari/helpers/action_view_extension'
+require 'kaminari/helpers/paginator'
+require 'kaminari/models/page_scope_methods'
+require 'kaminari/models/configuration_methods'
+require 'kaminari/hooks'
 
-  private
-  def self.rails?
-    defined?(::Rails)
-  end
-
-  def self.sinatra?
-    defined?(::Sinatra)
-  end
+# if not using Railtie, call `Kaminari::Hooks.init` directly
+if defined? Rails
+  require 'kaminari/railtie'
+  require 'kaminari/engine'
 end
-
-Kaminari.load!

data/lib/kaminari/config.rb

@@ -18,21 +18,27 @@ module Kaminari
   class Configuration #:nodoc:
     include ActiveSupport::Configurable
     config_accessor :default_per_page
+    config_accessor :max_per_page
     config_accessor :window
     config_accessor :outer_window
     config_accessor :left
     config_accessor :right
     config_accessor :page_method_name
-    config_accessor :param_name
 
     def param_name
       config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
     end
+
+    # define param_name writer (copied from AS::Configurable)
+    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    singleton_class.class_eval writer, __FILE__, line
+    class_eval writer, __FILE__, line
   end
 
   # this is ugly. why can't we pass the default value to config_accessor...?
   configure do |config|
     config.default_per_page = 25
+    config.max_per_page = nil
     config.window = 4
     config.outer_window = 0
     config.left = 0

data/lib/kaminari/grape.rb

@@ -0,0 +1,4 @@
+require 'grape'
+require 'kaminari'
+
+Kaminari::Hooks.init

data/lib/kaminari/helpers/action_view_extension.rb

@@ -15,10 +15,35 @@ module Kaminari
     # * <tt>:remote</tt> - Ajax? (false by default)
     # * <tt>:ANY_OTHER_VALUES</tt> - Any other hash key & values would be directly passed into each tag as :locals value.
     def paginate(scope, options = {}, &block)
-      paginator = Kaminari::Helpers::Paginator.new self, options.reverse_merge(:current_page => scope.current_page, :num_pages => scope.num_pages, :per_page => scope.limit_value, :param_name => Kaminari.config.param_name, :remote => false)
+      paginator = Kaminari::Helpers::Paginator.new self, options.reverse_merge(:current_page => scope.current_page, :total_pages => scope.total_pages, :per_page => scope.limit_value, :param_name => Kaminari.config.param_name, :remote => false)
       paginator.to_s
     end
 
+    # A simple "Twitter like" pagination link that creates a link to the previous page.
+    #
+    # ==== Examples
+    # Basic usage:
+    #
+    #   <%= link_to_previous_page @items, 'Previous Page' %>
+    #
+    # Ajax:
+    #
+    #   <%= link_to_previous_page @items, 'Previous Page', :remote => true %>
+    #
+    # By default, it renders nothing if there are no more results on the previous page.
+    # You can customize this output by passing a block.
+    #
+    #   <%= link_to_previous_page @users, 'Previous Page' do %>
+    #     <span>At the Beginning</span>
+    #   <% end %>
+    def link_to_previous_page(scope, name, options = {}, &block)
+      params = options.delete(:params) || {}
+      param_name = options.delete(:param_name) || Kaminari.config.param_name
+      link_to_unless scope.first_page?, name, params.merge(param_name => (scope.current_page - 1)), options.reverse_merge(:rel => 'previous') do
+        block.call if block
+      end
+    end
+
     # A simple "Twitter like" pagination link that creates a link to the next page.
     #
     # ==== Examples
@@ -55,26 +80,72 @@ module Kaminari
     #
     # By default, the message will use the humanized class name of objects
     # in collection: for instance, "project types" for ProjectType models.
+    # The namespace will be cutted out and only the last name will be used.
     # Override this with the <tt>:entry_name</tt> parameter:
     #
     #   <%= page_entries_info @posts, :entry_name => 'item' %>
     #   #-> Displaying items 6 - 10 of 26 in total
     def page_entries_info(collection, options = {})
-      entry_name = options[:entry_name] || (collection.empty?? 'entry' : collection.first.class.name.underscore.sub('_', ' '))
-      if collection.num_pages < 2
-        case collection.total_count
-        when 0; "No #{entry_name.pluralize} found"
-        when 1; "Displaying <b>1</b> #{entry_name}"
-        else;   "Displaying <b>all #{collection.total_count}</b> #{entry_name.pluralize}"
+      entry_name = if options[:entry_name]
+        options[:entry_name]
+      elsif collection.empty? || collection.is_a?(PaginatableArray)
+        'entry'
+      else
+        if collection.respond_to? :model  # DataMapper
+          collection.model.model_name.human.downcase
+        else  # AR
+          collection.model_name.human.downcase
         end
+      end
+      entry_name = entry_name.pluralize unless collection.total_count == 1
+
+      if collection.total_pages < 2
+        t('helpers.page_entries_info.one_page.display_entries', :entry_name => entry_name, :count => collection.total_count)
+      else
+        first = collection.offset_value + 1
+        last = collection.last_page? ? collection.total_count : collection.offset_value + collection.limit_value
+        t('helpers.page_entries_info.more_pages.display_entries', :entry_name => entry_name, :first => first, :last => last, :total => collection.total_count)
+      end.html_safe
+    end
+
+    # Renders rel="next" and rel="prev" links to be used in the head.
+    #
+    # ==== Examples
+    # Basic usage:
+    #
+    #   In head:
+    #   <head>
+    #     <title>My Website</title>
+    #     <%= yield :head %>
+    #   </head>
+    #
+    #   Somewhere in body:
+    #   <% content_for :head do %>
+    #     <%= rel_next_prev_link_tags @items %>
+    #   <% end %>
+    #
+    #   #-> <link rel="next" href="/items/page/3" /><link rel="prev" href="/items/page/1" />
+    #
+    def rel_next_prev_link_tags(scope, options = {})
+      params = options.delete(:params) || {}
+      param_name = options.delete(:param_name) || Kaminari.config.param_name
+
+      output = ""
+
+      if !scope.first_page? && !scope.last_page?
+        # If not first and not last, then output both links.
+        output << '<link rel="next" href="' + url_for(params.merge(param_name => (scope.current_page + 1))) + '"/>'
+        output << '<link rel="prev" href="' + url_for(params.merge(param_name => (scope.current_page - 1))) + '"/>'
+      elsif scope.first_page?
+        # If first page, add next link unless last page.
+        output << '<link rel="next" href="' + url_for(params.merge(param_name => (scope.current_page + 1))) + '"/>' unless scope.last_page?
       else
-        offset = (collection.current_page - 1) * collection.limit_value
-        %{Displaying #{entry_name.pluralize} <b>%d&nbsp;-&nbsp;%d</b> of <b>%d</b> in total} % [
-          offset + 1,
-          offset + collection.count,
-          collection.total_count
-        ]
+        # If last page, add prev link unless first page.
+        output << '<link rel="prev" href="' + url_for(params.merge(param_name => (scope.current_page - 1))) + '"/>' unless scope.first_page?
       end
+
+      output.html_safe
     end
+
   end
 end

data/lib/kaminari/helpers/paginator.rb

@@ -23,13 +23,16 @@ module Kaminari
         @template, @options = template, options
         @theme = @options[:theme] ? "#{@options[:theme]}/" : ''
         @options[:current_page] = PageProxy.new @window_options.merge(@options), @options[:current_page], nil
+        #FIXME for compatibility. remove num_pages at some time in the future
+        @options[:total_pages] ||= @options[:num_pages]
+        @last = nil
         # initialize the output_buffer for Context
         @output_buffer = ActionView::OutputBuffer.new
       end
 
       # render given block as a view template
       def render(&block)
-        instance_eval &block if @options[:num_pages] > 1
+        instance_eval(&block) if @options[:total_pages] > 1
         @output_buffer
       end
 
@@ -50,10 +53,10 @@ module Kaminari
 
       def relevant_pages(options)
         left_window_plus_one = 1.upto(options[:left] + 1).to_a
-        right_window_plus_one = (options[:num_pages] - options[:right]).upto(options[:num_pages]).to_a
+        right_window_plus_one = (options[:total_pages] - options[:right]).upto(options[:total_pages]).to_a
         inside_window_plus_each_sides = (options[:current_page] - options[:window] - 1).upto(options[:current_page] + options[:window] + 1).to_a
 
-        (left_window_plus_one + inside_window_plus_each_sides + right_window_plus_one).uniq.sort.reject {|x| (x < 1) || (x > options[:num_pages])}
+        (left_window_plus_one + inside_window_plus_each_sides + right_window_plus_one).uniq.sort.reject {|x| (x < 1) || (x > options[:total_pages])}
       end
       private :relevant_pages
 
@@ -114,7 +117,7 @@ module Kaminari
 
         # the last page or not
         def last?
-          @page == @options[:num_pages]
+          @page == @options[:total_pages]
         end
 
         # the previous page or not
@@ -134,7 +137,7 @@ module Kaminari
 
         # within the right outer window or not
         def right_outer?
-          @options[:num_pages] - @page < @options[:right]
+          @options[:total_pages] - @page < @options[:right]
         end
 
         # inside the inner window or not

data/lib/kaminari/helpers/sinatra_helpers.rb

@@ -14,8 +14,14 @@ module Kaminari::Helpers
 
       alias included registered
     end
-    
+
     class ActionViewTemplateProxy
+      include Padrino::Helpers::OutputHelpers
+      include Padrino::Helpers::TagHelpers
+      include Padrino::Helpers::AssetTagHelpers
+      include Padrino::Helpers::FormatHelpers
+      include Padrino::Helpers::TranslationHelpers
+
       def initialize(opts={})
         @current_path = opts[:current_path]
         @param_name = (opts[:param_name] || :page).to_sym
@@ -38,12 +44,25 @@ module Kaminari::Helpers
         query = @current_params.merge(extra_params)
         @current_path + (query.empty? ? '' : "?#{query.to_query}")
       end
-      
+
+      def link_to_unless(condition, name, options = {}, html_options = {}, &block)
+        options = url_for(options) if options.is_a? Hash
+        if condition
+          if block_given?
+            block.arity <= 1 ? capture(name, &block) : capture(name, options, html_options, &block)
+          else
+            name
+          end
+        else
+          link_to(name, options, html_options)
+        end
+      end
+
       def params
         @current_params
       end
     end
-  
+
     module HelperMethods
       # A helper that renders the pagination links - for Sinatra.
       #
@@ -63,7 +82,7 @@ module Kaminari::Helpers
         current_params = Rack::Utils.parse_query(env['QUERY_STRING']).symbolize_keys rescue {}
         paginator = Kaminari::Helpers::Paginator.new(
           ActionViewTemplateProxy.new(:current_params => current_params, :current_path => current_path, :param_name => options[:param_name] || Kaminari.config.param_name),
-          options.reverse_merge(:current_page => scope.current_page, :num_pages => scope.num_pages, :per_page => scope.limit_value, :param_name => Kaminari.config.param_name, :remote => false)
+          options.reverse_merge(:current_page => scope.current_page, :total_pages => scope.total_pages, :per_page => scope.limit_value, :param_name => Kaminari.config.param_name, :remote => false)
         )
         paginator.to_s
       end
@@ -88,10 +107,10 @@ module Kaminari::Helpers
       def link_to_next_page(scope, name, options = {})
         params = options.delete(:params) || (Rack::Utils.parse_query(env['QUERY_STRING']).symbolize_keys rescue {})
         param_name = options.delete(:param_name) || Kaminari.config.param_name
-        placeholder = options.delete(:placeholder) || ""
+        placeholder = options.delete(:placeholder)
         query = params.merge(param_name => (scope.current_page + 1))
         unless scope.last_page?
-          link_to name, env['PATH_INFO'] + (query.empty? ? '' : "?#{query.to_query}"), options.merge(:rel => 'next')
+          link_to name, env['PATH_INFO'] + (query.empty? ? '' : "?#{query.to_query}"), options.reverse_merge(:rel => 'next')
         else
           placeholder
         end