Kaminari

Kaminari (雷) is a paginating tool written in Ruby. gem compatible with Rails versions 3.0 thunder. It was developed by Akira Matsuda[1] along with Yuki Nishijima,[2] Zachary Scott,[3] Hiroshi Shibata[4] in 2011.[5][6]

Kaminari
DeveloperAkira Matsuda, Yuki Nishijima, Zachary Scott, Hiroshi Shibata
First appearedFeb 6, 2011
Stable release
0.16.2 / January 20, 2015
OSCross-platform
LicenseMIT license
Websitekaminari on GitHub

History
雷 (kaminari, kannari, ikazuchi, narukami, rai): thunder.

The first commit to the Git repository was made by Akira Matsuda on February 5, 2011 with the comment "Initial commit to kaminari."[7] On February 6, 2011 he released the first version 0.1.0, with the commit comment "Version bump to 0.1.0".[8] The latest stable release is 0.16.2 available from January 20, 2015.[9]

Features

[10]

User-friendly

Just by bundling the gem, the models of the project can be paginated without the need for any configurations.The page function just needs to be called inside the controller.

Clean

Kaminari doesn't pollute the global namespace while using Array, Hash, Object or ActiveRecord::Base.

Simple scope based

Kaminari can be used with just an instance of the class ActiveRecord::Relation without the use of any special class, module or anything for the paginated values. It also supports method chaining and chaining can be done before or after the pagination scope. An exception to this behavior is that the per method needs to be called after the page method as the page method creates its scope.[11]

Wide support

Kaminari has active support for various ORMs like Active Record, Mongoid.[12] It also supports web-frameworks like Rails, Sinatra, Grape and template engines like eRuby, Haml, Slim.[13]

HTML5 integration

Kaminari is actively updated and as such it has support for HTML5. It outputs the HTML <nav> tag by default.

Supported software/languages

[14]

  • Ruby 1.8.7, 1.9.2, 1.9.3, 2.0.0, 2.1.x, 2.2.x
  • Rails 3.0, 3.1, 3.2, 4.0, 4.1, 4.2
  • Sinatra 1.4
  • Haml 3+
  • Mongoid 2+

References
  1. "amatsuda (Akira Matsuda)". GitHub.
  2. "yuki24 (Yuki Nishijima)". GitHub.
  3. "zzak (Zachary Scott)". GitHub.
  4. "hsbt (SHIBATA Hiroshi)". GitHub.
  5. "All versions of kaminari | RubyGems.org | your community gem host". rubygems.org. Retrieved 2015-09-15.
  6. "kaminari | RubyGems.org | your community gem host". rubygems.org. Retrieved 2015-09-15.
  7. "Initial commit to kaminari. · amatsuda/kaminari@4db3397". GitHub. Retrieved 2015-09-15.
  8. "Version bump to 0.1.0 · amatsuda/kaminari@e1bd7b7". GitHub. Retrieved 2015-09-15.
  9. "amatsuda/kaminari". GitHub. Retrieved 2015-09-15.
  10. "kaminari/README.rdoc". GitHub. Archived from the original on 2014-08-27. Retrieved 2015-09-15.
  11. "ASCIIcasts - "Episode 254 - Pagination with Kaminari"". asciicasts.com. Archived from the original on 2015-09-26. Retrieved 2015-09-16.
  12. "Mongoid". GitHub.
  13. "Slim Template Language". GitHub.
  14. "kaminari/README.rdoc". GitHub. Archived from the original on 2014-08-27. Retrieved 2015-09-15.
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.