kaminari 0.14.1 → 0.15.0

data/lib/kaminari/helpers/action_view_extension.rb

@@ -88,7 +88,7 @@ module Kaminari
     def page_entries_info(collection, options = {})
       entry_name = if options[:entry_name]
         options[:entry_name]
-      elsif collection.empty? || collection.is_a?(PaginatableArray)
+      elsif collection.is_a?(::Kaminari::PaginatableArray)
         'entry'
       else
         if collection.respond_to? :model  # DataMapper
@@ -146,6 +146,5 @@ module Kaminari
 
       output.html_safe
     end
-
   end
 end

data/lib/kaminari/helpers/paginator.rb

@@ -25,6 +25,7 @@ module Kaminari
         @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]
+        @options[:num_pages] ||= @options[:total_pages]
         @last = nil
         # initialize the output_buffer for Context
         @output_buffer = ActionView::OutputBuffer.new
@@ -74,22 +75,32 @@ module Kaminari
 
       def to_s #:nodoc:
         subscriber = ActionView::LogSubscriber.log_subscribers.detect {|ls| ls.is_a? ActionView::LogSubscriber}
-        return super @window_options.merge(@options).merge :paginator => self unless subscriber
 
-        # dirty hack to suppress logging render_partial
-        class << subscriber
-          alias_method :render_partial_with_logging, :render_partial
-          # do nothing
-          def render_partial(event); end
-        end
+        # There is a logging subscriber
+        # and we don't want it to log render_partial
+        # It is threadsafe, but might not repress logging
+        # consistently in a high-load environment
+        if subscriber
+          unless defined? subscriber.render_partial_with_logging
+            class << subscriber
+              alias_method :render_partial_with_logging, :render_partial
+              attr_accessor :render_without_logging
+              # ugly hack to make a renderer where
+              # we can turn logging on or off
+              def render_partial(event)
+                render_partial_with_logging(event) unless render_without_logging
+              end
+            end
+          end
 
-        ret = super @window_options.merge(@options).merge :paginator => self
+          subscriber.render_without_logging = true
+          ret = super @window_options.merge(@options).merge :paginator => self
+          subscriber.render_without_logging = false
 
-        class << subscriber
-          alias_method :render_partial, :render_partial_with_logging
-          undef :render_partial_with_logging
+          ret
+        else
+          super @window_options.merge(@options).merge :paginator => self
         end
-        ret
       end
 
       # Wraps a "page number" and provides some utility methods

data/lib/kaminari/helpers/sinatra_helpers.rb

@@ -10,6 +10,11 @@ module Kaminari::Helpers
       def registered(app)
         app.register Padrino::Helpers
         app.helpers  HelperMethods
+        @app = app
+      end
+
+      def view_paths
+        @app.views
       end
 
       alias included registered
@@ -31,6 +36,7 @@ module Kaminari::Helpers
 
       def render(*args)
         base = ActionView::Base.new.tap do |a|
+          a.view_paths << SinatraHelpers.view_paths
           a.view_paths << File.expand_path('../../../../app/views', __FILE__)
         end
         base.render(*args)
@@ -125,7 +131,7 @@ end
 
 rescue LoadError
 
-$stderr.puts "[!]You shold install `padrino-helpers' gem if you want to use kaminari's pagination helpers with Sinatra."
+$stderr.puts "[!]You should install `padrino-helpers' gem if you want to use kaminari's pagination helpers with Sinatra."
 $stderr.puts "[!]Kaminari::Helpers::SinatraHelper does nothing now..."
 
 module Kaminari::Helpers

data/lib/kaminari/helpers/tags.rb

@@ -21,7 +21,7 @@ module Kaminari
       end
 
       def to_s(locals = {}) #:nodoc:
-        @template.render :partial => "kaminari/#{@theme}#{self.class.name.demodulize.underscore}", :locals => @options.merge(locals)
+        @template.render :partial => "kaminari/#{@theme}#{self.class.name.demodulize.underscore}", :locals => @options.merge(locals), :formats => [:html]
       end
 
       def page_url_for(page)

data/lib/kaminari/models/active_record_model_extension.rb

@@ -6,14 +6,16 @@ module Kaminari
 
     included do
       self.send(:include, Kaminari::ConfigurationMethods)
+    end
 
+    module ClassMethods
       # Fetch the values at the specified page number
       #   Model.page(5)
-      self.scope Kaminari.config.page_method_name, Proc.new {|num|
-        limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1))
-      } do
-        include Kaminari::ActiveRecordRelationMethods
-        include Kaminari::PageScopeMethods
+      define_method(Kaminari.config.page_method_name) do |num = nil|
+        limit(default_per_page).offset(default_per_page * ([num.to_i, 1].max - 1)).extending do
+          include Kaminari::ActiveRecordRelationMethods
+          include Kaminari::PageScopeMethods
+        end
       end
     end
   end

data/lib/kaminari/models/active_record_relation_methods.rb

@@ -3,12 +3,12 @@ module Kaminari
     # a workaround for AR 3.0.x that returns 0 for #count when page > 1
     # if +limit_value+ is specified, load all the records and count them
     if ActiveRecord::VERSION::STRING < '3.1'
-      def count #:nodoc:
-        limit_value ? length : super
+      def count(column_name = nil, options = {}) #:nodoc:
+        limit_value && !options[:distinct] ? length : super(column_name, options)
       end
     end
 
-    def total_count #:nodoc:
+    def total_count(column_name = :all, options = {}) #:nodoc:
       # #count overrides the #select which could include generated columns referenced in #order, so skip #order here, where it's irrelevant to the result anyway
       @total_count ||= begin
         c = except(:offset, :limit, :order)
@@ -16,14 +16,16 @@ module Kaminari
         # Remove includes only if they are irrelevant
         c = c.except(:includes) unless references_eager_loaded_tables?
 
-        # a workaround to count the actual model instances on distinct query because count + distinct returns wrong value in some cases. see https://github.com/amatsuda/kaminari/pull/160
-        uses_distinct_sql_statement = c.to_sql =~ /DISTINCT/i
-        if uses_distinct_sql_statement
-          c.length
+        # Rails 4.1 removes the `options` argument from AR::Relation#count
+        args = [column_name]
+        args << options if ActiveRecord::VERSION::STRING < '4.1.0'
+
+        # .group returns an OrderdHash that responds to #count
+        c = c.count(*args)
+        if c.is_a?(Hash) || c.is_a?(ActiveSupport::OrderedHash)
+          c.count
         else
-          # .group returns an OrderdHash that responds to #count
-          c = c.count
-          c.respond_to?(:count) ? c.count : c
+          c.respond_to?(:count) ? c.count(*args) : c
         end
       end
     end

data/lib/kaminari/models/array_extension.rb

@@ -11,12 +11,10 @@ module Kaminari
     # * <tt>:offset</tt> - offset
     # * <tt>:total_count</tt> - total_count
     def initialize(original_array = [], options = {})
-      @_original_array, @_limit_value, @_offset_value, @_total_count = original_array, (options[:limit] || default_per_page).to_i, options[:offset].to_i, options[:total_count]
+      @_original_array, @_limit_value, @_offset_value, @_total_count, @_padding = original_array, (options[:limit] || default_per_page).to_i, options[:offset].to_i, options[:total_count], options[:padding].to_i
 
       if options[:limit] && options[:offset]
-        class << self
-          include Kaminari::PageScopeMethods
-        end
+        extend Kaminari::PageScopeMethods
       end
 
       if options[:total_count]
@@ -35,7 +33,7 @@ module Kaminari
 
     # returns another chunk of the original array
     def limit(num)
-      self.class.new @_original_array, :limit => num, :offset => @_offset_value, :total_count => @_total_count
+      self.class.new @_original_array, :limit => num, :offset => @_offset_value, :total_count => @_total_count, :padding => @_padding
     end
 
     # total item numbers of the original array
@@ -45,7 +43,7 @@ module Kaminari
 
     # returns another chunk of the original array
     def offset(num)
-      self.class.new @_original_array, :limit => @_limit_value, :offset => num, :total_count => @_total_count
+      self.class.new @_original_array, :limit => @_limit_value, :offset => num, :total_count => @_total_count, :padding => @_padding
     end
   end
 

data/lib/kaminari/models/configuration_methods.rb

@@ -13,7 +13,7 @@ module Kaminari
       # This model's default +per_page+ value
       # returns +default_per_page+ value unless explicitly overridden via <tt>paginates_per</tt>
       def default_per_page
-        @_default_per_page ||= Kaminari.config.default_per_page
+        (defined?(@_default_per_page) && @_default_per_page) || Kaminari.config.default_per_page
       end
 
       # Overrides the max +per_page+ value per model
@@ -27,7 +27,21 @@ module Kaminari
       # This model's max +per_page+ value
       # returns +max_per_page+ value unless explicitly overridden via <tt>max_paginates_per</tt>
       def max_per_page
-        @_max_per_page || Kaminari.config.max_per_page
+        (defined?(@_max_per_page) && @_max_per_page) || Kaminari.config.max_per_page
+      end
+
+      # Overrides the max_pages value per model
+      #   class Article < ActiveRecord::Base
+      #     max_pages_per 100
+      #   end
+      def max_pages_per(val)
+        @_max_pages = val
+      end
+
+      # This model's max_pages value
+      # returns max_pages value unless explicitly overridden via <tt>max_pages_per</tt>
+      def max_pages
+        (defined?(@_max_pages) && @_max_pages) || Kaminari.config.max_pages
       end
     end
   end

data/lib/kaminari/models/data_mapper_extension.rb

@@ -5,8 +5,10 @@ module Kaminari
     module Paginatable
       class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def #{Kaminari.config.page_method_name}(num = 1)
+          model = self
+          model = self.model if self.is_a? DataMapper::Collection
           num = [num.to_i, 1].max - 1
-          all(:limit => default_per_page, :offset => default_per_page * num).extend Paginating
+          all(:limit => model.default_per_page, :offset => model.default_per_page * num).extend Paginating
         end
       RUBY
     end
@@ -26,9 +28,10 @@ module Kaminari
     module Collection
       extend ActiveSupport::Concern
       included do
-        include Kaminari::ConfigurationMethods::ClassMethods
         include Kaminari::DataMapperCollectionMethods
         include Paginatable
+
+        delegate :default_per_page, :max_per_page, :max_pages, :to => :model
       end
     end
 

data/lib/kaminari/models/page_scope_methods.rb

@@ -13,22 +13,46 @@ module Kaminari
     end
 
     def padding(num)
+      @_padding = num
       offset(offset_value + num.to_i)
     end
 
     # Total number of pages
     def total_pages
-      (total_count.to_f / limit_value).ceil
+      count_without_padding = total_count
+      count_without_padding -= @_padding if defined?(@_padding) && @_padding
+      count_without_padding = 0 if count_without_padding < 0
+
+      total_pages_count = (count_without_padding.to_f / limit_value).ceil
+      if max_pages.present? && max_pages < total_pages_count
+        max_pages
+      else
+        total_pages_count
+      end
     end
     #FIXME for compatibility. remove num_pages at some time in the future
     alias num_pages total_pages
 
     # Current page number
     def current_page
-      (offset_value / limit_value) + 1
+      offset_without_padding = offset_value
+      offset_without_padding -= @_padding if defined?(@_padding) && @_padding
+      offset_without_padding = 0 if offset_without_padding < 0
+
+      (offset_without_padding / limit_value) + 1
+    end
+
+    # Next page number in the collection
+    def next_page
+      current_page + 1 unless last_page?
+    end
+
+    # Previous page number in the collection
+    def prev_page
+      current_page - 1 unless first_page?
     end
 
-    # First page of the collection ?
+    # First page of the collection?
     def first_page?
       current_page == 1
     end
@@ -37,5 +61,10 @@ module Kaminari
     def last_page?
       current_page >= total_pages
     end
+
+    # Out of range of the collection?
+    def out_of_range?
+      current_page > total_pages
+    end
   end
 end

data/lib/kaminari/models/plucky_criteria_methods.rb

@@ -1,7 +1,8 @@
 module Kaminari
   module PluckyCriteriaMethods
     include Kaminari::PageScopeMethods
-    include Kaminari::ConfigurationMethods::ClassMethods
+
+    delegate :default_per_page, :max_per_page, :max_pages, :to => :model
 
     def limit_value #:nodoc:
       options[:limit]

data/lib/kaminari/version.rb

@@ -1,3 +1,3 @@
 module Kaminari
-  VERSION = '0.14.1'
+  VERSION = '0.15.0'
 end

data/lib/kaminari.rb

@@ -10,15 +10,16 @@ end
 
 $stderr.puts <<-EOC if !defined?(Rails) && !defined?(Sinatra) && !defined?(Grape)
 warning: no framework detected.
-would you check out if your Gemfile appropriately configured?
+
+Your Gemfile might not be configured properly.
 ---- e.g. ----
-when Rails:
+Rails:
     gem 'kaminari'
 
-when Sinatra/Padrino:
+Sinatra/Padrino:
     gem 'kaminari', :require => 'kaminari/sinatra'
 
-when Grape:
+Grape:
     gem 'kaminari', :require => 'kaminari/grape'
 
 EOC

data/spec/config/config_spec.rb

@@ -73,4 +73,19 @@ describe Kaminari::Configuration do
       end
     end
   end
+
+  describe 'max_pages' do
+    context 'by default' do
+      its(:max_pages) { should == nil }
+    end
+    context 'configure via config block' do
+      before do
+        Kaminari.configure {|c| c.max_pages = 5}
+      end
+      its(:max_pages) { should == 5 }
+      after do
+        Kaminari.configure {|c| c.max_pages = nil}
+      end
+    end
+  end
 end

data/spec/fake_app/active_record/models.rb

@@ -42,6 +42,13 @@ class User::Address < ActiveRecord::Base
   belongs_to :user
 end
 
+# a class that uses abstract class
+class Product < ActiveRecord::Base
+  self.abstract_class = true
+end
+class Device < Product
+end
+
 #migrations
 class CreateAllTables < ActiveRecord::Migration
   def self.up
@@ -51,6 +58,7 @@ class CreateAllTables < ActiveRecord::Migration
     create_table(:readerships) {|t| t.integer :user_id; t.integer :book_id }
     create_table(:authorships) {|t| t.integer :user_id; t.integer :book_id }
     create_table(:user_addresses) {|t| t.string :street; t.integer :user_id }
+    create_table(:devices) {|t| t.string :name; t.integer :age}
   end
 end
 ActiveRecord::Migration.verbose = false

data/spec/fake_app/rails_app.rb

@@ -11,6 +11,7 @@ app = Class.new(Rails::Application)
 app.config.secret_token = '3b7cd727ee24e8444053437c36cc66c4'
 app.config.session_store :cookie_store, :key => '_myapp_session'
 app.config.active_support.deprecation = :log
+app.config.eager_load = false
 # Rais.root
 app.config.root = File.dirname(__FILE__)
 Rails.backtrace_cleaner.remove_silencers!

data/spec/helpers/action_view_extension_spec.rb

@@ -77,7 +77,7 @@ describe 'Kaminari::ActionViewExtension' do
       end
       context 'having no entries' do
         subject { helper.page_entries_info @users, :params => {:controller => 'users', :action => 'index'} }
-        it      { should == 'No entries found' }
+        it      { should == 'No users found' }
 
         context 'setting the entry name option to "member"' do
           subject { helper.page_entries_info @users, :entry_name => 'member', :params => {:controller => 'users', :action => 'index'} }
@@ -151,7 +151,7 @@ describe 'Kaminari::ActionViewExtension' do
       end
       context 'having no entries' do
         subject { helper.page_entries_info @addresses, :params => {:controller => 'addresses', :action => 'index'} }
-        it      { should == 'No entries found' }
+        it      { should == 'No addresses found' }
       end
 
       context 'having 1 entry' do

data/spec/models/active_record/active_record_relation_methods_spec.rb

@@ -19,10 +19,51 @@ if defined? ActiveRecord
           @author.readers.by_read_count.page(1).total_count.should == @readers.size
         end
       end
+
       context "when the scope use conditions on includes" do
         it "should keep includes and successfully count the results" do
           # Only @author and @author2 have books titled with the title00x partern
-          User.includes(:books_authored).where("books.title LIKE 'title00%'").page(1).total_count.should == 2
+          if ActiveRecord::VERSION::STRING >= "4.1.0"
+            User.includes(:books_authored).references(:books).where("books.title LIKE 'title00%'").page(1).total_count.should == 2
+          else
+            User.includes(:books_authored).where("books.title LIKE 'title00%'").page(1).total_count.should == 2
+          end
+        end
+      end
+
+      context 'when the Relation has custom select clause' do
+        specify do
+          lambda { User.select('*, 1 as one').page(1).total_count }.should_not raise_exception
+        end
+      end
+
+      context "when total_count receives options" do
+        it "should return a distinct total count for rails < 4.1" do
+          if ActiveRecord::VERSION::STRING < "4.1.0"
+            User.page(1).total_count(:name, :distinct => true).should == 4
+          end
+        end
+
+        it "should ignore the options for rails 4.1+" do
+          if ActiveRecord::VERSION::STRING >= "4.1.0"
+            User.page(1).total_count(:name, :distinct => true).should == 7
+          end
+        end
+      end
+
+      if ActiveRecord::VERSION::STRING < '4.1.0'
+        context 'when count receives options' do
+          it 'should return a distinct set by column for rails < 4.1' do
+            User.page(1).count(:name, :distinct => true).should == 4
+          end
+        end
+      end
+
+      context "when the scope returns an ActiveSupport::OrderedHash" do
+        it "should not throw exception by passing options to count" do
+          lambda {
+            @author.readers.by_read_count.page(1).total_count(:name, :distinct => true)
+          }.should_not raise_exception
         end
       end
     end

data/spec/models/active_record/scopes_spec.rb

@@ -15,9 +15,10 @@ if defined? ActiveRecord
     before do
       1.upto(100) {|i| User.create! :name => "user#{'%03d' % i}", :age => (i / 10)}
       1.upto(100) {|i| GemDefinedModel.create! :name => "user#{'%03d' % i}", :age => (i / 10)}
+      1.upto(100) {|i| Device.create! :name => "user#{'%03d' % i}", :age => (i / 10)}
     end
 
-    [User, Admin, GemDefinedModel].each do |model_class|
+    [User, Admin, GemDefinedModel, Device].each do |model_class|
       context "for #{model_class}" do
         describe '#page' do
           context 'page 1' do
@@ -58,6 +59,11 @@ if defined? ActiveRecord
             it { should have(5).users }
             its('first.name') { should == 'user001' }
           end
+
+          context "page 1 per nil (using default)" do
+            subject { model_class.page(1).per(nil) }
+            it { should have(model_class.default_per_page).users }
+          end
         end
 
         describe '#padding' do
@@ -66,6 +72,12 @@ if defined? ActiveRecord
             it { should have(5).users }
             its('first.name') { should == 'user002' }
           end
+
+          context 'page 19 per 5 padding 5' do
+            subject { model_class.page(19).per(5).padding(5) }
+            its(:current_page) { should == 19 }
+            its(:total_pages) { should == 19 }
+          end
         end
 
         describe '#total_pages' do
@@ -98,8 +110,32 @@ if defined? ActiveRecord
             subject { model_class.page(5).per('aho') }
             its(:total_pages) { should == 4 }
           end
-        end
 
+          context 'with max_pages < total pages count from database' do
+            before { model_class.max_pages_per 3 }
+            subject { model_class.page }
+            its(:total_pages) { should == 3 }
+            after { model_class.max_pages_per nil }
+          end
+
+          context 'with max_pages > total pages count from database' do
+            before { model_class.max_pages_per 11 }
+            subject { model_class.page }
+            its(:total_pages) { should == 4 }
+            after { model_class.max_pages_per nil }
+          end
+
+          context 'with max_pages is nil' do
+            before { model_class.max_pages_per nil }
+            subject { model_class.page }
+            its(:total_pages) { should == 4 }
+          end
+
+          context "with per(nil) using default" do
+            subject { model_class.page.per(nil) }
+            its(:total_pages) { should == 4 }
+          end
+        end
 
         describe '#current_page' do
           context 'page 1' do
@@ -113,6 +149,30 @@ if defined? ActiveRecord
           end
         end
 
+        describe '#next_page' do
+          context 'page 1' do
+            subject { model_class.page }
+            its(:next_page) { should == 2 }
+          end
+
+          context 'page 5' do
+            subject { model_class.page(5) }
+            its(:next_page) { should be_nil }
+          end
+        end
+
+        describe '#prev_page' do
+          context 'page 1' do
+            subject { model_class.page }
+            its(:prev_page) { should be_nil }
+          end
+
+          context 'page 5' do
+            subject { model_class.page(5) }
+            its(:prev_page) { should == 4 }
+          end
+        end
+
         describe '#first_page?' do
           context 'on first page' do
             subject { model_class.page(1).per(10) }
@@ -137,6 +197,23 @@ if defined? ActiveRecord
           end
         end
 
+        describe '#out_of_range?' do
+          context 'on last page' do
+            subject { model_class.page(10).per(10) }
+            its(:out_of_range?) { should == false }
+          end
+
+          context 'within range' do
+            subject { model_class.page(1).per(10) }
+            its(:out_of_range?) { should == false }
+          end
+
+          context 'out of range' do
+            subject { model_class.page(11).per(10) }
+            its(:out_of_range?) { should == true }
+          end
+        end
+
         describe '#count' do
           context 'page 1' do
             subject { model_class.page }

data/spec/models/array_spec.rb

@@ -86,6 +86,11 @@ describe Kaminari::PaginatableArray do
       subject { array.page(5).per('aho') }
       its(:total_pages) { should == 4 }
     end
+
+    context 'per 25, padding 25' do
+      subject { array.page(1).padding(25) }
+      its(:total_pages) { should == 3 }
+    end
   end
 
   describe '#current_page' do
@@ -100,6 +105,30 @@ describe Kaminari::PaginatableArray do
     end
   end
 
+  describe '#next_page' do
+    context 'page 1' do
+      subject { array.page }
+      its(:next_page) { should == 2 }
+    end
+
+    context 'page 5' do
+      subject { array.page 5 }
+      its(:next_page) { should be_nil }
+    end
+  end
+
+  describe '#prev_page' do
+    context 'page 1' do
+      subject { array.page }
+      its(:prev_page) { should be_nil }
+    end
+
+    context 'page 5' do
+      subject { array.page 5 }
+      its(:prev_page) { should == 4 }
+    end
+  end
+
   describe '#count' do
     context 'page 1' do
       subject { array.page }