leaderboard 2.3.0 → 2.4.0

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## leaderboard 2.4.0 (2012-07-30)
+
+* Added `all_leaders` and `all_leaders_from` methods to retreive all members from a leaderboard. You may also use the aliases `all_members` or `all_members_from`.
+
 ## leaderboard 2.3.0 (2012-07-09)
 
 * Added `expire_leaderboard(seconds)` to expire the leaderboard in a set number of seconds.

data/README.markdown

@@ -176,6 +176,9 @@ Below is an example of retrieving the first page in the leaderboard without scor
 
 You can also use the `members` and `members_in` methods as aliases for the `leaders` and `leaders_in` methods.
 
+There are also a few convenience methods to be able to retrieve all leaders from a given leaderboard. They are `all_leaders` and `all_leaders_from`. You 
+may also use the aliases `all_members` or `all_members_from`. Use any of these methods sparingly as all the information in the leaderboard will be returned. 
+
 Add more members to your leaderboard:
 
 ```ruby

data/lib/leaderboard.rb

@@ -576,6 +576,42 @@ class Leaderboard
 
   alias_method :members_in, :leaders_in
 
+  # Retrieve all leaders from the leaderboard.
+  #
+  # @param options [Hash] Options to be used when retrieving the leaders from the leaderboard.
+  #
+  # @return the leaders from the leaderboard.
+  def all_leaders(options = {})
+    all_leaders_from(@leaderboard_name, options)
+  end
+
+  alias_method :all_members, :all_leaders
+
+  # Retrieves all leaders from the named leaderboard.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param options [Hash] Options to be used when retrieving the leaders from the named leaderboard.
+  #
+  # @return the named leaderboard.
+  def all_leaders_from(leaderboard_name, options = {})
+    leaderboard_options = DEFAULT_LEADERBOARD_REQUEST_OPTIONS.dup
+    leaderboard_options.merge!(options)
+
+    if @reverse
+      raw_leader_data = @redis_connection.zrange(leaderboard_name, 0, -1, :with_scores => false)
+    else
+      raw_leader_data = @redis_connection.zrevrange(leaderboard_name, 0, -1, :with_scores => false)
+    end
+
+    if raw_leader_data
+      return ranked_in_list_in(leaderboard_name, raw_leader_data, leaderboard_options)
+    else
+      return []
+    end
+  end
+
+  alias_method :all_members_from, :all_leaders_from
+
   # Retrieve members from the leaderboard within a given score range.
   #
   # @param minimum_score [float] Minimum score (inclusive).

data/lib/leaderboard/version.rb

@@ -1,4 +1,4 @@
 class Leaderboard
   # Leaderboard version
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

data/spec/leaderboard_spec.rb

@@ -141,6 +141,22 @@ describe 'Leaderboard' do
     leaders.size.should be(1)
   end
 
+  %w(members leaders).each do |method|
+    it "should return the entire leaderboard when you call 'all_#{method}'" do
+      rank_members_in_leaderboard(27)
+
+      @leaderboard.total_members.should be(27)
+
+      members = @leaderboard.send("all_#{method}")
+
+      members.size.should be(27)
+      members[0][:member].should == 'member_27'
+      members[-2][:member].should == 'member_2'
+      members[-1][:member].should == 'member_1'
+      members[-1][:score].to_i.should be(1)
+    end
+  end
+
   it 'should allow you to retrieve members in a given score range' do
     rank_members_in_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
 

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.3.0'
+    Leaderboard::VERSION.should == '2.4.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-09 00:00:00.000000000 Z
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -97,7 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -401137284638736499
+      hash: -2580404106533235495
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -401137284638736499
+      hash: -2580404106533235495
 requirements: []
 rubyforge_project: leaderboard
 rubygems_version: 1.8.23