leaderboard 1.0.0 → 1.0.1

data/CHANGELOG.markdown

@@ -0,0 +1,11 @@
+# leaderboard 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
+ * `check_member?(member)`: Check to see whether member is in the leaderboard
+ * `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
+
+ * Initial release

data/Gemfile

@@ -8,5 +8,5 @@ group :development do
   gem "rcov", ">= 0"
 end
 
-gem 'redis'
+gem 'redis', "~> 2.1.1"
 

data/README.rdoc

@@ -12,6 +12,10 @@ Install the gem:
 	
 Make sure your redis server is running! Redis configuration is outside the scope of this README, but 
 check out the Redis documentation, http://redis.io/documentation.
+
+== Compatibility
+
+The gem has been built and tested under Ruby 1.8.7 and Ruby 1.9.2
 	
 == Usage
 
@@ -19,6 +23,18 @@ Create a new leaderboard or attach to an existing leaderboard named 'highscores'
 
   ruby-1.8.7-p302 > highscore_lb = Leaderboard.new('highscores')
    => #<Leaderboard:0x1018e4250 @page_size=25, @port=6379, @host="localhost", @redis_connection=#<Redis client v2.1.1 connected to redis://localhost:6379/0 (Redis v2.1.10)>, @leaderboard_name="highscores"> 
+   
+If you need to pass in options for Redis, you can do this with the redis_options parameter:
+
+  redis_options = {:host => 'localhost', :port => 6379, :password => 'password', :db => 'some_redis_db'}
+  highscore_lb = Leaderboard.new('highscores', redis_options[:host], redis_options[:port], Leaderboard::DEFAULT_PAGE_SIZE, redis_options))
+
+You can set the page size to something other than the default page size (25):
+
+  ruby-1.8.7-p302 > highscore_lb.page_size = 5
+   => 5 
+  ruby-1.8.7-p302 > highscore_lb
+   => #<Leaderboard:0x1018e2130 @leaderboard_name="highscores", @page_size=5, @port=6379, @redis_connection=#<Redis client v2.1.1 connected to redis://localhost:6379/0 (Redis v2.1.10)>, @host="localhost", @redis_options={:host=>"localhost", :port=>6379}>   
   
 Add members to your leaderboard:
 
@@ -66,7 +82,16 @@ Get rank and score for an arbitrary list of members (e.g. friends):
 
   ruby-1.8.7-p302 > highscore_lb.ranked_in_list(['member_1', 'member_62', 'member_67'], true)
    => [{:rank=>55, :member=>"member_1", :score=>1.0}, {:rank=>33, :member=>"member_62", :score=>62.0}, {:rank=>28, :member=>"member_67", :score=>67.0}]   
-   
+
+=== Other useful methods
+
+	remove_member(member): Remove a member from the leaderboard
+	total_members_in_score_range(min_score, max_score): Count the number of members within a score range in the leaderboard
+	change_score_for(member, delta): Change the score for a member by some amount delta (delta could be positive or negative)
+	check_member?(member): Check to see whether member is in the leaderboard
+	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
+      
 == Performance Metrics
 
 10 million sequential scores insert:
@@ -124,6 +149,7 @@ Average time to request an arbitrary page from the leaderboard:
 == Future Ideas
 
 * Bulk insert
+* Atomicity for various operations?
 * Is nil? OK to return if Redis returns no data or should it be []?
   
 == Contributing to leaderboard
@@ -138,6 +164,5 @@ Average time to request an arbitrary page from the leaderboard:
 
 == Copyright
 
-Copyright (c) 2011 David Czarnecki. See LICENSE.txt for
-further details.
+Copyright (c) 2011 David Czarnecki. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/leaderboard.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{leaderboard}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Czarnecki"]
-  s.date = %q{2011-01-05}
+  s.date = %q{2011-02-16}
   s.description = %q{Leaderboards backed by Redis}
   s.email = %q{dczarnecki@agoragames.com}
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rvmrc",
+    "CHANGELOG.markdown",
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",
@@ -46,18 +47,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<redis>, [">= 0"])
+      s.add_runtime_dependency(%q<redis>, ["~> 2.1.1"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
-      s.add_dependency(%q<redis>, [">= 0"])
+      s.add_dependency(%q<redis>, ["~> 2.1.1"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
-    s.add_dependency(%q<redis>, [">= 0"])
+    s.add_dependency(%q<redis>, ["~> 2.1.1"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     s.add_dependency(%q<rcov>, [">= 0"])

data/lib/leaderboard.rb

@@ -1,15 +1,18 @@
 require 'redis'
 
 class Leaderboard
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.1'.freeze
+  
   DEFAULT_PAGE_SIZE = 25
+  DEFAULT_REDIS_HOST = 'localhost'
+  DEFAULT_REDIS_PORT = 6379
   
   attr_reader :host
   attr_reader :port
   attr_reader :leaderboard_name
-  attr_reader :page_size
+  attr_accessor :page_size
   
-  def initialize(leaderboard_name, host = 'localhost', port = 6379, page_size = DEFAULT_PAGE_SIZE)
+  def initialize(leaderboard_name, host = DEFAULT_REDIS_HOST, port = DEFAULT_REDIS_PORT, page_size = DEFAULT_PAGE_SIZE, redis_options = {})
     @leaderboard_name = leaderboard_name
     @host = host
     @port = port
@@ -20,7 +23,13 @@ class Leaderboard
     
     @page_size = page_size
     
-    @redis_connection = Redis.new(:host => @host, :port => @port)
+    redis_options = redis_options.dup
+    redis_options[:host] ||= @host
+    redis_options[:port] ||= @port
+    
+    @redis_options = redis_options
+    
+    @redis_connection = Redis.new(@redis_options)
   end
       
   def add_member(member, score)
@@ -58,7 +67,19 @@ class Leaderboard
   def score_for(member)
     @redis_connection.zscore(@leaderboard_name, member).to_f
   end
-
+  
+  def check_member?(member)
+    !@redis_connection.zscore(@leaderboard_name, member).nil?
+  end
+  
+  def score_and_rank_for(member, use_zero_index_for_rank = false)
+    {:member => member, :score => score_for(member), :rank => rank_for(member, use_zero_index_for_rank)}    
+  end
+  
+  def remove_members_in_score_range(min_score, max_score)
+    @redis_connection.zremrangebyscore(@leaderboard_name, min_score, max_score)
+  end
+  
   def leaders(current_page, with_scores = true, with_rank = true, use_zero_index_for_rank = false)
     if current_page < 1
       current_page = 1
@@ -129,7 +150,7 @@ class Leaderboard
       if member_attribute
         data[:member] = leader_data_item
       else
-        data[:score] = leader_data_item
+        data[:score] = leader_data_item.to_f
         data[:rank] = rank_for(data[:member], use_zero_index_for_rank) if with_rank
         leader_data << data
         data = {}     

data/test/test_leaderboard.rb

@@ -11,7 +11,7 @@ class TestLeaderboard < Test::Unit::TestCase
   end
   
   def test_version
-    assert_equal '1.0.0', Leaderboard::VERSION
+    assert_equal '1.0.1', Leaderboard::VERSION
   end
   
   def test_initialize_with_defaults  
@@ -159,6 +159,51 @@ class TestLeaderboard < Test::Unit::TestCase
     assert_equal 5, @leaderboard.score_for('member_1')
   end
   
+  def test_check_member
+    @leaderboard.add_member('member_1', 10)
+    
+    assert_equal true, @leaderboard.check_member?('member_1')
+    assert_equal false, @leaderboard.check_member?('member_2')
+  end
+  
+  def test_can_change_page_size_and_have_it_reflected_in_size_of_result_set
+    add_members_to_leaderboard(Leaderboard::DEFAULT_PAGE_SIZE)
+    
+    @leaderboard.page_size = 5
+    assert_equal 5, @leaderboard.total_pages
+    assert_equal 5, @leaderboard.leaders(1).size
+  end
+  
+  def test_score_and_rank_for
+    add_members_to_leaderboard
+    
+    data = @leaderboard.score_and_rank_for('member_1')
+    assert_equal 'member_1', data[:member]
+    assert_equal 1, data[:score]
+    assert_equal 5, data[:rank]
+  end
+  
+  def test_remove_members_in_score_range
+    add_members_to_leaderboard
+    
+    assert_equal 5, @leaderboard.total_members
+    
+    @leaderboard.add_member('cheater_1', 100)
+    @leaderboard.add_member('cheater_2', 101)
+    @leaderboard.add_member('cheater_3', 102)
+
+    assert_equal 8, @leaderboard.total_members
+
+    @leaderboard.remove_members_in_score_range(100, 102)
+    
+    assert_equal 5, @leaderboard.total_members
+    
+    leaders = @leaderboard.leaders(1)
+    leaders.each do |leader|
+      assert leader[:score] < 100
+    end
+  end
+  
   private
   
   def add_members_to_leaderboard(members_to_add = 5)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: leaderboard
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - David Czarnecki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-05 00:00:00 -05:00
+date: 2011-02-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,12 +25,14 @@ dependencies:
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 9
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
   requirement: *id001
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -90,6 +92,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .rvmrc
+- CHANGELOG.markdown
 - Gemfile
 - LICENSE.txt
 - README.rdoc