leaderboard 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bde8fa5f70279295659c4d1d2eff551c105ccf8
-  data.tar.gz: 0de720bc5a777acb6c568ebcd5a62d99490b799f
+  metadata.gz: 7f50c3a3b7020a18f0f1748f97bfd562958d13ea
+  data.tar.gz: 3f322fef803e8b098265f4282c2131c93ca75507
 SHA512:
-  metadata.gz: 237db7f422c2df67dc63040304a49efc806ce716e4976d5f2b68c36c70c6fa42b9fdd349237376a998430fd9ccd5faed03c0bd2ba075a1650dcb34f0aa153d66
-  data.tar.gz: 26c645596ea59bc82c738e16d1c8313b2c87753ccc1936dff64d4a2a70277683eac8e5479844467815a7d68824432736e95ebbdf7960aadb8846ac39d012a6bf
+  metadata.gz: 1060d4cc1804f92ca1005bc39e7ecab287faa29e6a926fad090f6403f666b68cde60152d5c93608715484b1094f8608fc15b6798cec0dbe7f926782475de1f23
+  data.tar.gz: 0eca6086b8c7db70f505d933749173c3dc91399c23fe1ee91920f8e7d3b380c2506761d7195af6b84aaecd4d11091fa6ce91d93364cd427f8d3eed43be67c7d7

data/CHANGELOG.markdown

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 3.9.0 (2015-02-15)
+
+* Add `global_member_data` option that allows multiple leaderboards to share the same set of member_data. [#51](https://github.com/agoragames/leaderboard/pull/51)
+* Add `top` helper method. [#50](https://github.com/agoragames/leaderboard/pull/50).
+
 ## 3.8.0 (2014-11-07)
 
 * Add support for `change_score_for(...)` in the `TieRankingLeaderboard` class.

data/README.markdown

@@ -52,13 +52,14 @@ DEFAULT_OPTIONS = {
   :rank_key => :rank,
   :score_key => :score,
   :member_data_key => :member_data,
-  :member_data_namespace => 'member_data'
+  :member_data_namespace => 'member_data',
+  :global_member_data => false
 }
 ```
 
 The `DEFAULT_PAGE_SIZE` is 25.
 
-You would use the option, `:reverse => true`, if you wanted a leaderboard sorted from lowest-to-highest score. You may also set the `reverse` option on a leaderboard after you have created a new instance of a leaderboard. The various `..._key` options above control what data is returned in the hash of leaderboard data from calls such as `leaders` or `around_me`.
+You would use the option, `:reverse => true`, if you wanted a leaderboard sorted from lowest-to-highest score. You may also set the `reverse` option on a leaderboard after you have created a new instance of a leaderboard. The various `..._key` options above control what data is returned in the hash of leaderboard data from calls such as `leaders` or `around_me`. Finally, the `global_member_data` option allows you to control whether optional member data is per-leaderboard (`false`) or global (`true`).
 
 If you need to pass in options for Redis, you can do this in the initializer:
 
@@ -131,7 +132,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, {'username' => 'member_name'}.to_json)
 ```
 
 You can retrieve, update and remove the optional member data using the
@@ -141,7 +142,7 @@ You can retrieve, update and remove the optional member data using the
 JSON.parse(highscore_lb.member_data_for('84849292'))
  => {"username"=>"member_name"}
 
-highscore_lb.update_member_data('84849292', JSON.generate({'last_updated' => Time.now, 'username' => 'updated_member_name'}))
+highscore_lb.update_member_data('84849292', {'last_updated' => Time.now, 'username' => 'updated_member_name'}.to_json)
  => "OK"
 JSON.parse(highscore_lb.member_data_for('84849292'))
  => {"username"=>"updated_member_name", "last_updated"=>"2012-06-09 09:11:06 -0400"}
@@ -360,6 +361,7 @@ Competition ranking: The `CompetitionRankingLeaderboard` subclass of `Leaderboar
   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
+  top(number, options): Retrieve members from the leaderboard within a range from 1 to the number given.
 ```
 
 Check the [online documentation](http://rubydoc.info/gems/leaderboard/frames) for more detail on each method.

data/lib/leaderboard.rb

@@ -15,7 +15,8 @@ class Leaderboard
     :rank_key => :rank,
     :score_key => :score,
     :member_data_key => :member_data,
-    :member_data_namespace => 'member_data'
+    :member_data_namespace => 'member_data',
+    :global_member_data => false
   }
 
   # Default Redis host: localhost
@@ -80,6 +81,7 @@ class Leaderboard
     @score_key = leaderboard_options[:score_key]
     @member_data_key = leaderboard_options[:member_data_key]
     @member_data_namespace = leaderboard_options[:member_data_namespace]
+    @global_member_data = leaderboard_options[:global_member_data]
 
     @redis_connection = redis_options[:redis_connection]
     unless @redis_connection.nil?
@@ -812,6 +814,28 @@ class Leaderboard
     end
   end
 
+  # Retrieve members from the leaderboard within a range from 1 to the number given.
+  #
+  # @param ending_rank [int] Ending rank (inclusive).
+  # @param options [Hash] Options to be used when retrieving the data from the leaderboard.
+  #
+  # @return number from the leaderboard that fall within the given rank range.
+  def top(number, options = {})
+    top_in(@leaderboard_name, number, options)
+  end
+
+  # Retrieve members from the named leaderboard within a range from 1 to the number given.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param starting_rank [int] Starting rank (inclusive).
+  # @param ending_rank [int] Ending rank (inclusive).
+  # @param options [Hash] Options to be used when retrieving the data from the leaderboard.
+  #
+  # @return members from the leaderboard that fall within the given rank range.
+  def top_in(leaderboard_name, number, options={})
+    members_from_rank_range_in(leaderboard_name, 1, number, options)
+  end
+
   # Retrieve a member at the specified index from the leaderboard.
   #
   # @param position [int] Position in leaderboard.
@@ -974,7 +998,7 @@ class Leaderboard
   #
   # @return a key in the form of +leaderboard_name:member_data+
   def member_data_key(leaderboard_name)
-    "#{leaderboard_name}:#{@member_data_namespace}"
+    @global_member_data == false ? "#{leaderboard_name}:#{@member_data_namespace}" : @member_data_namespace
   end
 
   # Validate and return the page size. Returns the +DEFAULT_PAGE_SIZE+ if the page size is less than 1.
@@ -989,4 +1013,4 @@ class Leaderboard
 
     page_size
   end
-end
+end

data/lib/leaderboard/version.rb

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

data/spec/competition_ranking_leaderboard_spec.rb

@@ -123,5 +123,48 @@ describe 'CompetitionRankingLeaderboard' do
 
       leaderboard.disconnect
     end
+
+    it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+      @leaderboard = CompetitionRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top(5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
+    it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+      @leaderboard = CompetitionRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top_in("ties", 5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
   end
-end
+end

data/spec/leaderboard_spec.rb

@@ -626,6 +626,46 @@ describe 'Leaderboard' do
     expect(members[24][:member]).to eql('member_1')
   end
 
+  it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top(5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[4][:member]).to eql('member_21')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_25')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[24][:member]).to eql('member_1')
+  end
+
+  it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top_in("name", 5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[4][:member]).to eql('member_21')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_25')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_25')
+    expect(members[0][:score].to_i).to be(25)
+    expect(members[24][:member]).to eql('member_1')
+  end
+
   it 'should sort by rank if the :sort_by option is set to :rank' do
     rank_members_in_leaderboard(25)
 
@@ -767,4 +807,12 @@ describe 'Leaderboard' do
     expect(@redis_connection.exists("name:member_data")).to be_falsey
     expect(@redis_connection.exists("name:md")).to be_truthy
   end
-end
+
+  it 'should allow you to have a global member data namespace' do
+    @leaderboard = Leaderboard.new('name', {:global_member_data => true}, {:host => "127.0.0.1", :db => 15})
+    rank_members_in_leaderboard
+
+    expect(@redis_connection.exists("member_data")).to be_truthy
+    expect(@redis_connection.exists("name:member_data")).to be_falsey
+  end
+end

data/spec/reverse_leaderboard_spec.rb

@@ -335,6 +335,48 @@ describe 'Leaderboard (reverse option)' do
     expect(members[24][:member]).to eql('member_25')
   end
 
+  it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top(5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[4][:member]).to eql('member_5')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_1')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[24][:member]).to eql('member_25')
+  end
+
+  it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+    rank_members_in_leaderboard(25)
+
+    members = @leaderboard.top_in("name", 5)
+    expect(members.size).to be(5)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[4][:member]).to eql('member_5')
+
+    members = @leaderboard.top(1)
+    expect(members.size).to be(1)
+    expect(members[0][:member]).to eql('member_1')
+
+    members = @leaderboard.top(26)
+    expect(members.size).to be(25)
+    expect(members[0][:member]).to eql('member_1')
+    expect(members[0][:score].to_i).to be(1)
+    expect(members[24][:member]).to eql('member_25')
+  end
+
+
+
   it 'should sort by rank if the :sort_by option is set to :rank' do
     rank_members_in_leaderboard(25)
 
@@ -370,4 +412,4 @@ describe 'Leaderboard (reverse option)' do
     expect(ranked_members[2][:rank]).to be(10)
     expect(ranked_members[2][:score]).to eql(10.0)
   end
-end
+end

data/spec/tie_ranking_leaderboard_spec.rb

@@ -197,6 +197,69 @@ describe 'TieRankingLeaderboard' do
       end
     end
 
+    it 'should allow you to retrieve a given set of members from the leaderboard in a rank range' do
+      @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.members_from_rank_range(5, 9)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_21')
+      expect(members[0][:score].to_i).to be(21)
+      expect(members[4][:member]).to eql('member_17')
+
+      members = @leaderboard.members_from_rank_range(1, 1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.members_from_rank_range(-1, 26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
+    it 'should allow you to retrieve a given set of members from the leaderboard in a range from 1 to the number given' do
+      @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top(5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
+    it 'should allow you to retrieve a given set of members from the named leaderboard in a range from 1 to the number given' do
+      @leaderboard = TieRankingLeaderboard.new('name', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
+      rank_members_in_leaderboard(25)
+
+      members = @leaderboard.top_in("name", 5)
+      expect(members.size).to be(5)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[4][:member]).to eql('member_21')
+
+      members = @leaderboard.top(1)
+      expect(members.size).to be(1)
+      expect(members[0][:member]).to eql('member_25')
+
+      members = @leaderboard.top(26)
+      expect(members.size).to be(25)
+      expect(members[0][:member]).to eql('member_25')
+      expect(members[0][:score].to_i).to be(25)
+      expect(members[24][:member]).to eql('member_1')
+    end
+
     it 'should expire the ties leaderboard in a given number of seconds' do
       @leaderboard = TieRankingLeaderboard.new('ties', Leaderboard::DEFAULT_OPTIONS, {:host => "127.0.0.1", :db => 15})
 
@@ -238,4 +301,4 @@ describe 'TieRankingLeaderboard' do
       end
     end
   end
-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
-    expect(Leaderboard::VERSION).to eq('3.8.0')
+    expect(Leaderboard::VERSION).to eq('3.9.0')
   end
 end

metadata

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