leaderboard 3.0.0.rc1 → 3.0.0.rc2

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## leaderboard 3.0.0.rc2 (2012-11-27)
+
+* No longer cast scores to a floating point automatically. If requesting a score for an unknown member in the leaderboard, return `nil`. Under the old behavior, a `nil` score gets returned as 0.0. This is misleading as 0.0 is a valid score.
+
 ## leaderboard 3.0.0.rc1 (2012-11-08)
 
 * Removes `:use_zero_index_for_rank_option` as valid option for requesting data from the leaderboard. [Original proposal](https://github.com/agoragames/leaderboard/pull/27)

data/lib/leaderboard.rb

@@ -120,7 +120,7 @@ class Leaderboard
   # @param member [String] Member name.
   # @param score [float] Member score.
   # @param member_data [Hash] Optional member data.
-  def rank_member_in(leaderboard_name, member, score, member_data)
+  def rank_member_in(leaderboard_name, member, score, member_data = nil)
     @redis_connection.multi do |transaction|
       transaction.zadd(leaderboard_name, score, member)
       transaction.hset(member_data_key(leaderboard_name), member, member_data) if member_data
@@ -320,7 +320,7 @@ class Leaderboard
   #
   # @param member Member name.
   #
-  # @return the score for a member in the leaderboard.
+  # @return the score for a member in the leaderboard or +nil+ if the member is not in the leaderboard.
   def score_for(member)
     score_for_in(@leaderboard_name, member)
   end
@@ -330,9 +330,10 @@ class Leaderboard
   # @param leaderboard_name Name of the leaderboard.
   # @param member [String] Member name.
   #
-  # @return the score for a member in the leaderboard.
+  # @return the score for a member in the leaderboard or +nil+ if the member is not in the leaderboard.
   def score_for_in(leaderboard_name, member)
-    @redis_connection.zscore(leaderboard_name, member).to_f
+    score = @redis_connection.zscore(leaderboard_name, member) 
+    score.to_f if score
   end
 
   # Check to see if a member exists in the leaderboard.
@@ -379,7 +380,7 @@ class Leaderboard
       end
     end
 
-    responses[0] = responses[0].to_f
+    responses[0] = responses[0].to_f if responses[0]
     responses[1] = responses[1] + 1 rescue nil
     
     {:member => member, :score => responses[0], :rank => responses[1]}    
@@ -790,7 +791,7 @@ class Leaderboard
       data = {}
       data[:member] = member
       data[:rank] = responses[index * 2] + 1 rescue nil
-      data[:score] = responses[index * 2 + 1].to_f
+      data[:score] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
 
       if leaderboard_options[:with_member_data]
         data[:member_data] = member_data_for_in(leaderboard_name, member)

data/lib/leaderboard/version.rb

@@ -1,4 +1,4 @@
 class Leaderboard
   # Leaderboard version
-  VERSION = '3.0.0.rc1'.freeze
+  VERSION = '3.0.0.rc2'.freeze
 end

data/spec/leaderboard_spec.rb

@@ -75,6 +75,7 @@ describe 'Leaderboard' do
     rank_members_in_leaderboard(5)
 
     @leaderboard.score_for('member_4').should eql(4.0)
+    @leaderboard.score_for('jones').should be_nil
   end
 
   it 'should return the correct total pages' do
@@ -477,7 +478,7 @@ describe 'Leaderboard' do
     score_and_rank_for_member = @leaderboard.score_and_rank_for('jones')
 
     score_and_rank_for_member[:member].should eql('jones')
-    score_and_rank_for_member[:score].should eql(0.0)
+    score_and_rank_for_member[:score].should be_nil
     score_and_rank_for_member[:rank].should be_nil
   end
 
@@ -498,7 +499,7 @@ describe 'Leaderboard' do
   end
 
   it 'should allow you to change the score for a member not in the leaderboard' do
-    @leaderboard.score_for('jones').should eql(0.0)
+    @leaderboard.score_for('jones').should be_nil
     @leaderboard.change_score_for('jones', 5)
     @leaderboard.score_for('jones').should eql(5.0)
   end
@@ -630,4 +631,15 @@ describe 'Leaderboard' do
     ranked_members[2][:rank].should be(16)
     ranked_members[2][:score].should eql(10.0)
   end
+
+  it 'should return nil for the score and rank for ranked_in_list if a member is not in the leaderboard' do
+    rank_members_in_leaderboard
+
+    ranked_members = @leaderboard.ranked_in_list(['jones'])
+
+    ranked_members.size.should be(1)
+    ranked_members[0][:member].should eql('jones')
+    ranked_members[0][:score].should be_nil
+    ranked_members[0][:rank].should be_nil
+  end
 end

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.0.0.rc1'
+    Leaderboard::VERSION.should == '3.0.0.rc2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -93,9 +93,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -395088559469707987
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: