leaderboard 3.1.0 → 3.2.0

data/CHANGELOG.markdown

@@ -1,84 +1,92 @@
 # CHANGELOG
 
-## leaderboard 3.0.2 (2013-02-22)
+## 3.2.0 (2013-05-31)
+
+* Added `remove_members_outside_rank` method to remove members from the leaderboard outside a given rank.
+
+## 3.1.0 (2013-05-15)
+
+* Added `:members_only` option for various leaderboard requests.
+
+## 3.0.2 (2013-02-22)
 
 * Fixed a data leak in `expire_leaderboard` and `expire_leaderboard_at` to also set expiration on the member data hash.
 
-## leaderboard 3.0.1 (2012-12-19)
+## 3.0.1 (2012-12-19)
 
 * Fixed a bug in `remove_member` that would remove all of the optional member data.
 
-## leaderboard 3.0.0 (2012-12-03)
+## 3.0.0 (2012-12-03)
 
-* Added `rank_member_if` and `rank_member_if_in` methods that allow you to rank a member in the leaderboard based on execution of a lambda. 
+* Added `rank_member_if` and `rank_member_if_in` methods that allow you to rank a member in the leaderboard based on execution of a lambda.
 
-## leaderboard 3.0.0.rc2 (2012-11-27)
+## 3.0.0.rc2 (2012-11-27)
 
 * No longer cast scores to a floating point automatically. If requesting a score for an unknown member in the leaderboard, return `nil`. Under the old behavior, a `nil` score gets returned as 0.0. This is misleading as 0.0 is a valid score.
 
-## leaderboard 3.0.0.rc1 (2012-11-08)
+## 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)
+## 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.
 
-## leaderboard 2.4.0 (2012-07-30)
+## 2.4.0 (2012-07-30)
 
 * Added `all_leaders` and `all_leaders_from` methods to retrieve all members from a leaderboard. You may also use the aliases `all_members` or `all_members_from`.
 
-## leaderboard 2.3.0 (2012-07-09)
+## 2.3.0 (2012-07-09)
 
 * Added `expire_leaderboard(seconds)` to expire the leaderboard in a set number of seconds.
 * Added `expire_leaderboard_at(timestamp)` to expire the leaderboard at a specific UNIX timestamp.
 * Added optional `page_size` parameter to the `total_pages` method.
 
-## leaderboard 2.2.1 (2012-06-18)
+## 2.2.1 (2012-06-18)
 
 * Fix for #17 - Leaderboard not compatible with redis 2.1.1. Redis' `zrangebyscore` and `zrevrangebyscore` methods do not return scores by default. No need to pass the option in the initial call.
 
-## leaderboard 2.2.0 (2012-06-18)
+## 2.2.0 (2012-06-18)
 
 * Added `members_from_score_range` and `members_from_score_range_in` methods. These will retrieve members from the leaderboard that fall within a given score range.
 * Add `member_at` and `member_at_in` methods. These will retrieve a given member from the leaderboard at the specified position.
 * `members` and `members_in` are now aliases for the `leaders` and `leaders_in` methods.
 
-## leaderboard 2.1.0 (2012-06-11)
+## 2.1.0 (2012-06-11)
 
 * Added ability to store optional member data alongside the leaderboard data.
 * `:with_member_data` is now a valid request option when retrieving leader data.
 
-## leaderboard 2.0.6 (2012-04-26)
+## 2.0.6 (2012-04-26)
 
 * Added accessor for `reverse` option so that you can set reverse after creating a leaderboard to see results in either highest-to-lowest or lowest-to-highest order.
 
-## leaderboard 2.0.5 (2012-03-14)
+## 2.0.5 (2012-03-14)
 
 * Added `rank_members(members_and_scores)` and `rank_members_in(leaderboard_name, members_and_scores)` allowing you to pass in some variable number of `member_name, score` and so on or an actual array of those data items. Use this method to do bulk insert of data, but be mindful of the amount of data you are inserting since a single transaction can get quite large.
 
-## leaderboard 2.0.4 (2012-02-29)
+## 2.0.4 (2012-02-29)
 
  * Added `page_for(member, page_size = DEFAULT_PAGE_SIZE)` and `page_for_in(leaderboard_name, member, page_size = DEFAULT_PAGE_SIZE)` calls to allow you to determine the page where a member falls in the leaderboard
 
-## leaderboard 2.0.3 (2012-02-22)
+## 2.0.3 (2012-02-22)
 
  * Added `:reverse => false` to `Leaderboard::DEFAULT_OPTIONS` to support leaderboards sorted from lowest to highest score instead of highest to lowest score. (Thanks @siuying)
 
-## leaderboard 2.0.2 (2012-02-03)
+## 2.0.2 (2012-02-03)
 
  * Fix for checking to see if a member actually exists in the leaderboard for the `around_me` calls
  * Return appropriate `nil` in data returned for calls such as `percentile_for` and `ranked_in_list` for non-existent members
 
-## leaderboard 2.0.1 (2011-11-07)
+## 2.0.1 (2011-11-07)
 
  * Allow for only single options to be passed to `leaders`, `around_me` and `ranked_in_list` methods - https://github.com/agoragames/leaderboard/issues/4
  * Added `percentile_for(member)` and `percentile_for_in(leaderboard_name, member)` methods to calculate percentile for a given member
 
-## leaderboard 2.0.0 (2011-08-05)
+## 2.0.0 (2011-08-05)
 
  * Change `add_member` to `rank_member` - https://github.com/agoragames/leaderboard/issues/3
  * Added `delete_leaderboard` and `delete_leaderboard_named` - https://github.com/agoragames/leaderboard/issues/2
@@ -87,33 +95,33 @@
  * Updated initializer to take a leaderboard name, `options` hash and `redis_options` hash
  * Simplified `leaders`, `around_me` and `ranked_in_list` to use an `options` hash with defaults for the previously individual parameters
 
-## leaderboard 1.0.6 (unreleased)
+## 1.0.6 (unreleased)
 
  * Added `disconnect` method
  * Check for invalid page size when changing
 
-## leaderboard 1.0.5 (2011-05-04)
+## 1.0.5 (2011-05-04)
 
  * Updated Rakefile to run tests under ruby 1.8.7 and ruby 1.9.2
  * Added `page_size` parameter to `total_pages_in` to allow for checking what if values in that scenario
  * Added `page_size` parameter to `leaders` and `around_me` calls
 
-## leaderboard 1.0.4 (2011-04-26)
+## 1.0.4 (2011-04-26)
 
  * Minor bug fix
 
-## leaderboard 1.0.3 (2011-04-26)
+## 1.0.3 (2011-04-26)
 
  * Fixing issue using total_pages in leaderboard_in call
  * Internal `massage_leader_data` method will now respect `with_scores`
 
-## leaderboard 1.0.2 (2011-02-25)
+## 1.0.2 (2011-02-25)
 
  * Adding `XXX_to`, `XXX_for`, `XXX_in` and `XXX_from` methods that will allow you to set the leaderboard name to interact with outside of creating a new object
  * Added `merge_leaderboards(destination, keys, options = {:aggregate => :min})` method to merge leaderboards given by keys with this leaderboard into destination
  * Added `intersect_leaderboards(destination, keys, options = {:aggregate => :min})` method to intersect leaderboards given by keys with this leaderboard into destination
 
-## leaderboard 1.0.1 (2011-02-16)
+## 1.0.1 (2011-02-16)
 
  * `redis_options` can be passed in the initializer to pass options for the connection to Redis
  * `page_size` is now settable outside of the initializer
@@ -121,6 +129,6 @@
  * `score_and_rank_for(member, use_zero_index_for_rank = false)`: Retrieve the score and rank for a member in a single call
  * `remove_members_in_score_range(min_score, max_score)`: Remove members from the leaderboard within a score range
 
-## leaderboard 1.0.0
+## 1.0.0
 
  * Initial release

data/README.markdown

@@ -151,9 +151,9 @@ If you delete the leaderboard, ALL of the member data is deleted as well.
 
 #### Optional member data notes
 
-If you use optional member data, the use of the `remove_members_in_score_range` will leave data around in the member data
-hash. This is because the internal Redis method, `zremrangebyscore`, only returns the number of items removed. It does
-not return the members that it removed.
+If you use optional member data, the use of the `remove_members_in_score_range` or `remove_members_outside_rank` methods
+will leave data around in the member data hash. This is because the internal Redis method, `zremrangebyscore`,
+only returns the number of items removed. It does not return the members that it removed.
 
 Get some information about a specific member(s) in the leaderboard:
 
@@ -311,6 +311,7 @@ Use this method to do bulk insert of data, but be mindful of the amount of data
   check_member?(member): Check to see whether member is in the leaderboard
   score_and_rank_for(member): Retrieve the score and rank for a member in a single call
   remove_members_in_score_range(min_score, max_score): Remove members from the leaderboard within a score range
+  remove_members_outside_rank(rank): Remove members from the leaderboard outside a given rank
   percentile_for(member): Calculate the percentile for a given member
   page_for(member, page_size): Determine the page where a member falls in the leaderboard
   expire_leaderboard(seconds): Expire the leaderboard in a set number of seconds.
@@ -412,12 +413,13 @@ end
 
 ## Ports
 
-The following ports have been made of the leaderboard gem.
+The following ports have been made of the [leaderboard gem](https://github.com/agoragames/leaderboard).
 
 Officially supported:
 
 * CoffeeScript: https://github.com/agoragames/leaderboard-coffeescript
 * Python: https://github.com/agoragames/leaderboard-python
+* Ruby: https://github.com/agoragames/leaderboard
 
 Unofficially supported (they need some feature parity love):
 

data/lib/leaderboard.rb

@@ -445,6 +445,27 @@ class Leaderboard
     @redis_connection.zremrangebyscore(leaderboard_name, min_score, max_score)
   end
 
+  # Remove members from the leaderboard outside a given rank.
+  #
+  # @param rank [int] The rank (inclusive) which we should keep.
+  # @return the total number of members removed.
+  def remove_members_outside_rank(rank)
+    remove_members_outside_rank_in(@leaderboard_name, rank)
+  end
+
+  # Remove members from the leaderboard outside a given rank.
+  #
+  # @param leaderboard_name [String] Name of the leaderboard.
+  # @param rank [int] The rank (inclusive) which we should keep.
+  # @return the total number of members removed.
+  def remove_members_outside_rank_in(leaderboard_name, rank)
+    if @reverse
+      @redis_connection.zremrangebyrank(leaderboard_name, rank, -1)
+    else
+      @redis_connection.zremrangebyrank(leaderboard_name, 0, -(rank) - 1)
+    end
+  end
+
   # Retrieve the percentile for a member in the leaderboard.
   #
   # @param member [String] Member name.

data/lib/leaderboard/version.rb

@@ -1,3 +1,3 @@
 class Leaderboard
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
 end

data/spec/leaderboard_spec.rb

@@ -358,6 +358,18 @@ describe 'Leaderboard' do
     end
   end
 
+  it 'should allow you to remove members outside a given rank' do
+    rank_members_in_leaderboard
+
+    @leaderboard.total_members.should be(5)
+    @leaderboard.remove_members_outside_rank(3).should be(2)
+
+    leaders = @leaderboard.leaders(1)
+    leaders.size.should be(3)
+    leaders[0][:member].should == 'member_5'
+    leaders[2][:member].should == 'member_3'
+  end
+
   it 'should allow you to merge leaderboards' do
     foo = Leaderboard.new('foo', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
     bar = Leaderboard.new('bar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)

data/spec/reverse_leaderboard_spec.rb

@@ -173,6 +173,18 @@ describe 'Leaderboard (reverse option)' do
     end
   end
 
+  it 'should allow you to remove members outside a given rank' do
+    rank_members_in_leaderboard
+
+    @leaderboard.total_members.should be(5)
+    @leaderboard.remove_members_outside_rank(3).should be(2)
+
+    leaders = @leaderboard.leaders(1)
+    leaders.size.should be(3)
+    leaders[0][:member].should == 'member_1'
+    leaders[2][:member].should == 'member_3'
+  end
+
   it 'should allow you to merge leaderboards' do
     foo = Leaderboard.new('foo', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
     bar = Leaderboard.new('bar', Leaderboard::DEFAULT_LEADERBOARD_REQUEST_OPTIONS, :host => "127.0.0.1", :db => 15)
@@ -299,7 +311,7 @@ describe 'Leaderboard (reverse option)' do
     members = @leaderboard.members_from_rank_range(5, 9)
     members.size.should be(5)
     members[0][:member].should eql('member_5')
-    members[0][:score].to_i.should be(5)    
+    members[0][:score].to_i.should be(5)
     members[4][:member].should eql('member_9')
 
     members = @leaderboard.members_from_rank_range(1, 1)
@@ -309,7 +321,7 @@ describe 'Leaderboard (reverse option)' do
     members = @leaderboard.members_from_rank_range(-1, 26)
     members.size.should be(25)
     members[0][:member].should eql('member_1')
-    members[0][:score].to_i.should be(1)    
+    members[0][:score].to_i.should be(1)
     members[24][:member].should eql('member_25')
   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.1.0'
+    Leaderboard::VERSION.should == '3.2.0'
   end
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: leaderboard
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
+  prerelease: 
 platform: ruby
 authors:
 - David Czarnecki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,26 +85,33 @@ files:
 - spec/version_spec.rb
 homepage: https://github.com/agoragames/leaderboard
 licenses: []
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3549560815015692578
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3549560815015692578
 requirements: []
 rubyforge_project: leaderboard
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Leaderboards backed by Redis in Ruby
 test_files:
 - spec/leaderboard_spec.rb

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjI2NWFlODMyNTM3NWMzZmM4YzUwMzljMWJkMDQ2MmVhMjVlNjQ1ZQ==
-  data.tar.gz: !binary |-
-    ZDNhMmYzZjU5MGJjYjU3YTIzMWI0NWJhZDNhNDAwNmRjYzFmMjAyOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    YTk2YTBhNzZhZGUyODgwYzAwYTgzNDAyOTYwYTQzYjVhODdmZGJiZmEwMzc1
-    YzdiODM3MTA2NGI1M2I2NjhjZmVmN2RlMDVlMzBjYmUxMGU1YjkyYjU4ODQy
-    NTRmMWM5NzM3NTE1MDYzYjc1ZjkyNDU1MjA3MDE1NTc0Nzk1ZWU=
-  data.tar.gz: !binary |-
-    MmIwMTc1ZGVjZmE0N2U4NjRjNGM2OGY3M2ZlZTQ4YTM5ZTQ0ZWI3MDRkNzA4
-    MjhjNDhkMWFiMDhiYTExOTdhMDFjNGU2YWEyNTI2MDVhNzA5YmEwYjA1Nzg3
-    NDljMDM5ZWNmZjY3ZDI5NzVlY2VmZGIxZDczMmJlMTAxZjgxOGI=