redis_pagination 0.0.1 → 1.0.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG 
+
+## 1.0.0 (2012-07-27)
+
+* Added `RedisPagination::Paginator::NonePaginator` to handle non-existent keys.
+
+## 0.0.1 (2012-07-19)
+
+* Initial release

data/README.md

@@ -79,6 +79,20 @@ items = items_paginator.page(2)
  => {:current_page=>2, :total_pages=>2, :total_items=>27, :items=>[["item_2", 2.0], ["item_1", 1.0]]}
 items = items_paginator.page(1, :with_scores => false, :reverse => false)
  => {: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"]}
+
+# 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> 
+items_paginator.total_items
+ => 0 
+items_paginator.total_pages
+ => 0 
+items_paginator.total_pages(5)
+ => 0 
+items = items_paginator.page(1)
+ => {: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=>[]}
 ```
 
 ## Paging Options
@@ -93,7 +107,7 @@ Valid options in the `page` call for paginating a Redis sorted set are:
 * `: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`.
 
-## Caveats
+## 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.rb

@@ -1,4 +1,5 @@
 require 'redis_pagination/paginator/list_paginator'
+require 'redis_pagination/paginator/none_paginator'
 require 'redis_pagination/paginator/sorted_set_paginator'
 
 module RedisPagination
@@ -21,6 +22,8 @@ module RedisPagination
         RedisPagination::Paginator::ListPaginator.new(key, options)
       when 'zset'
         RedisPagination::Paginator::SortedSetPaginator.new(key, options)
+      when 'none'
+        RedisPagination::Paginator::NonePaginator.new(key, options)
       else
         raise "Pagination is not supported for #{type}"
       end

data/lib/redis_pagination/paginator/none_paginator.rb

@@ -0,0 +1,46 @@
+module RedisPagination
+  module Paginator
+    class NonePaginator
+      # Initialize a new instance with a given Redis +key+ and options.
+      #
+      # @param key [String] Redis list key.
+      # @param options [Hash] Options for paginator.
+      def initialize(key, options = {})
+      end
+
+      # 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)
+        0
+      end
+
+      # Return the total number of items for +key+.
+      #
+      # @return the total number of items for +key+.
+      def total_items
+        0
+      end
+
+      # Retrieve a page of items for +key+.
+      #
+      # @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+.      
+      #
+      # @return a +Hash+ containing +:current_page+, +:total_pages+, +:total_items+ and +:items+.
+      def page(page, options = {})
+        current_page = page < 1 ? 1 : page
+
+        {
+          :current_page => current_page,
+          :total_pages => 0,
+          :total_items => 0,
+          :items => []
+        }        
+      end
+    end
+  end
+end

data/lib/redis_pagination/version.rb

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

data/spec/redis_pagination/paginator/none_paginator_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe RedisPagination::Paginator::NonePaginator do
+  describe '#total_pages' do
+    it 'should return the correct number of pages' do
+      items_paginator = RedisPagination.paginate('unknown-key-in-redis')
+      items_paginator.total_pages.should == 0
+    end
+
+    it 'should return the correct number of pages using a different page size' do
+      items_paginator = RedisPagination.paginate('unknown-key-in-redis')
+      items_paginator.total_pages(5).should == 0
+    end
+  end
+
+  describe '#total_items' do
+    it 'should return the correct number of items' do
+      items_paginator = RedisPagination.paginate('unknown-key-in-redis')
+      items_paginator.total_items.should == 0
+    end
+  end
+
+  describe '#page' do
+    it 'should return the correct page of items' do      
+      items_paginator = RedisPagination.paginate('unknown-key-in-redis')
+      result = items_paginator.page(1)
+      result[:items].length.should == 0
+      result[:current_page].should == 1
+      result[:total_pages].should == 0
+      result[:total_items].should == 0
+
+      result = items_paginator.page(2)
+      result[:items].length.should == 0
+      result[:current_page].should == 2
+    end
+
+    it 'should return the correct page of items with the options set' do
+      items_paginator = RedisPagination.paginate('unknown-key-in-redis')
+      result = items_paginator.page(1, :page_size => 5)
+      result[:items].length.should == 0
+      result[:current_page].should == 1
+      result[:total_pages].should == 0
+    end
+  end
+end

data/spec/redis_pagination/paginator_spec.rb

@@ -16,6 +16,10 @@ describe RedisPagination::Paginator do
       RedisPagination.paginate("items").should be_a_kind_of(RedisPagination::Paginator::SortedSetPaginator)
     end
 
+    it 'should return a RedisPagination::Paginator::NonePaginator' do
+      RedisPagination.paginate("unknown-key-in-redis").should be_a_kind_of(RedisPagination::Paginator::NonePaginator)
+    end
+
     it 'should raise an exception if trying to paginate a Redis type that cannot be paginated' do
       redis = RedisPagination.redis
       redis.set("items", "item_1")

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 == '0.0.1'
+    RedisPagination::VERSION.should == '1.0.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis_pagination
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -69,6 +69,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -77,11 +78,13 @@ files:
 - lib/redis_pagination/configuration.rb
 - lib/redis_pagination/paginator.rb
 - lib/redis_pagination/paginator/list_paginator.rb
+- lib/redis_pagination/paginator/none_paginator.rb
 - lib/redis_pagination/paginator/sorted_set_paginator.rb
 - lib/redis_pagination/version.rb
 - redis_pagination.gemspec
 - spec/redis_pagination/configuration_spec.rb
 - spec/redis_pagination/paginator/list_paginator_spec.rb
+- spec/redis_pagination/paginator/none_paginator_spec.rb
 - spec/redis_pagination/paginator/sorted_set_paginator_spec.rb
 - spec/redis_pagination/paginator_spec.rb
 - spec/redis_pagination/version_spec.rb
@@ -113,6 +116,7 @@ summary: Simple pagination for Redis lists and sorted sets.
 test_files:
 - spec/redis_pagination/configuration_spec.rb
 - spec/redis_pagination/paginator/list_paginator_spec.rb
+- spec/redis_pagination/paginator/none_paginator_spec.rb
 - spec/redis_pagination/paginator/sorted_set_paginator_spec.rb
 - spec/redis_pagination/paginator_spec.rb
 - spec/redis_pagination/version_spec.rb