actionpager 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f802c6a8d4b24b2acdef2cd58992d777ea2474ca6c87f32762f5d6a0b5ecd78b
-  data.tar.gz: 26306561adbdcf858e9ee23205806c157380a17fa3295dbf3d0ec0083013f2e1
+  metadata.gz: 876f031e85f180e04e799d237f79330a3cc0eb31a7ffde45778a46c2f1077128
+  data.tar.gz: 454bc22c406a1e108feb8b3792e187f8a6d72c25d417d7c103a5323b88a8b6f5
 SHA512:
-  metadata.gz: a684cc104adbff58048cb94eab079699eb33c555e75cf82fef2dfb9ef53f6514994b1383acfb8da4a12b6f66c6e38d0a0d4819d46345762ca672455e94435065
-  data.tar.gz: edbf8cd64f0ef6f6bd42b6403dcc63adfaaad97a12552ac64322f40eb1cadcd55fbc0da5d3e0f856048b8bb37db4cbb1227b4aa58c393b7e62272e22847e1b8a
+  metadata.gz: 0f216700001f0bd47fd43101bca418ab239407d0805159973abe37516d2d315aea19eb53948bc9a71486ed25fb31c9ac2449af5e199fccf7684e324a958611f0
+  data.tar.gz: 8b60339780300597182e3b8d041315ed8e05d57d3098d220ec5949fb1be3b0defa6167402ab404eb1b930c92fa48195b8fa503264ca5f7640a8ee426cdd00394

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionpager (0.0.3)
+    actionpager (0.0.6)
 
 GEM
   remote: https://rubygems.org/

data/README.ja.md

@@ -0,0 +1,72 @@
+# Action Pager
+
+コレクション(Array, ActiveRecord::Relationなど)で使用できるシンプルで軽量なページネーターです。
+
+## 特徴
+
+- シンプルな`pager`オブジェクトがページネーションで使用されます。
+  - 元のコレクションを汚染しません。
+- 他のGem (Kaminari, Will Paginateなど)に比べるとメモリ消費が非常に少ないです。
+- カスタマイズが簡単です。
+  - ページネーターのビューとヘルパのファイルがアプリ内に生成されます。
+  - 用途に応じてカスタマイズできます。
+
+## インストール
+
+アプリケーションのGemfile以下の行を追加します。
+
+```ruby
+gem "actionpager"
+```
+
+以下を実行します。
+
+    $ bundle
+
+または、以下のようにインストールします。
+
+    $ gem install actionpager
+
+Railsで使用するには以下のコマンドを実行します
+
+    $ rails g action_pager:install
+
+2つのファイルが生成され、カスタマイズすることができます。
+
+- `app/helpers/action_pager/pagination_helper.rb`
+- `app/views/action_pager/_pager.html.erb`
+
+## 使い方
+
+シンプルな配列で使う場合
+
+```ruby
+collection = (1..128).to_a
+pager = ActionPager::Pager.new(collection, page: 3, per: 10)
+
+pager.current_collection # => [21, ..., 30]
+```
+
+ActiveRecordのコレクションで使う場合
+
+```ruby
+resources = Book.recent_published
+@pager = ActionPager::Pager.new(resources, page: 2, per: 25)
+@books = pager.current_collection
+```
+
+Railsのビューでページャーを表示するには、以下のようにコードを記述します。
+
+```erb
+<%= render_pager @pager %>
+```
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Actionpager project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/actionpager/blob/master/CODE_OF_CONDUCT.md).

data/README.md

@@ -1,6 +1,15 @@
 # Action Pager
 
-Simple and lightweight paginator for collections (Array, ActiveRecord::Relation etc.)
+Simple, lightweight and easy to customize paginator for collections (Array, ActiveRecord::Relation etc.)
+
+# Features
+
+- A simple `pager` object is used for pagination.
+  - It does not pollute the original collection.
+- Consumes less memory than other gems (i.e. Kaminari, Will Paginate etc.).
+- Easy to customize.
+  - Paginator view and helper files are generated in your app.
+  - You can customize for your own purpose.
 
 ## Installation
 
@@ -18,9 +27,40 @@ Or install it yourself as:
 
     $ gem install actionpager
 
+Use with Rails
+
+    $ rails g action_pager:install
+
+It generates two files and you can customize.
+
+- `app/helpers/action_pager/pagination_helper.rb`
+- `app/views/action_pager/_pager.html.erb`
+
 ## Usage
 
-TODO: Write usage instructions here
+Use with a simple array:
+
+```ruby
+collection = (1..128).to_a
+pager = ActionPager::Pager.new(collection, page: 3, per: 10)
+
+pager.current_collection # => [21, ..., 30]
+```
+
+Use with an ActiveRecord collection
+
+```ruby
+resources = Book.recent_published
+@pager = ActionPager::Pager.new(resources, page: 2, per: 25)
+@books = pager.current_collection
+```
+
+To show the pager in your Rails app's view, add code like below:
+
+```erb
+<%= render_pager @pager %>
+```
+
 
 ## License
 

data/lib/action_pager/pager.rb

@@ -20,7 +20,8 @@ module ActionPager
       current_collection
     end
 
-    def current_collection
+    def collection_at(page)
+      offset = offset_at(page)
       if collection.is_a?(Array)
         collection.drop(offset).first(per_page)
       else # for ActiveRecord::Relation and other OR mapper collections
@@ -28,8 +29,48 @@ module ActionPager
       end
     end
 
-    def offset
-      (current_page - 1) * per_page
+    def current_collection
+      collection_at(current_page)
+    end
+
+    def first_collection
+      collection_at(first_page)
+    end
+
+    def last_collection
+      collection_at(last_page)
+    end
+
+    def prev_collection
+      collection_at(prev_page)
+    end
+
+    def next_collection
+      collection_at(next_page)
+    end
+
+    def offset_at(page)
+      (page - 1) * per_page
+    end
+
+    def current_offset
+      offset_at(current_page)
+    end
+
+    def first_offset
+      offset_at(first_page)
+    end
+
+    def last_offset
+      offset_at(last_page)
+    end
+
+    def prev_offset
+      offset_at(prev_page)
+    end
+
+    def next_offset
+      offset_at(next_page)
     end
 
     def collection_count

data/lib/action_pager/pagination.rb

@@ -0,0 +1,14 @@
+module ActionPager
+  module Pagination
+    DEFAULTS = { page: 1, per: 5 }.freeze
+
+    def pager_for(collection, options={})
+      opts = DEFAULTS.merge(options.reject { |_k, v| v.to_i.zero? })
+      ActionPager::Pager.new(
+        collection,
+        page: opts[:page].to_i,
+        per: opts[:per].to_i
+      )
+    end
+  end
+end

data/lib/action_pager/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionPager
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/actionpager.rb

@@ -2,3 +2,4 @@
 
 require "action_pager/version"
 require "action_pager/pager"
+require "action_pager/pagination"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionpager
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,10 +65,12 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.ja.md
 - README.md
 - Rakefile
 - actionpager.gemspec
 - lib/action_pager/pager.rb
+- lib/action_pager/pagination.rb
 - lib/action_pager/version.rb
 - lib/actionpager.rb
 - lib/generators/action_pager/install_generator.rb