mr_loga_loga 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8399869802c8da867d5ccdd3324cf90f77fd1cc29e5a2a3eb1c4ab79e662f4a
-  data.tar.gz: ad9c22f9df5313c82d74f8641f372d577cbb1181a02f69c0094d98ad11c2a94c
+  metadata.gz: 96771984713e671c4d386e6f2736e7f5fd1e929912a8536f735df46f5df80de1
+  data.tar.gz: 636178d39697f664b5093b49758c478a5dc3739bfceadf03d092ebd777c5d861
 SHA512:
-  metadata.gz: 28e3197e5680213067ffeab4907cdbbd1fb158e4017ef8648337277923ef1d13821e91159e39acade64b862533bb0f6c31f50c5fd309071e94aeef7326f8cb69
-  data.tar.gz: 23fbd32e192fae524e46720fb6228edb1da71b4043ab96a2d7c0545393c75f0f32ed92f86685ecdeedeb76f1a2214d14273e3c43ac24b0a49f72143eb067e8e8
+  metadata.gz: cee5fb5dd81654e5f32fdcc061a23de27e93b6f3dd5d514f2e8a0009b71a795014dc7b4077c4129c614ac96b26369e80e217e8dea25c56c9009d765b92204d7a
+  data.tar.gz: d53465a1153ab221eb2b4039dd987dc56ced93a0ece700fd653f7464bc95f5975a69f6e71cc894c3e3b6d03593c2e45b8be21f6a345304ef8286b97d3fd669a1

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@v2
+        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', 'package.json', 'package-lock.json']"
+          message: "chore: post-release ${{ steps.release-version.outputs.version }}"

data/.tool-versions

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

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    mr_loga_loga (0.1.0)
+    mr_loga_loga (0.1.1)
 
 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)
@@ -55,7 +54,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  byebug
   mr_loga_loga!
   rake (~> 13.0)
   rspec (~> 3.0)

data/README.md

@@ -9,6 +9,7 @@
 [![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)
+</div>
 
 ## What's this?
 
@@ -167,7 +168,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
 

data/lib/mr_loga_loga/extensions/active_support_logger_patch.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module MrLogaLoga
+  module Adapters
+    # This patches ActiveSupport::Logger to allow forwarding keyword arguments
+    module ActiveSupportLoggerPatch
+      class << self
+        def apply
+          return unless defined?(ActiveSupport)
+
+          patch_applies = defined?(ActiveSupport::Logger)
+          unless patch_applies
+            puts 'WARNING: Failed to patch ActiveSupprt::Logger. It looks like '\
+                 "MrLogaLoga's patch no longer applies in "\
+                 "#{__FILE__}. Please contact MrLogaLoga maintainers."
+            return
+          end
+
+          ActiveSupport::Logger.send(:include, self)
+        end
+
+        # rubocop:disable all
+        def included base
+          base.instance_eval do
+            def broadcast(logger)
+              Module.new do
+                # We need to patch this method as otherwise calling add with keyword arguments results in argument errors.
+                # Rails calls `broadcast` for the logger configured in `Rails.logger`, which means that any invocations of
+                # Rails.logger.add result in running through this method.
+                #
+                # TODO: Remove once patched in Rails
+                define_method(:add) do |*args, **kwargs, &block|
+                  logger.add(*args, &block)
+                  super(*args, **kwargs, &block)
+                end
+
+                define_method(:<<) do |x|
+                  logger << x
+                  super(x)
+                end
+
+                define_method(:close) do
+                  logger.close
+                  super()
+                end
+
+                define_method(:progname=) do |name|
+                  logger.progname = name
+                  super(name)
+                end
+
+                define_method(:formatter=) do |formatter|
+                  logger.formatter = formatter
+                  super(formatter)
+                end
+
+                define_method(:level=) do |level|
+                  logger.level = level
+                  super(level)
+                end
+
+                define_method(:local_level=) do |level|
+                  logger.local_level = level if logger.respond_to?(:local_level=)
+                  super(level) if respond_to?(:local_level=)
+                end
+
+                define_method(:silence) do |level = Logger::ERROR, &block|
+                  if logger.respond_to?(:silence)
+                    logger.silence(level) do
+                      if defined?(super)
+                        super(level, &block)
+                      else
+                        block.call(self)
+                      end
+                    end
+                  else
+                    if defined?(super)
+                      super(level, &block)
+                    else
+                      block.call(self)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+        # rubocpo:enable all
+      end
+    end
+  end
+end
+
+MrLogaLoga::Adapters::ActiveSupportLoggerPatch.apply

data/lib/mr_loga_loga/extensions/lograge_patch.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'byebug'
-
 module MrLogaLoga
   module Adapters
     # This patches Lograge to forward data as context to MrLogaLoga

data/lib/mr_loga_loga/formatters/json.rb

@@ -24,7 +24,7 @@ module MrLogaLoga
       # @param context [Hash] The log message context
       #
       # @return [String] the formatted log message
-      def call(severity, datetime, progname, message, context)
+      def call(severity, datetime, progname, message, **context)
         message = message.nil? || message.empty? ? nil : msg2str(message)
 
         message_hash = {

data/lib/mr_loga_loga/formatters/key_value.rb

@@ -24,7 +24,7 @@ module MrLogaLoga
       # @param context [Hash] The log message context
       #
       # @return [String] the formatted log message
-      def call(severity, datetime, progname, message, context)
+      def call(severity, datetime, progname, message, **context)
         message = context.map { |key, value| "#{key}=#{value}" }
                     .prepend(message)
                     .compact

data/lib/mr_loga_loga/instance_methods.rb

@@ -16,8 +16,8 @@ module MrLogaLoga
     end
 
     def loga_loga
-      @loga_loga ||= if defined?(Rails.application.logger)
-                       Rails.application.logger
+      @loga_loga ||= if defined?(Rails.logger)
+                       Rails.logger
                      else
                        MrLogaLoga.configuration.logger
                      end

data/lib/mr_loga_loga/logger.rb

@@ -20,6 +20,11 @@ module MrLogaLoga
   #   logger.debug("Default")
   #   logger.context(user: 1).debug('with context')
   class Logger < ::Logger
+    def initialize(*args, **kwargs)
+      super
+      @default_formatter = MrLogaLoga::Formatters::KeyValue.new
+    end
+
     def context(**kwargs, &block)
       context = block ? -> { kwargs.merge(block.call) } : kwargs
       Context.new(self, context)
@@ -30,11 +35,21 @@ module MrLogaLoga
       Message.new(self, message)
     end
 
-    def add(severity, message = nil, progname = nil, **context, &block)
+    def add(severity, message = nil, progname = nil, *_args, **context, &block)
       severity ||= UNKNOWN
       return true unless log?(severity)
 
-      message = block.call if block
+      progname = @progname if progname.nil?
+
+      if message.nil?
+        if block
+          message = block.call
+        else
+          message = progname
+          progname = @progname
+        end
+      end
+
       @logdev.write(format(format_severity(severity), Time.now, progname, message, context))
       true
     end
@@ -42,10 +57,10 @@ module MrLogaLoga
     alias log add
 
     %i[debug info warn error fatal unknown].each do |symbol|
-      define_method(symbol) do |message = nil, **context, &block|
+      define_method(symbol) do |progname = nil, **context, &block|
         # Map the symbol (e.g. :debug) to the severity constant (e.g. DEBUG)
         severity = Object.const_get("Logger::Severity::#{symbol.to_s.upcase}")
-        add(severity, message, **context, &block)
+        add(severity, nil, progname, **context, &block)
       end
     end
 
@@ -73,11 +88,7 @@ module MrLogaLoga
     end
 
     def format(severity, datetime, progname, message, context)
-      formatter.call(severity, datetime, progname, message, context)
-    end
-
-    def formatter
-      @formatter ||= MrLogaLoga::Formatters::KeyValue.new
+      (@formatter || @default_formatter).call(severity, datetime, progname, message, **context)
     end
   end
 end

data/lib/mr_loga_loga/logger_proxy.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'logger'
+require 'forwardable'
 
 module MrLogaLoga
   # == Description
@@ -9,30 +10,30 @@ module MrLogaLoga
   #
   # @api private
   class LoggerProxy
+    extend Forwardable
+
     def initialize(logger, context_proc)
       @logger = logger
       @context_proc = context_proc
     end
 
-    def add(severity, message = nil, **context, &block)
+    def add(severity, message = nil, progname = nil, **context, &block)
       severity ||= UNKNOWN
       return true unless @logger.log?(severity)
 
       context = @context_proc.call.merge(context)
 
-      @logger.add(severity, message, **context, &block)
+      @logger.add(severity, message, progname, **context, &block)
     end
 
     alias log add
 
     %i[debug info warn error fatal unknown].each do |symbol|
-      define_method(symbol) do |message = nil, **context, &block|
-        severity = Object.const_get("Logger::Severity::#{symbol.to_s.upcase}")
-        return true unless @logger.log?(severity)
+      def_delegator :@logger, "#{symbol}?".to_sym, "#{symbol}?".to_sym
 
-        context = @context_proc.call.merge(context)
-
-        @logger.public_send(symbol, message, **context, &block)
+      define_method(symbol) do |progname = nil, **context, &block|
+        severity = Object.const_get("Logger::Severity::#{symbol.to_s.upcase}")
+        add(severity, nil, progname, **context, &block)
       end
     end
   end

data/lib/mr_loga_loga/version.rb

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

data/lib/mr_loga_loga.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'byebug'
-
 require_relative 'mr_loga_loga/version'
 require_relative 'mr_loga_loga/configuration'
 require_relative 'mr_loga_loga/logger_proxy'
@@ -11,6 +9,7 @@ require_relative 'mr_loga_loga/logger'
 require_relative 'mr_loga_loga/formatters/key_value'
 require_relative 'mr_loga_loga/formatters/json'
 
+require_relative 'mr_loga_loga/extensions/active_support_logger_patch'
 require_relative 'mr_loga_loga/extensions/lograge_patch'
 
 # == Description

data/mr_loga_loga.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
@@ -33,7 +33,6 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
-  spec.add_development_dependency 'byebug'
   spec.add_development_dependency 'rubocop', '~> 1.24'
   spec.add_development_dependency 'simplecov', '~> 0.21.2'
   spec.add_development_dependency 'timecop', '~> 0.9.4'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mr_loga_loga
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - hschne
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-02 00:00:00.000000000 Z
+date: 2022-01-03 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -79,9 +65,11 @@ files:
 - ".github/dependabot.yml"
 - ".github/stale.yml"
 - ".github/workflows/main.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -94,6 +82,7 @@ files:
 - lib/mr_loga_loga.rb
 - lib/mr_loga_loga/configuration.rb
 - lib/mr_loga_loga/context.rb
+- lib/mr_loga_loga/extensions/active_support_logger_patch.rb
 - lib/mr_loga_loga/extensions/lograge_patch.rb
 - lib/mr_loga_loga/formatters/json.rb
 - lib/mr_loga_loga/formatters/key_value.rb
@@ -109,9 +98,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/hschne/mr-loga-loga
   source_code_uri: https://github.com/hschne/mr-loga-loga
-  changelog_uri: https://github.com/hschne/mr-loga-loga/CHANGELOG.md
+  changelog_uri: https://github.com/hschne/mr-loga-loga/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.2.3
+signing_key: 
 specification_version: 4
 summary: A bombastic, fantastic logger for Ruby
 test_files: []