rails_band 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33531dca2bfc581e2d892bfa6962bb31d41e1fef075917a8cb4427ed6b65c2e5
-  data.tar.gz: a4f5af5171bf836e9071cddffe9b06654eba3538c58b0bf7c5bbde93587e0686
+  metadata.gz: a25f05dedb0e797005029c002702b3f54d08f9be39b2f66fb3ca24de6a256b19
+  data.tar.gz: 24648cbe75b62df3f919e9809b40e93f30c985971c9fe8bc38fac6cfe41746fb
 SHA512:
-  metadata.gz: fc3c5c8628d6e8a0bb963e257d6eaa1c2cd8278b71f477034d33ea715c2563efe8854b466daa3aa9dadce94da15840ca2f4e65ee49fdfb0a30fa9880d20365ed
-  data.tar.gz: bc5f016c6b62c01b5081a9bc75a882edbcb51e7be37b65fa24ba17ef570855de37e6fdce6c86a1cccbb8d78aa77b2e5f47e077e086e8f138513fd87230e34a1f
+  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
 
@@ -82,7 +83,7 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 | [`render_template.action_view`](https://guides.rubyonrails.org/active_support_instrumentation.html#render-template-action-view)     | ✅        |
 | [`render_partial.action_view`](https://guides.rubyonrails.org/active_support_instrumentation.html#render-partial-action-view)       | ✅        |
 | [`render_collection.action_view`](https://guides.rubyonrails.org/active_support_instrumentation.html#render-collection-action-view) | ✅        |
-| [`render_layout.action_view`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#render-layout-action-view)     |           |
+| [`render_layout.action_view`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#render-layout-action-view)     | ✅        |
 
 ### Active Record
 
@@ -162,7 +163,7 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 | Event name                                                                                                  | Supported |
 | ----------------------------------------------------------------------------------------------------------- | --------- |
-| [`deprecation.rails`](https://guides.rubyonrails.org/active_support_instrumentation.html#deprecation-rails) |           |
+| [`deprecation.rails`](https://guides.rubyonrails.org/active_support_instrumentation.html#deprecation-rails) | ✅        |
 
 ## Contributing
 

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_collection.rb

@@ -16,7 +16,7 @@ module RailsBand
         def layout
           return @layout if defined? @layout
 
-          @layout = @event.payload[:layout]&.yield_self { |layout| from_views(layout) }
+          @layout = @event.payload[:layout]&.then { |layout| from_views(layout) }
         end
 
         def count

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_view/from_views'
+
+module RailsBand
+  module ActionView
+    module Event
+      # A wrapper for the event that is passed to `render_layout.action_view`.
+      class RenderLayout < BaseEvent
+        include FromViews
+
+        def identifier
+          @identifier ||= from_views(@event.payload.fetch(:identifier))
+        end
+      end
+    end
+  end
+end

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

@@ -16,12 +16,18 @@ module RailsBand
         def layout
           return @layout if defined? @layout
 
-          @layout = @event.payload[:layout]&.yield_self { |layout| from_views(layout) }
+          @layout = @event.payload[:layout]&.then { |layout| from_views(layout) }
         end
 
         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

@@ -16,7 +16,13 @@ module RailsBand
         def layout
           return @layout if defined? @layout
 
-          @layout = @event.payload[:layout]&.yield_self { |layout| from_views(layout) }
+          @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

data/lib/rails_band/action_view/log_subscriber.rb

@@ -3,6 +3,7 @@
 require 'rails_band/action_view/event/render_template'
 require 'rails_band/action_view/event/render_partial'
 require 'rails_band/action_view/event/render_collection'
+require 'rails_band/action_view/event/render_layout'
 
 module RailsBand
   module ActionView
@@ -22,6 +23,10 @@ module RailsBand
         consumer_of(__method__)&.call(Event::RenderCollection.new(event))
       end
 
+      def render_layout(event)
+        consumer_of(__method__)&.call(Event::RenderLayout.new(event))
+      end
+
       private
 
       def consumer_of(sub_event)

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

@@ -12,6 +12,14 @@ module RailsBand
         def job
           @job ||= @event.payload.fetch(:job)
         end
+
+        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
+        end
       end
     end
   end

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

@@ -12,6 +12,14 @@ module RailsBand
         def job
           @job ||= @event.payload.fetch(:job)
         end
+
+        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
+        end
       end
     end
   end

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

@@ -12,6 +12,18 @@ module RailsBand
         def job
           @job ||= @event.payload.fetch(:job)
         end
+
+        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
   end

data/lib/rails_band/base_event.rb

@@ -3,7 +3,7 @@
 module RailsBand
   # The base class of each Event class.
   class BaseEvent
-    attr_reader :name, :time, :end, :transaction_id, :children,
+    attr_reader :name, :time, :end, :transaction_id,
                 :cpu_time, :idle_time, :allocations, :duration
 
     # @param event [ActiveSupport::Notifications::Event]
@@ -13,7 +13,6 @@ module RailsBand
       @time = event.time
       @end = event.end
       @transaction_id = event.transaction_id
-      @children = event.children
       @cpu_time = event.cpu_time
       @idle_time = event.idle_time
       @allocations = event.allocations
@@ -22,7 +21,7 @@ module RailsBand
 
     def to_h
       @to_h ||= {
-        name: @name, time: @time, end: @end, transaction_id: @transaction_id, children: @children,
+        name: @name, time: @time, end: @end, transaction_id: @transaction_id,
         cpu_time: @cpu_time, idle_time: @idle_time, allocations: @allocations, duration: @duration
       }.merge!(
         public_methods(false).reject { |meth| non_hash_keys.include?(meth) }.each_with_object({}) do |meth, h|

data/lib/rails_band/deprecation_subscriber.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module RailsBand
+  # DeprecationSubscriber is responsible for logging deprecation warnings.
+  class DeprecationSubscriber < ::ActiveSupport::LogSubscriber
+    # DeprecationEvent is a wrapper around a deprecation notification event.
+    class DeprecationEvent < BaseEvent
+      def message
+        @message ||= @event.payload.fetch(:message)
+      end
+
+      def callstack
+        @callstack ||= @event.payload.fetch(:callstack)
+      end
+
+      def gem_name
+        @gem_name ||= @event.payload.fetch(:gem_name)
+      end
+
+      def deprecation_horizon
+        @deprecation_horizon ||= @event.payload.fetch(:deprecation_horizon)
+      end
+    end
+
+    mattr_accessor :consumers
+
+    def deprecation(event)
+      consumer&.call(DeprecationEvent.new(event))
+    end
+
+    private
+
+    def consumer
+      # HACK: ActiveSupport::Subscriber has the instance variable @namespace, but it's not documented.
+      #       This hack might possibly break in the future.
+      namespace = self.class.instance_variable_get(:@namespace)
+      consumers[:"deprecation.#{namespace}"] || consumers[:deprecation] || consumers[:default]
+    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,9 +48,14 @@ 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
 
+      RailsBand::DeprecationSubscriber.consumers = consumers
+      RailsBand::DeprecationSubscriber.attach_to :rails
+
       if defined?(::ActiveJob)
         require 'active_job/logging'
 

data/lib/rails_band/version.rb

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

data/lib/rails_band.rb

@@ -3,39 +3,53 @@
 require 'rails_band/version'
 require 'rails_band/configuration'
 require 'rails_band/base_event'
+require 'rails_band/deprecation_subscriber'
 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.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,10 +59,14 @@ 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
 - lib/rails_band/action_view/event/render_collection.rb
+- lib/rails_band/action_view/event/render_layout.rb
 - lib/rails_band/action_view/event/render_partial.rb
 - lib/rails_band/action_view/event/render_template.rb
 - lib/rails_band/action_view/from_views.rb
@@ -104,6 +108,7 @@ files:
 - lib/rails_band/active_support/log_subscriber.rb
 - lib/rails_band/base_event.rb
 - lib/rails_band/configuration.rb
+- lib/rails_band/deprecation_subscriber.rb
 - lib/rails_band/railtie.rb
 - lib/rails_band/version.rb
 homepage: https://github.com/yykamei/rails_band
@@ -129,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