any_logger 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2358954386fe713d2a0ecd983defb8d9490cb0e343c19fb7837984d031a1bd2
+  data.tar.gz: 7885ea10527db0410b819c16e91b9baf7f503ceb380f69a5098cf948e72536ac
+SHA512:
+  metadata.gz: 32f35f4c25058f116c5503bdd750a198e3ad6e14924d9075882226b15357aa3b6b565ce8b3d6a10bcfcaf3a0d11f09d161186759a107470d66fef8669d64f21d
+  data.tar.gz: acccf7756be61b8171373dcd9e96087951c41954a67eb69a77ed282204b862298ddc6badb9b98698b11ea28e8defb38b5a784c30bf1bbad050ddb25627771e6e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 3.4.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.4.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-14
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 milkeclair
+
+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,16 @@
+# AnyLogger
+
+Easier to change LogSubscribers in rails.
+
+### Example
+
+```ruby
+AnyLogger.configure do |config|
+  config.logger = Rails::Rack::Logger # default: AnyLogger::Example::RackLogger
+  config.swap :action_controller, AnyLogger::Example::ControllerSubscriber
+  config.detach :action_view
+  config.attach :active_record, MyLogger::ModelSubscriber
+end
+
+AnyLogger.start
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/any_logger/configuration.rb

@@ -0,0 +1,72 @@
+require "singleton"
+require "active_support"
+require "active_support/core_ext/string/inflections"
+require "action_controller/log_subscriber"
+require "active_record/log_subscriber"
+require "action_view/log_subscriber"
+require "action_mailer/log_subscriber"
+require "action_dispatch/log_subscriber"
+require "active_job/log_subscriber"
+require "active_storage/log_subscriber"
+require_relative "example/rack_logger"
+
+module AnyLogger
+  class Configuration
+    include Singleton
+
+    DEFAULT_SUBSCRIBERS = {
+      action_controller: ActionController::LogSubscriber,
+      active_record: ActiveRecord::LogSubscriber,
+      action_view: ActionView::LogSubscriber,
+      action_mailer: ActionMailer::LogSubscriber,
+      action_dispatch: ActionDispatch::LogSubscriber,
+      active_job: ActiveJob::LogSubscriber,
+      active_storage: ActiveStorage::LogSubscriber
+    }
+
+    DEFAULT_SUBSCRIBER_OPTIONS = { klass: nil, detachable: false, attachable: false }
+
+    private_constant :DEFAULT_SUBSCRIBER_OPTIONS
+
+    attr_reader :config
+
+    def initialize
+      @config = {
+        logger: ::AnyLogger::Example::RackLogger,
+        subscribers: DEFAULT_SUBSCRIBERS.dup.transform_values { |k| DEFAULT_SUBSCRIBER_OPTIONS.dup.merge(klass: k) }
+      }
+    end
+
+    def logger
+      @config[:logger]
+    end
+
+    def logger=(klass)
+      @config[:logger] = klass
+    end
+
+    def subscribers
+      @config[:subscribers]
+    end
+
+    def swap(key, klass)
+      return unless @config[:subscribers].key?(key)
+
+      @config[:subscribers][key] = { klass: klass, detachable: true, attachable: true }
+    end
+
+    def detach(key, klass = nil)
+      return unless @config[:subscribers].key?(key)
+
+      @config[:subscribers][key][:detachable] = true
+      @config[:subscribers][key][:klass] = klass if klass
+    end
+
+    def attach(key, klass)
+      return unless @config[:subscribers].key?(key)
+
+      @config[:subscribers][key][:attachable] = true
+      @config[:subscribers][key][:klass] = klass
+    end
+  end
+end

data/lib/any_logger/example/controller_subscriber.rb

@@ -0,0 +1,109 @@
+require "active_support/log_subscriber"
+require "rack/utils"
+
+module AnyLogger
+  module Example
+    class ControllerSubscriber < ActiveSupport::LogSubscriber
+      UNNECESSARY_PATHS = ["/favicon.ico"]
+
+      REDIRECT_CODES = [:moved_permanently, :found, :see_other, :temporary_redirect, :permanent_redirect]
+
+      private_constant :UNNECESSARY_PATHS, :REDIRECT_CODES
+
+      def process_action(event)
+        @event = event
+        @payload = event.payload
+        @headers = @payload[:response].headers.symbolize_keys if @payload[:response]&.headers
+
+        return if match_unnecessary_path?
+
+        info { formatted_message }
+      end
+
+      # @example
+      #
+      #   [GET] HogeController#index for: 127.0.0.1 at: 2025-01-01 00:00:00 +0900
+      #     path: "/hoge?foo=bar"
+      #     status: 200 in 100ms (view: 50ms | db: 50ms)
+      #     params: {"foo" => "bar"}
+      #     redirect: "/fuga"
+      private def formatted_message
+        <<~MESSAGE
+
+          #{l_method} #{l_action} #{l_for} #{l_at}
+            #{l_path}
+            #{l_status} #{l_duration} (#{l_view_runtime} | #{l_db_runtime})
+            #{"#{l_params}\n" if @payload[:params].present?}#{l_redirect if @headers[:location].present?}
+        MESSAGE
+      end
+
+      private def match_unnecessary_path?
+        UNNECESSARY_PATHS.include?(@payload[:path])
+      end
+
+      private def l_method
+        "[#{@payload[:method].upcase}]"
+      end
+
+      private def l_action
+        "#{@payload[:controller]}##{@payload[:action]}"
+      end
+
+      private def l_for
+        "for: #{@payload[:request].remote_ip}"
+      end
+
+      private def l_at
+        "at: #{conversion_event_time_to_datetime}"
+      end
+
+      private def l_path
+        "🔍 path: \"#{@payload[:path]}\""
+      end
+
+      private def l_status
+        "🧱 status: #{@payload[:status]}"
+      end
+
+      private def l_duration
+        "in #{@event.duration&.round(2) || 0}ms"
+      end
+
+      private def l_view_runtime
+        "view: #{@payload[:view_runtime]&.round(2) || 0}ms"
+      end
+
+      private def l_db_runtime
+        "db: #{@payload[:db_runtime]&.round(2) || 0}ms"
+      end
+
+      private def l_params
+        @payload[:params] = except_unnecessary_params
+        "📝 params: #{@payload[:params]&.inspect || {}}"
+      end
+
+      private def l_redirect
+        return unless REDIRECT_CODES.any? { @payload[:status] == Rack::Utils.status_code(it) }
+
+        ellipsised_url = ellipsis_scheme_and_authority(@headers[:location])
+        "🚀 redirect: \"#{ellipsised_url}\""
+      end
+
+      private def conversion_event_time_to_datetime
+        now_monotonic = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        elapsed = now_monotonic - @event.time
+        now = Time.now.to_f
+
+        Time.at((now - elapsed).to_i)
+      end
+
+      private def except_unnecessary_params
+        @payload[:params].except("controller", "action")
+      end
+
+      private def ellipsis_scheme_and_authority(url)
+        url.gsub(/\Ahttps?:\/\/[^\/]+/, "")
+      end
+    end
+  end
+end

data/lib/any_logger/example/rack_logger.rb

@@ -0,0 +1,17 @@
+require "active_support/log_subscriber"
+
+module AnyLogger
+  module Example
+    class RackLogger
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      ensure
+        ActiveSupport::LogSubscriber.flush_all!
+      end
+    end
+  end
+end

data/lib/any_logger/initializer.rb

@@ -0,0 +1,23 @@
+module AnyLogger
+  class Initializer
+    def self.run
+      swap_default_logger
+      change_subscribers
+    end
+
+    private_class_method def self.swap_default_logger
+      Rails.application.config.middleware.swap(Rails::Rack::Logger, AnyLogger.config.logger)
+    end
+
+    private_class_method def self.change_subscribers
+      Configuration::DEFAULT_SUBSCRIBERS.each do |key, default_subscriber|
+        subscribers = AnyLogger.config.subscribers
+        detachable = subscribers[key][:detachable]
+        attachable = subscribers[key][:attachable]
+
+        default_subscriber.detach_from(key) if detachable
+        subscribers[key][:klass].attach_to(key) if attachable
+      end
+    end
+  end
+end

data/lib/any_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AnyLogger
+  VERSION = "0.1.1"
+end

data/lib/any_logger.rb

@@ -0,0 +1,21 @@
+require_relative "any_logger/version"
+require_relative "any_logger/configuration"
+require_relative "any_logger/initializer"
+
+module AnyLogger
+  def self.configure(&block)
+    block.call(config)
+  end
+
+  def self.start
+    Initializer.run
+  end
+
+  def self.config
+    Configuration.instance
+  end
+
+  def self.subscribers
+    config.config[:subscribers]
+  end
+end

data/sig/any_logger.rbs

@@ -0,0 +1,4 @@
+module AnyLogger
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: any_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- milkeclair
+bindir: exe
+cert_chain: []
+date: 2025-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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: activejob
+  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: activerecord
+  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: activestorage
+  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: activesupport
+  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'
+description: easy swap for LogSubscribers in rails
+email:
+- milkeclair.black@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/any_logger.rb
+- lib/any_logger/configuration.rb
+- lib/any_logger/example/controller_subscriber.rb
+- lib/any_logger/example/rack_logger.rb
+- lib/any_logger/initializer.rb
+- lib/any_logger/version.rb
+- sig/any_logger.rbs
+homepage: https://github.com/milkeclair/any_logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/milkeclair/any_logger
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: easy swap for LogSubscribers in rails
+test_files: []