leaderboard 3.9.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f50c3a3b7020a18f0f1748f97bfd562958d13ea
-  data.tar.gz: 3f322fef803e8b098265f4282c2131c93ca75507
+  metadata.gz: 0e2258ac4147cfe36d76299662c67d8ac5f360de
+  data.tar.gz: 50896b7f86ae70b0339551f8b0afd5ce32383353
 SHA512:
-  metadata.gz: 1060d4cc1804f92ca1005bc39e7ecab287faa29e6a926fad090f6403f666b68cde60152d5c93608715484b1094f8608fc15b6798cec0dbe7f926782475de1f23
-  data.tar.gz: 0eca6086b8c7db70f505d933749173c3dc91399c23fe1ee91920f8e7d3b380c2506761d7195af6b84aaecd4d11091fa6ce91d93364cd427f8d3eed43be67c7d7
+  metadata.gz: dba84526f444d7494f2ea0a21ec8e8fd90b408f7477c1a9abe06cc6f9ff688f90e17935bebbdb71ca2261593608e61b610d8441cda7d161dda74306294308bed
+  data.tar.gz: 5c25f504a4ba53fcdc109692a82b09b50fef8711ab3521b9a2a9d303c3dd9a83caa305297df510974029c5d4ba98bf696d515a6411025b82c5bc7c9f34950093

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.2
+ruby-2.2.1

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.2
-  - 1.9.3
+  - 2.2.1
 services:
-  - redis-server
+  - redis-server

data/CHANGELOG.markdown

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 3.10.0 (2015-03-20)
+
+* Fixes TieRankingLeaderboard doesn't rank if the score is 0 [#53](https://github.com/agoragames/leaderboard/issues/53).
+* Allow member data to be set in the `change_score_for(...)` method.
+* Add `:include_missing` option in leaderboard request options to change
+  whether or not to include missing members in the result.
+
 ## 3.9.0 (2015-02-15)
 
 * Add `global_member_data` option that allows multiple leaderboards to share the same set of member_data. [#51](https://github.com/agoragames/leaderboard/pull/51)

data/lib/competition_ranking_leaderboard.rb

@@ -72,6 +72,10 @@ class CompetitionRankingLeaderboard < Leaderboard
       data[@member_key] = member
       unless leaderboard_options[:members_only]
         data[@score_key] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
+        if data[@score_key] == nil
+          next unless leaderboard_options[:include_missing]
+        end
+
         if @reverse
           data[@rank_key] = @redis_connection.zcount(leaderboard_name, '-inf', "(#{data[@score_key]}") + 1 rescue nil
         else

data/lib/leaderboard.rb

@@ -41,7 +41,8 @@ class Leaderboard
     :with_member_data => false,
     :page_size => nil,
     :members_only => false,
-    :sort_by => :none
+    :sort_by => :none,
+    :include_missing => true
   }
 
   # Name of the leaderboard.
@@ -352,8 +353,9 @@ class Leaderboard
   #
   # @param member [String] Member name.
   # @param delta [float] Score change.
-  def change_score_for(member, delta)
-    change_score_for_member_in(@leaderboard_name, member, delta)
+  # @param member_data [String] Optional member data.
+  def change_score_for(member, delta, member_data = nil)
+    change_score_for_member_in(@leaderboard_name, member, delta, member_data)
   end
 
   # Change the score for a member in the named leaderboard by a delta which can be positive or negative.
@@ -361,8 +363,12 @@ class Leaderboard
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
   # @param delta [float] Score change.
-  def change_score_for_member_in(leaderboard_name, member, delta)
-    @redis_connection.zincrby(leaderboard_name, delta, member)
+  # @param member_data [String] Optional member data.
+  def change_score_for_member_in(leaderboard_name, member, delta, member_data)
+    @redis_connection.multi do |transaction|
+      transaction.zincrby(leaderboard_name, delta, member)
+      transaction.hset(member_data_key(leaderboard_name), member, member_data) if member_data
+    end
   end
 
   # Retrieve the rank for a member in the leaderboard.
@@ -952,6 +958,9 @@ class Leaderboard
       data[@member_key] = member
       unless leaderboard_options[:members_only]
         data[@rank_key] = responses[index * 2] + 1 rescue nil
+        if data[@rank_key] == nil
+          next unless leaderboard_options[:include_missing]
+        end
         data[@score_key] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
       end
 

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '3.9.0'.freeze
+  VERSION = '3.10.0'.freeze
 end

data/lib/tie_ranking_leaderboard.rb

@@ -50,15 +50,17 @@ class TieRankingLeaderboard < Leaderboard
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
   # @param delta [float] Score change.
-  def change_score_for_member_in(leaderboard_name, member, delta)
+  # @param member_data [String] Optional member data.
+  def change_score_for_member_in(leaderboard_name, member, delta, member_data = nil)
     previous_score = score_for(member)
-    new_score = previous_score + delta
+    new_score = (previous_score || 0) + delta
 
     total_members_at_previous_score = @redis_connection.zrevrangebyscore(leaderboard_name, previous_score, previous_score)
 
     @redis_connection.multi do |transaction|
       transaction.zadd(leaderboard_name, new_score, member)
       transaction.zadd(ties_leaderboard_key(leaderboard_name), new_score, new_score.to_f.to_s)
+      transaction.hset(member_data_key(leaderboard_name), member, member_data) if member_data
     end
 
     if total_members_at_previous_score.length == 1
@@ -73,9 +75,15 @@ class TieRankingLeaderboard < Leaderboard
   # @param score [float] Member score.
   # @param member_data [String] Optional member data.
   def rank_member_in(leaderboard_name, member, score, member_data = nil)
+    member_score = @redis_connection.zscore(leaderboard_name, member) || nil
+    can_delete_score = member_score &&
+      members_from_score_range_in(leaderboard_name, member_score, member_score).length == 1 &&
+      member_score != score
+
     @redis_connection.multi do |transaction|
       transaction.zadd(leaderboard_name, score, member)
       transaction.zadd(ties_leaderboard_key(leaderboard_name), score, score.to_f.to_s)
+      transaction.zrem(ties_leaderboard_key(leaderboard_name), member_score.to_f.to_s) if can_delete_score
       transaction.hset(member_data_key(leaderboard_name), member, member_data) if member_data
     end
   end
@@ -87,12 +95,8 @@ class TieRankingLeaderboard < Leaderboard
   # @param score [float] Member score.
   # @param member_data [String] Optional member data.
   def rank_member_across(leaderboards, member, score, member_data = nil)
-    @redis_connection.multi do |transaction|
-      leaderboards.each do |leaderboard_name|
-        transaction.zadd(leaderboard_name, score, member)
-        transaction.zadd(ties_leaderboard_key(leaderboard_name), score, score.to_f.to_s)
-        transaction.hset(member_data_key(leaderboard_name), member, member_data) if member_data
-      end
+    leaderboards.each do |leaderboard_name|
+      rank_member_in(leaderboard_name, member, score, member_data)
     end
   end
 
@@ -105,11 +109,8 @@ class TieRankingLeaderboard < Leaderboard
       members_and_scores.flatten!
     end
 
-    @redis_connection.multi do |transaction|
-      members_and_scores.each_slice(2) do |member_and_score|
-        transaction.zadd(leaderboard_name, member_and_score[1], member_and_score[0])
-        transaction.zadd(ties_leaderboard_key(leaderboard_name), member_and_score[0], member_and_score[0].to_f.to_s)
-      end
+    members_and_scores.each_slice(2) do |member_and_score|
+      rank_member_in(leaderboard_name, member_and_score[0], member_and_score[1])
     end
   end
 
@@ -242,6 +243,10 @@ class TieRankingLeaderboard < Leaderboard
         else
           data[@rank_key] = @redis_connection.zrevrank(ties_leaderboard_key(leaderboard_name), data[@score_key].to_s) + 1 rescue nil
         end
+
+        if data[@rank_key] == nil
+          next unless leaderboard_options[:include_missing]
+        end
       end
 
       if leaderboard_options[:with_member_data]

data/spec/competition_ranking_leaderboard_spec.rb

@@ -166,5 +166,22 @@ describe 'CompetitionRankingLeaderboard' do
       expect(members[24][:member]).to eql('member_1')
     end
 
+    it 'should allow you to include or exclude missing members using the :include_missing option' do
+      @leaderboard = CompetitionRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      leaders = @leaderboard.ranked_in_list(['member_1', 'member_15', 'member_25', 'member_200'])
+      expect(leaders.size).to be(4)
+      expect(leaders[0][:member]).to eql('member_1')
+      expect(leaders[1][:member]).to eql('member_15')
+      expect(leaders[2][:member]).to eql('member_25')
+      expect(leaders[3][:member]).to eql('member_200')
+
+      leaders = @leaderboard.ranked_in_list(['member_1', 'member_15', 'member_25', 'member_200'], :include_missing => false)
+      expect(leaders.size).to be(3)
+      expect(leaders[0][:member]).to eql('member_1')
+      expect(leaders[1][:member]).to eql('member_15')
+      expect(leaders[2][:member]).to eql('member_25')
+    end
   end
 end

data/spec/leaderboard_spec.rb

@@ -50,7 +50,7 @@ describe 'Leaderboard' do
     @leaderboard = Leaderboard.new('name', Leaderboard::DEFAULT_OPTIONS, {:redis_connection => @redis_connection})
     rank_members_in_leaderboard
 
-    expect(@redis_connection.info["connected_clients"].to_i).to be(1)
+    expect(@redis_connection.info["connected_clients"].to_i).to be >= 1
   end
 
   it 'should allow you to rank a member and see that reflected in total members' do
@@ -304,6 +304,12 @@ describe 'Leaderboard' do
     expect(@leaderboard.score_for('member_1')).to eql(5.0)
   end
 
+  it 'should allow you to change the score and member data for a member' do
+    @leaderboard.change_score_for('member_1', 5, 'optional-data')
+    expect(@leaderboard.score_for('member_1')).to eql(5.0)
+    expect(@leaderboard.member_data_for('member_1')).to eql('optional-data')
+  end
+
   it 'should allow you to check if a member exists' do
     @leaderboard.rank_member('member_1', 10)
 
@@ -815,4 +821,21 @@ describe 'Leaderboard' do
     expect(@redis_connection.exists("member_data")).to be_truthy
     expect(@redis_connection.exists("name:member_data")).to be_falsey
   end
+
+  it 'should allow you to include or exclude missing members using the :include_missing option' do
+    rank_members_in_leaderboard(25)
+
+    leaders = @leaderboard.ranked_in_list(['member_1', 'member_15', 'member_25', 'member_200'])
+    expect(leaders.size).to be(4)
+    expect(leaders[0][:member]).to eql('member_1')
+    expect(leaders[1][:member]).to eql('member_15')
+    expect(leaders[2][:member]).to eql('member_25')
+    expect(leaders[3][:member]).to eql('member_200')
+
+    leaders = @leaderboard.ranked_in_list(['member_1', 'member_15', 'member_25', 'member_200'], :include_missing => false)
+    expect(leaders.size).to be(3)
+    expect(leaders[0][:member]).to eql('member_1')
+    expect(leaders[1][:member]).to eql('member_15')
+    expect(leaders[2][:member]).to eql('member_25')
+  end
 end

data/spec/reverse_tie_ranking_leaderboard_spec.rb

@@ -171,5 +171,21 @@ describe 'TieRankingLeaderboard (reverse option)' do
 
       leaderboard.disconnect
     end
+
+    it 'should output the correct rank when initial score is 0 and then later scores are tied' do
+      # See https://github.com/agoragames/leaderboard/issues/53
+      leaderboard = TieRankingLeaderboard.new('ties', {:reverse => true}, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.rank_members('member_1', 0, 'member_2', 0)
+      expect(leaderboard.rank_for('member_1')).to eq(1)
+      expect(leaderboard.rank_for('member_2')).to eq(1)
+      leaderboard.rank_members('member_1', 1, 'member_2', 1)
+      expect(leaderboard.rank_for('member_1')).to eq(1)
+      expect(leaderboard.rank_for('member_2')).to eq(1)
+      leaderboard.rank_members('member_1', 1, 'member_2', 1, 'member_3', 4)
+      expect(leaderboard.rank_for('member_3')).to eq(2)
+      expect(leaderboard.rank_for('member_1')).to eq(1)
+      expect(leaderboard.rank_for('member_2')).to eq(1)
+    end
   end
 end

data/spec/tie_ranking_leaderboard_spec.rb

@@ -155,6 +155,15 @@ describe 'TieRankingLeaderboard' do
       leaderboard.disconnect
     end
 
+    it 'should allow you to change the score and member data for a member' do
+      leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.change_score_for('member_1', 10, 'optional-data')
+
+      expect(leaderboard.rank_for('member_1')).to eq(1)
+      expect(leaderboard.member_data_for('member_1')).to eql('optional-data')
+    end
+
     it 'should have the correct rankings and scores when using change_score_for (varying scores)' do
       leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 
@@ -300,5 +309,42 @@ describe 'TieRankingLeaderboard' do
         expect(ttl).to be <= 10
       end
     end
+
+    it 'should output the correct rank when initial score is 0 and then later scores are tied' do
+      # See https://github.com/agoragames/leaderboard/issues/53
+      leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.rank_members('member_1', 0, 'member_2', 0)
+      expect(leaderboard.rank_for('member_1')).to eq(1)
+      expect(leaderboard.rank_for('member_2')).to eq(1)
+      leaderboard.rank_members('member_1', 0, 'member_2', 0)
+      expect(leaderboard.rank_for('member_1')).to eq(1)
+      expect(leaderboard.rank_for('member_2')).to eq(1)
+      leaderboard.rank_members('member_1', 1, 'member_2', 1)
+      expect(leaderboard.rank_for('member_1')).to eq(1)
+      expect(leaderboard.rank_for('member_2')).to eq(1)
+      leaderboard.rank_members('member_1', 1, 'member_2', 1, 'member_3', 4)
+      expect(leaderboard.rank_for('member_3')).to eq(1)
+      expect(leaderboard.rank_for('member_1')).to eq(2)
+      expect(leaderboard.rank_for('member_2')).to eq(2)
+    end
+
+    it 'should allow you to include or exclude missing members using the :include_missing option' do
+      @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      leaders = @leaderboard.ranked_in_list(['member_1', 'member_15', 'member_25', 'member_200'])
+      expect(leaders.size).to be(4)
+      expect(leaders[0][:member]).to eql('member_1')
+      expect(leaders[1][:member]).to eql('member_15')
+      expect(leaders[2][:member]).to eql('member_25')
+      expect(leaders[3][:member]).to eql('member_200')
+
+      leaders = @leaderboard.ranked_in_list(['member_1', 'member_15', 'member_25', 'member_200'], :include_missing => false)
+      expect(leaders.size).to be(3)
+      expect(leaders[0][:member]).to eql('member_1')
+      expect(leaders[1][:member]).to eql('member_15')
+      expect(leaders[2][:member]).to eql('member_25')
+    end
   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
-    expect(Leaderboard::VERSION).to eq('3.9.0')
+    expect(Leaderboard::VERSION).to eq('3.10.0')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.10.0
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-15 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: leaderboard
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Leaderboards backed by Redis in Ruby