rails_band 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33531dca2bfc581e2d892bfa6962bb31d41e1fef075917a8cb4427ed6b65c2e5
-  data.tar.gz: a4f5af5171bf836e9071cddffe9b06654eba3538c58b0bf7c5bbde93587e0686
+  metadata.gz: b9edf37b23613a1499389b5c70ba7c1e80112ab6b8f8879d4983c26ed41092e5
+  data.tar.gz: aded5c59846b0f4befa0ad2bca8dd48b63f37af95adedd5bb38ae672bafd001e
 SHA512:
-  metadata.gz: fc3c5c8628d6e8a0bb963e257d6eaa1c2cd8278b71f477034d33ea715c2563efe8854b466daa3aa9dadce94da15840ca2f4e65ee49fdfb0a30fa9880d20365ed
-  data.tar.gz: bc5f016c6b62c01b5081a9bc75a882edbcb51e7be37b65fa24ba17ef570855de37e6fdce6c86a1cccbb8d78aa77b2e5f47e077e086e8f138513fd87230e34a1f
+  metadata.gz: fecc6a2eca4835e5717e1fbe2aff99f29f585dc091215d1be8a8d2455fc8fec664da2a50f61535d906b68e4429ea5a5acf45a27a7a10840115558302575b0bc8
+  data.tar.gz: 1a0986674189d1546bba3988b0271496bf006b83fc86a894a676dd9c97d8f5efa7b7a84d7b6e488efe55fdf0e97d016168c99ff8d47a92b5fa56b3b08a5d8b28

data/README.md

@@ -82,7 +82,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 +162,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_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,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 cache_hit

data/lib/rails_band/action_view/event/render_template.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
       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.0')
+          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.0')
+          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,14 @@ module RailsBand
         def job
           @job ||= @event.payload.fetch(:job)
         end
+
+        if Gem::Version.new(Rails.version) > Gem::Version.new('7.0')
+          define_method(:aborted) do
+            return @aborted if defined?(@aborted)
+
+            @aborted = @event.payload[:aborted]
+          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

@@ -43,6 +43,9 @@ module RailsBand
       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.7.0'
 end

data/lib/rails_band.rb

@@ -3,6 +3,7 @@
 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,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,6 +63,7 @@ files:
 - 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 +105,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