leaderboard 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73f4fb333c04f1aef154ecf0469cdea2f3602c24
-  data.tar.gz: 6ada4c6ec175b491b2dec536b4961e3bd472eb54
+  metadata.gz: 7bde8fa5f70279295659c4d1d2eff551c105ccf8
+  data.tar.gz: 0de720bc5a777acb6c568ebcd5a62d99490b799f
 SHA512:
-  metadata.gz: 104e46c727ed24d53883a4f45260af84fc3518d863ef662ccafab806152aea83aea40a5a740c80452535c2dcf25853cd54ce52aa7b398f9b019638654f44e99c
-  data.tar.gz: 96f0f5756c4a17bd0dd9e573a3e8b682f961168f7a47e2fb0f0100cd6ec427457afdacb194367bf01a6f38eb5032bdcd3458f344a8683450dc8697a5a31d62c6
+  metadata.gz: 237db7f422c2df67dc63040304a49efc806ce716e4976d5f2b68c36c70c6fa42b9fdd349237376a998430fd9ccd5faed03c0bd2ba075a1650dcb34f0aa153d66
+  data.tar.gz: 26c645596ea59bc82c738e16d1c8313b2c87753ccc1936dff64d4a2a70277683eac8e5479844467815a7d68824432736e95ebbdf7960aadb8846ac39d012a6bf

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.8.0 (2014-11-07)
+
+* Add support for `change_score_for(...)` in the `TieRankingLeaderboard` class.
+
 ## 3.7.0 (2014-07-28)
 
 * Add support for tie handling in leaderboards [#46](https://github.com/agoragames/leaderboard/pull/46)

data/README.markdown

@@ -131,7 +131,7 @@ encode a Hash of member data. Example:
 
 ```ruby
 require 'json'
-highscore_lb.rank_member('84849292', 1, JSON.generate({'username' => 'member_name'})
+highscore_lb.rank_member('84849292', 1, JSON.generate({'username' => 'member_name'}))
 ```
 
 You can retrieve, update and remove the optional member data using the
@@ -182,7 +182,7 @@ You can pass various options to the calls `leaders`, `all_leaders`, `around_me`,
 * `:with_member_data` - `true` or `false` (default) to return the optional member data.
 * `:page_size` - An integer value to change the page size for that call.
 * `:members_only` - `true` or `false` (default) to return only the members without their score and rank.
-* `:sort_option` - Valid values for `:sort_option` are `:none` (default), `:score` and `:rank`.
+* `:sort_by` - Valid values for `:sort_by` are `:none` (default), `:score` and `:rank`.
 
 You can also use the `members` and `members_in` methods as aliases for the `leaders` and `leaders_in` methods.
 
@@ -234,7 +234,7 @@ members = highscore_lb.members_from_rank_range(1, 5)
  => [{:member=>"member_95", :rank=>1, :score=>95.0}, {:member=>"member_94", :rank=>2, :score=>94.0}, {:member=>"member_93", :rank=>3, :score=>93.0}, {:member=>"member_92", :rank=>4, :score=>92.0}, {:member=>"member_91", :rank=>5, :score=>91.0}]
 ```
 
-The option `:sort_option` is useful for retrieving an arbitrary list of
+The option `:sort_by` is useful for retrieving an arbitrary list of
 members from a given leaderboard where you would like the data sorted
 when returned. The follow examples demonstrate its use:
 

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '3.7.0'.freeze
+  VERSION = '3.8.0'.freeze
 end

data/lib/tie_ranking_leaderboard.rb

@@ -45,6 +45,27 @@ class TieRankingLeaderboard < Leaderboard
     end
   end
 
+  # Change the score for a member in the named leaderboard by a delta which can be positive or negative.
+  #
+  # @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)
+    previous_score = score_for(member)
+    new_score = previous_score + 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)
+    end
+
+    if total_members_at_previous_score.length == 1
+      @redis_connection.zrem(ties_leaderboard_key(leaderboard_name), previous_score.to_f.to_s)
+    end
+  end
+
   # Rank a member in the named leaderboard.
   #
   # @param leaderboard_name [String] Name of the leaderboard.

data/spec/competition_ranking_leaderboard_spec.rb

@@ -106,5 +106,22 @@ describe 'CompetitionRankingLeaderboard' do
 
       leaderboard.disconnect
     end
+
+    it 'should have the correct rankings and scores when using change_score_for' do
+      leaderboard = CompetitionRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.rank_member('member_1', 50)
+      leaderboard.rank_member('member_2', 50)
+      leaderboard.rank_member('member_3', 30)
+      leaderboard.rank_member('member_4', 30)
+      leaderboard.rank_member('member_5', 10)
+      leaderboard.change_score_for('member_3', 10)
+
+      expect(leaderboard.rank_for('member_3')).to eq(3)
+      expect(leaderboard.rank_for('member_4')).to eq(4)
+      expect(leaderboard.score_for('member_3')).to eq(40.0)
+
+      leaderboard.disconnect
+    end
   end
 end

data/spec/reverse_competition_ranking_leaderboard_spec.rb

@@ -112,5 +112,23 @@ describe 'CompetitionRankingLeaderboard (reverse option)' do
 
       leaderboard.disconnect
     end
+
+    it 'should have the correct rankings and scores when using change_score_for' do
+      leaderboard = CompetitionRankingLeaderboard.new('ties', {:reverse => true}, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.rank_member('member_1', 50)
+      leaderboard.rank_member('member_2', 50)
+      leaderboard.rank_member('member_3', 30)
+      leaderboard.rank_member('member_4', 30)
+      leaderboard.rank_member('member_5', 10)
+      leaderboard.change_score_for('member_3', 10)
+
+      expect(leaderboard.rank_for('member_3')).to eq(3)
+      expect(leaderboard.rank_for('member_4')).to eq(2)
+      expect(leaderboard.score_for('member_3')).to eq(40.0)
+
+      leaderboard.disconnect
+    end
+
   end
 end

data/spec/reverse_tie_ranking_leaderboard_spec.rb

@@ -137,5 +137,39 @@ describe 'TieRankingLeaderboard (reverse option)' do
 
       leaderboard.disconnect
     end
+
+    it 'should have the correct rankings and scores when using change_score_for' do
+      leaderboard = TieRankingLeaderboard.new('ties', {:reverse => true}, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.rank_member('member_1', 50)
+      leaderboard.rank_member('member_2', 50)
+      leaderboard.rank_member('member_3', 30)
+      leaderboard.rank_member('member_4', 30)
+      leaderboard.rank_member('member_5', 10)
+      leaderboard.change_score_for('member_3', 10)
+
+      expect(leaderboard.rank_for('member_3')).to eq(3)
+      expect(leaderboard.rank_for('member_4')).to eq(2)
+      expect(leaderboard.score_for('member_3')).to eq(40.0)
+
+      leaderboard.disconnect
+    end
+
+    it 'should have the correct rankings and scores when using change_score_for (varying scores)' do
+      leaderboard = TieRankingLeaderboard.new('ties', {:reverse => true}, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.rank_member('member_1', 5)
+      leaderboard.rank_member('member_2', 4)
+      leaderboard.rank_member('member_3', 3)
+      leaderboard.rank_member('member_4', 2)
+      leaderboard.rank_member('member_5', 1)
+      leaderboard.change_score_for('member_3', 0.5)
+
+      expect(leaderboard.rank_for('member_3')).to eq(3)
+      expect(leaderboard.rank_for('member_4')).to eq(2)
+      expect(leaderboard.score_for('member_3')).to eq(3.5)
+
+      leaderboard.disconnect
+    end
   end
 end

data/spec/tie_ranking_leaderboard_spec.rb

@@ -138,6 +138,40 @@ describe 'TieRankingLeaderboard' do
       leaderboard.disconnect
     end
 
+    it 'should have the correct rankings and scores when using change_score_for' do
+      leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+
+      leaderboard.rank_member('member_1', 50)
+      leaderboard.rank_member('member_2', 50)
+      leaderboard.rank_member('member_3', 30)
+      leaderboard.rank_member('member_4', 30)
+      leaderboard.rank_member('member_5', 10)
+      leaderboard.change_score_for('member_3', 10)
+
+      expect(leaderboard.rank_for('member_3')).to eq(2)
+      expect(leaderboard.rank_for('member_4')).to eq(3)
+      expect(leaderboard.score_for('member_3')).to eq(40.0)
+
+      leaderboard.disconnect
+    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})
+
+      leaderboard.rank_member('member_1', 5)
+      leaderboard.rank_member('member_2', 4)
+      leaderboard.rank_member('member_3', 3)
+      leaderboard.rank_member('member_4', 2)
+      leaderboard.rank_member('member_5', 1)
+      leaderboard.change_score_for('member_3', 0.5)
+
+      expect(leaderboard.rank_for('member_3')).to eq(3)
+      expect(leaderboard.rank_for('member_4')).to eq(4)
+      expect(leaderboard.score_for('member_3')).to eq(3.5)
+
+      leaderboard.disconnect
+    end
+
     it 'should allow you to remove members in a given score range using #remove_members_in_score_range' do
       @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 

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.7.0')
+    expect(Leaderboard::VERSION).to eq('3.8.0')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis