pagination_scope 0.0.8

data/ChangeLog

@@ -0,0 +1,40 @@
+== 0.0.7 / 2008-09-28
+
+* Changed spec of count method. Now it works without :group option.
+  If you want the old behaviour, you can use count_ids instead.
+
+== 0.0.6 / 2008-09-26
+
+* Applied the patch from maiha. Thanks!
+
+＜モデル＞
+* AR.paginate の第三引数に options を渡せるように変更
+* AR.paginate の options は第一引数でも可能にした
+  AR.paginate(params[:page], 10, options)
+  以外にも以下のように書ける
+  
+   options = {
+     :page => params[:page],
+     :per_page => 10,
+     :order => "id",
+   }
+   AR.paginate(options)
+
+＜ヘルパ＞
+* Helper#paginate のオプション名を変更 (newer->prev, older->next)
+   昇順、降順によって newer/older が逆の意味になってわかり辛かったので
+* Helper#paginate の各要素にクラス名を付与
+   will_paginate のスタイルシートがそのまま使えるように合わせた
+* Helper#paginate のリンクに rel 属性を追加
+   AutoPagerize 対応
+* Helper#paginate のオプションに truncate を追加
+   省略時の '...' を設定可能にした
+
+== 0.0.5 / 2008-09-24
+
+* Caches count.
+
+== 0.0.1 / 2008-08-14
+
+* initial release
+

data/README

@@ -0,0 +1,46 @@
+= pagination_scope
+
+This is a rails plugin module for mixing in pagination function.
+
+== Description
+
+This library is suitable to use together with complicated named_scope which has
+:joins options.  You can use the WillPaginate for ordinary case of pagination.
+
+== Installation
+
+=== Archive Installation
+
+	rake install
+
+=== Gem Installation
+
+	gem install pagination_scope
+
+
+== Features/Problems
+
+
+== Synopsis
+
+In your model class,
+
+  class Post
+    include PaginationScope
+
+In your controller class,
+
+  class PostsController < ApplicationController
+    def index
+      @posts = Post.not_deleted.paginate(params[:page], 10)
+
+In your view html.erb,
+
+  <%= paginate @posts %>
+
+
+== Copyright
+
+Author::    Genki Takiuchi <genki@s21g.com>
+Copyright:: Copyright (c) 2008 Genki Takiuchi
+License::   

data/Rakefile

@@ -0,0 +1,149 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+require 'lib/pagination_scope'
+include FileUtils
+
+NAME              = "pagination_scope"
+AUTHOR            = "Genki Takiuchi"
+EMAIL             = "genki@s21g.com"
+DESCRIPTION       = ""
+RUBYFORGE_PROJECT = "asakusarb"
+HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+BIN_FILES         = %w(  )
+
+VERS              = PaginationScope::VERSION
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = [
+	'--title', "#{NAME} documentation",
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README",
+	"--inline-source",
+]
+
+task :default => [:spec]
+task :package => [:clean]
+
+Rake::TestTask.new("test") do |t|
+	t.libs   << "spec"
+	t.pattern = "spec/**/*_spec.rb"
+	t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = ["README", "ChangeLog"]
+	s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+	s.summary           = DESCRIPTION
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir            = "bin"
+	s.require_path      = "lib"
+	#s.autorequire       = ""
+	s.test_files        = Dir["spec/unit/*_spec.rb"]
+
+	s.add_dependency('activesupport', '>=1.3.1')
+	#s.required_ruby_version = '>= 1.8.2'
+
+	s.files = %w(README ChangeLog Rakefile) +
+		Dir.glob("{bin,doc,spec,lib,templates,generator,extras,website,script}/**/*") + 
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb") +
+		Dir.glob("rails/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+end
+
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "resh"
+	#rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README', 'ChangeLog')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('ext/**/*.c')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	require 'rubyforge'
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'takiuchi').upload
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+	v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+	abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
+	pkg = "pkg/#{NAME}-#{VERS}"
+
+	require 'rubyforge'
+	rf = RubyForge.new.configure
+	puts "Logging in"
+	rf.login
+
+	c = rf.userconfig
+#	c["release_notes"] = description if description
+#	c["release_changes"] = changes if changes
+	c["preformatted"] = true
+
+	files = [
+		"#{pkg}.tgz",
+		"#{pkg}.gem"
+	].compact
+
+	puts "Releasing #{NAME} v. #{VERS}"
+	rf.add_release RUBYFORGE_PROJECT, NAME, VERS, *files
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+	puts spec.to_ruby
+end
+
+desc 'Update gem spec'
+task :gemspec do
+  open("#{NAME}.gemspec", 'w').write spec.to_ruby
+end
+
+desc 'Run specs'
+task :spec do
+  sh "spec --color spec"
+end

data/lib/pagination_scope.rb

@@ -0,0 +1,183 @@
+require 'activesupport'
+
+module PaginationScope
+  VERSION = '0.0.8'
+
+  class << self
+    def included(base)
+      base.class_eval do
+        named_scope :paginate, (proc do |*args|
+          options  = args.last.is_a?(Hash) ? args.pop : {}
+          page     = [(args.shift || options.delete(:page) || 1).to_i - 1, 0].max
+          per_page = args.shift || options.delete(:per_page) || 10
+          options[:extend] = PaginationScope::Extention
+          if per_page < 0
+            per_page = -per_page
+            options[:order] ||= "#{table_name}.id ASC"
+            options[:order].gsub!(/\b(DESC|ASC)\b/i){
+              case $1.upcase
+              when 'DESC'; 'ASC'
+              when 'ASC'; 'DESC'
+              end
+            }
+          end
+          options.merge :offset => per_page*(page), :limit => per_page
+        end)
+      end
+    end
+  end
+
+  module Extention
+    def size
+      proxy_found.size
+    end
+
+    def count
+      @count ||= with_scope :find => proxy_options.except(:offset, :limit) do
+        proxy_scope.count(:distinct => true, :select => "#{table_name}.#{primary_key}")
+      end
+    end
+
+    def num_pages; (count.to_f/proxy_options[:limit]).ceil end
+    def page; proxy_options[:offset]/proxy_options[:limit] + 1 end
+
+    def pages(window, left, right)
+      return [] if num_pages <= 1
+      (1..num_pages).inject([]) do |result, i|
+        i <= left || (num_pages - i) < right || (i-page).abs < window ?
+        result << i : (result.last.nil? ? result : result << nil)
+      end
+    end
+  end
+
+  Pagination = Struct.new(:context, :model, :options, :linker)
+  class Pagination
+    delegate :page, :num_pages, :count, :to=>"model"
+    delegate :link_to, :url_for, :content_tag, :to=>"context"
+
+    def current
+      page
+    end
+
+    def first_item
+      offset + 1
+    end
+
+    def last_item
+      [offset + limit, count].min
+    end
+
+    def first
+      1
+    end
+
+    def last
+      num_pages
+    end
+
+    def first?
+      page == 1
+    end
+
+    def last?
+      page == num_pages
+    end
+
+    def offset
+      model.proxy_options[:offset]
+    end
+
+    def limit
+      model.proxy_options[:limit]
+    end
+
+    def window
+      options[:window] || 5
+    end
+
+    def left
+      options[:left] || 2
+    end
+
+    def right
+      options[:right] || 2
+    end
+
+    def prev_label
+      options[:prev] || '&laquo; Prev'
+    end
+
+    def next_label
+      options[:next] || 'Next &raquo;'
+    end
+
+    def truncate
+      options[:truncate] || '...'
+    end
+
+    def pages
+      @pages ||= model.pages(window, left, right)
+    end
+
+    def span
+      proc do |*args|
+        content_tag(:span, args[0].to_s, :class => (args[1]||"disabled"))
+      end
+    end
+
+    def prev_link
+      if page > 1
+        link_to prev_label, url_for(:page => page - 1), :class => :prev, :rel => "prev"
+      else
+        span.call(prev_label)
+      end
+    end
+
+    def next_link
+      if page < num_pages
+        link_to next_label, url_for(:page => page + 1), :class => :older, :rel => "next"
+      else
+        span.call(next_label)
+      end
+    end
+
+    def page_link
+      pages.map{|i| page_link_for(i)}
+    end
+
+    def link(i, *args)
+      if linker
+        linker.call(i, *args)
+      else
+        link_to i, url_for(:page => i)
+      end
+    end
+
+    def page_link_for(i)
+      if i.nil?
+        span.call(truncate, options[:style])
+      elsif i == page
+        span.call(i, "#{options[:style]} current")
+      else
+        span.call(link(i), options[:style])
+      end
+    end
+
+    def to_s(*args)
+      args = [:prev, :page, :next] if args.blank?
+      items = args.map{|i| respond_to?("#{i}_link") ? send("#{i}_link") : []}.flatten
+      content_tag(:div, items.join("\n"), :class => "pagination")
+    end
+
+    def inspect
+      keys = %w( page count offset limit first last first_item last_item )
+      "#<Pagination %s>" % keys.map{|key| "#{key}: #{send(key)}"}.join(', ')
+    end
+  end
+
+  module ::ApplicationHelper
+    def paginate(model, options = nil, &block)
+      Pagination.new(self, model, options||{}, block)
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'pagination_scope'
+
+ActiveRecord::Base.class_eval do
+  include PaginationScope
+end

data/spec/fixtures/groups.csv

@@ -0,0 +1,3 @@
+id,name
+1,buono
+2,r&k

data/spec/fixtures/users.csv

@@ -0,0 +1,6 @@
+id,name,group_id
+1,momoko,1
+2,miyabi,1
+3,airi,1
+4,nksk,2
+5,chisato,2

data/spec/migrations/1_create_users.rb

@@ -0,0 +1,12 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table("users") do |t|
+      t.column :name,     :string
+      t.column :group_id, :integer
+    end
+  end
+
+  def self.down
+    drop_table "users"
+  end
+end

data/spec/migrations/2_create_groups.rb

@@ -0,0 +1,11 @@
+class CreateGroups < ActiveRecord::Migration
+  def self.up
+    create_table("groups") do |t|
+      t.column :name,     :string
+    end
+  end
+
+  def self.down
+    drop_table "groups"
+  end
+end

data/spec/models/group.rb

@@ -0,0 +1,4 @@
+class Group < ActiveRecord::Base
+  has_many :users
+  include PaginationScope
+end

data/spec/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  include PaginationScope
+  belongs_to :group
+end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+require 'pathname'
+require 'rubygems'
+require 'activerecord'
+require 'active_record/fixtures'
+
+gem 'rspec', '~>1.1.11'
+require 'spec'
+
+SPEC_ROOT = Pathname(__FILE__).dirname.expand_path
+require SPEC_ROOT.parent + 'lib/pagination_scope'
+
+# setup mock adapters
+def make_connection(clazz, db_file)
+  FileUtils.rm(db_file) if File.exist?(db_file)
+  ActiveRecord::Base.configurations = { clazz.name => { :adapter => 'sqlite3', :database => db_file, :timeout => 5000 } }
+  unless File.exist?(db_file)
+    puts "Building SQLite3 database at #{db_file}."
+    sqlite_command = %Q{sqlite3 "#{db_file}" "create table a (a integer); drop table a;"}
+    puts "Executing '#{sqlite_command}'"
+    raise SqliteError.new("Seems that there is no sqlite3 executable available") unless system(sqlite_command)
+  end
+  clazz.establish_connection(clazz.name)
+end
+
+sqlite_test_db  = "#{SPEC_ROOT}/../test.sqlite3"
+make_connection(ActiveRecord::Base, sqlite_test_db)
+
+# ----------------------------------------------------------------------
+# --- Migration      ---
+# ----------------------------------------------------------------------
+
+Dir.glob(SPEC_ROOT + 'migrations' + '*.rb').sort.each do |migration|
+  require migration
+end
+
+# TODO: should resolv class names automatically
+CreateUsers.up
+CreateGroups.up
+
+Dir.glob(SPEC_ROOT + 'models' + '*.rb').each do |model|
+  require model
+end
+
+Dir.glob(SPEC_ROOT + 'fixtures' + '*.{yml,csv}').each do |fixture_file|
+  Fixtures.create_fixtures('fixtures', File.basename(fixture_file, '.*'))
+end
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+#    Item.delete_all
+  end
+end
+
+

data/spec/unit/conditional_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe PaginationScope do
+  before(:all) do
+    User.destroy_all
+    require 'fastercsv'
+    users_csv = FasterCSV.open(
+      File.join(File.dirname(__FILE__), %w(../fixtures/users.csv))).to_a
+    cols, values = users_csv[0], users_csv[1..-1]
+    values.each do |vals|
+      hash = Hash[cols.zip(vals)]
+      hash.delete("id")
+      User.create!(hash.except("id"))
+    end
+  end
+
+  before(:each) do
+    @conds = ["id < 4"]
+    @start = 1
+    @limit = 2
+    @page  = User.paginate(@start, @limit, :conditions=>@conds)
+  end
+
+  describe ".paginate" do
+    describe "#size" do
+      it "should be tested on valid fixtures" do
+        User.count.should > 0 
+      end
+
+      it "should be equal to per_page" do
+        # TODO: ensure count >= limit
+        @page.size.should == @limit
+      end
+    end
+
+    describe "#count" do
+      it "should be equal to top level count" do
+        count = User.count(:conditions=>@conds)
+        @page.count.should == count
+      end
+
+      it "should ignore :offset option" do
+        count = User.count(:conditions=>@conds)
+        @page = User.paginate(2, @limit, :conditions=>@conds) # :offset 2*@limit
+        @page.count.should == count
+      end
+
+      it "should ignore :limit option" do
+        count = User.count(:conditions=>@conds)
+        @page = User.paginate(1, 0, :conditions=>@conds) # :limit 0
+        @page.count.should == count
+      end
+    end
+  end
+end
+
+

data/spec/unit/helper_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe PaginationScope::Pagination do
+  before(:each) do
+    @conds = ["id < 4"]
+    @limit = 3
+
+    # static values
+    @count = User.count
+    @max_pages = (@count.to_f / @limit).ceil
+  end
+
+  def page_at(page_no)
+    pagenate = User.paginate(page_no, @limit, :conditions=>@conds)
+    context  = :dummy_for_view
+    PaginationScope::Pagination.new(context, pagenate)
+  end
+
+  it "provide #current"
+  it "provide #first_item"
+  it "provide #last_item"
+  it "provide #first"
+  it "provide #last"
+  it "provide #first?"
+  it "provide #last?"
+  it "provide #offset"
+  it "provide #limit"
+  it "provide #window"
+  it "provide #left"
+  it "provide #right"
+  it "provide #prev_label"
+  it "provide #next_label"
+  it "provide #truncate"
+  it "provide #pages"
+  it "provide #span"
+  it "provide #prev_link"
+  it "provide #next_link"
+  it "provide #page_link"
+  it "provide #link(i, *args)"
+  it "provide #page_link_for(i)"
+  it "provide #to_s(*args)"
+  it "provide #inspect"
+  it "provide #paginate(model, options = nil, &block)"
+end
+
+

data/spec/unit/include_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe PaginationScope do
+  before(:each) do
+    @start = 1
+    @limit = 2
+    @page1 = Group.paginate(@start, @limit)
+    @page2 = Group.paginate(@start, @limit, :include=>:users)
+  end
+
+  describe ".paginate(:include)" do
+    describe " should be equal to non-included one" do
+      it "for #count" do
+        @page2.count.should == @page1.count
+      end
+      it "for #size" do
+        @page2.size.should == @page1.size
+      end
+    end
+  end
+end
+
+

data/spec/unit/paginate_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe PaginationScope do
+  it 'should grant paginate class method to model' do
+    User.should respond_to(:paginate)
+  end
+
+  describe ".paginate" do
+    it "should accept at most three args" do
+      lambda {
+        User.paginate
+        User.paginate 1
+        User.paginate 1, 10, {}
+      }.should_not raise_error
+    end
+
+    describe "should raise ArgumentError" do
+      it "when four args are given"
+      it "when 1st arg is not Integer or Hash"
+      it "when 2nd arg is not Integer or Hash"
+      it "when 3rd arg is not Hash"
+    end
+
+    it "should return an ActiveRecord::NamedScope::Scope" do
+      User.paginate.class.should == ActiveRecord::NamedScope::Scope
+    end
+
+    it "should provide #count" do
+      User.paginate.should respond_to(:count)
+    end
+
+    describe "#count" do
+      it "should be equal to top level count" do
+        count = User.count
+        User.paginate.count.should == count
+      end
+    end
+
+    it "provide #num_pages"
+    it "provide #page"
+    it "provide #pages(window, left, right)"
+  end
+
+  it "should provide #proxy_options" do
+    User.paginate.class.should == ActiveRecord::NamedScope::Scope
+    pending
+    User.paginate.should be_respond_to(:proxy_options)
+  end
+
+  describe "#proxy_options" do
+    it "should return an Hash" do
+      User.paginate.proxy_options.class.should == Hash
+    end
+
+    describe "should set default value" do
+      it "0 to offset"
+      it "10 to limit"
+    end
+  end
+end
+
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: pagination_scope
+version: !ruby/object:Gem::Version 
+  version: 0.0.8
+platform: ruby
+authors: 
+- Genki Takiuchi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-21 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.1
+    version: 
+description: ""
+email: genki@s21g.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- ChangeLog
+files: 
+- README
+- ChangeLog
+- Rakefile
+- spec/fixtures
+- spec/fixtures/groups.csv
+- spec/fixtures/users.csv
+- spec/migrations
+- spec/migrations/1_create_users.rb
+- spec/migrations/2_create_groups.rb
+- spec/models
+- spec/models/group.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/unit
+- spec/unit/conditional_spec.rb
+- spec/unit/helper_spec.rb
+- spec/unit/include_spec.rb
+- spec/unit/paginate_spec.rb
+- lib/pagination_scope.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://asakusarb.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- pagination_scope documentation
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples|extras)/
+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: asakusarb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: 
+- spec/unit/conditional_spec.rb
+- spec/unit/helper_spec.rb
+- spec/unit/include_spec.rb
+- spec/unit/paginate_spec.rb