scrolls 0.2.7 → 0.2.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8beec4af8465e8505c319ca48c0067fcfdff5f35
+  data.tar.gz: 8e9ddcc0a1b856f7b78fb03f4cc3ce1c20b5dc98
+SHA512:
+  metadata.gz: 7f06f0c33ad9191f1d3e034bb25d892aa5f3ba794c9ea622ab04531c0e86217ece67f0849dab0b52e57473a858ace2a4089189407ed67ec0535ce259263125f1
+  data.tar.gz: 3c2007e3912a15799b1905794f3325026d4636d7418f260c5086d109dd71872324f18aebd7bec3f96c8cea6c4fd79eb11bba1c6e284988d8b1d03f5e313b9265

data/lib/scrolls/log.rb

@@ -1,5 +1,6 @@
 require "scrolls/parser"
 require "scrolls/utils"
+require "scrolls/syslog"
 
 module Scrolls
 
@@ -44,10 +45,21 @@ module Scrolls
       @global_context.update { |previous_data| previous_data.merge(new_data) }
     end
 
+    def facility=(f)
+      @facility = LOG_FACILITY_MAP[f] if f
+    end
+
+    def facility
+      @facility ||= default_log_facility
+    end
+
     def stream=(out=nil)
       @defined = out.nil? ? false : true
-
-      @stream = sync_stream(out)
+      if out == 'syslog'
+        @stream = Scrolls::SyslogLogger.new($0, facility)
+      else
+        @stream = sync_stream(out)
+      end
     end
 
     def stream
@@ -198,5 +210,8 @@ module Scrolls
       end
     end
 
+    def default_log_facility
+      LOG_FACILITY
+    end
   end
 end

data/lib/scrolls/syslog.rb

@@ -0,0 +1,41 @@
+require 'syslog'
+
+module Scrolls
+
+  LOG_FACILITY = ENV['LOG_FACILITY'] || Syslog::LOG_USER
+  LOG_FACILITY_MAP = {
+    "auth"     => Syslog::LOG_AUTH,
+    "authpriv" => Syslog::LOG_AUTHPRIV,
+    "cron"     => Syslog::LOG_CRON,
+    "daemon"   => Syslog::LOG_DAEMON,
+    "ftp"      => Syslog::LOG_FTP,
+    "kern"     => Syslog::LOG_KERN,
+    "mail"     => Syslog::LOG_MAIL,
+    "news"     => Syslog::LOG_NEWS,
+    "syslog"   => Syslog::LOG_SYSLOG,
+    "user"     => Syslog::LOG_USER,
+    "uucp"     => Syslog::LOG_UUCP,
+    "local0"   => Syslog::LOG_LOCAL0,
+    "local1"   => Syslog::LOG_LOCAL1,
+    "local2"   => Syslog::LOG_LOCAL2,
+    "local3"   => Syslog::LOG_LOCAL3,
+    "local4"   => Syslog::LOG_LOCAL4,
+    "local5"   => Syslog::LOG_LOCAL5,
+    "local6"   => Syslog::LOG_LOCAL6,
+    "local7"   => Syslog::LOG_LOCAL7,
+  }
+
+  class SyslogLogger
+    def initialize(ident = 'scrolls', facility = Syslog::LOG_USER)
+      @syslog = Syslog.open(ident, Syslog::LOG_PID|Syslog::LOG_CONS, facility)
+    end
+
+    def puts(data)
+      @syslog.log(Syslog::LOG_INFO, data)
+    end
+
+    def close
+      @syslog.close
+    end
+  end
+end

data/lib/scrolls/version.rb

@@ -1,3 +1,3 @@
 module Scrolls
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/lib/scrolls.rb

@@ -28,7 +28,7 @@ module Scrolls
       Log.global_context
     end
   end
-  
+
   def add_global_context(data)
     Log.add_global_context(data)
   end
@@ -73,10 +73,37 @@ module Scrolls
     Log.log_exception(data, e)
   end
 
+  # Public: Setup a logging facility (default: Syslog::LOG_USER)
+  #
+  # facility - Syslog facility
+  #
+  # Examples
+  #
+  #   Scrolls.facility = Syslog::LOG_LOCAL7
+  #
+  def facility=(f)
+    Log.facility=(f)
+  end
+
+  # Public: Return the Syslog facility
+  #
+  # Examples
+  #
+  #   Scrolls.facility
+  #   => 8
+  #
+  def facility
+    Log.facility
+  end
+
   # Public: Setup a new output (default: STDOUT)
   #
   # out - New output
   #
+  # Options
+  #
+  #   syslog - Load 'Scrolls::SyslogLogger'
+  #
   # Examples
   #
   #   Scrolls.stream = StringIO.new

data/test/test_scrolls.rb

@@ -8,47 +8,50 @@ class TestScrolls < Test::Unit::TestCase
 
   def teardown
     Scrolls.global_context({})
+    # Reset our syslog context
+    Scrolls.facility = Scrolls::LOG_FACILITY
+    Scrolls.stream.close if Scrolls.stream.respond_to?(:close)
   end
 
-  def test_construct
-    assert_equal StringIO, Scrolls.stream.class
-  end
+  # def test_construct
+  #   assert_equal StringIO, Scrolls.stream.class
+  # end
 
   def test_default_global_context
     assert_equal Hash.new, Scrolls.global_context
   end
 
   def test_setting_global_context
-    Scrolls.global_context(g: "g")
-    Scrolls.log(d: "d")
+    Scrolls.global_context(:g => "g")
+    Scrolls.log(:d => "d")
     assert_equal "g=g d=d\n", @out.string
   end
   
   def test_adding_to_global_context
-    Scrolls.global_context(g: "g")
-    Scrolls.add_global_context(h: "h")
-    Scrolls.log(d: "d")
+    Scrolls.global_context(:g => "g")
+    Scrolls.add_global_context(:h => "h")
+    Scrolls.log(:d => "d")
     assert_equal "g=g h=h d=d\n", @out.string
   end
 
   def test_default_context
-    Scrolls.log(data: "d")
+    Scrolls.log(:data => "d")
     assert_equal Hash.new, Scrolls::Log.context
   end
 
   def test_setting_context
-    Scrolls.context(c: "c") { Scrolls.log(i: "i") }
+    Scrolls.context(:c =>"c") { Scrolls.log(:i => "i") }
     output = "c=c i=i\n"
     assert_equal output, @out.string
   end
 
   def test_all_the_contexts
-    Scrolls.global_context(g: "g")
-    Scrolls.log(o: "o") do
-      Scrolls.context(c: "c") do
-        Scrolls.log(ic: "i")
+    Scrolls.global_context(:g => "g")
+    Scrolls.log(:o => "o") do
+      Scrolls.context(:c => "c") do
+        Scrolls.log(:ic => "i")
       end
-      Scrolls.log(i: "i")
+      Scrolls.log(:i => "i")
     end
     @out.truncate(37)
     output = "g=g o=o at=start\ng=g c=c ic=i\ng=g i=i"
@@ -56,11 +59,11 @@ class TestScrolls < Test::Unit::TestCase
   end
 
   def test_deeply_nested_context
-    Scrolls.log(o: "o") do
-      Scrolls.context(c: "c") do
-        Scrolls.log(ic: "i")
+    Scrolls.log(:o => "o") do
+      Scrolls.context(:c => "c") do
+        Scrolls.log(:ic => "i")
       end
-      Scrolls.log(i: "i")
+      Scrolls.log(:i => "i")
     end
     @out.truncate(21)
     output = "o=o at=start\nc=c ic=i"
@@ -68,11 +71,11 @@ class TestScrolls < Test::Unit::TestCase
   end
 
   def test_deeply_nested_context_dropped
-    Scrolls.log(o: "o") do
-      Scrolls.context(c: "c") do
-        Scrolls.log(ic: "i")
+    Scrolls.log(:o => "o") do
+      Scrolls.context(:c => "c") do
+        Scrolls.log(:ic => "i")
       end
-      Scrolls.log(i: "i")
+      Scrolls.log(:i => "i")
     end
     @out.truncate(25)
     output = "o=o at=start\nc=c ic=i\ni=i"
@@ -81,12 +84,12 @@ class TestScrolls < Test::Unit::TestCase
 
   def test_context_after_exception
     begin
-      Scrolls.context(c: 'c') do
+      Scrolls.context(:c => 'c') do
         raise "Error from inside of context"
       end
       fail "Exception did not escape context block"
     rescue => e
-      Scrolls.log(o: 'o')
+      Scrolls.log(:o => 'o')
       assert_equal "o=o\n", @out.string
     end
   end
@@ -107,12 +110,12 @@ class TestScrolls < Test::Unit::TestCase
   end
 
   def test_logging
-    Scrolls.log(test: "basic")
+    Scrolls.log(:test => "basic")
     assert_equal "test=basic\n", @out.string
   end
 
   def test_logging_block
-    Scrolls.log(outer: "o") { Scrolls.log(inner: "i") }
+    Scrolls.log(:outer => "o") { Scrolls.log(:inner => "i") }
     output = "outer=o at=start\ninner=i\nouter=o at=finish elapsed=0.000\n"
     assert_equal output, @out.string
   end
@@ -121,7 +124,7 @@ class TestScrolls < Test::Unit::TestCase
     begin
       raise Exception
     rescue Exception => e
-      Scrolls.log_exception({test: "exception"}, e)
+      Scrolls.log_exception({:test => "exception"}, e)
     end
 
     oneline_backtrace = @out.string.gsub("\n", 'XX')
@@ -129,4 +132,19 @@ class TestScrolls < Test::Unit::TestCase
     assert_match /test=exception at=exception.*test_log_exception.*XX.*minitest/,
       oneline_backtrace
   end
+
+  def test_syslog_integration
+    Scrolls.stream = 'syslog'
+    assert_equal Scrolls::SyslogLogger, Scrolls.stream.class
+  end
+
+  def test_syslog_facility
+    Scrolls.stream = 'syslog'
+    assert_equal Syslog::LOG_USER, Scrolls.facility
+  end
+
+  def test_setting_syslog_facility
+    Scrolls.facility = "local7"
+    assert_equal Syslog::LOG_LOCAL7, Scrolls.facility
+  end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrolls
 version: !ruby/object:Gem::Version
-  version: 0.2.7
-  prerelease: 
+  version: 0.2.8
 platform: ruby
 authors:
 - Curt Micol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies: []
 description: Logging, easier, more consistent.
 email:
@@ -28,6 +27,7 @@ files:
 - lib/scrolls/atomic.rb
 - lib/scrolls/log.rb
 - lib/scrolls/parser.rb
+- lib/scrolls/syslog.rb
 - lib/scrolls/utils.rb
 - lib/scrolls/version.rb
 - scrolls.gemspec
@@ -37,27 +37,26 @@ files:
 - test/test_scrolls.rb
 homepage: https://github.com/asenchi/scrolls
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: When do we log? All the time.
 test_files:
 - test/test_atomic.rb