any_logger 0.1.5 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165c98ee85c05ca25d605f1f183afe9378bb7f14c1d0b9a8179bbd2a5000accc
-  data.tar.gz: a3904fb46fe860748e01546c434988ec99666189dea7ef1b35e98e768936e0a2
+  metadata.gz: 3ce22730112cf7d85f3f6bbbd9121953414ddf2340dec1c1345f1fa029f00cf2
+  data.tar.gz: 369a2346c8b527a95f8c12a5c0bb28b0775e9dc3b161760e07fae48bdc554a63
 SHA512:
-  metadata.gz: fa55349de040b2afe0abc46c16de65204ad43d9f15377788aac3719367b7ac2a7638f653214e9cc2c3adaa471f899cd436dad644f935eb7732cf15139d2310f1
-  data.tar.gz: d3c6a6b60ae6b57d08077bba36612323a3425e74d1c7ac2f8c491383395c6661b812d650e388d51780232accf54cf11b9a1660d0fb931bfa771536efa11964a8
+  metadata.gz: f16b68080e058b6fd5b57e9439b887a5961f6dcaa17376d03e07fdd77cce0f8f11baefd7dc583dd1f229c571b5d59f79f581e57973637d0dec7ccc9aa4d7d892
+  data.tar.gz: 03f93b241f571c798b576278916536d0d518ae25c89fe3851fdd8f26d9d7796f3469636505a796cefe145eca256773e9b1cfc9bc68a78ed0f36bb1575b974f15

data/CHANGELOG.md

@@ -19,3 +19,13 @@
 ## [0.1.5] - 2025-01-15
 
 - except_unnecessary_paramsをexpectに誤字していたのを修正
+
+## [0.2.0] - 2025-01-19
+
+- process_action.action_controllerのような個別のイベントに対応
+
+## [0.2.1] - 2025-01-20
+
+- Example::ControllerSubscriberのparamsに関するログが、paramsが空の場合にも出力される問題を修正
+- config.subscriber.detach :action_viewをしたときに、
+  ActionView::LogSubscriberがデフォルトでsubscribeするイベントをunsubscribeするように変更

data/README.md

@@ -1,6 +1,6 @@
 # AnyLogger
 
-A DSL for simplifying modification of Rails LogSubscribers
+A DSL for simplifying modification of Rails ActiveSupport Instrumentation API
 
 ### Example
 
@@ -11,8 +11,16 @@ require "any_logger/example/controller_subscriber"
 
 AnyLogger.configure do |config|
   config.logger = Rails::Rack::Logger # default: AnyLogger::Example::RackLogger
+
+  config.subscriber.attach :action_mailer, MyLogger::ModelSubscriber
+  # If you call swap, detach, or attach directly in config, the subscriber will be set
   config.swap :action_controller, AnyLogger::Example::ControllerSubscriber
   config.detach :action_view
-  config.attach :active_record, MyLogger::ModelSubscriber
+
+  # Event can be attached using either a class or a block
+  config.event.swap :active_record, :sql, MyLogger::ActiveRecord::Sql
+  config.event.attach :active_job, :discard do |event|
+    MyErrorReporter.notify(event)
+  end
 end
 ```

data/lib/any_logger/configuration/event.rb

@@ -0,0 +1,97 @@
+require "active_support/notifications"
+
+module AnyLogger
+  class Configuration
+    class Event
+      Detach = Struct.new(:organizer, :event)
+      Attach = Struct.new(:organizer, :event, :subscriber)
+
+      DEFAULT_ATTACHED_EVENTS = {
+        action_view: [:render_template, :render_layout]
+      }
+
+      private_constant :DEFAULT_ATTACHED_EVENTS
+
+      def swap(organizer, event, subscriber = nil, &block)
+        @organizer = organizer
+        @event = event
+        @subscriber = subscriber
+        @block = block
+
+        detach(organizer, event)
+        attach(organizer, event, subscriber, &block)
+      end
+
+      def detach(organizer, event)
+        @organizer ||= organizer
+        @event ||= event
+
+        push_detach_to_subscriptions
+        detach_from_event
+      end
+
+      def detaches_default_attached_for(organizer)
+        return unless DEFAULT_ATTACHED_EVENTS[organizer]
+
+        DEFAULT_ATTACHED_EVENTS[organizer].each { |event| detach(organizer, event) }
+      end
+
+      def attach(organizer, event, subscriber = nil, &block)
+        @organizer ||= organizer
+        @event ||= event
+        @subscriber ||= subscriber
+        @block ||= block
+
+        validate_provided_block_or_subscriber
+        validate_unless_provided_block_and_subscriber
+        validate_subscriber_is_callable
+
+        push_attach_to_subscriptions
+        attach_to_event
+      end
+
+      private def event_name
+        "#{@event}.#{@organizer}"
+      end
+
+      private def push_detach_to_subscriptions
+        AnyLogger.config.subscriptions << Detach.new(@organizer, @event)
+      end
+
+      private def push_attach_to_subscriptions
+        AnyLogger.config.subscriptions << Attach.new(@organizer, @event, @subscriber || @block)
+      end
+
+      private def detach_from_event
+        ActiveSupport::Notifications.unsubscribe(event_name)
+      end
+
+      private def attach_to_event
+        # LogSubscriber#attach_toはmonotonic_subscribeなので、それに合わせる
+        if @subscriber
+          ActiveSupport::Notifications.monotonic_subscribe(event_name, @subscriber.new)
+        else
+          ActiveSupport::Notifications.monotonic_subscribe(event_name, &@block)
+        end
+      end
+
+      private def validate_provided_block_or_subscriber
+        return if @block || @subscriber
+
+        raise ArgumentError, "Block or subscriber must be provided"
+      end
+
+      private def validate_unless_provided_block_and_subscriber
+        return unless @block && @subscriber
+
+        raise ArgumentError, "Block and subscriber cannot be provided simultaneously"
+      end
+
+      private def validate_subscriber_is_callable
+        return unless @subscriber && !@subscriber.public_method_defined?(:call)
+
+        raise NoMethodError, "Subscriber must respond to #call"
+      end
+    end
+  end
+end

data/lib/any_logger/configuration/log_subscriber.rb

@@ -0,0 +1,74 @@
+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"
+
+module AnyLogger
+  class Configuration
+    class LogSubscriber
+      Detach = Struct.new(:organizer, :subscriber)
+      Attach = Struct.new(:organizer, :subscriber)
+
+      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
+      }
+
+      private_constant :DEFAULT_SUBSCRIBERS
+
+      def swap(organizer, subscriber, detach_target = nil)
+        @organizer = organizer
+        @subscriber = subscriber
+        @detach_target = detach_target || DEFAULT_SUBSCRIBERS[organizer]
+
+        detach(organizer, detach_target)
+        attach(organizer, subscriber)
+      end
+
+      def detach(organizer, detach_target = nil)
+        @organizer ||= organizer
+        @detach_target ||= detach_target || DEFAULT_SUBSCRIBERS[organizer]
+
+        validate_detach_target_is_set
+
+        push_detach_to_subscriptions
+        @detach_target.detach_from(@organizer)
+        event.detaches_default_attached_for(@organizer)
+      end
+
+      def attach(organizer, subscriber)
+        @organizer ||= organizer
+        @subscriber ||= subscriber
+
+        push_attach_to_subscriptions
+        @subscriber.attach_to(@organizer)
+      end
+
+      private def push_detach_to_subscriptions
+        AnyLogger.config.subscriptions << Detach.new(@organizer, @detach_target)
+      end
+
+      private def push_attach_to_subscriptions
+        AnyLogger.config.subscriptions << Attach.new(@organizer, @subscriber)
+      end
+
+      private def validate_detach_target_is_set
+        raise KeyError, "#{@organizer}'s default subscriber not found" unless @detach_target
+      end
+
+      private def event
+        AnyLogger.config.event
+      end
+    end
+  end
+end

data/lib/any_logger/configuration.rb

@@ -1,43 +1,18 @@
 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"
+require_relative "configuration/log_subscriber"
+require_relative "configuration/event"
 
 module AnyLogger
   class Configuration
     include Singleton
 
-    Subscriber = Struct.new(:subscription, :klass, :detachable, :attachable) do
-      def initialize(subscription, klass, detachable: false, attachable: false)
-        super(subscription, klass, detachable, attachable)
-      end
-    end
-
-    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
-    }
-
-    private_constant :DEFAULT_SUBSCRIBERS
-
     attr_reader :config
 
     def initialize
       @config = {
         logger: ::AnyLogger::Example::RackLogger,
-        subscribers: DEFAULT_SUBSCRIBERS.map { |key, klass| Subscriber.new(key, klass) }
+        subscriptions: []
       }
     end
 
@@ -46,34 +21,36 @@ module AnyLogger
     end
 
     def logger=(klass)
+      Rails.application.config.middleware.swap(logger, klass)
       @config[:logger] = klass
     end
 
-    def subscribers
-      @config[:subscribers]
+    def swap_default_logger
+      Rails.application.config.middleware.swap(Rails::Rack::Logger, logger)
     end
 
-    def swap(key, klass, target_klass = nil)
-      target_klass ||= DEFAULT_SUBSCRIBERS[key]
-      raise KeyError, "Default subscriber not found" unless target_klass
+    def subscriptions
+      @config[:subscriptions]
+    end
 
-      detach(key, target_klass)
-      attach(key, klass)
+    def subscriber
+      LogSubscriber.new
     end
 
-    def detach(key, klass = nil)
-      klass ||= DEFAULT_SUBSCRIBERS[key]
-      raise KeyError, "Default subscriber not found" unless klass
+    def event
+      Event.new
+    end
 
-      target_subscriber =
-        @config[:subscribers].find { it.subscription == key && it.klass == klass }
+    def swap(...)
+      subscriber.swap(...)
+    end
 
-      target_subscriber.detachable = true
-      target_subscriber.attachable = false
+    def detach(...)
+      subscriber.detach(...)
     end
 
-    def attach(key, klass)
-      @config[:subscribers] << Subscriber.new(key, klass, attachable: true)
+    def attach(...)
+      subscriber.attach(...)
     end
   end
 end

data/lib/any_logger/example/controller_subscriber.rb

@@ -36,7 +36,7 @@ module AnyLogger
         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 << "  📝 params: #{e[:params]}" if e[:params].present?
         lines << "  🚀 redirect: \"#{e[:redirect_to]}\"" if @headers[:location].present?
         lines.join("\n")
       end

data/lib/any_logger/version.rb

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

data/lib/any_logger.rb

@@ -1,22 +1,17 @@
 require_relative "any_logger/version"
 require_relative "any_logger/configuration"
-require_relative "any_logger/initializer"
 
 module AnyLogger
-  def self.configure(auto_startable: true, &block)
+  def self.configure(&block)
+    config.swap_default_logger
     block.call(config)
-    start if auto_startable
-  end
-
-  def self.start
-    Initializer.run
   end
 
   def self.config
     Configuration.instance
   end
 
-  def self.subscribers
-    config.subscribers
+  def self.subscriptions
+    config.subscriptions
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: any_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.1
 platform: ruby
 authors:
 - milkeclair
 bindir: exe
 cert_chain: []
-date: 2025-01-14 00:00:00.000000000 Z
+date: 2025-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -93,7 +93,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A DSL for simplifying modification of Rails LogSubscribers
+description: A DSL for simplifying modification of Rails ActiveSupport Instrumentation
+  API
 email:
 - milkeclair.black@gmail.com
 executables: []
@@ -109,9 +110,10 @@ files:
 - Rakefile
 - lib/any_logger.rb
 - lib/any_logger/configuration.rb
+- lib/any_logger/configuration/event.rb
+- lib/any_logger/configuration/log_subscriber.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
@@ -135,5 +137,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: A DSL for simplifying modification of Rails LogSubscribers
+summary: A DSL for simplifying modification of Rails ActiveSupport Instrumentation
+  API
 test_files: []

data/lib/any_logger/initializer.rb

@@ -1,27 +0,0 @@
-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
-      AnyLogger.config.subscribers.each do
-        detach_subscriber(it) if it.detachable
-        attach_subscriber(it) if it.attachable
-      end
-    end
-
-    private_class_method def self.detach_subscriber(subscriber)
-      subscriber.klass.detach_from(subscriber.subscription)
-    end
-
-    private_class_method def self.attach_subscriber(subscriber)
-      subscriber.klass.attach_to(subscriber.subscription)
-    end
-  end
-end