dm-paginator 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Juan Felipe Alvarez Saldarriaga
+
+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.rdoc

@@ -0,0 +1,17 @@
+= dm-paginator
+
+A simple paginator for ruby's DataMapper.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Juan Felipe Alvarez Saldarriaga. See LICENSE for details.

data/examples/paginator.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby1.8
+require "rubygems"
+require "dm-core"
+require "dm-paginator"
+
+class Item
+	include DataMapper::Resource
+	property :id, Serial
+end
+ 
+DataMapper.setup :default, "sqlite3::memory:"
+DataMapper.auto_migrate!
+( 1..10 ).each { | n | Item.create }
+
+def test_paginator
+	@items = Item.limit_page nil, :limit => 2
+	p "<ul>"
+	@items.each do | item |
+		p "<li>" + item.id.to_s + "</li>"
+	end
+	p "</ul>"
+
+	p "page: " + @items.paginator.page.to_s
+	p "count: " + @items.paginator.count.to_s
+	p "page_count: " + @items.paginator.page_count.to_s
+
+  p @items.paginator.to_html "All", "control.erb"
+end
+
+test_paginator

data/lib/dm-paginator.rb

@@ -0,0 +1,15 @@
+require "dm-core"
+require "erb"
+require "dm-paginator/paginator"
+require "dm-paginator/default"
+require "dm-paginator/main"
+require "dm-paginator/control"
+require "dm-paginator/control/control_helper_abstract"
+require "dm-paginator/control/all"
+require "dm-paginator/control/sliding"
+require "dm-paginator/control/elastic"
+require "dm-paginator/control/jumping"
+
+DataMapper::Model.append_extensions DataMapper::Paginator
+DataMapper::Collection.send :include, DataMapper::Paginator
+DataMapper::Query.send :include, DataMapper::Paginator

data/lib/dm-paginator/control.rb

@@ -0,0 +1,31 @@
+module DataMapper
+  module Paginator
+    class Control
+      class << self; protected :new; end
+
+      ##
+      # Factory.
+      #
+      # @param [Main] paginator
+      # @param [String] kind
+      # @param [Hash] options
+      # @return [Sliding|Elastic|Jumping|All]
+      def self.factory paginator, kind = nil, options = {}
+        if !paginator.is_a?( Main )
+          raise ArgumentError, "paginator argument is not an instance of Main"
+        end
+        
+        case kind.downcase!
+          when "sliding"
+            return DataMapper::Paginator::ControlHelper::Sliding.new paginator, options
+          when "elastic"
+            return DataMapper::Paginator::ControlHelper::Elastic.new paginator, options
+          when "jumping"
+            return DataMapper::Paginator::ControlHelper::Jumping.new paginator, options
+          when "all", kind.empty?
+            return DataMapper::Paginator::ControlHelper::All.new paginator, options
+        end
+      end
+    end
+  end
+end

data/lib/dm-paginator/control/all.rb

@@ -0,0 +1,25 @@
+module DataMapper
+  module Paginator
+    module ControlHelper
+      class All
+        include DataMapper::Paginator::ControlHelperAbstract
+
+        attr_reader :paginator, :options
+
+        def initialize paginator, options = {}
+          if !paginator.is_a?( Main )
+            raise ArgumentError, "paginator argument is not an instance of Main"
+          end
+
+          @paginator = paginator
+          @options = options
+        end
+
+        def pages page_range = nil
+          return unless paginator.page_count > 0
+          return pages_in_range 1, paginator.count
+        end
+      end
+    end
+  end
+end

data/lib/dm-paginator/control/control_helper_abstract.rb

@@ -0,0 +1,48 @@
+module DataMapper
+  module Paginator
+    module ControlHelperAbstract      
+      ##
+      # Get pages using a pagination style.
+      #
+      def pages page_range = nil
+        raise NotImplementedError, "draw method not implemented"
+      end
+
+      ##
+      # Return pages in range.
+      #
+      # @param [Integer] lower
+      # @param [Integer] upper
+      # @return [Array]
+      def pages_in_range lower, upper
+        lower = normalize_page_number lower
+        upper = normalize_page_number upper
+
+        pages = []
+        ( lower ).upto( upper ) do | page_number |
+          pages.push( page_number )
+        end
+
+        pages
+      end
+
+      ##
+      # Normalize page number, brings the page number in range of the
+      # paginator.
+      #
+      # @param [Integer] page_number
+      # @return [Integer]
+      def normalize_page_number page_number
+        if page_number.to_i < 1
+          page_number = 1
+        end
+
+        if paginator.count > 0 && page_number > paginator.count
+          page_number = paginator.count
+        end
+
+        page_number.to_i
+      end
+    end
+  end
+end

data/lib/dm-paginator/control/elastic.rb

@@ -0,0 +1,38 @@
+module DataMapper
+  module Paginator
+    module ControlHelper
+      class Elastic < Sliding
+        include DataMapper::Paginator::ControlHelperAbstract
+
+        attr_reader :paginator, :options
+
+        def initialize paginator, options = {}
+          if !paginator.is_a?( Main )
+            raise ArgumentError, "paginator argument is not an instance of Main"
+          end
+
+          @paginator = paginator
+          @options = options
+          @options[:page_range] = options[:page_range].to_i || DataMapper::Paginator::default[:page_range]
+        end
+
+        def pages page_range = nil
+          return unless paginator.page_count > 0
+
+          page_range = options[:page_range] || page_range
+          page_number = normalize_page_number paginator.page
+          original_page_range = page_range
+          page_range = page_range * 2 - 1
+
+          if original_page_range + page_number - 1 < page_range
+            page_range = original_page_range + page_number -1
+          elsif original_page_range + page_number - 1 > paginator.count
+            page_range = original_page_range + paginator.count - page_number
+          end
+
+          return super( page_range )
+        end
+      end
+    end
+  end
+end

data/lib/dm-paginator/control/jumping.rb

@@ -0,0 +1,40 @@
+module DataMapper
+  module Paginator
+    module ControlHelper
+      class Jumping
+        include DataMapper::Paginator::ControlHelperAbstract
+
+        attr_reader :paginator, :options
+
+        def initialize paginator, options = {}
+          if !paginator.is_a?( Main )
+            raise ArgumentError, "paginator argument is not an instance of Main"
+          end
+
+          @paginator = paginator
+          @options = options
+          @options[:page_range] = options[:page_range].to_i || DataMapper::Paginator::default[:page_range]
+        end
+
+        def pages page_range = nil
+          return unless paginator.page_count > 0
+
+          page_range = options[:page_range] || page_range
+          page_number = paginator.page
+
+          delta = page_number % page_range
+
+          if delta == 0
+            delta = page_range
+          end
+
+          offset = page_number - delta
+          lower = offset + 1
+          upper = offset + page_range
+
+          return pages_in_range lower, upper
+        end
+      end
+    end
+  end
+end

data/lib/dm-paginator/control/sliding.rb

@@ -0,0 +1,48 @@
+module DataMapper
+  module Paginator
+    module ControlHelper
+      class Sliding
+        include DataMapper::Paginator::ControlHelperAbstract
+
+        attr_reader :paginator, :options
+
+        def initialize paginator, options = {}
+          if !paginator.is_a?( Main )
+            raise ArgumentError, "paginator argument is not an instance of Main"
+          end
+
+          @paginator = paginator
+          @options = options
+          @options[:page_range] = options[:page_range].to_i || DataMapper::Paginator::default[:page_range]
+        end
+
+        def pages page_range = nil
+          return unless paginator.page_count > 0
+          
+          page_range = options[:page_range] || page_range
+
+          if page_range > paginator.count
+            page_range = paginator.count
+          end
+
+          delta = ( page_range / 2 ).ceil
+
+          if paginator.page - delta > paginator.count - page_range
+            lower = paginator.count - page_range + 1
+            upper = paginator.count
+          else
+            if paginator.page - delta < 0
+              delta = paginator.page
+            end
+
+            offset = paginator.page - delta
+            lower = offeset + 1
+            upper = offset + page_range
+          end
+
+          return pages_in_range lower, upper
+        end
+      end
+    end
+  end
+end

data/lib/dm-paginator/default.rb

@@ -0,0 +1,14 @@
+module DataMapper
+  module Paginator
+    @default = {
+      :page => 1,
+      :limit => 10,
+      :order => :id.desc,
+      :page_range => 10,
+    }
+
+    def self.default
+      @default
+    end
+  end
+end

data/lib/dm-paginator/main.rb

@@ -0,0 +1,61 @@
+module DataMapper
+  module Paginator
+    ##
+    # Main class, this object handle pagination attributes.
+    #
+    class Main
+      attr_reader :count, :page, :limit, :offset, :page_count, :next_page,
+        :previous_page
+
+      def initialize options = {}
+        @count = options[:count].to_i
+        @page = options[:page].to_i
+        @limit = options[:limit].to_i
+        @offset = options[:offset].to_i
+        @page_count = calculate_page_count
+        @next_page = page.to_i + 1 unless page.to_i + 1 >= page_count
+        @previous_page = page.to_i - 1 unless page.to_i - 1 <= 1
+      end
+
+      ##
+      # Draw pagination controls using a partial (whatever erb file).
+      #
+      # @param [String] kind
+      # @param [String] erb
+      # @param [Hash] options
+      # @return [String]
+      def to_html kind, erb, options = {}
+        if !File.file?( erb )
+          raise IOError, "erb files doesn't exists"
+        end
+
+        template = ERB.new File.read( erb ), 0, "%<>"
+
+        control = DataMapper::Paginator::Control.factory self, kind.to_s, options
+        @pages = control.pages
+        template.result binding
+      end
+
+      ##
+      # Get pages range using a pagination control style.
+      #
+      # @param [String] kind
+      #
+      def pages kind, options = {}
+        control = DataMapper::Paginator::Control.factory self, kind.to_s, options
+        control.pages
+      end
+
+      private
+
+      ##
+      # Calculate how many page.
+      #
+      # @return [Integer]
+      def calculate_page_count
+        @page_count = count.to_i / limit.to_i
+        @page_count.ceil
+      end
+    end
+  end
+end

data/lib/dm-paginator/paginator.rb

@@ -0,0 +1,60 @@
+module DataMapper
+  module Paginator
+    attr_accessor :paginator
+    
+    ##
+    # Limit results.
+    #
+    # @param [Hash] options
+    # @return [Collection]
+    def limit options = {}
+      # Remove this key if we come from limit_page method.
+      page = options.delete :page
+      query = options.dup
+      collection = new_collection scoped_query( options = {
+        :limit => options[:limit],
+        :offset => options[:offset],
+        :order => [options[:order]]
+      }.merge( query ) )
+      options.merge! :count => calculate_total_records( query ), :page => page
+      collection.paginator = DataMapper::Paginator::Main.new options
+      collection
+    end
+
+    ##
+    # Limit results by page.
+    #
+    # @param [Integer, Hash] page
+    # @param [Hash] options
+    # @return [Collection]
+    def limit_page page = nil, options = {}
+      if page.is_a?( Hash )
+        options = page
+      else
+        options[:page] = page.to_i
+      end
+
+      options[:page] = options[:page].to_i > 0 ? options[:page] : DataMapper::Paginator.default[:page]
+      options[:limit] = options[:limit].to_i || DataMapper::Paginator.default[:limit]
+      options[:offset] = options[:limit] * ( options[:page] - 1 )
+      options[:order] = options[:order] || DataMapper::Paginator.default[:order]
+      limit options
+    end
+
+    private
+
+    ##
+    # Calculate total records
+    #
+    # @param [Hash] query
+    # @return [Integer]
+    def calculate_total_records query
+      # Remove those keys from the query
+      query.delete :page
+      query.delete :limit
+      query.delete :offset
+      collection = new_collection scoped_query( query )
+      collection.count.to_i
+    end
+  end
+end

data/lib/dm-paginator/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module Paginator
+    VERSION = "0.2.0"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'dm-paginator'
+
+class Test::Unit::TestCase
+end

data/test/test_dm-paginator.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestDmPaginator < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: dm-paginator
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Juan Felipe Alvarez Saldarriaga
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 1
+        version: 0.10.1
+  type: :development
+  version_requirements: *id001
+description: Simple DataMapper paginator
+email: nebiros@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/dm-paginator.rb
+- lib/dm-paginator/control.rb
+- lib/dm-paginator/control/all.rb
+- lib/dm-paginator/control/control_helper_abstract.rb
+- lib/dm-paginator/control/elastic.rb
+- lib/dm-paginator/control/jumping.rb
+- lib/dm-paginator/control/sliding.rb
+- lib/dm-paginator/default.rb
+- lib/dm-paginator/main.rb
+- lib/dm-paginator/paginator.rb
+- lib/dm-paginator/version.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/nebiros/dm-paginator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple DataMapper paginator
+test_files: 
+- test/helper.rb
+- test/test_dm-paginator.rb
+- examples/paginator.rb