paged_scopes 0.1.0

data/lib/paged_scopes/paginator.rb

@@ -0,0 +1,68 @@
+module PagedScopes
+  class Paginator
+    attr_reader :page
+
+    def initialize(page)
+      @page = page
+    end
+
+    def set_path(&block)
+      @path = block
+    end
+    
+    def path
+      @path || raise(RuntimeError, "No path proc supplied.")
+    end
+
+    def previous
+      path.call(@page.previous) unless @page.first?
+    end
+
+    def next
+      path.call(@page.next) unless @page.last?
+    end
+    
+    def first
+      path.call(@page.class.first)
+    end
+    
+    def last
+      path.call(@page.class.last)
+    end
+
+    def window(options)
+      raise ArgumentError, "No window block supplied." unless block_given?
+      raise ArgumentError, "please specify a :inner option" unless inner = options[:inner]
+      return if @page.page_count < 2
+      outer = options[:outer] || 0
+      extras = [ options[:extras] ].flatten.compact
+      numbers = case
+      when @page.number <= inner + 1
+        1 .. 1 + 2 * inner
+      when @page.number >= @page.page_count - inner
+        @page.page_count - 2 * inner .. @page.page_count
+      else
+        @page.number - inner .. @page.number + inner
+      end.to_a
+      1.upto(outer) { |n| numbers << n << @page.page_count-n+1 }
+      numbers.uniq!
+      numbers.sort!
+      numbers.reject! { |number| !number.between?(1, @page.page_count) }
+      returning [] do |results|
+        results << yield(:first, @page.first? ? nil : first, []) if extras.include?(:first)
+        results << yield(:previous, previous, []) if extras.include?(:previous)
+        numbers.zip([nil]+numbers, numbers[1..-1]) do |number, prev_number, next_number|
+          page = @page.class.find(number)
+          path = page == @page ? nil : @path.call(page)
+          classes = []
+          classes << :selected if page == @page
+          classes << :gap_before if prev_number && prev_number < number - 1
+          classes << :gap_after  if next_number && next_number > number + 1
+          results << yield(page, path, classes)
+        end        
+        results << yield(:next, self.next, []) if extras.include?(:next)
+        results << yield(:last, @page.last? ? nil : last, []) if extras.include?(:last)
+      end.join("\n")
+    end
+  end
+end

data/lib/paged_scopes/resources.rb

@@ -0,0 +1,32 @@
+module PagedScopes
+  module Resources
+    def resources_with_paged(*entities, &block)
+      options = entities.extract_options!
+      if page_options = options.delete(:paged)
+        resources_without_paged(*(entities.dup << options), &block)
+        page_options = {} unless page_options.is_a? Hash
+        page_name = page_options.delete(:name)
+        page_options.slice!(:as, :name)
+        page_options.merge!(:only => :none)
+        preserved_options = ActionController::Resources::INHERITABLE_OPTIONS + [ :name_prefix, :path_prefix ]
+        with_options(options.slice(*preserved_options)) do |map|
+          map.resources_without_paged(page_name || :pages, page_options) do |page|
+            page.resources(*(entities.dup << { :only => :index }))
+          end
+        end
+      else
+        resources_without_paged(*(entities << options), &block)
+      end
+    end
+    
+    def self.included(base)
+      base.class_eval do
+        alias_method_chain :resources, :paged
+      end
+    end
+  end
+end
+
+if defined? ActionController::Resources
+  ActionController::Resources.send :include, PagedScopes::Resources
+end

data/paged_scopes.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{paged_scopes}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matthew Hollingworth"]
+  s.date = %q{2009-10-10}
+  s.email = %q{mdholling@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/paged_scopes.rb",
+     "lib/paged_scopes/collection.rb",
+     "lib/paged_scopes/context.rb",
+     "lib/paged_scopes/controller.rb",
+     "lib/paged_scopes/index.rb",
+     "lib/paged_scopes/pages.rb",
+     "lib/paged_scopes/paginator.rb",
+     "lib/paged_scopes/resources.rb",
+     "paged_scopes.gemspec",
+     "rails/init.rb",
+     "spec/collection_spec.rb",
+     "spec/context_spec.rb",
+     "spec/controller_spec.rb",
+     "spec/index_spec.rb",
+     "spec/page_spec.rb",
+     "spec/paginator_spec.rb",
+     "spec/resources_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mholling/paged_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{PagedScopes is an ActiveRecord pagination gem. It lets you easily paginate collection associations and named scopes. It also paginates collections which already have :limit and :offset scopes in place. You can also find the page containing a given object in a collection, and find the next and previous objects for each object in the collection.}
+  s.test_files = [
+    "spec/collection_spec.rb",
+     "spec/context_spec.rb",
+     "spec/controller_spec.rb",
+     "spec/index_spec.rb",
+     "spec/page_spec.rb",
+     "spec/paginator_spec.rb",
+     "spec/resources_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.2.1"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 2.2.1"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 2.2.1"])
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'paged_scopes'

data/spec/collection_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Collection" do
+  describe "(ActiveRecord::Base class)" do
+    it "should have a per_page setter and getter" do
+      Article.per_page = 5
+      Article.per_page.should == 5
+    end
+    
+    it "should have a default page name of 'Page'" do
+      Article.page_name.should == "Page"
+    end
+
+    it "should have a page_name setter and getter" do
+      Article.page_name = "Group"
+      Article.page_name.should == "Group"
+    end
+    
+    it "should not have a #pages method" do
+      Article.respond_to?(:pages).should be_false
+    end
+  end
+  
+  [ [ "association", "User.first.articles"                             ],
+    [ "named scope", "Article.scoped(:conditions => 'title IS NULL')" ] ].each do |collection_type, collection|
+    describe "(#{collection_type})" do
+      before(:each) do
+        @collection = eval(collection)
+        Article.stub!(:per_page).and_return(10)
+        Article.page_name = "Page"
+      end
+      
+      it "should have a default per_page of the ActiveRecord::Base class" do
+        @collection.per_page.should == 10
+      end
+    
+      it "should have a per_page setter and getter" do
+        @collection.per_page = 20
+        @collection.per_page.should == 20
+      end
+      
+      it "should not overwrite the ActiveRecord::Base per_page value when per_page is set" do
+        @collection.per_page = 20
+        Article.per_page.should == 10
+      end
+      
+      it "should have a default page_name of the ActiveRecord::Base class" do
+        @collection.page_name.should == "Page"
+      end
+    
+      it "should have a page_name setter and getter" do
+        @collection.page_name = "Group"
+        @collection.page_name.should == "Group"
+      end
+      
+      it "should not overwrite the ActiveRecord::Base page_name value when page_name is set" do
+        @collection.page_name = "Group"
+        Article.page_name.should == "Page"
+      end
+  
+      it "should have a #pages method" do
+        @collection.respond_to?(:pages).should be_true
+      end
+    end
+  end
+end

data/spec/context_spec.rb

@@ -0,0 +1,27 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Context" do
+  in_contexts do
+    it "should know the object after an object obtained with #all" do
+      articles = @articles.all
+      until articles.empty? do
+        articles.shift.next.should == articles.first
+      end
+    end
+
+    it "should know the object before an object obtained with #all" do
+      articles = @articles.all
+      until articles.empty? do
+        articles.pop.previous.should == articles.last
+      end
+    end
+    
+    it "should be known for an object obtained with #first" do
+      @articles.all.should have_at_least(2).articles
+      @articles.first.next.should_not be_nil
+      @articles.first.previous.should be_nil
+    end
+    # (For a collection including :limit , this won't work with #last unless the collection
+    # has been evaluated already!)
+  end
+end

data/spec/controller_spec.rb

@@ -0,0 +1,234 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Controller" do
+  
+  context "class" do
+    it "should raise 404 on PagedScopes::PageNotFound" do
+      Class.new(ActionController::Base).rescue_responses['PagedScopes::PageNotFound'].should == :not_found
+    end
+    
+    it "should get the default collection name from the controller name" do
+      [ "ArticlesController", "ArticleController", "Admin::ArticlesController" ].each do |controller_name|
+        @class = Class.new(ActionController::Base)
+        @class.stub!(:name).and_return(controller_name)
+        @class.send(:default_collection_name).should == "articles"
+      end
+    end
+    
+    it "should not get the default collection name from a misnamed controller" do
+      [ "", "SomeClassName" ].each do |controller_name|
+        @class = Class.new(ActionController::Base)
+        @class.stub!(:name).and_return(controller_name)
+        lambda { @class.send(:default_collection_name) }.should raise_error(RuntimeError)
+      end
+    end
+  end
+    
+  context "instance using #page_for" do
+    before(:each) do
+      @class = Class.new(ActionController::Base)
+      @controller = @class.new
+      @articles = User.first.articles
+      @articles.per_page = 3
+    end
+
+    it "should default to the first page of the collection" do
+      in_controller @controller do
+        page_for(@articles).should == @articles.pages.first
+      end
+    end
+    
+    it "should find the page from a page id in the params" do
+      in_controller @controller do
+        @articles.pages.each do |page|
+          stub!(:params).and_return(:page_id => page.id)
+          page_for(@articles).should == page
+        end
+      end
+    end
+    
+    it "should find the page containing an object if specified" do
+      in_controller @controller do
+        @articles.each do |article|
+          page_for(@articles, article).should == @articles.pages.find_by_article(article)
+          # page_for(@articles, article).articles.all.should include(article)
+        end
+      end
+    end
+    
+    it "should set per_page on the collection if specified" do
+      in_controller @controller do
+        page_for(@articles, :per_page => 4)
+        @articles.per_page.should == 4
+      end
+    end
+    
+    it "should set the page model name on the collection if specified" do
+      in_controller @controller do
+        page_for(@articles, :name => "Group")
+        @articles.page_name.should == "Group"
+      end
+    end
+    
+    it "should set the pagination path proc if specified using a :path option" do
+      in_controller @controller do
+        @page = page_for(@articles, :path => :page_articles_path)
+        self.should_receive(:page_articles_path).with(@page.next)
+        @page.paginator.next
+      end
+    end
+    
+    it "should set the pagination path proc if specified with a block" do
+      in_controller @controller do
+        @page = page_for(@articles) { |page| "path/to/page/#{page.to_param}" }
+        @page.paginator.next.should == "path/to/page/#{@page.next.to_param}"
+      end
+    end
+  end
+  
+  context "class using #paginate" do
+    before(:each) do
+      @class = Class.new(ActionController::Base)
+    end
+    
+    it "should add a protected paginate callback as a before filter when paginate is called" do
+      @class.paginate :articles
+      @class.before_filters.map(&:to_s).should include("paginate_articles")
+      @class.protected_instance_methods.map(&:to_s).should include("paginate_articles")
+    end
+    
+    it "should use the default collection name if no collection name is specified" do
+      @class.stub!(:name).and_return("ArticlesController")
+      @class.paginate
+      @class.before_filters.map(&:to_s).should include("paginate_articles")
+    end
+    
+    it "should pass filter options except for :per_page, :name and :path on to the before filter" do
+      @options = { :per_page => 3, :name => "Group", :path => :page_articles_path, :only => [ :index, :show ], :if => :test }
+      @class.paginate :articles, @options
+      @filter = @class.filter_chain.detect { |filter| filter.method.to_s == "paginate_articles" }
+      @filter.options.keys.should_not include(:per_page, :name, :path)
+      @filter.options.keys.should include(:only, :if)
+    end
+  end
+  
+  context "instance using paginate with options in the controller class" do
+    before(:each) do
+      @options = { :per_page => 3, :name => "Group", :path => :page_articles_path, :only => [ :index, :show ], :if => :test }
+      @class = Class.new(ActionController::Base)
+      @class.paginate :articles, @options
+      @controller = @class.new
+    end
+    
+    it "should set :per_page on the collection" do
+      in_controller @controller do
+        @articles = User.first.articles
+        paginate_articles
+        @articles.per_page.should == @options[:per_page]
+      end
+    end
+
+    it "should set :page_name on the collection" do
+      in_controller @controller do
+        @articles = User.first.articles
+        paginate_articles
+        @articles.page_name.should == @options[:name]
+      end
+    end
+
+    it "should set a page instance variable named accordingly" do
+      in_controller @controller do
+        @articles = User.first.articles
+        paginate_articles
+        @group.should_not be_nil
+      end
+    end
+
+    it "should set :path on the page's paginator" do
+      in_controller @controller do
+        @articles = User.first.articles
+        paginate_articles
+        self.should_receive(@options[:path])
+        @group.paginator.first
+      end
+    end
+  end
+  
+  context "instance using #paginate in the controller class" do
+    before(:each) do
+      @class = Class.new(ActionController::Base)
+      @class.paginate :articles, :per_page => 3
+      @controller = @class.new
+    end
+    
+    it "should raise an error if no collection is set" do
+      in_controller @controller do
+        lambda { paginate_articles }.should raise_error(RuntimeError)
+      end      
+    end
+    
+    it "should pass :per_page, :name and :path options on to the call to #page_for" do
+      @options = { :per_page => 3, :name => "Group", :path => :page_articles_path }
+      @class.paginate :articles, @options
+      @controller = @class.new
+      in_controller @controller do
+        @articles = User.first.articles
+        self.should_receive(:page_for).with(@articles, nil, @options)
+        paginate_articles
+      end
+    end
+
+    context "when the collection is set before the filter is run" do
+      before(:each) do
+        in_controller @controller do
+          @articles = User.first.articles
+        end
+      end
+    
+      it "should get the page from the collection object if set as an instance variable" do
+        in_controller @controller do
+          @articles.each do |article|
+            @article = article
+            paginate_articles
+            @page.articles.all.should include(@article)
+          end
+        end
+      end
+      
+      it "should get the page from the params if a collection object is not set or is a new record" do
+        in_controller @controller do
+          @articles.per_page = 3
+          stub!(:params).and_return(:page_id => @articles.pages.last.id)
+          [ nil, Article.new ].each do |article|
+            @article = article
+            paginate_articles
+            @page.should == @articles.pages.last
+          end
+        end
+      end
+
+      it "should raise PageNotFound if the page id in the params is not in range" do
+        in_controller @controller do
+          @articles.per_page = 3
+          stub!(:params).and_return(:page_id => @articles.pages.last.id + 1)
+          lambda { paginate_articles }.should raise_error(PagedScopes::PageNotFound)
+        end
+      end
+                
+      it "should get the first page if the current object is a new record" do
+        in_controller @controller do
+          @article = @articles.new
+          paginate_articles
+          @page.should == @articles.pages.first
+        end
+      end
+          
+      it "should otherwise default to the first page" do
+        in_controller @controller do
+          paginate_articles
+          @page.should == @articles.pages.first
+        end
+      end
+    end
+  end
+end