rails_band 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2068455c0eab607cbdc32392362c6a181b0789d8bd41e77201c7bb06e3eb8ba8
-  data.tar.gz: c27bcf5e8dcd06c7f87f164ca1a7f58e537b5910bba7b0a98a7ea3a003649fad
+  metadata.gz: 3b347e10fae66e28648aca3427b76fe456fbaf21f1f45aaea5b4e3daed74bc44
+  data.tar.gz: 102f48535f8cbf10db8b670d57cf671c8f0a839ae0e312fd706631b39e1ad55a
 SHA512:
-  metadata.gz: 936e787242f04a6d7d81bf29993d87bba1187cf27d3e706cb0de672dd27100e99ab029da802871bd044ad722801a4fa6f4f6f22b33e3f1c160935dce10c9b369
-  data.tar.gz: 549f64623c4374c3067d0e82a853eace86c14873a89c5e894118ca8e4c1122377d89d55c10c7816b86db391d0130df423c68db25d9d898e4de769947554c1e54
+  metadata.gz: be4a7fbb271fd7bca9c47a23f7ee474b57ad06e047278476670d335fa22461a45a13d02e3d79be0578f5bcf40662aa7229e921e23a2919d9d838b9f718e1ff52
+  data.tar.gz: fe2e8deba94abbd8f44ea0c940dd4f23f132952f668de68aa06a221eb465f9c78e4ba5d69151f192e20491492f9aaca86662801c89a891ac1c3ba4f199cf31bd

data/README.md

@@ -1,7 +1,7 @@
 # rails_band
 
 <a href="https://github.com/yykamei/rails_band/actions/workflows/ci.yml"><img alt="GitHub Actions workflow status" src="https://github.com/yykamei/rails_band/actions/workflows/ci.yml/badge.svg"></a>
-<a href="https://rubygems.org/gems/rails_band"><img alt="Gem" src="https://img.shields.io/gem/v/rails_band"></a>
+<a href="https://rubygems.org/gems/rails_band"><img alt="rails_band" src="https://img.shields.io/gem/v/rails_band"></a>
 
 Easy-to-use Rails Instrumentation API.
 
@@ -82,6 +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)     |           |
 
 ### Active Record
 
@@ -128,11 +129,11 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 | Event name                                                                                                                                                              | Supported |
 | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
-| [`perform_action.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-action-action-cable)                                         |           |
-| [`transmit.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-action-cable)                                                     |           |
-| [`transmit_subscription_confirmation.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-subscription-confirmation-action-cable) |           |
-| [`transmit_subscription_rejection.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-subscription-rejection-action-cable)       |           |
-| [`broadcast.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#broadcast-action-cable)                                                   |           |
+| [`perform_action.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-action-action-cable)                                         | ✅        |
+| [`transmit.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-action-cable)                                                     | ✅        |
+| [`transmit_subscription_confirmation.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-subscription-confirmation-action-cable) | ✅        |
+| [`transmit_subscription_rejection.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#transmit-subscription-rejection-action-cable)       | ✅        |
+| [`broadcast.action_cable`](https://guides.rubyonrails.org/active_support_instrumentation.html#broadcast-action-cable)                                                   | ✅        |
 
 ### Active Storage
 

data/lib/rails_band/action_cable/event/broadcast.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionCable
+    module Event
+      # A wrapper for the event that is passed to `broadcast.action_cable`.
+      class Broadcast < BaseEvent
+        def broadcasting
+          @broadcasting ||= @event.payload.fetch(:broadcasting)
+        end
+
+        def message
+          @message ||= @event.payload.fetch(:message)
+        end
+
+        def coder
+          @coder ||= @event.payload.fetch(:coder)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_cable/event/perform_action.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionCable
+    module Event
+      # A wrapper for the event that is passed to `perform_action.action_cable`.
+      class PerformAction < BaseEvent
+        def channel_class
+          @channel_class ||= @event.payload.fetch(:channel_class)
+        end
+
+        def action
+          @action ||= @event.payload.fetch(:action)
+        end
+
+        def data
+          @data ||= @event.payload.fetch(:data)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_cable/event/transmit.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionCable
+    module Event
+      # A wrapper for the event that is passed to `transmit.action_cable`.
+      class Transmit < BaseEvent
+        def channel_class
+          @channel_class ||= @event.payload.fetch(:channel_class)
+        end
+
+        def data
+          @data ||= @event.payload.fetch(:data)
+        end
+
+        def via
+          @via ||= @event.payload.fetch(:via)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_cable/event/transmit_subscription_confirmation.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionCable
+    module Event
+      # A wrapper for the event that is passed to `transmit_subscription_confirmation.action_cable`.
+      class TransmitSubscriptionConfirmation < BaseEvent
+        def channel_class
+          @channel_class ||= @event.payload.fetch(:channel_class)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_cable/event/transmit_subscription_rejection.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActionCable
+    module Event
+      # A wrapper for the event that is passed to `transmit_subscription_rejection.action_cable`.
+      class TransmitSubscriptionRejection < BaseEvent
+        def channel_class
+          @channel_class ||= @event.payload.fetch(:channel_class)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/action_cable/log_subscriber.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails_band/action_cable/event/perform_action'
+require 'rails_band/action_cable/event/transmit'
+require 'rails_band/action_cable/event/transmit_subscription_confirmation'
+require 'rails_band/action_cable/event/transmit_subscription_rejection'
+require 'rails_band/action_cable/event/broadcast'
+
+module RailsBand
+  module ActionCable
+    # The custom LogSubscriber for ActionCable.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def perform_action(event)
+        consumer_of(__method__)&.call(Event::PerformAction.new(event))
+      end
+
+      def transmit(event)
+        consumer_of(__method__)&.call(Event::Transmit.new(event))
+      end
+
+      def transmit_subscription_confirmation(event)
+        consumer_of(__method__)&.call(Event::TransmitSubscriptionConfirmation.new(event))
+      end
+
+      def transmit_subscription_rejection(event)
+        consumer_of(__method__)&.call(Event::TransmitSubscriptionRejection.new(event))
+      end
+
+      def broadcast(event)
+        consumer_of(__method__)&.call(Event::Broadcast.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.action_cable"] || consumers[:action_cable] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/railtie.rb

@@ -30,6 +30,10 @@ module RailsBand
         swap.call(::ActionMailer::LogSubscriber, RailsBand::ActionMailer::LogSubscriber, :action_mailer)
       end
 
+      if defined?(::ActionCable)
+        RailsBand::ActionCable::LogSubscriber.attach_to :action_cable
+      end
+
       RailsBand::ActiveSupport::LogSubscriber.attach_to :active_support
 
       if defined?(::ActiveJob)

data/lib/rails_band/version.rb

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

data/lib/rails_band.rb

@@ -31,4 +31,8 @@ module RailsBand
   module ActiveJob
     autoload :LogSubscriber, 'rails_band/active_job/log_subscriber'
   end
+
+  module ActionCable
+    autoload :LogSubscriber, 'rails_band/action_cable/log_subscriber'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -35,6 +35,12 @@ files:
 - README.md
 - Rakefile
 - lib/rails_band.rb
+- lib/rails_band/action_cable/event/broadcast.rb
+- lib/rails_band/action_cable/event/perform_action.rb
+- lib/rails_band/action_cable/event/transmit.rb
+- lib/rails_band/action_cable/event/transmit_subscription_confirmation.rb
+- lib/rails_band/action_cable/event/transmit_subscription_rejection.rb
+- lib/rails_band/action_cable/log_subscriber.rb
 - lib/rails_band/action_controller/event/exist_fragment.rb
 - lib/rails_band/action_controller/event/expire_fragment.rb
 - lib/rails_band/action_controller/event/halted_callback.rb
@@ -103,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Easy-to-use Rails Instrumentation API