rumbrl 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 454f23a5e4d1da6e787cabe2b3401342497a91d3
-  data.tar.gz: 1f940e971b54e5b8f99284d0cad0b1bdf8f3a509
+  metadata.gz: 20177fee591c71454318f66d334b5eead85f937b
+  data.tar.gz: 2757a19d5b1ef05f63d28cba1ae7155031c7d7a8
 SHA512:
-  metadata.gz: ff0395cf81c81a6478da4f7ecf17b63e639e6156639e2dd6bd37c1ac7d8fe55caa7434bf06b2baae78390f12d6bdf219c3e670c2a05cc468e1d3ca284f40579a
-  data.tar.gz: 41add027e16840152392fa2af81d9695c3c875c3271c4470dd03b7e8dbe22f2aa9674d9d30c9043fc309b76370b9be1a919170de30208b02502458192290f93b
+  metadata.gz: 638033f9fb67cbd181d6f5f62a9981b0efab4a021661e063ac1c970dc28d6c85fd21525f9ed50fbad292c54a6485bfba255d1b7127fa408b548c0b40ba623993
+  data.tar.gz: 5e60535c9e432886c68c1711eb133431b4c6c51673b514f55150019fed931a4cf83ad09b972d65f3ae1d7650053b9fd5c0968e8dc10369864188bf54ed7c5492

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rumbrl (0.4.2)
+    rumbrl (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -46,3 +46,15 @@ Time format (`::Logger#datetime_format`). Defaults to `"[%F %T %z]"`
 #### `LOG_DATA_FORMAT`
 
 How to format log data. Defaults to `[%s] [%s]`
+
+#### `LOG_APP_NAME`
+
+Used by the formatter object to create a KV `APP_NAME=` string in the log entry. Full format is:
+
+```
+APP_NAME="#{ENV['LOG_APP_NAME']}::#{progname}"
+```
+
+Where `progname` is set in your logger.
+
+The formatter is meant to be inherited from, you can implement your own version of `format_msg`. In conjunction with the `Smash` object, you can easily format objects into log entries that are readily consumed by [SumoLogic](https://www.sumologic.com/)

data/lib/rumbrl/formatter.rb

@@ -0,0 +1,45 @@
+require 'logger'
+require 'rumbrl/smash'
+
+module Rumbrl
+  # Log4r formatter
+  class Formatter < ::Logger::Formatter
+    def call(severity, _timestamp, prog, msg)
+      return '' if omit_empty? && empty?(msg)
+
+      "[#{severity}] APP_NAME=#{appname(prog)} #{format_msg(msg)}\n"
+    end
+
+    def omit_empty(switch)
+      if [TrueClass, FalseClass].include? switch.class
+        @omit_empty = switch
+      else
+        @omit_empty = false
+      end
+    end
+
+    def omit_empty?
+      @omit_empty.nil? || @omit_empty
+    end
+
+    # overwrite this to format objects that are passed in
+    def format_msg(msg)
+      "#{msg}"
+    end
+
+    private
+
+    def empty?(obj)
+      obj.respond_to?(:empty?) && obj.empty?
+    end
+
+    def app_namespace
+      ENV.fetch('LOG_APP_NAME', 'RubyApplication')
+    end
+
+    def appname(progname)
+      progname = (progname.nil? || progname.strip.empty?) ? '' : progname.strip
+      (progname.empty?) ? app_namespace : "#{app_namespace}::#{progname}"
+    end
+  end
+end

data/lib/rumbrl/version.rb

@@ -2,5 +2,5 @@
 
 # version const for gem
 module Rumbrl
-  VERSION = '0.4.2'
+  VERSION = '0.5.0'
 end

data/lib/rumbrl.rb

@@ -2,6 +2,7 @@ require 'rumbrl/version'
 
 require 'rumbrl/env'
 require 'rumbrl/factory'
+require 'rumbrl/formatter'
 require 'rumbrl/grumble'
 require 'rumbrl/grumble_factory'
 require 'rumbrl/log'

data/spec/rumbrl/formatter_spec.rb

@@ -0,0 +1,58 @@
+require_relative '../spec_helper'
+
+describe Rumbrl::Formatter do
+  let(:formatter) { Rumbrl::Formatter.new }
+
+  before :each do
+    allow(ENV).to receive(:fetch).and_return 'SPECDEFAULT'
+  end
+
+  describe '#omit_empty?' do
+    it 'defaults to true' do
+      expect(formatter.omit_empty?).to be true
+    end
+  end
+
+  describe '#omit_empty' do
+    it 'sets the flag correctly' do
+      formatter.omit_empty(false)
+
+      expect(formatter.omit_empty?).to be false
+    end
+
+    it 'non-boolean args sets flag to false' do
+      formatter.omit_empty(0)
+      expect(formatter.omit_empty?).to be false
+
+      formatter.omit_empty('false')
+      expect(formatter.omit_empty?).to be false
+    end
+  end
+
+  describe '#call' do
+    context 'when omit_empty? is set' do
+      before :each do
+        formatter.omit_empty(true)
+      end
+
+      it 'it returns empty string' do
+        expect(formatter.call('INFO', Time.now, 'SPECS', ''))
+      end
+    end
+
+    context 'when omit_empty? is not set' do
+      before :each do
+        formatter.omit_empty(false)
+      end
+
+      context 'and msg is a string' do
+        it 'it returns a formatted string' do
+          expected = "[INFO] APP_NAME=SPECDEFAULT::SPECS stuff\n"
+          res = formatter.call('INFO', nil, 'SPECS', 'stuff')
+
+          expect(res).to eq expected
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rumbrl
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - chr0n1x
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-21 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -97,6 +97,7 @@ files:
 - lib/rumbrl.rb
 - lib/rumbrl/env.rb
 - lib/rumbrl/factory.rb
+- lib/rumbrl/formatter.rb
 - lib/rumbrl/grumble.rb
 - lib/rumbrl/grumble_factory.rb
 - lib/rumbrl/log.rb
@@ -104,6 +105,7 @@ files:
 - lib/rumbrl/version.rb
 - rumbrl.gemspec
 - spec/rumbrl/factory_spec.rb
+- spec/rumbrl/formatter_spec.rb
 - spec/rumbrl/grumble_factory_spec.rb
 - spec/rumbrl/grumble_spec.rb
 - spec/rumbrl/log_spec.rb
@@ -135,6 +137,7 @@ specification_version: 4
 summary: ''
 test_files:
 - spec/rumbrl/factory_spec.rb
+- spec/rumbrl/formatter_spec.rb
 - spec/rumbrl/grumble_factory_spec.rb
 - spec/rumbrl/grumble_spec.rb
 - spec/rumbrl/log_spec.rb