any_logger 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b26a8df3ee6ce7ee55d83fc442b93692952e9f5b5d91cd47dbaf0c44ce9fcd0f
-  data.tar.gz: e3dbad423f82581ac1051103a82d0ba1eef69418351c7c916ec13375585ae5d4
+  metadata.gz: de56cdda136e683ae52ee87f6a0cb802792f1e3aa1c6e946ade58b6dde832664
+  data.tar.gz: 9760f9c169b6d1f721e353d2a995b3da7ed07218cfd3f9d7ff1d7f7bd58417cf
 SHA512:
-  metadata.gz: 20defb8b3a5791d1e691f85bc9bd0774b013cbd43bb473b463ab0e03250cb4d5149e27ebb31f2b9f4a5a96440dfc25e13cfe0bfb8e008cc4268732b12df0e4d8
-  data.tar.gz: 7f18668828179449c462dd18a23fe60357ef0e314026faaccb6939e3c54f68d7d0b959dea66d2055713fde2e41bf655e2ea920afa5b8bef313050ad3d6b79670
+  metadata.gz: c3f6346e9da6a573bddc918a41195a7827c9d34086c3ab1a5b47290017615ef1c5d182968ee06a94d8eab2b31d672533cf7166fb7109849d327a7e39e5455dfb
+  data.tar.gz: de5672b026af7fbf51619d947e72ca52495781fc39397c559b10ca467227fb3811e61555eac684310b219e1628007dea3220f19ae0f5571e44cfeb46266723b6

data/.rubocop.yml

@@ -27,3 +27,9 @@ Style/RegexpLiteral:
 
 Bundler/OrderedGems:
   Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false

data/CHANGELOG.md

@@ -7,3 +7,11 @@
 ## [0.1.2] - 2025-01-14
 
 - detach, attach, swapが正常に動作していなかったのを修正
+
+## [0.1.3] - 2025-01-15
+
+- AnyLogger.startをデフォルトで不要に変更
+
+## [0.1.4] - 2025-01-15
+
+- Example::ControllerSubscriberのログの改行位置がおかしかったのを修正

data/README.md

@@ -1,19 +1,18 @@
 # AnyLogger
 
-Easier to change LogSubscribers in rails.
+A DSL for simplifying modification of Rails LogSubscribers
 
 ### Example
 
 ```ruby
+# initializers/any_logger.rb
 require "any_logger"
 require "any_logger/example/controller_subscriber"
 
 AnyLogger.configure do |config|
   config.logger = Rails::Rack::Logger # default: AnyLogger::Example::RackLogger
   config.swap :action_controller, AnyLogger::Example::ControllerSubscriber
-  config.detach :active_record
+  config.detach :action_view
   config.attach :active_record, MyLogger::ModelSubscriber
 end
-
-AnyLogger.start
 ```

data/lib/any_logger/example/controller_subscriber.rb

@@ -28,65 +28,44 @@ module AnyLogger
       #     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
+        e = formatted_log_details
+        # ヒアドキュメントだとparamsとredirectの有無で改行の入り方が変わってしまうので、配列を結合する方法を採用
+        lines = []
+        lines << ""
+        lines << "[#{e[:method]}] #{e[:controller]}##{e[:action]} for: #{e[:ip]} at: #{e[:datetime]}"
+        lines << "  🔍 path: \"#{e[:path]}\""
+        lines << "  🧱 status: #{e[:status]} in #{e[:duration]}ms " \
+                 "(view: #{e[:view_runtime]}ms | db: #{e[:db_runtime]}ms)"
+        lines << "  📝 params: #{e[:params]}" if @payload[:params].present?
+        lines << "  🚀 redirect: \"#{e[:redirect_to]}\"" if @headers[:location].present?
+        lines.join("\n")
       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
+      private def formatted_log_details
+        {
+          method: @payload[:method].upcase,
+          controller: @payload[:controller],
+          action: @payload[:action],
+          ip: @payload[:request].remote_ip,
+          datetime: conversion_event_time_to_datetime,
+          path: @payload[:path],
+          status: @payload[:status],
+          duration: round_value(@event.duration),
+          view_runtime: round_value(@payload[:view_runtime]),
+          db_runtime: round_value(@payload[:db_runtime]),
+          params: expect_unnecessary_params || {},
+          redirect_to: formatted_redirect_location
+        }
+      end
+
+      private def formatted_redirect_location
         return unless REDIRECT_CODES.any? { @payload[:status] == Rack::Utils.status_code(it) }
 
-        ellipsised_url = ellipsis_scheme_and_authority(@headers[:location])
-        "🚀 redirect: \"#{ellipsised_url}\""
+        ellipsis_scheme_and_authority(@headers[:location])
       end
 
       private def conversion_event_time_to_datetime
@@ -97,6 +76,10 @@ module AnyLogger
         Time.at((now - elapsed).to_i)
       end
 
+      private def round_value(value)
+        value&.round(2) || 0
+      end
+
       private def except_unnecessary_params
         @payload[:params].except("controller", "action")
       end

data/lib/any_logger/version.rb

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

data/lib/any_logger.rb

@@ -3,8 +3,9 @@ require_relative "any_logger/configuration"
 require_relative "any_logger/initializer"
 
 module AnyLogger
-  def self.configure(&block)
+  def self.configure(auto_startable: true, &block)
     block.call(config)
+    start if auto_startable
   end
 
   def self.start

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: any_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - milkeclair
@@ -93,7 +93,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: easy swap for LogSubscribers in rails
+description: A DSL for simplifying modification of Rails LogSubscribers
 email:
 - milkeclair.black@gmail.com
 executables: []
@@ -135,5 +135,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: easy swap for LogSubscribers in rails
+summary: A DSL for simplifying modification of Rails LogSubscribers
 test_files: []