will_paginate 2.3.16 → 3.0.pre

data/lib/will_paginate/named_scope.rb

@@ -1,170 +0,0 @@
-module WillPaginate
-  # This is a feature backported from Rails 2.1 because of its usefullness not only with will_paginate,
-  # but in other aspects when managing complex conditions that you want to be reusable.
-  module NamedScope
-    # All subclasses of ActiveRecord::Base have two named_scopes:
-    # * <tt>all</tt>, which is similar to a <tt>find(:all)</tt> query, and
-    # * <tt>scoped</tt>, which allows for the creation of anonymous scopes, on the fly: <tt>Shirt.scoped(:conditions => {:color => 'red'}).scoped(:include => :washing_instructions)</tt>
-    #
-    # These anonymous scopes tend to be useful when procedurally generating complex queries, where passing
-    # intermediate values (scopes) around as first-class objects is convenient.
-    def self.included(base)
-      base.class_eval do
-        extend ClassMethods
-        named_scope :scoped, lambda { |scope| scope }
-      end
-    end
-
-    module ClassMethods
-      def scopes
-        read_inheritable_attribute(:scopes) || write_inheritable_attribute(:scopes, {})
-      end
-
-      # Adds a class method for retrieving and querying objects. A scope represents a narrowing of a database query,
-      # such as <tt>:conditions => {:color => :red}, :select => 'shirts.*', :include => :washing_instructions</tt>.
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :red, :conditions => {:color => 'red'}
-      #     named_scope :dry_clean_only, :joins => :washing_instructions, :conditions => ['washing_instructions.dry_clean_only = ?', true]
-      #   end
-      # 
-      # The above calls to <tt>named_scope</tt> define class methods <tt>Shirt.red</tt> and <tt>Shirt.dry_clean_only</tt>. <tt>Shirt.red</tt>, 
-      # in effect, represents the query <tt>Shirt.find(:all, :conditions => {:color => 'red'})</tt>.
-      #
-      # Unlike Shirt.find(...), however, the object returned by <tt>Shirt.red</tt> is not an Array; it resembles the association object
-      # constructed by a <tt>has_many</tt> declaration. For instance, you can invoke <tt>Shirt.red.find(:first)</tt>, <tt>Shirt.red.count</tt>,
-      # <tt>Shirt.red.find(:all, :conditions => {:size => 'small'})</tt>. Also, just
-      # as with the association objects, name scopes acts like an Array, implementing Enumerable; <tt>Shirt.red.each(&block)</tt>,
-      # <tt>Shirt.red.first</tt>, and <tt>Shirt.red.inject(memo, &block)</tt> all behave as if Shirt.red really were an Array.
-      #
-      # These named scopes are composable. For instance, <tt>Shirt.red.dry_clean_only</tt> will produce all shirts that are both red and dry clean only.
-      # Nested finds and calculations also work with these compositions: <tt>Shirt.red.dry_clean_only.count</tt> returns the number of garments
-      # for which these criteria obtain. Similarly with <tt>Shirt.red.dry_clean_only.average(:thread_count)</tt>.
-      #
-      # All scopes are available as class methods on the ActiveRecord::Base descendent upon which the scopes were defined. But they are also available to
-      # <tt>has_many</tt> associations. If,
-      #
-      #   class Person < ActiveRecord::Base
-      #     has_many :shirts
-      #   end
-      #
-      # then <tt>elton.shirts.red.dry_clean_only</tt> will return all of Elton's red, dry clean
-      # only shirts.
-      #
-      # Named scopes can also be procedural.
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :colored, lambda { |color|
-      #       { :conditions => { :color => color } }
-      #     }
-      #   end
-      #
-      # In this example, <tt>Shirt.colored('puce')</tt> finds all puce shirts.
-      #
-      # Named scopes can also have extensions, just as with <tt>has_many</tt> declarations:
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :red, :conditions => {:color => 'red'} do
-      #       def dom_id
-      #         'red_shirts'
-      #       end
-      #     end
-      #   end
-      #
-      #
-      # For testing complex named scopes, you can examine the scoping options using the
-      # <tt>proxy_options</tt> method on the proxy itself.
-      #
-      #   class Shirt < ActiveRecord::Base
-      #     named_scope :colored, lambda { |color|
-      #       { :conditions => { :color => color } }
-      #     }
-      #   end
-      #
-      #   expected_options = { :conditions => { :colored => 'red' } }
-      #   assert_equal expected_options, Shirt.colored('red').proxy_options
-      def named_scope(name, options = {})
-        name = name.to_sym
-        scopes[name] = lambda do |parent_scope, *args|
-          Scope.new(parent_scope, case options
-            when Hash
-              options
-            when Proc
-              options.call(*args)
-          end) { |*a| yield(*a) if block_given? }
-        end
-        (class << self; self end).instance_eval do
-          define_method name do |*args|
-            scopes[name].call(self, *args)
-          end
-        end
-      end
-    end
-    
-    class Scope
-      attr_reader :proxy_scope, :proxy_options
-
-      [].methods.each do |m|
-        unless m =~ /(^__|^nil\?|^send|^object_id$|class|extend|^find$|count|sum|average|maximum|minimum|paginate|first|last|empty\?|respond_to\?)/
-          delegate m, :to => :proxy_found
-        end
-      end
-
-      delegate :scopes, :with_scope, :to => :proxy_scope
-
-      def initialize(proxy_scope, options)
-        [options[:extend]].flatten.each { |extension| extend extension } if options[:extend]
-        extend Module.new { |*args| yield(*args) } if block_given?
-        @proxy_scope, @proxy_options = proxy_scope, options.except(:extend)
-      end
-
-      def reload
-        load_found; self
-      end
-
-      def first(*args)
-        if args.first.kind_of?(Integer) || (@found && !args.first.kind_of?(Hash))
-          proxy_found.first(*args)
-        else
-          find(:first, *args)
-        end
-      end
-
-      def last(*args)
-        if args.first.kind_of?(Integer) || (@found && !args.first.kind_of?(Hash))
-          proxy_found.last(*args)
-        else
-          find(:last, *args)
-        end
-      end
-
-      def empty?
-        @found ? @found.empty? : count.zero?
-      end
-
-      def respond_to?(method, include_private = false)
-        super || @proxy_scope.respond_to?(method, include_private)
-      end
-
-      protected
-      def proxy_found
-        @found || load_found
-      end
-
-      private
-      def method_missing(method, *args)
-        if scopes.include?(method)
-          scopes[method].call(self, *args)
-        else
-          with_scope :find => proxy_options do
-            proxy_scope.send(method, *args) { |*a| yield(*a) if block_given? }
-          end
-        end
-      end
-
-      def load_found
-        @found = find(:all)
-      end
-    end
-  end
-end

data/lib/will_paginate/named_scope_patch.rb

@@ -1,37 +0,0 @@
-ActiveRecord::Associations::AssociationProxy.class_eval do
-  protected
-  def with_scope(*args)
-    @reflection.klass.send(:with_scope, *args) { |*a| yield(*a) if block_given? }
-  end
-end
-
-[ ActiveRecord::Associations::AssociationCollection,
-    ActiveRecord::Associations::HasManyThroughAssociation ].each do |klass|
-  klass.class_eval do
-    protected
-    alias :method_missing_without_scopes :method_missing_without_paginate
-    def method_missing_without_paginate(method, *args)
-      if @reflection.klass.scopes.include?(method)
-        @reflection.klass.scopes[method].call(self, *args) { |*a| yield(*a) if block_given? }
-      else
-        method_missing_without_scopes(method, *args) { |*a| yield(*a) if block_given? }
-      end
-    end
-  end
-end
-
-# Rails 1.2.6
-ActiveRecord::Associations::HasAndBelongsToManyAssociation.class_eval do
-  protected
-  def method_missing(method, *args)
-    if @target.respond_to?(method) || (!@reflection.klass.respond_to?(method) && Class.respond_to?(method))
-      super
-    elsif @reflection.klass.scopes.include?(method)
-      @reflection.klass.scopes[method].call(self, *args)
-    else
-      @reflection.klass.with_scope(:find => { :conditions => @finder_sql, :joins => @join_sql, :readonly => false }) do
-        @reflection.klass.send(method, *args) { |*a| yield(*a) if block_given? }
-      end
-    end
-  end
-end if ActiveRecord::Base.respond_to? :find_first

data/lib/will_paginate/per_page.rb

@@ -1,27 +0,0 @@
-module WillPaginate
-  module PerPage
-    def per_page
-      defined?(@per_page) ? @per_page : WillPaginate.per_page
-    end
-
-    def per_page=(limit)
-      @per_page = limit.to_i
-    end
-
-    def self.extended(base)
-      base.extend Inheritance if base.is_a? Class
-    end
-
-    module Inheritance
-      def inherited(subclass)
-        super
-        subclass.per_page = self.per_page
-      end
-    end
-  end
-
-  extend PerPage
-
-  # default number of items per page
-  self.per_page = 30
-end

data/test/ci.rb

@@ -1,56 +0,0 @@
-#!/usr/bin/env ruby
-databases = %w[ sqlite3 mysql postgres ]
-# skip mysql on 1.8.6 (doesn't work for unknown reason)
-run_mysql = !(ENV['TRAVIS'] && RUBY_VERSION == '1.8.6')
-
-def announce(name, msg)
-  puts "\n\e[1;33m[#{name}] #{msg}\e[m\n"
-end
-
-def rails_version(gemfile)
-  gemfile =~ /\d[\d.]*$/ ? $& : '2.3'
-end
-
-def system(*args)
-  puts "$ #{args.join(' ')}"
-  super
-end
-
-if ENV['TRAVIS']
-  if run_mysql
-    system "mysql -e 'create database will_paginate;' >/dev/null"
-    abort "failed to create mysql database" unless $?.success?
-  end
-  system "psql -c 'create database will_paginate;' -U postgres >/dev/null"
-  abort "failed to create postgres database" unless $?.success?
-end
-
-gemfiles = ['Gemfile']
-gemfiles.concat Dir['test/gemfiles/*'].reject { |f| f.include? '.lock' }.sort.reverse
-
-ruby19 = RUBY_VERSION > '1.9'
-ruby19_gemfiles = gemfiles.first
-
-bundler_options = ENV['TRAVIS'] ? "--path #{Dir.pwd}/vendor/bundle" : ''
-
-failed = false
-
-gemfiles.each do |gemfile|
-  next if ruby19 and !ruby19_gemfiles.include? gemfile
-  version = rails_version(gemfile)
-  ENV['BUNDLE_GEMFILE'] = gemfile
-  skip_install = gemfile == gemfiles.first
-  if skip_install or system %(bundle install #{bundler_options})
-    for db in databases
-      next if 'mysql' == db and !run_mysql
-      announce "Rails #{version}", "with #{db}"
-      ENV['DB'] = db
-      failed = true unless system %(bundle exec rake)
-    end
-  else
-    # bundle install failed
-    failed = true
-  end
-end
-
-exit 1 if failed

data/test/collection_test.rb

@@ -1,160 +0,0 @@
-require 'helper'
-require 'will_paginate/array'
-
-class ArrayPaginationTest < Test::Unit::TestCase
-  
-  def setup ; end
-  
-  def test_simple
-    collection = ('a'..'e').to_a
-    
-    [{ :page => 1,  :per_page => 3,  :expected => %w( a b c ) },
-     { :page => 2,  :per_page => 3,  :expected => %w( d e ) },
-     { :page => 1,  :per_page => 5,  :expected => %w( a b c d e ) },
-     { :page => 3,  :per_page => 5,  :expected => [] },
-    ].
-    each do |conditions|
-      expected = conditions.delete :expected
-      assert_equal expected, collection.paginate(conditions)
-    end
-  end
-
-  def test_defaults
-    result = (1..50).to_a.paginate
-    assert_equal 1, result.current_page
-    assert_equal 30, result.size
-  end
-
-  def test_deprecated_api
-    assert_raise(ArgumentError) { [].paginate(2) }
-    assert_raise(ArgumentError) { [].paginate(2, 10) }
-  end
-
-  def test_total_entries_has_precedence
-    result = %w(a b c).paginate :total_entries => 5
-    assert_equal 5, result.total_entries
-  end
-
-  def test_argument_error_with_params_and_another_argument
-    assert_raise ArgumentError do
-      [].paginate({}, 5)
-    end
-  end
-
-  def test_paginated_collection
-    entries = %w(a b c)
-    collection = create(2, 3, 10) do |pager|
-      assert_equal entries, pager.replace(entries)
-    end
-
-    assert_equal entries, collection
-    assert_respond_to_all collection, %w(total_pages each offset size current_page per_page total_entries)
-    assert_kind_of Array, collection
-    assert_instance_of Array, collection.entries
-    assert_equal 3, collection.offset
-    assert_equal 4, collection.total_pages
-    assert !collection.out_of_bounds?
-  end
-
-  def test_previous_next_pages
-    collection = create(1, 1, 3)
-    assert_nil collection.previous_page
-    assert_equal 2, collection.next_page
-    
-    collection = create(2, 1, 3)
-    assert_equal 1, collection.previous_page
-    assert_equal 3, collection.next_page
-    
-    collection = create(3, 1, 3)
-    assert_equal 2, collection.previous_page
-    assert_nil collection.next_page
-  end
-
-  def test_out_of_bounds
-    entries = create(2, 3, 2){}
-    assert entries.out_of_bounds?
-    
-    entries = create(1, 3, 2){}
-    assert !entries.out_of_bounds?
-  end
-
-  def test_guessing_total_count
-    entries = create do |pager|
-      # collection is shorter than limit
-      pager.replace array
-    end
-    assert_equal 8, entries.total_entries
-    
-    entries = create(2, 5, 10) do |pager|
-      # collection is shorter than limit, but we have an explicit count
-      pager.replace array
-    end
-    assert_equal 10, entries.total_entries
-    
-    entries = create do |pager|
-      # collection is the same as limit; we can't guess
-      pager.replace array(5)
-    end
-    assert_equal nil, entries.total_entries
-    
-    entries = create do |pager|
-      # collection is empty; we can't guess
-      pager.replace array(0)
-    end
-    assert_equal nil, entries.total_entries
-    
-    entries = create(1) do |pager|
-      # collection is empty and we're on page 1,
-      # so the whole thing must be empty, too
-      pager.replace array(0)
-    end
-    assert_equal 0, entries.total_entries
-  end
-
-  def test_invalid_page
-    bad_inputs = [0, -1, nil, '', 'Schnitzel']
-
-    bad_inputs.each do |bad|
-      assert_raise(WillPaginate::InvalidPage) { create bad }
-    end
-  end
-
-  def test_invalid_offset
-    error = assert_raise(WillPaginate::InvalidPage) { create(307445734561825862, 30) }
-    assert_equal "invalid offset: 9223372036854775830", error.message
-  end
-
-  def test_page_count_was_removed
-    assert_raise(NoMethodError) { create.page_count }
-    # It's `total_pages` now.
-  end
-
-  def test_inherits_global_per_page
-    col = WillPaginate::Collection.new(1)
-    assert_equal 30, col.per_page
-
-    WillPaginate.per_page = 12
-    begin
-      col = WillPaginate::Collection.new(1)
-      assert_equal 12, col.per_page
-
-      col = ('a'..'z').to_a.paginate(:page => 1)
-      assert_equal 12, col.per_page
-    ensure
-      WillPaginate.per_page = 30
-    end
-  end
-
-  private
-    def create(page = 2, limit = 5, total = nil, &block)
-      if block_given?
-        WillPaginate::Collection.create(page, limit, total, &block)
-      else
-        WillPaginate::Collection.new(page, limit, total)
-      end
-    end
-
-    def array(size = 3)
-      Array.new(size)
-    end
-end

data/test/console

@@ -1,8 +0,0 @@
-#!/usr/bin/env ruby
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-opts = %w[ --simple-prompt ]
-opts << '-rirb/completion'
-opts << '-rlib/load_fixtures'
-
-exec irb, '-Ilib:test', *opts

data/test/database.yml

@@ -1,16 +0,0 @@
-sqlite3:
-  database: ":memory:"
-  adapter: sqlite3
-  timeout: 500
-
-mysql:
-  adapter: mysql
-  database: will_paginate
-  username: 
-  encoding: utf8
-
-postgres:
-  adapter: postgresql
-  database: will_paginate
-  username: postgres
-  min_messages: warning