westfield_paginator 1.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/ISSUE_TEMPLATE +16 -0
- data/.github/PULL_REQUEST_TEMPLATE +19 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +11 -0
- data/Gemfile +4 -0
- data/LICENSE +201 -0
- data/README.md +52 -0
- data/Rakefile +7 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/contributing.md +13 -0
- data/lib/westfield_paginator.rb +5 -0
- data/lib/westfield_paginator/config.rb +40 -0
- data/lib/westfield_paginator/page_info.rb +25 -0
- data/lib/westfield_paginator/paginator.rb +43 -0
- data/lib/westfield_paginator/paginator_meta.rb +19 -0
- data/lib/westfield_paginator/version.rb +3 -0
- data/westfield_paginator.gemspec +29 -0
- metadata +156 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c443cdb869b05c5b74a36a84d6f0cb0c874f13cc
|
4
|
+
data.tar.gz: 104d7c3eca82b98c5657529bf94b9838cf9f12da
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: '078657c50f9fe154a5ddf808e061945ae6da3d51a20cb522a24f4075bc5e1a5a7031abcc172f1fef33f4e1df287ec0972dd0e7538c42ca9f536bbd7ce2e7169a'
|
7
|
+
data.tar.gz: '069bde3eb9f26815809cd98d600cd364dc7f12bb7b0864813a0c0f0b1a3ea44e10731d5897d4be7451bec4f27b9638d2d01fc50ea7d49296449e328a0953f4af'
|
@@ -0,0 +1,16 @@
|
|
1
|
+
### Expected/Desired Behavior:
|
2
|
+
< Description of the expected or desired behavior including an example >
|
3
|
+
|
4
|
+
### Current Behavior:
|
5
|
+
< Description of the current behavior being encountered including an example >
|
6
|
+
|
7
|
+
### Impact:
|
8
|
+
- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
|
9
|
+
- Was a regression introduced(if bug)?
|
10
|
+
- Urgency(low, medium, high)?
|
11
|
+
- Teams impacted?(web, ios, android, maps, etc)
|
12
|
+
|
13
|
+
### Requirements:
|
14
|
+
- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
|
15
|
+
|
16
|
+
cc: @two_ @team_members
|
@@ -0,0 +1,19 @@
|
|
1
|
+
### Issue:
|
2
|
+
[JIRA-0000](http://link_to_ticket.com)
|
3
|
+
|
4
|
+
### Proposed Changes:
|
5
|
+
< Description of the proposed change and its value. If possible also include a usage example and relative links to provide additional context for the reviewer>
|
6
|
+
|
7
|
+
### Impact:
|
8
|
+
- Will this introduce any externally facing changes(endpoint, fields, validation, query)?
|
9
|
+
- Any special deployment coordination needed(env changes, data/db migrations, etc.)?
|
10
|
+
- Urgency(low, medium, high)?
|
11
|
+
- Teams impacted(web, ios, android, maps, etc)?
|
12
|
+
|
13
|
+
### Requirements:
|
14
|
+
- Add Tests to cover changes
|
15
|
+
- Update Swagger documentation if applicable
|
16
|
+
- Update repo documentation if applicable(readme, wiki)
|
17
|
+
- Label as "Bug Fix", "Feature" or "Optimization"(Tech Debt)
|
18
|
+
|
19
|
+
cc: @two_ @team_members
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "{}"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright {yyyy} {name of copyright owner}
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,52 @@
|
|
1
|
+
# Westfield Paginator
|
2
|
+
_Created by Zhenya Mirkin_ (@emirkin)
|
3
|
+
|
4
|
+
This gem provides a common way to paginate results
|
5
|
+
|
6
|
+
## Installation
|
7
|
+
|
8
|
+
Add this line to your application's _Gemfile_:
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
gem 'westfield_paginator', git: "https://#{github_auth}@github.com/westfield/westfield_paginator.git", require: false # _github_auth_ is the basic auth string authorizing access to the repository
|
12
|
+
```
|
13
|
+
|
14
|
+
And then execute:
|
15
|
+
|
16
|
+
```sh
|
17
|
+
$ bundle install
|
18
|
+
```
|
19
|
+
|
20
|
+
## Usage
|
21
|
+
|
22
|
+
The most common pattern is:
|
23
|
+
```ruby
|
24
|
+
# Wrap paginator around your full set of records
|
25
|
+
paginator = Westfield::Paginator.new(retailers, page: params[:page], per_page: params[:per_page])
|
26
|
+
# Wrap paginator around your full set of records, leave page and per_page params empty to use default values
|
27
|
+
paginator = Westfield::Paginator.new(retailers)
|
28
|
+
# Possibly perform transformation on the records to be returned
|
29
|
+
data = paginator.paginated_records.map { |retailer| do_something_with_retailer }
|
30
|
+
# Return results
|
31
|
+
render json: api_response(data: data, meta: paginator.meta)
|
32
|
+
# meta contains: page, page_count, total_pages, per_page
|
33
|
+
```
|
34
|
+
|
35
|
+
If you need to generate only the meta portion and don't need to paginate records, you can use the following:
|
36
|
+
```ruby
|
37
|
+
# some_object must respond to the following methods:
|
38
|
+
# current_page, per_page, total_pages, total_count
|
39
|
+
paginator_meta = Westfield::PaginatorMeta.new(some_object)
|
40
|
+
render json: api_response(data: data, meta: paginator_meta.as_json)
|
41
|
+
```
|
42
|
+
|
43
|
+
## Overriding configuration options
|
44
|
+
|
45
|
+
The default per page value is 10 and the default maximum per page value is 100 (as specified in `lib/westfield_paginator/config.rb`). These values can be overridden by adding the following to a configuration file in the `config/initializers` directory:
|
46
|
+
|
47
|
+
```ruby
|
48
|
+
# Configures global settings for pagination
|
49
|
+
Westfield::Paginator.configure do |config|
|
50
|
+
config.default_per_page = 10
|
51
|
+
end
|
52
|
+
```
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "westfield_paginator"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
require "pry"
|
11
|
+
Pry.start
|
12
|
+
|
13
|
+
#require "irb"
|
14
|
+
#IRB.start
|
data/bin/setup
ADDED
data/contributing.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
## Contributing
|
2
|
+
|
3
|
+
0. Raise an issue in this project outlining the change you'd like to make. You'll need the `issue_number`
|
4
|
+
1. Fork this project into your own Github account
|
5
|
+
2. Create your feature branch (`git checkout -b {issue_number}_my-new-feature`)
|
6
|
+
4. Push to the branch (`git push -u origin {issue_number}_my-new-feature`)
|
7
|
+
5. Write RSpec tests to formalise the outcomes of your change
|
8
|
+
6. Write the code to implement the changes, ensuring that the tests eventually pass
|
9
|
+
7. Commit your changes (`git commit -am '{issue_number} Added some feature'`)
|
10
|
+
8. Push to the branch (`git push -u origin my-new-feature`)
|
11
|
+
9. Create a new Pull Request using Github's built-in mechanisms.
|
12
|
+
10. Wait for a code review to come back, or an approval.
|
13
|
+
11. Either go back and fix whatever the reviewers recommend, or watch and smile as your PR gets merged in and you become part of software development history.
|
@@ -0,0 +1,40 @@
|
|
1
|
+
require 'active_support/configurable'
|
2
|
+
|
3
|
+
# taken from https://github.com/amatsuda/kaminari/blob/master/lib/kaminari/config.rb
|
4
|
+
module Westfield
|
5
|
+
class Paginator
|
6
|
+
# Configures global settings for pagination
|
7
|
+
# Westfield::Paginator.configure do |config|
|
8
|
+
# config.default_per_page = 10
|
9
|
+
# end
|
10
|
+
def self.configure(&block)
|
11
|
+
yield @config ||= Westfield::Paginator::Configuration.new
|
12
|
+
end
|
13
|
+
|
14
|
+
# Global settings for Westfield::Paginator
|
15
|
+
def self.config
|
16
|
+
@config
|
17
|
+
end
|
18
|
+
|
19
|
+
# need a Class for 3.0
|
20
|
+
class Configuration
|
21
|
+
include ActiveSupport::Configurable
|
22
|
+
config_accessor :default_per_page
|
23
|
+
config_accessor :max_per_page
|
24
|
+
|
25
|
+
def param_name
|
26
|
+
config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
|
27
|
+
end
|
28
|
+
|
29
|
+
# define param_name writer (copied from AS::Configurable)
|
30
|
+
writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
|
31
|
+
singleton_class.class_eval writer, __FILE__, line
|
32
|
+
class_eval writer, __FILE__, line
|
33
|
+
end
|
34
|
+
|
35
|
+
configure do |config|
|
36
|
+
config.default_per_page = 10
|
37
|
+
config.max_per_page = 100
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
require 'active_support'
|
2
|
+
require 'active_support/core_ext'
|
3
|
+
|
4
|
+
module Westfield
|
5
|
+
class PageInfo
|
6
|
+
attr_reader :page, :per_page
|
7
|
+
|
8
|
+
# max_per_page is a caller-friendly way to set a cap on the maximum
|
9
|
+
# number of results. Otherwise, the caller would have to say:
|
10
|
+
# "per_page: [(params[:per_page] || 10), 10].min"
|
11
|
+
def initialize(page: nil, per_page: nil, max_per_page: nil)
|
12
|
+
# initialize to the default value on nil or ""
|
13
|
+
page = 1 if page.blank?
|
14
|
+
|
15
|
+
# initialize to the default value on nil or ""
|
16
|
+
per_page = Westfield::Paginator.config.default_per_page if per_page.blank?
|
17
|
+
|
18
|
+
# initialize to the default value on nil or ""
|
19
|
+
max_per_page = Westfield::Paginator.config.max_per_page if max_per_page.blank?
|
20
|
+
|
21
|
+
@per_page = [per_page.to_i, max_per_page].min
|
22
|
+
@page = page
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,43 @@
|
|
1
|
+
require 'kaminari'
|
2
|
+
require 'kaminari/models/array_extension'
|
3
|
+
|
4
|
+
module Westfield
|
5
|
+
class Paginator
|
6
|
+
def initialize(records, page: nil, per_page: nil, max_per_page: nil)
|
7
|
+
@page_info = Westfield::PageInfo.new(page: page, per_page: per_page, max_per_page: max_per_page)
|
8
|
+
|
9
|
+
if records.is_a? Array
|
10
|
+
@records = Kaminari.paginate_array(records)
|
11
|
+
else
|
12
|
+
@records = records
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def paginated_records
|
17
|
+
@paginated ||= @records.page(page_info.page).per(page_info.per_page)
|
18
|
+
end
|
19
|
+
|
20
|
+
def meta
|
21
|
+
PaginatorMeta.new(self).as_json
|
22
|
+
end
|
23
|
+
|
24
|
+
def current_page
|
25
|
+
paginated_records.current_page
|
26
|
+
end
|
27
|
+
|
28
|
+
def per_page
|
29
|
+
page_info.per_page
|
30
|
+
end
|
31
|
+
|
32
|
+
def total_pages
|
33
|
+
paginated_records.total_pages
|
34
|
+
end
|
35
|
+
|
36
|
+
def total_count
|
37
|
+
paginated_records.total_count
|
38
|
+
end
|
39
|
+
|
40
|
+
private
|
41
|
+
attr_reader :page_info
|
42
|
+
end
|
43
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
module Westfield
|
2
|
+
class PaginatorMeta
|
3
|
+
def initialize(paginator)
|
4
|
+
@paginator = paginator
|
5
|
+
end
|
6
|
+
|
7
|
+
def as_json
|
8
|
+
{
|
9
|
+
page: paginator.current_page,
|
10
|
+
per_page: paginator.per_page,
|
11
|
+
page_count: paginator.total_pages,
|
12
|
+
total: paginator.total_count
|
13
|
+
}
|
14
|
+
end
|
15
|
+
|
16
|
+
private
|
17
|
+
attr_reader :paginator
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
require_relative 'lib/westfield_paginator/version'
|
3
|
+
|
4
|
+
Gem::Specification.new do |spec|
|
5
|
+
spec.name = 'westfield_paginator'
|
6
|
+
spec.version = Westfield::VERSION
|
7
|
+
spec.authors = ['Zhenya Mirkin', 'George Shaw']
|
8
|
+
spec.email = ['gshaw@westfield.com']
|
9
|
+
|
10
|
+
spec.summary = 'A common gem for pagination'
|
11
|
+
spec.description = 'A common gem for pagination'
|
12
|
+
spec.homepage = 'https://www.github.com/westfieldlabs/westfield_paginator'
|
13
|
+
spec.license = 'Apache 2.0'
|
14
|
+
|
15
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
16
|
+
spec.bindir = 'bin'
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.require_paths = ['lib']
|
19
|
+
|
20
|
+
spec.required_ruby_version = '>= 2.2.2'
|
21
|
+
|
22
|
+
spec.add_dependency 'bundler'
|
23
|
+
spec.add_dependency 'rake'
|
24
|
+
spec.add_dependency 'kaminari'
|
25
|
+
spec.add_dependency 'activesupport', '>= 4.2', '< 5.1'
|
26
|
+
|
27
|
+
spec.add_development_dependency 'rspec'
|
28
|
+
spec.add_development_dependency 'pry'
|
29
|
+
end
|
metadata
ADDED
@@ -0,0 +1,156 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: westfield_paginator
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.0.6
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Zhenya Mirkin
|
8
|
+
- George Shaw
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2017-06-09 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
requirements:
|
18
|
+
- - ">="
|
19
|
+
- !ruby/object:Gem::Version
|
20
|
+
version: '0'
|
21
|
+
type: :runtime
|
22
|
+
prerelease: false
|
23
|
+
version_requirements: !ruby/object:Gem::Requirement
|
24
|
+
requirements:
|
25
|
+
- - ">="
|
26
|
+
- !ruby/object:Gem::Version
|
27
|
+
version: '0'
|
28
|
+
- !ruby/object:Gem::Dependency
|
29
|
+
name: rake
|
30
|
+
requirement: !ruby/object:Gem::Requirement
|
31
|
+
requirements:
|
32
|
+
- - ">="
|
33
|
+
- !ruby/object:Gem::Version
|
34
|
+
version: '0'
|
35
|
+
type: :runtime
|
36
|
+
prerelease: false
|
37
|
+
version_requirements: !ruby/object:Gem::Requirement
|
38
|
+
requirements:
|
39
|
+
- - ">="
|
40
|
+
- !ruby/object:Gem::Version
|
41
|
+
version: '0'
|
42
|
+
- !ruby/object:Gem::Dependency
|
43
|
+
name: kaminari
|
44
|
+
requirement: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - ">="
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '0'
|
49
|
+
type: :runtime
|
50
|
+
prerelease: false
|
51
|
+
version_requirements: !ruby/object:Gem::Requirement
|
52
|
+
requirements:
|
53
|
+
- - ">="
|
54
|
+
- !ruby/object:Gem::Version
|
55
|
+
version: '0'
|
56
|
+
- !ruby/object:Gem::Dependency
|
57
|
+
name: activesupport
|
58
|
+
requirement: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: '4.2'
|
63
|
+
- - "<"
|
64
|
+
- !ruby/object:Gem::Version
|
65
|
+
version: '5.1'
|
66
|
+
type: :runtime
|
67
|
+
prerelease: false
|
68
|
+
version_requirements: !ruby/object:Gem::Requirement
|
69
|
+
requirements:
|
70
|
+
- - ">="
|
71
|
+
- !ruby/object:Gem::Version
|
72
|
+
version: '4.2'
|
73
|
+
- - "<"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '5.1'
|
76
|
+
- !ruby/object:Gem::Dependency
|
77
|
+
name: rspec
|
78
|
+
requirement: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
type: :development
|
84
|
+
prerelease: false
|
85
|
+
version_requirements: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - ">="
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '0'
|
90
|
+
- !ruby/object:Gem::Dependency
|
91
|
+
name: pry
|
92
|
+
requirement: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - ">="
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '0'
|
97
|
+
type: :development
|
98
|
+
prerelease: false
|
99
|
+
version_requirements: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
description: A common gem for pagination
|
105
|
+
email:
|
106
|
+
- gshaw@westfield.com
|
107
|
+
executables:
|
108
|
+
- console
|
109
|
+
- setup
|
110
|
+
extensions: []
|
111
|
+
extra_rdoc_files: []
|
112
|
+
files:
|
113
|
+
- ".github/ISSUE_TEMPLATE"
|
114
|
+
- ".github/PULL_REQUEST_TEMPLATE"
|
115
|
+
- ".gitignore"
|
116
|
+
- ".rspec"
|
117
|
+
- ".travis.yml"
|
118
|
+
- Gemfile
|
119
|
+
- LICENSE
|
120
|
+
- README.md
|
121
|
+
- Rakefile
|
122
|
+
- bin/console
|
123
|
+
- bin/setup
|
124
|
+
- contributing.md
|
125
|
+
- lib/westfield_paginator.rb
|
126
|
+
- lib/westfield_paginator/config.rb
|
127
|
+
- lib/westfield_paginator/page_info.rb
|
128
|
+
- lib/westfield_paginator/paginator.rb
|
129
|
+
- lib/westfield_paginator/paginator_meta.rb
|
130
|
+
- lib/westfield_paginator/version.rb
|
131
|
+
- westfield_paginator.gemspec
|
132
|
+
homepage: https://www.github.com/westfieldlabs/westfield_paginator
|
133
|
+
licenses:
|
134
|
+
- Apache 2.0
|
135
|
+
metadata: {}
|
136
|
+
post_install_message:
|
137
|
+
rdoc_options: []
|
138
|
+
require_paths:
|
139
|
+
- lib
|
140
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
141
|
+
requirements:
|
142
|
+
- - ">="
|
143
|
+
- !ruby/object:Gem::Version
|
144
|
+
version: 2.2.2
|
145
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
146
|
+
requirements:
|
147
|
+
- - ">="
|
148
|
+
- !ruby/object:Gem::Version
|
149
|
+
version: '0'
|
150
|
+
requirements: []
|
151
|
+
rubyforge_project:
|
152
|
+
rubygems_version: 2.6.10
|
153
|
+
signing_key:
|
154
|
+
specification_version: 4
|
155
|
+
summary: A common gem for pagination
|
156
|
+
test_files: []
|