inst-wide-logger 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48eed6b5cb7f9b36589aaf6aac78b8ab88a7dcb6e44cfd618012838816312cb5
-  data.tar.gz: faa3e37c7f0537513f174f7f1c8bcd374de6827a7bcff86bb23cd4f1a40f3cd3
+  metadata.gz: 3b9f2740d229c6b5e3a628f349d8674654046c56c646ee505474699f14b9f8fd
+  data.tar.gz: b1ddd213ae2cf6b2b05da1a7855435a96294ca6879c8e2d10fc175a3edfd1a4d
 SHA512:
-  metadata.gz: 2950404c977ce06feb0360d6c878b60345c169b458beebb087815df10d2599c945ac6751dca23f349cdf716aa98144945e2116efe17db12fc12364abd667873a
-  data.tar.gz: f8708a57eaa0d58bf04049382139a9a49e6a4ce59ae446b18cbb7c6e6fbed331a2d697baf5051e6e9ace4a3a4328d623bde9599013458e9684b47ccd046f28a4
+  metadata.gz: 0f39db58281e6f7b4ba6379fad20b0f75150a3d8f53f20adefff61256a91842a792ba6823290ec1dc833f7a4cf60e70d813a97ae9bfe1fcbfcf1c05b53d9dd1f
+  data.tar.gz: fbdd690779e28f2bb8bf89182739d4114130689e04905078d089394e8641ddf01d88a71407759da107374d31d5ab1919f833a7db17d371ebdd6fa4045da5907e

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [1.3.0] - 2026-04-20
+
+### Added
+
+- `WideLogger::DevFormatter` with an `include_json:` constructor option (default `true`) to control whether the JSON context is appended to each log entry
+
+### Deprecated
+
+- `WideLogger::DevJsonFormatter` — use `WideLogger::DevFormatter` instead. The alias will be removed in 2.0.
+
 ## [1.2.0] - 2026-04-16
 
 ### Added

data/README.md

@@ -33,12 +33,20 @@ WideLogger.wrap(type: :web_request, metadata: { additional_context: @context })
 end
 ```
 
-Optionally, you can use WideLogger:DevJsonFormatter to have log entries in the following format:
+Optionally, you can use `WideLogger::DevFormatter` to have log entries in the following format:
 
 ```text
 <timestamp> <message> <context in JSON format>
 ```
 
+The formatter accepts an `include_json:` keyword (default `true`). Set it to `false` to suppress the JSON context and emit only `<timestamp> <message>`:
+
+```ruby
+config.logging.formatter = WideLogger::DevFormatter.new(include_json: false)
+```
+
+> `WideLogger::DevJsonFormatter` is kept as a deprecated alias of `DevFormatter` for backwards compatibility and will be removed in 2.0.
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.

data/lib/wide_logger/dev_formatter.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'active_support/deprecation'
+
+module WideLogger
+  class DevFormatter < PaulBunyan::JSONFormatter
+    def initialize(include_json: true)
+      super()
+      @include_json = include_json
+    end
+
+    def call(severity, time, progname, msg)
+      prefix = time.utc.strftime(DATETIME_FORMAT) + ' ' + msg.to_s
+      return prefix + "\n" unless @include_json
+
+      prefix + ' ' + super
+    end
+
+    private
+
+    def merge_metadata_and_message(metadata, message)
+      super.except('message', 'ts').sort_by { |key, _| key.to_s }.to_h
+    end
+  end
+
+  DEPRECATOR = ActiveSupport::Deprecation.new('2.0', 'WideLogger')
+
+  class DevJsonFormatter < DevFormatter
+    def initialize(*args, **kwargs)
+      DEPRECATOR.warn(
+        'WideLogger::DevJsonFormatter is deprecated and will be removed in 2.0. ' \
+        'Use WideLogger::DevFormatter instead.'
+      )
+      super
+    end
+  end
+end

data/lib/wide_logger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WideLogger
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/wide_logger.rb

@@ -4,5 +4,5 @@ require 'paul_bunyan'
 require_relative 'wide_logger/version'
 require_relative 'wide_logger/wide_logger'
 require_relative 'wide_logger/downgrading_to_debug_logger'
-require_relative 'wide_logger/dev_json_formatter'
+require_relative 'wide_logger/dev_formatter'
 require_relative 'wide_logger/railtie' if defined?(Rails::Railtie)

data/wide_logger.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport', '>= 6.0'
   spec.add_dependency 'paul_bunyan', '~> 2.1'
   spec.add_dependency 'railties', '>= 6.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: inst-wide-logger
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Zoltan Hegedus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-16 00:00:00.000000000 Z
+date: 2026-04-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: paul_bunyan
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ files:
 - Rakefile
 - lib/inst-wide-logger.rb
 - lib/wide_logger.rb
-- lib/wide_logger/dev_json_formatter.rb
+- lib/wide_logger/dev_formatter.rb
 - lib/wide_logger/downgrading_to_debug_logger.rb
 - lib/wide_logger/railtie.rb
 - lib/wide_logger/version.rb

data/lib/wide_logger/dev_json_formatter.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module WideLogger
-  class DevJsonFormatter < PaulBunyan::JSONFormatter
-    def call(severity, time, progname, msg)
-      time.utc.strftime(DATETIME_FORMAT) + ' ' + msg.to_s + ' ' + super
-    end
-
-    private
-
-    def merge_metadata_and_message(metadata, message)
-      super.except('message', 'ts').sort_by { |key, _| key.to_s }.to_h
-    end
-  end
-end