actionpager 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f802c6a8d4b24b2acdef2cd58992d777ea2474ca6c87f32762f5d6a0b5ecd78b
-  data.tar.gz: 26306561adbdcf858e9ee23205806c157380a17fa3295dbf3d0ec0083013f2e1
+  metadata.gz: 99b07f8d0f856295de69abdfe86ec10ca9bfbe04fcf3b9de3b290727e85cb25f
+  data.tar.gz: 5005c6fabe8b1b7dba2ce2787cb36bfaeb4ff44710e635bc8372e54307027f91
 SHA512:
-  metadata.gz: a684cc104adbff58048cb94eab079699eb33c555e75cf82fef2dfb9ef53f6514994b1383acfb8da4a12b6f66c6e38d0a0d4819d46345762ca672455e94435065
-  data.tar.gz: edbf8cd64f0ef6f6bd42b6403dcc63adfaaad97a12552ac64322f40eb1cadcd55fbc0da5d3e0f856048b8bb37db4cbb1227b4aa58c393b7e62272e22847e1b8a
+  metadata.gz: 87d74558a627912d6fb96fd5e3558d3109fa204345e9125359532cbacb6fc4536c105707a78c054b14c73fba4f23bd0d2764e2649f4dec06b52f4867f022eca4
+  data.tar.gz: ff05082a9c4cd7d02e6a9dafb80be0e6710f88b78ae52613212cd8c346ae18bf122dba495eec0f10a9df38dd9be5b5d7150ceddfb8b95cab630d4fdf963b0a17

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/Gemfile.lock

@@ -1,22 +1,43 @@
 PATH
   remote: .
   specs:
-    actionpager (0.0.3)
+    actionpager (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.11.3)
-    rake (10.5.0)
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    rake (13.0.1)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   actionpager!
-  bundler (~> 1.16)
+  activerecord (>= 5.2)
+  bundler (>= 1.16)
   minitest (~> 5.0)
-  rake (~> 10.0)
+  rake (>= 12.3.3)
+  sqlite3 (~> 1.4)
 
 BUNDLED WITH
-   1.17.1
+   2.1.4

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 Ryo Hashimoto
+Copyright (c) 2018-2020 Ryo Hashimoto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.ja.md

@@ -0,0 +1,73 @@
+# 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`
+
+標準では、Bootstrap 4のページネーションのスタイルを使用しています。
+必要であれば、生成されたファイルをカスタマイズしてください。
+
+## 使い方
+
+シンプルな配列で使う場合
+
+```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,43 @@ 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`
+
+By default, it uses Bootstrap 4 pagination for styles.
+If you need, you can easily customize the generated file.
+
 ## 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/RELEASE_DATE

@@ -0,0 +1 @@
+2020-10-12

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/actionpager.gemspec

@@ -1,11 +1,13 @@
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "action_pager/version"
+version = File.read(File.expand_path("VERSION", __dir__)).strip
+date = File.read(File.expand_path("RELEASE_DATE", __dir__)).strip
 
 Gem::Specification.new do |spec|
   spec.name          = "actionpager"
-  spec.version       = ActionPager::VERSION
+  spec.version       = version
+  spec.date          = date
   spec.authors       = ["Ryo Hashimoto"]
   spec.email         = ["ryohashimoto@gmail.com"]
 
@@ -21,7 +23,9 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.16"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "activerecord", ">= 5.2"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
 end

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/actionpager.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require "action_pager/version"
 require "action_pager/pager"
+require "action_pager/pagination"

data/lib/generators/action_pager/templates/app/views/action_pager/_pager.html.erb

@@ -1,37 +1,39 @@
-<ul class="pagination">
-  <% unless pager.first_page? -%>
-    <li>
-      <%= link_to url_for_page(page: pager.first_page) do %>
-        &laquo;
-      <% end -%>
-    </li>
-    <li>
-      <%= link_to url_for_page(page: pager.prev_page), rel: "prev" do %>
-        &lsaquo;
-      <% end -%>
-    </li>
-  <% end -%>
-  <% (1..(pager.last_page)).to_a.each do |page| -%>
-    <% if pager.current_page == page -%>
-      <li class="active">
-        <%= link_to page, url_for_page(page: page) -%>
+<nav>
+  <ul class="pagination">
+    <% unless pager.first_page? -%>
+      <li class="page-item">
+        <%= link_to url_for_page(page: pager.first_page), class: "page-link" do %>
+          &laquo;
+        <% end -%>
       </li>
-    <% else -%>
-      <li>
-        <%= link_to page, url_for_page(page: page) -%>
+      <li class="page-item">
+        <%= link_to url_for_page(page: pager.prev_page), class: "page-link", rel: "prev" do %>
+          &lsaquo;
+        <% end -%>
       </li>
     <% end -%>
-  <% end -%>
-  <% unless pager.last_page? -%>
-    <li>
-      <%= link_to url_for_page(page: pager.next_page), rel: "next" do -%>
-        &rsaquo;
+    <% pager.near_pages.each do |page| -%>
+      <% if pager.current_page == page -%>
+        <li class="page-item active">
+          <%= link_to page, url_for_page(page: page), class: "page-link" -%>
+        </li>
+      <% else -%>
+        <li class="page-item">
+          <%= link_to page, url_for_page(page: page), class: "page-link" -%>
+        </li>
       <% end -%>
-    </li>
-    <li>
-      <%= link_to url_for_page(page: pager.last_page) do -%>
-        &raquo;
-      <% end -%>
-    </li>
-  <% end -%>
-</ul>
+    <% end -%>
+    <% unless pager.last_page? -%>
+      <li class="page-item">
+        <%= link_to url_for_page(page: pager.next_page), rel: "next", class: "page-link" do -%>
+          &rsaquo;
+        <% end -%>
+      </li>
+      <li class="page-item">
+        <%= link_to url_for_page(page: pager.last_page), class: "page-link" do -%>
+          &raquo;
+        <% end -%>
+      </li>
+    <% end -%>
+  </ul>
+</nav>

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: actionpager
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: Simple and lightweight paginator for collections (Array, ActiveRecord::Relation
   etc.)
 email:
@@ -65,11 +93,14 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
+- README.ja.md
 - README.md
+- RELEASE_DATE
 - Rakefile
+- VERSION
 - actionpager.gemspec
 - lib/action_pager/pager.rb
-- lib/action_pager/version.rb
+- lib/action_pager/pagination.rb
 - lib/actionpager.rb
 - lib/generators/action_pager/install_generator.rb
 - lib/generators/action_pager/templates/app/helpers/action_pager/pagination_helper.rb
@@ -93,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Simple and lightweight paginator

data/lib/action_pager/version.rb

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