mr_loga_loga 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9302fc69d4d56866600c8d8fb20eedf503dd21d4749b4bc737614ecc73f4569a
-  data.tar.gz: 9e064b34de99a0fa1e624d2969cae8bfa2f1e425f1e53781243bf8c54c314c1a
+  metadata.gz: f131fea9745ad602c462f8b79aedd2a6e921c41ed6a21acb8c8aa80af8657d29
+  data.tar.gz: 2706932b984d4ea3e1a4db88dd45e6329cf705928e8d7b120e8e93b611ca0683
 SHA512:
-  metadata.gz: cd158e43d67fc8988387b247199768ba72b0e349860ad065b30c29b8a17a400dd7023b3587c8bd350f453818c489110d00975fbfe07da13dc07af76795bc4800
-  data.tar.gz: ce8770ac8a506652642ac564ed585be8b3b8f935b20afb1cd2162d732b44b09cc79d346aaca7d23858f4b3033861d19aff3259e31e16fc653960f5501ff421ff
+  metadata.gz: 86b20eefe439bfbe193ebb83bbade1c930c156e86b107cf73daf97f4894d33f4ea4c693090fabe04476c1a1159f1d169c1e1ef9e24635d75087ea59ebaa37e40
+  data.tar.gz: 0d459adab69a098925553c5e5b017e126ae0756ef126f5444ee6353f329c6f5b2fb73d4ab83b198904c6392c93b7604749b2e3ea3dc1e24e62f5e7b688161cee

data/.codeclimate.yml

@@ -0,0 +1,2 @@
+exclude_patterns:
+- "docs/"

data/.github/workflows/release.yml

@@ -75,5 +75,5 @@ jobs:
       - name: Commit Updated Files 📤
         uses: EndBug/add-and-commit@v7
         with:
-          add: "['Gemfile.lock']"
+          add: "['Gemfile.lock', 'lib/mr_loga_loga/version.rb']"
           message: "chore: post-release ${{ steps.release-version.outputs.version }}"

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+### [0.1.3](https://github.com/hschne/mr-loga-loga/compare/v0.1.2...v0.1.3) (2022-01-14)
+
+
+### Bug Fixes
+
+* json formatter errors ([874f3dd](https://github.com/hschne/mr-loga-loga/commit/874f3dd480e05792712495eb6b7c77c35474adc1))
+
 ### [0.1.2](https://github.com/hschne/mr-loga-loga/compare/v0.1.1...v0.1.2) (2022-01-05)
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mr_loga_loga (0.1.2)
+    mr_loga_loga (0.1.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -9,6 +9,9 @@
 [![Gem Version](https://badge.fury.io/rb/mr_loga_loga.svg)](https://badge.fury.io/rb/mr_loga_loga)
 [![Main](https://github.com/hschne/mr-loga-loga/actions/workflows/main.yml/badge.svg)](https://github.com/hschne/mr-loga-loga/actions/workflows/main.yml)
 ![License](https://img.shields.io/github/license/hschne/mr-loga-loga)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/7cdd4779e6c62bce6ba0/maintainability)](https://codeclimate.com/github/hschne/mr-loga-loga/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7cdd4779e6c62bce6ba0/test_coverage)](https://codeclimate.com/github/hschne/mr-loga-loga/test_coverage)
 </div>
 
 ## What's this?
@@ -21,7 +24,7 @@ logger.info('message', user: 'name', data: 1)
 # I, [2022-01-01T12:00:00.000000 #19074]  INFO -- Main: message user=user data=1
 ```
 
-You can find out more about the motivation behind the project [here](#why-mrlogaloga). For usage read [Usage](#usage) or [Advanced Usage](#advanced-usage)
+You can find out more about the motivation behind the project [here](#why-mrlogaloga). For usage read [Usage](#usage) or [Advanced Usage](#advanced-usage).
 
 **Note**: This gem is in early development. Try it out and leave some feedback, it really goes a long way in helping me out with development. Any [feature request](https://github.com/hschne/mr-loga-loga/issues/new?assignees=&labels=type%3ABug&template=FEATURE_REQUEST.md&title=) or [bug report](https://github.com/hschne/mr-loga-loga/issues/new?assignees=&labels=type%3AEnhancement&template=BUG_REPORT.md&title=) is welcome. If you like this project, leave a star to show your support! ⭐
 
@@ -126,7 +129,7 @@ You can implement and add your own formatters like so:
 
 ```ruby
 class MyFormatter
-  def call(severity, datetime, progname, message, context)
+  def call(severity, datetime, progname, message, **context)
     context = context.map { |key, value| "#{key}=#{value}" }.compact.join(' ')
     "#{severity} #{datetime.strftime('%Y-%m-%dT%H:%M:%S.%6N')} #{progname} #{message} #{context}"
   end
@@ -186,7 +189,7 @@ Thank you for contributing! :heart:
 
 We welcome all support, whether on bug reports, code, design, reviews, tests, documentation, translations, or just feature requests.
 
-Please use [GitHub issues](https://github.com/hschne/rails-mini-profiler/issues) to submit bugs or feature requests.
+Please use [GitHub issues](https://github.com/hschne/mr-loga-loga/issues) to submit bugs or feature requests.
 
 ## License
 

data/lib/mr_loga_loga/formatters/json.rb

@@ -20,19 +20,19 @@ module MrLogaLoga
       # @param severity [String] The message severity
       # @param datetime [DateTime] The message date time
       # @param progname [DateTime] The program name
-      # @param message [String] The log message
+      # @param message [Object] The log message, which may not be a string
       # @param context [Hash] The log message context
       #
       # @return [String] the formatted log message
       def call(severity, datetime, progname, message, **context)
-        message = message.nil? || message.empty? ? nil : msg2str(message)
+        message = message.nil? ? '' : msg2str(message)
 
         message_hash = {
           severity: severity,
           datetime: datetime.strftime('%Y-%m-%dT%H:%M:%S.%6N'),
           pid: Process.pid,
           progname: progname,
-          message: message,
+          message: (message.empty? ? nil : message),
           **context
         }.compact
         "#{message_hash.to_json}\n"

data/lib/mr_loga_loga/instance_methods.rb

@@ -11,6 +11,7 @@ module MrLogaLoga
       { class_name: self.class.name }
     end
 
+    # A shorthand method to use in your classes
     def logger
       if loga_loga.is_a?(MrLogaLoga::Logger)
         MrLogaLoga::LoggerProxy.new(loga_loga, -> { loga_context })
@@ -19,6 +20,7 @@ module MrLogaLoga
       end
     end
 
+    # Define the underlying logger to be used. Overwrite this to use a specific logger instance
     def loga_loga
       @loga_loga ||= if defined?(Rails.logger)
                        Rails.logger

data/lib/mr_loga_loga/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MrLogaLoga
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mr_loga_loga
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - hschne
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-05 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/ISSUE_TEMPLATE/BUG_REPORT.md"
 - ".github/ISSUE_TEMPLATE/FEATURE_REQUEST.md"
 - ".github/ISSUE_TEMPLATE/config.yml"