console-adapter-rails 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cc4bca3597337b67f0d19a87e57e5bd5e989f3e99052e6a07968db52e4e77a1
-  data.tar.gz: 2a2cd5896bf6966db23d612a05f481c41b44735ee8a36e4ea7bd1c0d6e6b7a70
+  metadata.gz: 057f12398013c527127c67b8b6ff58ff7c791fc198be826220054b52eb3ca931
+  data.tar.gz: 8e6b4ad82981ec6f48b308fe1e06cde8d186e33b863137aa0f94fc61e854a482
 SHA512:
-  metadata.gz: 02a6978fad7e5c8d645af5e5994b610e1b71b3c618858de3a4d621c5387cb3964102e4306f0941b6c117b710ccc1d46e2a52b45a738bbb288d663da1949426bf
-  data.tar.gz: ec8cffd46a7cd02fe812713fd87123af1ffbd880f19d79b45b8ad731def893148d2069084211ee6125ea0893971a8c83decaecc996781e8aca89be083e9aecde
+  metadata.gz: 100427e87bc7c51add63a4192af5b6e87a49ffd06125aa7dfd5169c0ea21d3d25a87bbcd0a6620948f2858246297ac4a15cc53cb9fe77fbb340cea10974ed74a
+  data.tar.gz: eea1a96c7862fbf5a60db16969acf8c4c335b0394bfdd20cd5762e15634dda0383229b6eacfa6510fb0a43487faea564630eca54b58fae7db505c4cd6ff48c59

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

@@ -1,18 +1,19 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require 'console'
+require "console"
 
-require 'action_controller/log_subscriber'
+require "active_support/log_subscriber"
+require "action_controller/log_subscriber"
 
 module Console
 	module Adapter
-		# A Rails adapter for the console logger.
 		module Rails
+			# ActionController integration for Console logger. Provides log subscribers that convert Rails ActionController events into Console-compatible log messages.
 			module ActionController
-				# A Rails log subscriber which is compatible with `Console::Logger`. It receives events from `ActiveSupport::Notifications` and logs them to the console.
+				# 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.
 					#
@@ -46,7 +47,7 @@ module Console
 						
 						if response and headers = response.headers
 							# Extract redirect location if any:
-							location = response.headers['Location'] || response.headers['location']
+							location = response.headers["Location"] || response.headers["location"]
 							if location
 								payload[:location] = location
 							end
@@ -59,6 +60,9 @@ module Console
 					end
 				end
 				
+				# Attach the log subscriber to ActionController events.
+				#
+				# @parameter notifications [ActiveSupport::Notifications] The notifications system to attach to.
 				def self.apply!(notifications: ActiveSupport::Notifications)
 					LogSubscriber.attach_to(:action_controller, LogSubscriber.new, notifications)
 				end

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

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require 'console'
+require "console"
 
-require 'active_record/log_subscriber'
+require "active_support/log_subscriber"
+require "active_record/log_subscriber"
 
 module Console
 	module Adapter
 		module Rails
+			# ActiveRecord integration for Console logger. Provides log subscribers that convert Rails ActiveRecord events into Console-compatible log messages.
 			module ActiveRecord
+				# Represents a Rails log subscriber which is compatible with `Console::Logger`. It receives SQL events from `ActiveSupport::Notifications` and logs them to the console.
 				class LogSubscriber < ::ActiveSupport::LogSubscriber
 					IGNORE_PAYLOAD_NAMES = ["SCHEMA", "EXPLAIN", "TRANSACTION"]
 					
@@ -61,10 +64,13 @@ module Console
 					end
 				end
 				
+				# Attach the log subscriber to ActiveRecord events.
+				#
+				# @parameter notifications [ActiveSupport::Notifications] The notifications system to attach to.
 				def self.apply!(notifications: ActiveSupport::Notifications)
 					LogSubscriber.attach_to(:active_record, LogSubscriber.new, notifications)
 				end
 			end
 		end
 	end
-end
+end

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

@@ -1,19 +1,26 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
+# Copyright, 2024, by Michael Adams.
 
-require 'console/compatible/logger'
+require "console/compatible/logger"
 
-require 'fiber/storage'
-require 'active_support/logger'
-require 'active_support/tagged_logging'
-require 'active_support/logger_silence'
+require "fiber/storage"
+require "active_support/logger"
+require "active_support/tagged_logging"
+require "active_support/logger_silence"
 
 if ActiveSupport::Logger.respond_to?(:logger_outputs_to?)
 	# https://github.com/rails/rails/issues/44800
+	# Monkey patch to fix ActiveSupport::Logger compatibility.
+	# @namespace
 	module ActiveSupport
+		# Extension to ActiveSupport::Logger for compatibility.
 		class Logger
+			# Override to always return `true` for compatibility with Console logger.
+			#
+			# @returns [Boolean] Always returns `true`.
 			def self.logger_outputs_to?(*)
 				true
 			end
@@ -25,22 +32,32 @@ module Console
 	module Adapter
 		# A Rails adapter for the console logger.
 		module Rails
+			# Represents a Rails-compatible logger that extends Console::Compatible::Logger with support for silencing and fiber-local log levels.
 			class Logger < ::Console::Compatible::Logger
+				# Initialize the logger with fiber-local silence support.
 				def initialize(...)
 					super
 					
 					@silence_key = :"#{self.class}.silence.#{object_id}"
 				end
 				
+				# Set the fiber-local log level for silencing.
+				# @parameter severity [Integer] The log level severity.
 				def local_level= severity
 					Fiber[@silence_key] = severity
 				end
 				
+				# Get the fiber-local log level.
+				# @returns [Integer | Nil] The current fiber-local log level, if any.
 				def local_level
 					Fiber[@silence_key]
 				end
 				
 				# Silences the logger for the duration of the block.
+				#
+				# @parameter severity [Integer] The minimum severity level to log.
+				# @yields {|logger| ...} Yields the logger instance to the block.
+				#	@parameter logger [Logger] The current logger instance.
 				def silence(severity = Logger::ERROR)
 					current = Fiber[@silence_key]
 					Fiber[@silence_key] = severity
@@ -49,18 +66,28 @@ module Console
 					Fiber[@silence_key] = current
 				end
 				
+				# Check if the logger is silenced for the given severity level.
+				#
+				# @parameter severity [Integer] The log level severity to check.
+				# @returns [Boolean] `true` if the logger is silenced for this severity.
 				def silenced?(severity)
 					if current = Fiber[@silence_key]
 						severity < current
 					end
 				end
 				
+				# Add a log message, respecting the silence level.
+				# @parameter severity [Integer] The log level severity.
+				# @parameter message [String | Nil] The log message.
+				# @parameter progname [String | Nil] The program name.
 				def add(severity, message = nil, progname = nil, &block)
 					return if silenced?(severity)
 					
 					super(severity, message, progname, &block)
 				end
 				
+				# Configure Rails to use the Console logger.
+				# @parameter configuration [Rails::Configuration] The Rails configuration object to update.
 				def self.apply!(configuration: ::Rails.configuration)
 					# Set the logger to a compatible logger to catch `Rails.logger` output:
 					configuration.logger = ActiveSupport::TaggedLogging.new(

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

@@ -1,36 +1,46 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2024, by Michael Adams.
+# Copyright, 2024, by Samuel Williams.
+# Copyright, 2025, by Jun Jiang.
 
-require 'action_controller/log_subscriber'
-require 'action_view/log_subscriber'
+require "action_controller/log_subscriber"
+require "action_view/log_subscriber"
 
 module Console
 	module Adapter
 		module Rails
 			# Hook into Rails startup process and replace Rails.logger with our custom hooks
 			class Railtie < ::Rails::Railtie
-				initializer 'console.adapter.rails', before: :initialize_logger do |app|
+				initializer "console.adapter.rails", before: :initialize_logger do |app|
 					# 1. 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
-					::ActionController::LogSubscriber.detach_from :action_controller
-
+					if ::ActionController::LogSubscriber < ::ActiveSupport::LogSubscriber
+						::ActionController::LogSubscriber.detach_from :action_controller
+					else
+						::ActiveSupport.event_reporter.unsubscribe(::ActionController::LogSubscriber)
+					end
+					
 					# Silence the default action view logs, e.g. "Rendering text template" etc
-					::ActionView::LogSubscriber.detach_from :action_view
+					if ::ActionView::LogSubscriber < ::ActiveSupport::LogSubscriber
+						::ActionView::LogSubscriber.detach_from :action_view
+					else
+						::ActiveSupport.event_reporter.unsubscribe(::ActionView::LogSubscriber)
+					end
 				end
-
+				
 				config.after_initialize do
 					# 4. Add a new log subscriber for ActionController
 					ActionController.apply!
-
+					
 					# 5. (optionally) Add a new log subscriber for ActiveRecord
 					# ActiveRecord.apply!
 				end

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

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
+# @namespace
 module Console
+	# @namespace
 	module Adapter
+		# @namespace
 		module Rails
-			VERSION = "0.4.0"
+			VERSION = "0.5.0"
 		end
 	end
 end

data/lib/console/adapter/rails.rb

@@ -1,20 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023, by Samuel Williams.
+# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2024, by Michael Adams.
 
-require_relative 'rails/logger'
-require_relative 'rails/action_controller'
-require_relative 'rails/active_record'
-require_relative 'rails/railtie'
-
-module Console
-	module Adapter
-		# A Rails adapter for the console logger.
-		module Rails
-			# Placeholder to remain compatible with older clients
-			def self.apply!
-			end
-		end
-	end
-end
+require_relative "rails/logger"
+require_relative "rails/action_controller"
+require_relative "rails/active_record"
+require_relative "rails/railtie" if defined?(Rails::Railtie)

data/license.md

@@ -1,6 +1,9 @@
 # MIT License
 
-Copyright, 2023, by Samuel Williams.  
+Copyright, 2023-2025, by Samuel Williams.  
+Copyright, 2023, by Joshua Young.  
+Copyright, 2024, by Michael Adams.  
+Copyright, 2025, by Jun Jiang.  
 
 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

@@ -2,8 +2,7 @@
 
 Adapt Rails event logs for `console`.
 
-[![Development
-Status](https://github.com/socketry/console-adapter-rails/workflows/Test/badge.svg)](https://github.com/socketry/console-adapter-rails/actions?workflow=Test)
+[![Development Status](https://github.com/socketry/console-adapter-rails/workflows/Test/badge.svg)](https://github.com/socketry/console-adapter-rails/actions?workflow=Test)
 
 ## Usage
 
@@ -23,10 +22,8 @@ We welcome contributions to this project.
 
 ### Developer Certificate of Origin
 
-This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this
-project must agree to this document to have their contributions accepted.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and
-participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,11 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: console-adapter-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire:
+- Joshua Young
+- Jun Jiang
+- Michael Adams
 bindir: bin
 cert_chain:
 - |
@@ -37,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-04-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -54,35 +56,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.21'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: fiber-storage
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: fiber-storage
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.1'
-description:
-email:
+        version: '7.0'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -100,7 +100,7 @@ licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/console-adapter-rails/
-post_install_message:
+  source_code_uri: https://github.com/socketry/console-adapter-rails.git
 rdoc_options: []
 require_paths:
 - lib
@@ -108,15 +108,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Adapt Rails logs and events to the console gem.
 test_files: []