paged_scopes 0.1.0

data/spec/resources_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Resources" do
+  before(:each) do
+    ActionController::Routing::Routes.clear!
+  end
+  
+  after(:each) do
+    ActionController::Routing::Routes.clear!
+  end
+
+  it "should not affect normal resource mapping if :paged option is not specified" do
+    drawing_routes { |map| map.resources :articles }.should change { number_of_routes }.by(7)
+  end
+  
+  it "should add a paged index route if a :paged option is specified" do
+    drawing_routes { |map| map.resources :articles, :paged => true }.should change { number_of_routes }.by(7+1)
+  end
+  
+  context "with a :paged options" do    
+    it "should map a paged index route for GET only" do
+      draw_routes { |map| map.resources :articles, :paged => true }
+      recognise_path(   :get, "/pages/1/articles").should == { :controller => "articles", :action => "index", :page_id => "1" }
+      recognise_path(   :put, "/pages/1/articles").should be_nil
+      recognise_path(  :post, "/pages/1/articles").should be_nil
+      recognise_path(:delete, "/pages/1/articles").should be_nil
+    end
+
+    it "should add a named route for the paged index route" do
+      draw_routes { |map| map.resources :articles, :paged => true }
+      named_routes.names.should include(:page_articles)
+    end
+    
+    it "should observe the :path_prefix option in the paged route" do
+      draw_routes { |map| map.resources :articles, :paged => true, :path_prefix => "foo" }
+      recognise_path(:get, "/foo/pages/1/articles").should == { :controller => "articles", :action => "index", :page_id => "1" }
+    end
+    
+    it "should observe a :namespace option in the paged route" do
+      draw_routes { |map| map.resources :articles, :paged => true, :namespace => "bar/" }
+      recognise_path(:get, "/pages/1/articles").should == { :controller => "bar/articles", :action => "index", :page_id => "1" }
+    end
+    
+    it "should accept an :as option in the :paged option" do
+      draw_routes { |map| map.resources :articles, :paged => { :as => "page" } }
+      recognise_path(:get, "/page/1/articles").should == { :controller => "articles", :action => "index", :page_id => "1" }
+    end
+    
+    it "should accept a :name option in the :paged option" do
+      draw_routes { |map| map.resources :articles, :paged => { :name => :groups } }
+      recognise_path(:get, "/groups/1/articles").should == { :controller => "articles", :action => "index", :group_id => "1" }
+    end
+    
+    it "should accept a :path_prefix hash as the :paged option" do
+      draw_routes { |map| map.resources :articles, :paged => true, :name_prefix => "baz_" }
+      named_routes.names.should include(:baz_page_articles)
+    end
+    
+    context "and nested resources" do
+      it "should not change the nested routes" do
+        drawing_routes do |map|
+          map.resources :articles, :paged => true do |article|
+            article.resources :comments
+          end
+        end.should change { number_of_routes }.by(7+1+7)
+        drawing_routes do |map|
+          map.resources :articles, :paged => true, :has_many => :comments
+        end.should change { number_of_routes }.by(7+1+7)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,160 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_support'
+require 'active_record'
+require 'action_controller'
+require 'action_controller/test_process'
+require 'action_view/test_case'
+require 'paged_scopes'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :dbfile => ':memory:')
+ActiveRecord::Schema.define do
+  create_table "users", :force => true do |t|
+    t.column "name",  :text
+  end
+  create_table "articles", :force => true do |t|
+    t.column "user_id",  :integer
+    t.column "title", :text
+    t.column "published_at", :datetime
+  end
+  create_table "comments", :force => true do |t|
+    t.column "article_id", :integer
+    t.column "user_id", :integer
+  end
+  create_table "contributions", :force => true do |t|
+    t.column "article_id", :integer
+    t.column "user_id", :integer
+  end
+end
+
+class ::User < ActiveRecord::Base
+  has_many :articles
+  has_many :recent_articles, :order => "published_at DESC", :conditions => [ "published_at IS NOT :nil", { :nil => nil } ], :class_name => "Article"
+  has_many :contributions
+  has_many :shared_articles, :through => :contributions, :source => :article
+end
+class ::Article < ActiveRecord::Base
+  belongs_to :user
+  has_many :comments
+  named_scope :untitled, :conditions => { :title => nil }
+  named_scope :including_user, :include => :user
+  named_scope :with_user, :joins => 'INNER JOIN users ON users.id = articles.user_id'
+  named_scope :with_named_user, :joins => 'INNER JOIN users ON users.id = articles.user_id', :conditions => [ 'users.name IS NOT :nil', { :nil => nil } ]
+  named_scope :ordered_by_user_name, :joins => 'INNER JOIN users ON users.id = articles.user_id', :conditions => [ 'users.name IS NOT :nil', { :nil => nil } ], :order => 'users.name'
+  named_scope :with_comments, :joins => 'INNER JOIN comments AS article_comments ON article_comments.article_id = articles.id', :group => 'articles.id'
+  named_scope :first_three_with_comments, :joins => 'INNER JOIN comments AS article_comments ON article_comments.article_id = articles.id', :group => 'articles.id', :limit => 3
+  named_scope :with_multiple_comments, :include => :comments, :joins => 'INNER JOIN (SELECT count(id) AS count, article_id FROM comments GROUP BY article_id) article_comments ON article_comments.article_id = articles.id', :conditions => 'article_comments.count > 1'
+  named_scope :first_three, :limit => 3
+  named_scope :two_through_four, :limit => 3, :offset => 1
+  named_scope :descending_id, :order => 'articles.id DESC'
+end
+class ::Comment < ActiveRecord::Base
+  belongs_to :article
+end
+class ::Contribution < ActiveRecord::Base
+  belongs_to :article
+  belongs_to :user
+end
+
+User.create(:name => "user #1")
+User.create(:name => nil)
+User.create(:name => "user #3")
+9.times do |n|
+  shared_article = User.first.articles.create
+  User.all.each_with_index do |user, i|
+    user.articles.create
+    user.articles.create(:title => "Article #%03d" % Article.count)
+    published_article = user.articles.create(:title => "Article #%03d" % Article.count, :published_at => n.weeks.ago)
+    n.times { published_article.comments << Comment.new }
+    user.articles.create(:published_at => n.weeks.ago)
+    user.shared_articles << shared_article unless user == User.first
+  end
+  n.times { shared_article.comments << Comment.new }
+end
+
+module ControllerHelpers
+  def in_instance(instance, &block)
+    instance.instance_eval do
+      extend Spec::Matchers
+      instance_eval(&block)
+    end
+  end
+  
+  def in_controller(controller, &block)
+    controller.copy_instance_variables_from(self)
+    in_instance controller do
+      stub!(:params).and_return({})
+      instance_eval(&block)
+    end
+  end
+end
+
+module RoutingHelpers
+  def draw_routes(&block)
+    ActionController::Routing::Routes.draw(&block)
+  end
+
+  def drawing_routes(&block)
+    lambda { draw_routes(&block) }
+  end
+
+  def number_of_routes
+    ActionController::Routing::Routes.routes.size
+  end
+
+  def named_routes
+    ActionController::Routing::Routes.named_routes
+  end
+
+  def recognise_path(method, path)
+    request = ActionController::TestRequest.new
+    request.request_method = method
+    ActionController::Routing::Routes.recognize_path(path, ActionController::Routing::Routes.extract_request_environment(request))
+  rescue ActionController::RoutingError, ActionController::MethodNotAllowed
+    nil
+  end
+end
+
+module Contexts
+  def in_contexts(&block)
+    [
+      [ "a scoped ActiveRecord class",        "Article.scoped({})"           ],
+      [ "a has_many association",             "User.last.articles"           ],
+      [ "an ordered has_many association",    "User.last.recent_articles"    ],
+      [ "a has_many, :through association",   "User.last.shared_articles"    ] # not tested for habtm!
+    ].each do |base_type, base|
+      [ 
+        [ "",                                         "" ],
+        [ "scoped with :conditions",                  ".untitled" ],
+        [ "scoped with :include",                     ".including_user" ],
+        [ "scoped with :joins",                       ".with_user" ],
+        [ "scoped with :joins & :conditions",         ".with_named_user" ],
+        [ "scoped with :joins, :conditions & :order", ".ordered_by_user_name" ],
+        [ "scoped with :joins & :group",              ".with_comments" ],
+        [ "scoped with :joins, :group & :limit",      ".first_three_with_comments" ],
+        [ "scoped with :includes, :joins & subquery", ".with_multiple_comments" ],
+        [ "scoped with :limit",                       ".first_three" ],
+        [ "scoped with :limit & :offset",             ".two_through_four" ],
+        [ "scoped with :order",                       ".descending_id" ]
+      ].each do |scope_type, scope|
+        context "for #{base_type} #{scope_type}" do
+          before(:each) do
+            @articles = eval("#{base}#{scope}")
+            @articles.all.should_not be_empty # sanity check: make sure our collection actually has some elements!
+            @articles.all.should == @articles.all.uniq # don't want duplicate items in our test collection
+          end
+          instance_eval(&block)
+        end
+      end
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.extend Contexts
+  config.include RoutingHelpers
+  config.include ControllerHelpers
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: paged_scopes
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Hollingworth
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-10 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.1
+    version: 
+description: 
+email: mdholling@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+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
+has_rdoc: true
+homepage: http://github.com/mholling/paged_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: 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.
+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