heedley-merb-pagination 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-08-19
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2008 Lori Holden
+
+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/Manifest.txt

@@ -0,0 +1,22 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/merb-pagination.rb
+lib/merb-pagination/hash.rb
+lib/merb-pagination/pagination_helper.rb
+lib/merb-pagination/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_merb-pagination.rb
+merb-pagination.gemspec

data/README.txt

@@ -0,0 +1,34 @@
+= merb_pagination
+
+* http://merb-pagination.rubyforge.org
+
+== DESCRIPTION:
+
+A pagination helper for merb. Useful with dm-is-paginated
+
+See the website for more details.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Lori Holden
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,72 @@
+require 'merb-pagination/version'
+
+AUTHOR = 'Lori Holden'
+EMAIL = "email+gem@loriholden.com"
+DESCRIPTION = "A pagination helper for merb"
+GEM_NAME = 'merb-pagination'
+RUBYFORGE_PROJECT = 'merb-pagination'
+HOMEPATH = "http://merb-pagination.rubyforge.org/"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['merb-core', '>= 0.9.4'],
+  ['builder', '>= 2.0.0']
+]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "lholden"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+VERS = MerbPagination::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'merb_pagination documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/merb-pagination.rb

@@ -0,0 +1,14 @@
+# Needed to import merb and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'merb-core', '>=0.9.4'
+require 'merb-core'
+
+# Require plugin-files
+dir = Pathname(__FILE__).dirname.expand_path / 'merb-pagination'
+require dir / "hash"
+require dir / 'pagination_helper'
+
+Merb::Controller.send(:include, Merb::PaginationHelper)

data/lib/merb-pagination/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  def reverse_merge(other_hash)
+    other_hash.merge(self)
+  end
+  def reverse_merge!(other_hash)
+    replace(reverse_merge(other_hash))
+  end
+end

data/lib/merb-pagination/pagination_helper.rb

@@ -0,0 +1,206 @@
+require 'builder'
+module Merb
+  module PaginationHelper
+    # paginate + some route parameters to generate more complex routes that
+    # let me avoid loathsome querystrings ;)
+    def paginate_with_route(current_page, page_count, route_name, params_for_route = {}, options = {})
+      options.reverse_merge!({
+        :class           => 'paginated',
+        :prev_label      => '« Previous ',
+        :next_label      => ' Next »',
+        :left_cut_label  => '←',
+        :right_cut_label => '→',
+        :outer_window    => 2,
+        :inner_window    => 10,
+        :default_css     => true,
+        :page_param      => 'page'
+      })
+
+      pages = { 
+        :all => (1 .. page_count).to_a, 
+        :left => [], 
+        :center => [], 
+        :right => [] 
+      }
+      
+      # Only worry about using our 'windows' if the page count is less then 
+      # our windows combined.
+      if options[:inner_window].nil? or ((options[:outer_window] *2) + options[:inner_window] + 2) >= page_count
+        pages[:center] = pages[:all]
+      else
+        pages[:left] = pages[:all][0, options[:outer_window]]
+        pages[:right] = pages[:all][page_count - options[:outer_window], options[:outer_window]]
+        pages[:center] = case current_page
+        # allow the inner 'window' to shift to right when close to the left edge
+        # Ex: 1 2 [3] 4 5 6 7 8 9 ... 20
+        when -infinity .. (options[:inner_window] / 2) +3
+          pages[:all][options[:outer_window], options[:inner_window]] + 
+            [options[:right_cut_label]]
+        # allow the inner 'window' to shift left when close to the right edge
+        # Ex: 1 2 ... 12 13 14 15 16 [17] 18 19 20
+        when (page_count - (options[:inner_window] / 2.0).ceil) -1 .. infinity
+          [options[:left_cut_label]] +
+            pages[:all][page_count - options[:inner_window] - options[:outer_window], options[:inner_window]]
+        # Display the unshifed window
+        # ex: 1 2 ... 5 6 7 [8] 9 10 11 ... 19 20
+        else
+          [options[:left_cut_label]] + 
+            pages[:all][current_page - (options[:inner_window] / 2) -1, options[:inner_window]] +
+            [options[:right_cut_label]]
+        end
+      end
+      
+      Builder::XmlMarkup.new.div(:class => options[:class]) do |b|
+        b.style {|s| s << %Q{
+          div.#{options[:class]} ul, div.#{options[:class]} ul li {
+            display: inline;
+            padding: 2px;
+          }  
+        } } if options[:default_css]
+        b << (current_page <= 1 ? options[:prev_label] : link_to(options[:prev_label],url(route_name, params_for_route.merge(:page => current_page - 1))) )
+        
+        b.ul do
+          [pages[:left], pages[:center], pages[:right]].each do |p|
+            p.each do |page_number|
+              case page_number
+              when String
+                b.li(:class=>'more_marker') {|li| li << page_number}
+              when current_page
+                b.li(page_number, :class=>'current_page')
+              else
+                b.li { b.a(page_number, :href=> url(route_name, params_for_route.merge(:page => page_number))  ) }
+              end
+            end
+          end
+        end
+        b << (current_page >= page_count ? options[:next_label] : link_to(options[:next_label],url(route_name, params_for_route.merge(:page => current_page + 1))) )
+      end
+    end
+    
+    # Given a page count and the current page, we generate a set of pagination
+    # links.
+    # 
+    # * We use an inner and outer window into a list of links. For a set of 
+    # 20 pages with the current page being 10:
+    # outer_window:
+    #   1 2  ..... 19 20
+    # inner_window
+    #   5 6 7 8 9 10 11 12 13 14
+    #
+    # This is totally adjustable, or can be turned off by giving the 
+    # :inner_window setting a value of nil.
+    #
+    # * Options
+    # :class => <em>css_class</em::
+    #    The CSS class to be given to the paginator div.
+    #    Defaults to 'paginated'
+    # :prev_label => <em>text_for_previous_link</em>::
+    #    Defaults to '&laquo; Previous '
+    # :next_labe => <em>text_for_next_link</em>::
+    #    Defaults to ' Next &raquo;'
+    # :left_cut_label => <em>text_for_cut</em>::
+    #    Used when the page numbers need to be cut off to prevent the set of
+    #    pagination links from being too long.
+    #    Defaults to '&larr;'
+    # :right_cut_label => <em>text_for_cut</em>::
+    #    Same as :left_cut_label but for the right side of numbers.
+    #    Defaults to '&rarr;'
+    # :outer_window => <em>number_of_pages</em>::
+    #    Sets the number of pages to include in the outer 'window'
+    #    Defaults to 2
+    # :inner_window => <em>number_of_pages</em>::
+    #    Sets the number of pags to include in the inner 'window'
+    #    Defaults to 10
+    # :default_css => <em>use_paginator_provided_css</em>
+    #    Use the default CSS provided by the paginator. If you want to do
+    #    your own custom styling of the paginator from scratch, set this to 
+    #    false.
+    #    Defaults to true
+    # :page_param => <em>name_of_page_paramiter</em>
+    #    Sets the name of the paramiter the paginator uses to return what
+    #    page is being requested.
+    #    Defaults to 'page'
+    # :url => <em>url_for_links</em>
+    #    Provides the base url to use in the page navigation links.
+    #    Defaults to ''
+    def paginate(current_page, page_count, options = {})
+      options.reverse_merge!({
+        :class           => 'paginated',
+        :prev_label      => '&laquo; Previous ',
+        :next_label      => ' Next &raquo;',
+        :left_cut_label  => '&larr;',
+        :right_cut_label => '&rarr;',
+        :outer_window    => 2,
+        :inner_window    => 10,
+        :default_css     => true,
+        :page_param      => 'page',
+        :url             => ''
+      })
+      url = options.delete :url
+      url << (url.include?('?') ? '&' : '?') << options[:page_param]
+      
+      pages = { 
+        :all => (1 .. page_count).to_a, 
+        :left => [], 
+        :center => [], 
+        :right => [] 
+      }
+      
+      # Only worry about using our 'windows' if the page count is less then 
+      # our windows combined.
+      if options[:inner_window].nil? or ((options[:outer_window] *2) + options[:inner_window] + 2) >= page_count
+        pages[:center] = pages[:all]
+      else
+        pages[:left] = pages[:all][0, options[:outer_window]]
+        pages[:right] = pages[:all][page_count - options[:outer_window], options[:outer_window]]
+        pages[:center] = case current_page
+        # allow the inner 'window' to shift to right when close to the left edge
+        # Ex: 1 2 [3] 4 5 6 7 8 9 ... 20
+        when -infinity .. (options[:inner_window] / 2) +3
+          pages[:all][options[:outer_window], options[:inner_window]] + 
+            [options[:right_cut_label]]
+        # allow the inner 'window' to shift left when close to the right edge
+        # Ex: 1 2 ... 12 13 14 15 16 [17] 18 19 20
+        when (page_count - (options[:inner_window] / 2.0).ceil) -1 .. infinity
+          [options[:left_cut_label]] +
+            pages[:all][page_count - options[:inner_window] - options[:outer_window], options[:inner_window]]
+        # Display the unshifed window
+        # ex: 1 2 ... 5 6 7 [8] 9 10 11 ... 19 20
+        else
+          [options[:left_cut_label]] + 
+            pages[:all][current_page - (options[:inner_window] / 2) -1, options[:inner_window]] +
+            [options[:right_cut_label]]
+        end
+      end
+      
+      Builder::XmlMarkup.new.div(:class => options[:class]) do |b|
+        b.style {|s| s << %Q{
+          div.#{options[:class]} ul, div.#{options[:class]} ul li {
+            display: inline;
+            padding: 2px;
+          }  
+        } } if options[:default_css]
+        b << (current_page <= 1 ? options[:prev_label] : %Q{<a href="#{url}=#{current_page -1}">#{options[:prev_label]}</a>})
+        
+        b.ul do
+          [pages[:left], pages[:center], pages[:right]].each do |p|
+            p.each do |page_number|
+              case page_number
+              when String
+                b.li(:class=>'more_marker') {|li| li << page_number}
+              when current_page
+                b.li(page_number, :class=>'current_page')
+              else
+                b.li { b.a(page_number, :href=>"#{url}=#{page_number}") }
+              end
+            end
+          end
+        end
+        
+        b << (current_page >= page_count ? options[:next_label] : %Q{<a href="#{url}=#{current_page +1}">#{options[:next_label]}</a>})
+      end
+    end
+    private
+      def infinity; 1.0/0; end
+  end
+end

data/lib/merb-pagination/version.rb

@@ -0,0 +1,9 @@
+module MerbPagination
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/merb-pagination.gemspec

@@ -0,0 +1,46 @@
+Gem::Specification.new do |s|
+  s.name     = %q{merb-pagination}
+  s.version  = "0.0.1"
+  s.date     = %q{2008-12-10}
+  s.summary  = %q{A pagination helper for merb. Useful with dm-is-paginated}
+  s.email    = "hedley.robertson@gmail.com"
+  s.homepage = %q{http://github.com/heedley/merb-pagination/tree/master}
+  s.require_paths = ["lib"]
+  s.description = %q{fork of lholden's merb-pagination}
+  s.has_rdoc = true
+  s.authors  = ["Lori Holden", "Hedley Robertson"]
+  
+  
+  s.files    = ["History.txt",
+                "License.txt",
+                "Manifest.txt",
+                "README.txt",
+                "Rakefile",
+                "config/hoe.rb",
+                "config/requirements.rb",
+                "lib/merb-pagination.rb",
+                "lib/merb-pagination/hash.rb",
+                "lib/merb-pagination/pagination_helper.rb",
+                "lib/merb-pagination/version.rb",
+                "script/console",
+                "script/destroy",
+                "script/generate",
+                "script/txt2html",
+                "setup.rb",
+                "tasks/deployment.rake",
+                "tasks/environment.rake",
+                "tasks/website.rake",
+                "test/test_helper.rb",
+                "test/test_merb-pagination.rb",
+                "merb-pagination.gemspec"]
+  
+  s.test_files = ["test/test_merb-pagination.rb"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency(%q<merb-core>, [">= 0.9"])
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+  end
+end
+