dm-pagination 0.2.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 YOUR NAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,23 @@
+dm-pagination
+=============
+
+A plugin for the Merb framework that provides pagination for DataMapper.
+
+USAGE:
+
+  In your controller,
+
+  class Posts
+    def index
+      @posts = Post.paginate(:page => params[:page])
+    end
+
+  In your view,
+
+  <ul>
+  <% @posts.each do |post| %>
+    <li><%= h(post.body) %></li>
+  <% end %>
+  </ul>
+  <%= paginate @posts %>
+

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "dm-pagination"
+GEM_VERSION = "0.2.1"
+AUTHOR = "Genki Takiuchi"
+EMAIL = "genki@s21g.com"
+HOMEPAGE = "http://blog.s21g.com/genki"
+SUMMARY = "Merb plugin that provides pagination for DataMapper"
+RUBYFORGE_PROJECT = "asakusarb"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = RUBYFORGE_PROJECT
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 1.0.7.1')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+	pkg.need_tar = true
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+desc "Run spec"
+task :spec do
+  sh "spec spec --color"
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => :package do |t|
+  require 'rubyforge'
+	v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+	abort "Versions don't match #{v} vs #{GEM_VERSION}" unless v == GEM_VERSION
+	pkg = "pkg/#{GEM_NAME}-#{GEM_VERSION}"
+
+	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 #{GEM_NAME} v. #{GEM_VERSION}"
+	rf.add_release RUBYFORGE_PROJECT, GEM_NAME, GEM_VERSION, *files
+end
+
+task :default => :spec

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/dm-pagination.rb
+Add your Merb rake tasks to lib/dm-pagination/merbtasks.rb

data/lib/dm-pagination/merbtasks.rb

@@ -0,0 +1,6 @@
+namespace :dm_pagination do
+  desc "Do something for dm-pagination"
+  task :default do
+    puts "dm-pagination doesn't do anything"
+  end
+end

data/lib/dm-pagination/paginatable.rb

@@ -0,0 +1,9 @@
+require 'dm-pagination/pagination'
+
+module DmPagination
+  module Paginatable
+    def paginate(options = {})
+      Pagination.new(all, options)
+    end
+  end
+end

data/lib/dm-pagination/pagination.rb

@@ -0,0 +1,41 @@
+module DmPagination
+  class Pagination
+    def initialize(collection, options)
+      @page = (options[:page] || 1).to_i
+      @per_page = (options[:per_page] || 10).to_i
+      @proxy_collection = collection
+      @collection = collection.all(
+        :offset => (@page - 1)*@per_page, :limit => @per_page)
+      @num_pages = num_pages
+    end
+
+    def page
+      @page
+    end
+
+    def num_pages
+      (@proxy_collection.count + @per_page - 1) / @per_page
+    end
+
+    def pages(window = 5, left = 2, right = 2)
+      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
+
+    def count
+      offset = (@page - 1)*@per_page
+      [0, [@proxy_collection.count - offset, @per_page].min].max
+    end
+
+    def respond_to?(*args, &block)
+      super || @collection.send(:respond_to?, *args, &block)
+    end
+
+    def method_missing(method, *args, &block)
+      @collection.send(method, *args, &block)
+    end
+  end
+end

data/lib/dm-pagination/pagination_builder.rb

@@ -0,0 +1,85 @@
+module DmPagination
+  class PaginationBuilder
+    def initialize(context, pagination, *args, &block)
+      @context = context
+      @pagination = pagination
+      @block = block
+      @options = args.last.kind_of?(Hash) ? args.pop : {}
+      @options[:page] ||= :page
+      @args = args.blank? ? [:prev, :pages, :next] : args
+    end
+
+    def to_s(*args)
+      args = @args if args.blank?
+      items = args.map{|i| respond_to?("link_to_#{i}") ?
+        send("link_to_#{i}") : []}.flatten
+      @context.tag(:div, items.join("\n"), :class => "pagination")
+    end
+
+    def link_to_pages
+      @pagination.pages.map{|page| link_to_page(page)}
+    end
+
+    def link_to_prev
+      if @pagination.page > 1
+        @context.link_to prev_label,
+          url(@options[:page] => @pagination.page - 1),
+          :class => :prev, :rel => "prev"
+      else
+        span.call(prev_label, :prev)
+      end
+    end
+
+    def link_to_next
+      if @pagination.page < @pagination.num_pages
+        @context.link_to next_label,
+          url(@options[:page] => @pagination.page + 1),
+          :class => :next, :rel => "next"
+      else
+        span.call(next_label, :next)
+      end
+    end
+
+    def link_to_page(page)
+      if page.nil?
+        span.call truncate, @options[:style]
+      elsif page == @pagination.page
+        span.call page, [@options[:style], 'current'].compact.join(' ')
+      else
+        span.call link(page), @options[:style]
+      end
+    end
+
+  private
+    def span
+      proc do |*args|
+        @context.tag(:span, args[0].to_s,
+          :class => [args[1], "disabled"].compact.join(' '))
+      end
+    end
+
+    def link(page, *args)
+      if @block
+        @block.call(page, *args)
+      else
+        @context.link_to(page, url(@options[:page] => page))
+      end
+    end
+
+    def truncate
+      @options[:truncate] || Merb::Plugins.config[:dm_pagination][:truncate]
+    end
+
+    def prev_label
+      @options[:prev] || Merb::Plugins.config[:dm_pagination][:prev_label]
+    end
+
+    def next_label
+      @options[:next] || Merb::Plugins.config[:dm_pagination][:next_label]
+    end
+
+    def url(params)
+      @context.url(@context.params.merge(params))
+    end
+  end
+end

data/lib/dm-pagination.rb

@@ -0,0 +1,41 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:dm_pagination] = {
+    :prev_label => '« Prev',
+    :next_label => 'Next »',
+    :truncate => '...'
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    # require code that must be loaded before the application
+    require 'dm-pagination/paginatable'
+    module DataMapper
+      module Resource
+        module ClassMethods
+          include DmPagination::Paginatable
+        end
+      end
+
+      class Collection
+        extend DmPagination::Paginatable
+      end
+    end
+
+    require 'dm-pagination/pagination_builder'
+    module Merb
+      module GlobalHelpers
+        def paginate(pagination, *args, &block)
+          DmPagination::PaginationBuilder.new(self, pagination, *args, &block)
+        end
+      end
+    end
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    # code that can be required after the application loads
+  end
+  
+  Merb::Plugins.add_rakefiles "dm-pagination/merbtasks"
+end

data/spec/dm-pagination_spec.rb

@@ -0,0 +1,99 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+DataMapper.setup(:default, "sqlite3::memory:")
+
+Post.auto_migrate!
+
+describe "dm-pagination" do
+  describe "paginatable" do
+    it "should extend DataMapper::Resource" do
+      test = Post.new
+      test.should_not be_nil
+      Post.should be_respond_to(:paginate)
+      Post.all.should be_respond_to(:paginate)
+    end
+
+    it "should return Pagination object" do
+      Post.paginate.should be_kind_of(DmPagination::Pagination)
+      Post.all.paginate.should be_kind_of(DmPagination::Pagination)
+    end
+
+    it "should respond to model's method" do
+      Post.paginate.should be_respond_to(:to_atom)
+    end
+  end
+
+  describe "pagination" do
+    before :all do
+      Post.all.destroy!
+      101.times{|i| Post.create(:index => i)}
+    end
+
+    it "should be specified on 101 test posts" do
+      Post.count.should == 101
+    end
+
+    it "should have 10 pages" do
+      Post.paginate.num_pages.should == 11
+      Post.all.paginate.num_pages.should == 11
+    end
+
+    it "should be able to calculate num pages on scope" do
+      Post.all(:index.gt => 50).count.should == 50
+      Post.all(:index.gt => 50).paginate.num_pages.should == 5
+      Post.all(:index.gt => 49).paginate.num_pages.should == 6
+    end
+
+    it "should act as Collection" do
+      Post.paginate(:page => 8).count.should == 10
+      Post.paginate(:page => 11).count.should == 1
+      Post.paginate(:page => 12).count.should == 0
+      Post.paginate(:page => 5, :per_page => 6).count.should == 6
+    end
+  end
+
+  describe "pagination builder" do
+    include Merb::Helpers::Tag
+
+    before :all do
+      Post.all.destroy!
+      101.times{|i| Post.create(:index => i)}
+    end
+
+    it "should be tested on 101 posts" do
+      Post.count.should == 101
+    end
+
+    it "should have rendered with pagination" do
+      response = request "/pagination_builder/simple"
+      response.should be_successful
+      response.should have_selector("div.pagination")
+      response.should have_selector("ul")
+      response.should have_selector("li")
+      response.should have_selector("a[rel=next]")
+    end
+
+    it "should have rendered with pagination at page 2" do
+      response = request "/pagination_builder/simple", :params => {:page => 2}
+      response.should be_successful
+      response.should have_selector("a.prev[rel=prev]")
+      response.should have_selector("a.next[rel=next]")
+      response.body.scan(/Prev|Next/).should == %w(Prev Next)
+      url = "/pagination_builder/simple?page=3"
+      response.should have_xpath("//a[@href='#{url}']")
+    end
+
+    it "should be able to control links" do
+      response = request "/pagination_builder/variant"
+      response.should be_successful
+      response.body.scan(/Prev|Next/).should == %w(Next Prev)
+      response.should have_selector("a.next[rel=next]")
+      response.should_not have_selector("a.prev[rel=prev]")
+      response.should have_selector("span.prev")
+      response.should have_selector("span.number")
+      response.should_not have_selector("span.prev.number")
+      url = "/pagination_builder/variant?foo=2"
+      response.should have_xpath("//a[@href='#{url}']")
+    end
+  end
+end

data/spec/fixture/app/controllers/pagination_builder.rb

@@ -0,0 +1,11 @@
+class PaginationBuilder < Merb::Controller
+  def simple
+    @posts = Post.paginate(params)
+    render
+  end
+
+  def variant
+    @posts = Post.paginate(params)
+    render
+  end
+end

data/spec/fixture/app/models/post.rb

@@ -0,0 +1,10 @@
+class Post
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :index, Integer
+
+  def self.to_atom
+    "atom"
+  end
+end

data/spec/fixture/app/views/layout/application.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <title>Fresh Merb App</title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <link rel="stylesheet" href="/stylesheets/master.css" type="text/css" media="screen" charset="utf-8"/>
+  </head>
+  <body>
+    <%= catch_content :for_layout %>
+  </body>
+</html>

data/spec/fixture/app/views/pagination_builder/simple.html.erb

@@ -0,0 +1,7 @@
+<ul>
+  <% @posts.each do |post| %>
+    <li><%= post.index %></li>
+  <% end %>
+</ul>
+
+<%= paginate @posts %>

data/spec/fixture/app/views/pagination_builder/variant.html.erb

@@ -0,0 +1 @@
+<%= paginate @posts, :pages, :next, :prev, :style => 'number', :page => :foo %>

data/spec/fixture/config/router.rb

@@ -0,0 +1,13 @@
+Merb::Router.prepare do |r|
+  # RESTful routes
+  # r.resources :posts
+
+  # This is the default route for /:controller/:action/:id
+  # This is fine for most cases.  If you're heavily using resource-based
+  # routes, you may want to comment/remove this line to prevent
+  # clients from calling your create or destroy actions with a GET
+  r.default_routes
+
+  # Change this for your home page to be available at /
+  # r.match('/').to(:controller => 'whatever', :action =>'index')
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
+require 'spec'
+require 'merb-core'
+require 'merb-helpers'
+require 'merb-assets'
+require 'dm-core'
+require 'dm-pagination'
+require 'dm-pagination/paginatable'
+require 'dm-pagination/pagination_builder'
+require 'dm-aggregates'
+
+default_options = {
+  :environment => 'test',
+  :adapter     => 'runner',
+  :merb_root   => File.dirname(__FILE__) / 'fixture',
+  :log_file    => File.dirname(__FILE__) / '..' / 'log' / "merb_test.log"
+}
+options = default_options.merge($START_OPTIONS || {})
+DataMapper::Model.append_extensions DmPagination::Paginatable
+module Merb
+  module GlobalHelpers
+    def paginate(pagination, *args, &block)
+      DmPagination::PaginationBuilder.new(self, pagination, *args, &block)
+    end
+  end
+end
+
+Merb.disable(:initfile)
+Merb.start_environment(options)
+
+Spec::Runner.configure do |config|
+  config.include Merb::Test::RequestHelper
+  config.include Webrat::Matchers
+  config.include Webrat::HaveTagMatcher
+    
+  def with_level(level)
+    Merb.logger = Merb::Logger.new(StringIO.new, level)
+    yield
+    Merb.logger
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: dm-pagination
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Genki Takiuchi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-27 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.7.1
+    version: 
+description: Merb plugin that provides pagination for DataMapper
+email: genki@s21g.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/dm-pagination
+- lib/dm-pagination/merbtasks.rb
+- lib/dm-pagination/paginatable.rb
+- lib/dm-pagination/pagination.rb
+- lib/dm-pagination/pagination_builder.rb
+- lib/dm-pagination.rb
+- spec/dm-pagination_spec.rb
+- spec/fixture
+- spec/fixture/app
+- spec/fixture/app/controllers
+- spec/fixture/app/controllers/pagination_builder.rb
+- spec/fixture/app/models
+- spec/fixture/app/models/post.rb
+- spec/fixture/app/views
+- spec/fixture/app/views/layout
+- spec/fixture/app/views/layout/application.html.erb
+- spec/fixture/app/views/pagination_builder
+- spec/fixture/app/views/pagination_builder/simple.html.erb
+- spec/fixture/app/views/pagination_builder/variant.html.erb
+- spec/fixture/config
+- spec/fixture/config/router.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://blog.s21g.com/genki
+post_install_message: 
+rdoc_options: []
+
+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: Merb plugin that provides pagination for DataMapper
+test_files: []
+