leaderboard 3.3.0 → 3.4.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDg1OTQ1OTc4MzkzY2I4Mzc5ZjEwZWVlZTU3M2QzMTdlZDc2MmM4MQ==
+  data.tar.gz: !binary |-
+    YjEwOWE0Mzk3NjA1YjA5NzlmYzQ0OWQ0ODliN2E1NjFjYzE4MTkzMA==
+SHA512:
+  metadata.gz: !binary |-
+    MWNmY2NjNmU5NGJkMzM0ZGViZGNiZTE5MGU4ZTZjYTIxZGYwNGJiNzU3N2Uz
+    YjBjOTlhZmJiYjIyNTk5NTE3NDdhYTE0Mjc5OWQ5YWI5MWEwNDQyM2U4ODQ3
+    MTUzMzJhYWEwN2YwNTBkNjUxZTI5OTcyMDNiYjQ5M2IyOTUzNjQ=
+  data.tar.gz: !binary |-
+    MzlmOTczZDJkMDNhNWM0ZDdmYzNlNzE5Y2VmOTcwMmI4MTVlMWY0ZjUwMWIw
+    ZTIxYTYwODgyMWJjYThlZjY1Yzg4YjhlNjcwMzI5NjljZmYwZjI4YzljNDgy
+    ZWY4NGI3ZWMzZDc0MzJiYjAwOGYyNmM2NzA0ZDVjZGJkNWQ0ZDY=

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.4.0 (2013-11-12)
+
+* Added `score_for_percentile` method to be able to calculate the score for a given percentile value in the leaderboard.
+
 ## 3.3.0 (2013-07-17)
 
 * Added `rank_member_across` method to be able to rank a member across multiple leaderboards at once.

data/README.markdown

@@ -319,6 +319,7 @@ highscore_lb.rank_member_across(['highscores', 'more_highscores'], 'david', 5000
   remove_members_in_score_range(min_score, max_score): Remove members from the leaderboard within a score range
   remove_members_outside_rank(rank): Remove members from the leaderboard outside a given rank
   percentile_for(member): Calculate the percentile for a given member
+  score_for_percentile(percentile): Calculate the score for a given percentile value in the leaderboard
   page_for(member, page_size): Determine the page where a member falls in the leaderboard
   expire_leaderboard(seconds): Expire the leaderboard in a set number of seconds.
   expire_leaderboard_at(timestamp): Expire the leaderboard at a specific UNIX timestamp.

data/lib/leaderboard.rb

@@ -512,6 +512,45 @@ class Leaderboard
     end
   end
 
+  # Calculate the score for a given percentile value in the leaderboard.
+  #
+  # @param percentile [float] Percentile value (0.0 to 100.0 inclusive)
+  def score_for_percentile(percentile)
+    score_for_percentile_in(@leaderboard_name, percentile)
+  end
+
+  # Calculate the score for a given percentile value in the named leaderboard.
+  #
+  # See http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm for
+  # implementation details (there are differing methods for calculating
+  # percentile scores that do not fall directly upon a ranked item; we are
+  # using the method specified by NIST, i.e. linear interpolation).
+  #
+  # @param percentile [float] Percentile value (0.0 to 100.0 inclusive)
+  def score_for_percentile_in(leaderboard_name, percentile)
+    return nil unless percentile.between?(0, 100)
+
+    total_members = total_members_in(leaderboard_name)
+    return nil if total_members < 1
+
+    if @reverse
+      percentile = 100 - percentile
+    end
+
+    index = (total_members - 1) * (percentile / 100.0)
+
+    scores = @redis_connection.zrange(
+      leaderboard_name, index.floor, index.ceil, :with_scores => true
+    ).map{ |pair| pair.last }
+
+    if index == index.floor
+      scores[0]
+    else
+      interpolate_fraction = index - index.floor
+      scores[0] + interpolate_fraction * (scores[1] - scores[0])
+    end
+  end
+
   # Determine the page where a member falls in the leaderboard.
   #
   # @param member [String] Member name.

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '3.3.0'.freeze
+  VERSION = '3.4.0'.freeze
 end

data/spec/leaderboard_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'Leaderboard' do
   before(:each) do
     @redis_connection = Redis.new(:host => "127.0.0.1", :db => 15)
-    @leaderboard = Leaderboard.new('name', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    @leaderboard = Leaderboard.new('name', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
   end
 
   after(:each) do
@@ -30,7 +30,7 @@ describe 'Leaderboard' do
   end
 
   it 'should set the page size to the default page size if passed an invalid value' do
-    some_leaderboard = Leaderboard.new('name', {:page_size => 0})
+    some_leaderboard = Leaderboard.new('name', {:page_size => 0}, {:host => "127.0.0.1", :db => 15})
 
     some_leaderboard.page_size.should be(Leaderboard::DEFAULT_PAGE_SIZE)
     some_leaderboard.disconnect
@@ -371,8 +371,8 @@ describe 'Leaderboard' do
   end
 
   it 'should allow you to merge leaderboards' do
-    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
-    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 
     foo.rank_member('foo_1', 1)
     foo.rank_member('foo_2', 2)
@@ -383,7 +383,7 @@ describe 'Leaderboard' do
     foobar_keys = foo.merge_leaderboards('foobar', ['bar'])
     foobar_keys.should be(5)
 
-    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
     foobar.total_members.should be(5)
 
     first_leader_in_foobar = foobar.leaders(1).first
@@ -397,8 +397,8 @@ describe 'Leaderboard' do
   end
 
   it 'should allow you to intersect leaderboards' do
-    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
-    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 
     foo.rank_member('foo_1', 1)
     foo.rank_member('foo_2', 2)
@@ -410,7 +410,7 @@ describe 'Leaderboard' do
     foobar_keys = foo.intersect_leaderboards('foobar', ['bar'], {:aggregate => :max})
     foobar_keys.should be(2)
 
-    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
     foobar.total_members.should be(2)
 
     first_leader_in_foobar = foobar.leaders(1).first
@@ -479,6 +479,16 @@ describe 'Leaderboard' do
     @leaderboard.percentile_for('member_12').should eql(92)
   end
 
+  it 'should return the correct information when calling score_for_percentile' do
+    rank_members_in_leaderboard(5)
+
+    @leaderboard.score_for_percentile(0).should eql(1.0)
+    @leaderboard.score_for_percentile(75).should eql(4.0)
+    @leaderboard.score_for_percentile(87.5).should eql(4.5)
+    @leaderboard.score_for_percentile(93.75).should eql(4.75)
+    @leaderboard.score_for_percentile(100).should eql(5.0)
+  end
+
   it 'should not throw an exception when calling around_me with a member not in the leaderboard' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE * 3 + 1)
 

data/spec/reverse_leaderboard_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'Leaderboard (reverse option)' do
   before(:each) do
     @redis_connection = Redis.new(:host => "127.0.0.1", :db => 15)
-    @leaderboard = Leaderboard.new('name', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS.merge({:reverse => true}), :host => "127.0.0.1", :db => 15)
+    @leaderboard = Leaderboard.new('name', Leaderboard::DEFAULT_OPTIONS.merge({:reverse => true}), {:host => "127.0.0.1", :db => 15})
   end
 
   after(:each) do
@@ -186,8 +186,8 @@ describe 'Leaderboard (reverse option)' do
   end
 
   it 'should allow you to merge leaderboards' do
-    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
-    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 
     foo.rank_member('foo_1', 1)
     foo.rank_member('foo_2', 2)
@@ -198,7 +198,7 @@ describe 'Leaderboard (reverse option)' do
     foobar_keys = foo.merge_leaderboards('foobar', ['bar'])
     foobar_keys.should be(5)
 
-    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
     foobar.total_members.should be(5)
 
     first_leader_in_foobar = foobar.leaders(1).first
@@ -212,8 +212,8 @@ describe 'Leaderboard (reverse option)' do
   end
 
   it 'should allow you to intersect leaderboards' do
-    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
-    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foo = Leaderboard.new('foo', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+    bar = Leaderboard.new('bar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 
     foo.rank_member('foo_1', 1)
     foo.rank_member('foo_2', 2)
@@ -225,7 +225,7 @@ describe 'Leaderboard (reverse option)' do
     foobar_keys = foo.intersect_leaderboards('foobar', ['bar'], {:aggregate => :max})
     foobar_keys.should be(2)
 
-    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
+    foobar = Leaderboard.new('foobar', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
     foobar.total_members.should be(2)
 
     first_leader_in_foobar = foobar.leaders(1).first
@@ -275,6 +275,16 @@ describe 'Leaderboard (reverse option)' do
     @leaderboard.percentile_for('member_12').should eql(8)
   end
 
+  it 'should return the correct information when calling score_for_percentile' do
+    rank_members_in_leaderboard(5)
+
+    @leaderboard.score_for_percentile(0).should eql(5.0)
+    @leaderboard.score_for_percentile(75).should eql(2.0)
+    @leaderboard.score_for_percentile(87.5).should eql(1.5)
+    @leaderboard.score_for_percentile(93.75).should eql(1.25)
+    @leaderboard.score_for_percentile(100).should eql(1.0)
+  end
+
   it 'should return the correct page when calling page_for a given member in the leaderboard' do
     @leaderboard.page_for('jones').should be(0)
 

data/spec/version_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe 'Leaderboard::VERSION' do
   it 'should be the correct version' do
-    Leaderboard::VERSION.should == '3.3.0'
+    Leaderboard::VERSION.should == '3.4.0'
   end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.3.0
-  prerelease: 
+  version: 3.4.0
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-11-12 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
@@ -86,33 +79,26 @@ files:
 homepage: https://github.com/agoragames/leaderboard
 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'
-      segments:
-      - 0
-      hash: 1089001734082897595
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1089001734082897595
 requirements: []
 rubyforge_project: leaderboard
-rubygems_version: 1.8.25
+rubygems_version: 2.1.10
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Leaderboards backed by Redis in Ruby
 test_files:
 - spec/leaderboard_spec.rb