rails_spotlight 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9eca5a5464ed6e44b8c65f206f96ead18ff5cc73a0f9395b2b5cc863a28b270
-  data.tar.gz: 4bc0b0e190af921c926a1f08bb43954dee8b3aa488d867c885b4af84c3816ab7
+  metadata.gz: 251b10d3b271c26da91b3d6c6b41f84eb49f4b6f732d89c4e0f377ead50ae797
+  data.tar.gz: bf48a45b74e5fd78f81e7f3b4250f339c7cd39c2ce230efefa4bf2d847898b83
 SHA512:
-  metadata.gz: 552d1619a7c990dbce5c52fa883a45bcb5d5d58fa3a81a947fd244badbffcab5516607bb739dc73803d90ababd44755d78b9efe159d6d7d785181cef9e390b59
-  data.tar.gz: 8173b1bfc3514712a350d08c8441552c8091c4b3559357192cde5de84470aee320dc26be1663ca07aa1fcbe7fb48573001d7d9bffce578886b3c5c75302633d3
+  metadata.gz: 3ec1fe5f5e842f5eb8975e6d19d5eb923b8dfe6425a86c85b650b1781d2f060a61fc866c159d0e940cb488c2d38cb9e72b9c26034d79638b1a7c2319f9c2fe9f
+  data.tar.gz: 9ab3ecb3de8b864c850b5b398e82c121cde1a4ecf9184170bb4e2c6f7229cb2306e4df21516f5d8fa60873fbb1bde1901f66358b6a098969ae6f86e0a48cca2f

data/README.md

@@ -11,6 +11,14 @@ Chrome extension [Rails Spotlight](https://chrome.google.com/webstore/detail/rai
 
 Add this line to your application's Gemfile:
 
+use bash
+
+```bash
+bundle add rails_spotlight --group development
+```
+
+or add it manually:
+
 ```ruby
 group :development do
   gem 'rails_spotlight'

data/lib/rails_spotlight/app_notifications.rb

@@ -62,6 +62,9 @@ module RailsSpotlight
     # Subscribe to all events relevant to RailsPanel
     #
     def self.subscribe
+      # Skip RailsSpotlight subscriptions during migrations
+      return if migrating?
+
       new
         .subscribe('rsl.notification.log')
         .subscribe('sql.active_record', &SQL_BLOCK)
@@ -92,6 +95,12 @@ module RailsSpotlight
       #                                such as the collection name and the partial being used to render each item.
     end
 
+    def self.migrating?
+      defined?(Rake) && Rake.application.top_level_tasks.any? do |task|
+        task.start_with?('db:migrate', 'db:schema:load')
+      end
+    end
+
     def subscribe(event_name)
       ActiveSupport::Notifications.subscribe(event_name) do |*args|
         event = block_given? ? yield(*args) : Event.new(*args)

data/lib/rails_spotlight/channels/handlers/live_console_handler.rb

@@ -44,7 +44,7 @@ module RailsSpotlight
           executor.execute(command)
           if executor.execution_successful?
             {
-              payload: { result: executor.result_as_json(inspect_types: inspect_types) },
+              payload: { result: executor.result_as_json(inspect_types: inspect_types) }
             }
           else
             {

data/lib/rails_spotlight/channels/handlers.rb

@@ -19,9 +19,7 @@ module RailsSpotlight
       def self.handle(data)
         case data['type']
         when LiveConsoleHandler::TYPE then LiveConsoleHandler.new(data).call
-        # when LogsHandler::TYPE then LogsHandler.new(data).call
-        else
-          nil
+        when LogsHandler::TYPE then LogsHandler.new(data).call
         end
       end
     end

data/lib/rails_spotlight/channels/silence_action_cable_broadcaster_logging.rb

@@ -23,4 +23,3 @@ module RailsSpotlight
     end
   end
 end
-

data/lib/rails_spotlight/channels.rb

@@ -2,7 +2,7 @@
 
 module RailsSpotlight
   module Channels
-    SPOTLIGHT_CHANNEL = 'RailsSpotlight::Channels::SpotlightChannel'.freeze
+    SPOTLIGHT_CHANNEL = 'RailsSpotlight::Channels::SpotlightChannel'.freeze # rubocop:disable Style/RedundantFreeze
     autoload(:SpotlightChannel, 'rails_spotlight/channels/spotlight_channel') if defined?(ActionCable)
   end
 end

data/lib/rails_spotlight/configuration.rb

@@ -4,7 +4,7 @@ require 'yaml'
 require 'erb'
 
 module RailsSpotlight
-  class Configuration
+  class Configuration # rubocop:disable Metrics/ClassLength
     DEFAULT_NOT_ENCODABLE_EVENT_VALUES = {
       'ActiveRecord' => ['ActiveRecord::ConnectionAdapters::AbstractAdapter'],
       'ActionDispatch' => ['ActionDispatch::Request', 'ActionDispatch::Response']

data/lib/rails_spotlight/event.rb

@@ -57,8 +57,9 @@ module RailsSpotlight
     def not_encodable?(value)
       ::RailsSpotlight.config.not_encodable_event_values.any? do |module_name, class_names|
         next unless defined?(module_name.constantize)
+
         class_names.any? { |class_name| value.is_a?(class_name.constantize) }
-      rescue => e
+      rescue => e # rubocop:disable Lint/RescueException, Lint/RedundantCopDisableDirective, Style/RescueStandardError
         puts "Error in not_encodable? method: #{e.message}"
       end
     end

data/lib/rails_spotlight/log_interceptor.rb

@@ -7,7 +7,7 @@ module RailsSpotlight
     SEVERITY = %w[debug info warn error fatal unknown].freeze
     SEVERITY_MAP = { 0 => 'debug', 1 => 'info', 2 => 'warn', 3 => 'error', 4 => 'fatal', 5 => 'unknown' }.freeze
 
-    def add(severity, message = nil, progname = nil)
+    def add(severity, message = nil, progname = nil) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       severity ||= 5
       return true if @logdev.nil? || severity < level
 
@@ -37,7 +37,7 @@ module RailsSpotlight
       message.include?(::RailsSpotlight::Channels::SPOTLIGHT_CHANNEL)
     end
 
-    def _push_event(level, message, progname = nil)
+    def _push_event(level, message, progname = nil) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity, Metrics/AbcSize
       callsite = Utils.dev_callsite(caller.drop(1))
       name = progname.is_a?(String) || progname.is_a?(Symbol) ? progname : nil
       AppRequest.current.events << Event.new('rsl.notification.log', 0, 0, 0, callsite.merge(message: message, level: level, progname: name)) if AppRequest.current && callsite
@@ -45,8 +45,8 @@ module RailsSpotlight
       return unless ::RailsSpotlight.config.live_console_enabled?
       return if message.blank?
 
-      id = AppRequest.current ? AppRequest.current.id : nil
-      payload = (callsite || {}).merge(msg: message, src: ENV['RS_SRC'] || ::RailsSpotlight.config.default_rs_src, l: level, dt: Time.now.to_f, id: id,  pg: name)
+      id = AppRequest.current ? AppRequest.current.id : nil # rubocop:disable Style/SafeNavigation
+      payload = (callsite || {}).merge(msg: message, src: ENV['RS_SRC'] || ::RailsSpotlight.config.default_rs_src, l: level, dt: Time.now.to_f, id: id, pg: name)
       ::RailsSpotlight::Channels::SpotlightChannel.broadcast(type: 'logs', payload: payload)
     rescue StandardError => e
       RailsSpotlight.config.logger.fatal("#{e.message}\n #{e.backtrace.join("\n ")}")

data/lib/rails_spotlight/railtie.rb

@@ -32,7 +32,7 @@ module RailsSpotlight
 
         require 'rails_spotlight/channels/spotlight_channel' if ::RailsSpotlight.config.request_completed_broadcast_enabled?
 
-        app.routes.draw { mount ActionCable.server => '/cable' } if ::RailsSpotlight.config.auto_mount_action_cable?
+        app.routes.draw { mount ActionCable.server => ::RailsSpotlight.config.action_cable_mount_path || '/cable' } if ::RailsSpotlight.config.auto_mount_action_cable?
       end
     end
 

data/lib/rails_spotlight/utils.rb

@@ -15,8 +15,7 @@ module RailsSpotlight
         line: line.to_i,
         method: method
       }
-    rescue
-      nil
+    rescue # rubocop:disable Style/RescueStandardError, Lint/SuppressedException
     end
 
     def sub_source_path(path)

data/lib/rails_spotlight/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsSpotlight
-  VERSION = '0.3.1'
+  VERSION = '0.3.4'
 end

data/lib/tasks/init.rake

@@ -45,10 +45,10 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
     end
   end
 
-  desc "Generate rails_spotlight JavaScript ERB partial for application layout to allow injecting JS code from the extension"
-  task inject_js_partial: :environment do
+  desc 'Generate rails_spotlight JavaScript ERB partial for application layout to allow injecting JS code from the extension'
+  task inject_js_partial: :environment do # rubocop:disable Metrics/BlockLength
     # Define the partial name and path
-    partial_name = "_rails_spotlight_extension_js.html.erb"
+    partial_name = '_rails_spotlight_extension_js.html.erb'
     partial_path = "app/views/layouts/#{partial_name}"
 
     # Define the JavaScript code
@@ -99,12 +99,10 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
     end
 
     case layout_format
-    when 'slim'
-      puts "- if Rails.env.development?\n  = render 'layouts/#{partial_name.split('.').first}'"
-    when 'haml'
-      puts "- if Rails.env.development?\n  = render 'layouts/#{partial_name.split('.').first}'"
+    when 'slim', 'haml'
+      puts "- if Rails.env.development?\n  = render 'layouts/#{partial_name.split('.').first}'" # rubocop:disable Style/StringLiteralsInInterpolation
     else
-      puts "<% if Rails.env.development? %>\n  <%= render 'layouts/#{partial_name.split('.').first}' %>\n<% end %>"
+      puts "<% if Rails.env.development? %>\n  <%= render 'layouts/#{partial_name.split('.').first}' %>\n<% end %>" # rubocop:disable Style/StringLiteralsInInterpolation
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Pawel Niemczyk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-19 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-contrib
@@ -39,7 +39,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
         version: 3.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.2'
+        version: '7.3'
 - !ruby/object:Gem::Dependency
   name: action-cable-testing
   requirement: !ruby/object:Gem::Requirement