magic_grid 0.12.3 → 0.12.4

data/Rakefile

@@ -32,6 +32,6 @@ RSpec::Core::RakeTask.new(:spec) do |t|
 end
 
 desc "Run TestUnit and RSpec tests"
-task tests: [:spec, :test]
+task :tests => [:spec, :test]
 
-task default: :tests
+task :default => :tests

data/lib/magic_grid/collection.rb

@@ -5,15 +5,15 @@ module MagicGrid
   class Collection
 
     DEFAULTS = {
-      per_page: 30,
-      searchable: [],
-      search_method: :search,
-      listener_handler: nil,
-      default_col: 0,
-      default_order: :asc,
-      post_filter: false,
-      collection_post_filter: true,
-      count: nil,
+      :per_page => 30,
+      :searchable => [],
+      :search_method => :search,
+      :listener_handler => nil,
+      :default_col => 0,
+      :default_order => :asc,
+      :post_filter => false,
+      :collection_post_filter => true,
+      :count => nil,
     }
 
     def initialize(collection, opts = {})
@@ -28,12 +28,14 @@ module MagicGrid
       @post_filter_callbacks = []
       @paginations = []
       @searchable_columns = []
+      @@kaminari_class = defined?(Kaminari) ? Kaminari : nil
     end
 
-    delegate :quoted_table_name, :map, :count, to: :collection
+    delegate :quoted_table_name, :map, :count, :to => :collection
 
     attr_accessor :searchable_columns
     attr_reader :current_page, :original_count, :total_pages, :per_page, :searches
+    cattr_accessor :kaminari_class
 
     def options=(opts)
       @options = DEFAULTS.merge(opts || {})
@@ -85,7 +87,7 @@ module MagicGrid
         begin
           search_cols = searchable_columns.map {|c| c.custom_sql || c.name }
           clauses = search_cols.map {|c| c << " LIKE :search" }.join(" OR ")
-          result = collection.where(clauses, {search: "%#{q}%"})
+          result = collection.where(clauses, {:search => "%#{q}%"})
         rescue
           MagicGrid.logger.debug "Given collection doesn't respond to :where well"
         end
@@ -181,7 +183,7 @@ module MagicGrid
       @original_count = self.count @collection
       @per_page = n
       if @per_page
-        @total_pages = @original_count / @per_page
+        @total_pages = calculate_total_pages(@per_page, @original_count)
       else
         @total_pages = 1
       end
@@ -213,13 +215,13 @@ module MagicGrid
                                          total_entries)
 
       if collection.respond_to? :paginate
-        collection.paginate(page: @current_page,
-                            per_page: @per_page,
-                            total_entries: total_entries)
+        collection.paginate(:page => @current_page,
+                            :per_page => @per_page,
+                            :total_entries => total_entries)
       elsif collection.respond_to? :page
         collection.page(@current_page).per(@per_page)
-      elsif collection.is_a?(Array) and Module.const_defined?(:Kaminari)
-         Kaminari.paginate_array(collection).page(@current_page).per(@per_page)
+      elsif collection.is_a?(Array) and @@kaminari_class
+         @@kaminari_class.paginate_array(collection).page(@current_page).per(@per_page)
       else
          default_paginate(collection, @current_page, @per_page)
       end
@@ -256,16 +258,26 @@ module MagicGrid
       @reduced_collection ||= apply_all_operations(@collection)
     end
 
-    private
+    def calculate_total_pages(per_page, total_entries)
+      pages = total_entries / per_page
+      pages += 1 if total_entries % per_page > 0
+      if pages < 1
+        1
+      else
+        pages
+      end
+    end
 
     def bound_current_page(page, per_page, total_entries)
-      pages = total_entries / per_page
-      pages = 1 if pages == 0
-      if page > pages
+      pages = calculate_total_pages(per_page, total_entries)
+      if page < 1
+        1
+      elsif page > pages
         pages
       else
         page
       end
     end
+
   end
 end

data/lib/magic_grid/column.rb

@@ -2,7 +2,7 @@ module MagicGrid
   class Column
 
     def self.columns_for_collection(collection, columns, searchables)
-      columns.map.each_with_index { |c, i|
+      columns.each_with_index.map { |c, i|
         MagicGrid::Column.new(collection, c, i)
       }.tap do |cols|
         if searchables == false
@@ -68,9 +68,9 @@ module MagicGrid
       @collection = collection
       @col = case c
               when Symbol
-                {col: c}
+                {:col => c}
               when String
-                {label: c}
+                {:label => c}
               else
                 c
               end

data/lib/magic_grid/definition.rb

@@ -17,31 +17,30 @@ module MagicGrid
     end
 
     DEFAULTS = {
-      class: [],
-      top_pager: false,
-      bottom_pager: true,
-      remote: false,
-      min_search_length: 3,
-      id: false,
-      searcher: false,
-      needs_searcher: false,
-      live_search: false,
-      listeners: {},
-      collapse_empty_header: false,
-      collapse_empty_footer: false,
-      default_ajax_handler: true,
-      search_button: false,
-      searcher_size: nil,
+      :class => [],
+      :top_pager => false,
+      :bottom_pager => true,
+      :remote => false,
+      :min_search_length => 3,
+      :id => false,
+      :searcher => false,
+      :needs_searcher => false,
+      :live_search => false,
+      :listeners => {},
+      :collapse_empty_header => false,
+      :collapse_empty_footer => false,
+      :default_ajax_handler => true,
+      :search_button => false,
+      :searcher_size => nil,
     }
 
     def self.runtime_defaults
       # run these lazily to catch any late I18n path changes
-      DEFAULTS.merge(Collection::DEFAULTS)
-              .merge(
-        if_empty:         I18n.t("magic_grid.no_results").capitalize, # "No results found."
-        searcher_label:   I18n.t("magic_grid.search.label").capitalize + ': ', # "Search: "
-        searcher_tooltip: I18n.t("magic_grid.search.tooltip"), # "type.. + <return>"
-        searcher_button:  I18n.t("magic_grid.search.button").capitalize, # "Search"
+      DEFAULTS.merge(Collection::DEFAULTS).merge(
+        :if_empty =>         I18n.t("magic_grid.no_results").capitalize, # "No results found."
+        :searcher_label =>   I18n.t("magic_grid.search.label").capitalize + ': ', # "Search: "
+        :searcher_tooltip => I18n.t("magic_grid.search.tooltip"), # "type.. + <return>"
+        :searcher_button =>  I18n.t("magic_grid.search.button").capitalize # "Search"
       )
     end
 
@@ -121,7 +120,7 @@ module MagicGrid
     end
 
     def base_params
-      @params.merge magic_grid_id: magic_id
+      @params.merge :magic_grid_id => magic_id
     end
 
     def current_page

data/lib/magic_grid/html_grid.rb

@@ -16,18 +16,18 @@ module MagicGrid
     def render(&row_renderer)
       @spinner_drawn = false
       grid_data = {
-        searcher: @grid.searcher,
-        current: @current_url,
-        live_search: @grid.options[:live_search],
-        listeners: @grid.options[:listeners],
-        remote: @grid.options[:remote],
-        default_ajax_handler: @grid.options[:default_ajax_handler],
-        params: @grid.base_params,
+        :searcher => @grid.searcher,
+        :current => @current_url,
+        :live_search => @grid.options[:live_search],
+        :listeners => @grid.options[:listeners],
+        :remote => @grid.options[:remote],
+        :default_ajax_handler => @grid.options[:default_ajax_handler],
+        :params => @grid.base_params,
       }
       table_options = {
-        class: (['magic_grid'] << @grid.options[:class]).join(' '),
-        id: @grid.magic_id,
-        data: grid_data.select {|_,v| v }
+        :class => (['magic_grid'] << @grid.options[:class]).join(' '),
+        :id => @grid.magic_id,
+        :data => grid_data.select {|_,v| v }
       }
       @view.content_tag('table', table_options) do
         thead + tbody(&row_renderer) + tfoot
@@ -35,13 +35,13 @@ module MagicGrid
     end
 
     def thead
-      @view.content_tag('thead', data: {params: @grid.base_params}) do
+      @view.content_tag('thead', :data => {:params => @grid.base_params}) do
         magic_grid_head
       end
     end
 
     def tbody(&row_renderer)
-      @view.content_tag('tbody', class: "ui-widget-content") do
+      @view.content_tag('tbody', :class => "ui-widget-content") do
         magic_rows &row_renderer
       end
     end
@@ -56,8 +56,8 @@ module MagicGrid
       unless @spinner_drawn
         @spinner_drawn = true
         @view.tag('span',
-                  id: (@grid.magic_id.to_s + "_spinner"),
-                  class: "magic_grid_spinner")
+                  :id => (@grid.magic_id.to_s + "_spinner"),
+                  :class => "magic_grid_spinner")
       end
     end
 
@@ -88,8 +88,8 @@ module MagicGrid
     def filler_block(content = nil, &block)
       @view.content_tag 'tr' do
         @view.content_tag('td', content,
-                          class: 'full-width ui-widget-header',
-                          colspan: @grid.columns.count,
+                          :class => 'full-width ui-widget-header',
+                          :colspan => @grid.columns.count,
                           &block)
       end
     end
@@ -102,7 +102,7 @@ module MagicGrid
           if col.sortable?
             sortable_header(col)
           else
-            @view.content_tag 'th', col.label.html_safe, class: classes.join(' ')
+            @view.content_tag 'th', col.label.html_safe, :class => classes.join(' ')
           end
         end
       end
@@ -119,8 +119,8 @@ module MagicGrid
     def render_empty_collection(fallback)
       if fallback
         @view.content_tag 'tr' do
-          @view.content_tag('td', colspan: @grid.columns.count,
-                            class: 'if-empty') do
+          @view.content_tag('td', :colspan => @grid.columns.count,
+                            :class => 'if-empty') do
             if fallback.respond_to? :call
               fallback.call(@grid).to_s
             else
@@ -135,14 +135,14 @@ module MagicGrid
       if row_renderer
         @view.capture(record, &row_renderer)
       else
-        @view.content_tag 'tr', class: @view.cycle('odd', 'even') do
+        @view.content_tag 'tr', :class => @view.cycle('odd', 'even') do
           @grid.columns.map { |c| grid_cell(c, record) }.join.html_safe
         end
       end
     end
 
     def grid_cell(column, record)
-      @view.content_tag('td', class: column.html_classes) do
+      @view.content_tag('td', :class => column.html_classes) do
         method = column.reader
         if method.respond_to? :call
           method.call(record).to_s
@@ -163,7 +163,7 @@ module MagicGrid
     end
 
     def order_icon(order = -1)
-      @view.content_tag 'span', '', class: "ui-icon #{order_icon_class(order)}"
+      @view.content_tag 'span', '', :class => "ui-icon #{order_icon_class(order)}"
     end
 
     def order_icon_class(order = -1)
@@ -202,8 +202,8 @@ module MagicGrid
       if column_link_params[@grid.param_key(:order)].to_i == default_sort_order.to_i
         column_link_params.delete(@grid.param_key(:order))
       end
-      @view.content_tag 'th', class: classes.join(' ') do
-        @view.link_to column_link_params, remote: @grid.options[:remote] do
+      @view.content_tag 'th', :class => classes.join(' ') do
+        @view.link_to column_link_params, :remote => @grid.options[:remote] do
           label.html_safe << order_icon(order)
         end
       end
@@ -211,8 +211,8 @@ module MagicGrid
 
     def searcher_block(&spinner)
       @view.content_tag('tr') do
-        @view.content_tag('td', class: 'searcher full-width ui-widget-header',
-                    colspan: @grid.columns.count) do
+        @view.content_tag('td', :class => 'searcher full-width ui-widget-header',
+                    :colspan => @grid.columns.count) do
           searcher_input(&spinner)
         end
       end
@@ -220,20 +220,20 @@ module MagicGrid
 
     def searcher_input(&spinner)
       searcher_data = {
-        min_length: @grid.options[:min_search_length],
-        current: @grid.current_search || "",
+        :min_length => @grid.options[:min_search_length],
+        :current => @grid.current_search || "",
       }
       searcher = @view.label_tag(@grid.searcher.to_sym,
                            @grid.options[:searcher_label])
       searcher << @view.search_field_tag(@grid.searcher.to_sym,
         @grid.param(:q),
-        placeholder: @grid.options[:searcher_tooltip],
-        size: @grid.options[:searcher_size],
-        data: searcher_data,
-        form: "a form that doesn't exist")
+        :placeholder => @grid.options[:searcher_tooltip],
+        :size => @grid.options[:searcher_size],
+        :data => searcher_data,
+        :form => "a form that doesn't exist")
       if @grid.options[:search_button]
         searcher << @view.button_tag(@grid.options[:searcher_button],
-          class: 'magic-grid-search-button')
+          :class => 'magic-grid-search-button')
       end
       searcher << yield if block_given?
       searcher
@@ -254,11 +254,11 @@ module MagicGrid
 
     def magic_pager_block(&spinner)
       @view.content_tag('tr') do
-        @view.content_tag('td', class: 'full-width ui-widget-header magic-pager',
-                    colspan: @grid.columns.count) do
+        @view.content_tag('td', :class => 'full-width ui-widget-header magic-pager',
+                    :colspan => @grid.columns.count) do
           pager = magic_pager(@grid.magic_collection,
-                                param_name: @grid.param_key(:page),
-                                params: @grid.base_params
+                                :param_name => @grid.param_key(:page),
+                                :params => @grid.base_params
                                )
           if spinner
             pager << @view.capture(&spinner)

data/lib/magic_grid/version.rb

@@ -1,3 +1,3 @@
 module MagicGrid
-  VERSION = "0.12.3"
+  VERSION = "0.12.4"
 end

data/spec/collection_spec.rb

@@ -95,16 +95,88 @@ describe MagicGrid::Collection do
     end
   end
 
+  describe "pagination" do
+    context "#calculate_total_pages" do
+      let(:array) { Array.new(10) { 1 }  }
+      subject { MagicGrid::Collection.new(array, nil) }
+      it "should round correctly" do
+        subject.calculate_total_pages(2, 10).should == 5
+        subject.calculate_total_pages(3, 10).should == 4
+        subject.calculate_total_pages(4, 10).should == 3
+      end
+    end
+
+    context "#bound_current_page" do
+      let(:array) { Array.new(10) { 1 }  }
+      subject { MagicGrid::Collection.new(array, nil) }
+
+      it "should round page 0 correctly" do
+        subject.bound_current_page(0, 2, 10).should == 1
+        subject.bound_current_page(0, 3, 10).should == 1
+        subject.bound_current_page(0, 4, 10).should == 1
+      end
+
+      it "should round page > pages correctly" do
+        subject.bound_current_page(10, 2, 10).should == 5
+        subject.bound_current_page(10, 3, 10).should == 4
+        subject.bound_current_page(10, 4, 10).should == 3
+      end
+    end
+  end
+
+  describe "#perform_pagination" do
+
+    context "page counts" do
+      let(:array) { Array.new(100) { 1 }  }
+      subject { MagicGrid::Collection.new(array, nil) }
+
+      it "should correctly calculate uneven page splits" do
+        subject.per_page = 33
+        subject.total_pages.should == 4
+      end
+
+      it "should correctly calculate even page splits" do
+        subject.per_page = 20
+        subject.total_pages.should == 5
+      end
+    end
+
+    context "page bounds checks" do
+      let(:array) { (1..10).to_a }
+      subject { MagicGrid::Collection.new(array, nil) }
+
+      it "should round down to the last page if a later page is requested" do
+        subject.per_page = 3
+        subject.total_pages.should == 4
+        subject.apply_pagination(5).perform_pagination(array)
+        subject.current_page.should == 4
+      end
+
+      context "providing the correct data" do
+        before(:each) { subject.per_page = 3 }
+        it "handles pages beyond lower bound" do
+          subject.apply_pagination(0).perform_pagination(array).should == [1,2,3]
+        end
+        it "handles pages in bounds" do
+          subject.apply_pagination(1).perform_pagination(array).should == [1,2,3]
+          subject.apply_pagination(2).perform_pagination(array).should == [4,5,6]
+          subject.apply_pagination(3).perform_pagination(array).should == [7,8,9]
+          subject.apply_pagination(4).perform_pagination(array).should == [10]
+        end
+        it "handles pages above bounds" do
+          subject.apply_pagination(5).perform_pagination(array).should == [10]
+        end
+      end
+    end
+
   #TODO these tests will only really work properly once we have the ability
   #     to undefine constants, which looks like it should be coming in a future
   #     version of RSpec (as in post 2.11.1)
 
-  describe "#perform_pagination" do
-
     context "when #paginate (aka WillPaginate) is available" do
       it "should call paginate helper when it is detected" do
         array = [1].tap do |a|
-          a.should_receive(:paginate).with(page: 1, per_page: 1, total_entries: 1) { a }
+          a.should_receive(:paginate).with(:page => 1, :per_page => 1, :total_entries => 1) { a }
         end
         collection = MagicGrid::Collection.new(array, nil)
         collection.per_page = 1
@@ -113,7 +185,7 @@ describe MagicGrid::Collection do
       end
     end
 
-    unless Module.const_defined? :WillPaginate
+    unless $will_paginate
       context "when #page (possibly from Kaminari) is available" do
         it "should call paginate helper when it is detected" do
           array = [1].tap do |a|
@@ -127,21 +199,25 @@ describe MagicGrid::Collection do
         end
       end
 
-      context "when given an Array and Kaminari is available" do
-        it "should call paginate helper when it is detected" do
-          array = Array.new(10) { 1 }
-          kaminaried_array = [1,1].tap do |ka|
-            ka.should_receive(:per).with(1) { ka }
-            ka.should_receive(:page).with(1) { ka }
+      unless $kaminari
+        context "when given an Array and Kaminari is available" do
+          it "should call paginate helper when it is detected" do
+            array = Array.new(10) { 1 }
+            kaminaried_array = [1].tap do |ka|
+              ka.should_receive(:per).with(1) { ka }
+              ka.should_receive(:page).with(1) { ka }
+            end
+            kaminari = double.tap do |k|
+              k.should_receive(:paginate_array).with(array) { kaminaried_array }
+            end
+            collection = MagicGrid::Collection.new(array, nil)
+            collection.per_page = 1
+            collection.apply_pagination 1
+            old_kaminari = MagicGrid::Collection.kaminari_class
+            MagicGrid::Collection.kaminari_class = kaminari
+            collection.perform_pagination(array).should == kaminaried_array
+            MagicGrid::Collection.kaminari_class = old_kaminari
           end
-          kaminari = double.tap do |k|
-            k.should_receive(:paginate_array).with(array) { kaminaried_array }
-          end
-          stub_const('Kaminari', kaminari)
-          collection = MagicGrid::Collection.new(array, nil)
-          collection.per_page = 1
-          collection.apply_pagination 1
-          collection.perform_pagination(array).should == kaminaried_array
         end
       end
     end
@@ -149,7 +225,7 @@ describe MagicGrid::Collection do
     context "when no pagination is provided" do
       # TODO replace this when rspec-mocks add 'hide_const'
       # before :each do
-      #   if Module.const_defined?(:Kaminari)
+      #   if defined?(Kaminari)
       #     @kaminari = Module.const_get(:Kaminari)
       #     Object.send(:remove_const, :Kaminari)
       #   end