rails_band 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b347e10fae66e28648aca3427b76fe456fbaf21f1f45aaea5b4e3daed74bc44
-  data.tar.gz: 102f48535f8cbf10db8b670d57cf671c8f0a839ae0e312fd706631b39e1ad55a
+  metadata.gz: 3d8062da3d8ef85024e23c439e5d3eea7daca6d1a02b67e8182ba7ca570f3b22
+  data.tar.gz: dff4f9a0b08ef4c09dde608ad7e00855859014059cbc7c6e430725d6cc51548a
 SHA512:
-  metadata.gz: be4a7fbb271fd7bca9c47a23f7ee474b57ad06e047278476670d335fa22461a45a13d02e3d79be0578f5bcf40662aa7229e921e23a2919d9d838b9f718e1ff52
-  data.tar.gz: fe2e8deba94abbd8f44ea0c940dd4f23f132952f668de68aa06a221eb465f9c78e4ba5d69151f192e20491492f9aaca86662801c89a891ac1c3ba4f199cf31bd
+  metadata.gz: ab91a63e9c231a7c92731c276749753b8ef862854192cb5cc9e10cfc2d0d96c56d293ba2fcbbc6d307cf6894d33ce71e82b86ab00e170a8314c6fd090414f362
+  data.tar.gz: 592ec597dfcdf32bbf1be74a962b4763c6b9c60903a2788fc44bf40d44ee5be379fbd3da9e70837d14c996cfe3f860cde368f8b02e4b01a537f9775819857ad0

data/README.md

@@ -139,17 +139,18 @@ These are Rails Instrumentation API hooks supported by this gem so far.
 
 | Event name                                                                                                                                                  | Supported |
 | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
-| [`service_upload.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-upload-active-storage)                         |           |
-| [`service_streaming_download.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-streaming-download-active-storage) |           |
-| [`service_download_chunk.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-download-chunk-active-storage)         |           |
-| [`service_download.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-download-active-storage)                     |           |
-| [`service_delete.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-delete-active-storage)                         |           |
-| [`service_delete_prefixed.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-delete-prefixed-active-storage)       |           |
-| [`service_exist.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-exist-active-storage)                           |           |
-| [`service_url.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-url-active-storage)                               |           |
-| [`service_update_metadata.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-update-metadata-active-storage)       |           |
-| [`preview.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#preview-active-storage)                                       |           |
-| [`analyze.active_storage`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#analyze-active-storage)                                   |           |
+| [`service_upload.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-upload-active-storage)                         | ✅        |
+| [`service_streaming_download.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-streaming-download-active-storage) | ✅        |
+| [`service_download_chunk.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-download-chunk-active-storage)         | ✅        |
+| [`service_download.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-download-active-storage)                     | ✅        |
+| [`service_delete.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-delete-active-storage)                         | ✅        |
+| [`service_delete_prefixed.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-delete-prefixed-active-storage)       | ✅        |
+| [`service_exist.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-exist-active-storage)                           | ✅        |
+| [`service_url.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-url-active-storage)                               | ✅        |
+| [`service_update_metadata.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#service-update-metadata-active-storage)       | ✅        |
+| [`preview.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#preview-active-storage)                                       | ✅        |
+| [`transform.active_storage`](https://guides.rubyonrails.org/active_support_instrumentation.html#transform-active-storage)                                   | ✅        |
+| [`analyze.active_storage`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#analyze-active-storage)                                   | ✅        |
 
 ### Railties
 

data/lib/rails_band/active_storage/event/analyze.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `analyze.active_storage`.
+      class Analyze < BaseEvent
+        def analyzer
+          @analyzer ||= @event.payload.fetch(:analyzer)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/preview.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `preview.active_storage`.
+      class Preview < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_delete.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_delete.active_storage`.
+      class ServiceDelete < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_delete_prefixed.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_delete_prefixed.active_storage`.
+      class ServiceDeletePrefixed < BaseEvent
+        def prefix
+          @prefix ||= @event.payload.fetch(:prefix)
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_download.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_download.active_storage`.
+      class ServiceDownload < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_download_chunk.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_download_chunk.active_storage`.
+      class ServiceDownloadChunk < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+
+        def range
+          @range ||= @event.payload.fetch(:range)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_exist.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_exist.active_storage`.
+      class ServiceExist < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+
+        def exist
+          return @exist if defined? @exist
+
+          @exist = @event.payload.fetch(:exist)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_streaming_download.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_streaming_download.active_storage`.
+      class ServiceStreamingDownload < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_update_metadata.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_update_metadata.active_storage`.
+      class ServiceUpdateMetadata < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+
+        def content_type
+          @content_type ||= @event.payload.fetch(:content_type)
+        end
+
+        def disposition
+          @disposition ||= @event.payload.fetch(:disposition)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_upload.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_upload.active_storage`.
+      class ServiceUpload < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def checksum
+          return @checksum if defined? @checksum
+
+          @checksum = @event.payload[:checksum]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/service_url.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `service_url.active_storage`.
+      class ServiceUrl < BaseEvent
+        def key
+          return @key if defined? @key
+
+          @key = @event.payload[:key]
+        end
+
+        def service
+          @service ||= @event.payload.fetch(:service)
+        end
+
+        def url
+          @url ||= @event.payload.fetch(:url)
+        end
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/event/transform.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsBand
+  module ActiveStorage
+    module Event
+      # A wrapper for the event that is passed to `transform.active_storage`.
+      class Transform < BaseEvent
+      end
+    end
+  end
+end

data/lib/rails_band/active_storage/log_subscriber.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'rails_band/active_storage/event/service_upload'
+require 'rails_band/active_storage/event/service_streaming_download'
+require 'rails_band/active_storage/event/service_download_chunk'
+require 'rails_band/active_storage/event/service_download'
+require 'rails_band/active_storage/event/service_delete'
+require 'rails_band/active_storage/event/service_delete_prefixed'
+require 'rails_band/active_storage/event/service_exist'
+require 'rails_band/active_storage/event/service_url'
+require 'rails_band/active_storage/event/service_update_metadata'
+require 'rails_band/active_storage/event/preview'
+require 'rails_band/active_storage/event/transform'
+require 'rails_band/active_storage/event/analyze'
+
+module RailsBand
+  module ActiveStorage
+    # The custom LogSubscriber for ActiveStorage.
+    class LogSubscriber < ::ActiveSupport::LogSubscriber
+      mattr_accessor :consumers
+
+      def service_upload(event)
+        consumer_of(__method__)&.call(Event::ServiceUpload.new(event))
+      end
+
+      def service_streaming_download(event)
+        consumer_of(__method__)&.call(Event::ServiceStreamingDownload.new(event))
+      end
+
+      def service_download_chunk(event)
+        consumer_of(__method__)&.call(Event::ServiceDownloadChunk.new(event))
+      end
+
+      def service_download(event)
+        consumer_of(__method__)&.call(Event::ServiceDownload.new(event))
+      end
+
+      def service_delete(event)
+        consumer_of(__method__)&.call(Event::ServiceDelete.new(event))
+      end
+
+      def service_delete_prefixed(event)
+        consumer_of(__method__)&.call(Event::ServiceDeletePrefixed.new(event))
+      end
+
+      def service_exist(event)
+        consumer_of(__method__)&.call(Event::ServiceExist.new(event))
+      end
+
+      def service_url(event)
+        consumer_of(__method__)&.call(Event::ServiceUrl.new(event))
+      end
+
+      def service_update_metadata(event)
+        consumer_of(__method__)&.call(Event::ServiceUpdateMetadata.new(event))
+      end
+
+      def preview(event)
+        consumer_of(__method__)&.call(Event::Preview.new(event))
+      end
+
+      def transform(event)
+        consumer_of(__method__)&.call(Event::Transform.new(event))
+      end
+
+      def analyze(event)
+        consumer_of(__method__)&.call(Event::Analyze.new(event))
+      end
+
+      private
+
+      def consumer_of(sub_event)
+        consumers[:"#{sub_event}.active_storage"] || consumers[:active_storage] || consumers[:default]
+      end
+    end
+  end
+end

data/lib/rails_band/railtie.rb

@@ -34,6 +34,10 @@ module RailsBand
         RailsBand::ActionCable::LogSubscriber.attach_to :action_cable
       end
 
+      if defined?(::ActiveStorage)
+        RailsBand::ActiveStorage::LogSubscriber.attach_to :active_storage
+      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.5.0'
+  VERSION = '0.6.0'
 end

data/lib/rails_band.rb

@@ -35,4 +35,8 @@ module RailsBand
   module ActionCable
     autoload :LogSubscriber, 'rails_band/action_cable/log_subscriber'
   end
+
+  module ActiveStorage
+    autoload :LogSubscriber, 'rails_band/active_storage/log_subscriber'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_band
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yutaka Kamei
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-25 00:00:00.000000000 Z
+date: 2022-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
 description: A Rails plugin to facilitate the use of Rails Instrumentation API.
 email:
 - kamei@yykamei.me
@@ -73,6 +79,19 @@ files:
 - lib/rails_band/active_record/event/sql.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
+- lib/rails_band/active_storage/event/preview.rb
+- lib/rails_band/active_storage/event/service_delete.rb
+- lib/rails_band/active_storage/event/service_delete_prefixed.rb
+- lib/rails_band/active_storage/event/service_download.rb
+- lib/rails_band/active_storage/event/service_download_chunk.rb
+- lib/rails_band/active_storage/event/service_exist.rb
+- lib/rails_band/active_storage/event/service_streaming_download.rb
+- lib/rails_band/active_storage/event/service_update_metadata.rb
+- lib/rails_band/active_storage/event/service_upload.rb
+- lib/rails_band/active_storage/event/service_url.rb
+- lib/rails_band/active_storage/event/transform.rb
+- lib/rails_band/active_storage/log_subscriber.rb
 - lib/rails_band/active_support/event/cache_delete.rb
 - lib/rails_band/active_support/event/cache_delete_multi.rb
 - lib/rails_band/active_support/event/cache_exist.rb
@@ -109,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Easy-to-use Rails Instrumentation API