godfat-pagify 0.5.0

data/CHANGES

@@ -0,0 +1,31 @@
+= pagify changes history
+
+==
+policy changed. null page was no longer a singleton. see reason below:
+
+  i encountered a strange problem, where:
+    
+    pager[10].pager.per_page != pager[1].pager.per_page
+  
+  because BasicPage#pager would refer to original pager,
+  while NullPage#pager would always refer to NullPager's singleton.
+
+  i think i should have not made NullPage be a singleton,
+  because we got have some way to keep page.pager.per_page
+  consist to the value we original setup. then we could write
+  something like this:
+
+    (0...page.pager.per_page).each{ ... }
+
+  that is, we don't have to keep pager around, and if you have
+  page, then you have pager. so now that NullPage was no longer
+  a singleton, and null_page.pager would return the original pager.
+
+  keep NullPager being a singleton though, and it should always
+  return the same page which refer the singleton null pager.
+
+== pagify 0.5 / 2008-10-11
+
+* 1 major enhancement
+  * Birthday!
+  * extracted from Ludy::Paginator!

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/NOTICE

@@ -0,0 +1,5 @@
+= notice for other stuffs
+
+* this project skeleton is built through Mr Bones 2.1.0:
+    gem install bones
+    http://codeforpeople.rubyforge.org/bones/

data/README

@@ -0,0 +1,121 @@
+= pagify 0.5
+by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
+  godfat (XD) godfat.org
+
+== LINKS:
+
+* github-project[http://github.com/godfat/pagify]
+* rubyforge-project[http://rubyforge.org/projects/ludy]
+
+== DESCRIPTION:
+
+ pagination tools for plain Ruby, DataMapper, ActiveRecord, and other ORM.
+
+== 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).
+
+== SYNOPSIS:
+
+ the easiest (but not recommended) way to use it is:
+
+ require 'pagify/data_mapper'
+ require 'pagify/helpers/html'
+
+ class User
+   include DataMapper::Resource
+   property :id, Serial
+   property :name, String
+   has n, :pets
+ end
+
+ class Pet
+   include DataMapper::Resource
+   property :id, Serial
+   property :name, String
+   belongs_to :user
+ end
+
+ User.pagify :page => 1, :per_page => 10 # => create a page contains users
+ User.all(:name => 'godfat').pagify      # => create a page contains users named godfat
+
+ User.get(1).pets.pagify                 # => create a page contains pets owned by user 1
+
+ # 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
+ # 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:
+
+ class Pet
+ # same as above
+   def self.page num
+     @pager ||= begin
+       pager = Pagify::DataMapperPager.new(:per_page => 20)
+       # below would be pager instance level setting
+       # you can setup global setting mentioned above in your init script perhaps
+       pager.html.setting[:separator] = ' . '
+       pager.html.setting[:ellipsis]  = '...'
+       pager
+     end
+     @pager.page(num)
+   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.
+
+ # this would create next/prev links only.
+ Pet.page(1).html.links_navigate{ |page|
+   "/pets/list?page=#{page}"
+ }
+
+ # this would create next/prev links and other page links
+ pet_pager.page(1).html.links_full{ |page|
+   "/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.
+
+ 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).
+
+== REQUIREMENTS:
+
+* 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
+
+== LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2008, Lin Jen-Shin (a.k.a. godfat 真常)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  load 'tasks/setup.rb'   # this line should already be there
+end
+
+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.gem.development_dependencies << ['activerecord', '>=2.0.0']
+PROJ.gem.development_dependencies << ['minitest', '>=1.3.0']
+# PROJ.gem.executables = ["bin/#{PROJ.name}"]
+
+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
+
+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.rdoc.remote_dir = PROJ.name
+
+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', 
+                   '--line-numbers', '--promiscuous']
+
+PROJ.spec.opts << '--color'
+
+PROJ.ann.file = "ann-#{PROJ.name}-#{PROJ.version}"
+PROJ.ann.paragraphs.concat %w[LINKS SYNOPSIS REQUIREMENTS INSTALL LICENSE]
+
+CLEAN.include Dir['**/*.rbc']

data/TODO

@@ -0,0 +1,4 @@
+= pagify todo list
+
+* refactor setting!!
+* merb and rails url helper

data/lib/pagify.rb

@@ -0,0 +1,9 @@
+
+module Pagify
+  autoload         :ArrayPager, 'pagify/array'
+  autoload    :DataMapperPager, 'pagify/data_mapper'
+  autoload  :ActiveRecordPager, 'pagify/active_record'
+end
+
+require 'pagify/basic'
+require 'pagify/null'

data/lib/pagify/active_record.rb

@@ -0,0 +1,19 @@
+
+# anything for active_record
+
+require 'active_record'
+
+require 'pagify'
+require 'pagify/pagers/details/page_accept_string_or_blank'
+
+require 'pagify/pagers/active_record'
+require 'pagify/pagifiers/active_record'
+
+require 'pagify/array' # this was needed for active_record...
+
+# workaround for active_record...
+module Pagify
+  class ArrayPager < BasicPager
+    include PageAcceptStringOrBlank
+  end
+end