console-adapter-rails 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4e48e85afc72be9449b0da7dcc6ea25c3333daaafe092062429ea8944fcca98
-  data.tar.gz: 3c325105475e32b6099d9eb35c7fe6ec2ec6990ef920c2b07cb03e4c4d211206
+  metadata.gz: 87a3133534ae9fef350296fe8f70381f69506077331665169523a7a59fef0786
+  data.tar.gz: c23583428a0b77f235b72e2c83b57818e53da8581d9087a739d30cf33e6b535e
 SHA512:
-  metadata.gz: d0265cf56ce46b5fac25cc1c3efccc071951b84d57e46d8e572ea5f16a8a70cacc2ea2645d9696acf4ccf5bfcaa1233d7dbd360da9b6738d483c534ca85eb785
-  data.tar.gz: 3f7377560820af3bd579778be6d85f15a0a83846eff9c1eca3e25a0957df0996010d8fcdfbb31f7a6f156d585cb42223c1bb1094d1b1e2c0ef8ad5591f6cd3fa
+  metadata.gz: f8d8d61c59a6c62fc9dbac96c1dbe7e60f00dc3cfd79322cc2e15a4bf7ea37a563516ac682994c96375a69ec5d9cd7cff1ff13b901df33f8b49aacbcf8f4e0cf
+  data.tar.gz: 5a3431fdcbe71b50d272ea61f0d56295b4a19520e77ee03cb7f42995faa884f35aab8dc01ed5b5c29702e5ec956e9061eb9c99176d7d8a4db386e24ee76ae575

data/context/getting-started.md

@@ -0,0 +1,15 @@
+# Getting Started
+
+This guide explains how to integrate the `console-adapter-rails` gem into your Rails application.
+
+## Installation
+
+Add the gem to your project:
+
+~~~ bash
+$ bundle add console-adapter-rails
+~~~
+
+The gem includes a Railtie that will set up all required logging configuration for you.
+
+If you wish to log ActiveRecord, add `Console::Adapter::Rails::ActiveRecord.apply!` into your `config/environment.rb` file, before the `Rails.application.initialize!` call.

data/context/index.yaml

@@ -0,0 +1,12 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: Adapt Rails logs and events to the console gem.
+metadata:
+  documentation_uri: https://socketry.github.io/console-adapter-rails/
+  source_code_uri: https://github.com/socketry/console-adapter-rails.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains how to integrate the `console-adapter-rails` gem
+    into your Rails application.

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

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require 'console'
+require "console"
 
-require 'active_support/log_subscriber'
-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.
 					#
@@ -47,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
@@ -60,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,17 +1,19 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
-require 'console'
+require "console"
 
-require 'active_support/log_subscriber'
-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"]
 					
@@ -62,6 +64,9 @@ 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

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

@@ -1,20 +1,26 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2023-2024, 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
@@ -26,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
@@ -50,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

@@ -3,35 +3,44 @@
 # Released under the MIT License.
 # 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-2024, by Samuel Williams.
+# Copyright, 2023-2025, by Samuel Williams.
 
+# @namespace
 module Console
+	# @namespace
 	module Adapter
+		# @namespace
 		module Rails
-			VERSION = "0.4.1"
+			VERSION = "0.5.1"
 		end
 	end
 end

data/lib/console/adapter/rails.rb

@@ -4,7 +4,7 @@
 # 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/logger"
+require_relative "rails/action_controller"
+require_relative "rails/active_record"
 require_relative "rails/railtie" if defined?(Rails::Railtie)

data/license.md

@@ -1,8 +1,9 @@
 # MIT License
 
-Copyright, 2023-2024, 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

@@ -10,6 +10,14 @@ Please see the [project documentation](https://socketry.github.io/console-adapte
 
   - [Getting Started](https://socketry.github.io/console-adapter-rails/guides/getting-started/index) - This guide explains how to integrate the `console-adapter-rails` gem into your Rails application.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/console-adapter-rails/releases/index) for all releases.
+
+### v0.5.0
+
+  - Improved compatibilty with Rails 8+.
+
 ## Contributing
 
 We welcome contributions to this project.

data/releases.md

@@ -0,0 +1,5 @@
+# Releases
+
+## v0.5.0
+
+  - Improved compatibilty with Rails 8+.

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: console-adapter-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Samuel Williams
 - Joshua Young
+- Jun Jiang
 - Michael Adams
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -39,7 +39,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: console
@@ -75,20 +75,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
-description:
-email:
+        version: '7.0'
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- context/getting-started.md
+- context/index.yaml
 - lib/console/adapter/rails.rb
 - lib/console/adapter/rails/action_controller.rb
 - lib/console/adapter/rails/active_record.rb
@@ -97,13 +97,13 @@ files:
 - lib/console/adapter/rails/version.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/console-adapter-rails
 licenses:
 - MIT
 metadata:
   documentation_uri: https://socketry.github.io/console-adapter-rails/
   source_code_uri: https://github.com/socketry/console-adapter-rails.git
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,15 +111,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Adapt Rails logs and events to the console gem.
 test_files: []