leaderboard 3.4.0 → 3.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDg1OTQ1OTc4MzkzY2I4Mzc5ZjEwZWVlZTU3M2QzMTdlZDc2MmM4MQ==
+    ZjY2OTAyMGJjZTE2NmFiNjQyYTdjZjUyNmUwMGUzZDc4NGM1ZDY5NQ==
   data.tar.gz: !binary |-
-    YjEwOWE0Mzk3NjA1YjA5NzlmYzQ0OWQ0ODliN2E1NjFjYzE4MTkzMA==
+    MDJhZTE4MTAwZTU0ZjM4OTUzNGJhY2ZjMGVmZTZlMzE0ZGNjNjY5Yw==
 SHA512:
   metadata.gz: !binary |-
-    MWNmY2NjNmU5NGJkMzM0ZGViZGNiZTE5MGU4ZTZjYTIxZGYwNGJiNzU3N2Uz
-    YjBjOTlhZmJiYjIyNTk5NTE3NDdhYTE0Mjc5OWQ5YWI5MWEwNDQyM2U4ODQ3
-    MTUzMzJhYWEwN2YwNTBkNjUxZTI5OTcyMDNiYjQ5M2IyOTUzNjQ=
+    NmQ2ZThlMDBjNDA4YmNhOWZlM2JlOWMyMWZlMTYzN2ZlZmMyM2FiMWIzMTAx
+    ODJhMzBhMjNkYzAzZGI5YTZmNWQ3YTRjM2RiYTFhMjRlMDkxNjU4M2NlMGI2
+    ZDExOWJjMjliODdhMTY4NTBjYjUwNGNmNTYyNGYxZmU2MTg5MDc=
   data.tar.gz: !binary |-
-    MzlmOTczZDJkMDNhNWM0ZDdmYzNlNzE5Y2VmOTcwMmI4MTVlMWY0ZjUwMWIw
-    ZTIxYTYwODgyMWJjYThlZjY1Yzg4YjhlNjcwMzI5NjljZmYwZjI4YzljNDgy
-    ZWY4NGI3ZWMzZDc0MzJiYjAwOGYyNmM2NzA0ZDVjZGJkNWQ0ZDY=
+    NTM4MTM3ZmNiYWYyMTE1MGRmMGJhZmQzNjIxNGM2NGI1MzM4NTg4NzM5YWRk
+    MGVkNDg5N2U5ODY1M2IyNzVjYjNmZDYyODMzNGRjMzZlYjcwMzYxZDRkYjI2
+    MjI4MzBkMDA4NDNlMTNmN2IwZjcyNWMyNzFmZDg1MzhhMWVlYWY=

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 3.5.0 (2014-01-24)
+
+* Allow for custom keys to be set for customizing the data returned from calls like `leaders` or `around_me` [#44](https://github.com/agoragames/leaderboard/pull/44)
+
 ## 3.4.0 (2013-11-12)
 
 * Added `score_for_percentile` method to be able to calculate the score for a given percentile value in the leaderboard.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2013 David Czarnecki
+Copyright (c) 2011-2014 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

@@ -2,7 +2,7 @@
 
 Leaderboards backed by [Redis](http://redis.io) in Ruby.
 
-Builds off ideas proposed in http://blog.agoragames.com/2011/01/01/creating-high-score-tables-leaderboards-using-redis/.
+Builds off ideas proposed in http://www.agoragames.com/blog/2011/01/01/creating-high-score-tables-leaderboards-using-redis/.
 
 [![Build Status](https://secure.travis-ci.org/agoragames/leaderboard.png)](http://travis-ci.org/agoragames/leaderboard)
 
@@ -23,8 +23,6 @@ check out the [Redis documentation](http://redis.io/documentation).
 
 The gem has been built and tested under Ruby 1.8.7, Ruby 1.9.2 and Ruby 1.9.3.
 
-The gem is compatible with Redis 2.4.x and Redis 2.6.x.
-
 ## Usage
 
 ### Creating a leaderboard
@@ -42,15 +40,6 @@ Create a new leaderboard or attach to an existing leaderboard named 'highscores'
    => #<Leaderboard:0x0000010307b530 @leaderboard_name="highscores", @page_size=25, @redis_connection=#<Redis client v2.2.2 connected to redis://localhost:6379/0 (Redis v2.2.5)>>
 ```
 
-If you need to pass in options for Redis, you can do this in the initializer:
-
-```ruby
-  redis_options = {:host => 'localhost', :port => 6379, :db => 1}
-   => {:host=>"localhost", :port=>6379, :db=>1}
-  highscore_lb = Leaderboard.new('highscores', Leaderboard::DEFAULT_OPTIONS, redis_options)
-   => #<Leaderboard:0x00000103095200 @leaderboard_name="highscores", @page_size=25, @redis_connection=#<Redis client v2.2.2 connected to redis://localhost:6379/1 (Redis v2.2.5)>>
-```
-
 ### Defining leaderboard options
 
 The `Leaderboard::DEFAULT_OPTIONS` are as follows:
@@ -58,16 +47,28 @@ The `Leaderboard::DEFAULT_OPTIONS` are as follows:
 ```ruby
 DEFAULT_OPTIONS = {
   :page_size => DEFAULT_PAGE_SIZE,
-  :reverse => false
+  :reverse => false,
+  :member_key => :member,
+  :rank_key => :rank,
+  :score_key => :score,
+  :member_data_key => :member_data
 }
 ```
 
 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.
+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`.
+
+If you need to pass in options for Redis, you can do this in the initializer:
+
+```ruby
+  redis_options = {:host => 'localhost', :port => 6379, :db => 1}
+   => {:host=>"localhost", :port=>6379, :db=>1}
+  highscore_lb = Leaderboard.new('highscores', Leaderboard::DEFAULT_OPTIONS, redis_options)
+   => #<Leaderboard:0x00000103095200 @leaderboard_name="highscores", @page_size=25, @redis_connection=#<Redis client v2.2.2 connected to redis://localhost:6379/1 (Redis v2.2.5)>>
+```
 
-You can pass in an existing connection to Redis using `:redis_connection` in the Redis options hash:
+You can pass in an existing connection to Redis using `:redis_connection` in the `redis_options` hash:
 
 ```ruby
   redis = Redis.new
@@ -446,5 +447,5 @@ Unofficially supported (they need some feature parity love):
 
 ## Copyright
 
-Copyright (c) 2011-2013 David Czarnecki. See LICENSE.txt for further details.
+Copyright (c) 2011-2014 David Czarnecki. See LICENSE.txt for further details.
 

data/lib/leaderboard.rb

@@ -10,7 +10,11 @@ class Leaderboard
   # highest-to-lowest order.
   DEFAULT_OPTIONS = {
     :page_size => DEFAULT_PAGE_SIZE,
-    :reverse => false
+    :reverse => false,
+    :member_key => :member,
+    :rank_key => :rank,
+    :score_key => :score,
+    :member_data_key => :member_data
   }
 
   # Default Redis host: localhost
@@ -60,13 +64,20 @@ class Leaderboard
   #   leaderboard = Leaderboard.new('highscores')
   #   leaderboard = Leaderboard.new('highscores', {:page_size => 10})
   def initialize(leaderboard_name, options = DEFAULT_OPTIONS, redis_options = DEFAULT_REDIS_OPTIONS)
+    leaderboard_options = DEFAULT_OPTIONS.dup
+    leaderboard_options.merge!(options)
+
     @leaderboard_name = leaderboard_name
 
-    @reverse   = options[:reverse]
-    @page_size = options[:page_size]
+    @reverse   = leaderboard_options[:reverse]
+    @page_size = leaderboard_options[:page_size]
     if @page_size.nil? || @page_size < 1
       @page_size = DEFAULT_PAGE_SIZE
     end
+    @member_key = leaderboard_options[:member_key]
+    @rank_key = leaderboard_options[:rank_key]
+    @score_key = leaderboard_options[:score_key]
+    @member_data_key = leaderboard_options[:member_data_key]
 
     @redis_connection = redis_options[:redis_connection]
     unless @redis_connection.nil?
@@ -440,7 +451,7 @@ class Leaderboard
     responses[0] = responses[0].to_f if responses[0]
     responses[1] = responses[1] + 1 rescue nil
 
-    {:member => member, :score => responses[0], :rank => responses[1]}
+    {@member_key => member, @score_key => responses[0], @rank_key => responses[1]}
   end
 
   # Remove members from the leaderboard in a given score range.
@@ -912,14 +923,14 @@ class Leaderboard
 
     members.each_with_index do |member, index|
       data = {}
-      data[:member] = member
+      data[@member_key] = member
       unless leaderboard_options[:members_only]
-        data[:rank] = responses[index * 2] + 1 rescue nil
-        data[:score] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
+        data[@rank_key] = responses[index * 2] + 1 rescue nil
+        data[@score_key] = responses[index * 2 + 1].to_f if responses[index * 2 + 1]
       end
 
       if leaderboard_options[:with_member_data]
-        data[:member_data] = member_data_for_in(leaderboard_name, member)
+        data[@member_data_key] = member_data_for_in(leaderboard_name, member)
       end
 
       ranks_for_members << data
@@ -927,9 +938,9 @@ class Leaderboard
 
     case leaderboard_options[:sort_by]
     when :rank
-      ranks_for_members = ranks_for_members.sort_by { |member| member[:rank] }
+      ranks_for_members = ranks_for_members.sort_by { |member| member[@rank_key] }
     when :score
-      ranks_for_members = ranks_for_members.sort_by { |member| member[:score] }
+      ranks_for_members = ranks_for_members.sort_by { |member| member[@score_key] }
     end
 
     ranks_for_members

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '3.4.0'.freeze
+  VERSION = '3.5.0'.freeze
 end

data/spec/leaderboard_spec.rb

@@ -735,4 +735,28 @@ describe 'Leaderboard' do
     @leaderboard.leaders_in('highscores', 1).size.should eql(1)
     @leaderboard.leaders_in('more_highscores', 1).size.should eql(1)
   end
+
+  it 'should allow you to set custom keys for member, score, rank and member_data' do
+    @leaderboard = Leaderboard.new('name',
+      {
+        :member_key => :custom_member_key,
+        :rank_key => :custom_rank_key,
+        :score_key => :custom_score_key,
+        :member_data_key => :custom_member_data_key
+      },
+      {:host => "127.0.0.1", :db => 15})
+
+    rank_members_in_leaderboard(5)
+    leaders = @leaderboard.leaders(1, :with_member_data => true)
+    leaders.each do |leader|
+      leader[:custom_member_key].should_not be_nil
+      leader[:member].should be_nil
+      leader[:custom_score_key].should_not be_nil
+      leader[:score].should be_nil
+      leader[:custom_rank_key].should_not be_nil
+      leader[:rank].should be_nil
+      leader[:custom_member_data_key].should_not be_nil
+      leader[:member_data].should be_nil
+    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
-    Leaderboard::VERSION.should == '3.4.0'
+    Leaderboard::VERSION.should == '3.5.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
+date: 2014-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: leaderboard
-rubygems_version: 2.1.10
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Leaderboards backed by Redis in Ruby