redis-objects-pagination 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 8278840db96bc5c25088c46ad3fed54b73d617ea
4
+ data.tar.gz: 89cb311bfee32d02051e01bb5cd195bb04833a0e
5
+ SHA512:
6
+ metadata.gz: 5532d7e004d06d0c63d88af4e703b869db936f169a384e0ee8025d3dae436f082706079603c6613dc1796c627cd867ce50b7383e3bf1dbc5e6504fbea7677901
7
+ data.tar.gz: b6bffe28f2ff8c56d4ea84afa13665e62a4825882156fc0e7ef26289837dcf28c2ae79fa7438955a98582ad43338ffbe73136d42ed60cd12933e1e177c667d5b
@@ -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/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.0
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in redis-objects-pagination.gemspec
4
+ gemspec
@@ -0,0 +1,79 @@
1
+ # Redis::Objects::Pagination
2
+
3
+ Pagination for [redis-objects](https://github.com/nateware/redis-objects).
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'redis-objects-pagination'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install redis-objects-pagination
20
+
21
+ ## Usage
22
+
23
+ ### `Redis::List`
24
+
25
+ ```ruby
26
+ Redis::List.new('list_key').paginator(:range).page(2).paginate
27
+ ```
28
+
29
+ ### `Redis::SortedSet`
30
+
31
+ ```ruby
32
+ Redis::SortedSet.new('sorted_set_key').paginator(:range).page(2).paginate
33
+ ```
34
+
35
+ ```ruby
36
+ Redis::SortedSet.new('sorted_set_key').paginator(:revrange).page(2).paginate
37
+ ```
38
+
39
+ ### with options
40
+
41
+ ```ruby
42
+ Redis::List.new('list_key').paginator(:range, offset: 10, limit: 10).page(2).paginate
43
+ ```
44
+
45
+ ```ruby
46
+ Redis::SortedSet.new('sorted_set_key').paginator(:revrange, with_scores: true).page(2).paginate
47
+ ```
48
+
49
+ ### paginator methods
50
+
51
+ ```ruby
52
+ paginator = Redis::List.new('list_key').paginator(:range)
53
+
54
+ paginator.page(2) # => Paginator
55
+ paginator.per(20) # => Paginator
56
+ paginator.total_count # => Integer
57
+ paginator.total_pages # => Integer
58
+ paginator.current_page # => Integer
59
+ paginator.next_page # => Integer
60
+ paginator.prev_page # => Integer
61
+ paginator.first_page? # => Boolean
62
+ paginator.last_page? # => Boolean
63
+
64
+ paginator.paginate # => Array
65
+ ```
66
+
67
+ ## Development
68
+
69
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
70
+
71
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
72
+
73
+ ## Contributing
74
+
75
+ 1. Fork it ( https://github.com/[my-github-username]/redis-objects-pagination/fork )
76
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
77
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
78
+ 4. Push to the branch (`git push origin my-new-feature`)
79
+ 5. Create a new Pull Request
@@ -0,0 +1,7 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
7
+
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "redis/objects/pagination"
5
+
6
+ require "pry"
7
+ Pry.start
@@ -0,0 +1,16 @@
1
+ #!/usr/bin/env ruby
2
+ #
3
+ # This file was generated by Bundler.
4
+ #
5
+ # The application 'rake' is installed as part of a gem, and
6
+ # this file is here to facilitate running it.
7
+ #
8
+
9
+ require 'pathname'
10
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
11
+ Pathname.new(__FILE__).realpath)
12
+
13
+ require 'rubygems'
14
+ require 'bundler/setup'
15
+
16
+ load Gem.bin_path('rake', 'rake')
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1 @@
1
+ require 'redis/objects/pagination'
@@ -0,0 +1,16 @@
1
+ require 'redis/objects'
2
+ require 'redis/objects/pagination/version'
3
+ require 'redis/objects/pagination/config'
4
+ require 'redis/objects/pagination/errors'
5
+ require 'redis/objects/pagination/paginatable'
6
+
7
+ class Redis
8
+ module Objects
9
+ module Pagination
10
+ autoload :Paginator, 'redis/objects/pagination/paginator'
11
+
12
+ ::Redis::List.send :include, Paginatable
13
+ ::Redis::SortedSet.send :include, Paginatable
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,23 @@
1
+ require 'active_support/configurable'
2
+
3
+ class Redis
4
+ module Objects
5
+ module Pagination
6
+ class << self
7
+ def configure(&block)
8
+ yield config
9
+ end
10
+
11
+ def config
12
+ @config ||= Configuration.new
13
+ end
14
+ end
15
+
16
+ class Configuration
17
+ include ::ActiveSupport::Configurable
18
+
19
+ config_accessor(:default_per_page){ 25 }
20
+ end
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,7 @@
1
+ class Redis
2
+ module Objects
3
+ module Pagination
4
+ class InvalidArgument < StandardError; end
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,20 @@
1
+ class Redis
2
+ module Objects
3
+ module Pagination
4
+ module Paginatable
5
+
6
+ # Create Paginator object by method name
7
+ #
8
+ # @param [Symbol, Hash<Symbol, Array>] method name only or method name and arguments hash
9
+ # @param [Hash] options
10
+ # @return [Paginator]
11
+ # @option options [Integer] :limit = ::Redis::Objects::Pagination.config.default_per_page
12
+ # @option options [Integer] :offset = 0
13
+ # @option options [Integer] :total_count
14
+ def paginator(method_name, options = {})
15
+ Paginator.new(self, method_name, options)
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,148 @@
1
+ require 'active_support/core_ext/array'
2
+ require 'redis/objects/pagination/paginator/collection_proxy'
3
+
4
+ class Redis
5
+ module Objects
6
+ module Pagination
7
+ class Paginator
8
+ include CollectionProxy
9
+
10
+ def initialize(object, method_name, options = {})
11
+ @object = object
12
+ @method_name, *@method_args =
13
+ case method_name
14
+ when Hash
15
+ name, args = method_name.first
16
+ [name, *Array.wrap(args)]
17
+ else
18
+ Array.wrap(method_name)
19
+ end
20
+
21
+ raise InvalidArgument if object.method(@method_name).arity.abs < 2
22
+
23
+ @limit, @offset, @total_count = (options[:limit] || ::Redis::Objects::Pagination.config.default_per_page).to_i, options[:offset].to_i, options[:total_count]
24
+ end
25
+
26
+ # Change page
27
+ #
28
+ # @param [Integer] page number
29
+ # @return [Paginator]
30
+ def page(num = 1)
31
+ num = num.to_i - 1
32
+ num = [num, 0].max
33
+ offset(@limit * num)
34
+ end
35
+
36
+ # Set number of items per page
37
+ #
38
+ # @param [Integer] number of items per page
39
+ # @return [Paginator]
40
+ def per(num)
41
+ limit(num).offset((current_page - 1) * num)
42
+ end
43
+
44
+ # Set limit
45
+ #
46
+ # @param [Integer] limit
47
+ # @return [Paginator]
48
+ def limit(num)
49
+ self.class.new @object, [@method_name, *@method_args], limit: num, offset: @offset
50
+ end
51
+
52
+ # Set offset
53
+ #
54
+ # @param [Integer] offset
55
+ # @return [Paginator]
56
+ def offset(num)
57
+ self.class.new @object, [@method_name, *@method_args], limit: @limit, offset: num
58
+ end
59
+
60
+ # Total number of items
61
+ #
62
+ # @return [Integer]
63
+ def total_count
64
+ @total_count || @object.size
65
+ end
66
+
67
+ # Total number of pages
68
+ #
69
+ # @return [Integer]
70
+ def total_pages
71
+ (total_count / @limit.to_f).ceil
72
+ end
73
+
74
+ # Current page number
75
+ #
76
+ # @return [Integer]
77
+ def current_page
78
+ @offset / @limit + 1
79
+ end
80
+
81
+ # Next page number
82
+ #
83
+ # @return [Integer]
84
+ def next_page
85
+ current_page + 1 unless last_page?
86
+ end
87
+
88
+ # Previous page number
89
+ #
90
+ # @return [Integer]
91
+ def prev_page
92
+ current_page - 1 unless first_page?
93
+ end
94
+
95
+ # First page?
96
+ #
97
+ # @return [Boolean]
98
+ def first_page?
99
+ current_page == 1
100
+ end
101
+
102
+ # Last page?
103
+ #
104
+ # @return [Boolean]
105
+ def last_page?
106
+ current_page >= total_pages
107
+ end
108
+
109
+ # Limit value
110
+ #
111
+ # @return [Integer]
112
+ def limit_value
113
+ @limit
114
+ end
115
+
116
+ # Offset value
117
+ #
118
+ # @return [Integer]
119
+ def offset_value
120
+ @offset
121
+ end
122
+
123
+ # Fetch collection of current page
124
+ #
125
+ # @return [Array]
126
+ def paginate
127
+ args = [start_index, end_index, *@method_args].compact
128
+ @object.send @method_name, *args
129
+ end
130
+
131
+ private
132
+
133
+ def start_index
134
+ @offset
135
+ end
136
+
137
+ def end_index
138
+ index = @offset + @limit - 1
139
+ if total_count <= index
140
+ total_count
141
+ else
142
+ index
143
+ end
144
+ end
145
+ end
146
+ end
147
+ end
148
+ end
@@ -0,0 +1,20 @@
1
+ class Redis
2
+ module Objects
3
+ module Pagination
4
+ class Paginator
5
+ module CollectionProxy
6
+ include Enumerable
7
+
8
+ def each(&block)
9
+ to_a.each(block)
10
+ end
11
+
12
+ def to_ary
13
+ paginate
14
+ end
15
+ alias_method :to_a, :to_ary
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,7 @@
1
+ class Redis
2
+ module Objects
3
+ module Pagination
4
+ VERSION = "0.1.0"
5
+ end
6
+ end
7
+ end
@@ -0,0 +1,33 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'redis/objects/pagination/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "redis-objects-pagination"
8
+ spec.version = Redis::Objects::Pagination::VERSION
9
+ spec.authors = ["ichi"]
10
+ spec.email = ["ichi.ttht.1@gmail.com"]
11
+
12
+ spec.summary = %q{Pagination for redis-objects.}
13
+ spec.description = %q{Pagination for redis-objects.}
14
+ spec.homepage = "https://github.com/ichi/redis-objects-pagination"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_dependency "redis-objects", ">= 1.2"
23
+ spec.add_dependency 'activesupport', '>= 3.0.0'
24
+
25
+ spec.add_development_dependency "bundler", "~> 1.8"
26
+ spec.add_development_dependency "rake", "~> 10.0"
27
+ spec.add_development_dependency "rspec"
28
+ spec.add_development_dependency "rspec-its"
29
+ spec.add_development_dependency "rspec-collection_matchers"
30
+ spec.add_development_dependency "mock_redis"
31
+ spec.add_development_dependency "pry"
32
+ spec.add_development_dependency "pry-doc"
33
+ end
metadata ADDED
@@ -0,0 +1,203 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: redis-objects-pagination
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - ichi
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-12-07 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: redis-objects
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '1.2'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '1.2'
27
+ - !ruby/object:Gem::Dependency
28
+ name: activesupport
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 3.0.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 3.0.0
41
+ - !ruby/object:Gem::Dependency
42
+ name: bundler
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.8'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.8'
55
+ - !ruby/object:Gem::Dependency
56
+ name: rake
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '10.0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '10.0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: rspec-its
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: rspec-collection_matchers
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: mock_redis
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - ">="
123
+ - !ruby/object:Gem::Version
124
+ version: '0'
125
+ - !ruby/object:Gem::Dependency
126
+ name: pry
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - ">="
130
+ - !ruby/object:Gem::Version
131
+ version: '0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - ">="
137
+ - !ruby/object:Gem::Version
138
+ version: '0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: pry-doc
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - ">="
144
+ - !ruby/object:Gem::Version
145
+ version: '0'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - ">="
151
+ - !ruby/object:Gem::Version
152
+ version: '0'
153
+ description: Pagination for redis-objects.
154
+ email:
155
+ - ichi.ttht.1@gmail.com
156
+ executables: []
157
+ extensions: []
158
+ extra_rdoc_files: []
159
+ files:
160
+ - ".gitignore"
161
+ - ".rspec"
162
+ - ".travis.yml"
163
+ - Gemfile
164
+ - README.md
165
+ - Rakefile
166
+ - bin/console
167
+ - bin/rake
168
+ - bin/setup
169
+ - lib/redis-objects-pagination.rb
170
+ - lib/redis/objects/pagination.rb
171
+ - lib/redis/objects/pagination/config.rb
172
+ - lib/redis/objects/pagination/errors.rb
173
+ - lib/redis/objects/pagination/paginatable.rb
174
+ - lib/redis/objects/pagination/paginator.rb
175
+ - lib/redis/objects/pagination/paginator/collection_proxy.rb
176
+ - lib/redis/objects/pagination/version.rb
177
+ - redis-objects-paginator.gemspec
178
+ homepage: https://github.com/ichi/redis-objects-pagination
179
+ licenses:
180
+ - MIT
181
+ metadata: {}
182
+ post_install_message:
183
+ rdoc_options: []
184
+ require_paths:
185
+ - lib
186
+ required_ruby_version: !ruby/object:Gem::Requirement
187
+ requirements:
188
+ - - ">="
189
+ - !ruby/object:Gem::Version
190
+ version: '0'
191
+ required_rubygems_version: !ruby/object:Gem::Requirement
192
+ requirements:
193
+ - - ">="
194
+ - !ruby/object:Gem::Version
195
+ version: '0'
196
+ requirements: []
197
+ rubyforge_project:
198
+ rubygems_version: 2.4.5
199
+ signing_key:
200
+ specification_version: 4
201
+ summary: Pagination for redis-objects.
202
+ test_files: []
203
+ has_rdoc: