console-adapter-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0482a25ab09b8ca5a4cd8b52c7509da5626a5a9c66c623d2d370348bc6701846'
+  data.tar.gz: f10ed2abff10dc4a103b7d2b23e57e2586f13f1e0f5c156335f89ec204077f95
+SHA512:
+  metadata.gz: 8259a2f4a8177535c620c77933d9ec09688392119cdc344b4118817bb8e16447eb9ca1d73f3dccd04728bdff3d2ea9b83046331399c8abdc1fa7efa058d15461
+  data.tar.gz: b6d4b017db0f3e69f871551884a1f4144d029f3caad6bfd1568e695ede9d77428dcdabd303f5a5690bc25fea52dbf8149164fec46e59f4a2a1f68d3a8a267f65

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

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

data/lib/console/adapter/rails.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'console'
+
+require 'active_support/log_subscriber'
+require 'action_controller/log_subscriber'
+require 'action_view/log_subscriber'
+require 'active_job/log_subscriber'
+
+module Console
+	module Adapter
+		# A Rails adapter for the console logger.
+		module Rails
+			# 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 controller action events.
+				#
+				# Includes the following fields:
+				# - `subject`: "process_action.action_controller"
+				# - `controller`: The name of the controller.
+				# - `action`: The action performed.
+				# - `format`: The format of the response.
+				# - `method`: The HTTP method of the request.
+				# - `path`: The path of the request.
+				# - `status`: The HTTP status code of the response.
+				# - `view_runtime`: The time spent rendering views.
+				# - `db_runtime`: The time spent querying the database.
+				# - `location`: The redirect location if any.
+				# - `allocations`: The number of allocations performed.
+				# - `duration`: The total time spent processing the request.
+				def process_action(event)
+					payload = event.payload.dup
+					
+					# This may contain sensitive information:
+					params = payload.delete(:params)
+					
+					# These objects are not useful and may not serialize correctly:
+					headers = payload.delete(:headers)
+					request = payload.delete(:request)
+					response = payload.delete(:response)
+					
+					# Extract redirect location if any:
+					location = response.headers['Location'] || response.headers['location']
+					if location
+						payload[:location] = location
+					end
+					
+					payload[:allocations] = event.allocations
+					payload[:duration] = event.duration
+					
+					Console.logger.info(event.name, **payload)
+				end
+			end
+			
+			# Apply the Rails adapter to the current process and Rails application.
+			# @parameter notifications [ActiveSupport::Notifications] The notifications object to use.
+			# @parameter configuration [Rails::Configuration] The configuration object to use.
+			def self.apply!(notifications: ActiveSupport::Notifications, configuration: ::Rails.configuration)
+				if notifications
+					# Clear out all the existing subscribers otherwise you'll get double the logs:
+					notifications.notifier = ActiveSupport::Notifications::Fanout.new
+				end
+				
+				if configuration
+					# Set the logger to a compatible logger to catch `Rails.logger` output:
+					configuration.logger = Console::Compatible::Logger.new("Rails", Console.logger)
+					# Delete `Rails::Rack::Logger` as it also doubles up on request logs:
+					configuration.middleware.delete ::Rails::Rack::Logger
+				end
+				
+				# Attach our log subscriber for action_controller events:
+				LogSubscriber.attach_to(:action_controller, LogSubscriber.new, notifications)
+			end
+		end
+	end
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2023, by Samuel Williams.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,33 @@
+# Console::Adapter::Rails
+
+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)
+
+## Usage
+
+Please see the [project documentation](https://github.com/socketry/console-adapter-rails) for more details.
+
+  - [Getting Started](https://github.com/socketry/console-adapter-railsguides/getting-started/index) - This guide
+    explains how to integrate the `console-adapter-rails` gem into your Rails application.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-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.
+
+### 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.
+
+### Contributor Covenant
+
+This project is governed by [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and
+participants agree to abide by its terms.

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: console-adapter-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2023-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/console/adapter/rails.rb
+- lib/console/adapter/rails/version.rb
+- license.md
+- readme.md
+homepage: https://github.com/socketry/console-adapter-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Adapt Rails logs and events to the console gem.
+test_files: []