streak 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+*.rdb
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format nested

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create ruby-1.9.3-p125@streak_gem

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.0.1
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in streak.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David Czarnecki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# streak
+
+streak is a gem for calculating win/loss streaks. It uses Redis as its backend for collecting the data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'streak'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install streak
+```
+
+## Usage
+
+streak is configurable with respect to its keys to allow for tracking other positive/negative things in a game like wins and losses, kills and deaths, etc.
+
+```ruby
+# Configuration
+Streak.configure do |configuration|
+  configuration.redis = Redis.new
+  configuration.namespace = 'streak'
+  configuration.positive_key = 'wins'
+  configuration.positive_total_key = 'wins_total'
+  configuration.positive_streak_key = 'wins_streak'
+  configuration.negative_key = 'losses'
+  configuration.negative_total_key = 'losses_total'
+  configuration.negative_streak_key = 'losses_streak'
+  configuration.total_key = 'total'
+end
+
+Streak.aggregate('david', 3) # 3 wins
+Streak.aggregate('david', -2) # 2 losses
+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} 
+
+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} 
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2012 David Czarnecki. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+  # spec.ruby_opts = ['-w']
+end
+
+task :default => :spec

data/lib/streak.rb

@@ -0,0 +1,9 @@
+require 'redis'
+require 'streak/configuration'
+require 'streak/collector'
+require 'streak/version'
+
+module Streak
+  extend Configuration
+  extend Collector
+end

data/lib/streak/collector.rb

@@ -0,0 +1,82 @@
+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 
+    # 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)
+      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}")
+        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)
+        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}")
+        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)
+        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+, 
+    # +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.
+    #
+    # @return +Hash+ of streak statistics and their corresponding values for a given +id+.
+    #
+    def 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])
+      values = Streak.redis.multi do |transaction|
+        keys.each do |key|
+          transaction.get("#{Streak::namespace}::#{key}::#{id}")
+        end
+      end.map(&:to_i)
+
+      Hash[keys.map(&:to_sym).zip(values)]
+    end
+
+    # Reset all the statistics for a given +id+ to 0.
+    #
+    # @param id [String] ID.
+    def reset_statistics(id)
+      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|
+          transaction.set("#{Streak::namespace}::#{key}::#{id}", 0)
+        end
+      end
+    end
+  end
+end

data/lib/streak/configuration.rb

@@ -0,0 +1,105 @@
+module Streak
+  module Configuration
+    # Redis instance.
+    attr_accessor :redis
+
+    # streak namespace for Redis.
+    attr_writer :namespace
+
+    # Key used in Redis for tracking positive.
+    attr_writer :positive_key
+
+    # Key used in Redis for tracking positive total.
+    attr_writer :positive_total_key
+
+    # Key used in Redis for tracking positive streak.
+    attr_writer :positive_streak_key
+
+    # Key used in Redis for tracking negative.
+    attr_writer :negative_key
+
+    # Key used in Redis for tracking negative total.
+    attr_writer :negative_total_key
+
+    # Key used in Redis for tracking negative streak.
+    attr_writer :negative_streak_key
+
+    # Key used in Redis for tracking total.
+    attr_writer :total
+    
+    # Yield self to be able to configure Streak with block-style configuration.
+    #
+    # Example:
+    #
+    #   Streak.configure do |configuration|
+    #     configuration.redis = Redis.new
+    #     configuration.namespace = 'streak'
+    #     configuration.positive_key = 'wins'
+    #     configuration.positive_total_key = 'wins_total'
+    #     configuration.positive_streak_key = 'wins_streak'
+    #     configuration.negative_key = 'losses'
+    #     configuration.negative_total_key = 'losses_total'
+    #     configuration.negative_streak_key = 'losses_streak'
+    #     configuration.total_key = 'total'
+    #   end
+    def configure
+      yield self
+    end
+
+    # streak namespace for Redis.
+    #
+    # @return the streak namespace or the default of 'streak' if not set.
+    def namespace
+      @namespace ||= 'streak'
+    end
+
+    # Key used in Redis for tracking positive.
+    #
+    # @return the key used in Redis for tracking positive or the default of 'wins' if not set.
+    def positive_key
+      @positive_key ||= 'wins'
+    end
+
+    # Key used in Redis for tracking positive total.
+    #
+    # @return the key used in Redis for tracking positive total or the default of 'wins_total' if not set.
+    def positive_total_key
+      @positive_total_key ||= 'wins_total'
+    end
+
+    # Key used in Redis for tracking positive streak.
+    #
+    # @return the key used in Redis for tracking positive streak or the default of 'wins_streak' if not set.
+    def positive_streak_key
+      @positive_streak_key ||= 'wins_streak'
+    end
+
+    # Key used in Redis for tracking negative.
+    # 
+    # @return the key used in Redis for tracking negative or the default of 'losses' if not set.
+    def negative_key
+      @negative_key ||= 'losses'
+    end
+
+    # Key used in Redis for tracking negative total.
+    #
+    # @return the key used in Redis for tracking negative total or the default of 'losses_total' if not set.
+    def negative_total_key
+      @negative_total_key ||= 'losses_total'
+    end
+
+    # Key used in Redis for tracking negative streak.
+    #
+    # @return the key used in Redis for tracking negative streak or the default of 'losses_streak' if not set.
+    def negative_streak_key
+      @negative_streak_key ||= 'losses_streak'
+    end
+
+    # Key used in Redis for tracking totals.
+    #
+    # @return the key used in Redis for tracking total or the default of 'total' if not set.
+    def total_key
+      @total ||= 'total'
+    end
+  end
+end

data/lib/streak/version.rb

@@ -0,0 +1,3 @@
+module Streak
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'streak'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.before(:all) do
+    Streak.configure do |configuration|
+      redis = Redis.new(:db => 15)
+      configuration.redis = redis
+    end
+  end
+
+  config.before(:each) do
+    Streak.redis.flushdb
+  end
+
+  config.after(:all) do
+    Streak.redis.flushdb
+    Streak.redis.quit
+  end
+
+  def streak_value_for(key, id)
+    Streak.redis.get("#{Streak::namespace}::#{key}::#{id}").to_i
+  end
+end

data/spec/streak/collector_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Streak::Collector do
+  describe '#aggregate' do
+    it 'should collect the right statistics' do
+      streak_value_for(Streak.positive_key, 'david').should == 0
+      streak_value_for(Streak.positive_streak_key, 'david').should == 0
+      streak_value_for(Streak.negative_key, 'david').should == 0
+      streak_value_for(Streak.negative_streak_key, 'david').should == 0
+      streak_value_for(Streak.total_key, 'david').should == 0
+      Streak.aggregate('david', 1)
+      streak_value_for(Streak.positive_key, 'david').should == 1
+      streak_value_for(Streak.positive_streak_key, 'david').should == 1
+      streak_value_for(Streak.negative_key, 'david').should == 0
+      streak_value_for(Streak.total_key, 'david').should == 1
+      Streak.aggregate('david', 1)
+      streak_value_for(Streak.positive_key, 'david').should == 2
+      streak_value_for(Streak.positive_streak_key, 'david').should == 2
+      streak_value_for(Streak.total_key, 'david').should == 2
+      Streak.aggregate('david', -1)
+      streak_value_for(Streak.positive_key, 'david').should == 0
+      streak_value_for(Streak.positive_streak_key, 'david').should == 2
+      streak_value_for(Streak.negative_key, 'david').should == 1
+      streak_value_for(Streak.negative_streak_key, 'david').should == 1
+      streak_value_for(Streak.total_key, 'david').should == 3
+      Streak.aggregate('david', 3)
+      streak_value_for(Streak.positive_key, 'david').should == 3
+      streak_value_for(Streak.positive_streak_key, 'david').should == 3
+      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
+
+  describe '#statistics' do
+    it 'should return the default list of statistics if no keys list is provided' do
+      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}
+    end
+
+    it 'should return the specified list of statistics if a keys list is provided' do
+      Streak.aggregate('david', 3)
+      Streak.aggregate('david', -2)
+      Streak.aggregate('david', 5)
+      Streak.aggregate('david', -1)
+
+      Streak.statistics('david', [Streak.positive_streak_key, Streak.negative_streak_key]).should == {:wins_streak => 5, :losses_streak => 2}
+    end
+  end
+
+  describe '#reset_statistics' do
+    it 'should reset all statistics' do
+      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.statistics('david').should == {:wins => 0, :wins_total => 0, :wins_streak => 0, :losses => 0, :losses_total => 0, :losses_streak => 0, :total => 0}
+    end
+  end
+end

data/spec/streak/configuration_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Streak::Configuration do
+  describe '#configure' do
+    it 'should have default attributes' do
+      Streak.configure do |configuration|
+        configuration.redis.should_not be_nil
+        configuration.namespace.should eql('streak')
+        configuration.positive_key.should eql('wins')
+        configuration.positive_total_key.should eql('wins_total')
+        configuration.positive_streak_key.should eql('wins_streak')
+        configuration.negative_key.should eql('losses')
+        configuration.negative_total_key.should eql('losses_total')
+        configuration.negative_streak_key.should eql('losses_streak')
+        configuration.total_key.should eql('total')
+      end
+    end
+  end
+end

data/streak.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'streak/version'
+
+# require File.expand_path('../lib/streak/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David Czarnecki"]
+  gem.email         = ["me@davidczarnecki.com"]
+  gem.description   = %q{Streak is a gem for calculating win/loss streaks}
+  gem.summary       = %q{Streak is a gem for calculating win/loss streaks}
+  gem.homepage      = "https://github.com/czarneckid/streak"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "streak"
+  gem.require_paths = ["lib"]
+  gem.version       = Streak::VERSION
+
+  gem.add_dependency 'redis'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: streak
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Czarnecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70095633195380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70095633195380
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70095633194840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095633194840
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70095633194140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095633194140
+description: Streak is a gem for calculating win/loss streaks
+email:
+- me@davidczarnecki.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/streak.rb
+- lib/streak/collector.rb
+- lib/streak/configuration.rb
+- lib/streak/version.rb
+- spec/spec_helper.rb
+- spec/streak/collector_spec.rb
+- spec/streak/configuration_spec.rb
+- streak.gemspec
+homepage: https://github.com/czarneckid/streak
+licenses: []
+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: -3298361675894523649
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3298361675894523649
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Streak is a gem for calculating win/loss streaks
+test_files:
+- spec/spec_helper.rb
+- spec/streak/collector_spec.rb
+- spec/streak/configuration_spec.rb