pagify 0.6.1

data/lib/pagify/pager/array.rb

@@ -0,0 +1,21 @@
+
+module Pagify
+  # array paginator would just simply assume your data is an array,
+  # and create pages simply for your_data[offset, per_page]
+  # if your data is much more complex, use Paginator instead of this
+  class ArrayPager < BasicPager
+    attr_reader :data
+
+    # data that you passed in this paginator
+    def initialize data, opts = {}
+      @data = data
+      super(opts.merge(
+        :fetcher => lambda{ |offset, per_page|
+          data[offset, per_page]
+        },
+        :counter => lambda{
+          data.size
+        }))
+    end
+  end # of ArrayPager
+end # of Pagify

data/lib/pagify/pager/basic.rb

@@ -0,0 +1,114 @@
+
+module Pagify
+  # pager is something help you paginate the data,
+  # through the fetcher and counter you pass in.
+  # e.g., for a array, the fetcher would be array[offset, per_page],
+  # the counter would be array.size. and for data mapper's resource,
+  # fetcher would be Model.all :offset => offset, :limit => per_page.
+  # see ArrayPager and DataMapperPager, ActiveRecordPager, etc.
+  # if you just simply need them or have a look at the source code
+  # for example usage for Pager.
+  class BasicPager
+    include Enumerable
+    attr_reader :fetcher, :counter
+    attr_accessor :opts
+
+    [:per_page, :null_page].each{ |attr|
+      define_method(attr) do
+        opts[attr]
+      end
+
+      define_method("#{attr}=") do |new_value|
+        opts[attr] = new_value
+      end
+    }
+
+    #  fetcher is function that fetch the data,
+    #  counter is function that count the data,
+    #  null_page indicates that pager sohuld
+    # the default per_page is 20. you can reset per_page property later.
+    def initialize opts = {}
+      raise ArgumentError.new('missing fetcher and/or counter.') if
+        !opts[:fetcher] || !opts[:counter]
+
+      raise ArgumentError.new('fetcher or counter does not respond to call.') if
+        !opts[:fetcher].respond_to?(:call) || !opts[:counter].respond_to?(:call)
+
+      @opts     = {}
+      @fetcher  = opts[:fetcher]
+      @counter  = opts[:counter]
+
+      self.per_page  = opts[:per_page]  || 20
+      self.null_page = opts[:null_page] || true
+    end
+
+    # if two paginators are equal, then the properties of
+    # per_page, fetcher, counter are all equal.
+    def == rhs
+      return false unless rhs
+      self.per_page == rhs.per_page and
+      self.fetcher  == rhs.fetcher  and
+      self.counter  == rhs.counter
+    end
+
+    # for each page...
+    def each; 1.upto(size){ |i| yield page(i) }; end
+
+    # return all pages in an array
+    def to_a; map{ |e| e }; end
+    alias_method :pages, :to_a
+
+    def page_exists? page
+      page = normalize_page(page)
+      offset = (page - 1) * per_page
+      page > 0 && offset < entries_count
+    end
+
+    # create page instance by page number.
+    # if page number you specified was not existed,
+    # nil would be returned. note, page start at 1, not zero.
+    def page page
+      if page_exists?(page)
+        return BasicPage.new(self, normalize_page(page))
+
+      else
+        if null_page
+          return null_page_instance
+        else
+          return nil
+        end
+
+      end
+
+    end
+    alias_method :[], :page
+
+    # return the amount of pages
+    def size; (entries_count / per_page.to_f).ceil; end
+
+    # simply call @counter.call
+    def entries_count; counter.call; end
+
+    # get the offset property about the page.
+    # it is simply (page-1)*@per_page
+    def offset page
+      (normalize_page(page) - 1) * per_page
+    end
+
+    protected
+    def reject_pager_opts opts
+      opts.reject{ |key, value| [:per_page, :null_page].member?(key) }
+    end
+
+    # do nothing for basic pager
+    def normalize_page page
+      page
+    end
+
+    # return a null pager that stubs anything to 0
+    def null_page_instance
+      @null_page_instance ||= NullPage.new(self)
+    end
+
+  end # of BasicPager
+end # of Pagify

data/lib/pagify/pager/data_mapper.rb

@@ -0,0 +1,29 @@
+
+# you'll need dm-core and dm-aggregates to use DataMapperPager
+
+module Pagify
+
+  class DataMapperPager < BasicPager
+    include PageAcceptStringOrBlank
+    attr_reader :model
+
+    def initialize model_class, opts = {}, query = {}
+      @model = model_class
+      query ||= {}
+      query_opts = reject_pager_opts(opts)
+
+      super(opts.merge(
+        :fetcher => lambda{ |offset, per_page|
+          model.send :with_scope, query do
+            model.all(query_opts.merge(:offset => offset, :limit => per_page))
+          end
+        },
+        :counter => lambda{
+          model.send :with_scope, query do
+            model.count(query_opts)
+          end
+        }))
+    end
+
+  end # of DataMapperPager
+end # of Pagify

data/lib/pagify/pager/detail/page_accept_string_or_blank.rb

@@ -0,0 +1,13 @@
+
+module Pagify
+  module PageAcceptStringOrBlank
+    private
+    def normalize_page n
+      if n.blank?
+        n = 1
+      else
+        n = n.to_i
+      end
+    end
+  end # of PageAcceptStringOrBlank
+end # of Pagify

data/lib/pagify/pager/null.rb

@@ -0,0 +1,15 @@
+
+module Pagify
+  # a null paginator that stubs any page into a null page.
+  class NullPager < BasicPager
+    include Singleton
+    def initialize
+      super(:fetcher => lambda{|*a|[]}, :counter => lambda{0})
+    end
+
+    private
+    def normalize_page n
+      0
+    end
+  end # of NullPager
+end # of Pagify

data/lib/pagify/pagifier/abstract.rb

@@ -0,0 +1,10 @@
+
+module Pagify
+  module Pagifier
+    def pagify opts = {}
+      opts = {:per_page => 20, :null_page => false, :page => 1}.merge(opts)
+      page = opts.delete(:page)
+      pagify_pager_create(self, opts).page(page)
+    end
+  end # of Pagifier
+end # of Pagify

data/lib/pagify/pagifier/active_record.rb

@@ -0,0 +1,11 @@
+
+require 'pagify/pagifier/abstract'
+
+[ActiveRecord::Base, ActiveRecord::Associations::AssociationCollection].each{ |klass|
+  klass.module_eval do
+    extend Pagify::Pagifier
+    def self.pagify_pager_create model, opts
+      Pagify::ActiveRecordPager.new model, opts
+    end
+  end
+}

data/lib/pagify/pagifier/array.rb

@@ -0,0 +1,9 @@
+
+require 'pagify/pagifier/abstract'
+
+class Array
+  include Pagify::Pagifier
+  def pagify_pager_create model, opts
+    Pagify::ArrayPager.new model, opts
+  end
+end

data/lib/pagify/pagifier/data_mapper.rb

@@ -0,0 +1,11 @@
+
+require 'pagify/pagifier/abstract'
+
+module DataMapper
+  module Model
+    include Pagify::Pagifier
+    def pagify_pager_create model, opts
+      Pagify::DataMapperPager.new(model, opts, model.query)
+    end
+  end
+end

data/lib/pagify/version.rb

@@ -0,0 +1,4 @@
+
+module Pagify
+  VERSION = '0.6.1'
+end

data/pagify.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pagify}
+  s.version = "0.6.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lin Jen-Shin (aka godfat \347\234\237\345\270\270)"]
+  s.date = %q{2009-07-30}
+  s.description = %q{ Pagination tools for Array(or custom class), DataMapper and ActiveRecord}
+  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/html.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/test_active_record.rb", "test/test_array.rb", "test/test_basic.rb", "test/test_data_mapper.rb", "test/test_html.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.require_paths = ["lib"]
+  s.rubyforge_project = %q{ludy}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{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_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.9.9"])
+      s.add_development_dependency(%q<dm-aggregates>, [">= 0.9.9"])
+      s.add_development_dependency(%q<activerecord>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<bones>, [">= 2.5.1"])
+      s.add_dependency(%q<dm-core>, [">= 0.9.9"])
+      s.add_dependency(%q<dm-aggregates>, [">= 0.9.9"])
+      s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<bones>, [">= 2.5.1"])
+    s.add_dependency(%q<dm-core>, [">= 0.9.9"])
+    s.add_dependency(%q<dm-aggregates>, [">= 0.9.9"])
+    s.add_dependency(%q<activerecord>, [">= 2.0.0"])
+  end
+end

data/spec/pagify_spec.rb

@@ -0,0 +1,8 @@
+# $Id$
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Pagify do
+end
+
+# EOF

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# $Id$
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib pagify]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

data/tasks/ann.rake

@@ -0,0 +1,80 @@
+
+begin
+  require 'bones/smtp_tls'
+rescue LoadError
+  require 'net/smtp'
+end
+require 'time'
+
+namespace :ann do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  file PROJ.ann.file do
+    ann = PROJ.ann
+    puts "Generating #{ann.file}"
+    File.open(ann.file,'w') do |fd|
+      fd.puts("#{PROJ.name} version #{PROJ.version}")
+      fd.puts("    by #{Array(PROJ.authors).first}") if PROJ.authors
+      fd.puts("    #{PROJ.url}") if PROJ.url.valid?
+      fd.puts("    (the \"#{PROJ.release_name}\" release)") if PROJ.release_name
+      fd.puts
+      fd.puts("== DESCRIPTION")
+      fd.puts
+      fd.puts(PROJ.description)
+      fd.puts
+      fd.puts(PROJ.changes.sub(%r/^.*$/, '== CHANGES'))
+      fd.puts
+      ann.paragraphs.each do |p|
+        fd.puts "== #{p.upcase}"
+        fd.puts
+        fd.puts paragraphs_of(PROJ.readme_file, p).join("\n\n")
+        fd.puts
+      end
+      fd.puts ann.text if ann.text
+    end
+  end
+
+  desc "Create an announcement file"
+  task :announcement => ['ann:prereqs', PROJ.ann.file]
+
+  desc "Send an email announcement"
+  task :email => ['ann:prereqs', PROJ.ann.file] do
+    ann = PROJ.ann
+    from = ann.email[:from] || Array(PROJ.authors).first || PROJ.email
+    to   = Array(ann.email[:to])
+
+    ### build a mail header for RFC 822
+    rfc822msg =  "From: #{from}\n"
+    rfc822msg << "To: #{to.join(',')}\n"
+    rfc822msg << "Subject: [ANN] #{PROJ.name} #{PROJ.version}"
+    rfc822msg << " (#{PROJ.release_name})" if PROJ.release_name
+    rfc822msg << "\n"
+    rfc822msg << "Date: #{Time.new.rfc822}\n"
+    rfc822msg << "Message-Id: "
+    rfc822msg << "<#{"%.8f" % Time.now.to_f}@#{ann.email[:domain]}>\n\n"
+    rfc822msg << File.read(ann.file)
+
+    params = [:server, :port, :domain, :acct, :passwd, :authtype].map do |key|
+      ann.email[key]
+    end
+
+    params[3] = PROJ.email if params[3].nil?
+
+    if params[4].nil?
+      STDOUT.write "Please enter your e-mail password (#{params[3]}): "
+      params[4] = STDIN.gets.chomp
+    end
+
+    ### send email
+    Net::SMTP.start(*params) {|smtp| smtp.sendmail(rfc822msg, from, to)}
+  end
+end  # namespace :ann
+
+desc 'Alias to ann:announcement'
+task :ann => 'ann:announcement'
+
+CLOBBER << PROJ.ann.file
+
+# EOF

data/tasks/bones.rake

@@ -0,0 +1,20 @@
+
+if HAVE_BONES
+
+namespace :bones do
+
+  desc 'Show the PROJ open struct'
+  task :debug do |t|
+    atr = if t.application.top_level_tasks.length == 2
+      t.application.top_level_tasks.pop
+    end
+
+    if atr then Bones::Debug.show_attr(PROJ, atr)
+    else Bones::Debug.show PROJ end
+  end
+
+end  # namespace :bones
+
+end  # HAVE_BONES
+
+# EOF

data/tasks/gem.rake

@@ -0,0 +1,201 @@
+
+require 'find'
+require 'rake/packagetask'
+require 'rubygems/user_interaction'
+require 'rubygems/builder'
+
+module Bones
+class GemPackageTask < Rake::PackageTask
+  # Ruby GEM spec containing the metadata for this package.  The
+  # name, version and package_files are automatically determined
+  # from the GEM spec and don't need to be explicitly provided.
+  #
+  attr_accessor :gem_spec
+
+  # Tasks from the Bones gem directory
+  attr_reader :bones_files
+
+  # Create a GEM Package task library.  Automatically define the gem
+  # if a block is given.  If no block is supplied, then +define+
+  # needs to be called to define the task.
+  #
+  def initialize(gem_spec)
+    init(gem_spec)
+    yield self if block_given?
+    define if block_given?
+  end
+
+  # Initialization tasks without the "yield self" or define
+  # operations.
+  #
+  def init(gem)
+    super(gem.name, gem.version)
+    @gem_spec = gem
+    @package_files += gem_spec.files if gem_spec.files
+    @bones_files = []
+
+    local_setup = File.join(Dir.pwd, %w[tasks setup.rb])
+    if !test(?e, local_setup)
+      Dir.glob(::Bones.path(%w[lib bones tasks *])).each {|fn| bones_files << fn}
+    end
+  end
+
+  # Create the Rake tasks and actions specified by this
+  # GemPackageTask.  (+define+ is automatically called if a block is
+  # given to +new+).
+  #
+  def define
+    super
+    task :prereqs
+    task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
+    file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
+      when_writing("Creating GEM") {
+        chdir(package_dir_path) do
+          Gem::Builder.new(gem_spec).build
+          verbose(true) {
+            mv gem_file, "../#{gem_file}"
+          }
+        end
+      }
+    end
+
+    file package_dir_path => bones_files do
+      mkdir_p package_dir rescue nil
+
+      gem_spec.files = (gem_spec.files +
+          bones_files.map {|fn| File.join('tasks', File.basename(fn))}).sort
+
+      bones_files.each do |fn|
+        base_fn = File.join('tasks', File.basename(fn))
+        f = File.join(package_dir_path, base_fn)
+        fdir = File.dirname(f)
+        mkdir_p(fdir) if !File.exist?(fdir)
+        if File.directory?(fn)
+          mkdir_p(f)
+        else
+          raise "file name conflict for '#{base_fn}' (conflicts with '#{fn}')" if test(?e, f)
+          safe_ln(fn, f)
+        end
+      end
+    end
+  end
+  
+  def gem_file
+    if @gem_spec.platform == Gem::Platform::RUBY
+      "#{package_name}.gem"
+    else
+      "#{package_name}-#{@gem_spec.platform}.gem"
+    end
+  end
+end  # class GemPackageTask
+end  # module Bones
+
+namespace :gem do
+
+  PROJ.gem._spec = Gem::Specification.new do |s|
+    s.name = PROJ.name
+    s.version = PROJ.version
+    s.summary = PROJ.summary
+    s.authors = Array(PROJ.authors)
+    s.email = PROJ.email
+    s.homepage = Array(PROJ.url).first
+    s.rubyforge_project = PROJ.rubyforge.name
+
+    s.description = PROJ.description
+
+    PROJ.gem.dependencies.each do |dep|
+      s.add_dependency(*dep)
+    end
+
+    PROJ.gem.development_dependencies.each do |dep|
+      s.add_development_dependency(*dep)
+    end
+
+    s.files = PROJ.gem.files
+    s.executables = PROJ.gem.executables.map {|fn| File.basename(fn)}
+    s.extensions = PROJ.gem.files.grep %r/extconf\.rb$/
+
+    s.bindir = 'bin'
+    dirs = Dir["{#{PROJ.libs.join(',')}}"]
+    s.require_paths = dirs unless dirs.empty?
+
+    incl = Regexp.new(PROJ.rdoc.include.join('|'))
+    excl = PROJ.rdoc.exclude.dup.concat %w[\.rb$ ^(\.\/|\/)?ext]
+    excl = Regexp.new(excl.join('|'))
+    rdoc_files = PROJ.gem.files.find_all do |fn|
+                   case fn
+                   when excl; false
+                   when incl; true
+                   else false end
+                 end
+    s.rdoc_options = PROJ.rdoc.opts + ['--main', PROJ.rdoc.main]
+    s.extra_rdoc_files = rdoc_files
+    s.has_rdoc = true
+
+    if test ?f, PROJ.test.file
+      s.test_file = PROJ.test.file
+    else
+      s.test_files = PROJ.test.files.to_a
+    end
+
+    # Do any extra stuff the user wants
+    PROJ.gem.extras.each do |msg, val|
+      case val
+      when Proc
+        val.call(s.send(msg))
+      else
+        s.send "#{msg}=", val
+      end
+    end
+  end  # Gem::Specification.new
+
+  Bones::GemPackageTask.new(PROJ.gem._spec) do |pkg|
+    pkg.need_tar = PROJ.gem.need_tar
+    pkg.need_zip = PROJ.gem.need_zip
+  end
+
+  desc 'Show information about the gem'
+  task :debug => 'gem:prereqs' do
+    puts PROJ.gem._spec.to_ruby
+  end
+
+  desc 'Write the gemspec '
+  task :spec => 'gem:prereqs' do
+    File.open("#{PROJ.name}.gemspec", 'w') do |f|
+      f.write PROJ.gem._spec.to_ruby
+    end
+  end
+
+  desc 'Install the gem'
+  task :install => [:clobber, 'gem:package'] do
+    sh "#{SUDO} #{GEM} install --local pkg/#{PROJ.gem._spec.full_name}"
+
+    # use this version of the command for rubygems > 1.0.0
+    #sh "#{SUDO} #{GEM} install --no-update-sources pkg/#{PROJ.gem._spec.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PROJ.name)
+    if installed_list and installed_list.collect { |s| s.version.to_s}.include?(PROJ.version) then
+      sh "#{SUDO} #{GEM} uninstall --version '#{PROJ.version}' --ignore-dependencies --executables #{PROJ.name}"
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+
+  desc 'Cleanup the gem'
+  task :cleanup do
+    sh "#{SUDO} #{GEM} cleanup #{PROJ.gem._spec.name}"
+  end
+end  # namespace :gem
+
+
+desc 'Alias to gem:package'
+task :gem => 'gem:package'
+
+task :clobber => 'gem:clobber_package'
+remove_desc_for_task 'gem:clobber_package'
+
+# EOF