activesupport-json_logging 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c99bef73cc6bf2627075656ee38a3e3b756ac61ef54f2edcc628814b317ac7bf
-  data.tar.gz: c4a0e1ecfd0ae8862db0167cc5507b8da4572e6a58ed4035ec7aa606c3154442
+  metadata.gz: 879dfb3d0d8142a294407c70771d234e55d410032dbc50f035bf85f3bd33b79a
+  data.tar.gz: bfa9d0637d5e84f58acdf407ce782feda91b584c5c63700b93ec2aa4e6e59dd4
 SHA512:
-  metadata.gz: 3abb724226828b28519f25dc8edb138c3b4d7dc1a07bf2946b952e46bee4bef5d71149a44df4a52cb12e41f892ca4d2f7147bfdeb9dbd7ad0ca3c4ee3873dddc
-  data.tar.gz: 25b2c9f5ae0c8107e4f5c7385ff96fbb379cbfba851234be9800909978b14d1d81b5fab961a5d72bd1d4ede78c5d1d16eb5ab1534e6ed54d2074e1c21456395c
+  metadata.gz: e4ed4ef5739e411af61e6186581ec30aa3f0653c557d7f2bc088abf264a3e8608c483b0790b892a7e1c10674d55811f95a5a3e4c33d073cd59949469e732e875
+  data.tar.gz: ec86db106814dee2731695159275fb7c56700d36564571edd72e54013d076dd1a3328a050eae06429d16eaaf1c0538404ae8345605d5a2ec63684ca1f71f40b7

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 1.2.1 (2026-01-18)
+
+- Refactor tag stack handling in JsonLogging formatter for improved maintainability
+- Refactor timestamp handling in JsonLogging helpers to support Time.zone
+- Add Ruby 4.0 support in gemspec and Appraisal configurations
+
 ## 1.2.0 (2025-11-07)
 
 - Add support for service-specific tagged loggers: create loggers with permanent tags using `logger.tagged("service")` without a block

data/README.md

@@ -1,6 +1,6 @@
 # activesupport-json_logging
 
-[![Gem Version](https://badge.fury.io/rb/activesupport-json_logging.svg)](https://badge.fury.io/rb/activesupport-json_logging) [![Test Status](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/activesupport-json_logging.rb/graph/badge.svg?token=UX80FTO0Y0)](https://codecov.io/gh/amkisko/activesupport-json_logging.rb)
+[![Gem Version](https://badge.fury.io/rb/activesupport-json_logging.svg)](https://badge.fury.io/rb/activesupport-json_logging) [![Test Status](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/activesupport-json_logging.rb/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/activesupport-json_logging.rb/graph/badge.svg?token=UX80FTO0Y0)](https://codecov.io/gh/amkisko/activesupport-json_logging.rb) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=amkisko_activesupport-json_logging.rb&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=amkisko_activesupport-json_logging.rb)
 
 Structured JSON logging for Rails and ActiveSupport with a safe, single-line formatter.
 No dependencies beyond Rails and Activesupport.
@@ -283,6 +283,8 @@ end
 
 If you use Lograge, configure it to feed raw hashes and let this gem handle JSON formatting. This example shows a complete setup including all Rails component loggers and common third-party libraries:
 
+**Important:** When using Lograge, `config.log_tags` does not work for adding fields to Lograge output. Instead, use `config.lograge.custom_options` to add custom fields to your request logs.
+
 ```ruby
 # config/initializers/lograge.rb
 # Note: require is optional in Rails apps (auto-loaded via Railtie)
@@ -295,8 +297,26 @@ Rails.application.configure do
   config.lograge.formatter = Lograge::Formatters::Raw.new
   config.lograge.keep_original_rails_log = ENV["DEBUG"] ? true : false
 
-  # Merge additional context into Lograge output
-  config.lograge.custom_options = ->(_event) { JsonLogging.additional_context }
+  # Add custom fields to Lograge output
+  # Note: config.log_tags does NOT work with Lograge - use custom_options instead
+  config.lograge.custom_options = ->(event) {
+    {
+      remote_ip: Current.remote_addr,
+      request_id: Current.request_id,
+      user_agent: Current.user_agent,
+      user_id: Current.user&.id
+    }
+  }
+
+  # Optionally merge additional context from JsonLogging.with_context
+  # config.lograge.custom_options = ->(event) {
+  #   {
+  #     remote_ip: Current.remote_addr,
+  #     request_id: Current.request_id,
+  #     user_agent: Current.user_agent,
+  #     user_id: Current.user&.id
+  #   }.merge(JsonLogging.additional_context)
+  # }
 
   # Build unified JSON logger
   logdev = Rails.env.production? ? Rails.root.join("log", "#{Rails.env}.log") : $stdout
@@ -306,7 +326,6 @@ Rails.application.configure do
 
   # Set the main Rails logger
   config.logger = json_logger
-  config.log_tags = [:request_id, :remote_ip]
 
   # Override Rails.logger to ensure it uses our formatter
   Rails.logger = json_logger
@@ -327,13 +346,6 @@ Rails.application.configure do
 
   # Disable verbose enqueue logs to reduce noise
   config.active_job.verbose_enqueue_logs = false
-
-  # Optional: Customize log tags based on request
-  # config.log_tags = [
-  #   :request_id,
-  #   ->(request) { request.remote_ip },
-  #   ->(request) { request.subdomain }
-  # ]
 end
 ```
 
@@ -594,27 +606,10 @@ The gem will automatically filter these from all log entries, including context
 
 ## Development
 
-```bash
-# Install dependencies
-bundle install
-bundle exec appraisal generate
-
-# Run tests for current Rails version
-bundle exec rspec
+Run release.rb script to prepare code for publishing, it has all the required checks and tests.
 
-# Run tests for all Rails versions (6.0, 6.1, 7.0, 7.1, 7.2, 8.0)
-bin/appraisals
-
-# Run tests for specific Rails version
-bin/appraisals rails-7.0
-
-# Run tests for multiple versions
-bin/appraisals rails-7.0 rails-8.0
-
-# Or use appraisal directly
-bundle exec appraisal rails-7.0 rspec
-
-bundle exec standardrb --fix
+```bash
+usr/bin/release.rb
 ```
 
 ### Development: Using from Local Repository

data/lib/json_logging/formatter_with_tags.rb

@@ -10,8 +10,8 @@ module JsonLogging
     def current_tags
       # If LocalTagStorage is extended on this formatter, use its tag_stack
       # This matches Rails' TaggedLogging behavior where tag_stack attribute shadows the method
-      if respond_to?(:tag_stack, true) && instance_variable_defined?(:@tag_stack)
-        tag_stack.tags
+      if (stack = current_tag_stack)
+        stack.tags
       else
         @logger.send(:current_tags)
       end
@@ -30,8 +30,8 @@ module JsonLogging
 
     def push_tags(*tags)
       # If LocalTagStorage is present, use it; otherwise use logger's thread-local storage
-      if respond_to?(:tag_stack, true) && instance_variable_defined?(:@tag_stack)
-        tag_stack.push_tags(tags)
+      if (stack = current_tag_stack)
+        stack.push_tags(tags)
       else
         @logger.send(:push_tags, tags)
       end
@@ -40,14 +40,12 @@ module JsonLogging
     # Support tagged blocks for formatter
     def tagged(*tags)
       if block_given?
-        # If LocalTagStorage is present, use it; otherwise use logger's thread-local storage
-        if respond_to?(:tag_stack, true) && instance_variable_defined?(:@tag_stack)
-          previous_count = tag_stack.tags.size
-          tag_stack.push_tags(tags)
+        if (stack = current_tag_stack)
+          pushed_count = stack.push_tags(tags).size
           begin
             yield @logger
           ensure
-            tag_stack.pop_tags(tag_stack.tags.size - previous_count)
+            stack.pop_tags(pushed_count)
           end
         else
           previous = @logger.send(:current_tags).dup
@@ -59,8 +57,8 @@ module JsonLogging
           end
         end
       else
-        if respond_to?(:tag_stack, true) && instance_variable_defined?(:@tag_stack)
-          tag_stack.push_tags(tags)
+        if (stack = current_tag_stack)
+          stack.push_tags(tags)
         else
           @logger.send(:push_tags, tags)
         end
@@ -70,6 +68,23 @@ module JsonLogging
 
     private
 
+    # Returns the current tag_stack to use, checking in order:
+    # 1. This formatter's tag_stack (if LocalTagStorage is extended)
+    # 2. Logger's formatter's tag_stack (if it has LocalTagStorage)
+    # 3. nil (fall back to thread-local storage)
+    def current_tag_stack
+      if respond_to?(:tag_stack, true) && instance_variable_defined?(:@tag_stack)
+        tag_stack
+      elsif logger_formatter_has_tag_stack?
+        @logger.formatter.tag_stack
+      end
+    end
+
+    def logger_formatter_has_tag_stack?
+      @logger.formatter.respond_to?(:tag_stack, true) &&
+        @logger.formatter.instance_variable_defined?(:@tag_stack)
+    end
+
     def build_fallback_output(severity, timestamp, msg, error)
       timestamp_str = Helpers.normalize_timestamp(timestamp)
       fallback_payload = {

data/lib/json_logging/helpers.rb

@@ -4,7 +4,17 @@ module JsonLogging
 
     # Normalize timestamp to ISO8601 with microseconds
     def normalize_timestamp(timestamp)
-      (timestamp || Time.now).utc.iso8601(6)
+      time = timestamp || current_time
+      time.utc.iso8601(6)
+    end
+
+    # Get current time, using Time.zone if available, otherwise Time.now
+    def current_time
+      if defined?(Time.zone) && Time.zone
+        Time.zone.now
+      else
+        Time.now
+      end
     end
 
     # Safely convert object to string, never raises

data/lib/json_logging/json_logger_extension.rb

@@ -50,7 +50,7 @@ module JsonLogging
       msg ||= "<uninitialized>"
 
       fallback = {
-        timestamp: Helpers.normalize_timestamp(Time.now),
+        timestamp: Helpers.normalize_timestamp(Helpers.current_time),
         severity: severity_name(severity),
         message: Sanitizer.sanitize_string(Helpers.safe_string(msg)),
         logger_error: {
@@ -129,7 +129,7 @@ module JsonLogging
       payload = PayloadBuilder.build_base_payload(
         msg,
         severity: severity_name(severity),
-        timestamp: Helpers.normalize_timestamp(Time.now)
+        timestamp: Helpers.normalize_timestamp(Helpers.current_time)
       )
       payload = PayloadBuilder.merge_context(
         payload,
@@ -186,6 +186,8 @@ module JsonLogging
       end
 
       def pop_tags(count = 1)
+        return [] if count <= 0
+
         @tags.pop(count)
       end
 

data/lib/json_logging/version.rb

@@ -1,3 +1,3 @@
 module JsonLogging
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activesupport-json_logging
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Andrei Makarov
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -140,14 +139,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.52'
+- !ruby/object:Gem::Dependency
+  name: standard-custom
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: standard-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: standard-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: standard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.33'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -190,6 +287,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 description: Lightweight JSON logger and formatter integrating with Rails/ActiveSupport.
   No extra deps beyond Rails/Activesupport. Compatible with Rails 6–8.
 email:
@@ -220,7 +331,6 @@ metadata:
   source_code_uri: https://github.com/amkisko/activesupport-json_logging.rb
   changelog_uri: https://github.com/amkisko/activesupport-json_logging.rb/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/amkisko/activesupport-json_logging.rb/issues
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -235,8 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Structured JSON logging for Rails/ActiveSupport with safe, single-line entries.
 test_files: []