redis_pagination 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTViNTg2OWQ3Y2U3ZTQyNmQ0ZGRiMjM0ZTBlM2QwZjY2MjcxNmJhMQ==
+  data.tar.gz: !binary |-
+    NzE2YWE1NTFlMmZjOTY2NDdkZWFlNGJjYWYzMWM2MjZkOWQyOGEzMA==
+SHA512:
+  metadata.gz: !binary |-
+    ZjZjOWU5MjU1MTUxM2YyODkwMzhkMDBkOTFmMmIwYmI0YWFkMWE3MjU1OTNm
+    NGU0MDlmYjg5YzcwZDY4MTEzZjZlYjgwNDU4ODZkZDJlYjA1Mzc4ZGFjYzA4
+    YjZiYjA2NTlhMGQxOWFkZTgzOWJmMjQ3NDc3NTY1NTg1NDg2NWI=
+  data.tar.gz: !binary |-
+    MzdiYWYzZTA1OTlmNWNjZjNiNWY1NzNlNTFiYzMwMDQyZjQwNTRlNDk5NmE0
+    ZGJkMjI5Yzk5YjIxNDY5NjA2YzUyZWYxZmM4OGQ0ZWQ3YmVhNTAxMzQyNmFk
+    MWMwNzI2ZDg1MzdjYzRmZjMyNzM1NjlkOGNiYzE5Y2NkZDY3NDk=

data/.rspec

@@ -1,2 +1,3 @@
 --color
---format nested
+--format nested
+--order random

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-# CHANGELOG 
+# CHANGELOG
+
+## 1.1.0 (2014-05-14)
+
+* Added `#all` method to `RedisPagination::Paginator::SortedSetPaginator` and
+  `RedisPagination::Paginator::ListPaginator` to retrieve all elements
+  from these data types for a given key.
 
 ## 1.0.0 (2012-07-27)
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 David Czarnecki
+Copyright (c) 2012-2014 David Czarnecki
 
 MIT License
 

data/README.md

@@ -2,7 +2,7 @@
 
 Simple pagination for Redis lists and sorted sets.
 
-Make sure your redis server is running! Redis configuration is outside the scope of this README, but 
+Make sure your redis server is running! Redis configuration is outside the scope of this README, but
 check out the [Redis documentation](http://redis.io/documentation) for more information.
 
 ## Installation
@@ -30,7 +30,7 @@ $ gem install redis_pagination
 Configure redis_pagination:
 
 ```ruby
-RedisPaginations.configure do |configuration|
+RedisPagination.configure do |configuration|
   configuration.redis = Redis.new
   configuration.page_size = 25
 end
@@ -48,15 +48,15 @@ end
 
 # List
 add_items_to_list('items', RedisPagination.page_size + 2)
- => 1 
+ => 1
 items_paginator = RedisPagination.paginate('items')
- => #<RedisPagination::Paginator::ListPaginator:0x007f8109b08ba0 @key="items"> 
+ => #<RedisPagination::Paginator::ListPaginator:0x007f8109b08ba0 @key="items">
 items_paginator.total_items
- => 27 
+ => 27
 items_paginator.total_pages
- => 2 
+ => 2
 items_paginator.total_pages(5)
- => 6 
+ => 6
 items = items_paginator.page(1)
  => {:current_page=>1, :total_pages=>2, :total_items=>27, :items=>["item_1", "item_2", "item_3", "item_4", "item_5", "item_6", "item_7", "item_8", "item_9", "item_10", "item_11", "item_12", "item_13", "item_14", "item_15", "item_16", "item_17", "item_18", "item_19", "item_20", "item_21", "item_22", "item_23", "item_24", "item_25"]}
 items = items_paginator.page(2)
@@ -64,15 +64,15 @@ items = items_paginator.page(2)
 
 # Sorted Set
 add_items_to_sorted_set('items', RedisPagination.page_size + 2)
- => 1 
+ => 1
 items_paginator = RedisPagination.paginate('items')
- => #<RedisPagination::Paginator::SortedSetPaginator:0x007f8109a25828 @key="items"> 
+ => #<RedisPagination::Paginator::SortedSetPaginator:0x007f8109a25828 @key="items">
 items_paginator.total_items
- => 27 
+ => 27
 items_paginator.total_pages
- => 2 
+ => 2
 items_paginator.total_pages(5)
- => 6 
+ => 6
 items = items_paginator.page(1)
  => {:current_page=>1, :total_pages=>2, :total_items=>27, :items=>[["item_27", 27.0], ["item_26", 26.0], ["item_25", 25.0], ["item_24", 24.0], ["item_23", 23.0], ["item_22", 22.0], ["item_21", 21.0], ["item_20", 20.0], ["item_19", 19.0], ["item_18", 18.0], ["item_17", 17.0], ["item_16", 16.0], ["item_15", 15.0], ["item_14", 14.0], ["item_13", 13.0], ["item_12", 12.0], ["item_11", 11.0], ["item_10", 10.0], ["item_9", 9.0], ["item_8", 8.0], ["item_7", 7.0], ["item_6", 6.0], ["item_5", 5.0], ["item_4", 4.0], ["item_3", 3.0]]}
 items = items_paginator.page(2)
@@ -82,19 +82,25 @@ items = items_paginator.page(1, :with_scores => false, :reverse => false)
 
 # If the key is non-existent, the paginate call will return a RedisPagination::Paginator::NonePaginator
 items_paginator = RedisPagination.paginate('unknown-key-in-redis')
- => #<RedisPagination::Paginator::NonePaginator:0x007f956b8052c0> 
+ => #<RedisPagination::Paginator::NonePaginator:0x007f956b8052c0>
 items_paginator.total_items
- => 0 
+ => 0
 items_paginator.total_pages
- => 0 
+ => 0
 items_paginator.total_pages(5)
- => 0 
+ => 0
 items = items_paginator.page(1)
- => {:current_page=>1, :total_pages=>0, :total_items=>0, :items=>[]} 
+ => {:current_page=>1, :total_pages=>0, :total_items=>0, :items=>[]}
 items = items_paginator.page(2)
  => {:current_page=>2, :total_pages=>0, :total_items=>0, :items=>[]}
 ```
 
+## Retrieving All Members
+
+The `RedisPagination::Paginator::SortedSetPaginator` and `RedisPagination::Paginator::ListPaginator`
+classes have an `all` method that can be called to retrieve all elements from these data types for
+a given key.
+
 ## Paging Options
 
 Valid options in the `page` call for paginating a Redis list are:
@@ -105,9 +111,9 @@ Valid options in the `page` call for paginating a Redis sorted set are:
 
 * `:page_size` controls the page size for the call. Default is `RedisPagination.page_size`.
 * `:with_scores` controls whether the score is returned along with the item. Default is `true`.
-* `:reverse controls` whether to return items in highest-to-lowest (`true`) or loweest-to-highest order (`false`). Default is `true`.
+* `:reverse` controls whether to return items in highest-to-lowest (`true`) or lowest-to-highest order (`false`). Default is `true`.
 
-## Differences in Redis Client Libraries 
+## Differences in Redis Client Libraries
 
 There is a difference between how sorted set data with scores is returned between the 2.x and the 3.x branch of the Ruby Redis client library.
 

data/lib/redis_pagination/paginator/list_paginator.rb

@@ -12,7 +12,7 @@ module RedisPagination
       # Return the total number of pages for +key+.
       #
       # @param page_size [int] Page size to calculate total number of pages.
-      # 
+      #
       # @return the total number of pages for +key+.
       def total_pages(page_size = RedisPagination.page_size)
         (RedisPagination.redis.llen(@key) / page_size.to_f).ceil
@@ -29,7 +29,7 @@ module RedisPagination
       #
       # @param page [int] Page of items to retrieve.
       # @param options [Hash] Options. Valid options are :page_size.
-      #   :page_size controls the page size for the call. Default is +RedisPagination.page_size+.      
+      #   :page_size controls the page size for the call. Default is +RedisPagination.page_size+.
       #
       # @return a +Hash+ containing +:current_page+, +:total_pages+, +:total_items+ and +:items+.
       def page(page, options = {})
@@ -44,7 +44,17 @@ module RedisPagination
           :total_pages => total_pages(page_size),
           :total_items => total_items,
           :items => RedisPagination.redis.lrange(@key, starting_offset, ending_offset)
-        }        
+        }
+      end
+
+      # Retrieve all items for +key+.
+      #
+      # @return a +Hash+ containing +:total_items+ and +:items+.
+      def all(options = {})
+        {
+          :total_items => total_items,
+          :items => RedisPagination.redis.lrange(@key, 0, -1)
+        }
       end
     end
   end

data/lib/redis_pagination/paginator/none_paginator.rb

@@ -3,7 +3,7 @@ module RedisPagination
     class NonePaginator
       # Initialize a new instance with a given Redis +key+ and options.
       #
-      # @param key [String] Redis list key.
+      # @param key [String] Redis key.
       # @param options [Hash] Options for paginator.
       def initialize(key, options = {})
       end

data/lib/redis_pagination/paginator/sorted_set_paginator.rb

@@ -3,7 +3,7 @@ module RedisPagination
     class SortedSetPaginator
       # Initialize a new instance with a given Redis +key+ and options.
       #
-      # @param key [String] Redis list key.
+      # @param key [String] Redis sorted set key.
       # @param options [Hash] Options for paginator.
       def initialize(key, options = {})
         @key = key
@@ -12,7 +12,7 @@ module RedisPagination
       # Return the total number of pages for +key+.
       #
       # @param page_size [int] Page size to calculate total number of pages.
-      # 
+      #
       # @return the total number of pages for +key+.
       def total_pages(page_size = RedisPagination.page_size)
         (RedisPagination.redis.zcard(@key) / page_size.to_f).ceil
@@ -53,7 +53,28 @@ module RedisPagination
           else
             RedisPagination.redis.zrange(@key, starting_offset, ending_offset, :with_scores => with_scores)
           end
-        } 
+        }
+      end
+
+      # Retrieve all items for +key+.
+      #
+      # @param options [Hash] Options. Valid options are :with_scores and :reverse.
+      #   :with_scores controls whether the score is returned along with the item. Default is +true+.
+      #   :reverse controls whether to return items in highest-to-lowest (+true+) or loweest-to-highest order (+false+). Default is +true+.
+      #
+      # @return a +Hash+ containing +:total_items+ and +:items+.
+      def all(options = {})
+        with_scores = options.has_key?(:with_scores) ? options[:with_scores] : true
+        reverse = options.has_key?(:reverse) ? options[:reverse] : true
+
+        {
+          :total_items => total_items,
+          :items => if reverse
+            RedisPagination.redis.zrevrange(@key, 0, -1, :with_scores => with_scores)
+          else
+            RedisPagination.redis.zrange(@key, 0, -1, :with_scores => with_scores)
+          end
+        }
       end
     end
   end

data/lib/redis_pagination/version.rb

@@ -1,3 +1,3 @@
 module RedisPagination
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/redis_pagination.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Simple pagination for Redis lists and sorted sets.}
   gem.summary       = %q{Simple pagination for Redis lists and sorted sets.}
   gem.homepage      = 'https://github.com/czarneckid/redis_pagination'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/spec/redis_pagination/paginator/list_paginator_spec.rb

@@ -56,4 +56,15 @@ describe RedisPagination::Paginator::ListPaginator do
       result[:total_pages].should == 6
     end
   end
+
+  describe '#all' do
+    it 'should return all the items with the default options' do
+      add_items_to_sorted_set('items', 50)
+      items_paginator = RedisPagination.paginate('items')
+      items_paginator.all.tap do |all_items|
+        all_items[:total_items].should == 50
+        all_items[:items].length.should == 50
+      end
+    end
+  end
 end

data/spec/redis_pagination/paginator/sorted_set_paginator_spec.rb

@@ -61,4 +61,15 @@ describe RedisPagination::Paginator::SortedSetPaginator do
       result[:total_pages].should == 6
     end
   end
+
+  describe '#all' do
+    it 'should return all the items with the default options' do
+      add_items_to_sorted_set('items', 50)
+      items_paginator = RedisPagination.paginate('items')
+      items_paginator.all.tap do |all_items|
+        all_items[:total_items].should == 50
+        all_items[:items].length.should == 50
+      end
+    end
+  end
 end

data/spec/redis_pagination/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe 'RedisPagination::VERSION' do
   it 'should be the correct version' do
-    RedisPagination::VERSION.should == '1.0.0'
+    RedisPagination::VERSION.should == '1.1.0'
   end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: redis_pagination
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -90,28 +83,28 @@ files:
 - spec/redis_pagination/version_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/czarneckid/redis_pagination
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple pagination for Redis lists and sorted sets.
 test_files:
 - spec/redis_pagination/configuration_spec.rb