console-adapter-rails 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3bfffd2e5daf13e1ee20290908faef062f5960d88021554cb06eb09f8b33561
-  data.tar.gz: b306352bde59591f90ecc8842ed3a369f53e54b6101f9513d672e33188969bd9
+  metadata.gz: 22f3bdcce8df798abb9d013c9c5ecbe9e41694a37ac0f3cc0d4cf70763ec98e8
+  data.tar.gz: ae9bc8c19ff6f3fe5e31e3447d0ba5d9faa7d6691280d9b22b77e41b0099fd1d
 SHA512:
-  metadata.gz: 9963a3eb7663df27e551e90bbdb5869f1a3175845aca759b94576363487adceac22d1ca1ba3423a7e3bc5b11d9125f72e99aea6ea0bebc3f8e33fc0c7268f42d
-  data.tar.gz: 67f48ccc6da55ffa1a729a5f841c159de0e4f5ef21f56f87d2622457e33c6a908f757c57fbcd53b79ed2292874f815060149b57faa99abc5ab05eb623ec45467
+  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/railtie.rb

@@ -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.6.0"
+			VERSION = "0.7.0"
 		end
 	end
 end

data/readme.md

@@ -26,26 +26,26 @@ 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:
 
-``` shell
-bundle exec sus
+``` bash
+$ bundle exec sus
 ```
 
 ### Making Releases
 
 To make a new release:
 
-``` shell
-bundle exec bake gem:release:patch # or minor or major
+``` bash
+$ bundle exec bake gem:release:patch # or minor or major
 ```
 
 ### Developer Certificate of Origin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: console-adapter-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -103,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: []
@@ -119,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Adapt Rails logs and events to the console gem.
 test_files: []