counters 1.0.1 → 1.0.2

data/README.textile

@@ -7,6 +7,7 @@ h2. Sample Usage
 Let's say you have a crawler. You'd like to record the number of URLs you visit, the number of URLs you skipped due to 304 Not Modified responses, and the number of bytes you consumed, and the amount of time each page takes to process. Here's how you'd do that:
 
 <pre><code>require "counters"
+require "redis"
 require "rest_client"
 Counter = Counters::Redis.new(Redis.new, "counters")
 

data/counters.gemspec

@@ -17,6 +17,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  # Eventually, we might have something like this
+  # s.add_optional_dependency "redis"
+  s.add_development_dependency "redis"
+
   s.add_development_dependency "rspec"
   s.add_development_dependency "timecop"
+  s.add_development_dependency "ruby-debug19"
 end

data/lib/counters/redis.rb

@@ -1,9 +1,11 @@
 require "benchmark"
-require "counters"
+
+# The redis gem must already be required - we don't require it.
+# This allows callers / users to use any implementation that has the right API.
 
 module Counters
   class Redis < Counters::Base
-    def initialize(redis, base_key)
+    def initialize(redis=Redis.new, base_key="counters")
       @redis, @base_key = redis, base_key
     end
 
@@ -12,7 +14,10 @@ module Counters
     end
 
     def record_magnitude(key, amount)
-      @redis.hset(@base_key, "magnitudes.#{key}", amount)
+      @redis.multi do
+        @redis.hincrby(@base_key, "magnitudes.#{key}.value", amount)
+        @redis.hincrby(@base_key, "magnitudes.#{key}.count", 1)
+      end
     end
 
     def ping(key)

data/lib/counters/version.rb

@@ -1,3 +1,3 @@
 module Counters
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/redis_counter_spec.rb

@@ -1,57 +1,77 @@
 require "spec_helper"
+require "redis"
 
-describe Counters::Redis do
+describe Counters::Redis, "integration tests" do
   let :redis do
-    double("redis")
+    ::Redis.new
   end
 
   let :counter do
     Counters::Redis.new(redis, "counters")
   end
 
+  before(:each) do
+    redis.flushdb
+  end
+
   it_should_behave_like "all counters"
 
-  it "should record a hit on 'pages.read' by HINCRBY counters/hits.pages.read" do
-    redis.should_receive(:hincrby).with("counters", "hits.pages.read", 1).twice
+  it "should record 2 hits on 'pages.read'" do
     2.times { counter.hit "pages.read" }
+    redis.hkeys("counters").should == ["hits.pages.read"]
+    redis.hget("counters", "hits.pages.read").to_i.should == 2
   end
 
-  it "should record a magnitude on 'bytes.in' by HSET counters/magnitudes.bytes.in" do
-    redis.should_receive(:hset).with("counters", "magnitudes.bytes.in", 309).once
-    redis.should_receive(:hset).with("counters", "magnitudes.bytes.in", 392).once
-    counter.magnitude "bytes.in", 309
-    counter.magnitude "bytes.in", 392
+  it "should record magnitude using a signed 64 bit 'value' and a 'count'" do
+    4.times { counter.magnitude "bytes.in", 2_047 }
+    redis.hkeys("counters").sort.should == %w(magnitudes.bytes.in.value magnitudes.bytes.in.count).sort
+
+    redis.hget("counters", "magnitudes.bytes.in.count").to_i.should == 4
+    redis.hget("counters", "magnitudes.bytes.in.value").to_i.should == 4*2_047
+  end
+
+  it "does not detect 63 bit integer overflow" do
+    counter.magnitude "bytes.in", 2**63 - 20
+    counter.magnitude "bytes.in", 2_047
+
+    target_value = (2**63 - 20) + 2_047
+
+    redis.hget("counters", "magnitudes.bytes.in.value").to_i.should == (target_value - 2**64)
+    redis.hget("counters", "magnitudes.bytes.in.count").to_i.should == 2
   end
 
   it "should record a ping on 'crawler' by HSET counters/pings.crawler with today's date/time as an int" do
-    Timecop.freeze do
-      redis.should_receive(:hset).with("counters", "pings.crawler", Time.now.utc.to_i).once
+    now = Time.now
+    Timecop.freeze(now) do
       counter.ping "crawler"
     end
 
+    redis.hget("counters", "pings.crawler").should == now.to_i.to_s
+
     target_time = Time.now + 9
     Timecop.travel(target_time) do
-      redis.should_receive(:hset).with("counters", "pings.crawler", target_time.to_i).once
       counter.ping "crawler"
     end
+
+    redis.hget("counters", "pings.crawler").should == target_time.to_i.to_s
   end
 
   it "should record latency on 'crawler.download' by HINCRBY counters/latencies.crawler.download.count by 1 and counters/latencies.crawler.download.nanoseconds by the latency" do
-    redis.should_receive(:hincrby).with("counters", "latencies.crawler.download.count", 1).twice
-    redis.should_receive(:hincrby).with("counters", "latencies.crawler.download.nanoseconds", 1.90 * 1_000_000_000).once
-    redis.should_receive(:hincrby).with("counters", "latencies.crawler.download.nanoseconds", 2.02 * 1_000_000_000).once
-
     counter.latency "crawler.download", 1.9
     counter.latency "crawler.download", 2.02
+
+    redis.hget("counters", "latencies.crawler.download.count").to_i.should == 2
+    redis.hget("counters", "latencies.crawler.download.nanoseconds").to_i.should == (2.02 + 1.90) * ONE_NANOSECOND
   end
 
   it "should record a block's latency" do
-    redis.should_receive(:hincrby).with("counters", "latencies.crawler.process.count", 1).once
-    redis.should_receive(:hincrby).once.with do |key, subkey, latency|
-      key == "counters" && subkey == "latencies.crawler.process.nanoseconds" && latency >= 0.2 * 1_000_000_000 && latency < 0.3 * 1_000_000_000
-    end
     counter.latency "crawler.process" do
       sleep 0.2
     end
+
+    redis.hget("counters", "latencies.crawler.process.count").to_i.should == 1
+    redis.hget("counters", "latencies.crawler.process.nanoseconds").to_i.should be_within(0.01 * ONE_NANOSECOND ).of ( 0.2 * ONE_NANOSECOND )
   end
+
+  ONE_NANOSECOND = 1_000_000_000
 end

data/spec/spec_helper.rb

@@ -1,6 +1,12 @@
 require "counters"
 require "timecop"
 
+begin
+  require "ruby-debug"
+rescue LoadError
+  # Optional dependency - ignoring
+end
+
 shared_examples_for "all counters" do
   it "should raise a ArgumentError when the key includes invalid chars" do
     lambda { counter.hit "hit!"        } .should raise_error(ArgumentError)
@@ -23,4 +29,12 @@ shared_examples_for "all counters" do
   it "should not raise ArgumentError when the key includes an underscore" do
     lambda { counter.hit "hit_" }.should_not raise_error(ArgumentError)
   end
+
+  it "should return the latency block's value" do
+    value = counter.latency "process" do
+      "the returned value"
+    end
+
+    value.should == "the returned value"
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Beausoleil"
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 -05:00
+date: 2011-03-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: redis
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -31,7 +31,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: timecop
+  name: rspec
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -43,6 +43,32 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Using the provided API, record metrics (such as number of hits to a particular controller, bytes in/out, compression ratio) within your system. Visualization is NOT provided within this gem.
 email: 
 - francois@teksol.info