godfat-pagify 0.5.0 → 0.6.1

data/CHANGES

@@ -1,5 +1,16 @@
 = pagify changes history
 
+== pagify 1.0 / ?
+
+== pagify 0.6.1 / 2009-07-30
+ * first rubyforge gem release!
+ * rearranged require call.
+ * use normal form for dir and module name
+ * removed pagify pager cache, it's not useful
+ * added rails helper (i.e. would_pagiante)
+ * fixed that NullPage from pagers other than NullPager,
+   it should always acts as an empty array.
+
 ==
 policy changed. null page was no longer a singleton. see reason below:
 

data/README

@@ -1,5 +1,5 @@
-= pagify 0.5
-by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
+= pagify 0.6.1
+by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
   godfat (XD) godfat.org
 
 == LINKS:
@@ -9,20 +9,30 @@ by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
 
 == DESCRIPTION:
 
- pagination tools for plain Ruby, DataMapper, ActiveRecord, and other ORM.
+ Pagination tools for Array(or custom class), DataMapper and ActiveRecord
 
 == FEATURES:
 
-* aims to be as flexible as possible
-* separate intrusive "pagify" method and Array/DataMapper/ActiveRecord Pager.
-* separate view helpers. there's html helper, yaml helper(planed), xml/rss/atom helper(planed).
+* Aims to be as flexible as possible
+* Separate intrusive "pagify" method and Array/DataMapper/ActiveRecord Pager.
+* Separate view helpers. There's only html helper right now.
 
 == SYNOPSIS:
 
- the easiest (but not recommended) way to use it is:
+ # for fast will_paginate replacement:
+ require 'pagify/active_record'
+ require 'pagify/helper/rails'
 
+ # in controller:
+ @photos = Photo.pagify(:page => params[:page])
+
+ # in view:
+ would_paginate(@photos)
+
+
+
+ # basic DataMapper usage:
  require 'pagify/data_mapper'
- require 'pagify/helpers/html'
 
  class User
    include DataMapper::Resource
@@ -43,17 +53,21 @@ by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
 
  User.get(1).pets.pagify                 # => create a page contains pets owned by user 1
 
+
+
+ # basic html helper usage:
+ require 'pagify/helper/html'
+
  # create a string with page links.
  Pet.pagify.pager.html.links(params[:page]){ |page|
    # the block result would be used as url for each page
    "/pets/list?page=#{page}"
  }
 
- Pagify::Helpers::HTML.setting[:prev_text] = '<]' # globally change html setting
+ Pagify::Helper::HTML.setting[:prev_text] = '<]' # globally change html setting
  # NOTE: if you would like to use instance level setting, you shouldn't use method pagify,
- # NOTE: or use User.pagify_cache = true; and face thread-safety problem.
-
- and the recommended usage is:
+ # NOTE: new your own DataMapperPager or so to remember instance level html setting.
+ # NOTE: for example, see below:
 
  class Pet
  # same as above
@@ -70,8 +84,7 @@ by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
    end
  end
 
- then you would use Pet.page(3) or user.pets.page(2) without encountering
- thread-safety problem or create a whole new pager in each request.
+ # then you would use Pet.page(3) or user.pets.page(2) to retrieve data
 
  # this would create next/prev links only.
  Pet.page(1).html.links_navigate{ |page|
@@ -83,30 +96,31 @@ by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
    "/pets/show?page=#{page}"
  }
 
- and you can build your pager from scratch via BasicPager.
- e.g. BasicPager.new :fetcher => lambda{|*a|[]}, :counter => lambda{0}
- this would be similar to Pagify::NullPager.
+ # and you can build your pager from scratch via BasicPager.
+ # e.g. BasicPager.new :fetcher => lambda{|*a|[]}, :counter => lambda{0}
+ # this would be similar to Pagify::NullPager.
 
- you can disable null page via passing :null_page => false to any pager,
- or set pager.null_page = false; anytime.
+ # you can disable null page via passing :null_page => false to any pager,
+ # or set pager.null_page = false; anytime.
 
- see example or test for more examples (and use case for ActiveRecordPager).
+ # see example or test for more examples (and use case for ActiveRecordPager).
 
 == REQUIREMENTS:
 
+* ruby 1.8+ or 1.9.1
 * for Basic/Array  Pager: only ruby is needed
 * for DataMapper   Pager: dm-core and dm-aggregates 0.9.6 and above
 * for ActiveRecord Pager: activerecord 2.1.1 and above
 
 == INSTALL:
 
-* sudo gem install pagify
+* gem install pagify
 
 == LICENSE:
 
 Apache License 2.0
 
-Copyright (c) 2008, Lin Jen-Shin (a.k.a. godfat 真常)
+Copyright (c) 2008, Lin Jen-Shin (aka godfat 真常)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,48 +1,27 @@
 # encoding: utf-8
 
-begin
-  require 'bones'
-  Bones.setup
-rescue LoadError
-  load 'tasks/setup.rb'   # this line should already be there
-end
+require 'bones'
+Bones.setup
 
 PROJ.name = 'pagify'
-# supress warnings, there's too many warnings in dm-core
-PROJ.ruby_opts.delete '-w'
-
-PROJ.gem.development_dependencies << ['extlib', '<=0.9.8']
-PROJ.gem.development_dependencies << ['dm-core', '<=0.9.7']
-PROJ.gem.development_dependencies << ['dm-aggregates', '<=0.9.7']
+PROJ.authors = 'Lin Jen-Shin (aka godfat 真常)'
+PROJ.email = 'godfat (XD) godfat.org'
+PROJ.url = "http://github.com/godfat/#{PROJ.name}"
+PROJ.rubyforge.name = 'ludy'
 
-PROJ.gem.development_dependencies << ['activerecord', '>=2.0.0']
-PROJ.gem.development_dependencies << ['minitest', '>=1.3.0']
-# PROJ.gem.executables = ["bin/#{PROJ.name}"]
+PROJ.gem.development_dependencies << ['dm-core',       '>=0.9.9'] <<
+                                     ['dm-aggregates', '>=0.9.9'] <<
+                                     ['activerecord',  '>=2.0.0']
 
-task :default do
-  Rake.application.options.show_task_pattern = /./
-  Rake.application.display_tasks_and_comments
-end
-
-namespace :gem do
-  desc "create #{PROJ.name}.gemspec"
-  task 'gemspec' do
-    puts "rake gem:debug > #{PROJ.name}.gemspec"
-    File.open("#{PROJ.name}.gemspec", 'w'){|spec| spec << `rake gem:debug`.sub(/.*/, '')}
-  end
-end
+# supress warnings, there's too many warnings in dm-core
+PROJ.ruby_opts.delete '-w'
 
-PROJ.authors = 'Lin Jen-Shin (a.k.a. godfat 真常)'
-PROJ.email = 'godfat (XD) godfat.org'
-PROJ.url = "http://github.com/godfat/#{PROJ.name}"
 PROJ.description = PROJ.summary = paragraphs_of('README', 'description').join("\n\n")
 PROJ.changes = paragraphs_of('CHANGES', 0..1).join("\n\n")
-PROJ.rubyforge.name = 'ludy'
 PROJ.version = File.read("lib/#{PROJ.name}/version.rb").gsub(/.*VERSION = '(.*)'.*/m, '\1')
 
-PROJ.manifest_file = 'Manifest'
-PROJ.exclude += ['^Manifest$', '^tmp', 'tmp$', '^pkg',
-                 '^\.gitignore$', '^ann-', '\.sqlite3$', '\.db$']
+PROJ.exclude += ['^tmp', 'tmp$', '^pkg', '^\.gitignore$',
+                 '^ann-', '\.sqlite3$', '\.db$']
 
 PROJ.rdoc.remote_dir = PROJ.name
 
@@ -50,8 +29,8 @@ PROJ.readme_file = 'README'
 PROJ.rdoc.main = 'README'
 PROJ.rdoc.exclude += ['Rakefile', '^tasks', '^test']
 PROJ.rdoc.include << '\w+'
-PROJ.rdoc.opts << '--diagram' if !WIN32 and `which dot` =~ %r/\/dot/
-PROJ.rdoc.opts += ['--charset=utf-8', '--inline-source', 
+# PROJ.rdoc.opts << '--diagram' if !Rake::WIN32 and `which dot` =~ %r/\/dot/
+PROJ.rdoc.opts += ['--charset=utf-8', '--inline-source',
                    '--line-numbers', '--promiscuous']
 
 PROJ.spec.opts << '--color'
@@ -60,3 +39,16 @@ PROJ.ann.file = "ann-#{PROJ.name}-#{PROJ.version}"
 PROJ.ann.paragraphs.concat %w[LINKS SYNOPSIS REQUIREMENTS INSTALL LICENSE]
 
 CLEAN.include Dir['**/*.rbc']
+
+task :default do
+  Rake.application.options.show_task_pattern = /./
+  Rake.application.display_tasks_and_comments
+end
+
+namespace :gem do
+  desc "create #{PROJ.name}.gemspec"
+  task 'gemspec' do
+    puts "rake gem:debug > #{PROJ.name}.gemspec"
+    File.open("#{PROJ.name}.gemspec", 'w'){|spec| spec << `rake gem:debug`.sub(/.*/, '')}
+  end
+end

data/TODO

@@ -1,4 +1,12 @@
 = pagify todo list
 
+== current
+* update README for better understanding, in use case
+
+== 1.0+
+* default chinese html setting
+* cooperate with DataMapper::Collection,
+  do user.pets.pagify work???
+  why test work, but not in my app?
+
 * refactor setting!!
-* merb and rails url helper

data/lib/pagify.rb

@@ -5,5 +5,10 @@ module Pagify
   autoload  :ActiveRecordPager, 'pagify/active_record'
 end
 
-require 'pagify/basic'
-require 'pagify/null'
+require 'pagify/pager/basic'
+require 'pagify/page/basic'
+
+require 'singleton'
+
+require 'pagify/pager/null'
+require 'pagify/page/null'

data/lib/pagify/active_record.rb

@@ -1,13 +1,11 @@
 
 # anything for active_record
 
-require 'active_record'
-
 require 'pagify'
-require 'pagify/pagers/details/page_accept_string_or_blank'
+require 'pagify/pager/detail/page_accept_string_or_blank'
 
-require 'pagify/pagers/active_record'
-require 'pagify/pagifiers/active_record'
+require 'pagify/pager/active_record'
+require 'pagify/pagifier/active_record'
 
 require 'pagify/array' # this was needed for active_record...
 

data/lib/pagify/array.rb

@@ -2,5 +2,5 @@
 # anything for array
 
 require 'pagify'
-require 'pagify/pagers/array'
-require 'pagify/pagifiers/array'
+require 'pagify/pager/array'
+require 'pagify/pagifier/array'

data/lib/pagify/data_mapper.rb

@@ -1,16 +1,8 @@
 
 # anything for data_mapper
 
-gem 'extlib', '<=0.9.8'
-gem 'dm-core', '<=0.9.7'
-gem 'dm-aggregates', '<=0.9.7'
-
-require 'dm-core'
-require 'dm-aggregates'
-
 require 'pagify'
-require 'pagify/pagers/details/page_accept_string_or_blank'
-
-require 'pagify/pagers/data_mapper'
-require 'pagify/pagifiers/data_mapper'
+require 'pagify/pager/detail/page_accept_string_or_blank'
 
+require 'pagify/pager/data_mapper'
+require 'pagify/pagifier/data_mapper'

data/lib/pagify/{helpers → helper}/abstract.rb

@@ -1,9 +1,9 @@
 
 module Pagify
-  module Helpers
+  module Helper
     class Abstract
       def self.default_attributes
-        raise NotImplementedError
+        {}
       end
 
       def self.setting
@@ -33,27 +33,26 @@ module Pagify
 
       private
       def caculate_2_parts outer_prev, inner_prev, inner_post, outer_post
-        [ caculate_prev(outer_prev, inner_prev),
-          caculate_post(inner_post, outer_post)  ]
+        [ caculate_part(outer_prev, inner_prev),
+          caculate_part(inner_post, outer_post)  ]
       end
-      def caculate_prev outer_prev, inner_prev
-        # concat outer and inner, remove overlap
-        links_prev = outer_prev + [setting[:ellipsis]] + inner_prev
 
-        # clean up overlap and remove '...' if there's overlap or no pages there
-        links_prev.delete(setting[:ellipsis]) if links_prev.uniq! || links_prev.size == 1
+      # concat outer and inner, remove overlap
+      def caculate_part left, right
+        # don't use ellipsis if there's no spaces between them
+        ellipsis = !left.empty? && (left.last + 1) == right.first ?
+          [] : [setting[:ellipsis]]
 
-        links_prev
-      end
-      def caculate_post inner_post, outer_post
-        # concat outer and inner, remove overlap
-        links_post = inner_post + [setting[:ellipsis]] + outer_post
+        part = left + ellipsis + right
 
-        # clean up overlap and remove '...' if there's overlap or no pages there
-        links_post.delete(setting[:ellipsis]) if links_post.uniq! || links_post.size == 1
+        # clean up overlap and remove '...' if
+        part.delete(setting[:ellipsis]) if
+          part.uniq!     || # there's overlap
+          part.size == 1    # no pages there
 
-        links_post
+        part
       end
+
       def caculate_4_parts page, size
         inner_prev, inner_post = caculate_inner(setting[:inner_links], page, size)
         outer_prev, outer_post = caculate_outer(setting[:outer_links], page, size,
@@ -61,10 +60,26 @@ module Pagify
 
         [outer_prev, inner_prev, inner_post, outer_post]
       end
+
       def caculate_inner limit, page, size
-        [ (1..limit).map{ |i| page_exists?(page - i, size) }.reverse.compact,
-          (1..limit).map{ |i| page_exists?(page + i, size) }.compact          ]
+        prev, post = page - limit, page + limit
+
+        left   = extract_pages(  prev      ... page, size )
+        right  = extract_pages( (page + 1) ..  post, size )
+
+        # adding more right pages if left pages were not enough.
+        right.push(
+          *extract_pages(
+            (post + 1) .. (post + limit - left.size),  size )) if left.size < limit
+
+        # ditto
+        left.unshift(
+          *extract_pages(
+            (prev - limit - right.size) .. (prev - 1), size )) if right.size < limit
+
+        [left, right]
       end
+
       def caculate_outer limit, page, size, inner_prev, inner_post
         # caculate index
         prev_last  = [limit,            (inner_prev.first || 1)   ].min
@@ -80,6 +95,11 @@ module Pagify
 
         [outer_prev, outer_post]
       end
+
+      def extract_pages range, size
+        range.map{ |i| page_exists?(i, size) }.compact
+      end
+
       def page_exists? page, size
         if page >= 1 && page <= size
           page

data/lib/pagify/{helpers/details → helper/detail}/setting.rb

@@ -1,8 +1,8 @@
 
-require 'pagify/helpers/abstract'
+require 'pagify/helper/abstract'
 
 module Pagify
-  module Helpers
+  module Helper
     # TODO: refactor me!!
     class Setting
       def initialize helper, parent = {}
@@ -49,6 +49,6 @@ module Pagify
         {}
       end
 
-    end
-  end
-end
+    end # of Setting
+  end # of Helper
+end # of Pagify

data/lib/pagify/{helpers/details → helper/detail}/setup.rb

@@ -1,6 +1,6 @@
 
 module Pagify
-  module Helpers
+  module Helper
     def self.setup helper_class
       Pagify::BasicPager.module_eval do
         helper_name = helper_class.to_s.downcase[/::?(\w+)$/, 1]

data/lib/pagify/{helpers → helper}/html.rb

@@ -1,13 +1,14 @@
 
-require 'pagify/helpers/abstract'
+require 'pagify/helper/abstract'
 
-require 'pagify/helpers/details/setting'
-require 'pagify/helpers/details/setup'
+require 'pagify/helper/detail/setting'
+require 'pagify/helper/detail/setup'
 
 module Pagify
-  module Helpers
+  module Helper
     class HTML < Abstract
       def self.default_attributes
+        super.merge(
         {  :first_text => '&laquo; First',
             :last_text =>          'Last &raquo;',
             :prev_text => '&lt; Previous',
@@ -16,12 +17,12 @@ module Pagify
           :outer_links => 2,
         #        :step => 3,
           :separator   => ' ',
-          :ellipsis    => '...' }
+          :ellipsis    => '...' })
       end
 
       def links_full page, &block
         page = normalize_page(page)
-        "#{links_navigate(page, &block)}<br />\n#{links(page, &block)}"
+        "#{links_navigate(page, &block)}<br />#{links(page, &block)}"
       end
 
       def links_navigate page
@@ -79,7 +80,7 @@ module Pagify
       def normalize_page page
         pager.__send__(:normalize_page, page)
       end
-    end
+    end # of HTML
     setup HTML
-  end
-end
+  end # of Helper
+end # of Pagify