moon-logfmt 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5c64d365719d9a645530f96a230a949d7dbb1f6
-  data.tar.gz: cbb71702fa16336bb4e0c0f04fed3b02de64508a
+  metadata.gz: bf7bce0bbd2512b2887937c51043c1d86b40c8a6
+  data.tar.gz: faf1d207712d2b8d577e072b259a0a58d94890c9
 SHA512:
-  metadata.gz: bf70cd0b1bd2650727e5b48232b0dd8eb762d6510400a717213b508f600e7e26c5fbf4d883833204de4444055740639e9706d91c1669e870cfa8eaab0d8c78f4
-  data.tar.gz: 478514355e11f0832544701c98d353910c5ad59e12ed3ad1effb5321ad66a91f94d753b49db061ec2207536a0df6c528625ef566be04a08944b6168f3c461c41
+  metadata.gz: 55970381b1653d84739073f4094f873369ab11bf13b06b18970d969cdcf8b8e2b631e91d487d801a9f21bc158a64de198cf4b4907968b0692f7cb37e76c7a65c
+  data.tar.gz: 778625cfca5db64c496091b4451c2de2dbba28eb89d288885fca10cbaf8e4b2e6eb434761dbfebd4160388b1dd192593fb8538b7a214a8f8c2da85450e421fe6

data/lib/moon-logfmt/formatter.rb

@@ -0,0 +1,10 @@
+module Moon
+  module Logfmt
+    # Default KEY=VALUE formatter
+    #
+    # @param [String] key
+    # @param [String] value
+    # @return [String]
+    FORMATTER = ->(key, value) { "#{key}=#{value}" }
+  end
+end

data/lib/moon-logfmt/logfmt.rb

@@ -1,36 +1,22 @@
-require 'moon-null_io/null_io'
+require 'moon-logfmt/logger'
+require 'moon-logfmt/null_logger'
 
 module Moon
   # Implementation of logfmt for 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
-
     # 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[a-zA-Z0-9\.\-\_\,\:\;\/]*\z/i
+    UNESCAPED_STRING = /\A[\w\.\-\+\%\_\,\:\;\/]*\z/i
 
-    # Formats provided data in a logfmt format.
+    # Escapes the context values and yields the result.
     #
     # @param [Hash<[String, Symbol], String>] data
-    # @return [String]
-    def self.format_context(data)
-      data.map do |pair|
-        key, value = *pair
+    # @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(',')
@@ -38,146 +24,13 @@ module Moon
           value = value.to_s
         end
         value = value.dump unless value =~ UNESCAPED_STRING
-        "#{key}=#{value}"
-      end.join(' ')
-    end
-
-    # Basic Logger class for Logfmt writing
-    # The main functions are #write and #new
-    # #new will copy the current logger and append its context data
-    class Logger
-      include Severity
-
-      # The underlaying IO to write to, the default is STDOUT
-      # @return [IO, #puts]
-      attr_accessor :io
-      # Whether to prepend timestamps to the logs
-      # @return [Boolean]
-      attr_accessor :timestamp
-      # Context related data, this protected, don't even think of using it.
-      # @return [Hash<[String, Symbol], String>]
-      attr_accessor :context
-      protected :context
-      protected :context=
-
-      # @param [Hash<[String, Symbol], String>] data
-      def initialize(data = {})
-        @io = STDOUT
-        @context = data
-        @timestamp = true
-      end
-
-      # @param [Logfmt::Logger] org
-      # @return [self]
-      def initialize_copy(org)
-        @io = org.io
-        @timestamp = org.timestamp
-        @context = org.context.dup
-        self
-      end
-
-      # Formats the provided context data
-      #
-      # @param [Hash<[String, Symbol], String>] data
-      # @return [String]
-      private def format_context(data)
-        Logfmt.format_context data
-      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
-      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)))
-      end
-
-      # @!group std Logger interface
-      # @param [Severity] severity
-      # @param [String, nil] message
-      # @param [String, nil] progname
-      # @yieldreturn [String] message
-      def add(severity, message = nil, progname = nil, &block)
-        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
-      end
-      alias :log :add
-
-      # Logs a message
-      #
-      # @overload info(message)
-      #   @param [String] message
-      # @overload info(progname, &block)
-      #   @param [String] progname
-      #   @yieldreturn [String] message
-      def info(progname = nil, &block)
-        add(INFO, nil, progname, &block)
-      end
-
-      # See {#info} for more information.
-      # (see #info)
-      def debug(progname = nil, &block)
-        add(DEBUG, nil, progname, &block)
-      end
-
-      # See {#info} for more information.
-      # (see #info)
-      def error(progname = nil, &block)
-        add(ERROR, nil, progname, &block)
-      end
-
-      # See {#info} for more information.
-      # (see #info)
-      def fatal(progname = nil, &block)
-        add(FATAL, nil, progname, &block)
-      end
-
-      # See {#info} for more information.
-      # (see #info)
-      def unknown(progname = nil, &block)
-        add(UNKNOWN, nil, progname, &block)
-      end
-
-      # See {#info} for more information.
-      # (see #info)
-      def warn(progname = nil, &block)
-        add(WARN, nil, progname, &block)
-      end
-      # @!endgroup
-
-      # Creates a new context by forking the current logger
-      #
-      # @param [Hash<[Symbol, String], String>] data
-      def new(data)
-        dup.tap { |l| l.context.merge!(data) }
+        yield key.to_s, value
       end
     end
 
-    NullLogger = Logger.new
-    NullLogger.io = NullIO::OUT
+    # (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

@@ -0,0 +1,89 @@
+require 'moon-logfmt/stdlib_loggable'
+require 'moon-logfmt/formatter'
+
+module Moon
+  module Logfmt
+    # Basic Logger class for Logfmt writing
+    # The main functions are #write and #new
+    # #new will copy the current logger and append its context data
+    class Logger
+      include StdlibLoggable
+
+      # The underlaying IO to write to, the default is STDOUT
+      # @return [IO, #puts]
+      attr_accessor :io
+
+      # A function which takes a key and value string and produces a string
+      # @return [Proc]
+      attr_accessor :formatter
+
+      # Whether to prepend timestamps to the logs
+      # @return [Boolean]
+      attr_accessor :timestamp
+
+      # Context related data, this protected, don't even think of using it.
+      # @return [Hash<[String, Symbol], String>]
+      attr_accessor :context
+      protected :context
+      protected :context=
+
+      # @param [Hash<[String, Symbol], String>] data
+      def initialize(data = {})
+        @io = STDOUT
+        @formatter = FORMATTER
+        @context = data
+        @timestamp = true
+      end
+
+      # @param [Logfmt::Logger] org
+      # @return [self]
+      def initialize_copy(org)
+        @io = org.io
+        @timestamp = org.timestamp
+        @context = org.context.dup
+        @formatter = org.formatter
+        self
+      end
+
+      # Formats the provided context data
+      #
+      # @param [Hash<[String, Symbol], String>] data
+      # @return [String]
+      private def format_context(data)
+        str = []
+        Logfmt.escape_context_data data do |key, value|
+          str << @formatter.call(key, value)
+        end
+        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
+      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)))
+      end
+
+      # Creates a new context by forking the current logger
+      #
+      # @param [Hash<[Symbol, String], String>] data
+      def new(data)
+        dup.tap { |l| l.context.merge!(data) }
+      end
+    end
+  end
+end

data/lib/moon-logfmt/null_logger.rb

@@ -0,0 +1,9 @@
+require 'moon-null_io/null_io'
+require 'moon-logfmt/logger'
+
+module Moon
+  module Logfmt
+    NullLogger = Logger.new
+    NullLogger.io = NullIO::OUT
+  end
+end

data/lib/moon-logfmt/stdlib_loggable.rb

@@ -0,0 +1,88 @@
+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
+      # @param [Severity] severity
+      # @param [String, nil] message
+      # @param [String, nil] progname
+      # @yieldreturn [String] message
+      def add(severity, message = nil, progname = nil, &block)
+        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
+      end
+      alias :log :add
+
+      # Logs a message
+      #
+      # @overload info(message)
+      #   @param [String] message
+      # @overload info(progname, &block)
+      #   @param [String] progname
+      #   @yieldreturn [String] message
+      def info(progname = nil, &block)
+        add(INFO, nil, progname, &block)
+      end
+
+      # See {#info} for more information.
+      # (see #info)
+      def debug(progname = nil, &block)
+        add(DEBUG, nil, progname, &block)
+      end
+
+      # See {#info} for more information.
+      # (see #info)
+      def error(progname = nil, &block)
+        add(ERROR, nil, progname, &block)
+      end
+
+      # See {#info} for more information.
+      # (see #info)
+      def fatal(progname = nil, &block)
+        add(FATAL, nil, progname, &block)
+      end
+
+      # See {#info} for more information.
+      # (see #info)
+      def unknown(progname = nil, &block)
+        add(UNKNOWN, nil, progname, &block)
+      end
+
+      # See {#info} for more information.
+      # (see #info)
+      def warn(progname = nil, &block)
+        add(WARN, nil, progname, &block)
+      end
+      # @!endgroup
+    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, 1, nil
+      MAJOR, MINOR, TEENY, PATCH = 1, 0, 2, nil
       # @return [String]
       STRING = [MAJOR, MINOR, TEENY, PATCH].compact.join('.')
     end

data/spec/logfmt_spec.rb

@@ -2,10 +2,10 @@ require 'spec_helper'
 require 'moon-logfmt/logfmt'
 
 describe Moon::Logfmt do
-  context '.format_context' do
+  context '.escape_context_data' do
     it 'formats a Hash to a String' do
-      actual = described_class.format_context(msg: 'Hello World', nums: [1, 2, 3])
-      expect(actual).to eq('msg="Hello World" nums=1,2,3')
+      actual = described_class.escape_context_data(msg: 'Hello World', nums: [1, 2, 3]).to_a
+      expect(actual).to eq([['msg', '"Hello World"'], ['nums', '1,2,3']])
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moon-logfmt
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Blaž Hrastnik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: moon-null_io
@@ -130,9 +130,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/moon-logfmt/_basalt.rb
+- lib/moon-logfmt/formatter.rb
 - lib/moon-logfmt/load.rb
 - lib/moon-logfmt/logfmt.rb
+- lib/moon-logfmt/logger.rb
+- lib/moon-logfmt/null_logger.rb
 - lib/moon-logfmt/pkg.yml
+- lib/moon-logfmt/stdlib_loggable.rb
 - lib/moon-logfmt/version.rb
 - spec/logfmt_spec.rb
 - spec/logger_spec.rb
@@ -157,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: An implementation of Logfmt encoding.