scrolls 0.3.9 → 0.9.3

data/lib/scrolls.rb

@@ -1,6 +1,4 @@
-require "thread"
-require "scrolls/atomic"
-require "scrolls/log"
+require "scrolls/logger"
 require "scrolls/version"
 
 module Scrolls
@@ -8,33 +6,27 @@ module Scrolls
 
   # Public: Initialize a Scrolls logger
   #
-  # Convienence method to prepare for future releases. Currently mimics
-  # behavior found in other methods. This prepares the developer for a future
-  # backward incompatible change, see:
-  # https://github.com/asenchi/scrolls/pull/54
-  #
   # options - A hash of key/values for configuring Scrolls
-  #
-  def init(options)
-    stream     = options.fetch(:stream, STDOUT)
-    facility   = options.fetch(:facility, Syslog::LOG_USER)
-    time_unit  = options.fetch(:time_unit, "seconds")
-    timestamp  = options.fetch(:timestamp, false)
-    exceptions = options.fetch(:exceptions, "multi")
-    global_ctx = options.fetch(:global_context, {})
-
-    Log.stream    = stream
-    Log.facility  = facility if facility
-    Log.time_unit = time_unit unless time_unit == "seconds"
-    Log.add_timestamp = timestamp unless timestamp == false
-
-    if exceptions == "single"
-      Log.single_line_exceptions = true
-    end
+  #   stream         - Stream to output data (default: STDOUT)
+  #   log_facility   - Syslog facility (default: Syslog::LOG_USER)
+  #   time_unit      - Unit of time (default: seconds)
+  #   timestamp      - Prepend logs with a timestamp (default: false)
+  #   exceptions     - Method for outputting exceptions (default: single line)
+  #   global_context - Immutable context to prepend all messages with
+  #   syslog_options - Syslog options (default: Syslog::LOG_PID|Syslog::LOG_CONS)
+  #   escape_keys    - Escape chars in keys
+  #   strict_logfmt  - Always use double quotes to quote values
+  #
+  def init(options={})
+    # Set a hint whether #init was called.
+    @initialized = true
+    @log = Logger.new(options)
+  end
 
-    unless global_ctx == {}
-      Log.global_context = global_ctx
-    end
+  # Public: Get the primary logger
+  #
+  def logger
+    @log.logger
   end
 
   # Public: Set a context in a block for logs
@@ -45,37 +37,13 @@ module Scrolls
   # Examples:
   #
   def context(data, &blk)
-    Log.with_context(data, &blk)
-  end
-
-  # Deprecated: Get or set a global context that prefixs all logs
-  #
-  # data - A hash of key/values to prepend to each log
-  #
-  # This method will be deprecated two releases after 0.3.8.
-  # See https://github.com/asenchi/scrolls/releases/tag/v0.3.8
-  # for more details.
-  #
-  def global_context(data=nil)
-    $stderr.puts "global_context() will be deprecated after v0.3.8, please see https://github.com/asenchi/scrolls for more information."
-    if data
-      Log.global_context = data
-    else
-      Log.global_context
-    end
+    @log.with_context(data, &blk)
   end
 
-  # Deprecated: Get or set a global context that prefixs all logs
-  #
-  # data - A hash of key/values to prepend to each log
-  #
-  # This method will be deprecated two releases after 0.3.8.
-  # See https://github.com/asenchi/scrolls/releases/tag/v0.3.8
-  # for more details.
+  # Public: Get the global context that prefixs all logs
   #
-  def add_global_context(data)
-    $stderr.puts "add_global_context will be deprecated after v0.3.8, please see https://github.com/asenchi/scrolls for more information."
-    Log.add_global_context(data)
+  def global_context
+    @log.global_context
   end
 
   # Public: Log data and/or wrap a block with start/finish
@@ -96,26 +64,32 @@ module Scrolls
   #   => nil
   #
   def log(data, &blk)
-    Log.log(data, &blk)
+    # Allows us to call #log directly and initialize defaults
+    @log = Logger.new({}) unless @initialized
+
+    @log.log(data, &blk)
   end
 
   # Public: Log an exception
   #
-  # data - A hash of key/values to log
   # e    - An exception to pass to the logger
+  # data - A hash of key/values to log
   #
   # Examples:
   #
   #   begin
   #     raise Exception
   #   rescue Exception => e
-  #     Scrolls.log_exception({test: "test"}, e)
+  #     Scrolls.log_exception(e, {test: "test"})
   #   end
   #   test=test at=exception class=Exception message=Exception exception_id=70321999017240
   #   ...
   #
-  def log_exception(data, e)
-    Log.log_exception(data, e)
+  def log_exception(e, data)
+    # Allows us to call #log directly and initialize defaults
+    @log = Logger.new({}) unless @initialized
+
+    @log.log_exception(e, data)
   end
 
   # Public: Setup a logging facility (default: Syslog::LOG_USER)
@@ -127,7 +101,7 @@ module Scrolls
   #   Scrolls.facility = Syslog::LOG_LOCAL7
   #
   def facility=(f)
-    Log.facility=(f)
+    @log.facility=(f)
   end
 
   # Public: Return the Syslog facility
@@ -138,7 +112,7 @@ module Scrolls
   #   => 8
   #
   def facility
-    Log.facility
+    @log.facility
   end
 
   # Public: Setup a new output (default: STDOUT)
@@ -154,7 +128,7 @@ module Scrolls
   #   Scrolls.stream = StringIO.new
   #
   def stream=(out)
-    Log.stream=(out)
+    @log.stream=(out)
   end
 
   # Public: Return the stream
@@ -165,7 +139,7 @@ module Scrolls
   #   => #<IO:<STDOUT>>
   #
   def stream
-    Log.stream
+    @log.stream
   end
 
   # Public: Set the time unit we use for 'elapsed' (default: "seconds")
@@ -177,7 +151,7 @@ module Scrolls
   #   Scrolls.time_unit = "milliseconds"
   #
   def time_unit=(unit)
-    Log.time_unit=(unit)
+    @log.time_unit = unit
   end
 
   # Public: Return the time unit currently configured
@@ -188,7 +162,7 @@ module Scrolls
   #   => "seconds"
   #
   def time_unit
-    Log.time_unit
+    @log.time_unit
   end
 
   # Public: Set whether to include a timestamp (now=<ISO8601>) field in the log
@@ -199,7 +173,7 @@ module Scrolls
   #   Scrolls.add_timestamp = true
   #
   def add_timestamp=(boolean)
-    Log.add_timestamp = boolean
+    @log.timestamp = boolean
   end
 
   # Public: Return whether the timestamp field will be included in the log
@@ -211,7 +185,7 @@ module Scrolls
   #   => true
   #
   def add_timestamp
-    Log.add_timestamp
+    @log.timestamp
   end
 
   # Public: Set whether exceptions should generate a single log
@@ -222,7 +196,7 @@ module Scrolls
   #   Scrolls.single_line_exceptions = true
   #
   def single_line_exceptions=(boolean)
-    Log.single_line_exceptions = boolean
+    @log.exceptions = boolean
   end
 
   # Public: Return whether exceptions generate a single log message.
@@ -233,7 +207,7 @@ module Scrolls
   #   => true
   #
   def single_line_exceptions?
-    Log.single_line_exceptions
+    @log.single_line_exceptions?
   end
 
   # Public: Convience method for Logger replacement
@@ -249,7 +223,7 @@ module Scrolls
   #
   def debug(data, &blk)
     data = data.merge(:level => "debug") if data.is_a?(Hash)
-    Log.log(data, &blk)
+    @log.log(data, &blk)
   end
 
   # Public: Convience method for Logger replacement
@@ -267,7 +241,7 @@ module Scrolls
   #
   def error(data, &blk)
     data = data.merge(:level => "warning") if data.is_a?(Hash)
-    Log.log(data, &blk)
+    @log.log(data, &blk)
   end
 
   # Public: Convience method for Logger replacement
@@ -285,7 +259,7 @@ module Scrolls
   #
   def fatal(data, &blk)
     data = data.merge(:level => "error") if data.is_a?(Hash)
-    Log.log(data, &blk)
+    @log.log(data, &blk)
   end
 
   # Public: Convience method for Logger replacement
@@ -303,7 +277,7 @@ module Scrolls
   #
   def info(data, &blk)
     data = data.merge(:level => "info") if data.is_a?(Hash)
-    Log.log(data, &blk)
+    @log.log(data, &blk)
   end
 
   # Public: Convience method for Logger replacement
@@ -321,7 +295,7 @@ module Scrolls
   #
   def warn(data, &blk)
     data = data.merge(:level => "notice") if data.is_a?(Hash)
-    Log.log(data, &blk)
+    @log.log(data, &blk)
   end
 
   # Public: Convience method for Logger replacement
@@ -339,7 +313,13 @@ module Scrolls
   #
   def unknown(data, &blk)
     data = data.merge(:level => "alert") if data.is_a?(Hash)
-    Log.log(data, &blk)
+    @log.log(data, &blk)
+  end
+
+  # Internal: The Logger initialized by #init
+  #
+  def internal
+    @log
   end
 
 end

data/test/test_helper.rb

@@ -1,6 +1,9 @@
-require "test/unit"
+require "minitest/autorun"
+require "minitest/reporters"
 require "stringio"
 
+Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+
 $: << File.expand_path("../../lib", __FILE__)
 
 require "scrolls"

data/test/test_parser.rb

@@ -1,6 +1,6 @@
-require_relative "test_helper"
+require File.expand_path("../test_helper", __FILE__)
 
-class TestScrollsParser < Test::Unit::TestCase
+class TestScrollsParser < Minitest::Test
   include Scrolls::Parser
 
   def test_parse_bool
@@ -79,6 +79,21 @@ class TestScrollsParser < Test::Unit::TestCase
     assert_equal 't="2012-06-19T16:02:35+01:00"', unparse(data)
   end
 
+  def test_unparse_escape_keys
+    html  = "<p>p</p>"
+    slash = "p/p"
+
+    data = { html => "d", slash => "d" }
+    assert_equal '&lt;p&gt;p&lt;&#x2F;p&gt;=d p&#x2F;p=d',
+      unparse(data, escape_keys=true)
+  end
+
+  def test_unparse_strict_logfmt
+    data = { s: 'echo "hello"' }
+    assert_equal 's="echo \"hello\""', unparse(data, escape_keys=false, strict_logfmt=true)
+    assert_equal data.inspect, parse(unparse(data, escape_keys=false, strict_logfmt=true)).inspect
+  end
+
   def test_parse_time
     time = Time.new(2012, 06, 19, 16, 02, 35, "+01:00")
     string = "t=2012-06-19T16:02:35+01:00"

data/test/test_scrolls.rb

@@ -1,44 +1,35 @@
-require_relative "test_helper"
+require File.expand_path("../test_helper", __FILE__)
 
-class TestScrolls < Test::Unit::TestCase
+class TestScrolls < Minitest::Test
   def setup
     @out = StringIO.new
-    Scrolls.init(:stream => @out)
-  end
-
-  def teardown
-    Scrolls.global_context({})
-    # Reset our syslog context
-    Scrolls.facility = Scrolls::LOG_FACILITY
-    Scrolls.add_timestamp = false
+    Scrolls.init(
+      :stream => @out
+    )
   end
 
-  def test_construct
-    assert_equal Scrolls::IOLog, Scrolls.stream.class
+  def test_default_construct
+    Scrolls.init
+    assert_equal Scrolls::IOLogger, Scrolls.logger.class
   end
 
   def test_default_global_context
+    Scrolls.init(:stream => @out)
     assert_equal Hash.new, Scrolls.global_context
   end
 
   def test_setting_global_context
-    Scrolls.global_context(:g => "g")
-    Scrolls.log(:d => "d")
-    global = @out.string.gsub("\n", 'XX')
-    assert_match /g=g.*d=d/, global
-  end
-  
-  def test_adding_to_global_context
-    Scrolls.global_context(:g => "g")
-    Scrolls.add_global_context(:h => "h")
+    Scrolls.init(
+      :stream => @out,
+      :global_context => {:g => "g"},
+    )
     Scrolls.log(:d => "d")
-    global = @out.string.gsub("\n", 'XX')
-    assert_match /g=g.*h=h.*d=d/, global
+    assert_equal "g=g d=d\n", @out.string
   end
 
   def test_default_context
-    Scrolls.log(:data => "d")
-    assert_equal Hash.new, Scrolls::Log.context
+    Scrolls.log(:d => "d")
+    assert_equal Hash.new, Scrolls.internal.context
   end
 
   def test_setting_context
@@ -48,15 +39,19 @@ class TestScrolls < Test::Unit::TestCase
   end
 
   def test_all_the_contexts
-    Scrolls.global_context(:g => "g")
+    Scrolls.init(
+      :stream => @out,
+      :global_context => {:g => "g"},
+    )
     Scrolls.log(:o => "o") do
       Scrolls.context(:c => "c") do
         Scrolls.log(:ic => "i")
       end
       Scrolls.log(:i => "i")
     end
-    global = @out.string.gsub("\n", 'XX')
-    assert_match /g=g.*at=start.*i=i/, global
+    @out.truncate(37)
+    output = "g=g o=o at=start\ng=g c=c ic=i\ng=g i=i"
+    assert_equal output, @out.string
   end
 
   def test_deeply_nested_context
@@ -89,12 +84,27 @@ class TestScrolls < Test::Unit::TestCase
         raise "Error from inside of context"
       end
       fail "Exception did not escape context block"
-    rescue => e
+    rescue
       Scrolls.log(:o => 'o')
       assert_equal "o=o\n", @out.string
     end
   end
 
+  def test_deeply_nested_context_after_exception
+    Scrolls.log(:o => "o") do
+      begin
+        Scrolls.log(:io => 'io') do
+          raise "Error from inside of nested logging"
+        end
+      rescue
+        Scrolls.log(:o => 'o')
+      end
+    end
+    @out.truncate(124)
+    output = "o=o at=start\nio=io at=start\nio=io at=exception reraise=true class=RuntimeError message=\"Error from inside of nested logging\""
+    assert_equal output, @out.string
+  end
+
   def test_default_time_unit
     assert_equal "seconds", Scrolls.time_unit
   end
@@ -105,8 +115,15 @@ class TestScrolls < Test::Unit::TestCase
   end
 
   def test_setting_incorrect_time_unit
-    assert_raise Scrolls::TimeUnitError do
+    assert_raises Scrolls::TimeUnitError do
       Scrolls.time_unit = "years"
+      Scrolls.log(:tu => "yrs")
+    end
+  end
+
+  def test_unknown_log_level
+    assert_raises Scrolls::LogLevelError do
+      Scrolls.log(:level => "nope")
     end
   end
 
@@ -125,28 +142,28 @@ class TestScrolls < Test::Unit::TestCase
     begin
       raise Exception
     rescue Exception => e
-      Scrolls.log_exception({:test => "exception"}, e)
+      Scrolls.log_exception(e, {:test => "exception"})
     end
 
-    oneline_backtrace = @out.string.gsub("\n", 'XX')
-
-    assert_match /test=exception at=exception.*test_log_exception.*XX/,
-      oneline_backtrace
+    oneline_bt = @out.string.gsub("\n", 'XX')
+    assert_match(/test=exception at=exception.*test_log_exception.*XX/, oneline_bt)
   end
 
-  def test_single_line_exceptions
-    Scrolls.single_line_exceptions = true
+  def test_multi_line_exceptions
+    Scrolls.single_line_exceptions = "multi"
     begin
       raise Exception
     rescue Exception => e
-      Scrolls.log_exception({:o => "o"}, e)
+      Scrolls.log_exception(e, {:o => "o"})
     end
-    assert_equal 1, @out.string.scan(/.*site=.*/).size
+
+    oneline_bt = @out.string.gsub("\n", 'XX')
+    assert_match(/o=o at=exception.*test_multi_line_exceptions.*XX/, oneline_bt)
   end
 
   def test_syslog_integration
     Scrolls.stream = 'syslog'
-    assert_equal Scrolls::SyslogLogger, Scrolls.stream.class
+    assert_equal Scrolls::SyslogLogger, Scrolls.internal.logger.class
   end
 
   def test_syslog_facility
@@ -162,13 +179,7 @@ class TestScrolls < Test::Unit::TestCase
   def test_setting_syslog_facility_after_instantiation
     Scrolls.stream = 'syslog'
     Scrolls.facility = 'local7'
-    assert_match /facility=184/, Scrolls.stream.inspect
-  end
-
-  def test_logging_message_with_syslog
-    Scrolls.stream = 'syslog'
-    Scrolls.facility = 'local7'
-    Scrolls.log "scrolls test"
+    assert_match(/facility=184/, Scrolls.internal.logger.inspect)
   end
 
   def test_add_timestamp

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrolls
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.9.3
 platform: ruby
 authors:
 - Curt Micol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies: []
 description: Logging, easier, more consistent.
 email:
@@ -25,15 +25,13 @@ files:
 - docs/global-context.md
 - docs/syslog.md
 - lib/scrolls.rb
-- lib/scrolls/atomic.rb
-- lib/scrolls/iolog.rb
-- lib/scrolls/log.rb
+- lib/scrolls/iologger.rb
+- lib/scrolls/logger.rb
 - lib/scrolls/parser.rb
-- lib/scrolls/syslog.rb
+- lib/scrolls/sysloglogger.rb
 - lib/scrolls/utils.rb
 - lib/scrolls/version.rb
 - scrolls.gemspec
-- test/test_atomic.rb
 - test/test_helper.rb
 - test/test_parser.rb
 - test/test_scrolls.rb
@@ -56,13 +54,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.2.29
 signing_key: 
 specification_version: 4
 summary: When do we log? All the time.
 test_files:
-- test/test_atomic.rb
 - test/test_helper.rb
 - test/test_parser.rb
 - test/test_scrolls.rb

data/lib/scrolls/atomic.rb

@@ -1,59 +0,0 @@
-require 'thread'
-
-module Scrolls
-  # The result of issues with an update I made to Scrolls. After talking with
-  # Fabio Kung about a fix I started work on an atomic object, but he added some
-  # fixes to #context without it and then used Headius' atomic gem.
-  #
-  # The code below is the start and cleanup of my atomic object. It's slim on
-  # details and eventually cleaned up around inspiration from Headius' code.
-  #
-  # LICENSE: Apache 2.0
-  #
-  # See Headius' atomic gem here:
-  # https://github.com/headius/ruby-atomic
-  class AtomicObject
-    def initialize(o)
-      @mtx = Mutex.new
-      @o = o
-    end
-
-    def get
-      @mtx.synchronize { @o }
-    end
-
-    def set(n)
-      @mtx.synchronize { @o = n }
-    end
-
-    def verify_set(o, n)
-      return false unless @mtx.try_lock
-      begin
-        return false unless @o.equal? o
-        @o = n
-      ensure
-        @mtx.unlock
-      end
-    end
-  end
-
-  class Atomic < AtomicObject
-    def initialize(v=nil)
-      super(v)
-    end
-
-    def value
-      self.get
-    end
-
-    def value=(v)
-      self.set(v)
-      v
-    end
-
-    def update
-      true until self.verify_set(o = self.get, n = yield(o))
-      n
-    end
-  end
-end