rails_paginate 0.0.4 → 0.0.5

data/Gemfile

@@ -7,6 +7,7 @@ group :development do
   gem "jeweler"
   gem "rspec"
   gem "yard"
+  gem "rspec-hpricot-matchers"
   if defined? JRUBY_VERSION
     gem "activerecord-jdbc-adapter"
     gem "activerecord-jdbcsqlite3-adapter"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    ZenTest (4.4.2)
+    ZenTest (4.5.0)
     abstract (1.0.0)
     actionmailer (3.0.4)
       actionpack (= 3.0.4)
@@ -37,6 +37,8 @@ GEM
     erubis (2.6.6)
       abstract (>= 1.0.0)
     git (1.2.5)
+    hpricot (0.8.3)
+    hpricot (0.8.3-java)
     i18n (0.5.0)
     jeweler (1.5.2)
       bundler (~> 1.0.0)
@@ -75,6 +77,8 @@ GEM
     rspec-core (2.5.1)
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
+    rspec-hpricot-matchers (0.0.3)
+      hpricot
     rspec-mocks (2.5.0)
     simplecov (0.4.0)
       simplecov-html (~> 0.4.0)
@@ -96,6 +100,7 @@ DEPENDENCIES
   jeweler
   rails (~> 3.0.0)
   rspec
+  rspec-hpricot-matchers
   simplecov
   sqlite3
   yard

data/README.rdoc

@@ -2,25 +2,52 @@
 
 a new rails 3 paginate plugin as will_paginate replacement
 
-== Development status
-
-* Collection - 100%
-* -> Array - 100%
-* -> ActiveRecord - 100%
-* -> Rspec - 100%
-* ViewHelper - 70%
-* -> HtmlDefault 80%
-* -> Rspec 5%
-* Pager - 100%
-* -> Slider - 100%
-* -> Rspec - 100%
+== Features
+
+* Collection support
+* - Array
+* - ActiveRecord
+* View helper for pagination
+* Renderer
+* - HTML list renderer (:html_default)
+* Pager
+* - Slider
+* I18n support
 
 == Installation
-Add the following line to your Gemfile
+
+add to Gemfile
   gem "rails_paginate"
 
-If you want to use it as plugin
-  rails plugin install git://github.com/traxanos/rails_paginate.git
+after bundle execute
+  rails g rails_paginate:install
+
+== Configuration
+
+  RailsPaginate.setup do |config|
+    # config.per_page = 20
+    # config.page_param = :page
+
+    # configure default renderer
+    # config.default_renderer = :html_default
+
+    # configure renderer
+    # config.renderer :html_default do |renderer|
+      # renderer.show_first_page = false
+      # renderer.show_last_page = false
+      # renderer.show_next_page = false
+      # renderer.show_previous_page = false
+    # end
+
+    # configure default default_pager
+    # config.default_pager = :slider
+
+    # configure pager
+    # config.pager :slider do |pager|
+      # pager.inner = 3
+      # pager.outer = 1
+    # end
+  end
 
 == Using
 
@@ -32,6 +59,10 @@ If you want to use it as plugin
 
   (1..555).to_a.paginate :page => 1, :per_page => 10
 
+== Requirements
+
+* Rails 3 (http://github.com/rails/rails)
+
 == Test environments
 
 * ruby-1.9.2

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/generators/rails_paginate/install_generator.rb

@@ -0,0 +1,15 @@
+module RailsPaginate
+  module Generators # :nodoc:
+    # Install Generator
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Install the rails_paginate plugin"
+      def install
+        copy_file "config/initializers/paginate.rb", "config/initializers/paginate.rb"
+        copy_file "config/locales/en.yml", "config/locales/paginate.en.yml"
+        copy_file "config/locales/de.yml", "config/locales/paginate.de.yml"
+      end
+    end
+  end
+end

data/lib/generators/templates/config/initializers/paginate.rb

@@ -0,0 +1,25 @@
+# setup paginate
+RailsPaginate.setup do |config|
+  # config.per_page = 20
+  # config.page_param = :page
+
+  # configure default renderer
+  # config.default_renderer = :html_default
+
+  # configure renderer
+  # config.renderer :html_default do |renderer|
+    # renderer.show_first_page = false
+    # renderer.show_last_page = false
+    # renderer.show_next_page = false
+    # renderer.show_previous_page = false
+  # end
+
+  # configure default default_pager
+  # config.default_pager = :slider
+
+  # configure pager
+  # config.pager :slider do |pager|
+    # pager.inner = 3
+    # pager.outer = 1
+  # end
+end

data/lib/generators/templates/config/locales/de.yml

@@ -0,0 +1,7 @@
+de:
+  paginate:
+    first_page_label: Anfang
+    last_page_label: Ende
+    previous_page_label: "« Zurück"
+    next_page_label: "Weiter »"
+    pager: %{page}

data/lib/generators/templates/config/locales/en.yml

@@ -0,0 +1,7 @@
+de:
+  paginate:
+    first_page_label: first
+    last_page_label: last
+    previous_page_label: "« previous"
+    next_page_label: "next »"
+    pager: %{page}

data/lib/rails_paginate.rb

@@ -35,7 +35,11 @@ module RailsPaginate
       raise ArgumentError, "renderer #{renderer} is not valid" unless (renderer.is_a? Symbol or renderer.is_a? String or renderer.is_a? Class)
       renderer = renderer.to_s if renderer.is_a? Symbol
       renderer = "rails_paginate/renderers/#{renderer}".camelize.constantize if renderer.is_a? String
-      renderer
+      if block_given?
+        yield renderer
+      else
+        renderer
+      end
     end
 
     # return pager
@@ -43,18 +47,20 @@ module RailsPaginate
       raise ArgumentError, "pager #{pager} is not valid" unless (pager.is_a? Symbol or pager.is_a? String or pager.is_a? Class)
       pager = pager.to_s if pager.is_a? Symbol
       pager = "rails_paginate/pagers/#{pager}".camelize.constantize if pager.is_a? String
-      pager
+      if block_given?
+        yield pager
+      else
+        pager
+      end
     end
 
     # init rails paginate
     def init
+      require 'rails_paginate/rails' if defined?(::Rails::Engine)
       ::Array.send(:include, Helpers::Array)
       ::ActiveRecord::Base.send(:extend, Helpers::ActiveRecord) if defined?(::ActiveRecord::Base)
       ::ActiveRecord::Relation.send(:include, Helpers::ActiveRecord) if defined?(::ActiveRecord::Relation)
       ::ActionView::Base.send(:include, Helpers::ActionView) if defined?(::ActionView::Base)
-
-      # set default method
-      renderer :html_default
     end
   end
 end

data/lib/rails_paginate/collection.rb

@@ -50,10 +50,12 @@ module RailsPaginate
       self.replace result.nil? ? [] : result
     end
 
+    # total count of array or relation
     def total
       @total ||= array_or_relation.count
     end
 
+    # count of pages
     def pages
       @pages ||= total == 0 ? 1 : (total / per_page.to_f).ceil
     end
@@ -68,12 +70,12 @@ module RailsPaginate
       total > per_page
     end
 
-    # return first page
+    # first page
     def first_page
       1
     end
 
-    # return last page
+    # last page
     def last_page
       pages
     end
@@ -88,12 +90,12 @@ module RailsPaginate
       current_page == first_page
     end
 
-    # return next page
+    # next page
     def next_page
       current_page < pages ? (current_page + 1) : nil
     end
 
-    # return previous page
+    # previous page
     def previous_page
       current_page > 1 ? (current_page - 1) : nil
     end

data/lib/rails_paginate/helpers/action_view.rb

@@ -1,4 +1,5 @@
 module RailsPaginate::Helpers
+  # ActionView extension for create paginate view helper
   module ActionView
     # view_helper for paginate
     #

data/lib/rails_paginate/helpers/active_record.rb

@@ -1,5 +1,10 @@
 module RailsPaginate::Helpers
+  # ActiveRecord extension for create paginate collection
   module ActiveRecord
+    # paginate with options
+    #
+    # page = active page
+    # per_page = how much entries per page
     def paginate(*args)
       options = args.extract_options!
       per_page = options.delete(:per_page)

data/lib/rails_paginate/helpers/array.rb

@@ -1,5 +1,10 @@
 module RailsPaginate::Helpers
+  # Array extension for create paginate collection
   module Array
+    # paginate with options
+    #
+    # page = active page
+    # per_page = how much entries per page
     def paginate(*args)
       options = args.extract_options!
       per_page = options.delete(:per_page)

data/lib/rails_paginate/pagers/base.rb

@@ -1,20 +1,26 @@
 module RailsPaginate::Pagers
   # base method
   class Base
+    # default reader
     attr_reader :collection, :options
+
+    # set default collection and options
     def initialize(collection, options = {})
       @collection = collection
       @options = options
     end
 
+    # current_page
     def current_page
       collection.current_page
     end
 
+    # total count
     def pages
       collection.pages
     end
 
+    # abstract
     def visible_pages
       raise StandardError, "render is not implemented"
     end

data/lib/rails_paginate/pagers/slider.rb

@@ -1,10 +1,16 @@
 module RailsPaginate::Pagers
   # slider method
   class Slider < Base
-    cattr_accessor :inner, :outer
+
+    # how much pages should display around current_page
+    cattr_accessor :inner
     @@inner = 3
+
+    # how much pages should display at start and end
+    cattr_accessor :outer
     @@outer = 1
 
+    # build array with all visible pages
     def visible_pages
       visible = []
       last_inserted = 0
@@ -26,6 +32,7 @@ module RailsPaginate::Pagers
       visible
     end
 
+    # build dummy inner range
     def inner_range
       @inner_range ||= (current_page - inner)..(current_page + inner)
     end
@@ -47,10 +54,12 @@ module RailsPaginate::Pagers
       false
     end
 
+    # get option of inner
     def inner
       options[:inner] || self.class.inner
     end
 
+    # get option of out
     def outer
       options[:outer] || self.class.outer
     end

data/lib/rails_paginate/rails.rb

@@ -0,0 +1,4 @@
+module RailsPaginate
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rails_paginate/renderers.rb

@@ -3,6 +3,5 @@ module RailsPaginate
   module Renderers
     autoload :Base, 'rails_paginate/renderers/base'
     autoload :HtmlDefault, 'rails_paginate/renderers/html_default'
-    autoload :HtmlList, 'rails_paginate/renderers/html_list'
   end
 end

data/lib/rails_paginate/renderers/base.rb

@@ -3,6 +3,7 @@ module RailsPaginate::Renderers
   class Base
     attr_reader :view, :collection, :options, :pager
 
+    # setup rails_paginate collection
     def initialize(view, collection, pager, options = {})
       raise ArgumentError, "first argument must be a RailsPaginate::Collection" unless collection.is_a? RailsPaginate::Collection
       raise ArgumentError, "second argument must be a Hash" unless options.is_a? Hash
@@ -13,21 +14,19 @@ module RailsPaginate::Renderers
       @pager = pager
     end
 
+    # build url
     def url_for_page(page)
-      # todo: fix url_for so did't neet fallback
-      begin
-        view.url_for(view.default_url_options.merge({:page => page}))
-      rescue
-        "?page=#{page}"
-      end
+      view.url_for(view.default_url_options.merge({page_param.to_sym => page}))
     end
 
+    # abstrack renderer
     def render
       raise StandardError, "render is not implemented"
     end
 
     protected
 
+    # link to page with i18n support
     def link_to_page(page, key, options = {})
       css_class = "#{options[:class]} #{page == current_page ? 'current' : ''}"
       if key.nil?
@@ -39,19 +38,27 @@ module RailsPaginate::Renderers
       end
     end
 
+    #
+    def page_param
+      options[:page_param] || RailsPaginate.page_param
+    end
+
     # helper
     def current_page
       collection.current_page
     end
 
+    # map to view helper
     def content_tag(*args, &block)
       view.content_tag(*args, &block)
     end
 
+    # map to view helper
     def link_to(*args, &block)
       view.link_to(*args, &block)
     end
 
+    # map to view helper
     def t(*args)
       view.t(*args)
     end

data/lib/rails_paginate/renderers/html_default.rb

@@ -1,6 +1,7 @@
 module RailsPaginate::Renderers
-  # normale renderer
+  # default html renderer
   class HtmlDefault < Base
+    
     # show first page item
     cattr_accessor :show_first_page
     @@show_first_page = true
@@ -17,6 +18,7 @@ module RailsPaginate::Renderers
     cattr_accessor :show_previous_page
     @@show_previous_page = true
 
+    # render html for pagination
     def render
       content_tag(:ul) do
         html = "\n"

data/rails_paginate.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rails_paginate}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marco Scholl"]
-  s.date = %q{2011-02-17}
+  s.date = %q{2011-02-19}
   s.description = %q{a new rails 3 paginate plugin as will_paginate replacement}
   s.email = %q{develop@marco-scholl.de}
   s.extra_rdoc_files = [
@@ -27,6 +27,10 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "init.rb",
+    "lib/generators/rails_paginate/install_generator.rb",
+    "lib/generators/templates/config/initializers/paginate.rb",
+    "lib/generators/templates/config/locales/de.yml",
+    "lib/generators/templates/config/locales/en.yml",
     "lib/rails_paginate.rb",
     "lib/rails_paginate/collection.rb",
     "lib/rails_paginate/helpers.rb",
@@ -36,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/rails_paginate/pagers.rb",
     "lib/rails_paginate/pagers/base.rb",
     "lib/rails_paginate/pagers/slider.rb",
+    "lib/rails_paginate/rails.rb",
     "lib/rails_paginate/renderers.rb",
     "lib/rails_paginate/renderers/base.rb",
     "lib/rails_paginate/renderers/html_default.rb",
@@ -49,8 +54,7 @@ Gem::Specification.new do |s|
     "spec/renderers/base_spec.rb",
     "spec/renderers/html_default_spec.rb",
     "spec/spec_helper.rb",
-    "spec/support/10_active_record.rb",
-    "spec/support/20_action_controller.rb"
+    "spec/support/10_active_record.rb"
   ]
   s.homepage = %q{http://github.com/phatworx/rails_paginate}
   s.licenses = ["MIT"]
@@ -67,8 +71,7 @@ Gem::Specification.new do |s|
     "spec/renderers/base_spec.rb",
     "spec/renderers/html_default_spec.rb",
     "spec/spec_helper.rb",
-    "spec/support/10_active_record.rb",
-    "spec/support/20_action_controller.rb"
+    "spec/support/10_active_record.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -81,6 +84,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rspec-hpricot-matchers>, [">= 0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<sqlite3>, [">= 0"])
     else
@@ -90,6 +94,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rspec-hpricot-matchers>, [">= 0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
     end
@@ -100,6 +105,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rspec-hpricot-matchers>, [">= 0"])
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<sqlite3>, [">= 0"])
   end

data/spec/helpers/action_view_spec.rb

@@ -28,9 +28,9 @@ describe RailsPaginate::Helpers::ActionView do
     end
 
     context "#paginate with class => dummy" do
-      before { @pagination = action_view.paginate collection, :class => "dummy" }
-      subject { @pagination }
-      it { subject.should match(/<div class="pagination dummy">/) }
+      subject { action_view.paginate collection, :class => "dummy" }
+      it("should have one div.pagination.dummy") { subject.should have_tag('div.pagination.dummy', :count => 1) }
+      it("should have one div with ul") { subject.should have_tag('div > ul', :count => 1) }
     end
 
   end

data/spec/renderers/html_default_spec.rb

@@ -1,12 +1,45 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe RailsPaginate::Renderers::HtmlDefault do
-  let(:collection) { [].paginate }
-  subject { RailsPaginate::Renderers::HtmlDefault.new action_view, collection, RailsPaginate.pager(:slider).new(collection) }
-  specify { should respond_to :render }
 
-  it "#render should not raise StandardError" do
-    lambda { subject.render }.should_not raise_error(StandardError)
+
+  context "empty collection" do
+    let(:collection) { [].paginate }
+    context "pager type slider" do
+      subject { RailsPaginate::Renderers::HtmlDefault.new action_view, collection, RailsPaginate.pager(:slider).new(collection) }
+      specify { should respond_to :render }
+      it "#render should not raise StandardError" do
+        lambda { subject.render }.should_not raise_error(StandardError)
+      end
+    end
+  end
+
+  context "collection with 100 items" do
+    let(:collection) { (1..100).to_a.paginate }
+    context "pager type slider" do
+      before { @renderer = RailsPaginate::Renderers::HtmlDefault.new action_view, collection, RailsPaginate.pager(:slider).new(collection) }
+      subject { @renderer }
+      specify { should respond_to :render }
+      it "#render should not raise StandardError" do
+        lambda { subject.render }.should_not raise_error(StandardError)
+      end
+
+      context "result of #render" do
+        subject { @renderer.render }
+        specify { should be_an String }
+
+        it("should not have the div at first") { subject.should_not have_tag('> div', :count => 1) }
+        it("should have one ul") { subject.should have_tag('ul') }
+        it("should have one li") { subject.should have_tag('ul > li', :count => 9) }
+        [:first_page, :previous_page, :first_pager, :last_pager, :next_page, :last_page].each do |class_attr|
+          it("should have one li.#{class_attr}") { subject.should have_tag("ul > li.#{class_attr}", :count => 1) }
+        end
+        it("should have 5 li.pager") { subject.should have_tag('ul > li.pager', :count => 5) }
+        it("should have 8 ul > li > a") { subject.should have_tag('ul > li > a', :count => 8) }
+      end
+
+
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ require 'active_support/test_case'
 require 'action_controller'
 require 'action_controller/test_case'
 require 'action_dispatch'
+require 'rspec-hpricot-matchers'
 require 'rails_paginate'
 
 # Requires supporting files with custom matchers and macros, etc,
@@ -20,30 +21,20 @@ require 'rails_paginate'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
+  config.include(HpricotSpec::Matchers)
+  
   def action_view
     x = ActionView::Base.new
     x.controller = action_controller
-    x.request = action_controller.request
+    x.stub!(:url_for).and_return do |*args|
+      options = args.extract_options!
+      "?page=#{options[:page]}"
+    end
     x
   end
 
   def action_controller
-    x = DummyController.new
-    x.request = test_request
-    x.response = test_response
-    x
-  end
-
-  def routes
-    ActionDispatch::Routing::RouteSet.new.draw { root :to => "index#dummy" }
-  end
-
-  def test_request
-    ActionController::TestRequest.new
-  end
-
-  def test_response
-    ActionController::TestResponse.new
+    ActionController::Base.new
   end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: rails_paginate
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Marco Scholl
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-17 00:00:00 +01:00
+date: 2011-02-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,7 +80,7 @@ dependencies:
   prerelease: false
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: simplecov
+  name: rspec-hpricot-matchers
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -91,7 +91,7 @@ dependencies:
   prerelease: false
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
-  name: sqlite3
+  name: simplecov
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -101,6 +101,17 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
 description: a new rails 3 paginate plugin as will_paginate replacement
 email: develop@marco-scholl.de
 executables: []
@@ -121,6 +132,10 @@ files:
 - Rakefile
 - VERSION
 - init.rb
+- lib/generators/rails_paginate/install_generator.rb
+- lib/generators/templates/config/initializers/paginate.rb
+- lib/generators/templates/config/locales/de.yml
+- lib/generators/templates/config/locales/en.yml
 - lib/rails_paginate.rb
 - lib/rails_paginate/collection.rb
 - lib/rails_paginate/helpers.rb
@@ -130,6 +145,7 @@ files:
 - lib/rails_paginate/pagers.rb
 - lib/rails_paginate/pagers/base.rb
 - lib/rails_paginate/pagers/slider.rb
+- lib/rails_paginate/rails.rb
 - lib/rails_paginate/renderers.rb
 - lib/rails_paginate/renderers/base.rb
 - lib/rails_paginate/renderers/html_default.rb
@@ -144,7 +160,6 @@ files:
 - spec/renderers/html_default_spec.rb
 - spec/spec_helper.rb
 - spec/support/10_active_record.rb
-- spec/support/20_action_controller.rb
 has_rdoc: true
 homepage: http://github.com/phatworx/rails_paginate
 licenses: 
@@ -159,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -185373245493970734
+      hash: -152789811183962972
       segments: 
       - 0
       version: "0"
@@ -187,4 +202,3 @@ test_files:
 - spec/renderers/html_default_spec.rb
 - spec/spec_helper.rb
 - spec/support/10_active_record.rb
-- spec/support/20_action_controller.rb

data/spec/support/20_action_controller.rb

@@ -1,4 +0,0 @@
-class DummyController < ActionController::Base
-  def index
-  end
-end