rails_band 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b46032c94cc57bc9ae8bb0208502853a98bfca87530fd28cd5d356272489f2a
-  data.tar.gz: 962cf4666c9925b5f1dab87088224ba223021aded56739b72582a1a8ebf4234f
+  metadata.gz: 25195f352d9f1105a0dc497aff31a087310185a09133674516ec77e1f44b00ab
+  data.tar.gz: 62a96059041df354354cbb871997bc367c0fd5132e526c3888ac955796b326df
 SHA512:
-  metadata.gz: 14a38b8df1ef166a7bc62c52c3408a0e054768892bc97f6bd547d8b2f486e60c5dad7fd5aefaa7f41416de3e0e48cacf3994140b0bc355b25439501845c8b6e9
-  data.tar.gz: 30fd719ea30ddec606e8bc298ada082e38a79062b84e923054f19276f121484e9ca0bd9b0a56b6dbf531c1a7b258cbd988abe54f709dde91659a4516548c7860
+  metadata.gz: a4518ad9565c64461de711c8d73e6567046e81385ed5b05fb17a63e35495b767b02d6177ca6952a6496a7152e6c75a82351d805fdcbbc9e977cd348dffe14db9
+  data.tar.gz: d8b7090706903ba8dc95bd7e1ff7823c1354577483407829fc94ed5194d6e9443b6f1c36de106998641be1549834fdb2c135002b5981f4fa0e83b19bd97bd521

data/README.md

@@ -89,12 +89,13 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 ### Active Record
 
-| Event name                                                                                                                      | Supported |
-| ------------------------------------------------------------------------------------------------------------------------------- | --------- |
-| `strict_loading_violation.active_record` (Not yet documented. See the configuration of `action_on_strict_loading_violation`)    | ✅        |
-| [`sql.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record)                     | ✅        |
-| [`instantiation.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#instantiation-active-record) | ✅        |
-| [`transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#transaction-active-record) |           |
+| Event name                                                                                                                                  | Supported |
+| ------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| `strict_loading_violation.active_record` (Not yet documented. See the configuration of `action_on_strict_loading_violation`)                | ✅        |
+| [`sql.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#sql-active-record)                                 | ✅        |
+| [`instantiation.active_record`](https://guides.rubyonrails.org/active_support_instrumentation.html#instantiation-active-record)             | ✅        |
+| [`start_transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#start-transaction-active-record) | ✅        |
+| [`transaction.active_record`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#transaction-active-record)             |           |
 
 ### Action Mailer
 
@@ -176,9 +177,9 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 ### Railties
 
-| Event name                                                                                                                                | Supported |
-| ----------------------------------------------------------------------------------------------------------------------------------------- | --------- |
-| [`load_config_initializer.railties`](https://guides.rubyonrails.org/active_support_instrumentation.html#load-config-initializer-railties) |           |
+| Event name                                                                                                                                    | Supported |
+| --------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
+| [`load_config_initializer.railties`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#load-config-initializer-railties) |           |
 
 ### Rails
 

data/lib/rails_band/action_controller/event/rate_limit.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionController
+    module Event
+      # A wrapper for the event that is passed to `rate_limit.action_controller`.
+      class RateLimit < BaseEvent
+        def request
+          @request ||= @event.payload.fetch(:request)
+        end
+
+        # @note The following attributes are only available in Rails 8.1+
+        if Gem::Version.new(Rails.version) >= Gem::Version.new('8.1.0.alpha')
+          define_method(:count) do
+            @count ||= @event.payload.fetch(:count)
+          end
+
+          define_method(:to) do
+            @to ||= @event.payload.fetch(:to)
+          end
+
+          define_method(:within) do
+            @within ||= @event.payload.fetch(:within)
+          end
+
+          define_method(:by) do
+            @by ||= @event.payload.fetch(:by)
+          end
+
+          # @note This method is renamed in order to avoid conflicts with BaseEvent#name.
+          define_method(:rate_limit_name) do
+            return @rate_limit_name if defined? @rate_limit_name
+
+            @rate_limit_name = @event.payload[:name]
+          end
+
+          define_method(:scope) do
+            @scope ||= @event.payload.fetch(:scope)
+          end
+
+          define_method(:cache_key) do
+            @cache_key ||= @event.payload.fetch(:cache_key)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_controller/log_subscriber.rb

@@ -12,6 +12,7 @@ require 'rails_band/action_controller/event/send_data'
 require 'rails_band/action_controller/event/redirect_to'
 require 'rails_band/action_controller/event/halted_callback'
 require 'rails_band/action_controller/event/unpermitted_parameters'
+require 'rails_band/action_controller/event/rate_limit'
 
 module RailsBand
   module ActionController
@@ -71,6 +72,10 @@ module RailsBand
         consumer_of(__method__)&.call(Event::UnpermittedParameters.new(event))
       end
 
+      def rate_limit(event)
+        consumer_of(__method__)&.call(Event::RateLimit.new(event))
+      end
+
       private
 
       def consumer_of(sub_event)

data/lib/rails_band/active_record/event/start_transaction.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveRecord
+    module Event
+      # A wrapper for the event that is passed to `start_transaction.active_record`.
+      class StartTransaction < BaseEvent
+        def transaction
+          @transaction ||= @event.payload.fetch(:transaction)
+        end
+
+        def connection
+          @connection ||= @event.payload.fetch(:connection)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_record/log_subscriber.rb

@@ -3,6 +3,7 @@
 require 'rails_band/active_record/event/sql'
 require 'rails_band/active_record/event/instantiation'
 require 'rails_band/active_record/event/strict_loading_violation'
+require 'rails_band/active_record/event/start_transaction'
 
 module RailsBand
   module ActiveRecord
@@ -22,6 +23,10 @@ module RailsBand
         consumer_of(__method__)&.call(Event::Instantiation.new(event))
       end
 
+      def start_transaction(event)
+        consumer_of(__method__)&.call(Event::StartTransaction.new(event))
+      end
+
       private
 
       def consumer_of(sub_event)

data/lib/rails_band/railtie.rb

@@ -12,7 +12,9 @@ module RailsBand
       # 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)
+      if defined?(::ActionDispatch::LogSubscriber)
+        detach_log_subscriber(::ActionDispatch::LogSubscriber, :action_dispatch)
+      end
       RailsBand::ActionDispatch::LogSubscriber.attach_to :action_dispatch
     end
 
@@ -20,7 +22,7 @@ module RailsBand
       consumers = app.config.rails_band.consumers
 
       swap = lambda { |old_class, new_class, namespace|
-        old_class.detach_from namespace
+        detach_log_subscriber(old_class, namespace)
         new_class.consumers = consumers
         new_class.attach_to namespace
       }
@@ -72,5 +74,19 @@ module RailsBand
         RailsBand::ActionMailbox::LogSubscriber.attach_to :action_mailbox
       end
     end
+
+    # Helper method to detach log subscribers in a way that's compatible with both
+    # Rails < 8.1 (using detach_from) and Rails >= 8.1 (using unsubscribe)
+    def self.detach_log_subscriber(log_subscriber_class, namespace)
+      if log_subscriber_class.respond_to?(:detach_from)
+        # Rails < 8.1: use detach_from method
+        log_subscriber_class.detach_from namespace
+      elsif log_subscriber_class.respond_to?(:unsubscribe)
+        # Rails >= 8.1: use unsubscribe method
+        log_subscriber_class.unsubscribe
+      end
+    end
+
+    private_class_method :detach_log_subscriber
   end
 end

data/lib/rails_band/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Yutaka Kamei
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,6 +50,7 @@ files:
 - lib/rails_band/action_controller/event/expire_fragment.rb
 - lib/rails_band/action_controller/event/halted_callback.rb
 - lib/rails_band/action_controller/event/process_action.rb
+- lib/rails_band/action_controller/event/rate_limit.rb
 - lib/rails_band/action_controller/event/read_fragment.rb
 - lib/rails_band/action_controller/event/redirect_to.rb
 - lib/rails_band/action_controller/event/send_data.rb
@@ -86,6 +86,7 @@ files:
 - lib/rails_band/active_job/log_subscriber.rb
 - lib/rails_band/active_record/event/instantiation.rb
 - lib/rails_band/active_record/event/sql.rb
+- lib/rails_band/active_record/event/start_transaction.rb
 - lib/rails_band/active_record/event/strict_loading_violation.rb
 - lib/rails_band/active_record/log_subscriber.rb
 - lib/rails_band/active_storage/event/analyze.rb
@@ -129,7 +130,6 @@ metadata:
   homepage_uri: https://github.com/yykamei/rails_band
   source_code_uri: https://github.com/yykamei/rails_band
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Easy-to-use Rails Instrumentation API
 test_files: []