leaderboard 2.5.0 → 3.0.0.rc1

data/.rvmrc

@@ -1,3 +1,2 @@
 rvm --create 1.8.7@leaderboard_gem
-rvm --create 1.9.2@leaderboard_gem
 rvm --create 1.9.3@leaderboard_gem

data/CHANGELOG.markdown

@@ -1,5 +1,12 @@
 # CHANGELOG
 
+## 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)
+* Optional member data is stored in a single hash. [Original proposal](https://github.com/agoragames/leaderboard/pull/26)
+* Adds `:sort_by` as valid option for requesting data from the leaderboard. [Original proposal](https://github.com/agoragames/leaderboard/pull/30)
+* Removes `:with_scores` and `:with_ranks` as valid options for requesting data from the leaderboard.
+
 ## leaderboard 2.5.0 (2012-10-12)
 
 * Added `members_from_rank_range` and `members_from_rank_range_in` methods to be able to retrieve members from a leaderboard in a given rank range.

data/README.markdown

@@ -119,30 +119,34 @@ Get some information about your leaderboard:
    => 1
 ```
 
-The `rank_member` call will also accept an optional hash of member data that could
-be used to store other information about a given member in the leaderboard. This
-may be useful in situations where you are storing member IDs in the leaderboard and
-you want to be able to store a member name for display. Example:
+The `rank_member` call will also accept an optional string member data that could 
+be used to store other information about a given member in the leaderboard. This 
+may be useful in situations where you are storing member IDs in the leaderboard and 
+you want to be able to store a member name for display. You could use JSON to 
+encode a Hash of member data. Example:
 
 ```ruby
-highscore_lb.rank_member('84849292', 1, {'username' => 'member_name'})
+require 'json'
+highscore_lb.rank_member('84849292', 1, JSON.generate({'username' => 'member_name'})
 ```
 
 You can retrieve, update and remove the optional member data using the
 `member_data_for`, `update_member_data` and `remove_member_data` calls. Example:
 
 ```ruby
-highscore_lb.member_data_for('84849292')
+JSON.parse(highscore_lb.member_data_for('84849292'))
  => {"username"=>"member_name"}
 
-highscore_lb.update_member_data('84849292', {'last_updated' => Time.now, 'username' => 'updated_member_name'})
- => "OK"
-highscore_lb.member_data_for('84849292')
+highscore_lb.update_member_data('84849292', JSON.generate({'last_updated' => Time.now, 'username' => 'updated_member_name'}))
+ => "OK" 
+JSON.parse(highscore_lb.member_data_for('84849292'))
  => {"username"=>"updated_member_name", "last_updated"=>"2012-06-09 09:11:06 -0400"}
 
 highscore_lb.remove_member_data('84849292')
 ```
 
+If you delete the leaderboard, ALL of the member data is deleted as well.
+  
 Get some information about a specific member(s) in the leaderboard:
 
 ```ruby
@@ -162,23 +166,10 @@ Get page 1 in the leaderboard:
   highscore_lb.leaders(1)
    => [{:member=>"member_10", :rank=>1, :score=>10.0}, {:member=>"member_9", :rank=>2, :score=>9.0}, {:member=>"member_8", :rank=>3, :score=>8.0}, {:member=>"member_7", :rank=>4, :score=>7.0}, {:member=>"member_6", :rank=>5, :score=>6.0}, {:member=>"member_5", :rank=>6, :score=>5.0}, {:member=>"member_4", :rank=>7, :score=>4.0}, {:member=>"member_3", :rank=>8, :score=>3.0}, {:member=>"member_2", :rank=>9, :score=>2.0}, {:member=>"member_1", :rank=>10, :score=>1.0}]
 ```
-
-You can pass various options to the calls `leaders`, `around_me` and `ranked_in_list`.
-Valid options are `:with_scores`, `:with_rank`, `:with_member_data`, `:use_zero_index_for_rank`
-and `:page_size`. Below is an example of retrieving the first page in the leaderboard
-without ranks:
-
-```ruby
-  highscore_lb.leaders(1, :with_rank => false)
-   => [{:member=>"member_10", :score=>9.0}, {:member=>"member_9", :score=>7.0}, {:member=>"member_8", :score=>5.0}, {:member=>"member_7", :score=>3.0}, {:member=>"member_6", :score=>1.0}, {:member=>"member_5", :score=>0.0}, {:member=>"member_4", :score=>0.0}, {:member=>"member_3", :score=>0.0}, {:member=>"member_2", :score=>0.0}, {:member=>"member_1", :score=>0.0}]
-```
-
-Below is an example of retrieving the first page in the leaderboard without scores or ranks:
-
-```ruby
-  highscore_lb.leaders(1, :with_scores => false, :with_rank => false)
-   => [{:member=>"member_10"}, {:member=>"member_9"}, {:member=>"member_8"}, {:member=>"member_7"}, {:member=>"member_6"}, {:member=>"member_5"}, {:member=>"member_4"}, {:member=>"member_3"}, {:member=>"member_2"}, {:member=>"member_1"}]
-```
+	
+You can pass various options to the calls `leaders`, `around_me` and `ranked_in_list`. 
+Valid options are `:with_member_data`, `:page_size` and `:sort_option`. Valid values for 
+`:sort_option` 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.
 
@@ -231,6 +222,20 @@ 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 
+members from a given leaderboard where you would like the data sorted 
+when returned. The follow examples demonstrate its use:
+
+```ruby
+friends = highscore_lb.ranked_in_list(['member_6', 'member_1', 'member_10'], :sort_by => :rank)
+ => [{:member=>"member_10", :rank=>47, :score=>10.0}, {:member=>"member_6", :rank=>51, :score=>6.0}, {:member=>"member_1", :rank=>56, :score=>1.0}] 
+```
+
+```ruby
+friends = highscore_lb.ranked_in_list(['member_6', 'member_1', 'member_10'], :sort_by => :score)
+ => [{:member=>"member_1", :rank=>56, :score=>1.0}, {:member=>"member_6", :rank=>51, :score=>6.0}, {:member=>"member_10", :rank=>47, :score=>10.0}] 
+```
+
 ### Ranking multiple members in a leaderboard at once
 
 Insert multiple data items for members and their associated scores:

data/Rakefile

@@ -10,6 +10,7 @@ end
 
 task :default => :spec
 
+desc "Run the specs against Ruby 1.8.7 and 1.9.3"
 task :test_rubies do
-  system "rvm 1.8.7@leaderboard_gem,1.9.2@leaderboard_gem,1.9.3@leaderboard_gem do rake spec"
+  system "rvm 1.8.7@leaderboard_gem,1.9.3@leaderboard_gem do rake spec"
 end

data/lib/leaderboard/version.rb

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

data/lib/leaderboard.rb

@@ -27,17 +27,13 @@ class Leaderboard
   }
 
   # Default options when requesting data from a leaderboard.
-  # +:with_scores+ true: Return scores along with the member names.
-  # +:with_rank+ true: Return ranks along with the member names.
   # +:with_member_data+ false: Return member data along with the member names.
-  # +:use_zero_index_for_rank+ false: If you want to 0-index ranks.
   # +:page_size+ nil: The default page size will be used.
+  # +:sort_by+ :none: The default sort for a call to `ranked_in_list`.
   DEFAULT_LEADERBOARD_REQUEST_OPTIONS = {
-    :with_scores => true,
-    :with_rank => true,
     :with_member_data => false,
-    :use_zero_index_for_rank => false,
-    :page_size => nil
+    :page_size => nil,
+    :sort_by => :none
   }
 
   # Name of the leaderboard.
@@ -103,7 +99,10 @@ class Leaderboard
   #
   # @param leaderboard_name [String] Name of the leaderboard.
   def delete_leaderboard_named(leaderboard_name)
-    @redis_connection.del(leaderboard_name)
+    @redis_connection.multi do |transaction|
+      transaction.del(leaderboard_name)
+      transaction.del(member_data_key(leaderboard_name))
+    end
   end
 
   # Rank a member in the leaderboard.
@@ -124,9 +123,7 @@ class Leaderboard
   def rank_member_in(leaderboard_name, member, score, member_data)
     @redis_connection.multi do |transaction|
       transaction.zadd(leaderboard_name, score, member)
-      if member_data
-        transaction.hmset(member_data_key(leaderboard_name, member), *member_data.to_a.flatten)
-      end
+      transaction.hset(member_data_key(leaderboard_name), member, member_data) if member_data
     end
   end
 
@@ -146,7 +143,7 @@ class Leaderboard
   #
   # @return Hash of optional member data.
   def member_data_for_in(leaderboard_name, member)
-    @redis_connection.hgetall(member_data_key(leaderboard_name, member))
+    @redis_connection.hget(member_data_key(leaderboard_name), member)
   end
 
   # Update the optional member data for a given member in the leaderboard.
@@ -163,7 +160,7 @@ class Leaderboard
   # @param member [String] Member name.
   # @param member_data [Hash] Optional member data.
   def update_member_data_in(leaderboard_name, member, member_data)
-    @redis_connection.hmset(member_data_key(leaderboard_name, member), *member_data.to_a.flatten)
+    @redis_connection.hset(member_data_key(leaderboard_name), member, member_data)
   end
 
   # Remove the optional member data for a given member in the leaderboard.
@@ -178,7 +175,7 @@ class Leaderboard
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
   def remove_member_data_in(leaderboard_name, member)
-    @redis_connection.del(member_data_key(leaderboard_name, member))
+    @redis_connection.hdel(member_data_key(leaderboard_name), member)
   end
 
   # Rank an array of members in the leaderboard.
@@ -218,7 +215,7 @@ class Leaderboard
   def remove_member_from(leaderboard_name, member)
     @redis_connection.multi do |transaction|
       transaction.zrem(leaderboard_name, member)
-      transaction.del(member_data_key(leaderboard_name, member))
+      transaction.del(member_data_key(leaderboard_name), member)
     end
   end
 
@@ -299,33 +296,23 @@ class Leaderboard
   # Retrieve the rank for a member in the leaderboard.
   #
   # @param member [String] Member name.
-  # @param use_zero_index_for_rank [boolean, false] If the returned rank should be 0-indexed.
-  #
+  # 
   # @return the rank for a member in the leaderboard.
-  def rank_for(member, use_zero_index_for_rank = false)
-    rank_for_in(@leaderboard_name, member, use_zero_index_for_rank)
+  def rank_for(member)
+    rank_for_in(@leaderboard_name, member)
   end
 
   # Retrieve the rank for a member in the named leaderboard.
   #
   # @param leaderboard_name [String] Name of the leaderboard.
   # @param member [String] Member name.
-  # @param use_zero_index_for_rank [boolean, false] If the returned rank should be 0-indexed.
-  #
+  # 
   # @return the rank for a member in the leaderboard.
-  def rank_for_in(leaderboard_name, member, use_zero_index_for_rank = false)
+  def rank_for_in(leaderboard_name, member)
     if @reverse
-      if use_zero_index_for_rank
-        return @redis_connection.zrank(leaderboard_name, member)
-      else
-        return @redis_connection.zrank(leaderboard_name, member) + 1 rescue nil
-      end
+      return @redis_connection.zrank(leaderboard_name, member) + 1 rescue nil
     else
-      if use_zero_index_for_rank
-        return @redis_connection.zrevrank(leaderboard_name, member)
-      else
-        return @redis_connection.zrevrank(leaderboard_name, member) + 1 rescue nil
-      end
+      return @redis_connection.zrevrank(leaderboard_name, member) + 1 rescue nil
     end
   end
 
@@ -370,21 +357,19 @@ class Leaderboard
   # Retrieve the score and rank for a member in the leaderboard.
   #
   # @param member [String] Member name.
-  # @param use_zero_index_for_rank [boolean, false] If the returned rank should be 0-indexed.
   #
   # @return the score and rank for a member in the leaderboard as a Hash.
-  def score_and_rank_for(member, use_zero_index_for_rank = false)
-    score_and_rank_for_in(@leaderboard_name, member, use_zero_index_for_rank)
+  def score_and_rank_for(member)
+    score_and_rank_for_in(@leaderboard_name, member)
   end
 
   # Retrieve the score and rank for a member in the named leaderboard.
   #
   # @param leaderboard_name [String]Name of the leaderboard.
   # @param member [String] Member name.
-  # @param use_zero_index_for_rank [boolean, false] If the returned rank should be 0-indexed.
   #
   # @return the score and rank for a member in the named leaderboard as a Hash.
-  def score_and_rank_for_in(leaderboard_name, member, use_zero_index_for_rank = false)
+  def score_and_rank_for_in(leaderboard_name, member)
     responses = @redis_connection.multi do |transaction|
       transaction.zscore(leaderboard_name, member)
       if @reverse
@@ -395,11 +380,9 @@ class Leaderboard
     end
 
     responses[0] = responses[0].to_f
-    if !use_zero_index_for_rank
-      responses[1] = responses[1] + 1 rescue nil
-    end
-
-    {:member => member, :score => responses[0], :rank => responses[1]}
+    responses[1] = responses[1] + 1 rescue nil
+    
+    {:member => member, :score => responses[0], :rank => responses[1]}    
   end
 
   # Remove members from the leaderboard in a given score range.
@@ -795,38 +778,19 @@ class Leaderboard
     responses = @redis_connection.multi do |transaction|
       members.each do |member|
         if @reverse
-          transaction.zrank(leaderboard_name, member) if leaderboard_options[:with_rank]
+          transaction.zrank(leaderboard_name, member)
         else
-          transaction.zrevrank(leaderboard_name, member) if leaderboard_options[:with_rank]
+          transaction.zrevrank(leaderboard_name, member)
         end
-        transaction.zscore(leaderboard_name, member) if leaderboard_options[:with_scores]
+        transaction.zscore(leaderboard_name, member)
       end
     end
 
     members.each_with_index do |member, index|
       data = {}
       data[:member] = member
-      if leaderboard_options[:with_scores]
-        if leaderboard_options[:with_rank]
-          if leaderboard_options[:use_zero_index_for_rank]
-            data[:rank] = responses[index * 2]
-          else
-            data[:rank] = responses[index * 2] + 1 rescue nil
-          end
-
-          data[:score] = responses[index * 2 + 1].to_f
-        else
-          data[:score] = responses[index].to_f
-        end
-      else
-        if leaderboard_options[:with_rank]
-          if leaderboard_options[:use_zero_index_for_rank]
-            data[:rank] = responses[index]
-          else
-            data[:rank] = responses[index] + 1 rescue nil
-          end
-        end
-      end
+      data[:rank] = responses[index * 2] + 1 rescue nil
+      data[:score] = responses[index * 2 + 1].to_f
 
       if leaderboard_options[:with_member_data]
         data[:member_data] = member_data_for_in(leaderboard_name, member)
@@ -835,6 +799,13 @@ class Leaderboard
       ranks_for_members << data
     end
 
+    case leaderboard_options[:sort_by]
+    when :rank
+      ranks_for_members = ranks_for_members.sort_by { |member| member[:rank] }
+    when :score
+      ranks_for_members = ranks_for_members.sort_by { |member| member[:score] }
+    end
+
     ranks_for_members
   end
 
@@ -861,11 +832,10 @@ class Leaderboard
   # Key for retrieving optional member data.
   #
   # @param leaderboard_name [String] Name of the leaderboard.
-  # @param member [String] Member name.
-  #
-  # @return a key in the form of +leaderboard_name:data:member+
-  def member_data_key(leaderboard_name, member)
-    "#{leaderboard_name}:member_data:#{member}"
+  # 
+  # @return a key in the form of +leaderboard_name:member_data+
+  def member_data_key(leaderboard_name)
+    "#{leaderboard_name}:member_data" 
   end
 
   # Validate and return the page size. Returns the +DEFAULT_PAGE_SIZE+ if the page size is less than 1.

data/spec/leaderboard_spec.rb

@@ -40,8 +40,10 @@ describe 'Leaderboard' do
     rank_members_in_leaderboard
 
     @redis_connection.exists('name').should be_true
+    @redis_connection.exists('name:member_data').should be_true
     @leaderboard.delete_leaderboard
     @redis_connection.exists('name').should be_false
+    @redis_connection.exists('name:member_data').should be_false
   end
 
   it 'should allow you to pass in an existing redis connection in the initializer' do
@@ -67,7 +69,6 @@ describe 'Leaderboard' do
     rank_members_in_leaderboard(5)
 
     @leaderboard.rank_for('member_4').should be(2)
-    @leaderboard.rank_for('member_4', true).should be(1)
   end
 
   it 'should return the correct score when calling score_for' do
@@ -160,70 +161,57 @@ describe 'Leaderboard' do
   it 'should allow you to retrieve members in a given score range' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
 
-    members = @leaderboard.members_from_score_range(10, 15, {:with_scores => false, :with_rank => false})
+    members = @leaderboard.members_from_score_range(10, 15)
 
-    member_15 = {:member => 'member_15'}
+    member_15 = {:member => 'member_15', :score => 15.0, :rank => 11}
     members[0].should eql(member_15)
 
-    member_10 = {:member => 'member_10'}
+    member_10 = {:member => 'member_10', :score => 10.0, :rank => 16}
     members[5].should eql(member_10)
 
-    members = @leaderboard.members_from_score_range(10, 15, {:with_scores => true, :with_rank => true, :with_member_data => true})
+    members = @leaderboard.members_from_score_range(10, 15, {:with_member_data => true})
 
-    member_15 = {:member => 'member_15', :rank => 11, :score => 15.0, :member_data => {'member_name' => 'Leaderboard member 15'}}
-    members[0].should eql(member_15)
+    member_15 = {:member => 'member_15', :rank => 11, :score => 15.0, :member_data => {:member_name => 'Leaderboard member 15'}.to_s}
+    members[0].should == member_15
 
-    member_10 = {:member => 'member_10', :rank => 16, :score => 10.0, :member_data => {'member_name' => 'Leaderboard member 10'}}
-    members[5].should eql(member_10)
-  end
-
-  it 'should allow you to retrieve leaders without scores and ranks' do
-    rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
-
-    @leaderboard.total_members.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false})
-
-    member_25 = {:member => 'member_25'}
-    leaders[0].should eql(member_25)
-
-    member_1 = {:member => 'member_1'}
-    leaders[24].should eql(member_1)
+    member_10 = {:member => 'member_10', :rank => 16, :score => 10.0, :member_data => {:member_name => 'Leaderboard member 10'}.to_s}
+    members[5].should == member_10
   end
 
   it 'should allow you to retrieve leaders with extra data' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
 
     @leaderboard.total_members.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false, :with_member_data => true})
-
-    member_25 = {:member => 'member_25', :member_data => { "member_name" => "Leaderboard member 25" }}
-    leaders[0].should eql(member_25)
+    leaders = @leaderboard.leaders(1, {:with_member_data => true})
 
-    member_1 = {:member => 'member_1', :member_data => { "member_name" => "Leaderboard member 1" }}
-    leaders[24].should eql(member_1)
+    member_25 = {:member => 'member_25', :score => 25.0, :rank => 1, :member_data => { :member_name => "Leaderboard member 25" }.to_s }
+    leaders[0].should == member_25
+    
+    member_1 = {:member => 'member_1', :score => 1.0, :rank => 25, :member_data => { :member_name => "Leaderboard member 1" }.to_s }
+    leaders[24].should == member_1
   end
 
   it 'should allow you to retrieve optional member data' do
     @leaderboard.rank_member('member_id', 1, {'username' => 'member_name', 'other_data_key' => 'other_data_value'})
 
-    @leaderboard.member_data_for('unknown_member').should eql({})
-    @leaderboard.member_data_for('member_id').should eql({'username' => 'member_name', 'other_data_key' => 'other_data_value'})
+    @leaderboard.member_data_for('unknown_member').should be_nil
+    @leaderboard.member_data_for('member_id').should == {'username' => 'member_name', 'other_data_key' => 'other_data_value'}.to_s
   end
 
   it 'should allow you to update optional member data' do
     @leaderboard.rank_member('member_id', 1, {'username' => 'member_name'})
 
-    @leaderboard.member_data_for('member_id').should eql({'username' => 'member_name'})
-    @leaderboard.update_member_data('member_id', {'other_data_key' => 'other_data_value'})
-    @leaderboard.member_data_for('member_id').should eql({'username' => 'member_name', 'other_data_key' => 'other_data_value'})
+    @leaderboard.member_data_for('member_id').should == {'username' => 'member_name'}.to_s
+    @leaderboard.update_member_data('member_id', {'username' => 'member_name', 'other_data_key' => 'other_data_value'})
+    @leaderboard.member_data_for('member_id').should == {'username' => 'member_name', 'other_data_key' => 'other_data_value'}.to_s
   end
 
   it 'should allow you to remove optional member data' do
     @leaderboard.rank_member('member_id', 1, {'username' => 'member_name'})
 
-    @leaderboard.member_data_for('member_id').should eql({'username' => 'member_name'})
+    @leaderboard.member_data_for('member_id').should == {'username' => 'member_name'}.to_s
     @leaderboard.remove_member_data('member_id')
-    @leaderboard.member_data_for('member_id').should eql({})
+    @leaderboard.member_data_for('member_id').should be_nil
   end
 
   it 'should allow you to call leaders with various options that respect the defaults for the options not passed in' do
@@ -231,33 +219,7 @@ describe 'Leaderboard' do
 
     leaders = @leaderboard.leaders(1, :page_size => 1)
     leaders.size.should be(1)
-
-    leaders = @leaderboard.leaders(1, :with_rank => false)
-    leaders.size.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    member_26 = {:member => 'member_26', :score => 26.0}
-    member_25 = {:member => 'member_25', :score => 25.0}
-    member_24 = {:member => 'member_24', :score => 24.0}
-    leaders[0].should eql(member_26)
-    leaders[1].should eql(member_25)
-    leaders[2].should eql(member_24)
-
-    leaders = @leaderboard.leaders(1, :with_scores => false)
-    leaders.size.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    member_26 = {:member => 'member_26', :rank => 1}
-    member_25 = {:member => 'member_25', :rank => 2}
-    leaders[0].should eql(member_26)
-    leaders[1].should eql(member_25)
-
-    leaders = @leaderboard.leaders(1, :with_scores => false, :with_rank => false)
-    leaders.size.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    member_26 = {:member => 'member_26'}
-    member_25 = {:member => 'member_25'}
-    leaders[0].should eql(member_26)
-    leaders[1].should eql(member_25)
-
-    leaders = @leaderboard.leaders(1, :with_rank => false, :page_size => 1)
-    leaders.size.should be(1)
-    member_26 = {:member => 'member_26', :score => 26.0}
+    member_26 = {:member => 'member_26', :score => 26.0, :rank => 1}
     leaders[0].should eql(member_26)
   end
 
@@ -268,8 +230,7 @@ describe 'Leaderboard' do
     @leaderboard.member_at(26)[:rank].should eql(26)
     @leaderboard.member_at(50)[:rank].should eql(50)
     @leaderboard.member_at(51).should be_nil
-    @leaderboard.member_at(1, :with_member_data => true)[:member_data].should eql({'member_name' => 'Leaderboard member 50'})
-    @leaderboard.member_at(1, :use_zero_index_for_rank => true)[:rank].should eql(0)
+    @leaderboard.member_at(1, :with_member_data => true)[:member_data].should == {:member_name => 'Leaderboard member 50'}.to_s
   end
 
   it 'should return the correct information when calling around_me' do
@@ -313,8 +274,7 @@ describe 'Leaderboard' do
     @leaderboard.total_members.should be(Leaderboard::DEFAULT_PAGE_SIZE)
 
     members = ['member_1', 'member_5', 'member_10']
-    ranked_members = @leaderboard.ranked_in_list(members, {:with_scores => false, :with_rank => true, :use_zero_index_for_rank => false})
-
+    ranked_members = @leaderboard.ranked_in_list(members, {:with_rank => true})
     ranked_members.size.should be(3)
     ranked_members[0][:rank].should be(25)
     ranked_members[1][:rank].should be(21)
@@ -450,19 +410,15 @@ describe 'Leaderboard' do
     foobar.disconnect
   end
 
-  it 'should respect the with_scores option in the massage_leader_data method' do
+  it 'should respect options in the massage_leader_data method' do
     rank_members_in_leaderboard(25)
 
     @leaderboard.total_members.should be(25)
 
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false})
+    leaders = @leaderboard.leaders(1)
     leaders[0][:member].should_not be_nil
-    leaders[0][:score].should be_nil
-    leaders[0][:rank].should be_nil
-
-    @leaderboard.page_size = 25
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false})
-    leaders.size.should be(25)
+    leaders[0][:score].should_not be_nil
+    leaders[0][:rank].should_not be_nil
 
     @leaderboard.page_size = Leaderboard::DEFAULT_PAGE_SIZE
     leaders = @leaderboard.leaders(1, Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
@@ -638,4 +594,40 @@ describe 'Leaderboard' do
     members[0][:score].to_i.should be(25)
     members[24][:member].should eql('member_1')
   end
+
+  it 'should sort by rank if the :sort_by option is set to :rank' do
+    rank_members_in_leaderboard(25)
+
+    members = ['member_5', 'member_1', 'member_10']
+    ranked_members = @leaderboard.ranked_in_list(members, :sort_by => :rank)
+
+    ranked_members.size.should be(3)
+
+    ranked_members[0][:rank].should be(16)
+    ranked_members[0][:score].should eql(10.0)
+
+    ranked_members[1][:rank].should be(21)
+    ranked_members[1][:score].should eql(5.0)
+
+    ranked_members[2][:rank].should be(25)
+    ranked_members[2][:score].should eql(1.0)
+  end
+
+  it 'should sort by score if the :sort_by option is set to :score' do
+    rank_members_in_leaderboard(25)
+
+    members = ['member_5', 'member_1', 'member_10']
+    ranked_members = @leaderboard.ranked_in_list(members, :sort_by => :score)
+
+    ranked_members.size.should be(3)
+
+    ranked_members[0][:rank].should be(25)
+    ranked_members[0][:score].should eql(1.0)
+
+    ranked_members[1][:rank].should be(21)
+    ranked_members[1][:score].should eql(5.0)
+
+    ranked_members[2][:rank].should be(16)
+    ranked_members[2][:score].should eql(10.0)
+  end
 end

data/spec/reverse_leaderboard_spec.rb

@@ -16,7 +16,6 @@ describe 'Leaderboard (reverse option)' do
     rank_members_in_leaderboard(5)
 
     @leaderboard.rank_for('member_4').should be(4)
-    @leaderboard.rank_for('member_4', true).should be(3)
   end
 
   it 'should return the correct list when calling leaders' do
@@ -52,32 +51,19 @@ describe 'Leaderboard (reverse option)' do
 
     members = @leaderboard.members_from_score_range(10, 15, {:with_scores => false, :with_rank => false})
 
-    member_10 = {:member => 'member_10'}
+    member_10 = {:member => 'member_10', :score => 10.0, :rank => 10}
     members[0].should eql(member_10)
 
-    member_15 = {:member => 'member_15'}
+    member_15 = {:member => 'member_15', :score => 15.0, :rank => 15}
     members[5].should eql(member_15)
 
-    members = @leaderboard.members_from_score_range(10, 15, {:with_scores => true, :with_rank => true, :with_member_data => true})
+    members = @leaderboard.members_from_score_range(10, 15, {:with_member_data => true})
 
-    member_10 = {:member => 'member_10', :rank => 10, :score => 10.0, :member_data => {'member_name' => 'Leaderboard member 10'}}
-    members[0].should eql(member_10)
-
-    member_15 = {:member => 'member_15', :rank => 15, :score => 15.0, :member_data => {'member_name' => 'Leaderboard member 15'}}
-    members[5].should eql(member_15)
-  end
-
-  it 'should allow you to retrieve leaders without scores and ranks' do
-    rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
-
-    @leaderboard.total_members.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false})
+    member_10 = {:member => 'member_10', :rank => 10, :score => 10.0, :member_data => {:member_name => 'Leaderboard member 10'}.to_s}
+    members[0].should == member_10
 
-    member_1 = {:member => 'member_1'}
-    leaders[0].should eql(member_1)
-
-    member_25 = {:member => 'member_25'}
-    leaders[24].should eql(member_25)
+    member_15 = {:member => 'member_15', :rank => 15, :score => 15.0, :member_data => {:member_name => 'Leaderboard member 15'}.to_s}
+    members[5].should == member_15
   end
 
   it 'should allow you to call leaders with various options that respect the defaults for the options not passed in' do
@@ -86,33 +72,14 @@ describe 'Leaderboard (reverse option)' do
     leaders = @leaderboard.leaders(1, :page_size => 1)
     leaders.size.should be(1)
 
-    leaders = @leaderboard.leaders(1, :with_rank => false)
+    leaders = @leaderboard.leaders(1)
     leaders.size.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    member_1 = {:member => 'member_1', :score => 1.0}
-    member_2 = {:member => 'member_2', :score => 2.0}
-    member_3 = {:member => 'member_3', :score => 3.0}
+    member_1 = {:member => 'member_1', :score => 1.0, :rank => 1}
+    member_2 = {:member => 'member_2', :score => 2.0, :rank => 2}
+    member_3 = {:member => 'member_3', :score => 3.0, :rank => 3}
     leaders[0].should eql(member_1)
     leaders[1].should eql(member_2)
     leaders[2].should eql(member_3)
-
-    leaders = @leaderboard.leaders(1, :with_scores => false)
-    leaders.size.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    member_1 = {:member => 'member_1', :rank => 1}
-    member_2 = {:member => 'member_2', :rank => 2}
-    leaders[0].should eql(member_1)
-    leaders[1].should eql(member_2)
-
-    leaders = @leaderboard.leaders(1, :with_scores => false, :with_rank => false)
-    leaders.size.should be(Leaderboard::DEFAULT_PAGE_SIZE)
-    member_1 = {:member => 'member_1'}
-    member_2 = {:member => 'member_2'}
-    leaders[0].should eql(member_1)
-    leaders[1].should eql(member_2)
-
-    leaders = @leaderboard.leaders(1, :with_rank => false, :page_size => 1)
-    leaders.size.should be(1)
-    member_1 = {:member => 'member_1', :score => 1.0}
-    leaders[0].should eql(member_1)
   end
 
   it 'should return a single member when calling member_at' do
@@ -122,8 +89,7 @@ describe 'Leaderboard (reverse option)' do
     @leaderboard.member_at(26)[:rank].should eql(26)
     @leaderboard.member_at(50)[:rank].should eql(50)
     @leaderboard.member_at(51).should be_nil
-    @leaderboard.member_at(1, :with_member_data => true)[:member_data].should eql({'member_name' => 'Leaderboard member 1'})
-    @leaderboard.member_at(1, :use_zero_index_for_rank => true)[:rank].should eql(0)
+    @leaderboard.member_at(1, :with_member_data => true)[:member_data].should == {:member_name => 'Leaderboard member 1'}.to_s
   end
 
   it 'should return the correct information when calling around_me' do
@@ -167,8 +133,7 @@ describe 'Leaderboard (reverse option)' do
     @leaderboard.total_members.should be(Leaderboard::DEFAULT_PAGE_SIZE)
 
     members = ['member_1', 'member_5', 'member_10']
-    ranked_members = @leaderboard.ranked_in_list(members, {:with_scores => false, :with_rank => true, :use_zero_index_for_rank => false})
-
+    ranked_members = @leaderboard.ranked_in_list(members, {:with_scores => false, :with_rank => true})
     ranked_members.size.should be(3)
 
     ranked_members[0][:rank].should be(1)
@@ -261,29 +226,22 @@ describe 'Leaderboard (reverse option)' do
     foobar.disconnect
   end
 
-  it 'should respect the with_scores option in the massage_leader_data method' do
+  it 'should respect options in the massage_leader_data method' do
     rank_members_in_leaderboard(25)
 
     @leaderboard.total_members.should be(25)
 
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false})
+    leaders = @leaderboard.leaders(1)
     leaders[0][:member].should_not be_nil
-    leaders[0][:score].should be_nil
-    leaders[0][:rank].should be_nil
-
-    @leaderboard.page_size = 25
-    leaders = @leaderboard.leaders(1, {:with_scores => false, :with_rank => false})
-    leaders.size.should be(25)
+    leaders[0][:score].should_not be_nil
+    leaders[0][:rank].should_not be_nil
 
     @leaderboard.page_size = Leaderboard::DEFAULT_PAGE_SIZE
     leaders = @leaderboard.leaders(1, Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
+    leaders.size.should be(25)
     leaders[0][:member].should_not be_nil
     leaders[0][:score].should_not be_nil
     leaders[0][:rank].should_not be_nil
-
-    @leaderboard.page_size = 25
-    leaders = @leaderboard.leaders(1, Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS)
-    leaders.size.should be(25)
   end
 
   it 'should return the correct number of members when calling around_me with a page_size options' do
@@ -354,4 +312,40 @@ describe 'Leaderboard (reverse option)' do
     members[0][:score].to_i.should be(1)    
     members[24][:member].should eql('member_25')
   end
+
+  it 'should sort by rank if the :sort_by option is set to :rank' do
+    rank_members_in_leaderboard(25)
+
+    members = ['member_5', 'member_1', 'member_10']
+    ranked_members = @leaderboard.ranked_in_list(members, :sort_by => :rank)
+
+    ranked_members.size.should be(3)
+
+    ranked_members[0][:rank].should be(1)
+    ranked_members[0][:score].should eql(1.0)
+
+    ranked_members[1][:rank].should be(5)
+    ranked_members[1][:score].should eql(5.0)
+
+    ranked_members[2][:rank].should be(10)
+    ranked_members[2][:score].should eql(10.0)
+  end
+
+  it 'should sort by score if the :sort_by option is set to :score' do
+    rank_members_in_leaderboard(25)
+
+    members = ['member_5', 'member_1', 'member_10']
+    ranked_members = @leaderboard.ranked_in_list(members, :sort_by => :score)
+
+    ranked_members.size.should be(3)
+
+    ranked_members[0][:rank].should be(1)
+    ranked_members[0][:score].should eql(1.0)
+
+    ranked_members[1][:rank].should be(5)
+    ranked_members[1][:score].should eql(5.0)
+
+    ranked_members[2][:rank].should be(10)
+    ranked_members[2][:score].should eql(10.0)
+  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 == '2.5.0'
+    Leaderboard::VERSION.should == '3.0.0.rc1'
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 2.5.0
-  prerelease: 
+  version: 3.0.0.rc1
+  prerelease: 6
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2012-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -95,16 +95,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1313694139295611168
+      hash: -395088559469707987
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 1313694139295611168
+      version: 1.3.1
 requirements: []
 rubyforge_project: leaderboard
 rubygems_version: 1.8.24