hanami-pagination 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 0986664b4be2c0f014eeb429da1f582bd329b527
4
+ data.tar.gz: 1d78af3d6e59e319fe8bba542eb3239b7aa28e45
5
+ SHA512:
6
+ metadata.gz: 4953cc0cd70890fc472c73a71430b791e5f9ec6e3108ccb41ffcf2f229e3b938f552f6535933e8fd3173356ad465eaa39028808c3e596c9270d79ef361f69db3
7
+ data.tar.gz: 43ccef361c6eca6aa2d9359683cfb47d62e8becb82d99df7d00c1eaadcf4fecc4e0ca48a764250988c75bb2665754eb4e44da3e27e9465abe73eb4b28f4087b6
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.travis.yml ADDED
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.0
5
+ before_install: gem install bundler -v 1.13.7
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at antondavydov.o@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in hanami-pagination.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2017 Anton Davydov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,142 @@
1
+ # Hanami::Pagination
2
+ Pagination gem for your hanami applications
3
+
4
+ ## Installation
5
+
6
+ Add this line to your application's Gemfile:
7
+
8
+ ```ruby
9
+ gem 'hanami-pagination'
10
+ ```
11
+
12
+ And then execute:
13
+
14
+ $ bundle
15
+
16
+ Or install it yourself as:
17
+
18
+ $ gem install hanami-pagination
19
+
20
+ Include pagination helpers to view and action:
21
+
22
+ ```ruby
23
+ # in action
24
+ module Web::Controllers::Books
25
+ class Index
26
+ include Web::Action
27
+
28
+ # include Pagination::Action module
29
+ include Hanami::Pagination::Action
30
+
31
+ def call(params)
32
+ ...
33
+ end
34
+ end
35
+ end
36
+ ```
37
+
38
+ ```ruby
39
+ # in view
40
+ module Web::Views::Books
41
+ class Index
42
+ include Web::View
43
+
44
+ # include Pagination::View module
45
+ include Hanami::Pagination::View
46
+ end
47
+ end
48
+ ```
49
+
50
+ After that you need to enable pagination for each repository class:
51
+ ```ruby
52
+ # in config/initializers/enable_pagination.rb
53
+ BookRepository.enable_pagination!
54
+ PostRepository.enable_pagination!
55
+ # etc
56
+ ```
57
+
58
+ ## Usage
59
+ Now you have special methods for working with pagination in your app.
60
+
61
+ ### Action
62
+ #### `all_for_page`
63
+ This helper takes rom/hanami relation and sets `pager` expose. Returns array. Example:
64
+
65
+ ```ruby
66
+ module Web::Controllers::Books
67
+ class Index
68
+ include Web::Action
69
+ include Hanami::Pagination::Action
70
+
71
+ expose :books
72
+
73
+ def call(params)
74
+ repo = BookRepository.new
75
+ @books = all_for_page(repo.all)
76
+ end
77
+ end
78
+ end
79
+ ```
80
+
81
+ Also you can set `limit` (default 100) for each action:
82
+
83
+ ```ruby
84
+ module Web::Controllers::Books
85
+ class Index
86
+ include Web::Action
87
+ include Hanami::Pagination::Action
88
+
89
+ expose :books
90
+
91
+ def call(params)
92
+ repo = BookRepository.new
93
+ @books = all_for_page(repo.all)
94
+ end
95
+
96
+ def limit
97
+ 25
98
+ end
99
+ end
100
+ end
101
+ ```
102
+
103
+ #### `pager` expose
104
+ 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:
105
+
106
+ - `next_page`
107
+ - `prev_page`
108
+ - `total`
109
+ - `next_page`
110
+ - `current_page?`
111
+ - `pages_range`
112
+ - `all_pages`
113
+ - `first_page?`
114
+ - `last_page?`
115
+
116
+
117
+ ### View
118
+ #### `next_page_url`
119
+ Returns string with url to next page. Example:
120
+
121
+ ```ruby
122
+ next_page_url # => '/books?page=3'
123
+ ```
124
+
125
+ #### `prev_page_url`
126
+ Returns string with url to prev page. Example:
127
+
128
+ ```ruby
129
+ prev_page_url # => '/books?page=1'
130
+ ```
131
+
132
+ #### `page_url(page)`
133
+ Returns string with url to specific page. Example:
134
+
135
+ ```ruby
136
+ page_url(4) # => '/books?page=4'
137
+ ```
138
+
139
+ ## License
140
+
141
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
142
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/*_test.rb']
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,29 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'hanami/pagination/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "hanami-pagination"
8
+ spec.version = Hanami::Pagination::VERSION
9
+ spec.authors = ["Anton Davydov"]
10
+ spec.email = ["antondavydov.o@gmail.com"]
11
+
12
+ spec.summary = %q{Pagination in your hanami apps}
13
+ spec.description = %q{Pagination in your hanami apps}
14
+ spec.homepage = "https://github.com/davydovanton/hanami-pagination"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
18
+ f.match(%r{^(test|spec|features)/})
19
+ end
20
+ spec.bindir = "exe"
21
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
22
+ spec.require_paths = ["lib"]
23
+
24
+ spec.add_dependency "hanami-model", "~> 1.0"
25
+
26
+ spec.add_development_dependency "bundler", "~> 1.13"
27
+ spec.add_development_dependency "rake", "~> 10.0"
28
+ spec.add_development_dependency "rspec"
29
+ end
@@ -0,0 +1,10 @@
1
+ require 'hanami/pagination/view'
2
+ require 'hanami/pagination/pager'
3
+ require 'hanami/pagination/action'
4
+ require 'hanami/pagination/version'
5
+ require 'hanami/pagination/extentions'
6
+
7
+ module Hanami
8
+ module Pagination
9
+ end
10
+ end
@@ -0,0 +1,21 @@
1
+ module Hanami
2
+ module Pagination
3
+ module Action
4
+ def self.included(action)
5
+ action.class_eval do
6
+ expose :pager
7
+ end
8
+ end
9
+
10
+ def all_for_page(relation)
11
+ relation = relation.per_page(limit).page(params[:page] || 1)
12
+ @pager = Pager.new(relation.pager)
13
+ relation.to_a
14
+ end
15
+
16
+ def limit
17
+ 100
18
+ end
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,7 @@
1
+ module Hanami
2
+ class Repository
3
+ def self.enable_pagination!
4
+ container.relation(relation).class.use(:pagination)
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,53 @@
1
+ module Hanami
2
+ module Pagination
3
+ class Pager
4
+ attr_reader :pager
5
+
6
+ def initialize(pager)
7
+ @pager = pager
8
+ end
9
+
10
+ def next_page
11
+ pager.next_page
12
+ end
13
+
14
+ def prev_page
15
+ pager.prev_page
16
+ end
17
+
18
+ def total
19
+ pager.total
20
+ end
21
+
22
+ def next_page
23
+ pager.next_page
24
+ end
25
+
26
+ def current_page?(page)
27
+ pager.current_page == page
28
+ end
29
+
30
+ def pages_range(delta: 3)
31
+ first = pager.current_page - delta
32
+ first = first > 0 ? first : 1
33
+
34
+ last = pager.current_page + delta
35
+ last = last < pager.total_pages ? last : pager.total_pages
36
+
37
+ (first..last).to_a
38
+ end
39
+
40
+ def all_pages
41
+ (1..pager.total_pages).to_a
42
+ end
43
+
44
+ def first_page?
45
+ pager.current_page == 1
46
+ end
47
+
48
+ def last_page?
49
+ pager.current_page == pager.total_pages
50
+ end
51
+ end
52
+ end
53
+ end
@@ -0,0 +1,5 @@
1
+ module Hanami
2
+ module Pagination
3
+ VERSION = "0.1.0"
4
+ end
5
+ end
@@ -0,0 +1,17 @@
1
+ module Hanami
2
+ module Pagination
3
+ module View
4
+ def next_page_url
5
+ page_url(pager.next_page)
6
+ end
7
+
8
+ def prev_page_url
9
+ page_url(pager.prev_page)
10
+ end
11
+
12
+ def page_url(page)
13
+ "#{params.env['REQUEST_PATH']}?page=#{page}"
14
+ end
15
+ end
16
+ end
17
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: hanami-pagination
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Anton Davydov
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-06-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: hanami-model
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: bundler
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '1.13'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '1.13'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '10.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '10.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rspec
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ description: Pagination in your hanami apps
70
+ email:
71
+ - antondavydov.o@gmail.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - ".gitignore"
77
+ - ".travis.yml"
78
+ - CODE_OF_CONDUCT.md
79
+ - Gemfile
80
+ - LICENSE.txt
81
+ - README.md
82
+ - Rakefile
83
+ - hanami-pagination.gemspec
84
+ - lib/hanami/pagination.rb
85
+ - lib/hanami/pagination/action.rb
86
+ - lib/hanami/pagination/extentions.rb
87
+ - lib/hanami/pagination/pager.rb
88
+ - lib/hanami/pagination/version.rb
89
+ - lib/hanami/pagination/view.rb
90
+ homepage: https://github.com/davydovanton/hanami-pagination
91
+ licenses:
92
+ - MIT
93
+ metadata: {}
94
+ post_install_message:
95
+ rdoc_options: []
96
+ require_paths:
97
+ - lib
98
+ required_ruby_version: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ required_rubygems_version: !ruby/object:Gem::Requirement
104
+ requirements:
105
+ - - ">="
106
+ - !ruby/object:Gem::Version
107
+ version: '0'
108
+ requirements: []
109
+ rubyforge_project:
110
+ rubygems_version: 2.5.1
111
+ signing_key:
112
+ specification_version: 4
113
+ summary: Pagination in your hanami apps
114
+ test_files: []