pagify 0.7.1 → 0.8.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+*.rbc

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "task"]
+	path = task
+	url = git://github.com/godfat/gemgem.git

data/CHANGES.md

@@ -0,0 +1,78 @@
+# CHANGES
+
+## pagify 0.8.0 / 2011-11-16
+
+Adopt changes from @agios
+
+* Setting `setting[:first_text]` to `nil` would make pagify
+  use page number as the first_text. The same goes to
+  `setting[:last_text]`
+
+* Added a `<span class="pagination_active">` wrapper for active
+  page. You can change the class by changing `setting[:active_class]`
+
+* Now links would by default contain `class="pagination_inactive"`.
+  You can also change the class name by changing `setting[:inactive_class]`
+  Set it to `nil` would disable this.
+
+* Fixed a deprecation warning on activerecord 3.1.1
+
+## pagify 0.7.1 / 2010-04-26
+
+* fix the problem that RUBY_VERSION is forzen,
+  just use lexical string comparsion then.
+
+## pagify 0.7.0 / 2009-11-16
+
+* added innate helper.
+* some internal refactoring
+
+## pagify 0.6.2 / 2009-08-08
+
+* no joke now, use pagify_links instead of would_paginate.
+* now you can define your own pagify_links and call super
+  in ApplicationHelper.
+* added a links_type option for rails helper,
+  telling which html helper method you would like.
+  default to HTML#links_full
+
+## 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:
+
+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/CONTRIBUTORS

@@ -0,0 +1,2 @@
+Lin Jen-Shin (godfat)
+agios (agios)

data/Gemfile

@@ -0,0 +1,14 @@
+
+source 'http://rubygems.org'
+
+gemspec
+
+# datamapper
+gem 'dm-core'
+gem 'dm-aggregates'
+gem 'dm-migrations'
+gem 'dm-sqlite-adapter'
+
+# rails
+gem 'activerecord'
+gem 'sqlite3'

data/README.md

@@ -0,0 +1,157 @@
+# pagify
+
+by Lin Jen-Shin ([godfat](http://godfat.org))
+
+## LINKS:
+
+* [github](https://github.com/godfat/pagify)
+* [rubygems](https://rubygems.org/gems/pagify)
+* [rdoc](http://rdoc.info/github/godfat/pagify)
+
+## DESCRIPTION:
+
+Pagination tools for Array(or custom class), DataMapper and ActiveRecord.
+Helpers for Innate/Ramaze and Rails included.
+
+## REQUIREMENTS:
+
+* Ruby 1.8+ or 1.9.1+
+* For  Basic/ArrayPager: only Ruby is needed
+* For   DataMapperPager: dm-core and dm-aggregates 1.2+
+* for ActiveRecordPager: activerecord 2.3.14+ or activerecord 3.1+
+* for     Innate helper: innate 2011.10+
+
+## INSTALLATION:
+
+    gem install pagify
+
+## FEATURES:
+
+* 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.
+* Web framework specific helper included. Currently for Innate/Ramaze and Rails.
+
+## SYNOPSIS:
+
+For fast Rails will_paginate replacement:
+
+    require 'pagify/active_record'
+    require 'pagify/helper/rails'
+
+in controller:
+
+    @photos = Photo.pagify(:page => params[:page])
+
+in view:
+
+    pagify_links(@photos)
+
+For Innate/Ramaze:
+
+    require 'pagify'
+    require 'pagify/helper/innate'
+
+in controller, say you want pagify helper:
+
+    class Controller < Ramaze::Controller
+      helper :pagify
+    end
+
+for the data part, see `DataMapperPager` or `ActiveRecordPager` in view,
+same as in Rails.
+
+Basic DataMapper usage:
+
+    require 'pagify/data_mapper'
+
+    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
+
+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::Helper::HTML.setting[:prev_text] = '<]' # globally change html setting
+
+If you would like to use instance level setting, you shouldn't use method
+pagify, new your own DataMapperPager or so to remember instance level html
+setting. for example, see below:
+
+    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)` to retrieve data.
+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`).
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2008-2011, Lin Jen-Shin (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

@@ -1,37 +1,19 @@
 # encoding: utf-8
 
-begin
-  require 'bones'
-rescue LoadError
-  abort '### Please install the "bones" gem ###'
-end
-
-ensure_in_path 'lib'
-proj = 'pagify'
-require "#{proj}/version"
-
-Bones{
-  version Pagify::VERSION
-
-  ruby_opts [''] # silence warning, too many in addressable and/or dm-core
-  depend_on 'dm-core',       :development => true, :version => '>=0.10.1'
-  depend_on 'dm-aggregates', :development => true, :version => '>=0.10.1'
-  depend_on 'activerecord',  :development => true, :version => '>=2.3.4'
+require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+Gemgem.dir = dir
 
-  name    proj
-  url     "http://github.com/godfat/#{proj}"
-  authors 'Lin Jen-Shin (aka godfat 真常)'
-  email   'godfat (XD) godfat.org'
+($LOAD_PATH << File.expand_path("#{Gemgem.dir}/lib")).uniq!
 
-  history_file   'CHANGES'
-   readme_file   'README'
-   ignore_file   '.gitignore'
-  rdoc.include   ['\w+']
-}
+desc 'Generate gemspec'
+task 'gem:spec' do
+  Gemgem.spec = Gemgem.create do |s|
+    require 'pagify/version'
+    s.name    = 'pagify'
+    s.version = Pagify::VERSION
 
-CLEAN.include Dir['**/*.rbc']
+    %w[].each{ |g| s.add_runtime_dependency(g) }
+  end
 
-task :default do
-  Rake.application.options.show_task_pattern = /./
-  Rake.application.display_tasks_and_comments
+  Gemgem.write
 end

data/{TODO → TODO.md}

@@ -1,10 +1,12 @@
-= pagify todo list
+# TODO
+
+## 1.0-
 
-== 1.0-
 * more docs
 * remove would_paginate
 
-== 1.0+
+## 1.0+
+
 * default chinese html setting
 * cooperate with DataMapper::Collection,
   do user.pets.pagify work???

data/lib/pagify/helper/detail/setting.rb

@@ -12,7 +12,7 @@ module Pagify
       end
 
       def [] key
-        if @attributes[key]
+        if @attributes.key?(key)
            @attributes[key]
         else
           @parent[key]

data/lib/pagify/helper/html.rb

@@ -20,12 +20,14 @@ module Pagify
           :ellipsis    => '...',
           :query_name  => :page,
           :links_type  => :links_full,
-          :wrapper_class => 'pagination' })
+          :inactive_class => 'pagination_inactive',
+          :active_class   => 'pagination_active',
+          :wrapper_class  => 'pagination' })
       end
 
       def links_full page, &block
         page = normalize_page(page)
-        "#{links_navigate(page, &block)}<br />#{links(page, &block)}"
+        "#{links_navigate(page, &block)}<br/>#{links(page, &block)}"
       end
 
       def links_navigate page
@@ -51,21 +53,22 @@ module Pagify
       def links page
         page = normalize_page(page)
         size = pager.size
-        attrs = extract_html_attributes
+        a    = extract_html_attributes
 
         prepare_links(page).map{ |i|
           if i == page
             case page
-              when 1;    setting[:first_text]
-              when size; setting[ :last_text]
-              else;      page
+              when 1   ; wrap_active(setting[:first_text] || i)
+              when size; wrap_active(setting[ :last_text] || i)
+              else     ; wrap_active(i)
             end
           else
             case i
-              when 1;      "<a href=\"#{yield(i)}\"#{attrs}>#{setting[:first_text]}</a>"
-              when size;   "<a href=\"#{yield(i)}\"#{attrs}>#{setting[ :last_text]}</a>"
-              when Fixnum; "<a href=\"#{yield(i)}\"#{attrs}>#{i}</a>"
-              else;        i.to_s
+              when 1   ; wrap_inactive(setting[:first_text] || i, a){yield(i)}
+              when size; wrap_inactive(setting[ :last_text] || i, a){yield(i)}
+              when Fixnum
+                         wrap_inactive(i, a){yield(i)}
+              else     ; i.to_s
             end
           end
         }.join(setting[:separator])
@@ -73,7 +76,9 @@ module Pagify
 
       private
       def extract_html_attributes
-        attrs = setting.additional_attributes.
+        attrs = {:class => setting[:inactive_class]}.
+                  merge(setting.additional_attributes).
+                  select{ |_, value| value }.
                   map{ |key, value| "#{key}=\"#{value}\"" }.join(' ')
 
         attrs = ' ' + attrs if attrs != ''
@@ -83,6 +88,14 @@ module Pagify
       def normalize_page page
         pager.__send__(:normalize_page, page)
       end
+
+      def wrap_active label
+        %Q{<span class="#{setting[:active_class]}">#{label}</span>}
+      end
+
+      def wrap_inactive label, attr
+        %Q{<a href="#{yield}"#{attr}>#{label}</a>}
+      end
     end # of HTML
     setup HTML
   end # of Helper

data/lib/pagify/pagifier/active_record.rb

@@ -1,7 +1,13 @@
 
 require 'pagify/pagifier/abstract'
 
-[ActiveRecord::Base, ActiveRecord::Associations::AssociationCollection].each{ |klass|
+proxy = if defined?(ActiveRecord::Associations::CollectionProxy)
+          ActiveRecord::Associations::CollectionProxy
+        else
+          ActiveRecord::Associations::AssociationCollection
+        end
+
+[ActiveRecord::Base, proxy].each{ |klass|
   klass.module_eval do
     extend Pagify::Pagifier
     def self.pagify_pager_create model, opts

data/lib/pagify/version.rb

@@ -1,4 +1,4 @@
 
 module Pagify
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/pagify.gemspec

@@ -1,44 +1,84 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{pagify}
-  s.version = "0.7.0"
+  s.name = "pagify"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Lin Jen-Shin (aka godfat 真常)"]
-  s.date = %q{2009-11-16}
-  s.description = %q{ Pagination tools for Array(or custom class), DataMapper and ActiveRecord
- Helpers for Innate/Ramaze and Rails included.}
-  s.email = %q{godfat (XD) godfat.org}
-  s.extra_rdoc_files = ["CHANGES", "LICENSE", "NOTICE", "README", "TODO", "pagify.gemspec"]
-  s.files = ["CHANGES", "LICENSE", "NOTICE", "README", "Rakefile", "TODO", "lib/pagify.rb", "lib/pagify/active_record.rb", "lib/pagify/array.rb", "lib/pagify/data_mapper.rb", "lib/pagify/helper/abstract.rb", "lib/pagify/helper/detail/setting.rb", "lib/pagify/helper/detail/setup.rb", "lib/pagify/helper/detail/web.rb", "lib/pagify/helper/html.rb", "lib/pagify/helper/innate.rb", "lib/pagify/helper/rails.rb", "lib/pagify/page/basic.rb", "lib/pagify/page/null.rb", "lib/pagify/pager/active_record.rb", "lib/pagify/pager/array.rb", "lib/pagify/pager/basic.rb", "lib/pagify/pager/data_mapper.rb", "lib/pagify/pager/detail/page_accept_string_or_blank.rb", "lib/pagify/pager/null.rb", "lib/pagify/pagifier/abstract.rb", "lib/pagify/pagifier/active_record.rb", "lib/pagify/pagifier/array.rb", "lib/pagify/pagifier/data_mapper.rb", "lib/pagify/version.rb", "pagify.gemspec", "spec/pagify_spec.rb", "spec/spec_helper.rb", "test/helper.rb", "test/helper_model.rb", "test/helper_pagify.rb", "test/helper_web.rb", "test/test_active_record.rb", "test/test_array.rb", "test/test_basic.rb", "test/test_data_mapper.rb", "test/test_html.rb", "test/test_innate.rb", "test/test_null.rb", "test/test_rails.rb"]
-  s.homepage = %q{http://github.com/godfat/pagify}
-  s.rdoc_options = ["--charset=utf-8", "--inline-source", "--line-numbers", "--promiscuous", "--main", "README"]
+  s.authors = ["Lin Jen-Shin (godfat)"]
+  s.date = "2011-11-16"
+  s.description = "Pagination tools for Array(or custom class), DataMapper and ActiveRecord.\nHelpers for Innate/Ramaze and Rails included."
+  s.email = ["godfat (XD) godfat.org"]
+  s.files = [
+  ".gitignore",
+  ".gitmodules",
+  "CHANGES.md",
+  "CONTRIBUTORS",
+  "Gemfile",
+  "LICENSE",
+  "README.md",
+  "Rakefile",
+  "TODO.md",
+  "lib/pagify.rb",
+  "lib/pagify/active_record.rb",
+  "lib/pagify/array.rb",
+  "lib/pagify/data_mapper.rb",
+  "lib/pagify/helper/abstract.rb",
+  "lib/pagify/helper/detail/setting.rb",
+  "lib/pagify/helper/detail/setup.rb",
+  "lib/pagify/helper/detail/web.rb",
+  "lib/pagify/helper/html.rb",
+  "lib/pagify/helper/innate.rb",
+  "lib/pagify/helper/rails.rb",
+  "lib/pagify/page/basic.rb",
+  "lib/pagify/page/null.rb",
+  "lib/pagify/pager/active_record.rb",
+  "lib/pagify/pager/array.rb",
+  "lib/pagify/pager/basic.rb",
+  "lib/pagify/pager/data_mapper.rb",
+  "lib/pagify/pager/detail/page_accept_string_or_blank.rb",
+  "lib/pagify/pager/null.rb",
+  "lib/pagify/pagifier/abstract.rb",
+  "lib/pagify/pagifier/active_record.rb",
+  "lib/pagify/pagifier/array.rb",
+  "lib/pagify/pagifier/data_mapper.rb",
+  "lib/pagify/version.rb",
+  "misc.txt",
+  "pagify.gemspec",
+  "task/.gitignore",
+  "task/gemgem.rb",
+  "test/helper.rb",
+  "test/helper_model.rb",
+  "test/helper_pagify.rb",
+  "test/helper_web.rb",
+  "test/test_active_record.rb",
+  "test/test_array.rb",
+  "test/test_basic.rb",
+  "test/test_data_mapper.rb",
+  "test/test_html.rb",
+  "test/test_innate.rb",
+  "test/test_null.rb",
+  "test/test_rails.rb"]
+  s.homepage = "https://github.com/godfat/pagify"
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{ludy}
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Pagination tools for Array(or custom class), DataMapper and ActiveRecord Helpers for Innate/Ramaze and Rails included.}
-  s.test_files = ["test/test_active_record.rb", "test/test_array.rb", "test/test_basic.rb", "test/test_data_mapper.rb", "test/test_html.rb", "test/test_innate.rb", "test/test_null.rb", "test/test_rails.rb"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Pagination tools for Array(or custom class), DataMapper and ActiveRecord."
+  s.test_files = [
+  "test/test_active_record.rb",
+  "test/test_array.rb",
+  "test/test_basic.rb",
+  "test/test_data_mapper.rb",
+  "test/test_html.rb",
+  "test/test_innate.rb",
+  "test/test_null.rb",
+  "test/test_rails.rb"]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bones>, [">= 2.5.1"])
-      s.add_development_dependency(%q<dm-core>, [">= 0.10.1"])
-      s.add_development_dependency(%q<dm-aggregates>, [">= 0.10.1"])
-      s.add_development_dependency(%q<activerecord>, [">= 2.3.4"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
-      s.add_dependency(%q<bones>, [">= 2.5.1"])
-      s.add_dependency(%q<dm-core>, [">= 0.10.1"])
-      s.add_dependency(%q<dm-aggregates>, [">= 0.10.1"])
-      s.add_dependency(%q<activerecord>, [">= 2.3.4"])
     end
   else
-    s.add_dependency(%q<bones>, [">= 2.5.1"])
-    s.add_dependency(%q<dm-core>, [">= 0.10.1"])
-    s.add_dependency(%q<dm-aggregates>, [">= 0.10.1"])
-    s.add_dependency(%q<activerecord>, [">= 2.3.4"])
   end
 end