godfat-pagify 0.5.0

data/lib/pagify/pagers/data_mapper.rb

@@ -0,0 +1,30 @@
+
+# you'll need dm-core and dm-aggregates to use DataMapperPager
+
+module Pagify
+
+  class DataMapperPager < BasicPager
+    include PageAcceptStringOrBlank
+    attr_reader :model
+
+    def initialize model_class, opts = {}, query = {}
+      @model = model_class
+      query ||= {}
+      query_opts = reject_pager_opts(opts)
+
+      super(opts.merge(
+        :fetcher => lambda{ |offset, per_page|
+          model.send :with_scope, query do
+            model.all(query_opts.merge(:offset => offset, :limit => per_page))
+          end
+        },
+        :counter => lambda{
+          model.send :with_scope, query do
+            model.count(query_opts)
+          end
+        }))
+    end
+
+  end
+
+end

data/lib/pagify/pagers/details/page_accept_string_or_blank.rb

@@ -0,0 +1,14 @@
+
+module Pagify
+  module PageAcceptStringOrBlank
+    private
+    def normalize_page n
+      if n.blank?
+        n = 1
+      else
+        n = n.to_i
+      end
+    end
+  end
+
+end

data/lib/pagify/pagers/null.rb

@@ -0,0 +1,17 @@
+
+module Pagify
+
+  # a null paginator that stubs any page into a null page.
+  class NullPager < BasicPager
+    include Singleton
+    def initialize
+      super(:fetcher => lambda{|*a|[]}, :counter => lambda{0})
+    end
+
+    private
+    def normalize_page n
+      0
+    end
+  end
+
+end # of Pagify

data/lib/pagify/pages/basic.rb

@@ -0,0 +1,58 @@
+
+require 'rubygems'
+
+module Pagify
+  # which was produced by Paginator#page / Paginator#[],
+  # representing page that contained target data.
+  # it would use lazy fetching, whenever you need the data,
+  # the fetcher would be invoked that time. whenever the data
+  # was fetched, it won't fetch again. it you need refetch,
+  # call Page#fetch
+  class BasicPage
+    # prvent Page#to_a return [#<Page:0x12345>]
+    undef_method :to_a if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.9.0')
+
+    # pager to get the original pager; page to get the number of this page
+    attr_reader :pager, :page
+
+    # don't create a page instance yourself unless you have to
+    def initialize pager, page; @pager, @page = pager, page; end
+
+    # return the page instance next to this page
+    def next; pager.page(page + 1); end
+
+    # return the page instance prev to this page
+    def prev; pager.page(page - 1); end
+
+    # if the page numbers and the pagers are equal,
+    # then the pages are equal.
+    def == rhs
+      rhs.kind_of?(BasicPage) &&
+      page  == rhs.page       &&
+      pager == rhs.pager
+    end
+
+    # explicitly fetch the data from pager
+    def fetch; @data = pager.fetcher[self.begin, pager.per_page]; end
+
+    # get the data fetched from pager
+    def data; @data ||= fetch; end
+
+    # the real beginning index
+    def begin; pager.offset page; end
+
+    # the real ending index (need fetch, because we don't know the size)
+    def end; self.begin + self.size - 1; end
+
+    # any other method call would delegate to the data,
+    # e.g., each, to_a, map, first, method_you_defined, etc.
+    def method_missing msg, *args, &block
+      if data.respond_to?(msg)
+        data.__send__(msg, *args, &block)
+      else
+        super(msg, *args, &block)
+      end
+    end
+
+  end
+end

data/lib/pagify/pages/null.rb

@@ -0,0 +1,11 @@
+
+module Pagify
+
+  # a null page that stubs anything to 0 or [], etc.
+  class NullPage < BasicPage
+    def initialize pager = NullPager.instance, page = 0
+      super(pager, page)
+    end
+  end
+
+end # of Pagify

data/lib/pagify/pagifiers/abstract.rb

@@ -0,0 +1,34 @@
+
+module Pagify
+  module Pagifier
+
+    attr_reader :pagify_pager
+
+    def pagify_cache
+      @pagify_cache ||= false
+    end
+
+    # cleanup cache if turn off cache
+    # NOTE: you would face thread-safety problem if you turn on cache
+    def pagify_cache= bool
+      @pagify_pager = nil unless bool
+      @pagify_cache = bool
+    end
+
+    def pagify opts = {}
+      opts = {:per_page => 20, :null_page => false, :page => 1}.merge(opts)
+      page = opts.delete(:page)
+
+      pager = if pagify_cache
+                @pagify_pager ||= pagify_pager_create(self, opts)
+                pagify_pager.opts = opts
+                pagify_pager
+              else
+                pagify_pager_create(self, opts)
+              end
+
+      pager.page(page)
+    end
+
+  end
+end

data/lib/pagify/pagifiers/active_record.rb

@@ -0,0 +1,11 @@
+
+require 'pagify/pagifiers/abstract'
+
+[ActiveRecord::Base, ActiveRecord::Associations::AssociationCollection].each{ |klass|
+  klass.module_eval do
+    extend Pagify::Pagifier
+    def self.pagify_pager_create model, opts
+      Pagify::ActiveRecordPager.new model, opts
+    end
+  end
+}

data/lib/pagify/pagifiers/array.rb

@@ -0,0 +1,9 @@
+
+require 'pagify/pagifiers/abstract'
+
+class Array
+  include Pagify::Pagifier
+  def pagify_pager_create model, opts
+    Pagify::ArrayPager.new model, opts
+  end
+end

data/lib/pagify/pagifiers/data_mapper.rb

@@ -0,0 +1,11 @@
+
+require 'pagify/pagifiers/abstract'
+
+module DataMapper
+  module Model
+    include Pagify::Pagifier
+    def pagify_pager_create model, opts
+      Pagify::DataMapperPager.new model, opts, model.query
+    end
+  end
+end

data/lib/pagify/version.rb

@@ -0,0 +1,4 @@
+
+module Pagify
+  VERSION = '0.5.0'
+end

data/pagify.gemspec

@@ -0,0 +1,51 @@
+
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pagify}
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lin Jen-Shin (a.k.a. godfat \347\234\237\345\270\270)"]
+  s.date = %q{2008-12-11}
+  s.description = %q{pagination tools for plain Ruby, DataMapper, ActiveRecord, and other ORM.}
+  s.email = %q{godfat (XD) godfat.org}
+  s.extra_rdoc_files = ["CHANGES", "LICENSE", "NOTICE", "README", "TODO", "pagify.gemspec"]
+  s.files = ["CHANGES", "LICENSE", "NOTICE", "README", "Rakefile", "TODO", "lib/pagify.rb", "lib/pagify/active_record.rb", "lib/pagify/array.rb", "lib/pagify/basic.rb", "lib/pagify/data_mapper.rb", "lib/pagify/helpers/abstract.rb", "lib/pagify/helpers/details/setting.rb", "lib/pagify/helpers/details/setup.rb", "lib/pagify/helpers/html.rb", "lib/pagify/null.rb", "lib/pagify/pagers/active_record.rb", "lib/pagify/pagers/array.rb", "lib/pagify/pagers/basic.rb", "lib/pagify/pagers/data_mapper.rb", "lib/pagify/pagers/details/page_accept_string_or_blank.rb", "lib/pagify/pagers/null.rb", "lib/pagify/pages/basic.rb", "lib/pagify/pages/null.rb", "lib/pagify/pagifiers/abstract.rb", "lib/pagify/pagifiers/active_record.rb", "lib/pagify/pagifiers/array.rb", "lib/pagify/pagifiers/data_mapper.rb", "lib/pagify/version.rb", "pagify.gemspec", "spec/pagify_spec.rb", "spec/spec_helper.rb", "tasks/ann.rake", "tasks/bones.rake", "tasks/gem.rake", "tasks/git.rake", "tasks/manifest.rake", "tasks/notes.rake", "tasks/post_load.rake", "tasks/rdoc.rake", "tasks/rubyforge.rake", "tasks/setup.rb", "tasks/spec.rake", "tasks/svn.rake", "tasks/test.rake", "test/helper.rb", "test/suite_for_model.rb", "test/test_active_record.rb", "test/test_array.rb", "test/test_basic.rb", "test/test_data_mapper.rb", "test/test_html.rb", "test/test_null.rb", "test/test_pagify.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/godfat/pagify}
+  s.rdoc_options = ["--diagram", "--charset=utf-8", "--inline-source", "--line-numbers", "--promiscuous", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ludy}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{pagination tools for plain Ruby, DataMapper, ActiveRecord, and other ORM.}
+  s.test_files = ["test/test_active_record.rb", "test/test_array.rb", "test/test_basic.rb", "test/test_data_mapper.rb", "test/test_html.rb", "test/test_null.rb", "test/test_pagify.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bones>, [">= 2.1.0"])
+      s.add_development_dependency(%q<extlib>, ["<= 0.9.8"])
+      s.add_development_dependency(%q<dm-core>, ["<= 0.9.7"])
+      s.add_development_dependency(%q<dm-aggregates>, ["<= 0.9.7"])
+      s.add_development_dependency(%q<activerecord>, [">= 2.0.0"])
+      s.add_development_dependency(%q<minitest>, [">= 1.3.0"])
+    else
+      s.add_dependency(%q<bones>, [">= 2.1.0"])
+      s.add_dependency(%q<extlib>, ["<= 0.9.8"])
+      s.add_dependency(%q<dm-core>, ["<= 0.9.7"])
+      s.add_dependency(%q<dm-aggregates>, ["<= 0.9.7"])
+      s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+      s.add_dependency(%q<minitest>, [">= 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<bones>, [">= 2.1.0"])
+    s.add_dependency(%q<extlib>, ["<= 0.9.8"])
+    s.add_dependency(%q<dm-core>, ["<= 0.9.7"])
+    s.add_dependency(%q<dm-aggregates>, ["<= 0.9.7"])
+    s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+    s.add_dependency(%q<minitest>, [">= 1.3.0"])
+  end
+end

data/spec/pagify_spec.rb

@@ -0,0 +1,8 @@
+# $Id$
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Pagify do
+end
+
+# EOF

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# $Id$
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib pagify]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

data/test/helper.rb

@@ -0,0 +1,14 @@
+
+require 'rubygems'
+require 'minitest/unit'
+MiniTest::Unit.autorun
+
+require 'pagify'
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('1.8.7')
+  class Symbol
+    def to_proc
+      lambda{ |*args| args.shift.__send__(self, *args) }
+    end
+  end
+end

data/test/suite_for_model.rb

@@ -0,0 +1,125 @@
+
+# require 'extlib'
+require 'test/test_pagify'
+
+module SuiteForModel
+
+  def test_cache_for_pager
+    send(:User).pagify_cache = true
+
+    users1 = send(:User).pagify :page => 1, :per_page => 2
+    pager = send(:User).pagify_pager
+
+    users2 = send(:User).pagify :page => 2, :per_page => 2
+
+    # same pager
+    assert_equal users1.pager.object_id, send(:User).pagify_pager.object_id
+    assert_equal users2.pager.object_id, send(:User).pagify_pager.object_id
+    assert_equal send(:User).pagify(:per_page => 1).pager.object_id, users1.pager.object_id
+
+    # there's cache
+    assert send(:User).pagify_pager != nil
+
+    # cleanup cache
+    send(:User).pagify_cache = false
+    assert_nil send(:User).pagify_pager
+  ensure
+    # ensure we cleanup the cache.
+    send(:User).pagify_cache = false
+  end
+
+  def test_no_cache_for_pager
+    assert_nil send(:User).pagify_pager
+
+    users1 = send(:User).pagify :page => 1, :per_page => 2
+    pager = send(:User).pagify_pager
+
+    users2 = send(:User).pagify :page => 2, :per_page => 2
+
+    assert_nil send(:User).pagify_pager
+
+    # not same pager for same opts
+    assert users1.pager.object_id != send(:User).pagify_pager.object_id
+    assert users2.pager.object_id != send(:User).pagify_pager.object_id
+  end
+
+  def test_page_correctness_fixnum
+    page_correctness 1
+  end
+
+  def test_page_correctness_string
+    page_correctness '1'
+  end
+
+  def test_nil_page_default_page_1
+    users = send(:User).pagify :page => nil, :per_page => 2
+    assert_equal 2, users.pager.size
+    assert_equal 1, users.page
+  end
+
+  def page_correctness page
+    users = send(:User).pagify :page => page, :per_page => 2
+
+    assert_equal 2, users.pager.size
+    assert_equal 1, users.page
+    assert_equal send(:User).first, users.first
+    assert_equal 2, users.size
+    assert_equal send(:User).first(:offset => 2), users.next.first
+    assert_equal 1, users.next.size
+    assert_equal Pagify::NullPage.new(users.pager), users.next.next
+  end
+
+  def test_condition_chain
+    users_A = send(:User).all(:conditions => ['name = ?', 'A']).pagify :page => 1, :per_page => 1
+    assert_equal 1, users_A.size
+    assert_equal 2, users_A.pager.entries_count
+    assert_equal 2, users_A.pager.size # pages
+  end
+
+  def test_association_pagify
+    user = send(:User).first
+    user.pets.push(*send(:Pet).all)
+    assert user.save
+    assert_equal 3, user.pets.count
+
+    page = all_pets_with_name_godfat(user).pagify :page => 2, :per_page => 1
+    assert_equal 1, page.size
+    assert_equal 2, page.pager.size
+  end
+
+  def self.included test_case
+    test_case.module_eval do
+      # due to ruby const lookup is different from method lookup
+      def User; self.class.const_get(:User); end
+      def Pet;  self.class.const_get(:Pet); end
+    end
+
+    test_case.const_get(:User).module_eval do
+      create :name => 'A'
+      create :name => 'A'
+      create :name => 'B'
+    end
+
+    test_case.const_get(:Pet).module_eval do
+      create :name => 'Qoo'
+      create :name => 'godfat'
+      create :name => 'godfat'
+    end
+  end
+
+  # include Extlib::Hook
+  #
+  # private
+  # def i_give_up
+  #   if self.class == TestActiveRecord
+  #     skip "it's toooooo hard to implement this for active record!! patch wanted!"
+  #   end
+  # end
+  #
+  # [:test_same_pager_with_same_opts,
+  #  :test_page_correctness,
+  #  :test_condition_chain].each{ |test|
+  #   before test.to_sym, :i_give_up
+  # }
+
+end

data/test/test_active_record.rb

@@ -0,0 +1,71 @@
+
+require 'test/helper'
+require 'test/suite_for_model'
+
+require 'pagify/active_record'
+
+gem 'dm-core', '<=0.9.7'
+require 'dm-core' # to help with active record to create database
+
+class TestActiveRecord < TestPagify
+  def test_for_active_record
+    for_pager Pagify::ActiveRecordPager.new(Topic)
+  end
+
+  class Topic
+    class << self
+      def count opts = {}
+        101
+      end
+      def find all, opts = {}
+        TestPagify.data[opts[:offset], opts[:limit]]
+      end
+    end
+  end
+
+  # i am tired with active record!!
+  DataMapper.setup :active_record, 'sqlite3:tmp/active_record.sqlite3'
+  class UserForActiveRecord
+    include DataMapper::Resource
+    property :id, Serial
+    property :name, String
+    def self.default_repository_name
+      :active_record
+    end
+    # why can't i use:
+    storage_name = 'users'
+    # end why
+    storage_names[default_repository_name] = 'users'
+    auto_migrate!
+  end
+
+  class PetForActiveRecord
+    include DataMapper::Resource
+    property :id, Serial
+    property :name, String
+    property :user_id, Integer
+    def self.default_repository_name
+      :active_record
+    end
+    storage_names[default_repository_name] = 'pets'
+    auto_migrate!
+  end
+
+  ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3', :database => 'tmp/active_record.sqlite3')
+
+  class User < ActiveRecord::Base
+    has_many :pets
+  end
+
+  class Pet < ActiveRecord::Base
+    belongs_to :user
+  end
+
+  include SuiteForModel
+
+  def all_pets_with_name_godfat user
+    user.pets.all(:conditions => ['name = ?', 'godfat'])
+  end
+
+end