kaminari 0.9.2 → 0.9.3

data/CHANGELOG

@@ -1,3 +1,12 @@
+== 0.9.3
+
+* improved template detection logic
+  When a template for a tag could not be found in the app/views/kaminari/
+	directory, it searches the tag's ancestor template files before falling back
+	to engine's default template. This may help keeping your custom templates DRY.
+
+* simplified bundled template themes
+
 == 0.9.2
 
 * stop adding extra LF between templates when joining

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.3

data/kaminari.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{kaminari}
-  s.version = "0.9.2"
+  s.version = "0.9.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Akira Matsuda"]
-  s.date = %q{2011-02-10}
+  s.date = %q{2011-02-11}
   s.description = %q{Kaminari is a Scope & Engine based clean and powerful and customizable and sophisticated paginator for Rails 3}
   s.email = %q{ronnie@dio.jp}
   s.extra_rdoc_files = [
@@ -49,10 +49,6 @@ Gem::Specification.new do |s|
     "app/views/kaminari/_truncated_span.html.haml",
     "app/views/kaminari/github/_current_page.html.erb",
     "app/views/kaminari/github/_current_page.html.haml",
-    "app/views/kaminari/github/_first_page_link.html.erb",
-    "app/views/kaminari/github/_first_page_link.html.haml",
-    "app/views/kaminari/github/_last_page_link.html.erb",
-    "app/views/kaminari/github/_last_page_link.html.haml",
     "app/views/kaminari/github/_next_link.html.erb",
     "app/views/kaminari/github/_next_link.html.haml",
     "app/views/kaminari/github/_next_span.html.erb",
@@ -69,10 +65,6 @@ Gem::Specification.new do |s|
     "app/views/kaminari/github/_truncated_span.html.haml",
     "app/views/kaminari/google/_current_page.html.erb",
     "app/views/kaminari/google/_current_page.html.haml",
-    "app/views/kaminari/google/_first_page_link.html.erb",
-    "app/views/kaminari/google/_first_page_link.html.haml",
-    "app/views/kaminari/google/_last_page_link.html.erb",
-    "app/views/kaminari/google/_last_page_link.html.haml",
     "app/views/kaminari/google/_next_link.html.erb",
     "app/views/kaminari/google/_next_link.html.haml",
     "app/views/kaminari/google/_next_span.html.erb",
@@ -94,6 +86,7 @@ Gem::Specification.new do |s|
     "lib/kaminari/engine.rb",
     "lib/kaminari/helpers.rb",
     "lib/kaminari/railtie.rb",
+    "lib/kaminari/tags.rb",
     "spec/acceptance/acceptance_helper.rb",
     "spec/acceptance/support/helpers.rb",
     "spec/acceptance/support/paths.rb",

data/lib/generators/kaminari/views_generator.rb

@@ -5,7 +5,7 @@ module Kaminari
 
       class_option :template_engine, :type => :string, :aliases => '-e', :desc => 'Template engine for the views. Available options are "erb" and "haml".'
 
-      def self.banner
+      def self.banner #:nodoc:
         <<-BANNER.chomp
 rails g kaminari:views THEME [options]
 
@@ -15,13 +15,13 @@ rails g kaminari:views THEME [options]
         default: The default one.
                  This one is used internally while you don't override the partials.
         google:  Looks googlish! (note that this is just an example...)
-                 Make sure to specify a very big number (like 65536) for the "window" value.
+                 Try with this option  :window => 10, :outer_window => -1
         github:  A very simple one with only "Older" and "Newer" links.
 BANNER
       end
 
       desc ''
-      def copy_views
+      def copy_views #:nodoc:
         Dir.glob(filename_pattern).map {|f| File.basename f}.each do |f|
           copy_file File.join([template_name.presence, f].compact), "app/views/kaminari/#{f}"
         end

data/lib/kaminari/engine.rb

@@ -1,4 +1,4 @@
-module Kaminari
-  class Engine < ::Rails::Engine
+module Kaminari #:nodoc:
+  class Engine < ::Rails::Engine #:nodoc:
   end
 end

data/lib/kaminari/helpers.rb

@@ -1,71 +1,16 @@
+require File.join(File.dirname(__FILE__), 'tags')
+
 module Kaminari
   module Helpers
-    class Tag
-      def initialize(renderer, options = {})
-        @renderer, @options = renderer, renderer.options.merge(options)
-      end
-
-      def to_s(locals = {})
-        @renderer.render :partial => "kaminari/#{self.class.name.demodulize.underscore}", :locals => @options.merge(locals)
-      end
-
-      private
-      def page_url_for(page)
-        @renderer.url_for @renderer.params.merge(:page => (page <= 1 ? nil : page))
-      end
-    end
-
-    class PrevSpan < Tag
-    end
-
-    class PrevLink < Tag
-      def to_s
-        super :prev_url => page_url_for(@options[:current_page] - 1)
-      end
-    end
-
-    class NextSpan < Tag
-    end
-
-    class NextLink < Tag
-      def to_s
-        super :next_url => page_url_for(@options[:current_page] + 1)
-      end
-    end
-
-    class PageLink < Tag
-      def to_s
-        super :page_url => page_url_for(@options[:page])
-      end
-    end
-
-    class CurrentPage < Tag
-      def to_s
-        super :page_url => page_url_for(@options[:page])
-      end
-    end
-
-    class FirstPageLink < PageLink
-    end
-
-    class LastPageLink < PageLink
-    end
-
-    class TruncatedSpan < Tag
-    end
-
-    class Paginator < Tag
-    end
-
     class PaginationRenderer
       attr_reader :options
 
-      def initialize(template, options)
+      def initialize(template, options) #:nodoc:
         @template, @options = template, options
         @left, @window, @right = (options[:left] || options[:outer_window] || 1), (options[:window] || options[:inner_window] || 4), (options[:right] || options[:outer_window] || 1)
       end
 
-      def tagify_links
+      def tagify_links #:nodoc:
         num_pages, current_page, left, window, right = @options[:num_pages], @options[:current_page], @left, @window, @right
         return [] if num_pages <= 1
 
@@ -90,7 +35,15 @@ module Kaminari
         tags << (num_pages > current_page ? NextLink.new(self) : NextSpan.new(self))
       end
 
-      def to_s
+      def context #:nodoc:
+        @template.instance_variable_get('@lookup_context')
+      end
+
+      def resolver #:nodoc:
+        context.instance_variable_get('@view_paths').first
+      end
+
+      def to_s #:nodoc:
         suppress_logging_render_partial do
           clear_content_for :kaminari_paginator_tags
           @template.content_for :kaminari_paginator_tags, tagify_links.join.html_safe
@@ -129,6 +82,19 @@ module Kaminari
       end
     end
 
+    # = Helpers
+    #
+    # A helper that renders the pagination links.
+    #
+    #   <%= paginate @articles %>
+    #
+    # ==== Options
+    # * <tt>:window</tt> - The "inner window" size (2 by default).
+    # * <tt>:outer_window</tt> - The "outer window" size (1 by default).
+    # * <tt>:left</tt> - The "left outer window" size (1 by default).
+    # * <tt>:right</tt> - The "right outer window" size (1 by default).
+    # * <tt>:remote</tt> - Ajax? (false by default)
+    # * <tt>:ANY_OTHER_VALUES</tt> - Any other hash key & values would be directly passed into each tag as :locals value.
     def paginate(scope, options = {}, &block)
       PaginationRenderer.new self, options.reverse_merge(:current_page => scope.current_page, :num_pages => scope.num_pages, :per_page => scope.limit_value, :remote => false)
     end

data/lib/kaminari/railtie.rb

@@ -5,7 +5,7 @@ require File.join(File.dirname(__FILE__), 'active_record')
 require File.join(File.dirname(__FILE__), 'helpers')
 
 module Kaminari
-  class Railtie < ::Rails::Railtie
+  class Railtie < ::Rails::Railtie #:nodoc:
     initializer 'paginatablize' do |app|
       ::ActiveRecord::Base.send :include, Kaminari::ActiveRecord
       ::ActionView::Base.send :include, Kaminari::Helpers

data/lib/kaminari/tags.rb

@@ -0,0 +1,115 @@
+module Kaminari
+  module Helpers
+    # A tag stands for an HTML tag inside the paginator.
+    # Basically, a tag has its own partial template file, so every tag can be
+    # rendered into String using its partial template.
+    #
+    # The template file should be placed in your app/views/kaminari/ directory
+    # with underscored class name (besides the "Tag" class. Tag is an abstract
+    # class, so _tag parital is not needed).
+    #   e.g.)  PrevLink  ->  app/views/kaminari/_prev_link.html.erb
+    #
+    # If the template file does not exist, it falls back to ancestor classes.
+    #   e.g.)  FirstPageLink  ->  app/views/kaminari/_first_page_link.html.erb
+    #                         ->  app/views/kaminari/_page_link.html.erb
+    #
+    # When no template were found in your app, finally the engine's pre insatalled
+    # template will be used.
+    #   e.g.)  Paginator  ->  $GEM_HOME/kaminari-x.x.x/app/views/kaminari/_paginator.html.erb
+    class Tag
+      def self.template_filename #:nodoc:
+        name.demodulize.underscore
+      end
+
+      def initialize(renderer, options = {}) #:nodoc:
+        @renderer, @options = renderer, renderer.options.merge(options)
+      end
+
+      def to_s(locals = {}) #:nodoc:
+        @renderer.render :partial => find_template, :locals => @options.merge(locals)
+      end
+
+      private
+      # OMG yet another super dirty hack
+      # this method finds
+      #   1. a template for the given class from app/views
+      #   2. a template for its parent class from app/views
+      #   3. the default one inside the engine
+      def find_template(klass = self.class)
+        if @renderer.resolver.find_all(*args_for_lookup(klass)).present?
+          "kaminari/#{klass.template_filename}"
+        elsif (parent = klass.ancestors[1]) == Tag
+          "kaminari/#{self.class.template_filename}"
+        else
+          find_template parent
+        end
+      end
+
+      def args_for_lookup(klass)
+        if (method = @renderer.context.method :args_for_lookup).arity == 3
+          # 3.0
+          method.call klass.template_filename, 'kaminari', true
+        else
+          # 3.1
+          method.call klass.template_filename, 'kaminari', true, []
+        end
+      end
+
+      def page_url_for(page)
+        @renderer.url_for @renderer.params.merge(:page => (page <= 1 ? nil : page))
+      end
+    end
+
+    # "Previous" without link
+    class PrevSpan < Tag
+    end
+
+    # "Previous" with link
+    class PrevLink < Tag
+      def to_s #:nodoc:
+        super :prev_url => page_url_for(@options[:current_page] - 1)
+      end
+    end
+
+    # "Next" without link
+    class NextSpan < Tag
+    end
+
+    # "Next" with link
+    class NextLink < Tag
+      def to_s #:nodoc:
+        super :next_url => page_url_for(@options[:current_page] + 1)
+      end
+    end
+
+    # A link showing page number
+    class PageLink < Tag
+      def to_s #:nodoc:
+        super :page_url => page_url_for(@options[:page])
+      end
+    end
+
+    # A non-link tag showing the current page number
+    class CurrentPage < Tag
+      def to_s #:nodoc:
+        super :page_url => page_url_for(@options[:page])
+      end
+    end
+
+    # A link with page number that appears at the leftmost
+    class FirstPageLink < PageLink
+    end
+
+    # A link with page number that appears at the rightmost
+    class LastPageLink < PageLink
+    end
+
+    # A non-link tag that stands for skipped pages...
+    class TruncatedSpan < Tag
+    end
+
+    # The container tag
+    class Paginator < Tag
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kaminari
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 61
   prerelease: 
   segments: 
   - 0
   - 9
-  - 2
-  version: 0.9.2
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Akira Matsuda
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-10 00:00:00 +09:00
+date: 2011-02-11 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -275,10 +275,6 @@ files:
 - app/views/kaminari/_truncated_span.html.haml
 - app/views/kaminari/github/_current_page.html.erb
 - app/views/kaminari/github/_current_page.html.haml
-- app/views/kaminari/github/_first_page_link.html.erb
-- app/views/kaminari/github/_first_page_link.html.haml
-- app/views/kaminari/github/_last_page_link.html.erb
-- app/views/kaminari/github/_last_page_link.html.haml
 - app/views/kaminari/github/_next_link.html.erb
 - app/views/kaminari/github/_next_link.html.haml
 - app/views/kaminari/github/_next_span.html.erb
@@ -295,10 +291,6 @@ files:
 - app/views/kaminari/github/_truncated_span.html.haml
 - app/views/kaminari/google/_current_page.html.erb
 - app/views/kaminari/google/_current_page.html.haml
-- app/views/kaminari/google/_first_page_link.html.erb
-- app/views/kaminari/google/_first_page_link.html.haml
-- app/views/kaminari/google/_last_page_link.html.erb
-- app/views/kaminari/google/_last_page_link.html.haml
 - app/views/kaminari/google/_next_link.html.erb
 - app/views/kaminari/google/_next_link.html.haml
 - app/views/kaminari/google/_next_span.html.erb
@@ -320,6 +312,7 @@ files:
 - lib/kaminari/engine.rb
 - lib/kaminari/helpers.rb
 - lib/kaminari/railtie.rb
+- lib/kaminari/tags.rb
 - spec/acceptance/acceptance_helper.rb
 - spec/acceptance/support/helpers.rb
 - spec/acceptance/support/paths.rb

data/app/views/kaminari/github/_first_page_link.html.erb

@@ -1,9 +0,0 @@
-<%# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--%>
-<%# EMPTY! %>

data/app/views/kaminari/github/_first_page_link.html.haml

@@ -1,8 +0,0 @@
--# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--# EMPTY!

data/app/views/kaminari/github/_last_page_link.html.erb

@@ -1,9 +0,0 @@
-<%# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--%>
-<%# EMPTY! %>

data/app/views/kaminari/github/_last_page_link.html.haml

@@ -1,8 +0,0 @@
--# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--# EMPTY!

data/app/views/kaminari/google/_first_page_link.html.erb

@@ -1,10 +0,0 @@
-<%# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--%>
-<%# this kind of works even though looks a bit hackish... -%>
-<%= render :partial => 'kaminari/page_link', :locals => @_partial_renderer.instance_variable_get('@locals') %>

data/app/views/kaminari/google/_first_page_link.html.haml

@@ -1,9 +0,0 @@
--# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--# this kind of works even though looks a bit hackish...
-= render :partial => 'kaminari/page_link', :locals => @_partial_renderer.instance_variable_get('@locals')

data/app/views/kaminari/google/_last_page_link.html.erb

@@ -1,10 +0,0 @@
-<%# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--%>
-<%# this kind of works even though looks a bit hackish... -%>
-<%= render :partial => 'kaminari/page_link', :locals => @_partial_renderer.instance_variable_get('@locals') %>

data/app/views/kaminari/google/_last_page_link.html.haml

@@ -1,9 +0,0 @@
--# available local variables:
-  page:          the page number of this page
-  page_url:      url to this page
-  current_page:  the page number of currently displayed page
-  num_pages:     total number of pages
-  per_page:      number of items to fetch per page
-  remote:        data-remote
--# this kind of works even though looks a bit hackish...
-= render :partial => 'kaminari/page_link', :locals => @_partial_renderer.instance_variable_get('@locals')