just_paginate 0.0.1 → 0.0.2

data/README.md

@@ -2,16 +2,50 @@
 DESCRIPTION:
 ===========
 
-just_paginate is a framework-agnostic approach to creating paginated webpages. 
+just_paginate is a framework-agnostic approach to creating paginated
+webpages. It has no external dependencies and works with any web
+framework.
 
+Consists of two main methods, paginate and page_navigation. 
 
-TODO
+JustPaginate.paginate helps you slice up your collections and, given a
+page number, entities per page and totoal entity count, gives you the
+correct range of indexes you need to get. You supply a block where you
+specify how elements with those indices are to be gathered. Your block
+needs to return those elements. The JustPaginate method then returns
+the objects that you sliced in your block, as well as the total number
+of pages in the pagination.
 
+JustPaginate.page_navigation generates html for a page-navigator
+widget that will let you navigate arbitrarily large page ranges: if
+the range is larger than what can be displayed, it truncates the range
+of pages. You supply it with current page number, and total number of
+pages. You pass in a block which, given the page number, will let you
+construct a html link to that page number.
+
+Note: There is also a JustPaginate.page_value helper method that will
+take an arbitrary object, and try to translate it to a (default) page
+number. If you are using Rails you can simply pass the param
+specifying current page and JustPaginate will do its best to translate
+it to a page number integer.
 
 
 EXAMPLES:
 ======
 
+Say we have a Rails app, with an index page of paginated Projects. You
+could do this in the controller, to select the 20 projects for the
+current page:
+
+    @page = JustPaginate.page_value(params[:page])
+    @project_count = Project.count
+    @projects, @total_pages = JustPaginate.paginate(@page, 20, @project_count) do |index_range|
+      Project.all.slice(index_range)
+    end
+
+And in the index.html.erb file, to generate the page navigation:
+
+    <%= JustPaginate.page_navigation(@page, @total_pages) { |page_no| "/projects/?page=#{page_no}" } -%>
 
 
 INSTALL:
@@ -19,7 +53,8 @@ INSTALL:
 
 `sudo gem install just_paginate` 
 
-(Or simply stick just_paginate into your Gemfile and use Bundler to pull it down)
+Or simply stick just_paginate into your Gemfile and use Bundler to
+pull it down.
 
 
 LICENSE:

data/just_paginate.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "just_paginate/version"
+require "just_paginate"
 
 Gem::Specification.new do |s|
   s.name        = "just_paginate"

data/lib/just_paginate.rb

@@ -1,8 +1,7 @@
-require "just_paginate/version"
-require "just_paginate/common"
-
 module JustPaginate
 
+  VERSION = "0.0.2"
+
   def self.page_value(page)
     if page.nil?
       1
@@ -39,7 +38,7 @@ module JustPaginate
   end
 
   def self.page_links(curr_page, total_page_count, &page_link_constructor)
-    page_labels(curr_page, total_page_count).map do |label|        
+    page_labels(curr_page, total_page_count).map do |label|
       page_element = ""
       
       if label == "..."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: just_paginate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-10-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &22415940 !ruby/object:Gem::Requirement
+  requirement: &19779880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22415940
+  version_requirements: *19779880
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &22415460 !ruby/object:Gem::Requirement
+  requirement: &19779240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22415460
+  version_requirements: *19779240
 - !ruby/object:Gem::Dependency
   name: shoulda-context
-  requirement: &22415020 !ruby/object:Gem::Requirement
+  requirement: &19778580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *22415020
+  version_requirements: *19778580
 description: Framework-agnostic support for paginating collections of things, and
   linking to paginated things in your webpage
 email:
@@ -58,8 +58,6 @@ files:
 - 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

data/lib/just_paginate/common.rb

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

data/lib/just_paginate/version.rb

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