rails_band 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9edf37b23613a1499389b5c70ba7c1e80112ab6b8f8879d4983c26ed41092e5
-  data.tar.gz: aded5c59846b0f4befa0ad2bca8dd48b63f37af95adedd5bb38ae672bafd001e
+  metadata.gz: a25f05dedb0e797005029c002702b3f54d08f9be39b2f66fb3ca24de6a256b19
+  data.tar.gz: 24648cbe75b62df3f919e9809b40e93f30c985971c9fe8bc38fac6cfe41746fb
 SHA512:
-  metadata.gz: fecc6a2eca4835e5717e1fbe2aff99f29f585dc091215d1be8a8d2455fc8fec664da2a50f61535d906b68e4429ea5a5acf45a27a7a10840115558302575b0bc8
-  data.tar.gz: 1a0986674189d1546bba3988b0271496bf006b83fc86a894a676dd9c97d8f5efa7b7a84d7b6e488efe55fdf0e97d016168c99ff8d47a92b5fa56b3b08a5d8b28
+  metadata.gz: f60fd033f93bc2c1716a8e3f950e2b0dc5e38d109f7bcefdff93d4bbf132cb29b4dacfc0b2387eab46f8c9879bc75673938003d9b2401dfb99b11a6c0ef1ffc1
+  data.tar.gz: 3fec1674cea01cfa0e1031b7bd7759fde79e9b43367e12484737b1110240e9c9557345827ed4811c974a2bcf3cf285d6d5c78f4c236637132731a489d7cf2352

data/README.md

@@ -73,7 +73,8 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 | Event name                                                                                                                                    | Supported |
 | --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
-| [`process_middleware.action_dispatch`](https://guides.rubyonrails.org/active_support_instrumentation.html#process-middleware-action-dispatch) |           |
+| [`process_middleware.action_dispatch`](https://guides.rubyonrails.org/active_support_instrumentation.html#process-middleware-action-dispatch) | ✅        |
+| [`redirect.action_dispatch`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#redirect-action-dispatch)                 | ✅        |
 
 ### Action View
 

data/lib/rails_band/action_dispatch/event/process_middleware.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionDispatch
+    module Event
+      # A wrapper for the event that is passed to `process_middleware.action_dispatch`.
+      class ProcessMiddleware < BaseEvent
+        def middleware
+          @middleware ||= @event.payload.fetch(:middleware)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_dispatch/event/redirect.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionDispatch
+    module Event
+      # A wrapper for the event that is passed to `redirect.action_dispatch`.
+      class Redirect < BaseEvent
+        def status
+          @status ||= @event.payload.fetch(:status)
+        end
+
+        def location
+          @location ||= @event.payload.fetch(:location)
+        end
+
+        def request
+          @request ||= @event.payload.fetch(:request)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_dispatch/log_subscriber.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_dispatch/event/process_middleware'
+require 'rails_band/action_dispatch/event/redirect'
+
+module RailsBand
+  module ActionDispatch
+    # The custom LogSubscriber for ActionDispatch.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def process_middleware(event)
+        consumer_of(__method__)&.call(Event::ProcessMiddleware.new(event))
+      end
+
+      def redirect(event)
+        consumer_of(__method__)&.call(Event::Redirect.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.action_dispatch"] || consumers[:action_dispatch] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/action_view/event/render_partial.rb

@@ -22,6 +22,12 @@ module RailsBand
         def cache_hit
           @cache_hit ||= @event.payload.fetch(:cache_hit)
         end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0.alpha')
+          define_method(:locals) do
+            @locals ||= @event.payload[:locals]
+          end
+        end
       end
     end
   end

data/lib/rails_band/action_view/event/render_template.rb

@@ -18,6 +18,12 @@ module RailsBand
 
           @layout = @event.payload[:layout]&.then { |layout| from_views(layout) }
         end
+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0.alpha')
+          define_method(:locals) do
+            @locals ||= @event.payload[:locals]
+          end
+        end
       end
     end
   end

data/lib/rails_band/active_job/event/enqueue.rb

@@ -13,7 +13,7 @@ module RailsBand
           @job ||= @event.payload.fetch(:job)
         end
 
-        if Gem::Version.new(Rails.version) > Gem::Version.new('7.0')
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0.alpha')
           define_method(:aborted) do
             return @aborted if defined?(@aborted)
 

data/lib/rails_band/active_job/event/enqueue_at.rb

@@ -13,7 +13,7 @@ module RailsBand
           @job ||= @event.payload.fetch(:job)
         end
 
-        if Gem::Version.new(Rails.version) > Gem::Version.new('7.0')
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0.alpha')
           define_method(:aborted) do
             return @aborted if defined?(@aborted)
 

data/lib/rails_band/active_job/event/perform.rb

@@ -13,12 +13,16 @@ module RailsBand
           @job ||= @event.payload.fetch(:job)
         end
 
-        if Gem::Version.new(Rails.version) > Gem::Version.new('7.0')
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('7.1.0.alpha')
           define_method(:aborted) do
             return @aborted if defined?(@aborted)
 
             @aborted = @event.payload[:aborted]
           end
+
+          define_method(:db_runtime) do
+            @db_runtime ||= @event.payload[:db_runtime]
+          end
         end
       end
     end

data/lib/rails_band/railtie.rb

@@ -8,6 +8,14 @@ module RailsBand
   class Railtie < ::Rails::Railtie
     config.rails_band = Configuration.new
 
+    config.before_initialize do
+      # NOTE: `ActionDispatch::MiddlewareStack::InstrumentationProxy` will be called
+      #       only when `ActionDispatch::MiddlewareStack#build` detects `process_middleware.action_dispatch`
+      #       is listened to. So, `attach_to` must be called before Rack middlewares will be loaded.
+      ::ActionDispatch::LogSubscriber.detach_from :action_dispatch if defined?(::ActionDispatch::LogSubscriber)
+      RailsBand::ActionDispatch::LogSubscriber.attach_to :action_dispatch
+    end
+
     config.after_initialize do |app|
       consumers = app.config.rails_band.consumers
 
@@ -40,6 +48,8 @@ module RailsBand
         RailsBand::ActiveStorage::LogSubscriber.attach_to :active_storage
       end
 
+      RailsBand::ActionDispatch::LogSubscriber.consumers = consumers
+
       RailsBand::ActiveSupport::LogSubscriber.consumers = consumers
       RailsBand::ActiveSupport::LogSubscriber.attach_to :active_support
 

data/lib/rails_band/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsBand
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/lib/rails_band.rb

@@ -9,34 +9,47 @@ require 'rails_band/railtie'
 # Rails::Band unsubscribes all default LogSubscribers from Rails Instrumentation API,
 # and it subscribes our own custom LogSubscribers to make it easy to access Rails Instrumentation API.
 module RailsBand
+  # RailsBand::ActionController is responsible for subscribing notifications from ActionController.
   module ActionController
     autoload :LogSubscriber, 'rails_band/action_controller/log_subscriber'
   end
 
+  # RailsBand::ActionView is responsible for subscribing notifications from ActionView.
   module ActionView
     autoload :LogSubscriber, 'rails_band/action_view/log_subscriber'
   end
 
+  # RailsBand::ActiveRecord is responsible for subscribing notifications from ActiveRecord.
   module ActiveRecord
     autoload :LogSubscriber, 'rails_band/active_record/log_subscriber'
   end
 
+  # RailsBand::ActionMailer is responsible for subscribing notifications from ActionMailer.
   module ActionMailer
     autoload :LogSubscriber, 'rails_band/action_mailer/log_subscriber'
   end
 
+  # RailsBand::ActionDispatch is responsible for subscribing notifications from ActionDispatch.
+  module ActionDispatch
+    autoload :LogSubscriber, 'rails_band/action_dispatch/log_subscriber'
+  end
+
+  # RailsBand::ActiveSupport is responsible for subscribing notifications from ActiveSupport.
   module ActiveSupport
     autoload :LogSubscriber, 'rails_band/active_support/log_subscriber'
   end
 
+  # RailsBand::ActiveJob is responsible for subscribing notifications from ActiveJob.
   module ActiveJob
     autoload :LogSubscriber, 'rails_band/active_job/log_subscriber'
   end
 
+  # RailsBand::ActionCable is responsible for subscribing notifications from ActionCable.
   module ActionCable
     autoload :LogSubscriber, 'rails_band/action_cable/log_subscriber'
   end
 
+  # RailsBand::ActiveStorage is responsible for subscribing notifications from ActiveStorage.
   module ActiveStorage
     autoload :LogSubscriber, 'rails_band/active_storage/log_subscriber'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,9 @@ files:
 - lib/rails_band/action_controller/event/unpermitted_parameters.rb
 - lib/rails_band/action_controller/event/write_fragment.rb
 - lib/rails_band/action_controller/log_subscriber.rb
+- lib/rails_band/action_dispatch/event/process_middleware.rb
+- lib/rails_band/action_dispatch/event/redirect.rb
+- lib/rails_band/action_dispatch/log_subscriber.rb
 - lib/rails_band/action_mailer/event/deliver.rb
 - lib/rails_band/action_mailer/event/process.rb
 - lib/rails_band/action_mailer/log_subscriber.rb
@@ -131,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Easy-to-use Rails Instrumentation API