hanami-pagination 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0986664b4be2c0f014eeb429da1f582bd329b527
+  data.tar.gz: 1d78af3d6e59e319fe8bba542eb3239b7aa28e45
+SHA512:
+  metadata.gz: 4953cc0cd70890fc472c73a71430b791e5f9ec6e3108ccb41ffcf2f229e3b938f552f6535933e8fd3173356ad465eaa39028808c3e596c9270d79ef361f69db3
+  data.tar.gz: 43ccef361c6eca6aa2d9359683cfb47d62e8becb82d99df7d00c1eaadcf4fecc4e0ca48a764250988c75bb2665754eb4e44da3e27e9465abe73eb4b28f4087b6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.7

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at antondavydov.o@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hanami-pagination.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Anton Davydov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# Hanami::Pagination
+Pagination gem for your hanami applications
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hanami-pagination'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hanami-pagination
+
+Include pagination helpers to view and action:
+
+```ruby
+# in action
+module Web::Controllers::Books
+  class Index
+    include Web::Action
+
+    # include Pagination::Action module
+    include Hanami::Pagination::Action
+
+    def call(params)
+      ...
+    end
+  end
+end
+```
+
+```ruby
+# in view
+module Web::Views::Books
+  class Index
+    include Web::View
+
+    # include Pagination::View module
+    include Hanami::Pagination::View
+  end
+end
+```
+
+After that you need to enable pagination for each repository class:
+```ruby
+# in config/initializers/enable_pagination.rb
+BookRepository.enable_pagination!
+PostRepository.enable_pagination!
+# etc
+```
+
+## Usage
+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:
+
+```ruby
+module Web::Controllers::Books
+  class Index
+    include Web::Action
+    include Hanami::Pagination::Action
+
+    expose :books
+
+    def call(params)
+      repo = BookRepository.new
+      @books = all_for_page(repo.all)
+    end
+  end
+end
+```
+
+Also you can set `limit` (default 100) for each action:
+
+```ruby
+module Web::Controllers::Books
+  class Index
+    include Web::Action
+    include Hanami::Pagination::Action
+
+    expose :books
+
+    def call(params)
+      repo = BookRepository.new
+      @books = all_for_page(repo.all)
+    end
+
+    def limit
+      25
+    end
+  end
+end
+```
+
+#### `pager` expose
+When you include `Pagination::Action` to your action you get `pager` getter with `Hanami::Pagination::Pager` instance. Please check source code for this class. In future I'll add full documentation. Now we support this methods:
+
+- `next_page`
+- `prev_page`
+- `total`
+- `next_page`
+- `current_page?`
+- `pages_range`
+- `all_pages`
+- `first_page?`
+- `last_page?`
+
+
+### View
+#### `next_page_url`
+Returns string with url to next page. Example:
+
+```ruby
+next_page_url # => '/books?page=3'
+```
+
+#### `prev_page_url`
+Returns string with url to prev page. Example:
+
+```ruby
+prev_page_url # => '/books?page=1'
+```
+
+#### `page_url(page)`
+Returns string with url to specific page. Example:
+
+```ruby
+page_url(4) # => '/books?page=4'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/hanami-pagination.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hanami/pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-pagination"
+  spec.version       = Hanami::Pagination::VERSION
+  spec.authors       = ["Anton Davydov"]
+  spec.email         = ["antondavydov.o@gmail.com"]
+
+  spec.summary       = %q{Pagination in your hanami apps}
+  spec.description   = %q{Pagination in your hanami apps}
+  spec.homepage      = "https://github.com/davydovanton/hanami-pagination"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hanami-model", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/hanami/pagination.rb

@@ -0,0 +1,10 @@
+require 'hanami/pagination/view'
+require 'hanami/pagination/pager'
+require 'hanami/pagination/action'
+require 'hanami/pagination/version'
+require 'hanami/pagination/extentions'
+
+module Hanami
+  module Pagination
+  end
+end

data/lib/hanami/pagination/action.rb

@@ -0,0 +1,21 @@
+module Hanami
+  module Pagination
+    module Action
+      def self.included(action)
+        action.class_eval do
+          expose :pager
+        end
+      end
+
+      def all_for_page(relation)
+        relation = relation.per_page(limit).page(params[:page] || 1)
+        @pager = Pager.new(relation.pager)
+        relation.to_a
+      end
+
+      def limit
+        100
+      end
+    end
+  end
+end

data/lib/hanami/pagination/extentions.rb

@@ -0,0 +1,7 @@
+module Hanami
+  class Repository
+    def self.enable_pagination!
+      container.relation(relation).class.use(:pagination)
+    end
+  end
+end

data/lib/hanami/pagination/pager.rb

@@ -0,0 +1,53 @@
+module Hanami
+  module Pagination
+    class Pager
+      attr_reader :pager
+
+      def initialize(pager)
+        @pager = pager
+      end
+
+      def next_page
+        pager.next_page
+      end
+
+      def prev_page
+        pager.prev_page
+      end
+
+      def total
+        pager.total
+      end
+
+      def next_page
+        pager.next_page
+      end
+
+      def current_page?(page)
+        pager.current_page == page
+      end
+
+      def pages_range(delta: 3)
+        first = pager.current_page - delta
+        first = first > 0 ? first : 1
+
+        last = pager.current_page + delta
+        last = last < pager.total_pages ? last : pager.total_pages
+
+        (first..last).to_a
+      end
+
+      def all_pages
+        (1..pager.total_pages).to_a
+      end
+
+      def first_page?
+        pager.current_page == 1
+      end
+
+      def last_page?
+        pager.current_page == pager.total_pages
+      end
+    end
+  end
+end

data/lib/hanami/pagination/version.rb

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

data/lib/hanami/pagination/view.rb

@@ -0,0 +1,17 @@
+module Hanami
+  module Pagination
+    module View
+      def next_page_url
+        page_url(pager.next_page)
+      end
+
+      def prev_page_url
+        page_url(pager.prev_page)
+      end
+
+      def page_url(page)
+        "#{params.env['REQUEST_PATH']}?page=#{page}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: hanami-pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Davydov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hanami-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pagination in your hanami apps
+email:
+- antondavydov.o@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hanami-pagination.gemspec
+- lib/hanami/pagination.rb
+- lib/hanami/pagination/action.rb
+- lib/hanami/pagination/extentions.rb
+- lib/hanami/pagination/pager.rb
+- lib/hanami/pagination/version.rb
+- lib/hanami/pagination/view.rb
+homepage: https://github.com/davydovanton/hanami-pagination
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Pagination in your hanami apps
+test_files: []