streak 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -1,10 +1,15 @@
 # CHANGELOG
 
+## 0.2.0 (2012-07-02)
+
+* You can now pass a custom set of keys to be used in the `aggregate` call if you want to
+use a different set of positive/negative things than what is setup in the configuration.
+
 ## 0.1.0
 
 * Key-space is now separated by a single `:` instead of `::`
 
-## 0.0.2 
+## 0.0.2
 
 * Fix +total_key+ configuration.
 

data/README.md

@@ -46,14 +46,48 @@ Streak.aggregate('david', 5) # 5 wins
 Streak.aggregate('david', -1) # 1 loss
 
 Streak.statistics('david')
- => {:wins=>0, :wins_total=>8, :wins_streak=>5, :losses=>1, :losses_total=>3, :losses_streak=>2, :total=>11} 
+ => {:wins=>0, :wins_total=>8, :wins_streak=>5, :losses=>1, :losses_total=>3, :losses_streak=>2, :total=>11}
 
 Streak.statistics('david', [Streak.positive_streak_key, Streak.negative_streak_key])
  => {:wins_streak=>5, :losses_streak=>2}
 
 Streak.reset_statistics('david')
 Streak.statistics('david')
- => {:wins=>0, :wins_total=>0, :wins_streak=>0, :losses=>0, :losses_total=>0, :losses_streak=>0, :total=>0} 
+ => {:wins=>0, :wins_total=>0, :wins_streak=>0, :losses=>0, :losses_total=>0, :losses_streak=>0, :total=>0}
+```
+
+You can also pass a custom set of keys to be used in the `aggregate` call if you want to
+use a different set of positive/negative things than what is setup in the configuration.
+Below is a complete example:
+
+```ruby
+custom_keys = {
+  :positive_key => 'kills',
+  :positive_total_key => 'kills_total',
+  :positive_streak_key => 'kills_streak',
+  :negative_key => 'deaths',
+  :negative_total_key => 'deaths_total',
+  :negative_streak_key => 'deaths_streak',
+  :total_key => 'kills_deaths_total'
+}
+
+Streak.aggregate('david', 1, custom_keys)
+Streak.aggregate('david', -7, custom_keys)
+Streak.aggregate('david', 6, custom_keys)
+Streak.aggregate('david', -3, custom_keys)
+
+Streak.aggregate('david', 3)
+Streak.aggregate('david', -2)
+Streak.aggregate('david', 5)
+Streak.aggregate('david', -1)
+
+Streak.statistics('david')
+ => {:wins=>0, :wins_total=>8, :wins_streak=>5, :losses=>1, :losses_total=>3, :losses_streak=>2, :total=>11}
+Streak.statistics('david', custom_keys.values)
+ => {:kills=>0, :kills_total=>7, :kills_streak=>6, :deaths=>3, :deaths_total=>10, :deaths_streak=>7, :kills_deaths_total=>17}
+
+Streak.reset_statistics('david')
+Streak.reset_statistics('david', custom_keys.values)
 ```
 
 ## Contributing

data/lib/streak/collector.rb

@@ -1,58 +1,59 @@
 module Streak
   module Collector
-    # Aggregate streaks for a given +id+. If +count+ is greater than 0, it will increment +Streak.positive_key+ and 
-    # +Streak.positive_total_key+ by the absolute value of count. It will zero out +Streak.negative_key+. Finally, it 
-    # will add the absolute value of count to +Streak.total_key+. If the current positive streak is greater than 
-    # the value of +Streak.positive_streak_key+, its value will be replaced. 
-    # If +count+ is less than than 0, it will increment +Streak.negative_key+ and 
-    # +Streak.negative_total_key+ by the absolute value of count. It will zero out +Streak.positive_key+. Finally, it 
-    # will add the absolute value of count to +Streak.total_key+. If the current negative streak is greater than 
+    # Aggregate streaks for a given +id+. If +count+ is greater than 0, it will increment +Streak.positive_key+ and
+    # +Streak.positive_total_key+ by the absolute value of count. It will zero out +Streak.negative_key+. Finally, it
+    # will add the absolute value of count to +Streak.total_key+. If the current positive streak is greater than
+    # the value of +Streak.positive_streak_key+, its value will be replaced.
+    # If +count+ is less than than 0, it will increment +Streak.negative_key+ and
+    # +Streak.negative_total_key+ by the absolute value of count. It will zero out +Streak.positive_key+. Finally, it
+    # will add the absolute value of count to +Streak.total_key+. If the current negative streak is greater than
     # the value of +Streak.negative_streak_key+, its value will be replaced.
     #
     # @param id [String] ID of the item being monitored for a streak.
     # @param count [Integer] Streak count, which can be positive or negative.
-    def aggregate(id, count)
+    # @param keys [Hash] Keys to be used for aggregating streaks.
+    def aggregate(id, count, keys = keys_for_aggregate)
       if count >= 0
         previous_data = Streak.redis.multi do |transaction|
-          transaction.get("#{Streak.namespace}:#{Streak.positive_key}:#{id}")
-          transaction.get("#{Streak.namespace}:#{Streak.positive_streak_key}:#{id}")
+          transaction.get("#{Streak.namespace}:#{keys[:positive_key]}:#{id}")
+          transaction.get("#{Streak.namespace}:#{keys[:positive_streak_key]}:#{id}")
         end
 
         previous_wins = previous_data[0].to_i
         previous_streak = previous_data[1].to_i
 
         Streak.redis.multi do |transaction|
-          transaction.set("#{Streak.namespace}:#{Streak.positive_streak_key}:#{id}", [previous_wins + count, previous_streak].max)
-          transaction.incrby("#{Streak.namespace}:#{Streak.positive_key}:#{id}", count.abs)
-          transaction.incrby("#{Streak.namespace}:#{Streak.positive_total_key}:#{id}", count.abs)
-          transaction.set("#{Streak.namespace}:#{Streak.negative_key}:#{id}", 0)
-          transaction.incrby("#{Streak.namespace}:#{Streak.total_key}:#{id}", count.abs)
+          transaction.set("#{Streak.namespace}:#{keys[:positive_streak_key]}:#{id}", [previous_wins + count, previous_streak].max)
+          transaction.incrby("#{Streak.namespace}:#{keys[:positive_key]}:#{id}", count.abs)
+          transaction.incrby("#{Streak.namespace}:#{keys[:positive_total_key]}:#{id}", count.abs)
+          transaction.set("#{Streak.namespace}:#{keys[:negative_key]}:#{id}", 0)
+          transaction.incrby("#{Streak.namespace}:#{keys[:total_key]}:#{id}", count.abs)
         end
       else
         previous_data = Streak.redis.multi do |transaction|
-          transaction.get("#{Streak.namespace}:#{Streak.negative_key}:#{id}")
-          transaction.get("#{Streak.namespace}:#{Streak.negative_streak_key}:#{id}")
+          transaction.get("#{Streak.namespace}:#{keys[:negative_key]}:#{id}")
+          transaction.get("#{Streak.namespace}:#{keys[:negative_streak_key]}:#{id}")
         end
 
         previous_losses = previous_data[0].to_i
         previous_streak = previous_data[1].to_i
 
         Streak.redis.multi do |transaction|
-          transaction.set("#{Streak.namespace}:#{Streak.negative_streak_key}:#{id}", [previous_losses + count.abs, previous_streak].max)
-          transaction.incrby("#{Streak.namespace}:#{Streak.negative_key}:#{id}", count.abs)
-          transaction.incrby("#{Streak.namespace}:#{Streak.negative_total_key}:#{id}", count.abs)
-          transaction.set("#{Streak.namespace}:#{Streak.positive_key}:#{id}", 0)
-          transaction.incrby("#{Streak.namespace}:#{Streak.total_key}:#{id}", count.abs)
+          transaction.set("#{Streak.namespace}:#{keys[:negative_streak_key]}:#{id}", [previous_losses + count.abs, previous_streak].max)
+          transaction.incrby("#{Streak.namespace}:#{keys[:negative_key]}:#{id}", count.abs)
+          transaction.incrby("#{Streak.namespace}:#{keys[:negative_total_key]}:#{id}", count.abs)
+          transaction.set("#{Streak.namespace}:#{keys[:positive_key]}:#{id}", 0)
+          transaction.incrby("#{Streak.namespace}:#{keys[:total_key]}:#{id}", count.abs)
         end
       end
     end
 
-    # Retrieve all (or some) of the streak statistics collected. By default, without a second parameter, this 
-    # method will return a +Hash+ of: +Streak.positive_key+, +Streak.positive_total_key+, +Streak.positive_streak_key+, 
+    # Retrieve all (or some) of the streak statistics collected. By default, without a second parameter, this
+    # method will return a +Hash+ of: +Streak.positive_key+, +Streak.positive_total_key+, +Streak.positive_streak_key+,
     # +Streak.negative_key+, +Streak.negative_total_key+, +Streak.negative_streak_key+, and +Streak.total_key+ with
     # their corresponding values. If you want a subset of that list, pass in an array with the keys you want
     # returned.
-    # 
+    #
     # @param id [String] ID.
     # @param keys [Array, optional]. Optional list of streak statistic keys to be retrieved.
     #
@@ -71,12 +72,27 @@ module Streak
     # Reset all the statistics for a given +id+ to 0.
     #
     # @param id [String] ID.
-    def reset_statistics(id)
+    # @param keys [Array] List of keys to zero-out.
+    def reset_statistics(id, keys = [Streak.positive_key, Streak.positive_total_key, Streak.positive_streak_key, Streak.negative_key, Streak.negative_total_key, Streak.negative_streak_key, Streak.total_key])
       Streak.redis.multi do |transaction|
-        [Streak.positive_key, Streak.positive_total_key, Streak.positive_streak_key, Streak.negative_key, Streak.negative_total_key, Streak.negative_streak_key, Streak.total_key].each do |key|
+        keys.each do |key|
           transaction.set("#{Streak.namespace}:#{key}:#{id}", 0)
         end
       end
     end
+
+    private
+
+    def keys_for_aggregate
+      {
+        :positive_key => Streak.positive_key,
+        :positive_total_key => Streak.positive_total_key,
+        :positive_streak_key => Streak.positive_streak_key,
+        :negative_key => Streak.negative_key,
+        :negative_total_key => Streak.negative_total_key,
+        :negative_streak_key => Streak.negative_streak_key,
+        :total_key => Streak.total_key
+      }
+    end
   end
 end

data/lib/streak/version.rb

@@ -1,3 +1,3 @@
 module Streak
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/streak/collector_spec.rb

@@ -29,7 +29,7 @@ describe Streak::Collector do
       streak_value_for(Streak.negative_key, 'david').should == 0
       streak_value_for(Streak.negative_streak_key, 'david').should == 1
       streak_value_for(Streak.total_key, 'david').should == 6
-    end    
+    end
   end
 
   describe '#statistics' do
@@ -64,6 +64,50 @@ describe Streak::Collector do
       Streak.reset_statistics('david')
 
       Streak.statistics('david').should == {:wins => 0, :wins_total => 0, :wins_streak => 0, :losses => 0, :losses_total => 0, :losses_streak => 0, :total => 0}
+
+      Streak.aggregate('david', 3)
+      Streak.aggregate('david', -2)
+      Streak.aggregate('david', 5)
+      Streak.aggregate('david', -1)
+
+      Streak.statistics('david').should == {:wins => 0, :wins_total => 8, :wins_streak => 5, :losses => 1, :losses_total => 3, :losses_streak => 2, :total => 11}
+
+      Streak.reset_statistics('david', [Streak.positive_key, Streak.positive_total_key, Streak.positive_streak_key, Streak.negative_key, Streak.negative_total_key, Streak.negative_streak_key, Streak.total_key])
+
+      Streak.statistics('david').should == {:wins => 0, :wins_total => 0, :wins_streak => 0, :losses => 0, :losses_total => 0, :losses_streak => 0, :total => 0}
+    end
+  end
+
+  describe 'custom keys in #aggregate, #statistics and #reset_statistics' do
+    it 'should allow you to use custom keys different from the configured keys' do
+      custom_keys = {
+        :positive_key => 'kills',
+        :positive_total_key => 'kills_total',
+        :positive_streak_key => 'kills_streak',
+        :negative_key => 'deaths',
+        :negative_total_key => 'deaths_total',
+        :negative_streak_key => 'deaths_streak',
+        :total_key => 'kills_deaths_total'
+      }
+
+      Streak.aggregate('david', 1, custom_keys)
+      Streak.aggregate('david', -7, custom_keys)
+      Streak.aggregate('david', 6, custom_keys)
+      Streak.aggregate('david', -3, custom_keys)
+
+      Streak.aggregate('david', 3)
+      Streak.aggregate('david', -2)
+      Streak.aggregate('david', 5)
+      Streak.aggregate('david', -1)
+
+      Streak.statistics('david').should == {:wins => 0, :wins_total => 8, :wins_streak => 5, :losses => 1, :losses_total => 3, :losses_streak => 2, :total => 11}
+      Streak.statistics('david', custom_keys.values).should == {:kills => 0, :kills_total => 7, :kills_streak => 6, :deaths => 3, :deaths_total => 10, :deaths_streak => 7, :kills_deaths_total => 17}
+
+      Streak.reset_statistics('david')
+      Streak.statistics('david').should == {:wins => 0, :wins_total => 0, :wins_streak => 0, :losses => 0, :losses_total => 0, :losses_streak => 0, :total => 0}
+      Streak.statistics('david', custom_keys.values).should == {:kills => 0, :kills_total => 7, :kills_streak => 6, :deaths => 3, :deaths_total => 10, :deaths_streak => 7, :kills_deaths_total => 17}
+      Streak.reset_statistics('david', custom_keys.values)
+      Streak.statistics('david', custom_keys.values).should == {:kills => 0, :kills_total => 0, :kills_streak => 0, :deaths => 0, :deaths_total => 0, :deaths_streak => 0, :kills_deaths_total => 0}
     end
   end
 end

data/spec/streak/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Streak::VERSION' do
+  it 'should be the correct version' do
+    Streak::VERSION.should == '0.2.0'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: streak
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-18 00:00:00.000000000 Z
+date: 2012-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70352190361800 !ruby/object:Gem::Requirement
+  requirement: &70182212219520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70352190361800
+  version_requirements: *70182212219520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70352190361340 !ruby/object:Gem::Requirement
+  requirement: &70182212218380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70352190361340
+  version_requirements: *70182212218380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70352190360860 !ruby/object:Gem::Requirement
+  requirement: &70182212217580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70352190360860
+  version_requirements: *70182212217580
 description: Streak is a gem for calculating win/loss streaks
 email:
 - me@davidczarnecki.com
@@ -66,6 +66,7 @@ files:
 - spec/spec_helper.rb
 - spec/streak/collector_spec.rb
 - spec/streak/configuration_spec.rb
+- spec/streak/version_spec.rb
 - streak.gemspec
 homepage: https://github.com/czarneckid/streak
 licenses: []
@@ -81,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4141444244431860570
+      hash: 3197324458808714618
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -90,10 +91,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4141444244431860570
+      hash: 3197324458808714618
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Streak is a gem for calculating win/loss streaks
@@ -101,3 +102,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/streak/collector_spec.rb
 - spec/streak/configuration_spec.rb
+- spec/streak/version_spec.rb