counters 1.1.2 → 1.1.3

data/README.textile

@@ -71,7 +71,15 @@ $ cat counters.log
 2011-02-21T09:46:27.989183000 - latency: crawler.processing 0.3123122982101s
 </code></pre>
 
-You may also output your counters to "StatsD":https://github.com/etsy/statsd. The only change that might be surprising is magnitudes are output as timer events. Magnitudes are used to record
+You may also output your counters to "StatsD":https://github.com/etsy/statsd. The only change that might be surprising is magnitudes are output as timer events. Magnitudes are used to record values (such as process RSS, packet sizes, etc).
+
+Instantiate a StatsD instance:
+
+<pre><code>Counter = Counters::StatsD.new("127.0.0.1", 8125, :namespace => "analyzer")
+
+# Alternatively, use a URI:
+Counter = Counters::StatsD.new(:url => "udp://127.0.0.1:8125", :namespace => "crawler")
+</code></pre>
 
 See the file "samples/crawler.rb":blob/master/samples/crawler.rb for a more detailed example.
 

data/lib/counters/file.rb

@@ -5,12 +5,23 @@ module Counters
     def initialize(path_or_io_or_logger, options={})
       super(options)
 
-      @logger = if path_or_io_or_logger.kind_of?(Logger) then
+      @logger = if path_or_io_or_logger.kind_of?(Logger) || path_or_io_or_logger.respond_to?(:add) then
                   path_or_io_or_logger
+
+                elsif path_or_io_or_logger.respond_to?(:to_str) then
+                  # path to something
+                  raise ArgumentError, "Counters::File expects a path with a non-empty name (or a Logger, IO instance); received: #{path_or_io_or_logger.inspect}" if path_or_io_or_logger.to_str.empty?
+
+                  logger = Logger.new(path_or_io_or_logger)
+                  logger.formatter = lambda {|severity, datetime, progname, msg| "#{datetime.strftime("%Y-%m-%dT%H:%M:%S.%N")} - #{msg}\n"}
+                  logger
+
                 elsif path_or_io_or_logger.respond_to?(:<<) then
+                  # IO instance
                   logger = Logger.new(path_or_io_or_logger)
                   logger.formatter = lambda {|severity, datetime, progname, msg| "#{datetime.strftime("%Y-%m-%dT%H:%M:%S.%N")} - #{msg}\n"}
                   logger
+
                 else
                   raise ArgumentError, "Counters::File expects an object which is either a Logger or respond to #<<, received a #{path_or_io_or_logger.class}"
                 end

data/lib/counters/version.rb

@@ -1,3 +1,3 @@
 module Counters
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/spec/file_counter_spec.rb

@@ -2,6 +2,86 @@ require "spec_helper"
 require "logger"
 require "tempfile"
 
+describe Counters::File, "#initialize" do
+  context "given an existing Logger instance" do
+    let! :logger do
+      Logger.new(STDOUT)
+    end
+
+    it "should use the existing Logger instance" do
+      Logger.should_not_receive(:new)
+      Counters::File.new(logger)
+    end
+
+    it "should not change the formatting" do
+      logger.should_not_receive(:formatter=)
+      Counters::File.new(logger)
+    end
+  end
+
+  context "given an object that responds_to?(:add) (such as ActiveSupport::BufferedLogger)" do
+    class FakeLogger
+      def add(*args)
+        raise "called for nothing"
+      end
+    end
+
+    let! :logger do
+      FakeLogger.new
+    end
+
+    it "should use the existing instance" do
+      Logger.should_not_receive(:new)
+      Counters::File.new(logger)
+    end
+  end
+
+  context "given a String (representing a path)" do
+    let :path do
+      "log/mycounters.log"
+    end
+
+    let :logger do
+      double("logger").as_null_object
+    end
+
+    it "should instantiate a Logger with the passed path" do
+      Logger.should_receive(:new).with(path).and_return(logger)
+      Counters::File.new(path)
+    end
+
+    it "should set the formatting" do
+      Logger.stub(:new).and_return(logger)
+      logger.should_receive(:formatter=)
+      Counters::File.new(path)
+    end
+  end
+
+  context "given an IO object" do
+    let :io do
+      STDOUT
+    end
+
+    let :logger do
+      double("logger").as_null_object
+    end
+
+    it "should instantiate a Logger with the passed IO" do
+      Logger.should_receive(:new).with(io).and_return(logger)
+      Counters::File.new(io)
+    end
+
+    it "should set the formatting" do
+      Logger.stub(:new).and_return(logger)
+      logger.should_receive(:formatter=)
+      Counters::File.new(io)
+    end
+  end
+
+  it { lambda { Counters::File.new(nil) }.should raise_error(ArgumentError) }
+  it { lambda { Counters::File.new("")  }.should raise_error(ArgumentError) }
+end
+
 describe Counters::File do
   TIMESTAMP_RE = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3,}/
 

metadata

@@ -2,7 +2,7 @@
 name: counters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors: 
 - "Fran\xC3\xA7ois Beausoleil"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 -04:00
+date: 2011-04-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency