stats 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+*.gemspec
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Matt Duncan
+
+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,41 @@
+Stats
+=====
+
+Requires the redis gem.
+
+Easily keep track of vital stats using Redis.
+
+There are currently three types of statistics that Stats captures:
+
+1. Simple
+---------
+Simple stats are meant to be updated periodically.  Only the latest value is
+kept.
+
+    Stats.set("load", System.load)
+
+2. Counts
+---------
+Counts can be incremented and decremented.  Only the latest value is kept.
+
+    Stats.incr("downloads")
+
+3. Timings
+----------
+Timings are used to keep track of the time it takes to run a block.  All values
+are kept so that they can be graphed/analyzed.
+
+    Stats.time("archive") { file.archive }
+
+
+Installation
+------------
+
+    $ gem install stats
+
+
+Author
+------
+
+Matt Duncan
+matt@mattduncan.org

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake/testtask'
+
+task :default => :test
+
+desc "Runs all tests"
+task :test => ['test:unit', 'test:integration']
+
+namespace :test do
+  desc "Runs unit tests"
+  Rake::TestTask.new(:unit) do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/unit/test_*.rb']
+  end
+
+  desc "Runs integration tests"
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/integration/test_*.rb']
+  end
+end
+
+desc "Build a gem"
+task :gem => [:gemspec, :build]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "stats"
+    gemspec.summary = "Simple stats collection using Redis."
+    gemspec.email = "matt@mattduncan.org"
+    gemspec.homepage = "http://github.com/mrduncan/stats"
+    gemspec.authors = ["Matt Duncan"]
+    gemspec.version = '0.1.0'
+    gemspec.add_dependency 'redis'
+    gemspec.description = <<description
+The stats gem is a simple way to keep track of different statistics using
+Redis.
+description
+  end
+rescue LoadError
+  warn "Jeweler not available. Install it with:"
+  warn "gem install jeweler"
+end

data/lib/stats/helpers.rb

@@ -0,0 +1,23 @@
+module Stats
+  module Helpers
+    # Sets the Redis server with the specified 'hostname:port[:db]' string or
+    # Redis object.
+    def redis=(server)
+      case server
+      when String
+        host, port, db = server.split(':')
+        @redis = Redis.new(:host => host, :port => port, :db => db, :thread_safe => true)
+      else
+        @redis = server
+      end
+    end
+
+    # Returns the current Redis connection.  A default connection will be made
+    # if one doesn't yet exist.
+    def redis
+      return @redis if @redis
+      self.redis = 'localhost:6379'
+      self.redis
+    end
+  end
+end

data/lib/stats/times.rb

@@ -0,0 +1,16 @@
+module Stats
+  module Times
+    # Returns the timing data for the stat with the specified name.
+    def get_times(name)
+      times = Stats.redis.lrange(name, 0, -1)
+      TimingStat.new(times.map { |t| t.to_f })
+    end
+
+    # Adds a new time for the stat with the specified name.
+    def time(name, &block)
+      raise ArgumentError.new("Block required to time.") unless block
+      realtime = Benchmark.realtime { block.call }
+      Stats.redis.rpush(name, realtime)
+    end
+  end
+end

data/lib/stats/timing_stat.rb

@@ -0,0 +1,25 @@
+module Stats
+  class TimingStat < Array
+    # Returns the average value.
+    def average
+      sum / length.to_f
+    end
+
+    # Returns the sample variance of the values.
+    def population_variance
+      avg = average
+      1 / length.to_f * inject(0) { |acc, i| acc + (i - avg) ** 2 }
+    end
+
+    # Returns the standard deviation of the values.
+    def standard_deviation
+      Math.sqrt(population_variance)
+    end
+
+    private
+      # Returns the sum of all values.
+      def sum
+        inject(0) { |acc, i| acc + i }
+      end
+  end
+end

data/lib/stats.rb

@@ -0,0 +1,36 @@
+require 'benchmark'
+require 'redis'
+require 'stats/helpers'
+require 'stats/times'
+require 'stats/timing_stat'
+
+module Stats
+  extend self
+  extend Helpers
+  extend Times
+
+  # Sets the stat with the specified name.
+  def set(name, value)
+    Stats.redis.set(name, value)
+  end
+
+  # Returns the value with the specified name.
+  def get(name)
+    Stats.redis.get(name)
+  end
+
+  # Increments the stat with the specified name.
+  def incr(name, by = 1)
+    Stats.redis.incrby(name, by)
+  end
+
+  # Decrements the stat with the specified name.
+  def decr(name, by = 1)
+    Stats.redis.decrby(name, by)
+  end
+
+  # Clears the stat with the specified name.
+  def clear(name)
+    Stats.redis.del(name)
+  end
+end

data/test/integration/test_stats.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+require 'mocha'
+require 'stats'
+
+class TestStats < Test::Unit::TestCase
+  def setup
+    Stats.redis = 'localhost:6379:stats_test'
+    Stats.redis.flush_db
+  end
+
+  def test_should_set
+    Stats.set("load", 1.2)
+    assert_equal 1.2, Stats.get("load").to_f
+    Stats.set("load", 1.7)
+    assert_equal 1.7, Stats.get("load").to_f
+  end
+
+  def test_should_increment
+    assert_equal 0, Stats.get("downloads").to_i
+    Stats.incr("downloads")
+    assert_equal 1, Stats.get("downloads").to_i
+    Stats.incr("downloads", 2)
+    assert_equal 3, Stats.get("downloads").to_i
+  end
+
+  def test_should_decrement
+    Stats.set("invitations", 100)
+    Stats.decr("invitations")
+    assert_equal 99, Stats.get("invitations").to_i
+    Stats.decr("invitations", 4)
+    assert_equal 95, Stats.get("invitations").to_i
+  end
+
+  def test_should_clear
+    Stats.set("space_left", 100)
+    Stats.clear("space_left")
+    assert_nil Stats.get("space_left")
+  end
+
+  def test_should_time
+    Benchmark.expects(:realtime).returns(2)
+    Stats.time("archive") { "takes 2" }
+    Benchmark.expects(:realtime).returns(3)
+    Stats.time("archive") { "takes 3" }
+    assert_equal [2, 3], Stats.get_times("archive")
+  end
+end

data/test/unit/test_stats.rb

@@ -0,0 +1,75 @@
+require 'test/unit'
+require 'mocha'
+require 'stats'
+
+class TestStats < Test::Unit::TestCase
+  def setup
+    Stats.instance_variable_set(:@redis, nil)
+  end
+
+  def test_should_initialize_redis_with_host_port
+    Redis.expects(:new).with(:host        => 'localhost',
+                             :port        => '6379',
+                             :db          => nil,
+                             :thread_safe => true).returns(mock('redis'))
+    Stats.redis = 'localhost:6379'
+  end
+
+  def test_should_initialize_redis_with_host_port_db
+    Redis.expects(:new).with(:host        => 'localhost',
+                             :port        => '6379',
+                             :db          => 'stats',
+                             :thread_safe => true).returns(mock('redis'))
+    Stats.redis = 'localhost:6379:stats'
+  end
+
+  def test_should_initialize_redis_if_not_set
+    Redis.expects(:new).with(:host        => 'localhost',
+                             :port        => '6379',
+                             :db          => nil,
+                             :thread_safe => true).returns(mock('redis'))
+    Stats.redis
+  end
+
+  def test_should_set
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:set).with("load", 2.1)
+    Stats.set("load", 2.1)
+  end
+
+  def test_should_get
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:get).with("load").returns(1.1)
+    assert_equal 1.1, Stats.get("load")
+  end
+
+  def test_should_incr_by_one
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:incrby).with("downloads", 1)
+    Stats.incr("downloads")
+  end
+
+  def test_should_incr_by_many
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:incrby).with("purchased_items", 5)
+    Stats.incr("purchased_items", 5)
+  end
+
+  def test_should_decr_by_one
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:decrby).with("invitations", 1)
+    Stats.decr("invitations")
+  end
+
+  def test_should_decr_by_many
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:decrby).with("tickets_left", 4)
+    Stats.decr("tickets_left", 4)
+  end
+
+  def test_should_clear
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:del).with("downloads")
+    Stats.clear("downloads")
+  end
+end

data/test/unit/test_times.rb

@@ -0,0 +1,24 @@
+require 'test/unit'
+require 'mocha'
+require 'stats'
+
+class TestStats < Test::Unit::TestCase
+  def test_should_add_timing
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:rpush).with("archive", 1)
+    Benchmark.expects(:realtime).returns(1)
+    Stats.time("archive") { "noop" }
+  end
+
+  def test_should_raise_arguement_error_when_timing_without_block
+    assert_raise(ArgumentError) do
+      Stats.time("archive")
+    end
+  end
+
+  def test_should_get_times
+    Stats.redis = mock('redis')
+    Stats.redis.expects(:lrange).with("archive", 0, -1).returns(["1", "2"])
+    assert_equal [1, 2], Stats.get_times("archive")
+  end
+end

data/test/unit/test_timing_stat.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require 'mocha'
+require 'stats'
+
+class TestStats < Test::Unit::TestCase
+  def test_should_average
+    assert_equal 2.0, Stats::TimingStat.new([1, 2, 2, 3]).average
+  end
+
+  def test_should_get_population_variance
+    assert_equal 0.25, Stats::TimingStat.new([1, 1, 2, 2]).population_variance
+  end
+
+  def test_should_get_standard_deviation
+    assert_equal 0.5, Stats::TimingStat.new([1, 1, 2, 2]).standard_deviation
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: stats
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matt Duncan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: |
+  The stats gem is a simple way to keep track of different statistics using
+  Redis.
+
+email: matt@mattduncan.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/stats.rb
+- lib/stats/helpers.rb
+- lib/stats/times.rb
+- lib/stats/timing_stat.rb
+- test/integration/test_stats.rb
+- test/unit/test_stats.rb
+- test/unit/test_times.rb
+- test/unit/test_timing_stat.rb
+has_rdoc: true
+homepage: http://github.com/mrduncan/stats
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple stats collection using Redis.
+test_files: 
+- test/integration/test_stats.rb
+- test/unit/test_stats.rb
+- test/unit/test_times.rb
+- test/unit/test_timing_stat.rb