steno 0.0.12 → 0.0.15

data/bin/steno-prettify

@@ -12,21 +12,25 @@ require "steno/json_prettifier"
 
 Signal.trap("INT") { exit }
 
-def prettify_io(io, prettifier)
+def prettify_io(io, prettifier, ignore_parse_error = false)
   lineno = 0
   io.each_line do |line|
     begin
       prettified = prettifier.prettify_line(line)
       print prettified
-    rescue Yajl::ParseError => e
-      STDERR.puts "steno-prettify: Malformed json at line #{lineno}, '#{line.strip}'"
+    rescue Steno::JsonPrettifier::ParseError => e
+      if ignore_parse_error
+        print line
+      else
+        STDERR.puts "steno-prettify: Malformed json at line #{lineno}, '#{line.strip}'"
+      end
     end
 
     lineno += 1
   end
 end
 
-def prettify_file(path, prettifier)
+def prettify_file(path, prettifier, ignore_parse_error = false)
   begin
     f = File.open(path, "r")
   rescue => e
@@ -34,13 +38,14 @@ def prettify_file(path, prettifier)
     return
   end
 
-  prettify_io(f, prettifier)
+  prettify_io(f, prettifier, ignore_parse_error)
 
 ensure
   f.close if f
 end
 
 excluded_fields = []
+ignore_parse_error = false
 
 option_parser = OptionParser.new do |op|
   op.banner =<<EOT
@@ -68,6 +73,10 @@ EOT
   op.on("-a", "--align", "Omit location and data in order to provide well-aligned logs") do
     excluded_fields = %w[location data]
   end
+
+  op.on("-s", "--no-messages", "Donot complain about errors in parsing logs") do
+    ignore_parse_error = true
+  end
 end
 
 option_parser.parse!(ARGV)
@@ -80,9 +89,8 @@ inputs << "-" if inputs.empty?
 
 inputs.each do |path|
   if path == "-"
-    prettify_io(STDIN, prettifier)
+    prettify_io(STDIN, prettifier, ignore_parse_error)
   else
-    prettify_file(path, prettifier)
+    prettify_file(path, prettifier, ignore_parse_error)
   end
 end
-

data/lib/steno/core_ext.rb

@@ -1,5 +1,11 @@
-class Class
+class Module
   def logger
     Steno.logger(name)
   end
 end
+
+class Object
+  def logger
+    self.class.logger
+  end
+end

data/lib/steno/json_prettifier.rb

@@ -10,13 +10,20 @@ class Steno::JsonPrettifier
   FIELD_ORDER = %w[timestamp source process_id thread_id fiber_id location data
                    log_level message]
 
+  class ParseError < StandardError
+  end
+
   def initialize(excluded_fields = [])
     @time_format = "%Y-%m-%d %H:%M:%S.%6N"
     @excluded_fields = Set.new(excluded_fields)
   end
 
   def prettify_line(line)
-    json_record = Yajl::Parser.parse(line)
+    begin
+      json_record = Yajl::Parser.parse(line)
+    rescue Yajl::ParseError => e
+      raise ParseError, e.to_s
+    end
 
     format_record(json_record)
   end
@@ -24,6 +31,7 @@ class Steno::JsonPrettifier
   protected
 
   def format_record(record)
+    record ||= {}
     fields = []
 
     FIELD_ORDER.each do |field_name|
@@ -33,8 +41,11 @@ class Steno::JsonPrettifier
       pred_meth = "check_#{field_name}".to_sym
       if respond_to?(pred_meth)
         exists = send(pred_meth, record)
-      else
+      elsif record.respond_to?(:has_key?)
         exists = record.has_key?(field_name)
+      else
+        msg = "Expected the record to be a hash, but received: #{record.class}."
+        raise ParseError, msg
       end
 
       if exists

data/lib/steno/record.rb

@@ -28,7 +28,7 @@ class Steno::Record
     @timestamp  = Time.now
     @source     = source
     @log_level  = log_level
-    @message    = message
+    @message    = message.to_s
     @data       = {}.merge(data)
     @thread_id  = Thread.current.object_id
     @fiber_id   = Fiber.current.object_id

data/lib/steno/sink/syslog.rb

@@ -31,8 +31,11 @@ class Steno::Sink::Syslog < Steno::Sink::Base
 
   def add_record(record)
     msg = @codec.encode_record(record)
-    pri = LOG_LEVEL_MAP[record.log_level]
+    pri = LOG_LEVEL_MAP[record.log_level.name]
     @syslog_lock.synchronize { @syslog.log(pri, "%s", msg) }
   end
 
+  def flush
+    nil
+  end
 end

data/lib/steno/version.rb

@@ -1,3 +1,3 @@
 module Steno
-  VERSION = "0.0.12"
+  VERSION = "0.0.15"
 end

data/spec/unit/core_ext_spec.rb

@@ -1,20 +1,38 @@
 require "spec_helper"
 
+require "steno/core_ext"
+
 module Foo
   class Bar
   end
 end
 
-describe Class do
+describe Module do
   describe "#logger" do
-    it "should request a logger named after the class" do
-      expect do
-        Foo::Bar.logger
-      end.to raise_error(/undefined/)
+    it "should request a logger named after itself" do
+      x = Foo.logger
+      x.should be_a(Steno::Logger)
+      x.name.should include("Foo")
+    end
+  end
+end
 
-      require "steno/core_ext"
+describe Class do
+  describe "#logger" do
+    it "should request a logger named after itself" do
       x = Foo::Bar.logger
-      x.should_not be_nil
+      x.should be_a(Steno::Logger)
+      x.name.should include("Foo::Bar")
+    end
+  end
+end
+
+describe Object do
+  describe "#logger" do
+    it "should request a logger named after its class" do
+      x = Foo::Bar.new.logger
+      x.should be_a(Steno::Logger)
+      x.name.should include("Foo::Bar")
     end
   end
 end

data/spec/unit/json_prettifier_spec.rb

@@ -27,5 +27,17 @@ describe Steno::JsonPrettifier do
                    ].join("\s+") + "\n"
       prettified.should match(exp_regex)
     end
+
+    it "should raise a parse error when the json-encoded string is not a hash" do
+      expect {
+        prettifier.prettify_line("[1,2,3]")
+      }.to raise_error(Steno::JsonPrettifier::ParseError)
+    end
+
+    it "should raise a parse error when the json-encoded string is malformed" do
+      expect {
+        prettifier.prettify_line("blah")
+      }.to raise_error(Steno::JsonPrettifier::ParseError)
+    end
   end
 end

data/spec/unit/record_spec.rb

@@ -1,7 +1,8 @@
 require "spec_helper"
 
 describe Steno::Record do
-  let(:record) { Steno::Record.new("test", :info, "test message") }
+  let(:message) { Array("test message") }
+  let(:record) { Steno::Record.new("test", :info, message) }
 
   it "should set the process id" do
     record.process_id.should == Process.pid
@@ -18,4 +19,8 @@ describe Steno::Record do
   it "should set the source" do
     record.source.should == "test"
   end
+
+  it "should stringify the message" do
+    record.message.should be_a(String)
+  end
 end

data/spec/unit/{io_sink_spec.rb → sink/io_spec.rb}

@@ -1,15 +1,21 @@
 require "spec_helper"
 
 describe Steno::Sink::IO do
-  let(:record) { { :data => "test" } }
+  let(:level) do
+    Steno::Logger.lookup_level(:info)
+  end
+
+  let(:record) do
+    Steno::Record.new("source", level, "message")
+  end
 
   describe "#add_record" do
     it "should encode the record and write it to the underlying io object" do
       codec = mock("codec")
-      codec.should_receive(:encode_record).with(record).and_return(record[:data])
+      codec.should_receive(:encode_record).with(record).and_return(record.message)
 
       io = mock("io")
-      io.should_receive(:write).with(record[:data])
+      io.should_receive(:write).with(record.message)
 
       Steno::Sink::IO.new(io, codec).add_record(record)
     end

data/spec/unit/{syslog_sink_spec.rb → sink/syslog_spec.rb}

@@ -1,6 +1,14 @@
 require "spec_helper"
 
 describe Steno::Sink::Syslog do
+  let(:level) do
+    Steno::Logger.lookup_level(:info)
+  end
+
+  let(:record) do
+    Steno::Record.new("source", level, "message")
+  end
+
   describe "#add_record" do
     it "should append an encoded record with the correct priority" do
       identity = "test"
@@ -13,15 +21,19 @@ describe Steno::Sink::Syslog do
       sink = Steno::Sink::Syslog.instance
       sink.open(identity)
 
-      record = Steno::Record.new("test", :info, "hello")
-
       codec = mock("codec")
-      codec.should_receive(:encode_record).with(record).and_return("test")
+      codec.should_receive(:encode_record).with(record).and_return(record.message)
       sink.codec = codec
 
-      syslog.should_receive(:log).with(Syslog::LOG_INFO, "%s", "test")
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "%s", record.message)
 
       sink.add_record(record)
     end
   end
+
+  describe "#flush" do
+    it "should do nothing" do
+      Steno::Sink::Syslog.instance.flush
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steno
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000 Z
+date: 2012-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -148,14 +148,14 @@ files:
 - spec/unit/context_spec.rb
 - spec/unit/core_ext_spec.rb
 - spec/unit/http_handler_spec.rb
-- spec/unit/io_sink_spec.rb
 - spec/unit/json_codec_spec.rb
 - spec/unit/json_prettifier_spec.rb
 - spec/unit/log_level_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/record_spec.rb
+- spec/unit/sink/io_spec.rb
+- spec/unit/sink/syslog_spec.rb
 - spec/unit/steno_spec.rb
-- spec/unit/syslog_sink_spec.rb
 - spec/unit/tagged_logger_spec.rb
 - steno.gemspec
 homepage: http://www.cloudfoundry.org
@@ -191,12 +191,12 @@ test_files:
 - spec/unit/context_spec.rb
 - spec/unit/core_ext_spec.rb
 - spec/unit/http_handler_spec.rb
-- spec/unit/io_sink_spec.rb
 - spec/unit/json_codec_spec.rb
 - spec/unit/json_prettifier_spec.rb
 - spec/unit/log_level_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/record_spec.rb
+- spec/unit/sink/io_spec.rb
+- spec/unit/sink/syslog_spec.rb
 - spec/unit/steno_spec.rb
-- spec/unit/syslog_sink_spec.rb
 - spec/unit/tagged_logger_spec.rb