leaderboard 1.0.1 → 1.0.2

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+# leaderboard 1.0.2 (2011-02-25)
+
+ * Adding `XXX_to`, `XXX_for`, `XXX_in` and `XXX_from` methods that will allow you to set the leaderboard name to interact with outside of creating a new object
+ * Added `merge_leaderboards(destination, keys, options = {:aggregate => :min})` method to merge leaderboards given by keys with this leaderboard into destination
+ * Added `intersect_leaderboards(destination, keys, options = {:aggregate => :min})` method to intersect leaderboards given by keys with this leaderboard into destination
+
 # leaderboard 1.0.1 (2011-02-16)
 
  * `redis_options` can be passed in the initializer to pass options for the connection to Redis

data/README.rdoc

@@ -1,6 +1,6 @@
 = leaderboard
 
-Leaderboards backed by Redis, http://redis.io.
+Leaderboards backed by Redis in Ruby, http://redis.io.
 
 Builds off ideas proposed in http://blog.agoragames.com/2011/01/01/creating-high-score-tables-leaderboards-using-redis/.
 
@@ -91,6 +91,8 @@ 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, use_zero_index_for_rank = false): 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
+	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
       
 == Performance Metrics
 

data/Rakefile

@@ -15,8 +15,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "leaderboard"
   gem.homepage = "http://github.com/agoragames/leaderboard"
   gem.license = "MIT"
-  gem.summary = %Q{Leaderboards backed by Redis}
-  gem.description = %Q{Leaderboards backed by Redis}
+  gem.summary = %Q{Leaderboards backed by Redis in Ruby}
+  gem.description = %Q{Leaderboards backed by Redis in Ruby}
   gem.email = "dczarnecki@agoragames.com"
   gem.authors = ["David Czarnecki"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/leaderboard.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{leaderboard}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Czarnecki"]
-  s.date = %q{2011-02-16}
-  s.description = %q{Leaderboards backed by Redis}
+  s.date = %q{2011-02-25}
+  s.description = %q{Leaderboards backed by Redis in Ruby}
   s.email = %q{dczarnecki@agoragames.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Leaderboards backed by Redis}
+  s.summary = %q{Leaderboards backed by Redis in Ruby}
   s.test_files = [
     "test/helper.rb",
     "test/test_leaderboard.rb"

data/lib/leaderboard.rb

@@ -1,7 +1,7 @@
 require 'redis'
 
 class Leaderboard
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
   
   DEFAULT_PAGE_SIZE = 25
   DEFAULT_REDIS_HOST = 'localhost'
@@ -33,54 +33,102 @@ class Leaderboard
   end
       
   def add_member(member, score)
-    @redis_connection.zadd(@leaderboard_name, score, member)
+    add_member_to(@leaderboard_name, member, score)
+  end
+
+  def add_member_to(leaderboard_name, member, score)
+    @redis_connection.zadd(leaderboard_name, score, member)
   end
   
   def remove_member(member)
-    @redis_connection.zrem(@leaderboard_name, member)
+    remove_member_from(@leaderboard_name, member)
+  end
+  
+  def remove_member_from(leaderboard_name, member)
+    @redis_connection.zrem(leaderboard_name, member)
   end
   
   def total_members
-    @redis_connection.zcard(@leaderboard_name)
+    total_members_in(@leaderboard_name)
+  end
+  
+  def total_members_in(leaderboard_name)
+    @redis_connection.zcard(leaderboard_name)
   end
   
   def total_pages
-    (total_members / @page_size.to_f).ceil
+    total_pages_in(@leaderboard_name)
+  end
+  
+  def total_pages_in(leaderboard_name)
+    (total_members_in(leaderboard_name) / @page_size.to_f).ceil
   end
   
   def total_members_in_score_range(min_score, max_score)
-    @redis_connection.zcount(@leaderboard_name, min_score, max_score)
+    total_members_in_score_range_in(@leaderboard_name, min_score, max_score)
   end
   
-  def change_score_for(member, delta)
-    @redis_connection.zincrby(@leaderboard_name, delta, member)
+  def total_members_in_score_range_in(leaderboard_name, min_score, max_score)
+    @redis_connection.zcount(leaderboard_name, min_score, max_score)
   end
   
-  def rank_for(member, use_zero_index_for_rank = false)    
+  def change_score_for(member, delta)    
+    change_score_for_member_in(@leaderboard_name, member, delta)
+  end
+  
+  def change_score_for_member_in(leaderboard_name, member, delta)
+    @redis_connection.zincrby(leaderboard_name, delta, member)
+  end
+  
+  def rank_for(member, use_zero_index_for_rank = false)
+    rank_for_in(@leaderboard_name, member, use_zero_index_for_rank)
+  end
+  
+  def rank_for_in(leaderboard_name, member, use_zero_index_for_rank = false)
     if use_zero_index_for_rank
-      return @redis_connection.zrevrank(@leaderboard_name, member)
+      return @redis_connection.zrevrank(leaderboard_name, member)
     else
-      return @redis_connection.zrevrank(@leaderboard_name, member) + 1 rescue nil
+      return @redis_connection.zrevrank(leaderboard_name, member) + 1 rescue nil
     end
   end
   
   def score_for(member)
-    @redis_connection.zscore(@leaderboard_name, member).to_f
+    score_for_in(@leaderboard_name, member)
   end
   
+  def score_for_in(leaderboard_name, member)
+    @redis_connection.zscore(leaderboard_name, member).to_f
+  end
+
   def check_member?(member)
-    !@redis_connection.zscore(@leaderboard_name, member).nil?
+    check_member_in?(@leaderboard_name, member)
+  end
+  
+  def check_member_in?(leaderboard_name, member)
+    !@redis_connection.zscore(leaderboard_name, member).nil?
   end
   
   def score_and_rank_for(member, use_zero_index_for_rank = false)
-    {:member => member, :score => score_for(member), :rank => rank_for(member, use_zero_index_for_rank)}    
+    score_and_rank_for_in(@leaderboard_name, member, use_zero_index_for_rank)
+  end
+
+  def score_and_rank_for_in(leaderboard_name, member, use_zero_index_for_rank = false)
+    {:member => member, :score => score_for_in(leaderboard_name, member), :rank => rank_for_in(leaderboard_name, member, use_zero_index_for_rank)}    
   end
   
   def remove_members_in_score_range(min_score, max_score)
-    @redis_connection.zremrangebyscore(@leaderboard_name, min_score, max_score)
+    remove_members_in_score_range_in(@leaderboard_name, min_score, max_score)
+  end
+  
+  def remove_members_in_score_range_in(leaderboard_name, min_score, max_score)
+    @redis_connection.zremrangebyscore(leaderboard_name, min_score, max_score)
   end
   
   def leaders(current_page, with_scores = true, with_rank = true, use_zero_index_for_rank = false)
+    leaders_in(@leaderboard_name, current_page, with_scores, with_rank, use_zero_index_for_rank)
+  end
+
+  def leaders_in(leaderboard_name, current_page, with_scores = true, with_rank = true, use_zero_index_for_rank = false)
     if current_page < 1
       current_page = 1
     end
@@ -98,16 +146,20 @@ class Leaderboard
     
     ending_offset = (starting_offset + @page_size) - 1
     
-    raw_leader_data = @redis_connection.zrevrange(@leaderboard_name, starting_offset, ending_offset, :with_scores => with_scores)
+    raw_leader_data = @redis_connection.zrevrange(leaderboard_name, starting_offset, ending_offset, :with_scores => with_scores)
     if raw_leader_data
-      massage_leader_data(raw_leader_data, with_rank, use_zero_index_for_rank)
+      massage_leader_data(leaderboard_name, raw_leader_data, with_rank, use_zero_index_for_rank)
     else
       return nil
     end
   end
   
   def around_me(member, with_scores = true, with_rank = true, use_zero_index_for_rank = false)
-    reverse_rank_for_member = @redis_connection.zrevrank(@leaderboard_name, member)
+    around_me_in(@leaderboard_name, member, with_scores, with_rank, use_zero_index_for_rank)
+  end
+  
+  def around_me_in(leaderboard_name, member, with_scores = true, with_rank = true, use_zero_index_for_rank = false)
+    reverse_rank_for_member = @redis_connection.zrevrank(leaderboard_name, member)
     
     starting_offset = reverse_rank_for_member - (@page_size / 2)
     if starting_offset < 0
@@ -116,22 +168,26 @@ class Leaderboard
     
     ending_offset = (starting_offset + @page_size) - 1
     
-    raw_leader_data = @redis_connection.zrevrange(@leaderboard_name, starting_offset, ending_offset, :with_scores => with_scores)
+    raw_leader_data = @redis_connection.zrevrange(leaderboard_name, starting_offset, ending_offset, :with_scores => with_scores)
     if raw_leader_data
-      massage_leader_data(raw_leader_data, with_rank, use_zero_index_for_rank)
+      massage_leader_data(leaderboard_name, raw_leader_data, with_rank, use_zero_index_for_rank)
     else
       return nil
     end
   end
   
   def ranked_in_list(members, with_scores = true, use_zero_index_for_rank = false)
+    ranked_in_list_in(@leaderboard_name, members, with_scores, use_zero_index_for_rank)
+  end
+  
+  def ranked_in_list_in(leaderboard_name, members, with_scores = true, use_zero_index_for_rank = false)
     ranks_for_members = []
     
     members.each do |member|
       data = {}
       data[:member] = member
-      data[:rank] = rank_for(member, use_zero_index_for_rank)
-      data[:score] = score_for(member) if with_scores
+      data[:rank] = rank_for_in(leaderboard_name, member, use_zero_index_for_rank)
+      data[:score] = score_for_in(leaderboard_name, member) if with_scores
       
       ranks_for_members << data
     end
@@ -139,9 +195,19 @@ class Leaderboard
     ranks_for_members
   end
   
+  # Merge leaderboards given by keys with this leaderboard into destination
+  def merge_leaderboards(destination, keys, options = {:aggregate => :sum})
+    @redis_connection.zunionstore(destination, keys.insert(0, @leaderboard_name), options)
+  end
+  
+  # Intersect leaderboards given by keys with this leaderboard into destination
+  def intersect_leaderboards(destination, keys, options = {:aggregate => :sum})
+    @redis_connection.zinterstore(destination, keys.insert(0, @leaderboard_name), options)
+  end
+  
   private 
   
-  def massage_leader_data(leaders, with_rank, use_zero_index_for_rank)
+  def massage_leader_data(leaderboard_name, leaders, with_rank, use_zero_index_for_rank)
     member_attribute = true    
     leader_data = []
     
@@ -151,7 +217,7 @@ class Leaderboard
         data[:member] = leader_data_item
       else
         data[:score] = leader_data_item.to_f
-        data[:rank] = rank_for(data[:member], use_zero_index_for_rank) if with_rank
+        data[:rank] = rank_for_in(leaderboard_name, data[:member], use_zero_index_for_rank) if with_rank
         leader_data << data
         data = {}     
       end

data/test/test_leaderboard.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 class TestLeaderboard < Test::Unit::TestCase
-  def setup
+  def setup    
     @leaderboard = Leaderboard.new('name')
     @redis_connection = Redis.new
   end
@@ -11,7 +11,7 @@ class TestLeaderboard < Test::Unit::TestCase
   end
   
   def test_version
-    assert_equal '1.0.1', Leaderboard::VERSION
+    assert_equal '1.0.2', Leaderboard::VERSION
   end
   
   def test_initialize_with_defaults  
@@ -204,6 +204,51 @@ class TestLeaderboard < Test::Unit::TestCase
     end
   end
   
+  def test_merge_leaderboards
+    foo = Leaderboard.new('foo')
+    bar = Leaderboard.new('bar')
+    
+    foo.add_member('foo_1', 1)
+    foo.add_member('foo_2', 2)
+    bar.add_member('bar_1', 3)
+    bar.add_member('bar_2', 4)
+    bar.add_member('bar_3', 5)
+    
+    foobar_keys = foo.merge_leaderboards('foobar', ['bar'])
+    assert_equal 5, foobar_keys
+    
+    foobar = Leaderboard.new('foobar')  
+    assert_equal 5, foobar.total_members
+    
+    first_leader_in_foobar = foobar.leaders(1).first
+    assert_equal 1, first_leader_in_foobar[:rank]
+    assert_equal 'bar_3', first_leader_in_foobar[:member]
+    assert_equal 5, first_leader_in_foobar[:score]
+  end
+  
+  def test_intersect_leaderboards
+    foo = Leaderboard.new('foo')
+    bar = Leaderboard.new('bar')
+    
+    foo.add_member('foo_1', 1)
+    foo.add_member('foo_2', 2)
+    foo.add_member('bar_3', 6)
+    bar.add_member('bar_1', 3)
+    bar.add_member('foo_1', 4)
+    bar.add_member('bar_3', 5)
+    
+    foobar_keys = foo.intersect_leaderboards('foobar', ['bar'], {:aggregate => :max})    
+    assert_equal 2, foobar_keys
+    
+    foobar = Leaderboard.new('foobar')
+    assert_equal 2, foobar.total_members
+    
+    first_leader_in_foobar = foobar.leaders(1).first
+    assert_equal 1, first_leader_in_foobar[:rank]
+    assert_equal 'bar_3', first_leader_in_foobar[:member]
+    assert_equal 6, first_leader_in_foobar[:score]
+  end
+  
   private
   
   def add_members_to_leaderboard(members_to_add = 5)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: leaderboard
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - David Czarnecki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-16 00:00:00 -05:00
+date: 2011-02-25 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -80,7 +80,7 @@ dependencies:
         - 0
         version: "0"
   requirement: *id004
-description: Leaderboards backed by Redis
+description: Leaderboards backed by Redis in Ruby
 email: dczarnecki@agoragames.com
 executables: []
 
@@ -137,7 +137,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Leaderboards backed by Redis
+summary: Leaderboards backed by Redis in Ruby
 test_files: 
 - test/helper.rb
 - test/test_leaderboard.rb