scrolls 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c8d03494ac14a1c9e62cc5fb1603230062b4b7c
-  data.tar.gz: f55c3919d123172659203c03f6ae319b681def88
+  metadata.gz: d8a45e22efcf405c0ad873aa6a4b5552f740f806
+  data.tar.gz: 2306f64eaaf2390ea2df0c356fc6ef414c770ebf
 SHA512:
-  metadata.gz: 0628d7e8017ff0df5aa567a4dcfd2949f7c1cd606d1a30a24a731c10992c555af96f34fa0c606ac18f4c5192d4d38069166f414c1fca55c58c6d4cc959ecd72e
-  data.tar.gz: 1e1878a898a1bfc674a996a3368e6400cc96fe295c025db101cc9f04296e71c9736b651a59f246cc280f112cc800487fd0b613b83219f06483361bcf60fd3f7b
+  metadata.gz: ebd0aee8262fae69f7f57a09e79aad31613bdc5224450e55c347e3eeba6e8a59bd5f784be035827bb043818f01e8f680bddd04a3f0c1b4b69b7c909fdffebe90
+  data.tar.gz: 37497139c5d177d53fa929225c37f5bc851921fe13e143c83a8af9c0bbcdcac405e6fec059bbdaa8017f30e095f3cf3fc2a673e12b3f44f1317fb11b8de3af2c

data/lib/scrolls/log.rb

@@ -1,6 +1,7 @@
 require "scrolls/parser"
 require "scrolls/utils"
 require "scrolls/syslog"
+require "time"
 
 module Scrolls
 
@@ -75,12 +76,25 @@ module Scrolls
       @tunit ||= default_time_unit
     end
 
+    def add_timestamp=(b)
+      @add_timestamp = !!b
+    end
+
+    def add_timestamp
+      @add_timestamp || false
+    end
+
     def log(data, &blk)
       if gc = get_global_context
         ctx = gc.merge(context)
         logdata = ctx.merge(data)
       end
 
+      # By merging the logdata into the timestamp, rather than vice-versa, we
+      # ensure that the timestamp comes first in the Hash, and is placed first
+      # on the output, which helps with readability.
+      logdata = { :now => Time.now }.merge(logdata) if add_timestamp
+
       unless blk
         write(logdata)
       else

data/lib/scrolls/syslog.rb

@@ -27,15 +27,16 @@ module Scrolls
 
   class SyslogLogger
     def initialize(ident = 'scrolls', facility = Syslog::LOG_USER)
-      @syslog = Syslog.open(ident, Syslog::LOG_PID|Syslog::LOG_CONS, facility)
+      options = Syslog::LOG_PID|Syslog::LOG_CONS
+      begin
+        @syslog = Syslog.open(ident, options, facility)
+      rescue RuntimeError
+        @syslog = Syslog.reopen(ident, options, facility)
+      end
     end
 
     def puts(data)
-      @syslog.log(Syslog::LOG_INFO, data)
-    end
-
-    def close
-      @syslog.close
+      @syslog.log(Syslog::LOG_INFO, data, nil)
     end
   end
 end

data/lib/scrolls/version.rb

@@ -1,3 +1,3 @@
 module Scrolls
-  VERSION = "0.2.9"
+  VERSION = "0.3.0"
 end

data/lib/scrolls.rb

@@ -145,4 +145,28 @@ module Scrolls
   def time_unit
     Log.time_unit
   end
+
+  # Public: Set whether to include a timestamp (now=<ISO8601>) field in the log
+  # output (default: false)
+  #
+  # Examples
+  #
+  #   Scrolls.add_timestamp = true
+  #
+  def add_timestamp=(boolean)
+    Log.add_timestamp = boolean
+  end
+
+  # Public: Return whether the timestamp field will be included in the log
+  # output.
+  #
+  # Examples
+  #
+  #   Scrolls.add_timestamp
+  #   => true
+  #
+  def add_timestamp
+    Log.add_timestamp
+  end
+
 end

data/test/test_scrolls.rb

@@ -10,7 +10,7 @@ class TestScrolls < Test::Unit::TestCase
     Scrolls.global_context({})
     # Reset our syslog context
     Scrolls.facility = Scrolls::LOG_FACILITY
-    Scrolls.stream.close if Scrolls.stream.respond_to?(:close)
+    Scrolls.add_timestamp = false
   end
 
   def test_construct
@@ -147,4 +147,11 @@ class TestScrolls < Test::Unit::TestCase
     Scrolls.facility = "local7"
     assert_equal Syslog::LOG_LOCAL7, Scrolls.facility
   end
+
+  def test_add_timestamp
+    Scrolls.add_timestamp = true
+    Scrolls.log(:test => "foo")
+    iso8601_regexp = "(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?"
+    assert_match(/^now=#{iso8601_regexp} test=foo$/, @out.string)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrolls
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Curt Micol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-12 00:00:00.000000000 Z
+date: 2013-09-13 00:00:00.000000000 Z
 dependencies: []
 description: Logging, easier, more consistent.
 email: