magic_grid 0.9.3.1 → 0.10.0

data/README.md

@@ -1,9 +1,17 @@
 MagicGrid
 =========
 
-Takes a collection (ActiveRecord or Array) and creates a paginated table of
-it using a supplied column definition. It can generate the rows for you, or
-you can supply a block to do it yourself.
+[![Build Status](https://secure.travis-ci.org/rmg/magic_grid.png?branch=master,stable,release)](http://travis-ci.org/rmg/magic_grid)
+
+Easy collection display grid with column sorting and pagination.
+
+Displays a collection (ActiveRelation or Array) wrapped in an html table with server
+side column sorting, filtering hooks, and search bar. Large collections can be
+paginated with either the will_paginate gem or kaminari gem if you use them, or a naive
+Enumerable based paginator (without pager links) if neither is present.
+
+Tables are styled using Themeroller compatible classes, which also don't look _too_ bad
+with Bootstrap.
 
 Basic Usage
 -----------
@@ -18,7 +26,7 @@ In your view:
 
 Or a more realistic example:
 
-```ruby
+```rhtml
 <%= magic_grid(@posts, [:title, :author, "Actions"]) do |post| %>
   <tr>
     <td><%= link_to(post.title, post) %></td>

data/Rakefile

@@ -5,15 +5,19 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'yard'
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  puts "Skipping YARD tasks"
+end
 
-YARD::Rake::YardocTask.new
 
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
-Rake::TestTask.new(:tests) do |t|
+Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
@@ -27,5 +31,7 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false
 end
 
-task :test => [:spec, :tests]
-task :default => :test
+desc "Run TestUnit and RSpec tests"
+task :tests => [:spec, :test]
+
+task :default => :tests

data/lib/magic_grid/definition.rb

@@ -1,10 +1,10 @@
-require 'will_paginate/view_helpers/action_view'
+#require 'will_paginate/view_helpers/action_view'
 
 module MagicGrid
   class Definition
-    include WillPaginate::ActionView
+    #include WillPaginate::ActionView
     attr_accessor :columns, :collection, :magic_id, :options, :params,
-      :current_sort_col, :current_order, :default_order
+      :current_sort_col, :current_order, :default_order, :per_page
 
     DEFAULTS = {
       :class => [],
@@ -54,7 +54,8 @@ module MagicGrid
         raise "I have no idea what that is, but it's not a Hash or an Array"
       end
       @default_order = @options[:default_order]
-      @params = controller.try(:params) || {}
+      @params = controller && controller.params || {}
+      @per_page = @options[:per_page]
       @collection = collection
       begin
         #if @collection.respond_to? :table
@@ -172,9 +173,24 @@ module MagicGrid
         @collection = @options[:post_filter].call(@collection)
       end
       # Paginate at the very end, after all sorting, filtering, etc..
-      if @options[:per_page]
-        @collection = @collection.paginate(:page => param(:page, 1),
-                                           :per_page => @options[:per_page])
+      if @per_page
+        if @collection.respond_to? :paginate
+          @collection = @collection.paginate(:page => current_page,
+                                             :per_page => @per_page)
+        elsif @collection.respond_to? :page
+          @collection = @collection.page(current_page).per(@per_page)
+        elsif @collection.is_a?(Array) and Module.const_defined?(:Kaminari)
+          @collection = Kaminari.paginate_array(@collection).page(current_page).per(@per_page)
+        else
+          original = @collection
+          @collection = @collection.to_enum.each_slice(@per_page).drop(current_page - 1).first.to_a
+          class << @collection
+            attr_accessor :current_page, :total_pages, :original_count
+          end
+          @collection.current_page = current_page
+          @collection.original_count = original.count
+          @collection.total_pages = original.count / @per_page
+        end
       end
     end
 
@@ -190,6 +206,10 @@ module MagicGrid
       @params.merge :magic_grid_id => @magic_id
     end
 
+    def current_page
+      [param(:page, 1).to_i, 1].max
+    end
+
     def order(something)
       case something
       when 1, "1", :desc, :DESC, "desc", "DESC"

data/lib/magic_grid/helpers.rb

@@ -1,5 +1,8 @@
 require 'magic_grid/definition'
-require 'will_paginate/array'
+
+if Module.const_defined? :WillPaginate
+  require 'will_paginate/array'
+end
 
 module MagicGrid
   module Helpers
@@ -62,7 +65,7 @@ module MagicGrid
             thead << content_tag('tr') do
               content_tag('td', :class => 'full-width ui-widget-header',
                           :colspan => grid.columns.count) do
-                pager = will_paginate(grid.collection,
+                pager = magic_paginate(grid.collection,
                                       :param_name => grid.param_key(:page),
                                       :params => base_params
                                      )
@@ -96,7 +99,7 @@ module MagicGrid
             tfoot << content_tag('tr') do
               content_tag('td', :class => 'full-width ui-widget-header',
                           :colspan => grid.columns.count) do
-                will_paginate(grid.collection,
+                magic_paginate(grid.collection,
                               :param_name => grid.param_key(:page),
                               :params => base_params
                              )
@@ -243,6 +246,21 @@ module MagicGrid
       searcher
     end
 
+    def magic_paginate(collection, opts={})
+      if respond_to? :will_paginate
+        # WillPaginate
+        will_paginate collection, opts
+        #alias_method :magic_paginate, :will_paginate
+      elsif respond_to? :paginate
+        #Kaminari, or something else..
+        paginate collection, opts
+        #alias_method :magic_paginate, :paginate
+      else
+        ("<!-- page #{collection.current_page} of #{collection.total_pages} -->" +
+                '<!-- INSTALL WillPaginate or Kaminari for a pager! -->').html_safe
+      end
+    end
+
     ::ActionView::Base.send :include, self
   end
 end

data/lib/magic_grid/version.rb

@@ -1,3 +1,3 @@
 module MagicGrid
-  VERSION = "0.9.3.1"
+  VERSION = "0.10.0"
 end

data/spec/definition_spec.rb

@@ -1,10 +1,31 @@
 require 'spec_helper'
 require 'magic_grid/definition'
+require 'active_support/core_ext/hash/indifferent_access'
 
 describe MagicGrid::Definition do
   pending "embarasses me with how tightly it is coupled with.. EVERYTHING"
 
+  shared_examples "a basic grid" do
+    its(:options) { should == MagicGrid::Definition.runtime_defaults }
+    its(:current_page) { should == 1 }
+
+    descendings = [1, "1", :desc, :DESC, "desc", "DESC"]
+    descendings.each do |down|
+      it "should normalize #{down} to 1" do
+        expect(subject.order(down)).to eq(1)
+      end
+    end
+
+    ascendings = [0, "0", :asc, :ASC, "asc", "ASC"]
+    ascendings.each do |up|
+      it "should normalize #{up} to 0" do
+        expect(subject.order(up)).to eq(0)
+      end
+    end
+  end
+
   let (:empty_collection) { [] }
+  let (:large_collection) { 200.times.map { |i| {id: i, name: "Name", description: "Describe me!"} } }
   let (:column_list) { [:name, :description] }
   let (:column_hash) { {} }
 
@@ -24,24 +45,48 @@ describe MagicGrid::Definition do
     expect { MagicGrid::Definition.new() }.to raise_error
   end
 
-  subject { MagicGrid::Definition.new(column_list, empty_collection) }
-  its(:base_params) { should include(:magic_grid_id) }
-  its(:collection) { should == empty_collection }
-  its(:columns) { should == column_list }
-  its(:options) { should == MagicGrid::Definition.runtime_defaults }
+  context "when given an empty collection" do
+    subject { MagicGrid::Definition.new(column_list, empty_collection) }
+    its(:base_params) { should include(:magic_grid_id) }
+    its(:collection) { should == empty_collection }
+    its(:columns) { should == column_list }
+    it_behaves_like "a basic grid"
+  end
 
+  context "when given a large collection and default options" do
+    let(:controller) {
+      controller = double()
+      controller.stub(:params) { {page: 2} }
+      controller
+    }
+    subject { MagicGrid::Definition.new(column_list, large_collection, controller) }
+    it_behaves_like "a basic grid"
+    its(:collection) { should_not == empty_collection }
 
-  descendings = [1, "1", :desc, :DESC, "desc", "DESC"]
-  descendings.each do |down|
-    it "should normalize #{down} to 1" do
-      expect(subject.order(down)).to eq(1)
-    end
+    its(:collection) { should have(MagicGrid::Definition.runtime_defaults[:per_page]).items }
+    its(:columns) { should == column_list }
   end
 
-  ascendings = [0, "0", :asc, :ASC, "asc", "ASC"]
-  ascendings.each do |up|
-    it "should normalize #{up} to 0" do
-      expect(subject.order(up)).to eq(0)
+  context "when given a large collection and some options" do
+    let(:controller) {
+      controller = double()
+      controller.stub(:params) { HashWithIndifferentAccess.new({grid_page: 2}) }
+      controller
+    }
+    subject { MagicGrid::Definition.new(column_list, large_collection, controller, id: :grid, per_page: 17) }
+    its(:collection) { should_not == empty_collection }
+    it "should give a collection with a page worth of items" do
+      subject.per_page.should < large_collection.count
+      subject.collection.should have(subject.per_page).items
     end
+    its(:columns) { should == column_list }
+    its(:current_page) { should == 2 }
+
+    it "should know how to extract its params" do
+      subject.param_key(:page).should == :grid_page
+      subject.param_key(:hunkydory).should == :grid_hunkydory
+      subject.param(:page).should == 2
+    end
+
   end
 end

data/spec/helpers_spec.rb

@@ -10,6 +10,15 @@ describe MagicGrid::Helpers do
   let(:empty_collection) { [] }
   let(:column_list) { [:name, :description] }
 
+  let(:view_renderer) {
+    double.tap { |v|
+      v.stub(:render)
+      v.stub(:params) { {} }
+      # controller.stub(:option)
+      v.stub(:url_for) {|h| "/foo?page=#{h[:page]}"}
+    }
+  }
+
   describe "#normalize_magic" do
 
     it "should turn an array into a MagicGrid::Definition" do

data/spec/spec_helper.rb

@@ -1,8 +1,33 @@
+# require 'bundler'
+# Bundler.setup
+
+unless ENV['TRAVIS']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/test/'
+  end
+end
+
 require 'action_view'
 require 'rails'
-require 'will_paginate'
-require 'will_paginate/array'
-require 'will_paginate/view_helpers'
+
+begin
+  require 'will_paginate'
+  require 'will_paginate/array'
+  require 'will_paginate/view_helpers'
+  puts "Testing with WillPaginate"
+rescue LoadError
+  puts "skipping WillPaginate"
+end
+
+begin
+  require 'kaminari'
+  require 'kaminari/models/array_extension'
+  puts "Testing with Kaminari"
+rescue LoadError
+  puts "skipping Kaminari"
+end
 
 Rails.backtrace_cleaner.remove_silencers!
 
@@ -35,7 +60,8 @@ RSpec.configure do |config|
   config.filter_run :focus
 
   config.include ActionView::Helpers
-  config.include WillPaginate::ViewHelpers
+  config.include WillPaginate::ViewHelpers if Module.const_defined? :WillPaginate
+  config.include Kaminari::ActionViewExtension if Module.const_defined? :Kaminari
   config.include ActionFaker
 
   # Run specs in random order to surface order dependencies. If you find an

data/test/dummy/config/environments/development.rb

@@ -23,7 +23,8 @@ Dummy::Application.configure do
   config.action_dispatch.best_standards_support = :builtin
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # Rails 3.2.x+
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)

data/test/dummy/config/environments/test.rb

@@ -30,7 +30,8 @@ Dummy::Application.configure do
   config.action_mailer.delivery_method = :test
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # Rails 3.2.x+
+  #config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

data/test/test_helper.rb

@@ -1,6 +1,13 @@
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
 
+unless ENV['TRAVIS']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/dummy/'
+  end
+end
+
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magic_grid
 version: !ruby/object:Gem::Version
-  version: 0.9.3.1
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,23 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: will_paginate
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -59,103 +43,59 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.17
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: tarantula
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: Simple collection displaying with pagination using will_paginate
+        version: 2.11.0
+description: ! "    Displays a collection (ActiveRelation or Array) wrapped in an
+  html table with server\n    side column sorting, filtering hooks, and search bar.
+  Large collections can be\n    paginated with either the will_paginate gem or kaminari
+  gem if you use them, or a naive\n    Enumerable based paginator (without pager links)
+  if neither is present.\n"
 email:
 - r.m.graham@gmail.com
 executables: []
@@ -268,7 +208,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1296722646557219267
+      hash: -4018779425854186674
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -277,13 +217,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1296722646557219267
+      hash: -4018779425854186674
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Simple collection displaying with pagination using will_paginate
+summary: Easy collection display grid with column sorting and pagination
 test_files:
 - spec/spec_helper.rb
 - spec/helpers_spec.rb