mr_loga_loga 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8399869802c8da867d5ccdd3324cf90f77fd1cc29e5a2a3eb1c4ab79e662f4a
-  data.tar.gz: ad9c22f9df5313c82d74f8641f372d577cbb1181a02f69c0094d98ad11c2a94c
+  metadata.gz: 606efac4895e737ab02c1e96818c4ebb2dbc537a8e7b5b7871ad32322fc63da1
+  data.tar.gz: 16c3bc2ad45e9b456f8584c507be9f057384f4f34e14588d8ed9f88352c7797c
 SHA512:
-  metadata.gz: 28e3197e5680213067ffeab4907cdbbd1fb158e4017ef8648337277923ef1d13821e91159e39acade64b862533bb0f6c31f50c5fd309071e94aeef7326f8cb69
-  data.tar.gz: 23fbd32e192fae524e46720fb6228edb1da71b4043ab96a2d7c0545393c75f0f32ed92f86685ecdeedeb76f1a2214d14273e3c43ac24b0a49f72143eb067e8e8
+  metadata.gz: dcf4b5fb67d75ca7e7214e9240790cffaaf6351142d152944f5c933611c8fae4b8d0c8b8f003ba928a5e911867a8080d2357d086cc061ddfacc981d6554965b3
+  data.tar.gz: 1a0c3ec86d9053b56f2aa7bd05648f5f9280462c88b7a090f4a05e0866783119771e0b253d1e8896d5366de46856666c43c4e6edda79b0ad883de3081e3aeb76

data/.codeclimate.yml

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

data/.github/workflows/main.yml

@@ -48,7 +48,6 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.1"
           bundler-cache: true
 
       - name: Run RuboCop 🚓

data/.github/workflows/release.yml

@@ -0,0 +1,79 @@
+name: release
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'The release version'
+        required: true
+
+jobs:
+  prepare-release:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      version: ${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}.${{ steps.release.outputs.patch }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Generate Release 🗒️
+        uses: GoogleCloudPlatform/release-please-action@v3
+        id: release
+        with:
+          release-type: ruby
+          package-name: mr-loga-loga
+          bump-minor-pre-major: true
+          version-file: 'dummy.rb' # Don't set the version file, we do version increments ourselves on release
+
+  release:
+    needs: prepare-release
+    runs-on: ubuntu-latest
+    if: needs.prepare-release.outputs.release_created || github.event_name == 'workflow_dispatch'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+        env:
+          BUNDLE_WITHOUT: 'development'
+
+      - name: Release Version
+        id: release-version
+        run: |
+          if [[ ${{github.event_name}} == 'workflow_dispatch' ]]; then
+            version=${{ github.event.inputs.version }}
+          else
+            version=${{ needs.prepare-release.outputs.version }}
+          fi
+          echo "::set-output name=version::$version"
+
+      - name: Bump Gem Version
+        run: |
+          sed -i "s|\(VERSION = \)'.*'|\1'${{ steps.release-version.outputs.version }}'|" lib/mr_loga_loga/version.rb
+
+      - name: Update Gemfile.lock
+        run: |
+          bundle config unset deployment
+          bundle install --jobs 4
+
+      - name: Publish Gem 💎
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+
+      - name: Commit Updated Files 📤
+        uses: EndBug/add-and-commit@v7
+        with:
+          add: "['Gemfile.lock', 'lib/mr_loga_loga/version.rb']"
+          message: "chore: post-release ${{ steps.release-version.outputs.version }}"

data/.gitignore

@@ -188,3 +188,4 @@ tags
 # End of https://www.toptal.com/developers/gitignore/api/vim,rubymine+all,rails
 
 .rspec_status
+.yardoc

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.0

data/.yardopts

@@ -0,0 +1 @@
+--output-dir docs

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 ## [Unreleased]
 
+### [0.1.4](https://github.com/hschne/mr-loga-loga/compare/v0.1.3...v0.1.4) (2022-01-22)
+
+
+### Bug Fixes
+
+* error formatting for keyvalue formatter, fixes [#7](https://github.com/hschne/mr-loga-loga/issues/7) ([a64d822](https://github.com/hschne/mr-loga-loga/commit/a64d8225691d55e1eb42df57afcb950d76f5f59b))
+
+### [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)
+
+
+### Bug Fixes
+
+* improve rails patch ([a31cdf1](https://github.com/hschne/mr-loga-loga/commit/a31cdf1b655bfaeb2351bff818ca0af83293ace5))
+* only delegate when logger is loga loga ([55bd0db](https://github.com/hschne/mr-loga-loga/commit/55bd0dbdee5b975c80effac90e989eb08d2b6948))
+
+### [0.1.1](https://www.github.com/hschne/mr-loga-loga/compare/v0.1.0...v0.1.1) (2022-01-03)
+
+
+### Bug Fixes
+
+* rails compatibility ([81619ef](https://www.github.com/hschne/mr-loga-loga/commit/81619ef76d772ac05eb78daf3714794d345af587))
+* remove byebug, patch rails, fix logger proxy ([38caf62](https://www.github.com/hschne/mr-loga-loga/commit/38caf625304449e128e9201aeeaf79d24798aa7d))
+* update initializer signature ([bdd8b72](https://www.github.com/hschne/mr-loga-loga/commit/bdd8b7269111550ff9e2e5e3c6344d6c83707099))
+
 ## [0.1.0] - 2021-11-12
 
 - Initial release

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    mr_loga_loga (0.1.0)
+    mr_loga_loga (0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    byebug (11.1.3)
     diff-lcs (1.4.4)
     docile (1.4.0)
     parallel (1.21.0)
@@ -50,18 +49,21 @@ GEM
     simplecov_json_formatter (0.1.3)
     timecop (0.9.4)
     unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  byebug
   mr_loga_loga!
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.7)
-  simplecov (~> 0.21.2)
-  timecop (~> 0.9.4)
+  simplecov (~> 0.21)
+  timecop (~> 0.9)
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.2.26

data/README.md

@@ -10,16 +10,21 @@
 [![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?
 
-MrLogaLoga is a logger for Ruby that allows you to easily attach contextual information to your log messages. When writing logs, messages only tell half the story. MrLogaLoga allows you to make the most of your logs:
+MrLogaLoga is a logger for Ruby that allows you to easily attach contextual information to your log messages. 
+When writing logs, messages only tell half the story. MrLogaLoga allows you to make the most of your logs.
 
 ```ruby
 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! ⭐
 
@@ -39,7 +44,7 @@ bundle install
 
 ## Usage
 
-MrLogaLoga provides the same interface as the Ruby default logger you are used to. In addition, however, you can attach contextual information to your log messages:
+MrLogaLoga provides the same interface as the Ruby default logger you are used to. In addition, however, you can attach contextual information to your log messages.
 
 ```ruby
 require 'mr_loga_loga'
@@ -65,7 +70,7 @@ logger.user('name').info('message') # Dynamic context method
 logger.user { 'name' }.info('message') # Dynamic context block
 ```
 
-The block syntax [ is recommended when logging calculated properties ](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html#class-Logger-label-How+to+log+a+message).
+The block syntax [ is recommended when logging calculated properties ](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html#class-Logger-label-How+to+log+a+message). You can find more in-depth information about specific method in the [Code Documentation](https://www.hschne.at/mr-loga-loga/).
 
 #### Shared Context
 
@@ -111,7 +116,6 @@ class MyClass
 end
 ```
 
-
 ### Formatters
 
 MrLogaLoga uses the [KeyValue](https://github.com/hschne/mr-loga-loga/blob/main/lib/mr_loga_loga/formatters/key_value.rb) formatter per default. The [Json](https://github.com/hschne/mr-loga-loga/blob/main/lib/mr_loga_loga/formatters/json.rb) formatter is also included. To use a specific formatter pass it to the logger constructor:
@@ -125,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
@@ -167,7 +171,7 @@ logger.debug("my message user=#{user} more_data=#{data}")
 
 This is fine, as long as you do not need to change your log format. Changing your log formatter will not change the format of your message, nor the formatting of the contextual information you provided.
 
-MrLogaLoga addresses this by allowing you to attach contextual information to your logs and giving you full control over how both message and context are formatted.
+MrLogaLoga addresses this by allowing you to attach contextual information to your logs and giving you full control over how both message and context are formatted. There are other gems doing similar things, most notably [Semantic Logger](https://logger.rocketjob.io/). Where Semantic Logger provides lots of functionality related to logging, MrLogaLoga focuses on making it nice to write log messages - and nothing more. 
 
 ## Credit
 
@@ -185,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/docs/MrLogaLoga/Configuration.html

@@ -0,0 +1,376 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: MrLogaLoga::Configuration
+  
+    &mdash; Documentation by YARD 0.9.27
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" />
+
+<script type="text/javascript">
+  pathId = "MrLogaLoga::Configuration";
+  relpath = '../';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="../_index.html">Index (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../MrLogaLoga.html" title="MrLogaLoga (module)">MrLogaLoga</a></span></span>
+     &raquo; 
+    <span class="title">Configuration</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Class: MrLogaLoga::Configuration
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">MrLogaLoga::Configuration</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+    </dd>
+  </dl>
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/mr_loga_loga/configuration.rb</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<h2 id="label-Description">Description</h2>
+
+<p>The configuration class for MrLogaLoga</p>
+
+<h2 id="label-Usage">Usage</h2>
+
+<pre class="code ruby"><code class="ruby">MrLogaLoga.configure do |configuration|
+  configuration.logger = ...
+end
+</code></pre>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+
+
+
+  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+    
+    
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute logger.</p>
+</div></span>
+  
+</li>
+
+    
+  </ul>
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(**kwargs)  &#x21d2; Configuration </a>
+    
+
+    
+  </span>
+  
+  
+    <span class="note title constructor">constructor</span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Initialize the configuration by setting configuration default values.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Reset the configuration to default values.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <h3 class="signature first" id="initialize-instance_method">
+  
+    #<strong>initialize</strong>(**kwargs)  &#x21d2; <tt><span class='object_link'><a href="" title="MrLogaLoga::Configuration (class)">Configuration</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Initialize the configuration by setting configuration default values</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+17
+18
+19
+20</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mr_loga_loga/configuration.rb', line 17</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kwargs'>kwargs</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_reset'>reset</span>
+  <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+    
+      
+      <span id="logger=-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="logger-instance_method">
+  
+    #<strong>logger</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the value of attribute logger.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+14
+15
+16</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mr_loga_loga/configuration.rb', line 14</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
+  <span class='ivar'>@logger</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="reset-instance_method">
+  
+    #<strong>reset</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Reset the configuration to default values</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mr_loga_loga/configuration.rb', line 23</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span>
+  <span class='ivar'>@logger</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../MrLogaLoga.html" title="MrLogaLoga (module)">MrLogaLoga</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Logger.html" title="MrLogaLoga::Logger (class)">Logger</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Logger.html#initialize-instance_method" title="MrLogaLoga::Logger#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='gvar'>$stdout</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Wed Jan  5 09:59:09 2022 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.27 (ruby-3.0.0).
+</div>
+
+    </div>
+  </body>
+</html>