leaderboard 2.0.4 → 2.0.5

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## leaderboard 2.0.5 (2012-03-14)
+
+* Added `rank_members(members_and_scores)` and `rank_members_in(leaderboard_name, members_and_scores)` allowing you to pass in some variable number of `member_name, score` and so on or an actual array of those data items. Use this method to do bulk insert of data, but be mindful of the amount of data you are inserting since a single transaction can get quite large.
+
 ## leaderboard 2.0.4 (2012-02-29)
 
  * Added `page_for(member, page_size = DEFAULT_PAGE_SIZE)` and `page_for_in(leaderboard_name, member, page_size = DEFAULT_PAGE_SIZE)` calls to allow you to determine the page where a member falls in the leaderboard

data/README.markdown

@@ -146,7 +146,23 @@ Get rank and score for an arbitrary list of members (e.g. friends):
 ```ruby
   ruby-1.9.2-p180 :034 > highscore_lb.ranked_in_list(['member_1', 'member_62', 'member_67'])
    => [{:member=>"member_1", :rank=>56, :score=>1.0}, {:member=>"member_62", :rank=>34, :score=>62.0}, {:member=>"member_67", :rank=>29, :score=>67.0}]
-```   
+```
+
+Insert multiple data items for members and their associated scores:
+
+As a splat:
+
+```ruby
+highscore_lb.rank_members('member_1', 1, 'member_5', 5, 'member_10', 10)
+```
+
+Or as an array:
+
+```ruby
+highscore_lb.rank_members(['member_1', 1, 'member_5', 5, 'member_10', 10])
+```
+
+Use this method to do bulk insert of data, but be mindful of the amount of data you are inserting since a single transaction can get quite large.
 
 ### Other useful methods
 
@@ -164,6 +180,7 @@ Get rank and score for an arbitrary list of members (e.g. friends):
   remove_members_in_score_range(min_score, max_score): Remove members from the leaderboard within a score range
   percentile_for(member): Calculate the percentile for a given member
   page_for(member, page_size): Determine the page where a member falls in the leaderboard
+  rank_members(members_and_scores): Rank an array of members in the leaderboard where you can call via (member_name, score) or pass in an array of [member_name, score]
   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
 ```
@@ -228,9 +245,38 @@ Average time to request an arbitrary page from the leaderboard:
    => 0.0014615999999999531 
 ```
 
+Bulk insert performance:
+
+Ranking individual members:
+
+```ruby
+1.9.3p0 :015 > insert_time = Benchmark.measure do
+1.9.3p0 :016 >     1.upto(1000000) do |index|
+1.9.3p0 :017 >       highscore_lb.rank_member("member_#{index}", index)
+1.9.3p0 :018?>     end
+1.9.3p0 :019?>   end
+ =>  29.340000  15.050000  44.390000 ( 81.673507)
+```
+
+Ranking multiple members at once:
+
+```ruby
+1.9.3p0 :020 > member_data = []
+ => [] 
+1.9.3p0 :021 > 1.upto(1000000) do |index|
+1.9.3p0 :022 >   member_data << "member_#{index}"
+1.9.3p0 :023?>   member_data << index
+1.9.3p0 :024?> end
+ => 1 
+1.9.3p0 :025 > insert_time = Benchmark.measure do
+1.9.3p0 :026 >   highscore_lb.rank_members(member_data)
+1.9.3p0 :027?> end
+ =>  22.390000   6.380000  28.770000 ( 31.144027)
+```
+
 ## Future Ideas
 
-* Bulk insert
+* Ideas?
 
 ## Ports
 

data/lib/leaderboard.rb

@@ -102,6 +102,29 @@ class Leaderboard
   def rank_member_in(leaderboard_name, member, score)
     @redis_connection.zadd(leaderboard_name, score, member)
   end
+
+  # Rank an array of members in the leaderboard.
+  # 
+  # @param members_and_scores [Splat or Array] Variable list of members and scores
+  def rank_members(*members_and_scores)
+    rank_members_in(@leaderboard_name, *members_and_scores)
+  end
+
+  # Rank an array of members in the named leaderboard.
+  # 
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param members_and_scores [Splat or Array] Variable list of members and scores
+  def rank_members_in(leaderboard_name, *members_and_scores)
+    if members_and_scores.is_a?(Array)
+      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])
+      end
+    end
+  end
   
   # Remove a member from the leaderboard.
   #

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '2.0.4'.freeze
+  VERSION = '2.0.5'.freeze
 end

data/test/test_helper.rb

@@ -6,7 +6,7 @@ require 'leaderboard'
 class LeaderboardTest < Test::Unit::TestCase
 
   def test_version
-    assert_equal '2.0.4', Leaderboard::VERSION
+    assert_equal '2.0.5', Leaderboard::VERSION
   end
 
   private

data/test/test_leaderboard.rb

@@ -467,4 +467,18 @@ class TestLeaderboard < LeaderboardTest
     assert_equal 2, @leaderboard.page_for('member_10', 10)
     assert_equal 2, @leaderboard.page_for('member_1', 10)
   end
+
+  def test_rank_members
+    assert_equal 0, @leaderboard.total_members
+    @leaderboard.rank_members('member_1', 1, 'member_10', 10)
+    assert_equal 2, @leaderboard.total_members
+    assert_equal 'member_10', @leaderboard.leaders(1).first[:member]
+  end
+
+  def test_rank_members_with_array
+    assert_equal 0, @leaderboard.total_members
+    @leaderboard.rank_members(['member_1', 1, 'member_10', 10])
+    assert_equal 2, @leaderboard.total_members
+    assert_equal 'member_10', @leaderboard.leaders(1).first[:member]
+  end
 end

data/test/test_rev_leaderboard.rb

@@ -467,4 +467,18 @@ class TestRevLeaderboard < LeaderboardTest
     assert_equal 2, @leaderboard.page_for('member_17', 10)
     assert_equal 2, @leaderboard.page_for('member_11', 10)
   end
+
+  def test_rank_members
+    assert_equal 0, @leaderboard.total_members
+    @leaderboard.rank_members('member_1', 1, 'member_10', 10)
+    assert_equal 2, @leaderboard.total_members
+    assert_equal 'member_1', @leaderboard.leaders(1).first[:member]
+  end
+
+  def test_rank_members_with_array
+    assert_equal 0, @leaderboard.total_members
+    @leaderboard.rank_members(['member_1', 1, 'member_10', 10])
+    assert_equal 2, @leaderboard.total_members
+    assert_equal 'member_1', @leaderboard.leaders(1).first[:member]
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-29 00:00:00.000000000 Z
+date: 2012-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70133210061060 !ruby/object:Gem::Requirement
+  requirement: &2161382920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70133210061060
+  version_requirements: *2161382920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70133210060620 !ruby/object:Gem::Requirement
+  requirement: &2161382500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133210060620
+  version_requirements: *2161382500
 description: Leaderboards backed by Redis in Ruby
 email:
 - dczarnecki@agoragames.com
@@ -69,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 182894351603387394
+      hash: 1692368560274540289
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 182894351603387394
+      hash: 1692368560274540289
 requirements: []
 rubyforge_project: leaderboard
 rubygems_version: 1.8.10