hanami-pagination 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0986664b4be2c0f014eeb429da1f582bd329b527
-  data.tar.gz: 1d78af3d6e59e319fe8bba542eb3239b7aa28e45
+  metadata.gz: aba6404915cdeb83f938c0c092062a1df5d4ce25
+  data.tar.gz: d4ef8a7276cb2231ec38f67c3c4a210fc114040d
 SHA512:
-  metadata.gz: 4953cc0cd70890fc472c73a71430b791e5f9ec6e3108ccb41ffcf2f229e3b938f552f6535933e8fd3173356ad465eaa39028808c3e596c9270d79ef361f69db3
-  data.tar.gz: 43ccef361c6eca6aa2d9359683cfb47d62e8becb82d99df7d00c1eaadcf4fecc4e0ca48a764250988c75bb2665754eb4e44da3e27e9465abe73eb4b28f4087b6
+  metadata.gz: 4423ba26ea9d10ccf6ae25bec80318dadae2c96256cbad8d551dc46f2cb7df24e081791806b7d9d33f010b31677b3e4e5970a6d24943812305f43f739cfc4672
+  data.tar.gz: 76f525ecc258ef16ab55427784fc53802afca5ff99c551d8fa3190af58907167c752f7ad6e32a19ae2b063f8347ab67b5a04ba38bd3cca16f38fcb8cb48e31f0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGES.md

@@ -0,0 +1,10 @@
+# Hanami-pagination changes
+
+HEAD
+-----------
+
+- Introduce `MockPager` class for easily testing your app
+- Introduce `pager#total_pages` for getting total pages count
+
+0.1.0
+-----------

data/README.md

@@ -1,5 +1,5 @@
 # Hanami::Pagination
-Pagination gem for your hanami applications
+Pagination gem for your hanami applications. Based on ROM::Pagination plugin.
 
 ## Installation
 
@@ -24,12 +24,10 @@ Include pagination helpers to view and action:
 module Web::Controllers::Books
   class Index
     include Web::Action
-
-    # include Pagination::Action module
     include Hanami::Pagination::Action
 
     def call(params)
-      ...
+      # ...
     end
   end
 end
@@ -40,8 +38,6 @@ end
 module Web::Views::Books
   class Index
     include Web::View
-
-    # include Pagination::View module
     include Hanami::Pagination::View
   end
 end
@@ -60,7 +56,7 @@ Now you have special methods for working with pagination in your app.
 
 ### Action
 #### `all_for_page`
-This helper takes rom/hanami relation and sets `pager` expose. Returns array. Example:
+This helper takes **only rom/hanami relation** and sets `pager` expose. Returns array. Example:
 
 ```ruby
 module Web::Controllers::Books
@@ -72,7 +68,7 @@ module Web::Controllers::Books
 
     def call(params)
       repo = BookRepository.new
-      @books = all_for_page(repo.all)
+      @books = all_for_page(repo.books)
     end
   end
 end
@@ -90,7 +86,7 @@ module Web::Controllers::Books
 
     def call(params)
       repo = BookRepository.new
-      @books = all_for_page(repo.all)
+      @books = all_for_page(repo.books)
     end
 
     def limit
@@ -106,15 +102,58 @@ When you include `Pagination::Action` to your action you get `pager` getter with
 - `next_page`
 - `prev_page`
 - `total`
-- `next_page`
+- `total_pages`
 - `current_page?`
 - `pages_range`
 - `all_pages`
 - `first_page?`
 - `last_page?`
+- `previous_page_path`
+- `next_page_path`
+- `n_page_path`
+- `paginate`
 
 
 ### View
+
+#### `paginate(page)`
+
+Returns `<nav>` tag with links to first, last and closest pages. For example:
+
+```ruby
+paginate(:items) # where `:items` is a named route
+```
+
+when there is 11 pages, will returns:
+
+```html
+<nav class="pagination">
+  <a href="/items?page=1" class="pagination-first-page">
+    1
+  </a>
+  <span class="pagination-ellipsis">
+    ...
+  </span>
+  <a href="/items?page=4" class="pagination-previous-page">
+    4
+  </a>
+  <span class="pagination-current-page">
+    5
+  </span>
+  <a href="/items?page=6" class="pagination-next-page">
+    6
+  </a>
+  <span class="pagination-ellipsis">
+    ...
+  </span>
+  <a href="/items?page=11" class="pagination-last-page">
+    11
+  </a>
+</nav>
+
+```
+Every elements has special css-classes, so it is easy to change pagination look.
+
 #### `next_page_url`
 Returns string with url to next page. Example:
 
@@ -136,7 +175,50 @@ Returns string with url to specific page. Example:
 page_url(4) # => '/books?page=4'
 ```
 
+#### `previous_page_path(page)`
+Returns string with `page` path and current `params` to prev page. Example:
+
+```ruby
+# params => { status: 'active' }
+# pager.current_page?(2) => true
+previous_page_path(:books) # => '/books?status=active&page=1'
+```
+
+#### `next_page_path(page)`
+Returns string with `page` path and current `params` to next page. Example:
+
+```ruby
+# params => { status: 'inactive' }
+# pager.current_page?(1) => true
+previous_page_path(:users) # => '/books?status=inactive&page=2'
+```
+
+#### `n_page_path(page, n)`
+Returns string with `page` path and current `params` to specific page. Example:
+
+```ruby
+# params => { status: 'active' }
+previous_page_path(:books, 10) # => '/books?status=active&page=10'
+```
+
+### Testing
+
+You can use `Hanami::Pagination::MockPager` class for testing you apps.
+
+#### View testing
+```ruby
+RSpec.describe Web::Views::Books::Show do
+  let(:mock_pager) { Hanami::Pagination::MockPager.new(current_page, total_pages) }
+  let(:pager) { Hanami::Pagination::Pager.new(mock_pager) }
+  let(:exposures) { Hash[pager: pager] }
+
+  let(:current_page) { 1 }
+  let(:total_pages) { 10 }
+
+  # ...
+end
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/hanami-pagination.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "hanami-model", "~> 1.0"
+  spec.add_dependency "hanami-helpers", "~> 1.1"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/hanami/pagination.rb

@@ -3,6 +3,7 @@ require 'hanami/pagination/pager'
 require 'hanami/pagination/action'
 require 'hanami/pagination/version'
 require 'hanami/pagination/extentions'
+require 'hanami/pagination/mock_pager'
 
 module Hanami
   module Pagination

data/lib/hanami/pagination/extentions.rb

@@ -1,7 +1,7 @@
-module Hanami
-  class Repository
-    def self.enable_pagination!
-      container.relation(relation).class.use(:pagination)
-    end
+require "hanami/repository"
+
+Hanami::Repository.class_eval do
+  def self.enable_pagination!
+    container.relations[relation].class.use(:pagination)
   end
 end

data/lib/hanami/pagination/mock_pager.rb

@@ -0,0 +1,36 @@
+module Hanami
+  module Pagination
+    class MockPager
+      attr_reader :current_page, :total_pages
+
+      def initialize(current_page, total_pages)
+        @current_page = current_page
+        @total_pages = total_pages
+      end
+
+      def next_page
+        [current_page + 1, total_pages].min
+      end
+
+      def prev_page
+        [current_page - 1, 1].max
+      end
+
+      def total
+        total_pages
+      end
+
+      def total_pages
+        @total_pages
+      end
+
+      def first_page?
+        current_page == 1
+      end
+
+      def last_page?
+        current_page == total_pages
+      end
+    end
+  end
+end

data/lib/hanami/pagination/pager.rb

@@ -19,8 +19,12 @@ module Hanami
         pager.total
       end
 
-      def next_page
-        pager.next_page
+      def total_pages
+        pager.total_pages
+      end
+
+      def current_page
+        pager.current_page
       end
 
       def current_page?(page)

data/lib/hanami/pagination/version.rb

@@ -1,5 +1,5 @@
 module Hanami
   module Pagination
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/hanami/pagination/view.rb

@@ -1,6 +1,10 @@
+require 'hanami/helpers'
+
 module Hanami
   module Pagination
     module View
+      include Hanami::Helpers
+
       def next_page_url
         page_url(pager.next_page)
       end
@@ -12,6 +16,70 @@ module Hanami
       def page_url(page)
         "#{params.env['REQUEST_PATH']}?page=#{page}"
       end
+
+      def previous_page_path(page)
+        routes.path(page, **params, page: pager.prev_page)
+      end
+
+      def next_page_path(page)
+        routes.path(page, **params, page: pager.next_page)
+      end
+
+      def n_page_path(page, n)
+        routes.path(page, **params, page: n)
+      end
+
+      def paginate(page)
+        html.nav(class: 'pagination') do
+          content = []
+
+          content << first_page_tag(page) unless pager.first_page?
+          content << ellipsis_tag if pager.current_page > 3
+          content << previous_page_tag(page) if pager.current_page > 2
+          content << current_page_tag
+          content << next_page_tag(page) if (pager.total_pages - pager.current_page) > 1
+          content << ellipsis_tag if (pager.total_pages - pager.current_page) > 3
+          content << last_page_tag(page) unless pager.last_page?
+
+          raw(content.map(&:to_s).join)
+        end
+      end
+
+      def first_page_tag(page)
+        html.a(href: n_page_path(page, 1), class: 'pagination-first-page') do
+          '1'
+        end
+      end
+
+      def previous_page_tag(page)
+        html.a(href: previous_page_path(page), class: 'pagination-previous-page') do
+          pager.prev_page
+        end
+      end
+
+      def current_page_tag
+        html.span(class: 'pagination-current-page') do
+          pager.current_page
+        end
+      end
+
+      def last_page_tag(page)
+        html.a(href: n_page_path(page, pager.total_pages), class: 'pagination-last-page') do
+          pager.total_pages
+        end
+      end
+
+      def next_page_tag(page)
+        html.a(href: next_page_path(page), class: 'pagination-next-page') do
+          pager.next_page
+        end
+      end
+
+      def ellipsis_tag
+        html.span(class: 'pagination-ellipsis') do
+          '...'
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hanami-pagination
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Davydov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-02 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-model
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hanami-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +88,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- CHANGES.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -84,6 +100,7 @@ files:
 - lib/hanami/pagination.rb
 - lib/hanami/pagination/action.rb
 - lib/hanami/pagination/extentions.rb
+- lib/hanami/pagination/mock_pager.rb
 - lib/hanami/pagination/pager.rb
 - lib/hanami/pagination/version.rb
 - lib/hanami/pagination/view.rb
@@ -107,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Pagination in your hanami apps