redis-objects-pagination 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8278840db96bc5c25088c46ad3fed54b73d617ea
+  data.tar.gz: 89cb311bfee32d02051e01bb5cd195bb04833a0e
+SHA512:
+  metadata.gz: 5532d7e004d06d0c63d88af4e703b869db936f169a384e0ee8025d3dae436f082706079603c6613dc1796c627cd867ce50b7383e3bf1dbc5e6504fbea7677901
+  data.tar.gz: b6bffe28f2ff8c56d4ea84afa13665e62a4825882156fc0e7ef26289837dcf28c2ae79fa7438955a98582ad43338ffbe73136d42ed60cd12933e1e177c667d5b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,79 @@
+# Redis::Objects::Pagination
+
+Pagination for [redis-objects](https://github.com/nateware/redis-objects).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis-objects-pagination'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-objects-pagination
+
+## Usage
+
+### `Redis::List`
+
+```ruby
+Redis::List.new('list_key').paginator(:range).page(2).paginate
+```
+
+### `Redis::SortedSet`
+
+```ruby
+Redis::SortedSet.new('sorted_set_key').paginator(:range).page(2).paginate
+```
+
+```ruby
+Redis::SortedSet.new('sorted_set_key').paginator(:revrange).page(2).paginate
+```
+
+### with options
+
+```ruby
+Redis::List.new('list_key').paginator(:range, offset: 10, limit: 10).page(2).paginate
+```
+
+```ruby
+Redis::SortedSet.new('sorted_set_key').paginator(:revrange, with_scores: true).page(2).paginate
+```
+
+### paginator methods
+
+```ruby
+paginator = Redis::List.new('list_key').paginator(:range)
+
+paginator.page(2)       # => Paginator
+paginator.per(20)       # => Paginator
+paginator.total_count   # => Integer
+paginator.total_pages   # => Integer
+paginator.current_page  # => Integer
+paginator.next_page     # => Integer
+paginator.prev_page     # => Integer
+paginator.first_page?   # => Boolean
+paginator.last_page?    # => Boolean
+
+paginator.paginate      # => Array
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/redis-objects-pagination/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis/objects/pagination"
+
+require "pry"
+Pry.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis-objects-pagination.rb

@@ -0,0 +1 @@
+require 'redis/objects/pagination'

data/lib/redis/objects/pagination.rb

@@ -0,0 +1,16 @@
+require 'redis/objects'
+require 'redis/objects/pagination/version'
+require 'redis/objects/pagination/config'
+require 'redis/objects/pagination/errors'
+require 'redis/objects/pagination/paginatable'
+
+class Redis
+  module Objects
+    module Pagination
+      autoload :Paginator,    'redis/objects/pagination/paginator'
+
+      ::Redis::List.send      :include, Paginatable
+      ::Redis::SortedSet.send :include, Paginatable
+    end
+  end
+end

data/lib/redis/objects/pagination/config.rb

@@ -0,0 +1,23 @@
+require 'active_support/configurable'
+
+class Redis
+  module Objects
+    module Pagination
+      class << self
+        def configure(&block)
+          yield config
+        end
+
+        def config
+          @config ||= Configuration.new
+        end
+      end
+
+      class Configuration
+        include ::ActiveSupport::Configurable
+
+        config_accessor(:default_per_page){ 25 }
+      end
+    end
+  end
+end

data/lib/redis/objects/pagination/errors.rb

@@ -0,0 +1,7 @@
+class Redis
+  module Objects
+    module Pagination
+      class InvalidArgument < StandardError; end
+    end
+  end
+end

data/lib/redis/objects/pagination/paginatable.rb

@@ -0,0 +1,20 @@
+class Redis
+  module Objects
+    module Pagination
+      module Paginatable
+
+        # Create Paginator object by method name
+        #
+        # @param [Symbol, Hash<Symbol, Array>] method name only or method name and arguments hash
+        # @param [Hash] options
+        # @return [Paginator]
+        # @option options [Integer] :limit = ::Redis::Objects::Pagination.config.default_per_page
+        # @option options [Integer] :offset = 0
+        # @option options [Integer] :total_count
+        def paginator(method_name, options = {})
+          Paginator.new(self, method_name, options)
+        end
+      end
+    end
+  end
+end

data/lib/redis/objects/pagination/paginator.rb

@@ -0,0 +1,148 @@
+require 'active_support/core_ext/array'
+require 'redis/objects/pagination/paginator/collection_proxy'
+
+class Redis
+  module Objects
+    module Pagination
+      class Paginator
+        include CollectionProxy
+
+        def initialize(object, method_name, options = {})
+          @object = object
+          @method_name, *@method_args =
+            case method_name
+            when Hash
+              name, args = method_name.first
+              [name, *Array.wrap(args)]
+            else
+              Array.wrap(method_name)
+            end
+
+          raise InvalidArgument if object.method(@method_name).arity.abs < 2
+
+          @limit, @offset, @total_count = (options[:limit] || ::Redis::Objects::Pagination.config.default_per_page).to_i, options[:offset].to_i, options[:total_count]
+        end
+
+        # Change page
+        #
+        # @param [Integer] page number
+        # @return [Paginator]
+        def page(num = 1)
+          num = num.to_i - 1
+          num = [num, 0].max
+          offset(@limit * num)
+        end
+
+        # Set number of items per page
+        #
+        # @param [Integer] number of items per page
+        # @return [Paginator]
+        def per(num)
+          limit(num).offset((current_page - 1) * num)
+        end
+
+        # Set limit
+        #
+        # @param [Integer] limit
+        # @return [Paginator]
+        def limit(num)
+          self.class.new @object, [@method_name, *@method_args], limit: num, offset: @offset
+        end
+
+        # Set offset
+        #
+        # @param [Integer] offset
+        # @return [Paginator]
+        def offset(num)
+          self.class.new @object, [@method_name, *@method_args], limit: @limit, offset: num
+        end
+
+        # Total number of items
+        #
+        # @return [Integer]
+        def total_count
+          @total_count || @object.size
+        end
+
+        # Total number of pages
+        #
+        # @return [Integer]
+        def total_pages
+          (total_count / @limit.to_f).ceil
+        end
+
+        # Current page number
+        #
+        # @return [Integer]
+        def current_page
+          @offset / @limit + 1
+        end
+
+        # Next page number
+        #
+        # @return [Integer]
+        def next_page
+          current_page + 1 unless last_page?
+        end
+
+        # Previous page number
+        #
+        # @return [Integer]
+        def prev_page
+          current_page - 1 unless first_page?
+        end
+
+        # First page?
+        #
+        # @return [Boolean]
+        def first_page?
+          current_page == 1
+        end
+
+        # Last page?
+        #
+        # @return [Boolean]
+        def last_page?
+          current_page >= total_pages
+        end
+
+        # Limit value
+        #
+        # @return [Integer]
+        def limit_value
+          @limit
+        end
+
+        # Offset value
+        #
+        # @return [Integer]
+        def offset_value
+          @offset
+        end
+
+        # Fetch collection of current page
+        #
+        # @return [Array]
+        def paginate
+          args = [start_index, end_index, *@method_args].compact
+          @object.send @method_name, *args
+        end
+
+        private
+
+        def start_index
+          @offset
+        end
+
+        def end_index
+          index = @offset + @limit - 1
+          if total_count <= index
+            total_count
+          else
+            index
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redis/objects/pagination/paginator/collection_proxy.rb

@@ -0,0 +1,20 @@
+class Redis
+  module Objects
+    module Pagination
+      class Paginator
+        module CollectionProxy
+          include Enumerable
+
+          def each(&block)
+            to_a.each(block)
+          end
+
+          def to_ary
+            paginate
+          end
+          alias_method :to_a, :to_ary
+        end
+      end
+    end
+  end
+end

data/lib/redis/objects/pagination/version.rb

@@ -0,0 +1,7 @@
+class Redis
+  module Objects
+    module Pagination
+      VERSION = "0.1.0"
+    end
+  end
+end

data/redis-objects-paginator.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis/objects/pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-objects-pagination"
+  spec.version       = Redis::Objects::Pagination::VERSION
+  spec.authors       = ["ichi"]
+  spec.email         = ["ichi.ttht.1@gmail.com"]
+
+  spec.summary       = %q{Pagination for redis-objects.}
+  spec.description   = %q{Pagination for redis-objects.}
+  spec.homepage      = "https://github.com/ichi/redis-objects-pagination"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis-objects", ">= 1.2"
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-collection_matchers"
+  spec.add_development_dependency "mock_redis"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: redis-objects-pagination
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ichi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pagination for redis-objects.
+email:
+- ichi.ttht.1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- lib/redis-objects-pagination.rb
+- lib/redis/objects/pagination.rb
+- lib/redis/objects/pagination/config.rb
+- lib/redis/objects/pagination/errors.rb
+- lib/redis/objects/pagination/paginatable.rb
+- lib/redis/objects/pagination/paginator.rb
+- lib/redis/objects/pagination/paginator/collection_proxy.rb
+- lib/redis/objects/pagination/version.rb
+- redis-objects-paginator.gemspec
+homepage: https://github.com/ichi/redis-objects-pagination
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Pagination for redis-objects.
+test_files: []
+has_rdoc: