yap 0.1.1 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +340 -0
- data/README.md +126 -0
- data/lib/yap/column_mapper.rb +12 -0
- data/lib/yap/exceptions.rb +5 -0
- data/lib/yap/filterable.rb +81 -0
- data/lib/yap.rb +27 -27
- metadata +9 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f4209a6b39a6416deb044ff771ee02c69ca4a4aa
|
|
4
|
+
data.tar.gz: 263b674a929599199a7834784e6c8952ae98bc78
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0f09333d7565e16f89b1f6ed11df04dfaeadc772fcb5e6bc9af9d805592ddfc6d15f3855742fd6170fcf94b50bca1571c3cbd55ff1d4bca14aa4e9eb1583f97e
|
|
7
|
+
data.tar.gz: 9d3f5de083c85b3ad493f93bcfd669a0f29e06d0a3dd693bec90ad124dc29a33043c10dfe5b52d82472eb41e3f9c8389a24cdfa80e647d114776c9995b1bf07a
|
data/LICENSE
ADDED
|
@@ -0,0 +1,340 @@
|
|
|
1
|
+
GNU GENERAL PUBLIC LICENSE
|
|
2
|
+
Version 2, June 1991
|
|
3
|
+
|
|
4
|
+
Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
|
|
5
|
+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
6
|
+
Everyone is permitted to copy and distribute verbatim copies
|
|
7
|
+
of this license document, but changing it is not allowed.
|
|
8
|
+
|
|
9
|
+
Preamble
|
|
10
|
+
|
|
11
|
+
The licenses for most software are designed to take away your
|
|
12
|
+
freedom to share and change it. By contrast, the GNU General Public
|
|
13
|
+
License is intended to guarantee your freedom to share and change free
|
|
14
|
+
software--to make sure the software is free for all its users. This
|
|
15
|
+
General Public License applies to most of the Free Software
|
|
16
|
+
Foundation's software and to any other program whose authors commit to
|
|
17
|
+
using it. (Some other Free Software Foundation software is covered by
|
|
18
|
+
the GNU Lesser General Public License instead.) You can apply it to
|
|
19
|
+
your programs, too.
|
|
20
|
+
|
|
21
|
+
When we speak of free software, we are referring to freedom, not
|
|
22
|
+
price. Our General Public Licenses are designed to make sure that you
|
|
23
|
+
have the freedom to distribute copies of free software (and charge for
|
|
24
|
+
this service if you wish), that you receive source code or can get it
|
|
25
|
+
if you want it, that you can change the software or use pieces of it
|
|
26
|
+
in new free programs; and that you know you can do these things.
|
|
27
|
+
|
|
28
|
+
To protect your rights, we need to make restrictions that forbid
|
|
29
|
+
anyone to deny you these rights or to ask you to surrender the rights.
|
|
30
|
+
These restrictions translate to certain responsibilities for you if you
|
|
31
|
+
distribute copies of the software, or if you modify it.
|
|
32
|
+
|
|
33
|
+
For example, if you distribute copies of such a program, whether
|
|
34
|
+
gratis or for a fee, you must give the recipients all the rights that
|
|
35
|
+
you have. You must make sure that they, too, receive or can get the
|
|
36
|
+
source code. And you must show them these terms so they know their
|
|
37
|
+
rights.
|
|
38
|
+
|
|
39
|
+
We protect your rights with two steps: (1) copyright the software, and
|
|
40
|
+
(2) offer you this license which gives you legal permission to copy,
|
|
41
|
+
distribute and/or modify the software.
|
|
42
|
+
|
|
43
|
+
Also, for each author's protection and ours, we want to make certain
|
|
44
|
+
that everyone understands that there is no warranty for this free
|
|
45
|
+
software. If the software is modified by someone else and passed on, we
|
|
46
|
+
want its recipients to know that what they have is not the original, so
|
|
47
|
+
that any problems introduced by others will not reflect on the original
|
|
48
|
+
authors' reputations.
|
|
49
|
+
|
|
50
|
+
Finally, any free program is threatened constantly by software
|
|
51
|
+
patents. We wish to avoid the danger that redistributors of a free
|
|
52
|
+
program will individually obtain patent licenses, in effect making the
|
|
53
|
+
program proprietary. To prevent this, we have made it clear that any
|
|
54
|
+
patent must be licensed for everyone's free use or not licensed at all.
|
|
55
|
+
|
|
56
|
+
The precise terms and conditions for copying, distribution and
|
|
57
|
+
modification follow.
|
|
58
|
+
|
|
59
|
+
GNU GENERAL PUBLIC LICENSE
|
|
60
|
+
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
|
61
|
+
|
|
62
|
+
0. This License applies to any program or other work which contains
|
|
63
|
+
a notice placed by the copyright holder saying it may be distributed
|
|
64
|
+
under the terms of this General Public License. The "Program", below,
|
|
65
|
+
refers to any such program or work, and a "work based on the Program"
|
|
66
|
+
means either the Program or any derivative work under copyright law:
|
|
67
|
+
that is to say, a work containing the Program or a portion of it,
|
|
68
|
+
either verbatim or with modifications and/or translated into another
|
|
69
|
+
language. (Hereinafter, translation is included without limitation in
|
|
70
|
+
the term "modification".) Each licensee is addressed as "you".
|
|
71
|
+
|
|
72
|
+
Activities other than copying, distribution and modification are not
|
|
73
|
+
covered by this License; they are outside its scope. The act of
|
|
74
|
+
running the Program is not restricted, and the output from the Program
|
|
75
|
+
is covered only if its contents constitute a work based on the
|
|
76
|
+
Program (independent of having been made by running the Program).
|
|
77
|
+
Whether that is true depends on what the Program does.
|
|
78
|
+
|
|
79
|
+
1. You may copy and distribute verbatim copies of the Program's
|
|
80
|
+
source code as you receive it, in any medium, provided that you
|
|
81
|
+
conspicuously and appropriately publish on each copy an appropriate
|
|
82
|
+
copyright notice and disclaimer of warranty; keep intact all the
|
|
83
|
+
notices that refer to this License and to the absence of any warranty;
|
|
84
|
+
and give any other recipients of the Program a copy of this License
|
|
85
|
+
along with the Program.
|
|
86
|
+
|
|
87
|
+
You may charge a fee for the physical act of transferring a copy, and
|
|
88
|
+
you may at your option offer warranty protection in exchange for a fee.
|
|
89
|
+
|
|
90
|
+
2. You may modify your copy or copies of the Program or any portion
|
|
91
|
+
of it, thus forming a work based on the Program, and copy and
|
|
92
|
+
distribute such modifications or work under the terms of Section 1
|
|
93
|
+
above, provided that you also meet all of these conditions:
|
|
94
|
+
|
|
95
|
+
a) You must cause the modified files to carry prominent notices
|
|
96
|
+
stating that you changed the files and the date of any change.
|
|
97
|
+
|
|
98
|
+
b) You must cause any work that you distribute or publish, that in
|
|
99
|
+
whole or in part contains or is derived from the Program or any
|
|
100
|
+
part thereof, to be licensed as a whole at no charge to all third
|
|
101
|
+
parties under the terms of this License.
|
|
102
|
+
|
|
103
|
+
c) If the modified program normally reads commands interactively
|
|
104
|
+
when run, you must cause it, when started running for such
|
|
105
|
+
interactive use in the most ordinary way, to print or display an
|
|
106
|
+
announcement including an appropriate copyright notice and a
|
|
107
|
+
notice that there is no warranty (or else, saying that you provide
|
|
108
|
+
a warranty) and that users may redistribute the program under
|
|
109
|
+
these conditions, and telling the user how to view a copy of this
|
|
110
|
+
License. (Exception: if the Program itself is interactive but
|
|
111
|
+
does not normally print such an announcement, your work based on
|
|
112
|
+
the Program is not required to print an announcement.)
|
|
113
|
+
|
|
114
|
+
These requirements apply to the modified work as a whole. If
|
|
115
|
+
identifiable sections of that work are not derived from the Program,
|
|
116
|
+
and can be reasonably considered independent and separate works in
|
|
117
|
+
themselves, then this License, and its terms, do not apply to those
|
|
118
|
+
sections when you distribute them as separate works. But when you
|
|
119
|
+
distribute the same sections as part of a whole which is a work based
|
|
120
|
+
on the Program, the distribution of the whole must be on the terms of
|
|
121
|
+
this License, whose permissions for other licensees extend to the
|
|
122
|
+
entire whole, and thus to each and every part regardless of who wrote it.
|
|
123
|
+
|
|
124
|
+
Thus, it is not the intent of this section to claim rights or contest
|
|
125
|
+
your rights to work written entirely by you; rather, the intent is to
|
|
126
|
+
exercise the right to control the distribution of derivative or
|
|
127
|
+
collective works based on the Program.
|
|
128
|
+
|
|
129
|
+
In addition, mere aggregation of another work not based on the Program
|
|
130
|
+
with the Program (or with a work based on the Program) on a volume of
|
|
131
|
+
a storage or distribution medium does not bring the other work under
|
|
132
|
+
the scope of this License.
|
|
133
|
+
|
|
134
|
+
3. You may copy and distribute the Program (or a work based on it,
|
|
135
|
+
under Section 2) in object code or executable form under the terms of
|
|
136
|
+
Sections 1 and 2 above provided that you also do one of the following:
|
|
137
|
+
|
|
138
|
+
a) Accompany it with the complete corresponding machine-readable
|
|
139
|
+
source code, which must be distributed under the terms of Sections
|
|
140
|
+
1 and 2 above on a medium customarily used for software interchange; or,
|
|
141
|
+
|
|
142
|
+
b) Accompany it with a written offer, valid for at least three
|
|
143
|
+
years, to give any third party, for a charge no more than your
|
|
144
|
+
cost of physically performing source distribution, a complete
|
|
145
|
+
machine-readable copy of the corresponding source code, to be
|
|
146
|
+
distributed under the terms of Sections 1 and 2 above on a medium
|
|
147
|
+
customarily used for software interchange; or,
|
|
148
|
+
|
|
149
|
+
c) Accompany it with the information you received as to the offer
|
|
150
|
+
to distribute corresponding source code. (This alternative is
|
|
151
|
+
allowed only for noncommercial distribution and only if you
|
|
152
|
+
received the program in object code or executable form with such
|
|
153
|
+
an offer, in accord with Subsection b above.)
|
|
154
|
+
|
|
155
|
+
The source code for a work means the preferred form of the work for
|
|
156
|
+
making modifications to it. For an executable work, complete source
|
|
157
|
+
code means all the source code for all modules it contains, plus any
|
|
158
|
+
associated interface definition files, plus the scripts used to
|
|
159
|
+
control compilation and installation of the executable. However, as a
|
|
160
|
+
special exception, the source code distributed need not include
|
|
161
|
+
anything that is normally distributed (in either source or binary
|
|
162
|
+
form) with the major components (compiler, kernel, and so on) of the
|
|
163
|
+
operating system on which the executable runs, unless that component
|
|
164
|
+
itself accompanies the executable.
|
|
165
|
+
|
|
166
|
+
If distribution of executable or object code is made by offering
|
|
167
|
+
access to copy from a designated place, then offering equivalent
|
|
168
|
+
access to copy the source code from the same place counts as
|
|
169
|
+
distribution of the source code, even though third parties are not
|
|
170
|
+
compelled to copy the source along with the object code.
|
|
171
|
+
|
|
172
|
+
4. You may not copy, modify, sublicense, or distribute the Program
|
|
173
|
+
except as expressly provided under this License. Any attempt
|
|
174
|
+
otherwise to copy, modify, sublicense or distribute the Program is
|
|
175
|
+
void, and will automatically terminate your rights under this License.
|
|
176
|
+
However, parties who have received copies, or rights, from you under
|
|
177
|
+
this License will not have their licenses terminated so long as such
|
|
178
|
+
parties remain in full compliance.
|
|
179
|
+
|
|
180
|
+
5. You are not required to accept this License, since you have not
|
|
181
|
+
signed it. However, nothing else grants you permission to modify or
|
|
182
|
+
distribute the Program or its derivative works. These actions are
|
|
183
|
+
prohibited by law if you do not accept this License. Therefore, by
|
|
184
|
+
modifying or distributing the Program (or any work based on the
|
|
185
|
+
Program), you indicate your acceptance of this License to do so, and
|
|
186
|
+
all its terms and conditions for copying, distributing or modifying
|
|
187
|
+
the Program or works based on it.
|
|
188
|
+
|
|
189
|
+
6. Each time you redistribute the Program (or any work based on the
|
|
190
|
+
Program), the recipient automatically receives a license from the
|
|
191
|
+
original licensor to copy, distribute or modify the Program subject to
|
|
192
|
+
these terms and conditions. You may not impose any further
|
|
193
|
+
restrictions on the recipients' exercise of the rights granted herein.
|
|
194
|
+
You are not responsible for enforcing compliance by third parties to
|
|
195
|
+
this License.
|
|
196
|
+
|
|
197
|
+
7. If, as a consequence of a court judgment or allegation of patent
|
|
198
|
+
infringement or for any other reason (not limited to patent issues),
|
|
199
|
+
conditions are imposed on you (whether by court order, agreement or
|
|
200
|
+
otherwise) that contradict the conditions of this License, they do not
|
|
201
|
+
excuse you from the conditions of this License. If you cannot
|
|
202
|
+
distribute so as to satisfy simultaneously your obligations under this
|
|
203
|
+
License and any other pertinent obligations, then as a consequence you
|
|
204
|
+
may not distribute the Program at all. For example, if a patent
|
|
205
|
+
license would not permit royalty-free redistribution of the Program by
|
|
206
|
+
all those who receive copies directly or indirectly through you, then
|
|
207
|
+
the only way you could satisfy both it and this License would be to
|
|
208
|
+
refrain entirely from distribution of the Program.
|
|
209
|
+
|
|
210
|
+
If any portion of this section is held invalid or unenforceable under
|
|
211
|
+
any particular circumstance, the balance of the section is intended to
|
|
212
|
+
apply and the section as a whole is intended to apply in other
|
|
213
|
+
circumstances.
|
|
214
|
+
|
|
215
|
+
It is not the purpose of this section to induce you to infringe any
|
|
216
|
+
patents or other property right claims or to contest validity of any
|
|
217
|
+
such claims; this section has the sole purpose of protecting the
|
|
218
|
+
integrity of the free software distribution system, which is
|
|
219
|
+
implemented by public license practices. Many people have made
|
|
220
|
+
generous contributions to the wide range of software distributed
|
|
221
|
+
through that system in reliance on consistent application of that
|
|
222
|
+
system; it is up to the author/donor to decide if he or she is willing
|
|
223
|
+
to distribute software through any other system and a licensee cannot
|
|
224
|
+
impose that choice.
|
|
225
|
+
|
|
226
|
+
This section is intended to make thoroughly clear what is believed to
|
|
227
|
+
be a consequence of the rest of this License.
|
|
228
|
+
|
|
229
|
+
8. If the distribution and/or use of the Program is restricted in
|
|
230
|
+
certain countries either by patents or by copyrighted interfaces, the
|
|
231
|
+
original copyright holder who places the Program under this License
|
|
232
|
+
may add an explicit geographical distribution limitation excluding
|
|
233
|
+
those countries, so that distribution is permitted only in or among
|
|
234
|
+
countries not thus excluded. In such case, this License incorporates
|
|
235
|
+
the limitation as if written in the body of this License.
|
|
236
|
+
|
|
237
|
+
9. The Free Software Foundation may publish revised and/or new versions
|
|
238
|
+
of the General Public License from time to time. Such new versions will
|
|
239
|
+
be similar in spirit to the present version, but may differ in detail to
|
|
240
|
+
address new problems or concerns.
|
|
241
|
+
|
|
242
|
+
Each version is given a distinguishing version number. If the Program
|
|
243
|
+
specifies a version number of this License which applies to it and "any
|
|
244
|
+
later version", you have the option of following the terms and conditions
|
|
245
|
+
either of that version or of any later version published by the Free
|
|
246
|
+
Software Foundation. If the Program does not specify a version number of
|
|
247
|
+
this License, you may choose any version ever published by the Free Software
|
|
248
|
+
Foundation.
|
|
249
|
+
|
|
250
|
+
10. If you wish to incorporate parts of the Program into other free
|
|
251
|
+
programs whose distribution conditions are different, write to the author
|
|
252
|
+
to ask for permission. For software which is copyrighted by the Free
|
|
253
|
+
Software Foundation, write to the Free Software Foundation; we sometimes
|
|
254
|
+
make exceptions for this. Our decision will be guided by the two goals
|
|
255
|
+
of preserving the free status of all derivatives of our free software and
|
|
256
|
+
of promoting the sharing and reuse of software generally.
|
|
257
|
+
|
|
258
|
+
NO WARRANTY
|
|
259
|
+
|
|
260
|
+
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
|
261
|
+
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
|
262
|
+
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
|
263
|
+
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
|
264
|
+
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
265
|
+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
|
266
|
+
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
|
267
|
+
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
|
268
|
+
REPAIR OR CORRECTION.
|
|
269
|
+
|
|
270
|
+
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
271
|
+
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
|
272
|
+
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
273
|
+
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
|
274
|
+
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
|
275
|
+
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
|
276
|
+
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
|
277
|
+
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
|
278
|
+
POSSIBILITY OF SUCH DAMAGES.
|
|
279
|
+
|
|
280
|
+
END OF TERMS AND CONDITIONS
|
|
281
|
+
|
|
282
|
+
How to Apply These Terms to Your New Programs
|
|
283
|
+
|
|
284
|
+
If you develop a new program, and you want it to be of the greatest
|
|
285
|
+
possible use to the public, the best way to achieve this is to make it
|
|
286
|
+
free software which everyone can redistribute and change under these terms.
|
|
287
|
+
|
|
288
|
+
To do so, attach the following notices to the program. It is safest
|
|
289
|
+
to attach them to the start of each source file to most effectively
|
|
290
|
+
convey the exclusion of warranty; and each file should have at least
|
|
291
|
+
the "copyright" line and a pointer to where the full notice is found.
|
|
292
|
+
|
|
293
|
+
{description}
|
|
294
|
+
Copyright (C) {year} {fullname}
|
|
295
|
+
|
|
296
|
+
This program is free software; you can redistribute it and/or modify
|
|
297
|
+
it under the terms of the GNU General Public License as published by
|
|
298
|
+
the Free Software Foundation; either version 2 of the License, or
|
|
299
|
+
(at your option) any later version.
|
|
300
|
+
|
|
301
|
+
This program is distributed in the hope that it will be useful,
|
|
302
|
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
303
|
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
304
|
+
GNU General Public License for more details.
|
|
305
|
+
|
|
306
|
+
You should have received a copy of the GNU General Public License along
|
|
307
|
+
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
308
|
+
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
309
|
+
|
|
310
|
+
Also add information on how to contact you by electronic and paper mail.
|
|
311
|
+
|
|
312
|
+
If the program is interactive, make it output a short notice like this
|
|
313
|
+
when it starts in an interactive mode:
|
|
314
|
+
|
|
315
|
+
Gnomovision version 69, Copyright (C) year name of author
|
|
316
|
+
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
317
|
+
This is free software, and you are welcome to redistribute it
|
|
318
|
+
under certain conditions; type `show c' for details.
|
|
319
|
+
|
|
320
|
+
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
321
|
+
parts of the General Public License. Of course, the commands you use may
|
|
322
|
+
be called something other than `show w' and `show c'; they could even be
|
|
323
|
+
mouse-clicks or menu items--whatever suits your program.
|
|
324
|
+
|
|
325
|
+
You should also get your employer (if you work as a programmer) or your
|
|
326
|
+
school, if any, to sign a "copyright disclaimer" for the program, if
|
|
327
|
+
necessary. Here is a sample; alter the names:
|
|
328
|
+
|
|
329
|
+
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
|
330
|
+
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
|
331
|
+
|
|
332
|
+
{signature of Ty Coon}, 1 April 1989
|
|
333
|
+
Ty Coon, President of Vice
|
|
334
|
+
|
|
335
|
+
This General Public License does not permit incorporating your program into
|
|
336
|
+
proprietary programs. If your program is a subroutine library, you may
|
|
337
|
+
consider it more useful to permit linking proprietary applications with the
|
|
338
|
+
library. If this is what you want to do, use the GNU Lesser General
|
|
339
|
+
Public License instead of this License.
|
|
340
|
+
|
data/README.md
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# yap v0.2.1
|
|
2
|
+
|
|
3
|
+
Yet another paginator for Ruby on Rails, which adds a `paginate` scope to your ActiveRecords.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
Include `Yap` into your models to add the `paginate` scope like so:
|
|
8
|
+
|
|
9
|
+
class User < ActiveRecord::Base
|
|
10
|
+
include Yap
|
|
11
|
+
belongs_to :team
|
|
12
|
+
end
|
|
13
|
+
|
|
14
|
+
##### Defaults (optional)
|
|
15
|
+
|
|
16
|
+
To setup default parameters call `Yap.configure`. You can access the defaults as block parameter. Call this somewhere in
|
|
17
|
+
`config/initializers/`.
|
|
18
|
+
|
|
19
|
+
Yap.configure do |defaults|
|
|
20
|
+
defaults.page = 1
|
|
21
|
+
defaults.per_page = 10
|
|
22
|
+
defaults.sort = 'id'
|
|
23
|
+
defaults.direction = 'ASC'
|
|
24
|
+
defaults.disable_warnings = false
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
The above settings will be applied if you do not set your own.
|
|
28
|
+
|
|
29
|
+
##### Custom Naming (optional)
|
|
30
|
+
|
|
31
|
+
ActiveRecords can implement the method map_name_to_column to define aliases for columns. This can be useful to hide
|
|
32
|
+
internal naming from users and to make sorting by associations possible (more on this below).
|
|
33
|
+
|
|
34
|
+
COLUMN_MAP = {
|
|
35
|
+
'team' => 'teams.name',
|
|
36
|
+
'birthday' => 'date_of_birth'
|
|
37
|
+
}
|
|
38
|
+
def self.map_name_to_column(name)
|
|
39
|
+
return COLUMN_MAP[name]
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
## Usage
|
|
43
|
+
|
|
44
|
+
### Basics
|
|
45
|
+
|
|
46
|
+
Assuming you included `Yap` into `User`, you can now do something like this:
|
|
47
|
+
|
|
48
|
+
User.paginate # => Page 1 with default order and size.
|
|
49
|
+
User.paginate(
|
|
50
|
+
page: 1,
|
|
51
|
+
per_page: 10,
|
|
52
|
+
sort: 'id',
|
|
53
|
+
direction: 'ASC'
|
|
54
|
+
) # => Invocation with custom options.
|
|
55
|
+
|
|
56
|
+
User.last_page # => Last page as a number for defaults
|
|
57
|
+
User.last_page(params) # => Last page for given params. Works the same way as paginate.
|
|
58
|
+
|
|
59
|
+
User.filter('gender' => 'f') # => All female users.
|
|
60
|
+
User.filter(
|
|
61
|
+
'team_id' => '1,2',
|
|
62
|
+
'gender' => 'm'
|
|
63
|
+
) # => All males of teams 1 and 2.
|
|
64
|
+
User.filter('team_id' => '!null') # => All users with any team.
|
|
65
|
+
User.paginate(
|
|
66
|
+
page: 1,
|
|
67
|
+
filter: { 'team' => 'null' }
|
|
68
|
+
) # => Combining filter and pagination.
|
|
69
|
+
|
|
70
|
+
User.paginate(params) # => Passing parameters in controller (http://localhost/users?filter[gender]=f)
|
|
71
|
+
|
|
72
|
+
Yap will convert strings to symbols or numbers and vice versa where necessary. This make the last one a really powerful
|
|
73
|
+
method of offering the pagination API directly to the user.
|
|
74
|
+
|
|
75
|
+
### Advanced
|
|
76
|
+
|
|
77
|
+
The "team" alias defined in the column map above allows us to sort the results by the name of the team a user belongs
|
|
78
|
+
to. "teams.name" describes the "teams" table and the "name" column in our database. We need to join the team
|
|
79
|
+
association to make this work. Example:
|
|
80
|
+
|
|
81
|
+
User.joins(:team).paginate(sort: 'team')
|
|
82
|
+
|
|
83
|
+
## Error Handling
|
|
84
|
+
|
|
85
|
+
If an option cannot be parsed it will raise `Yap::PaginationError` or `Yap::FilterError`, which are both
|
|
86
|
+
`Yap::YapError`s. I suggest to use `rescue_from` in the controller to handle such a case.
|
|
87
|
+
|
|
88
|
+
rescue_from Yap::YapError, with: :handle_yap_error
|
|
89
|
+
|
|
90
|
+
def handle_yap_error
|
|
91
|
+
# generate user friendly error here, set flash[:error] or whatever you like.
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
## Full Example
|
|
95
|
+
|
|
96
|
+
require 'yap'
|
|
97
|
+
|
|
98
|
+
class User < ActiveRecord::Base
|
|
99
|
+
include Yap
|
|
100
|
+
belongs_to :team
|
|
101
|
+
|
|
102
|
+
COLUMN_MAP = {
|
|
103
|
+
'team' => 'teams.name',
|
|
104
|
+
'birthday' => 'date_of_birth'
|
|
105
|
+
}
|
|
106
|
+
def self.map_name_to_column(name)
|
|
107
|
+
return COLUMN_MAP[name]
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
class UsersController < ApplicationController
|
|
112
|
+
rescue_from Yap::YapError, with: :handle_yap_error
|
|
113
|
+
|
|
114
|
+
def handle_yap_error
|
|
115
|
+
# generate user friendly error here, set flash[:error] or whatever you like.
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
def index
|
|
119
|
+
respond_with User.joins(:team).paginate(params)
|
|
120
|
+
end
|
|
121
|
+
end
|
|
122
|
+
|
|
123
|
+
## ToDos
|
|
124
|
+
|
|
125
|
+
* Methods for generating next, previous and last page links
|
|
126
|
+
* Maximum for per_page
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
module ColumnMapper
|
|
2
|
+
private
|
|
3
|
+
|
|
4
|
+
def map_column(name)
|
|
5
|
+
column_names.include?(name) ? name : if respond_to? :map_name_to_column
|
|
6
|
+
map_name_to_column(name)
|
|
7
|
+
else
|
|
8
|
+
warn "#{self.name} does not implement map_name_to_column. If you do not need column mapping set disable_warnings=true" unless Yap::DEFAULTS.disable_warnings
|
|
9
|
+
nil
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
require 'active_support/concern'
|
|
2
|
+
require 'yap/exceptions'
|
|
3
|
+
require 'yap/column_mapper'
|
|
4
|
+
|
|
5
|
+
##
|
|
6
|
+
# ActiveRecords can be filtered by their attributes if either Yap or Filterable is included into the model. Filters can
|
|
7
|
+
# be applied through the filter or paginate scope. Multiple filters for the same attribute can be separated by comma,
|
|
8
|
+
# negative filters have a leading exclamation mark (!) and 'null' will be translated to the NULL value.
|
|
9
|
+
#
|
|
10
|
+
# User.filter('gender' => 'f') # => All female users.
|
|
11
|
+
# User.filter(
|
|
12
|
+
# 'team_id' => '1,2',
|
|
13
|
+
# 'gender' => 'm'
|
|
14
|
+
# ) # => All males of teams 1 and 2.
|
|
15
|
+
# User.filter('team_id' => '!null') # => All users with any team.
|
|
16
|
+
# User.paginate(params) # => Passing parameters in controller (http://localhost/users?filter[gender]=f)
|
|
17
|
+
# User.paginate(
|
|
18
|
+
# page: 1,
|
|
19
|
+
# filter: { 'team' => 'null' }
|
|
20
|
+
# ) # => Combining filter and pagination.
|
|
21
|
+
#
|
|
22
|
+
module Yap
|
|
23
|
+
module Filterable
|
|
24
|
+
extend ActiveSupport::Concern
|
|
25
|
+
|
|
26
|
+
included do
|
|
27
|
+
extend ColumnMapper
|
|
28
|
+
|
|
29
|
+
##
|
|
30
|
+
# Filter scope can be invoked explicitly or implicitly by passing :filter to paginate.
|
|
31
|
+
#
|
|
32
|
+
# @param [Hash] Attribute/value pairs to filter ( { 'gender' => 'f' } )
|
|
33
|
+
#
|
|
34
|
+
scope :filter, -> (params = nil) {
|
|
35
|
+
if params.blank?
|
|
36
|
+
all
|
|
37
|
+
else
|
|
38
|
+
filter = extract_filter_params(params)
|
|
39
|
+
where(filter[:where]).where.not(filter[:not])
|
|
40
|
+
end
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
private
|
|
44
|
+
|
|
45
|
+
def self.extract_filter_params(params)
|
|
46
|
+
filter = {
|
|
47
|
+
where: {},
|
|
48
|
+
not: {}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
failed = []
|
|
52
|
+
params.each do |key, values|
|
|
53
|
+
column = map_column(key.to_s.downcase)
|
|
54
|
+
if column
|
|
55
|
+
values.to_s.split(',').each do |value|
|
|
56
|
+
# Perform negative match if value starts with '!'.
|
|
57
|
+
if value =~/^!(.+)$/
|
|
58
|
+
match = :not
|
|
59
|
+
value = $1
|
|
60
|
+
else
|
|
61
|
+
match = :where
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# Ensure filter contains an array to append to.
|
|
65
|
+
filter[match][column] ||= []
|
|
66
|
+
|
|
67
|
+
# Convert null to ruby nil to use 'IS NULL' in SQL.
|
|
68
|
+
filter[match][column] << (value.downcase == 'null' ? nil : value)
|
|
69
|
+
end
|
|
70
|
+
else
|
|
71
|
+
failed << key
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
raise FilterError.new('Cannot filter by: ' + failed.join(', ')) unless failed.empty?
|
|
76
|
+
|
|
77
|
+
filter
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
end
|
|
81
|
+
end
|
data/lib/yap.rb
CHANGED
|
@@ -1,22 +1,29 @@
|
|
|
1
1
|
require 'active_support/concern'
|
|
2
|
+
require 'yap/exceptions'
|
|
3
|
+
require 'yap/column_mapper'
|
|
4
|
+
require 'yap/filterable'
|
|
2
5
|
|
|
3
6
|
##
|
|
4
|
-
#
|
|
5
|
-
#
|
|
7
|
+
# Support for Active Record pagination. All options can be safely accessed by the user through url query parameters. To
|
|
8
|
+
# get the number of the last page call the last_page method with the same parameters as the pagination.
|
|
6
9
|
#
|
|
7
|
-
# User.paginate
|
|
8
|
-
# User.paginate(params)
|
|
10
|
+
# User.paginate # => Page 1 with default order and size.
|
|
11
|
+
# User.paginate(params) # => Passing parameters in controller.
|
|
9
12
|
# User.paginate(
|
|
10
13
|
# page: 1,
|
|
11
14
|
# per_page: 10,
|
|
12
15
|
# sort: :id,
|
|
13
16
|
# direction: :asc
|
|
14
|
-
# )
|
|
17
|
+
# ) # => Invocation with custom options.
|
|
15
18
|
#
|
|
16
|
-
#
|
|
19
|
+
# User.last_page # => Last page as a number for defaults
|
|
20
|
+
# User.last_page(params) # => Last page for given params. Works the same way as paginate.
|
|
21
|
+
#
|
|
22
|
+
# @see Filterable Filter results by attributes.
|
|
17
23
|
#
|
|
18
24
|
module Yap
|
|
19
25
|
extend ActiveSupport::Concern
|
|
26
|
+
include Filterable
|
|
20
27
|
|
|
21
28
|
DEFAULTS = Struct.new(:page, :per_page, :sort, :direction, :disable_warnings)
|
|
22
29
|
.new(1, 10, 'id', 'ASC', false)
|
|
@@ -26,12 +33,25 @@ module Yap
|
|
|
26
33
|
yield(DEFAULTS)
|
|
27
34
|
end
|
|
28
35
|
|
|
36
|
+
module ClassMethods
|
|
37
|
+
def last_page(params)
|
|
38
|
+
per_page = extract_number(params[:per_page], DEFAULTS.per_page)
|
|
39
|
+
(count / per_page.to_f).ceil
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
|
|
29
43
|
included do
|
|
30
44
|
extend ClassMethods
|
|
45
|
+
extend ColumnMapper
|
|
31
46
|
|
|
47
|
+
##
|
|
48
|
+
# The paginate scope takes a hash as parameter. All options are optional and can be combined arbitrarily.
|
|
49
|
+
#
|
|
50
|
+
# @param [Hash] The parameters used for pagination (:page, :per_page, :sort, :direction)
|
|
51
|
+
#
|
|
32
52
|
scope :paginate, -> (params = {}) {
|
|
33
53
|
page, per_page, column, direction = extract_pagination_params(params)
|
|
34
|
-
limit(per_page).offset((page-1)*per_page).order("#{column} #{direction}")
|
|
54
|
+
filter(params[:filter]).limit(per_page).offset((page-1)*per_page).order("#{column} #{direction}")
|
|
35
55
|
}
|
|
36
56
|
|
|
37
57
|
private
|
|
@@ -67,25 +87,5 @@ module Yap
|
|
|
67
87
|
raise PaginationError.new("'#{direction}' is not a valid direction. Use 'asc' or 'desc'.") unless %w[ASC DESC].include? dir
|
|
68
88
|
dir
|
|
69
89
|
end
|
|
70
|
-
|
|
71
|
-
private
|
|
72
|
-
|
|
73
|
-
def self.map_column(name)
|
|
74
|
-
begin
|
|
75
|
-
map_name_to_column(name)
|
|
76
|
-
rescue
|
|
77
|
-
warn "#{self.name} does not implement map_name_to_column. If you do not need column mapping set disable_warnings=true" unless DEFAULTS.disable_warnings
|
|
78
|
-
nil
|
|
79
|
-
end || (column_names.include?(name) ? name : nil)
|
|
80
|
-
end
|
|
81
90
|
end
|
|
82
|
-
|
|
83
|
-
module ClassMethods
|
|
84
|
-
def last_page(params)
|
|
85
|
-
per_page = extract_number(params[:per_page], DEFAULTS.per_page)
|
|
86
|
-
(count / per_page.to_f).ceil
|
|
87
|
-
end
|
|
88
|
-
end
|
|
89
|
-
|
|
90
|
-
class PaginationError < StandardError; end
|
|
91
91
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yap
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Finn Glöe
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2015-01-
|
|
11
|
+
date: 2015-01-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: activerecord
|
|
@@ -38,14 +38,19 @@ dependencies:
|
|
|
38
38
|
- - "~>"
|
|
39
39
|
- !ruby/object:Gem::Version
|
|
40
40
|
version: '1.3'
|
|
41
|
-
description: Yet another paginator for Ruby on Rails
|
|
42
|
-
to
|
|
41
|
+
description: Yet another paginator for Ruby on Rails adding a pagination and filtering
|
|
42
|
+
interface to ActiveRecords.
|
|
43
43
|
email: finn.gloee@1und1.de
|
|
44
44
|
executables: []
|
|
45
45
|
extensions: []
|
|
46
46
|
extra_rdoc_files: []
|
|
47
47
|
files:
|
|
48
|
+
- LICENSE
|
|
49
|
+
- README.md
|
|
48
50
|
- lib/yap.rb
|
|
51
|
+
- lib/yap/column_mapper.rb
|
|
52
|
+
- lib/yap/exceptions.rb
|
|
53
|
+
- lib/yap/filterable.rb
|
|
49
54
|
homepage: http://rubygems.org/gems/yap
|
|
50
55
|
licenses:
|
|
51
56
|
- GPL v2
|