<commit_before>= Kaminari

A Scope & Engine based clean and powerful and customizable and sophisticated paginator for Rails 3


== Features

* Clean
Does not globally pollute Array, Hash, Object or AR::Base.

* Easy to use
Just bundle the gem, then your models are ready to be paginated. No configuration. Don't have to define anything in your models or helpers.

* Scope based simple API
Everything is method chainable with less Hasheritis. You know, that's the Rails 3 way.
No special collection class or something for the paginated values but uses a general AR::Relation instance. So, of course you can chain any other conditions before or after the paginator scope.

* Engine based customizable helper
As the whole pagination helper is basically just a collection of links and non-links, Kaminari renders each of them through its own partial template inside the Engine. So, you can easily modify their behaviour or style or whatever by overriding partial templates.

* Modern
The pagination helper outputs the HTML5 <nav> tag by default. Plus, the helper supports the Rails 3 unobtrusive Ajax.


== Rails versions

3.0.x and 3.1


== Install

Put this line in your Gemfile:
  gem 'kaminari'

Then bundle:
  % bundle


== Usage

=== Query Basics

* the :page scope
To fetch the 7th page of the users (per_page = 25 by default)
  User.page(7)

* the :per scope
To show a lot more users per each page (change the per_page value)
  User.page(7).per(50)
Note that the :per scope is not directly defined on the models but is just a method defined on the page scope. This is absolutely reasonable because you will never actually use "per_page" without specifying the "page" number.

=== Configuring default per_page value for each model

* paginates_per
You can specify default per_page value per each model using the following declarative DSL.
  class User < ActiveRecord::Base
    paginates_per 50
  end

=== Controllers

* the page parameter is in params[:page]
Typically, your controller code will look like this:
  @users = User.order(:name).page params[:page]

=== Views

* the same old helper method
Just call the "paginate" helper:
  <%= paginate @users %>

This will render several "?page=N" pagination links surrounded by an HTML5 <nav> tag.

=== Helper Options

* specifing the "inner window" size (4 by default)
This would output something like ... 5 6 7 8 9 ... when 7 is the current page.
  <%= paginate @users, :window => 2 %>

* specifing the "outer window" size (1 by default)
This would output something like 1 2 3 4 ...(snip)... 17 18 19 20 while having 20 pages in total.
  <%= paginate @users, :outer_window => 3 %>

* outer window can be separetely specified by "left", "right" (1 by default)
This would output something like 1 ...(snip)... 18 19 20 while having 20 pages in total.
  <%= paginate @users, :left => 0, :right => 2 %>

* Ajax links (crazy simple, but works perfectly!)
This would add data-remote="true" to all the links inside.
  <%= paginate @users, :remote => true %>

=== I18n and labels

The default labels for 'previous', '...' and 'next' are rendered through I18n API.
So, for example, if you want to change the "prev_label" to '<-', add it to a YAML file in your Rails.root/config/locales directory. Keys and the default values are the following.

  en:
    views:
      pagination:
        previous: "&laquo; Prev"
        next: "Next &raquo;"<commit_msg>documentation<commit_after>= Kaminari

A Scope & Engine based clean and powerful and customizable and sophisticated paginator for Rails 3


== Features

* Clean
Does not globally pollute Array, Hash, Object or AR::Base.

* Easy to use
Just bundle the gem, then your models are ready to be paginated. No configuration. Don't have to define anything in your models or helpers.

* Scope based simple API
Everything is method chainable with less "Hasheritis". You know, that's the Rails 3 way.
No special collection class or something for the paginated values but uses a general AR::Relation instance. So, of course you can chain any other conditions before or after the paginator scope.

* Engine based I18n aware customizable helper
As the whole pagination helper is basically just a collection of links and non-links, Kaminari renders each of them through its own partial template inside the Engine. So, you can easily modify their behaviour or style or whatever by overriding partial templates.

* Modern
The pagination helper outputs the HTML5 <nav> tag by default. Plus, the helper supports the Rails 3 unobtrusive Ajax.


== Rails versions

3.0.x and 3.1


== Install

Put this line in your Gemfile:
  gem 'kaminari'

Then bundle:
  % bundle


== Usage

=== Query Basics

* the :page scope
To fetch the 7th page of the users (per_page = 25 by default)
  User.page(7)

* the :per scope
To show a lot more users per each page (change the per_page value)
  User.page(7).per(50)
Note that the :per scope is not directly defined on the models but is just a method defined on the page scope. This is absolutely reasonable because you will never actually use "per_page" without specifying the "page" number.

=== Configuring default per_page value for each model

* paginates_per
You can specify default per_page value per each model using the following declarative DSL.
  class User < ActiveRecord::Base
    paginates_per 50
  end

=== Controllers

* the page parameter is in params[:page]
Typically, your controller code will look like this:
  @users = User.order(:name).page params[:page]

=== Views

* the same old helper method
Just call the "paginate" helper:
  <%= paginate @users %>

This will render several "?page=N" pagination links surrounded by an HTML5 <nav> tag.

=== Helper Options

* specifing the "inner window" size (4 by default)
This would output something like ... 5 6 7 8 9 ... when 7 is the current page.
  <%= paginate @users, :window => 2 %>

* specifing the "outer window" size (1 by default)
This would output something like 1 2 3 4 ...(snip)... 17 18 19 20 while having 20 pages in total.
  <%= paginate @users, :outer_window => 3 %>

* outer window can be separetely specified by "left", "right" (1 by default)
This would output something like 1 ...(snip)... 18 19 20 while having 20 pages in total.
  <%= paginate @users, :left => 0, :right => 2 %>

* Ajax links (crazy simple, but works perfectly!)
This would add data-remote="true" to all the links inside.
  <%= paginate @users, :remote => true %>

=== I18n and labels

The default labels for 'previous', '...' and 'next' are stored in the I18n yaml inside the engine, and rendered through I18n API. You can switch the label value per I18n.locale for your internationalized application.
Keys and the default values are the following. You can override them by adding to a YAML file in your Rails.root/config/locales directory.

  en:
    views:
      pagination:
        previous: "&laquo; Prev"
        next: "Next &raquo;"
{'fraction_non_alphanumeric': 0.07798231627772141, 'fraction_numerical': 0.0176837222785911, 'mean_word_length': 3.8832271762208066, 'pattern_counts': {'":': 0, '<': 20, '<?xml version=': 0, '>': 27, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2580863', 'n_tokens_mistral': 2056, 'n_tokens_neox': 1885, 'n_words': 1019}