leaderboard 2.0.0 → 2.0.1

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# leaderboard 2.0.1 (2011-11-07)
+
+ * Allow for only single options to be passed to `leaders`, `around_me` and `ranked_in_list` methods - https://github.com/agoragames/leaderboard/issues/4
+ * Added `percentile_for(member)` and `percentile_for_in(leaderboard_name, member)` methods to calculate percentile for a given member
+ 
 # leaderboard 2.0.0 (2011-08-05)
  
  * Change `add_member` to `rank_member` - https://github.com/agoragames/leaderboard/issues/3

data/Gemfile

@@ -3,10 +3,11 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
+  gem "bundler"
+  gem "jeweler"
+  gem "rcov"
+  gem "rdoc"
 end
 
-gem 'redis', "~> 2.2.0"
+gem 'redis'
 

data/README.rdoc

@@ -8,7 +8,7 @@ Builds off ideas proposed in http://blog.agoragames.com/2011/01/01/creating-high
 
 Install the gem:
 
-  gem "leaderboard", "~> 2.0.0"
+  gem "leaderboard", "~> 2.0.1"
 	
 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.
@@ -77,10 +77,10 @@ Get page 1 in the leaderboard:
   ruby-1.9.2-p180 :025 > highscore_lb.leaders(1)
    => [{:member=>"member_10", :rank=>1, :score=>10.0}, {:member=>"member_9", :rank=>2, :score=>9.0}, {:member=>"member_8", :rank=>3, :score=>8.0}, {:member=>"member_7", :rank=>4, :score=>7.0}, {:member=>"member_6", :rank=>5, :score=>6.0}, {:member=>"member_5", :rank=>6, :score=>5.0}, {:member=>"member_4", :rank=>7, :score=>4.0}, {:member=>"member_3", :rank=>8, :score=>3.0}, {:member=>"member_2", :rank=>9, :score=>2.0}, {:member=>"member_1", :rank=>10, :score=>1.0}] 
 	
-You can pass various options to the calls `leaders`, `around_me` and `ranked_in_list`. Valid options are :with_scores, :with_rank, :use_zero_index_for_rank and :page_size. 
+You can pass various options to the calls `leaders`, `around_me` and `ranked_in_list`. Valid options are `:with_scores`, `:with_rank`, `:use_zero_index_for_rank` and `:page_size`.
 Below is an example of retrieving the first page in the leaderboard without ranks:
 
-  ruby-1.9.2-p180 :026 > highscore_lb.leaders(1, :with_scores => true, :with_rank => false, :use_zero_index_for_rank => false)
+  ruby-1.9.2-p180 :026 > highscore_lb.leaders(1, :with_rank => false)
    => [{:member=>"member_10", :score=>9.0}, {:member=>"member_9", :score=>7.0}, {:member=>"member_8", :score=>5.0}, {:member=>"member_7", :score=>3.0}, {:member=>"member_6", :score=>1.0}, {:member=>"member_5", :score=>0.0}, {:member=>"member_4", :score=>0.0}, {:member=>"member_3", :score=>0.0}, {:member=>"member_2", :score=>0.0}, {:member=>"member_1", :score=>0.0}] 
 
 Below is an example of retrieving the first page in the leaderboard without scores or ranks:
@@ -120,6 +120,7 @@ Get rank and score for an arbitrary list of members (e.g. friends):
   check_member?(member): Check to see whether member is in the leaderboard
   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
   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
 
@@ -178,6 +179,16 @@ Average time to request an arbitrary page from the leaderboard:
 == Future Ideas
 
 * Bulk insert
+
+== Ports
+
+The following ports have been made of the leaderboard gem.
+
+* Java: https://github.com/agoragames/java-leaderboard
+* NodeJS: https://github.com/omork/node-leaderboard
+* PHP: https://github.com/agoragames/php-leaderboard
+* Python: https://github.com/agoragames/python-leaderboard
+* Scala: https://github.com/agoragames/scala-leaderboard
   
 == Contributing to leaderboard
  

data/Rakefile

@@ -40,8 +40,8 @@ Rcov::RcovTask.new do |test|
   test.verbose = true
 end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
@@ -89,5 +89,5 @@ task :stop do
 end
 
 task :test_rubies do
-  system "rvm 1.8.7@leaderboard_gem,1.9.2@leaderboard_gem rake test"
+  system "rvm 1.8.7@leaderboard_gem,1.9.2@leaderboard_gem do rake test"
 end

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1

data/leaderboard.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{leaderboard}
-  s.version = "2.0.0"
+  s.name = "leaderboard"
+  s.version = "2.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{David Czarnecki}]
-  s.date = %q{2011-08-17}
-  s.description = %q{Leaderboards backed by Redis in Ruby}
-  s.email = %q{dczarnecki@agoragames.com}
+  s.authors = ["David Czarnecki"]
+  s.date = "2011-11-07"
+  s.description = "Leaderboards backed by Redis in Ruby"
+  s.email = "dczarnecki@agoragames.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -32,11 +32,11 @@ Gem::Specification.new do |s|
     "test/test.conf",
     "test/test_leaderboard.rb"
   ]
-  s.homepage = %q{http://github.com/agoragames/leaderboard}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{Leaderboards backed by Redis in Ruby}
+  s.homepage = "http://github.com/agoragames/leaderboard"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Leaderboards backed by Redis in Ruby"
   s.test_files = [
     "test/helper.rb",
     "test/test_leaderboard.rb"
@@ -46,21 +46,24 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<redis>, ["~> 2.2.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_runtime_dependency(%q<redis>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
     else
-      s.add_dependency(%q<redis>, ["~> 2.2.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<redis>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
     end
   else
-    s.add_dependency(%q<redis>, ["~> 2.2.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<redis>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
   end
 end
 

data/lib/leaderboard.rb

@@ -1,7 +1,7 @@
 require 'redis'
 
 class Leaderboard
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.0.1'.freeze
   
   DEFAULT_PAGE_SIZE = 25
   DEFAULT_OPTIONS = {
@@ -23,7 +23,7 @@ class Leaderboard
   }
   
   attr_reader :leaderboard_name
-  attr_accessor :page_size
+  attr_reader :page_size
   
   def initialize(leaderboard_name, options = DEFAULT_OPTIONS, redis_options = DEFAULT_REDIS_OPTIONS)
     @leaderboard_name = leaderboard_name
@@ -162,16 +162,32 @@ class Leaderboard
     @redis_connection.zremrangebyscore(leaderboard_name, min_score, max_score)
   end
   
-  def leaders(current_page, options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
+  def percentile_for(member)
+    percentile_for_in(@leaderboard_name, member)
+  end
+ 
+  def percentile_for_in(leaderboard_name, member)
+    responses = @redis_connection.multi do |transaction|
+      transaction.zcard(leaderboard_name)     
+      transaction.zrevrank(leaderboard_name, member)
+    end
+       
+    ((responses[0] - responses[1] - 1).to_f / responses[0].to_f * 100).ceil
+  end
+    
+  def leaders(current_page, options = {})
     leaders_in(@leaderboard_name, current_page, options)
   end
 
-  def leaders_in(leaderboard_name, current_page, options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
+  def leaders_in(leaderboard_name, current_page, options = {})
+    leaderboard_options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS.dup
+    leaderboard_options.merge!(options)
+    
     if current_page < 1
       current_page = 1
     end
         
-    page_size = validate_page_size(options[:page_size]) || @page_size
+    page_size = validate_page_size(leaderboard_options[:page_size]) || @page_size
     
     if current_page > total_pages_in(leaderboard_name, page_size)
       current_page = total_pages_in(leaderboard_name, page_size)
@@ -188,20 +204,23 @@ class Leaderboard
         
     raw_leader_data = @redis_connection.zrevrange(leaderboard_name, starting_offset, ending_offset, :with_scores => false)    
     if raw_leader_data
-      return ranked_in_list_in(leaderboard_name, raw_leader_data, options)
+      return ranked_in_list_in(leaderboard_name, raw_leader_data, leaderboard_options)
     else
       return []
     end
   end
   
-  def around_me(member, options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
+  def around_me(member, options = {})
     around_me_in(@leaderboard_name, member, options)
   end
   
-  def around_me_in(leaderboard_name, member, options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
+  def around_me_in(leaderboard_name, member, options = {})
+    leaderboard_options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS.dup
+    leaderboard_options.merge!(options)
+    
     reverse_rank_for_member = @redis_connection.zrevrank(leaderboard_name, member)
     
-    page_size = validate_page_size(options[:page_size]) || @page_size
+    page_size = validate_page_size(leaderboard_options[:page_size]) || @page_size
     
     starting_offset = reverse_rank_for_member - (page_size / 2)
     if starting_offset < 0
@@ -212,42 +231,47 @@ class Leaderboard
     
     raw_leader_data = @redis_connection.zrevrange(leaderboard_name, starting_offset, ending_offset, :with_scores => false)
     if raw_leader_data
-      return ranked_in_list_in(leaderboard_name, raw_leader_data, options)
+      return ranked_in_list_in(leaderboard_name, raw_leader_data, leaderboard_options)
     else
       return []
     end
   end
   
-  def ranked_in_list(members, options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
+  def ranked_in_list(members, options = {})
     ranked_in_list_in(@leaderboard_name, members, options)
   end
   
-  def ranked_in_list_in(leaderboard_name, members, options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
+  def ranked_in_list_in(leaderboard_name, members, options = {})
+    leaderboard_options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS.dup
+    leaderboard_options.merge!(options)
+    
     ranks_for_members = []
     
     responses = @redis_connection.multi do |transaction|
       members.each do |member|
-        transaction.zrevrank(leaderboard_name, member) if options[:with_rank]
-        transaction.zscore(leaderboard_name, member) if options[:with_scores]
+        transaction.zrevrank(leaderboard_name, member) if leaderboard_options[:with_rank]
+        transaction.zscore(leaderboard_name, member) if leaderboard_options[:with_scores]
       end
     end
     
     members.each_with_index do |member, index|
       data = {}
       data[:member] = member
-      if options[:with_scores]
-        if options[:with_rank]
-          if options[:use_zero_index_for_rank]
+      if leaderboard_options[:with_scores]
+        if leaderboard_options[:with_rank]
+          if leaderboard_options[:use_zero_index_for_rank]
             data[:rank] = responses[index * 2]
           else
             data[:rank] = responses[index * 2] + 1
           end
+          
+          data[:score] = responses[index * 2 + 1].to_f
+        else
+          data[:score] = responses[index].to_f          
         end
-
-        data[:score] = responses[index * 2 + 1].to_f
       else
-        if options[:with_rank]
-          if options[:use_zero_index_for_rank]
+        if leaderboard_options[:with_rank]
+          if leaderboard_options[:use_zero_index_for_rank]
             data[:rank] = responses[index]
           else
             data[:rank] = responses[index] + 1

data/test/test_leaderboard.rb

@@ -13,7 +13,7 @@ class TestLeaderboard < Test::Unit::TestCase
   end
   
   def test_version
-    assert_equal '2.0.0', Leaderboard::VERSION
+    assert_equal '2.0.1', Leaderboard::VERSION
   end
   
   def test_initialize_with_defaults  
@@ -134,7 +134,7 @@ class TestLeaderboard < Test::Unit::TestCase
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
     
     assert_equal Leaderboard::DEFAULT_PAGE_SIZE, @leaderboard.total_members
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_ranks => false})
+    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false})
 
     member_25 = {:member => 'member_25'}
     assert_equal member_25, leaders[0]
@@ -143,6 +143,41 @@ class TestLeaderboard < Test::Unit::TestCase
     assert_equal member_1, leaders[24]
   end
   
+  def test_leaders_with_only_various_options_should_respect_other_defaults
+    rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE + 1)
+
+    leaders = @leaderboard.leaders(1, :page_size => 1)
+    assert_equal 1, leaders.size
+    
+    leaders = @leaderboard.leaders(1, :with_rank => false)
+    assert_equal Leaderboard::DEFAULT_PAGE_SIZE, leaders.size
+    member_26 = {:member => 'member_26', :score => 26}
+    member_25 = {:member => 'member_25', :score => 25}
+    member_24 = {:member => 'member_24', :score => 24}
+    assert_equal member_26, leaders[0]
+    assert_equal member_25, leaders[1]    
+    assert_equal member_24, leaders[2]    
+
+    leaders = @leaderboard.leaders(1, :with_scores => false)
+    assert_equal Leaderboard::DEFAULT_PAGE_SIZE, leaders.size
+    member_26 = {:member => 'member_26', :rank => 1}
+    member_25 = {:member => 'member_25', :rank => 2}
+    assert_equal member_26, leaders[0]
+    assert_equal member_25, leaders[1]
+
+    leaders = @leaderboard.leaders(1, :with_scores => false, :with_rank => false)
+    assert_equal Leaderboard::DEFAULT_PAGE_SIZE, leaders.size
+    member_26 = {:member => 'member_26'}
+    member_25 = {:member => 'member_25'}
+    assert_equal member_26, leaders[0]
+    assert_equal member_25, leaders[1]
+
+    leaders = @leaderboard.leaders(1, :with_rank => false, :page_size => 1)
+    assert_equal 1, leaders.size
+    member_26 = {:member => 'member_26', :score => 26}
+    assert_equal member_26, leaders[0]
+  end
+  
   def test_around_me
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE * 3 + 1)
 
@@ -374,6 +409,16 @@ class TestLeaderboard < Test::Unit::TestCase
     assert_equal 'member_29', leaders_around_me[2][:member]
   end
   
+  def test_percentile_for
+    rank_members_in_leaderboard(12)
+    
+    assert_equal 0, @leaderboard.percentile_for('member_1')
+    assert_equal 9, @leaderboard.percentile_for('member_2')
+    assert_equal 17, @leaderboard.percentile_for('member_3')
+    assert_equal 25, @leaderboard.percentile_for('member_4')
+    assert_equal 92, @leaderboard.percentile_for('member_12')
+  end
+  
   private
   
   def rank_members_in_leaderboard(members_to_add = 5)

metadata

@@ -1,68 +1,82 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: leaderboard
-version: !ruby/object:Gem::Version
-  version: 2.0.0
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 2.0.1
 platform: ruby
-authors:
+authors: 
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-17 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-11-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: redis
-  requirement: &70114074547140 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.2.0
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
   prerelease: false
-  version_requirements: *70114074547140
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &70114074545640 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *70114074545640
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  requirement: &70114074543920 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.2
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *70114074543920
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: rcov
-  requirement: &70114074539440 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *70114074539440
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
 description: Leaderboards backed by Redis in Ruby
 email: dczarnecki@agoragames.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
-files:
+files: 
 - .document
 - .rvmrc
 - CHANGELOG.markdown
@@ -78,33 +92,35 @@ files:
 - test/test.conf
 - test/test_leaderboard.rb
 homepage: http://github.com/agoragames/leaderboard
-licenses:
+licenses: 
 - MIT
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 2535082084974160649
+      segments: 
       - 0
-      hash: -2495258638232902776
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Leaderboards backed by Redis in Ruby
-test_files:
+test_files: 
 - test/helper.rb
 - test/test_leaderboard.rb