console-adapter-rails 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a3133534ae9fef350296fe8f70381f69506077331665169523a7a59fef0786
-  data.tar.gz: c23583428a0b77f235b72e2c83b57818e53da8581d9087a739d30cf33e6b535e
+  metadata.gz: 22f3bdcce8df798abb9d013c9c5ecbe9e41694a37ac0f3cc0d4cf70763ec98e8
+  data.tar.gz: ae9bc8c19ff6f3fe5e31e3447d0ba5d9faa7d6691280d9b22b77e41b0099fd1d
 SHA512:
-  metadata.gz: f8d8d61c59a6c62fc9dbac96c1dbe7e60f00dc3cfd79322cc2e15a4bf7ea37a563516ac682994c96375a69ec5d9cd7cff1ff13b901df33f8b49aacbcf8f4e0cf
-  data.tar.gz: 5a3431fdcbe71b50d272ea61f0d56295b4a19520e77ee03cb7f42995faa884f35aab8dc01ed5b5c29702e5ec956e9061eb9c99176d7d8a4db386e24ee76ae575
+  metadata.gz: b540ef6e3c7c2387efd9c4dec9f7cca4bd12b6e936e81881d345a7f1c053981b75aa9afd21504dda0c142d1b08d9e475bcbb0b34dca44faf968ce290640bc925
+  data.tar.gz: 875cbe82136ef8b6ad18b3fecb9f1777228272b67a22d3607e273055889e6f18130298db0318426004c7e491849fd11796fe103ed175a2675863fd29500d6f41

data/context/index.yaml

@@ -3,6 +3,8 @@
 ---
 description: Adapt Rails logs and events to the console gem.
 metadata:
+  bug_tracker_uri: https://github.com/socketry/console-adapter-rails/issues
+  changelog_uri: https://github.com/socketry/console-adapter-rails/blob/main/releases.md
   documentation_uri: https://socketry.github.io/console-adapter-rails/
   source_code_uri: https://github.com/socketry/console-adapter-rails.git
 files:

data/lib/console/adapter/rails/action_controller.rb

@@ -13,6 +13,22 @@ module Console
 		module Rails
 			# ActionController integration for Console logger. Provides log subscribers that convert Rails ActionController events into Console-compatible log messages.
 			module ActionController
+				@log_parameters = false
+				
+				# Whether filtered request parameters should be included in action controller logs.
+				#
+				# @returns [Boolean] Whether filtered request parameters are logged.
+				def self.log_parameters?
+					@log_parameters
+				end
+				
+				# Configure whether filtered request parameters should be included in action controller logs.
+				#
+				# @parameter value [Boolean] Whether filtered request parameters should be logged.
+				def self.log_parameters=(value)
+					@log_parameters = value
+				end
+				
 				# Represents a Rails log subscriber which is compatible with `Console::Logger`. It receives events from `ActiveSupport::Notifications` and logs them to the console.
 				class LogSubscriber < ::ActiveSupport::LogSubscriber
 					# Log an ActionController `process_action` event.
@@ -33,8 +49,8 @@ module Console
 					def process_action(event)
 						payload = event.payload.dup
 						
-						# This may contain sensitive information:
-						params = payload.delete(:params)
+						# This may contain sensitive information, but Rails applies configured parameter filters before emitting the event:
+						payload.delete(:params) unless ActionController.log_parameters?
 						
 						# These objects are not useful and may not serialize correctly:
 						headers = payload.delete(:headers)

data/lib/console/adapter/rails/active_record.rb

@@ -47,6 +47,7 @@ module Console
 					def update_binds(payload)
 						binds = payload.delete(:binds)
 						type_casted_binds = payload.delete(:type_casted_binds)
+						type_casted_binds = type_casted_binds.call if type_casted_binds.respond_to?(:call)
 						
 						if binds&.any? and type_casted_binds
 							payload[:binds] = binds.map.with_index do |attribute, index|

data/lib/console/adapter/rails/logger.rb

@@ -3,6 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2023-2025, by Samuel Williams.
 # Copyright, 2024, by Michael Adams.
+# Copyright, 2026, by Yasha Krasnou.
 
 require "console/compatible/logger"
 
@@ -83,7 +84,25 @@ module Console
 				def add(severity, message = nil, progname = nil, &block)
 					return if silenced?(severity)
 					
-					super(severity, message, progname, &block)
+					if formatter.respond_to?(:tag_stack)
+						tags = formatter.tag_stack.tags
+						
+						options = tags.each_with_object({}) do |tag, memo|
+							next unless tag.respond_to?(:to_hash)
+							
+							tag.to_hash.each do |key, value|
+								case key
+								when Symbol
+									memo[key] = value
+								else
+									next unless key.respond_to?(:to_sym)
+									memo[key.to_sym] = value
+								end
+							end
+						end
+					end
+					
+					super(severity, message, progname, **options, &block)
 				end
 				
 				# Configure Rails to use the Console logger.

data/lib/console/adapter/rails/railtie.rb

@@ -2,7 +2,7 @@
 
 # Released under the MIT License.
 # Copyright, 2024, by Michael Adams.
-# Copyright, 2024, by Samuel Williams.
+# Copyright, 2024-2026, by Samuel Williams.
 # Copyright, 2025, by Jun Jiang.
 
 require "action_controller/log_subscriber"
@@ -13,28 +13,32 @@ module Console
 		module Rails
 			# Hook into Rails startup process and replace Rails.logger with our custom hooks
 			class Railtie < ::Rails::Railtie
+				# Detach a Rails log subscriber using the API appropriate for its implementation.
+				#
+				# @parameter subscriber [Class] The log subscriber class to detach.
+				# @parameter namespace [Symbol] The notification namespace the subscriber is attached to.
+				def self.detach_log_subscriber(subscriber, namespace)
+					if subscriber < ::ActiveSupport::LogSubscriber
+						subscriber.detach_from(namespace)
+					else
+						::ActiveSupport.event_reporter.unsubscribe(subscriber)
+					end
+				end
+				
+				# 1. Remove the Rails::Rack::Logger middleware as it also doubles up on request logs
+				config.app_middleware.delete ::Rails::Rack::Logger
+				
 				initializer "console.adapter.rails", before: :initialize_logger do |app|
-					# 1. Set up Console to be used as the Rails logger
+					# 2. Set up Console to be used as the Rails logger
 					Logger.apply!(configuration: app.config)
-					
-					# 2. Remove the Rails::Rack::Logger middleware as it also doubles up on request logs
-					app.middleware.delete ::Rails::Rack::Logger
 				end
 				
 				# 3. Remove existing log subscribers for ActionController and ActionView
 				config.after_initialize do
-					if ::ActionController::LogSubscriber < ::ActiveSupport::LogSubscriber
-						::ActionController::LogSubscriber.detach_from :action_controller
-					else
-						::ActiveSupport.event_reporter.unsubscribe(::ActionController::LogSubscriber)
-					end
+					detach_log_subscriber(::ActionController::LogSubscriber, :action_controller)
 					
 					# Silence the default action view logs, e.g. "Rendering text template" etc
-					if ::ActionView::LogSubscriber < ::ActiveSupport::LogSubscriber
-						::ActionView::LogSubscriber.detach_from :action_view
-					else
-						::ActiveSupport.event_reporter.unsubscribe(::ActionView::LogSubscriber)
-					end
+					detach_log_subscriber(::ActionView::LogSubscriber, :action_view)
 				end
 				
 				config.after_initialize do

data/lib/console/adapter/rails/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2025, by Samuel Williams.
+# Copyright, 2023-2026, by Samuel Williams.
 
 # @namespace
 module Console
@@ -9,7 +9,7 @@ module Console
 	module Adapter
 		# @namespace
 		module Rails
-			VERSION = "0.5.1"
+			VERSION = "0.7.0"
 		end
 	end
 end

data/lib/console/adapter/rails.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2026, by Samuel Williams.
 # Copyright, 2024, by Michael Adams.
 
 require_relative "rails/logger"

data/license.md

@@ -1,9 +1,10 @@
 # MIT License
 
-Copyright, 2023-2025, by Samuel Williams.  
+Copyright, 2023-2026, by Samuel Williams.  
 Copyright, 2023, by Joshua Young.  
 Copyright, 2024, by Michael Adams.  
 Copyright, 2025, by Jun Jiang.  
+Copyright, 2026, by Yasha Krasnou.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -14,6 +14,10 @@ Please see the [project documentation](https://socketry.github.io/console-adapte
 
 Please see the [project releases](https://socketry.github.io/console-adapter-rails/releases/index) for all releases.
 
+### v0.6.0
+
+  - Add support for Rails tagged logging in the Rails logger adapter. This allows log messages with tags to be properly formatted and displayed.
+
 ### v0.5.0
 
   - Improved compatibilty with Rails 8+.
@@ -22,11 +26,27 @@ Please see the [project releases](https://socketry.github.io/console-adapter-rai
 
 We welcome contributions to this project.
 
-1.  Fork it.
+1.  Fork the repository.
 2.  Create your feature branch (`git checkout -b my-new-feature`).
-3.  Commit your changes (`git commit -am 'Add some feature'`).
+3.  Commit your changes (`git commit -am 'Add some feature.'`).
 4.  Push to the branch (`git push origin my-new-feature`).
-5.  Create new Pull Request.
+5.  Create a new pull request.
+
+### Running Tests
+
+To run the test suite:
+
+``` bash
+$ bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` bash
+$ bundle exec bake gem:release:patch # or minor or major
+```
 
 ### Developer Certificate of Origin
 

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.6.0
+
+  - Add support for Rails tagged logging in the Rails logger adapter. This allows log messages with tags to be properly formatted and displayed.
+
 ## v0.5.0
 
   - Improved compatibilty with Rails 8+.

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console-adapter-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Williams
 - Joshua Young
 - Jun Jiang
 - Michael Adams
+- Yasha Krasnou
 bindir: bin
 cert_chain:
 - |
@@ -47,14 +48,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.34'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.34'
 - !ruby/object:Gem::Dependency
   name: fiber-storage
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +103,8 @@ homepage: https://github.com/socketry/console-adapter-rails
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/socketry/console-adapter-rails/issues
+  changelog_uri: https://github.com/socketry/console-adapter-rails/blob/main/releases.md
   documentation_uri: https://socketry.github.io/console-adapter-rails/
   source_code_uri: https://github.com/socketry/console-adapter-rails.git
 rdoc_options: []
@@ -111,14 +114,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.2'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Adapt Rails logs and events to the console gem.
 test_files: []