moon-logfmt 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39f8167fa92c462fbf0dbcf43d839dbf7a1b5096
-  data.tar.gz: 9d77f73ced138f99307ffab5ee5976808f8be3e7
+  metadata.gz: ad3d92684b23cd251495e9723dddbcd87db16ae8
+  data.tar.gz: e393c13c1f7c40e8d64313cf48d2826f93ae82a4
 SHA512:
-  metadata.gz: dcc9a60b418ec171809621f3efcd5731c263bcb1b40b7dbc832aa8b35fcf1dd049b05fc3117e16b3e46b34796a56d1f92a19f83112bd7c0ca45395c71e76d725
-  data.tar.gz: 1274ccb323dc4184f0329355b37dfe275f6b331fedb2bc33211667d0bf4674cb245220d00b6a9109dfc4d93e372dec4acfbb9460643ff0cb618bb07b815998d4
+  metadata.gz: ce0188e6c9f29a7a43f33648d460b2b66bd088b0f2bd14afb1eb9f6c24af87582f92925f657e06e72fb5a9679ef74e09d681cf7b2967e0eb795af51f921aad94
+  data.tar.gz: f81eca8be731925137a3777842e74d75ad727dfe0b95f339ca2e5f3a13e952a5ccf747a3376fbd4ab293eecdc2e4abe3f0cb9598426a1d488fe52cdda7ecb79c

data/lib/moon-logfmt/formatter.rb

@@ -1,10 +1,39 @@
 module Moon
   module Logfmt
-    # Default KEY=VALUE formatter
-    #
-    # @param [String] key
-    # @param [String] value
-    # @return [String]
-    FORMATTER = ->(key, value) { "#{key}=#{value}" }
+    # Identity Formatter, this was created to interact with the stdlib
+    # Logger::Formatter
+    class Formatter
+      # @return [String] message
+      def call(severity, time, progname, msg)
+        msg
+      end
+
+      # Returns the default instance of the formatter
+      #
+      # @return [Formatter]
+      def self.default
+        @default ||= new
+      end
+    end
+
+    # Logfmt's actual formatter, this takes a key and a value and produces
+    # a string
+    class KeyValueFormatter
+      # Default KEY=VALUE formatter
+      #
+      # @param [String] key
+      # @param [String] value
+      # @return [String]
+      def call(key, value)
+        "#{key}=#{value}"
+      end
+
+      # Returns the default instance of the key value formatter
+      #
+      # @return [KeyValueFormatter]
+      def self.default
+        @default ||= new
+      end
+    end
   end
 end

data/lib/moon-logfmt/logfmt.rb

@@ -1,36 +1,2 @@
 require 'moon-logfmt/logger'
 require 'moon-logfmt/null_logger'
-
-module Moon
-  # Implementation of logfmt for Moon
-  module Logfmt
-    # Regular expression used for checking strings that may need escaping.
-    # This regular expression will validate true if the string doesn't need
-    # escaping.
-    UNESCAPED_STRING = /\A[\w\.\-\+\%\_\,\:\;\/]*\z/i
-
-    # Escapes the context values and yields the result.
-    #
-    # @param [Hash<[String, Symbol], String>] data
-    # @yieldparam [String] key
-    # @yieldparam [String] value
-    def self.escape_context_data(data)
-      return to_enum :escape_context_data, data unless block_given?
-      data.each_pair do |key, value|
-        case value
-        when Array
-          value = value.join(',')
-        else
-          value = value.to_s
-        end
-        value = value.dump unless value =~ UNESCAPED_STRING
-        yield key.to_s, value
-      end
-    end
-
-    # (see Moon::Logfmt::Logger#initialize)
-    def self.new(*args, &block)
-      Moon::Logfmt::Logger.new(*args, &block)
-    end
-  end
-end

data/lib/moon-logfmt/logger.rb

@@ -1,5 +1,6 @@
 require 'moon-logfmt/stdlib_loggable'
 require 'moon-logfmt/formatter'
+require 'moon-logfmt/utils'
 
 module Moon
   module Logfmt
@@ -8,6 +9,11 @@ module Moon
     # #new will copy the current logger and append its context data
     class Logger
       include StdlibLoggable
+      include Severity
+
+      # The default datetime string format
+      # @return [String]
+      DEFAULT_DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%S%Z'.freeze
 
       # The underlaying IO to write to, the default is STDOUT
       # @return [IO, #puts]
@@ -15,6 +21,10 @@ module Moon
 
       # A function which takes a key and value string and produces a string
       # @return [Proc]
+      attr_accessor :key_value_formatter
+
+      # A function which takes the final context string and formats it
+      # @return [Proc]
       attr_accessor :formatter
 
       # Whether to prepend timestamps to the logs
@@ -30,52 +40,91 @@ module Moon
       # @param [Hash<[String, Symbol], String>] data
       def initialize(data = {})
         @io = STDOUT
-        @formatter = FORMATTER
+        @formatter = Formatter.default
+        @key_value_formatter = KeyValueFormatter.default
         @context = data
         @timestamp = true
+        @level = Moon::Logfmt::Severity::DEBUG
+        @datetime_format = DEFAULT_DATETIME_FORMAT
+      end
+
+      attr_reader :level
+
+      # @param [Symbol]
+      def level=(lvl)
+        @level = Moon::Logfmt.determine_loglevel_from_object(lvl)
       end
 
       # @param [Logfmt::Logger] org
       # @return [self]
       def initialize_copy(org)
         @io = org.io
+        @level = org.level
         @timestamp = org.timestamp
         @context = org.context.dup
         @formatter = org.formatter
+        @key_value_formatter = org.key_value_formatter
         self
       end
 
+      # @param [Integer] severity
+      # @return [Symbol]
+      private def severity_to_symbol(severity)
+        case severity
+        when DEBUG   then :debug
+        when INFO    then :info
+        when WARN    then :warn
+        when ERROR   then :error
+        when FATAL   then :fatal
+        when UNKNOWN then :unknown
+        else
+          severity.to_s
+        end
+      end
+
+      # Adds timestamp information to the provided data
+      #
+      # @param [Hash<Symbol, Object>] data  to add timestamp to
+      # @return [Hash] data given
+      private def timestamp_context(data)
+        data.tap { |d| d[:now] = Time.now.strftime(@datetime_format) }
+      end
+
       # Formats the provided context data
       #
       # @param [Hash<[String, Symbol], String>] data
       # @return [String]
-      private def format_context(data)
+      private def format_context(severity, time, progname, ctx)
+        data = {}
+        data[:level] = severity_to_symbol(severity) if severity
+        timestamp_context(data) if @timestamp
+        data[:progname] = progname if progname
+        data.merge!(ctx)
         str = []
         Logfmt.escape_context_data data do |key, value|
-          str << @formatter.call(key, value)
+          str << @key_value_formatter.call(key, value)
         end
-        str.join(' ')
+        @formatter.call(severity, time, progname, str.join(' '))
       end
 
-      # Adds timestamp information to the provided data
-      #
-      # @param [Hash<Symbol, Object>] data  to add timestamp to
-      # @return [Hash] data given
-      private def timestamp_context(data)
-        t = Time.now
-        fmt = '%04d-%02d-%02dT%02d:%02d:%02d%s'
-        s = sprintf(fmt, t.year, t.mon, t.day, t.hour, t.min, t.sec, t.zone)
-        data[:now] = s
-        data
+      protected def write_to_logdev(str)
+        @io.puts str
+      end
+
+      # Writes a new context line to the logdev
+      # @param [Integer] severity
+      # @param [Time] time
+      # @param [String] progname
+      # @param [Hash] ctx
+      protected def write_context(severity, time, progname, ctx)
+        write_to_logdev format_context(severity, time, progname, context.merge(ctx))
       end
 
       # Writes a new log line
       #
       # @param [Hash<[String, Symbol], String>] data
       def write(data)
-        pre = {}
-        timestamp_context(pre) if @timestamp
-        @io.puts format_context(pre.merge(context.merge(data)))
+        write_context nil, Time.now, nil, data
       end
 
       # Creates a new context by forking the current logger

data/lib/moon-logfmt/severity.rb

@@ -0,0 +1,19 @@
+module Moon
+  module Logfmt
+    # Logging severity.
+    module Severity
+      # Low-level information, mostly for developers.
+      DEBUG = 0
+      # Generic (useful) information about system operation.
+      INFO = 1
+      # A warning.
+      WARN = 2
+      # A handleable error condition.
+      ERROR = 3
+      # An unhandleable error that results in a program crash.
+      FATAL = 4
+      # An unknown message that should always be logged.
+      UNKNOWN = 5
+    end
+  end
+end

data/lib/moon-logfmt/stdlib_loggable.rb

@@ -1,54 +1,38 @@
+require 'moon-logfmt/severity'
+
 module Moon
   module Logfmt
-    # Logging severity.
-    module Severity
-      # Low-level information, mostly for developers.
-      DEBUG = 0
-      # Generic (useful) information about system operation.
-      INFO = 1
-      # A warning.
-      WARN = 2
-      # A handleable error condition.
-      ERROR = 3
-      # An unhandleable error that results in a program crash.
-      FATAL = 4
-      # An unknown message that should always be logged.
-      UNKNOWN = 5
-    end
-
     # Interface for the stdlib Logger class
     module StdlibLoggable
       include Severity
 
       # @!group std Logger interface
+
+      # Adds a new logger message
+      #
       # @param [Severity] severity
       # @param [String, nil] message
       # @param [String, nil] progname
       # @yieldreturn [String] message
       def add(severity, message = nil, progname = nil, &block)
+        return if severity < @level
         message = message || (block && block.call)
         msg = message || progname
         data = {}
-        data[:progname] = progname if progname && message
-        data[case severity
-          when DEBUG then :debug
-          when ERROR then :error
-          when FATAL then :fatal
-          when INFO then :msg
-          when UNKNOWN then :msg
-          when WARN then :warn
-          end] = msg
-        write data
+        msg.is_a?(Hash) ? data.merge!(msg) : data.store(:msg, msg)
+        write_context(severity, Time.now, progname, data)
       end
       alias :log :add
 
       # Logs a message
       #
+      # @overload info(data)
+      #   @param [Hash] data - data to log
       # @overload info(message)
-      #   @param [String] message
+      #   @param [String] message - message to log
       # @overload info(progname, &block)
-      #   @param [String] progname
-      #   @yieldreturn [String] message
+      #   @param [String] progname - program name
+      #   @yieldreturn [String] message - message to log
       def info(progname = nil, &block)
         add(INFO, nil, progname, &block)
       end

data/lib/moon-logfmt/utils.rb

@@ -0,0 +1,53 @@
+require 'moon-logfmt/severity'
+
+module Moon
+  # Implementation of logfmt for Moon
+  module Logfmt
+    # Regular expression used for checking strings that may need escaping.
+    # This regular expression will validate true if the string doesn't need
+    # escaping.
+    UNESCAPED_STRING = /\A[\w\.\-\+\%\_\,\:\;\/]*\z/i
+
+    # Escapes the context values and yields the result.
+    #
+    # @param [Hash<[String, Symbol], String>] data
+    # @yieldparam [String] key
+    # @yieldparam [String] value
+    def self.escape_context_data(data)
+      return to_enum :escape_context_data, data unless block_given?
+      data.each_pair do |key, value|
+        case value
+        when Array
+          value = value.join(',')
+        else
+          value = value.to_s
+        end
+        value = value.dump unless value =~ UNESCAPED_STRING
+        yield key.to_s, value
+      end
+    end
+
+    # Determines what the loglevel should be from the given object
+    #
+    # @param [Object] object
+    # @return [Integer] loglevel
+    def self.determine_loglevel_from_object(object)
+      return object if object.is_a?(Integer)
+      case object.to_s.upcase
+      when 'DEBUG'   then Moon::Logfmt::Severity::DEBUG
+      when 'INFO'    then Moon::Logfmt::Severity::INFO
+      when 'WARN'    then Moon::Logfmt::Severity::WARN
+      when 'ERROR'   then Moon::Logfmt::Severity::ERROR
+      when 'FATAL'   then Moon::Logfmt::Severity::FATAL
+      when 'UNKNOWN' then Moon::Logfmt::Severity::UNKNOWN
+      else
+        raise ArgumentError, "unknown log level #{object}"
+      end
+    end
+
+    # (see Moon::Logfmt::Logger#initialize)
+    def self.new(*args, &block)
+      Moon::Logfmt::Logger.new(*args, &block)
+    end
+  end
+end

data/lib/moon-logfmt/version.rb

@@ -3,7 +3,7 @@ module Moon
     # Version module
     module Version
       # @return [Integer, nil]
-      MAJOR, MINOR, TEENY, PATCH = 1, 0, 3, nil
+      MAJOR, MINOR, TEENY, PATCH = 1, 1, 0, nil
       # @return [String]
       STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.')
     end

data/spec/logfmt_spec.rb

@@ -2,6 +2,13 @@ require 'spec_helper'
 require 'moon-logfmt/logfmt'
 
 describe Moon::Logfmt do
+  context '.new' do
+    it 'creates a new Logger instance' do
+      logger = described_class.new
+      expect(logger).to be_instance_of(Moon::Logfmt::Logger)
+    end
+  end
+
   context '.escape_context_data' do
     it 'formats a Hash to a String' do
       actual = described_class.escape_context_data(msg: 'Hello World', nums: [1, 2, 3]).to_a

data/spec/logger_spec.rb

@@ -32,40 +32,81 @@ describe Moon::Logfmt::Logger do
     end
   end
 
-  context '#info' do
-    it 'writes a basic message' do
-      null_logger.info 'Test Test Test'
+  context 'std logger interface' do
+    context '#level=' do
+      it 'will accept symbols' do
+        null_logger.level = :debug
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::DEBUG)
+
+        null_logger.level = :info
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::INFO)
+
+        null_logger.level = :warn
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::WARN)
+
+        null_logger.level = :error
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::ERROR)
+
+        null_logger.level = :fatal
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::FATAL)
+
+        null_logger.level = :unknown
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::UNKNOWN)
+      end
+
+      it 'will accept strings' do
+        null_logger.level = 'debug'
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::DEBUG)
+      end
+
+      it 'will accept integers' do
+        null_logger.level = 0
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::DEBUG)
+
+        null_logger.level = 5
+        expect(null_logger.level).to eq(Moon::Logfmt::Severity::UNKNOWN)
+      end
+
+      it 'will fail given an invalid level' do
+        expect { null_logger.level = :something }.to raise_error(ArgumentError)
+      end
     end
-  end
 
-  context '#debug' do
-    it 'writes a debug message' do
-      null_logger.debug { 'Test Test Test' }
+    context '#info' do
+      it 'writes a basic message' do
+        null_logger.info 'Test Test Test'
+      end
     end
-  end
 
-  context '#warn' do
-    it 'writes a warning message' do
-      null_logger.warn { 'Test Test Test' }
+    context '#debug' do
+      it 'writes a debug message' do
+        null_logger.debug { 'Test Test Test' }
+      end
     end
-  end
 
-  context '#error' do
-    it 'writes a warning message' do
-      null_logger.error('testapp') { 'Test Test Test' }
+    context '#warn' do
+      it 'writes a warning message' do
+        null_logger.warn { 'Test Test Test' }
+      end
     end
-  end
 
-  context '#fatal' do
-    it 'writes a fatal message' do
-      null_logger.fatal 'AND I DIED'
+    context '#error' do
+      it 'writes a warning message' do
+        null_logger.error('testapp') { 'Test Test Test' }
+      end
+    end
+
+    context '#fatal' do
+      it 'writes a fatal message' do
+        null_logger.fatal 'AND I DIED'
+      end
     end
-  end
 
-  context '#warn' do
-    it 'writes a unknown message' do
-      # more like a spooky message
-      null_logger.unknown { 'Spoooooky' }
+    context '#warn' do
+      it 'writes a unknown message' do
+        # more like a spooky message
+        null_logger.unknown { 'Spoooooky' }
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moon-logfmt
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Blaž Hrastnik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: moon-null_io
@@ -142,7 +142,9 @@ files:
 - lib/moon-logfmt/logger.rb
 - lib/moon-logfmt/null_logger.rb
 - lib/moon-logfmt/pkg.yml
+- lib/moon-logfmt/severity.rb
 - lib/moon-logfmt/stdlib_loggable.rb
+- lib/moon-logfmt/utils.rb
 - lib/moon-logfmt/version.rb
 - spec/logfmt_spec.rb
 - spec/logger_spec.rb