leaderboard 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e2258ac4147cfe36d76299662c67d8ac5f360de
-  data.tar.gz: 50896b7f86ae70b0339551f8b0afd5ce32383353
+  metadata.gz: 3f0aeb0cd68034cf6d268f8f1d8d4e8a39c0df66
+  data.tar.gz: 4576a03574ab9f93200d11ab861b9b3203a179dc
 SHA512:
-  metadata.gz: dba84526f444d7494f2ea0a21ec8e8fd90b408f7477c1a9abe06cc6f9ff688f90e17935bebbdb71ca2261593608e61b610d8441cda7d161dda74306294308bed
-  data.tar.gz: 5c25f504a4ba53fcdc109692a82b09b50fef8711ab3521b9a2a9d303c3dd9a83caa305297df510974029c5d4ba98bf696d515a6411025b82c5bc7c9f34950093
+  metadata.gz: ac3cc4247ea3c1ca634375112b2614dbe18a1d1a8ab818f08c2f27fe1c1167dea897b95eb7014704a81c0a9303ed03865537837f0eb7efed8bd1b34e8990de1e
+  data.tar.gz: 68128561ee0b7d89d929c251d19b5463ca836325d15a1a163a48e370dba1a39e8475106c7575d9ddbc0ea04dcdbeb8c544e88512879ca25805d124f023ae2b6a

data/CHANGELOG.markdown

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 3.11.0 (2016-09-16)
+
+* More pipelining [#58](https://github.com/agoragames/leaderboard/pull/58).
+  Also adds `members_data_for(...) and `members_data_for_in(...)` methods.
+* Guard against an out of bounds index in `member_at`
+
 ## 3.10.0 (2015-03-20)
 
 * Fixes TieRankingLeaderboard doesn't rank if the score is 0 [#53](https://github.com/agoragames/leaderboard/issues/53).

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2014 David Czarnecki
+Copyright (c) 2011-2016 David Czarnecki
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -21,7 +21,9 @@ check out the [Redis documentation](http://redis.io/documentation).
 
 ## Compatibility
 
-The gem has been built and tested under Ruby 1.9.3 and Ruby 2.1.2.
+The gem has been built and tested under 2.2.1.
+
+NOTE: The gem should work fine in earlier versions of Ruby such as 1.8.7 or 1.9.3. There are no specific aspects of Ruby 2.x that we utilize at this time.
 
 ## Usage
 
@@ -184,6 +186,7 @@ You can pass various options to the calls `leaders`, `all_leaders`, `around_me`,
 * `: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_by` - Valid values for `:sort_by` are `:none` (default), `:score` and `:rank`.
+* `:include_missing` - `true` (default) or `false` to return members that are not ranked.
 
 You can also use the `members` and `members_in` methods as aliases for the `leaders` and `leaders_in` methods.
 
@@ -340,6 +343,7 @@ Competition ranking: The `CompetitionRankingLeaderboard` subclass of `Leaderboar
 ```
   delete_leaderboard: Delete the current leaderboard
   member_data_for(member): Retrieve the optional member data for a given member in the leaderboard
+  members_data_for(members): Retrieve the optional member data for a given list of members in the leaderboard
   update_member_data(member, member_data): Update the optional member data for a given member in the leaderboard
   remove_member_data(member): Remove the optional member data for a given member in the leaderboard
   remove_member(member): Remove a member from the leaderboard
@@ -482,5 +486,5 @@ Unofficially supported (they need some feature parity love):
 
 ## Copyright
 
-Copyright (c) 2011-2014 David Czarnecki. See LICENSE.txt for further details.
+Copyright (c) 2011-2016 David Czarnecki. See LICENSE.txt for further details.
 

data/lib/competition_ranking_leaderboard.rb

@@ -67,29 +67,36 @@ class CompetitionRankingLeaderboard < Leaderboard
       end
     end unless leaderboard_options[:members_only]
 
+    included_members = []
+    scores = []
+
     members.each_with_index do |member, index|
       data = {}
       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[@rank_key] = @redis_connection.zcount(leaderboard_name, "(#{data[@score_key]}", '+inf') + 1 rescue nil
-        end
       end
 
-      if leaderboard_options[:with_member_data]
-        data[@member_data_key] = member_data_for_in(leaderboard_name, member)
-      end
+      included_members << member
+      scores << data[@score_key]
 
       ranks_for_members << data
     end
 
+    if leaderboard_options[:with_member_data]
+      members_data_for_in(leaderboard_name, included_members).each_with_index do |member_data, index|
+        ranks_for_members[index][@member_data_key] = member_data
+      end
+    end
+
+    rankings_for_members_having_scores_in(leaderboard_name, included_members, scores).each_with_index do |rank, index|
+      ranks_for_members[index][@rank_key] = rank
+    end
+
     case leaderboard_options[:sort_by]
     when :rank
       ranks_for_members = ranks_for_members.sort_by { |member| member[@rank_key] }
@@ -99,4 +106,26 @@ class CompetitionRankingLeaderboard < Leaderboard
 
     ranks_for_members
   end
-end
+
+  protected
+
+  # Retrieve a list of the rankings of leaders given their member names and scores
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param members [Array] Member names.
+  # @param scores [Array] a list of scores for the members, aligned with the member names
+  #
+  # @return a list of the rankings for the passed in members and scores
+  def rankings_for_members_having_scores_in(leaderboard_name, members, scores)
+    @redis_connection.multi do |transaction|
+      members.each_with_index do |member, index|
+        if @reverse
+          transaction.zcount(leaderboard_name, '-inf', "(#{scores[index]}")
+        else
+          transaction.zcount(leaderboard_name, "(#{scores[index]}", '+inf')
+        end
+      end
+    end.map{|rank| rank ? rank + 1 : rank}
+  end
+
+end

data/lib/leaderboard.rb

@@ -219,6 +219,26 @@ class Leaderboard
     @redis_connection.hget(member_data_key(leaderboard_name), member)
   end
 
+  # Retrieve the optional member data for a given member in the named leaderboard.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param members [Array] Member names.
+  #
+  # @return array of strings of optional member data.
+  def members_data_for_in(leaderboard_name, members)
+    return [] unless members.size > 0
+    @redis_connection.hmget(member_data_key(leaderboard_name), *members)
+  end
+
+  # Retrieve the optional member data for the given members in the leaderboard.
+  #
+  # @param members [Array] Member names.
+  #
+  # @return array of strings of optional member data.
+  def members_data_for(members)
+    members_data_for_in(@leaderboard_name, members)
+  end
+
   # Update the optional member data for a given member in the leaderboard.
   #
   # @param member [String] Member name.
@@ -860,7 +880,7 @@ class Leaderboard
   #
   # @return a page of leaders from the named leaderboard.
   def member_at_in(leaderboard_name, position, options = {})
-    if position <= total_members_in(leaderboard_name)
+    if position > 0 && position <= total_members_in(leaderboard_name)
       leaderboard_options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS.dup
       leaderboard_options.merge!(options)
       page_size = validate_page_size(leaderboard_options[:page_size]) || @page_size
@@ -964,13 +984,15 @@ class Leaderboard
         data[@score_key] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
       end
 
-      if leaderboard_options[:with_member_data]
-        data[@member_data_key] = member_data_for_in(leaderboard_name, member)
-      end
-
       ranks_for_members << data
     end
 
+    if leaderboard_options[:with_member_data]
+      members_data_for_in(leaderboard_name, members).each_with_index do |member_data, index|
+        ranks_for_members[index][@member_data_key] = member_data
+      end
+    end
+
     case leaderboard_options[:sort_by]
     when :rank
       ranks_for_members = ranks_for_members.sort_by { |member| member[@rank_key] }

data/lib/leaderboard/version.rb

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

data/lib/tie_ranking_leaderboard.rb

@@ -249,13 +249,15 @@ class TieRankingLeaderboard < Leaderboard
         end
       end
 
-      if leaderboard_options[:with_member_data]
-        data[@member_data_key] = member_data_for_in(leaderboard_name, member)
-      end
-
       ranks_for_members << data
     end
 
+    if leaderboard_options[:with_member_data]
+      members_data_for_in(leaderboard_name, members).each_with_index do |member_data, index|
+        ranks_for_members[index][@member_data_key] = member_data
+      end
+    end
+
     case leaderboard_options[:sort_by]
     when :rank
       ranks_for_members = ranks_for_members.sort_by { |member| member[@rank_key] }

data/spec/leaderboard_spec.rb

@@ -199,6 +199,14 @@ describe 'Leaderboard' do
     expect(@leaderboard.member_data_for('member_id')).to eq({'username' => 'member_name', 'other_data_key' => 'other_data_value'}.to_s)
   end
 
+  it 'should allow you to retrieve optional member data for multiple members' do
+    rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
+
+    members_data = @leaderboard.members_data_for(['member_1', 'member_3'])
+    expect(members_data[0]).to eq({:member_name => 'Leaderboard member 1'}.to_s)
+    expect(members_data[1]).to eq({:member_name => 'Leaderboard member 3'}.to_s)
+  end
+
   it 'should allow you to update optional member data' do
     @leaderboard.rank_member('member_id', 1, {'username' => 'member_name'})
 
@@ -234,6 +242,12 @@ describe 'Leaderboard' do
     expect(@leaderboard.member_at(1, :with_member_data => true)[:member_data]).to eq({:member_name => 'Leaderboard member 50'}.to_s)
   end
 
+  it 'should not return a single member when calling member_at with a position < 0' do
+    rank_members_in_leaderboard(5)
+    expect(@leaderboard.member_at(1)[:rank]).to eql(1)
+    expect(@leaderboard.member_at(-5)).to be nil
+  end
+
   it 'should return the correct information when calling around_me' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE * 3 + 1)
 

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2016-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis