leaderboard 2.0.3 → 2.0.4

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## leaderboard 2.0.4 (2012-02-29)
+
+ * Added `page_for(member, page_size = DEFAULT_PAGE_SIZE)` and `page_for_in(leaderboard_name, member, page_size = DEFAULT_PAGE_SIZE)` calls to allow you to determine the page where a member falls in the leaderboard
+
 ## leaderboard 2.0.3 (2012-02-22)
 
  * Added `:reverse => false` to `Leaderboard::DEFAULT_OPTIONS` to support leaderboards sorted from lowest to highest score instead of highest to lowest score. (Thanks @siuying)

data/README.markdown

@@ -163,6 +163,7 @@ Get rank and score for an arbitrary list of members (e.g. friends):
   score_and_rank_for(member): Retrieve the score and rank for a member in a single call
   remove_members_in_score_range(min_score, max_score): Remove members from the leaderboard within a score range
   percentile_for(member): Calculate the percentile for a given member
+  page_for(member, page_size): Determine the page where a member falls in the leaderboard
   merge_leaderboards(destination, keys, options = {:aggregate => :min}): Merge leaderboards given by keys with this leaderboard into destination
   intersect_leaderboards(destination, keys, options = {:aggregate => :min}): Intersect leaderboards given by keys with this leaderboard into destination
 ```

data/Rakefile

@@ -1,8 +1,7 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
+require 'bundler/gem_tasks'
 require 'rake'
 require 'rake/testtask'
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
   test.pattern = 'test/**/test_*.rb'
@@ -20,9 +19,6 @@ task :default => :run
 desc "Run tests and manage server start/stop"
 task :run => [:start, :test, :stop]
 
-desc "Run rcov and manage server start/stop"
-task :rcoverage => [:start, :rcov, :stop]
-
 desc "Start the Redis server"
 task :start do
   redis_running = \

data/lib/leaderboard.rb

@@ -343,6 +343,37 @@ class Leaderboard
       percentile
     end
   end
+
+  # Determine the page where a member falls in the leaderboard.
+  #
+  # @param member [String] Member name.
+  # @param page_size [int] Page size to be used in determining page location.
+  #
+  # @return the page where a member falls in the leaderboard.
+  def page_for(member, page_size = DEFAULT_PAGE_SIZE)
+    page_for_in(@leaderboard_name, member, page_size)
+  end
+
+  # Determine the page where a member falls in the named leaderboard.
+  #
+  # @param leaderboard [String] Name of the leaderboard.
+  # @param member [String] Member name.
+  # @param page_size [int] Page size to be used in determining page location.
+  #
+  # @return the page where a member falls in the leaderboard.
+  def page_for_in(leaderboard_name, member, page_size = DEFAULT_PAGE_SIZE)
+    rank_for_member = @reverse ? 
+      @redis_connection.zrank(leaderboard_name, member) : 
+      @redis_connection.zrevrank(leaderboard_name, member)
+
+    if rank_for_member.nil?
+      rank_for_member = 0
+    else
+      rank_for_member += 1
+    end
+
+    (rank_for_member.to_f / page_size.to_f).ceil    
+  end
     
   # Retrieve a page of leaders from the leaderboard.
   # 

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '2.0.3'.freeze
+  VERSION = '2.0.4'.freeze
 end

data/test/test_helper.rb

@@ -2,3 +2,18 @@ require 'rubygems'
 require 'test/unit'
 
 require 'leaderboard'
+
+class LeaderboardTest < Test::Unit::TestCase
+
+  def test_version
+    assert_equal '2.0.4', Leaderboard::VERSION
+  end
+
+  private
+  
+  def rank_members_in_leaderboard(members_to_add = 5)
+    1.upto(members_to_add) do |index|
+      @leaderboard.rank_member("member_#{index}", index)
+    end
+  end
+end

data/test/test_leaderboard.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TestLeaderboard < Test::Unit::TestCase
+class TestLeaderboard < LeaderboardTest
   def setup    
     @redis_connection = Redis.new(:host => "127.0.0.1")
     @leaderboard = Leaderboard.new('name', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1")
@@ -11,11 +11,7 @@ class TestLeaderboard < Test::Unit::TestCase
     @leaderboard.disconnect
     @redis_connection.client.disconnect
   end
-  
-  def test_version
-    assert_equal '2.0.3', Leaderboard::VERSION
-  end
-  
+    
   def test_initialize_with_defaults  
     assert_equal 'name', @leaderboard.leaderboard_name
     assert_equal Leaderboard::DEFAULT_PAGE_SIZE, @leaderboard.page_size
@@ -456,11 +452,19 @@ class TestLeaderboard < Test::Unit::TestCase
     assert_equal 5.0, @leaderboard.score_for('jones')
   end
 
-  private
-  
-  def rank_members_in_leaderboard(members_to_add = 5)
-    1.upto(members_to_add) do |index|
-      @leaderboard.rank_member("member_#{index}", index)
-    end
+  def test_page_for
+    assert_equal 0, @leaderboard.page_for('jones')
+
+    rank_members_in_leaderboard(20)
+
+    assert_equal 1, @leaderboard.page_for('member_17')
+    assert_equal 1, @leaderboard.page_for('member_11')
+    assert_equal 1, @leaderboard.page_for('member_10')
+    assert_equal 1, @leaderboard.page_for('member_1')
+
+    assert_equal 1, @leaderboard.page_for('member_17', 10)
+    assert_equal 1, @leaderboard.page_for('member_11', 10)
+    assert_equal 2, @leaderboard.page_for('member_10', 10)
+    assert_equal 2, @leaderboard.page_for('member_1', 10)
   end
 end

data/test/test_rev_leaderboard.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TestRevLeaderboard < Test::Unit::TestCase
+class TestRevLeaderboard < LeaderboardTest
   def setup    
     @redis_connection = Redis.new(:host => "127.0.0.1")
     @leaderboard = Leaderboard.new('name', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS.merge({:reverse => true}), :host => "127.0.0.1")
@@ -11,11 +11,7 @@ class TestRevLeaderboard < Test::Unit::TestCase
     @leaderboard.disconnect
     @redis_connection.client.disconnect
   end
-  
-  def test_version
-    assert_equal '2.0.3', Leaderboard::VERSION
-  end
-  
+    
   def test_initialize_with_defaults  
     assert_equal 'name', @leaderboard.leaderboard_name
     assert_equal Leaderboard::DEFAULT_PAGE_SIZE, @leaderboard.page_size
@@ -456,11 +452,19 @@ class TestRevLeaderboard < Test::Unit::TestCase
     assert_equal 5.0, @leaderboard.score_for('jones')
   end
 
-  private
-  
-  def rank_members_in_leaderboard(members_to_add = 5)
-    1.upto(members_to_add) do |index|
-      @leaderboard.rank_member("member_#{index}", index)
-    end
+  def test_page_for
+    assert_equal 0, @leaderboard.page_for('jones')
+
+    rank_members_in_leaderboard(20)
+
+    assert_equal 1, @leaderboard.page_for('member_17')
+    assert_equal 1, @leaderboard.page_for('member_11')
+    assert_equal 1, @leaderboard.page_for('member_10')
+    assert_equal 1, @leaderboard.page_for('member_1')
+
+    assert_equal 1, @leaderboard.page_for('member_10', 10)
+    assert_equal 1, @leaderboard.page_for('member_1', 10)
+    assert_equal 2, @leaderboard.page_for('member_17', 10)
+    assert_equal 2, @leaderboard.page_for('member_11', 10)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-22 00:00:00.000000000 Z
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &2157419300 !ruby/object:Gem::Requirement
+  requirement: &70133210061060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157419300
+  version_requirements: *70133210061060
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2157418880 !ruby/object:Gem::Requirement
+  requirement: &70133210060620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2157418880
+  version_requirements: *70133210060620
 description: Leaderboards backed by Redis in Ruby
 email:
 - dczarnecki@agoragames.com
@@ -40,7 +40,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
 - .gitignore
 - .rvmrc
 - CHANGELOG.markdown
@@ -70,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2153712714897513648
+      hash: 182894351603387394
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -79,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2153712714897513648
+      hash: 182894351603387394
 requirements: []
 rubyforge_project: leaderboard
 rubygems_version: 1.8.10

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt