moon-logfmt 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5c64d365719d9a645530f96a230a949d7dbb1f6
+  data.tar.gz: cbb71702fa16336bb4e0c0f04fed3b02de64508a
+SHA512:
+  metadata.gz: bf70cd0b1bd2650727e5b48232b0dd8eb762d6510400a717213b508f600e7e26c5fbf4d883833204de4444055740639e9706d91c1669e870cfa8eaab0d8c78f4
+  data.tar.gz: 478514355e11f0832544701c98d353910c5ad59e12ed3ad1effb5321ad66a91f94d753b49db061ec2207536a0df6c528625ef566be04a08944b6168f3c461c41

data/lib/moon-logfmt/_basalt.rb

@@ -0,0 +1 @@
+require 'moon-logfmt/load'

data/lib/moon-logfmt/load.rb

@@ -0,0 +1 @@
+require 'moon-logfmt/logfmt'

data/lib/moon-logfmt/logfmt.rb

@@ -0,0 +1,183 @@
+require 'moon-null_io/null_io'
+
+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
+
+    # Formats provided data in a logfmt format.
+    #
+    # @param [Hash<[String, Symbol], String>] data
+    # @return [String]
+    def self.format_context(data)
+      data.map do |pair|
+        key, value = *pair
+        case value
+        when Array
+          value = value.join(',')
+        else
+          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) }
+      end
+    end
+
+    NullLogger = Logger.new
+    NullLogger.io = NullIO::OUT
+  end
+end

data/lib/moon-logfmt/pkg.yml

@@ -0,0 +1,7 @@
+---
+name: Logfmt
+author: IceDragon200 (Corey Powell) (mistdragon100@gmail.com)
+description: A basic implementation of logfmt.
+require: _basalt.rb
+deps:
+- moon-null_io

data/lib/moon-logfmt/version.rb

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

data/spec/logfmt_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'moon-logfmt/logfmt'
+
+describe Moon::Logfmt do
+  context '.format_context' 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')
+    end
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'moon-logfmt/logfmt'
+
+describe Moon::Logfmt::Logger do
+  let(:null_logger) { @null_logger ||= Moon::Logfmt::NullLogger.new(fn: 'test') }
+
+  context '#initialize' do
+    it 'initializes a new logger without arguments' do
+      logger = described_class.new
+    end
+
+    it 'initializes a new logger with context arguments' do
+      logger = described_class.new fn: 'test'
+
+      expect(logger.send(:context)).to eq(fn: 'test')
+    end
+  end
+
+  context '#initialize_copy' do
+    it 'initializes a copy' do
+      logger = described_class.new fn: 'test'
+      c = logger.dup
+
+      expect(c.send(:context)).to eq(logger.send(:context))
+      expect(c.send(:context)).not_to equal(logger.send(:context))
+    end
+  end
+
+  context '#write' do
+    it 'writes a new log line' do
+      null_logger.write msg: 'Test Test Test'
+    end
+  end
+
+  context '#info' do
+    it 'writes a basic message' do
+      null_logger.info 'Test Test Test'
+    end
+  end
+
+  context '#debug' do
+    it 'writes a debug message' do
+      null_logger.debug { 'Test Test Test' }
+    end
+  end
+
+  context '#warn' do
+    it 'writes a warning message' do
+      null_logger.warn { 'Test Test Test' }
+    end
+  end
+
+  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
+
+  context '#warn' do
+    it 'writes a unknown message' do
+      # more like a spooky message
+      null_logger.unknown { 'Spoooooky' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+Encoding.default_internal = Encoding.default_external = 'UTF-8'
+
+require 'codeclimate-test-reporter'
+require 'simplecov'
+
+CodeClimate::TestReporter.start
+SimpleCov.start
+
+require 'moon-logfmt/load'

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: moon-logfmt
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Blaž Hrastnik
+- Corey Powell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: moon-null_io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An implementation of Logfmt encoding in ruby.
+email: mistdragon100@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/moon-logfmt/_basalt.rb
+- lib/moon-logfmt/load.rb
+- lib/moon-logfmt/logfmt.rb
+- lib/moon-logfmt/pkg.yml
+- lib/moon-logfmt/version.rb
+- spec/logfmt_spec.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/polyfox/moon-logfmt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: An implementation of Logfmt encoding.
+test_files: []
+has_rdoc: