just_paginate 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/.keeptesting

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in keeptesting.gemspec
+gemspec

data/README.md

@@ -0,0 +1,30 @@
+
+DESCRIPTION:
+===========
+
+just_paginate is a framework-agnostic approach to creating paginated webpages. 
+
+
+TODO
+
+
+
+EXAMPLES:
+======
+
+
+
+INSTALL:
+========
+
+`sudo gem install just_paginate` 
+
+(Or simply stick just_paginate into your Gemfile and use Bundler to pull it down)
+
+
+LICENSE:
+========
+
+just_paginate is free software licensed under the
+[GNU Affero General Public License (AGPL)](http://www.gnu.org/licenses/agpl-3.0.html). just_paginate
+is developed as part of the Gitorious project.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |i|
+  i.test_files = FileList['test/test_*.rb']
+  #i.verbose = true
+end

data/just_paginate.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "just_paginate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "just_paginate"
+  s.version     = JustPaginate::VERSION
+  s.authors     = ["Gitorious AS"]
+  s.email       = ["support@gitorious.org"]
+  s.homepage    = "https://gitorious.org/gitorious/just_paginate"
+  s.summary     = %q{Framework-agnostic support for paginating collections of things, and linking to paginated things in your webpage}
+  s.description = %q{Framework-agnostic support for paginating collections of things, and linking to paginated things in your webpage}
+
+  s.rubyforge_project = "just_paginate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "shoulda"
+  s.add_development_dependency "shoulda-context"  
+end

data/lib/just_paginate.rb

@@ -0,0 +1,92 @@
+require "just_paginate/version"
+require "just_paginate/common"
+
+module JustPaginate
+
+  def self.page_value(page)
+    if page.nil?
+      1
+    else 
+      page.to_i
+    end
+  end
+
+  def self.paginate(curr_page, per_page, total_entry_count,  &selection_strategy)
+    raise "Pagination just supplies index range, expects a selection strategy" if selection_strategy.nil? 
+    total_page_number = total_entry_count / per_page
+    entries = yield(index_range(curr_page, per_page, total_entry_count)) || []    
+    return entries, total_page_number
+  end
+  
+  def self.index_range(curr_page, per_page, total_entry_count)
+    start_index = ((curr_page-1)*per_page)
+    end_index = (start_index+per_page)-1
+    
+    if(start_index>total_entry_count)
+      raise "Pagination is out of bounds, beyond total entry size"
+    end
+    
+    if end_index>total_entry_count
+      end_index=(total_entry_count-1)
+    end
+    
+    Range.new(start_index, end_index)
+  end
+
+  def self.page_navigation(curr_page, total_page_count, &page_link_constructor)   
+    links = page_links(curr_page.to_i, total_page_count, &page_link_constructor)
+    return "<style>.pagelink{font-size: 20px; margin-right: 5px;}</style><center>#{links}</center>"
+  end
+
+  def self.page_links(curr_page, total_page_count, &page_link_constructor)
+    page_labels(curr_page, total_page_count).map do |label|        
+      page_element = ""
+      
+      if label == "..."
+        page_element = "<span class='pagelink'>#{label}</span>"
+      elsif label == "<"
+        page_url = yield(curr_page-1)
+        page_element = "<a class='pagelink' href='#{page_url}'>#{label}</a>"
+      elsif label == ">"
+        page_url = yield(curr_page+1)
+        page_element = "<a class='pagelink' href='#{page_url}'>#{label}</a>"
+      else
+        page_url = yield(label)
+        if label.to_i == curr_page
+          page_element = "<span class='pagelink'>#{label}</span>"
+        else
+          page_element = "<a class='pagelink' href='#{page_url}'>#{label}</a>"
+        end
+      end
+
+    end.join(" ")
+  end
+  
+  def self.page_labels(current, total)
+    max_visible = 10
+    labels = []
+
+    if total <= max_visible
+      1.upto(total).each {|n| labels.push(n.to_s)}
+    else 
+      if current > max_visible
+        labels = ["<", "1", "..."]
+      else
+        current = 1
+      end
+
+      if (current > (total-max_visible))
+        current = (total-max_visible)+1
+      end
+
+      current.upto(current+(max_visible-1)).each {|n| labels.push(n.to_s)}
+
+      if (current <= (total-max_visible))
+        labels.concat ["...", "#{total}", ">"]
+      end 
+    end
+
+    return labels
+  end  
+  
+end

data/lib/just_paginate/common.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+module Keeptesting
+    
+
+end

data/lib/just_paginate/version.rb

@@ -0,0 +1,3 @@
+module JustPaginate
+  VERSION = "0.0.1"
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'test/unit'
+require 'shoulda'
+require 'shoulda-context'
+
+require File.dirname(__FILE__) + '/../lib/just_paginate'

data/test/test_just_paginate.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class JustPaginateTest < Test::Unit::TestCase
+  
+  context "The backend pagination function" do    
+    should "basically work like this" do
+      paged_collection = [1,2,3,4,5,6,7,8,9,10]
+
+      entries, page_count = JustPaginate.paginate(1, 5, 100) do |index_range|
+        paged_collection.slice(index_range)
+      end
+
+      assert_equal 5, entries.size
+      assert_equal 20, page_count
+      assert_equal [1,2,3,4,5], entries
+    end
+
+    should "blow up if no selection strategy block is present" do
+      assert_raises RuntimeError do
+        JustPaginate.paginate(1, 20, 100)
+      end
+    end
+
+    should "complain if given page extends past collection bounds" do
+      assert_raises RuntimeError do
+        JustPaginate.index_range(7,2,4)
+      end
+    end
+    
+    should "correctly apply the supplied selection strategy" do
+      ran = false
+      sliced_entries, page_count = JustPaginate.paginate(1, 5, 10) do |index_range|
+        assert index_range.class == Range
+        assert_equal 0..4, index_range
+        ran = true
+      end
+      assert ran, "selection block didn't run"
+    end
+    
+    should "calculate correct index ranges" do
+      assert_equal 0..1, JustPaginate.index_range(1,2,4)
+      assert_equal 2..3, JustPaginate.index_range(2,2,4)
+
+      assert_equal 0..2, JustPaginate.index_range(1,3,9)
+      assert_equal 3..5, JustPaginate.index_range(2,3,9)
+      assert_equal 6..8, JustPaginate.index_range(3,3,9)
+
+      assert_equal 0..2, JustPaginate.index_range(1,3,9)
+      assert_equal 3..5, JustPaginate.index_range(2,3,9)
+      assert_equal 6..8, JustPaginate.index_range(3,3,9)
+
+      assert_equal 0..19, JustPaginate.index_range(1,20,100)
+      assert_equal 60..79, JustPaginate.index_range(4,20,100)
+      assert_equal 60..79, JustPaginate.index_range(4,20,95)
+      assert_equal 80..99, JustPaginate.index_range(5,20,100)
+      assert_equal 80..94, JustPaginate.index_range(5,20,95)
+    end
+  end
+  
+  context "The frontend pagination html helper" do
+    should "basically work like this" do
+      generated = JustPaginate.page_navigation(1, 10) { |page_no| "/projects/index?page=#{page_no}" }
+      # TODO write this and following tests after I've manually browser-reload-iterated something stable'
+    end
+
+    should "do page nav labels, truncation and quicklinks correctly" do
+      assert_correct_paging_labels "1 2 3 4 5 6 7 8 9 10", 1, 10
+
+      assert_correct_paging_labels "1 2 3 4 5 6 7 8 9 10 ... 50 >", 1, 50
+      assert_correct_paging_labels "1 2 3 4 5 6 7 8 9 10 ... 50 >", 5, 50
+      assert_correct_paging_labels "1 2 3 4 5 6 7 8 9 10 ... 50 >", 10, 50
+      assert_correct_paging_labels "1 2 3 4 5 6 7 8 9 10 ... 545 >", 1, 545
+
+      assert_correct_paging_labels "< 1 ... 11 12 13 14 15 16 17 18 19 20 ... 50 >", 11, 50
+      assert_correct_paging_labels "< 1 ... 12 13 14 15 16 17 18 19 20 21 ... 50 >", 12, 50
+      assert_correct_paging_labels "< 1 ... 21 22 23 24 25 26 27 28 29 30 ... 50 >", 21, 50
+      assert_correct_paging_labels "< 1 ... 40 41 42 43 44 45 46 47 48 49 ... 50 >", 40, 50
+
+      assert_correct_paging_labels "< 1 ... 41 42 43 44 45 46 47 48 49 50", 41, 50
+      assert_correct_paging_labels "< 1 ... 41 42 43 44 45 46 47 48 49 50", 45, 50
+      assert_correct_paging_labels "< 1 ... 41 42 43 44 45 46 47 48 49 50", 50, 50
+    end
+  end
+
+  def assert_correct_paging_labels(expected_joined, page, total)
+    p = JustPaginate
+    actual = p.page_labels(page, total).join(" ")
+    assert_equal expected_joined, actual, "labels didn't match expected paging labels'"
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: just_paginate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gitorious AS
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &22415940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22415940
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &22415460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22415460
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: &22415020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22415020
+description: Framework-agnostic support for paginating collections of things, and
+  linking to paginated things in your webpage
+email:
+- support@gitorious.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- just_paginate.gemspec
+- lib/just_paginate.rb
+- lib/just_paginate/common.rb
+- lib/just_paginate/version.rb
+- test/test_helper.rb
+- test/test_just_paginate.rb
+homepage: https://gitorious.org/gitorious/just_paginate
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: just_paginate
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Framework-agnostic support for paginating collections of things, and linking
+  to paginated things in your webpage
+test_files: []