rails_spotlight 0.4.2 → 0.5.0

data/lib/rails_spotlight/middlewares/handlers/file_action_handler.rb

@@ -5,26 +5,20 @@ module RailsSpotlight
     module Handlers
       class FileActionHandler < BaseActionHandler
         def execute
-          raise NotFound, 'File not found' unless path_valid?
+          raise Forbidden.new('File manager is disabled', code: :disabled_file_manager_settings) unless enabled?
+          raise NotFound.new('File not found', code: :file_not_found) unless path_valid?
 
-          if write_mode?
-            try_to_update_file
-          else
-            File.read(file_path)
+          begin
+            write_mode? ? try_to_update_file : File.read(file_path)
+          rescue => e # rubocop:disable Style/RescueStandardError
+            raise UnprocessableEntity.new(e.message, code: write_mode? ? :file_update_error : :file_read_error)
           end
-        rescue => e # rubocop:disable Style/RescueStandardError
-          raise UnprocessableEntity, e.message
         end
 
         private
 
-        def text_response_body
-          File.read(file_path)
-        end
-
-        def new_content
-          body_fetch('content')
-        end
+        def text_response_body = File.read(file_path)
+        def new_content = body_fetch('content')
 
         def json_response_body
           {
@@ -33,11 +27,7 @@ module RailsSpotlight
             in_project: file_in_project?,
             relative_path: Pathname.new(file_path).relative_path_from(::RailsSpotlight.config.rails_root).to_s,
             root_path: ::RailsSpotlight.config.rails_root
-          }.merge(write_mode? ? { new_content: new_content } : {})
-        end
-
-        def write_mode?
-          request_mode == 'write'
+          }.merge(write_mode? ? { new_content: } : {})
         end
 
         def try_to_update_file
@@ -56,13 +46,9 @@ module RailsSpotlight
           'Editing files is blocked. Please check the Rails spotlight BLOCK_EDITING_FILES_OUTSIDE_OF_THE_PROJECT configuration.'
         end
 
-        def request_mode
-          @request_mode ||= body_fetch('mode', 'read')
-        end
-
-        def path_valid?
-          File.exist?(file_path)
-        end
+        def write_mode? = request_mode == 'write'
+        def request_mode = @request_mode ||= body_fetch('mode', 'read')
+        def path_valid? = File.exist?(file_path)
 
         def file_path
           @file_path ||= if path_file_in_project?
@@ -78,29 +64,13 @@ module RailsSpotlight
                          end
         end
 
-        def original_file_path
-          @original_file_path ||= body_fetch('file')
-        end
+        def original_file_path = @original_file_path ||= body_fetch('file')
 
-        def path_file_in_project?
-          @path_file_in_project ||= original_file_path.start_with?(::RailsSpotlight.config.rails_root)
-        end
-
-        def file_in_project?
-          File.exist?(File.join(::RailsSpotlight.config.rails_root, original_file_path))
-        end
-
-        def file_in_project_app_dir?
-          File.exist?(File.join(::RailsSpotlight.config.rails_root, 'app', original_file_path))
-        end
-
-        def file_in_project_views_dir?
-          File.exist?(File.join(::RailsSpotlight.config.rails_root, 'app', 'views', original_file_path))
-        end
-
-        def file_outside_project?
-          !file_in_project? && File.exist?(original_file_path)
-        end
+        def path_file_in_project? = @path_file_in_project ||= original_file_path.start_with?(::RailsSpotlight.config.rails_root)
+        def file_in_project? = File.exist?(File.join(::RailsSpotlight.config.rails_root, original_file_path))
+        def file_in_project_app_dir? = File.exist?(File.join(::RailsSpotlight.config.rails_root, 'app', original_file_path))
+        def file_in_project_views_dir? = File.exist?(File.join(::RailsSpotlight.config.rails_root, 'app', 'views', original_file_path))
+        def file_outside_project? = !file_in_project? && File.exist?(original_file_path)
 
         def editing_outside_project_file_is_blocked?(file_path)
           return false unless file_outside_project?
@@ -109,13 +79,9 @@ module RailsSpotlight
           !file_path.start_with?(::RailsSpotlight.config.rails_root)
         end
 
-        def block_editing_files?
-          ::RailsSpotlight.config.block_editing_files
-        end
-
-        def block_editing_files_outside_of_the_project?
-          ::RailsSpotlight.config.block_editing_files_outside_of_the_project
-        end
+        def block_editing_files? = ::RailsSpotlight.config.block_editing_files
+        def block_editing_files_outside_of_the_project? = ::RailsSpotlight.config.block_editing_files_outside_of_the_project
+        def enabled? = ::RailsSpotlight.config.file_manager_enabled
       end
     end
   end

data/lib/rails_spotlight/middlewares/handlers/meta_action_handler.rb

@@ -10,18 +10,13 @@ module RailsSpotlight
 
         def json_response_body
           {
-            events: events,
+            events:,
             root_path: ::RailsSpotlight.config.rails_root
           }
         end
 
-        def id
-          @id ||= request.params['id']
-        end
-
-        def events
-          @events ||= Storage.new(id).read || []
-        end
+        def id = @id ||= request.params['id']
+        def events = @events ||= Storage.new(id).read || []
       end
     end
   end

data/lib/rails_spotlight/middlewares/handlers/not_found_action_handler.rb

@@ -5,7 +5,7 @@ module RailsSpotlight
     module Handlers
       class NotFoundActionHandler < BaseActionHandler
         def execute
-          raise NotFound, 'Not found'
+          raise NotFound.new('Not found', code: :action_not_found)
         end
       end
     end

data/lib/rails_spotlight/middlewares/handlers/sql_action_handler.rb

@@ -5,10 +5,11 @@ module RailsSpotlight
     module Handlers
       class SqlActionHandler < BaseActionHandler
         def execute
-          return transaction unless ActiveSupport.const_defined?('ExecutionContext')
+          raise Forbidden.new('SQL is disabled', code: :disabled_sql_console_settings) unless enabled?
+          return transactional { transaction } unless ActiveSupport.const_defined?('ExecutionContext')
 
           ActiveSupport::ExecutionContext.set(rails_spotlight: request_id) do
-            transaction
+            transactional { transaction }
           end
         end
 
@@ -18,7 +19,7 @@ module RailsSpotlight
           return block.call if force_execution?
 
           ActiveRecord::Base.transaction do
-            begin
+            begin # rubocop:disable Style/RedundantBegin
               block.call
             ensure
               raise ActiveRecord::Rollback
@@ -36,9 +37,7 @@ module RailsSpotlight
           end
         end
 
-        def run # rubocop:disable Metrics/AbcSize
-          RailsSpotlight.config.logger && RailsSpotlight.config.logger.info("Executing query: #{query}") # rubocop:disable Style/SafeNavigation
-
+        def run
           return self.result = ActiveRecord::Base.connection.exec_query(query) if connection_options.blank? || !ActiveRecord::Base.respond_to?(:connects_to)
 
           connections = ActiveRecord::Base.connects_to(**connection_options)
@@ -53,50 +52,34 @@ module RailsSpotlight
 
         def json_response_body
           {
-            query: query,
-            result: result,
-            logs: logs,
+            query:, result:, logs:,
             error: error.present? ? error.inspect : nil,
             query_mode: force_execution? ? 'force' : 'default'
           }
         end
 
         def logger(_, started, finished, unique_id, payload)
-          logs << { time: started, end: finished, unique_id: unique_id }.merge(
+          logs << { time: started, end: finished, unique_id: }.merge(
             payload.as_json(except: %i[connection method name filename line transaction])
           )
         end
 
-        def logs
-          @logs ||= []
-        end
-
-        def query
-          @query ||= body_fetch('query')
-        end
-
-        def raw_options
-          @raw_options ||= body_fetch('options', {}) || {}
-        end
-
-        def mode
-          @mode ||= body_fetch('mode', 'default')
-        end
-
-        def use
-          @use ||= { 'shard' => 'default', 'role' => 'reading' }.merge(raw_options.fetch('use', {}))
-        end
+        def logs = @logs ||= []
+        def query = @query ||= body_fetch('query')
+        def raw_options = @raw_options ||= body_fetch('options', {}) || {}
+        def mode = @mode ||= body_fetch('mode', 'default')
+        def use = @use ||= { 'shard' => 'default', 'role' => 'reading' }.merge(raw_options.fetch('use', {}))
 
+        # TODO: Check for each rails version
         def connection_options
           @connection_options ||= raw_options
-                                    .symbolize_keys
-                                    .slice(:database, :shards)
-                                    .reject { |_, v| v.nil? || (!v.is_a?(TrueClass) && !v.is_a?(FalseClass) && v.empty?) } # TODO: Check for each rails version
+                                  .symbolize_keys
+                                  .slice(:database, :shards)
+                                  .reject { |_, v| v.nil? || (!v.is_a?(TrueClass) && !v.is_a?(FalseClass) && v.empty?) }
         end
 
-        def force_execution?
-          @force_execution ||= mode == 'force'
-        end
+        def force_execution? = @force_execution ||= mode == 'force'
+        def enabled? = ::RailsSpotlight.config.sql_console_enabled?
       end
     end
   end

data/lib/rails_spotlight/middlewares/handlers/verify_action_handler.rb

@@ -12,9 +12,7 @@ module RailsSpotlight
           "Rails Spotlight is working!\nRails version: #{Rails.version}\nRails environment: #{Rails.env}"
         end
 
-        def skip_project_validation?
-          true
-        end
+        def skip_project_validation? = true
 
         def json_response_body
           {

data/lib/rails_spotlight/middlewares/header_marker.rb

@@ -25,9 +25,7 @@ module RailsSpotlight
 
       attr_reader :app, :app_config
 
-      def default_skip_paths
-        %w[/__better_errors /__meta_request]
-      end
+      def default_skip_paths = %w[/__better_errors /__meta_request]
     end
   end
 end

data/lib/rails_spotlight/middlewares/request_completed.rb

@@ -49,8 +49,8 @@ module RailsSpotlight
             payload: {
               id: rails_spotlight_request_id,
               http_method: env['REQUEST_METHOD'],
-              host: host,
-              url: url,
+              host:,
+              url:,
               format: request.format.symbol,
               controller: request.path_parameters[:controller],
               action: request.path_parameters[:action]

data/lib/rails_spotlight/rails_command_executor.rb

@@ -31,15 +31,13 @@ module RailsSpotlight
 
     attr_reader :result, :console, :error, :syntax_error
 
-    def execution_successful?
-      error.nil?
-    end
+    def execution_successful? = error.nil?
 
     def result_as_json(inspect_types: false)
       if error
         {
           status: :error,
-          syntax_error: syntax_error,
+          syntax_error:,
           error: error.respond_to?(:message) ? error.message : error.to_s,
           backtrace: error.respond_to?(:backtrace) ? error.backtrace : nil
         }
@@ -50,7 +48,7 @@ module RailsSpotlight
           raw: result,
           type: result.class.name,
           types: result_inspect_types(inspect_types, result),
-          console: console
+          console:
         }
       end
     end

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 => ::RailsSpotlight.config.action_cable_mount_path || '/cable' } if ::RailsSpotlight.config.auto_mount_action_cable?
+        app.routes.draw { mount ActionCable.server => ::RailsSpotlight.config.cable_mount_path || '/cable' } if ::RailsSpotlight.config.auto_mount_cable?
       end
     end
 
@@ -62,8 +62,6 @@ module RailsSpotlight
       end
     end
 
-    def app
-      Rails.application
-    end
+    def app = Rails.application
   end
 end

data/lib/rails_spotlight/render_view_reporter.rb

@@ -5,10 +5,10 @@ module RailsSpotlight
     def self.report_rendered_view_locals(view, locals: nil, params: nil, show_devise: false, skip_vars: [], metadata: {})
       ActiveSupport::Notifications.instrument(
         'render_view.locals',
-        params: params,
+        params:,
         locals: serialize_as_json(locals),
-        instance_variables: dev_instance_variables(view, skip_vars: skip_vars, show_devise: show_devise),
-        metadata: metadata
+        instance_variables: dev_instance_variables(view, skip_vars:, show_devise:),
+        metadata:
       )
     end
 

data/lib/rails_spotlight/storage.rb

@@ -15,19 +15,14 @@ module RailsSpotlight
       maintain_file_pool(RailsSpotlight.config.storage_pool_size)
     end
 
-    def read
-      # avoid FileNotFound error
-      File.exist?(json_file) ? File.read(json_file) : '[]'
-    end
+    def read = File.exist?(json_file) ? File.read(json_file) : '[]'
 
     private
 
     def maintain_file_pool(size)
       files = Dir["#{dir_path}/*.json"]
       files = files.sort_by { |f| -file_ctime(f) }
-      (files[size..] || []).each do |file|
-        FileUtils.rm_f(file)
-      end
+      (files[size..] || []).each { |file| FileUtils.rm_f(file) }
     end
 
     def file_ctime(file)
@@ -36,12 +31,7 @@ module RailsSpotlight
       0
     end
 
-    def json_file
-      File.join(dir_path, "#{key}.json")
-    end
-
-    def dir_path
-      @dir_path ||= RailsSpotlight.config.storage_path
-    end
+    def json_file = @json_file ||= File.join(dir_path, "#{key}.json")
+    def dir_path = @dir_path ||= RailsSpotlight.config.storage_path
   end
 end

data/lib/rails_spotlight/utils.rb

@@ -13,7 +13,7 @@ module RailsSpotlight
       {
         filename: sub_source_path(filename),
         line: line.to_i,
-        method: method
+        method:
       }
     rescue # rubocop:disable Style/RescueStandardError, Lint/SuppressedException
     end

data/lib/rails_spotlight/version.rb

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

data/lib/tasks/init.rake

@@ -16,26 +16,46 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
       STORAGE_PATH: <%=Rails.root.join('tmp', 'data', 'rails_spotlight')%>
       STORAGE_POOL_SIZE: 20
       LOGGER: <%=Logger.new(Rails.root.join('log', 'rails_spotlight.log'))%>
+      
+      # Security configuration
+      DATA_ACCESS_TOKEN:
+      RAILS_SPOTLIGHT_PROJECT:
+      
       # Prevent from processing and sending some data to the extension
       MIDDLEWARE_SKIPPED_PATHS: []
       NOT_ENCODABLE_EVENT_VALUES:
       SKIP_RENDERED_IVARS: []
+      
+      # Features
+      FILE_MANAGER_ENABLED: true
+      RUBOCOP_ENABLED: true
+      SQL_CONSOLE_ENABLED: true
+      IRB_CONSOLE_ENABLED: true
+      
       # File manager configuration
       BLOCK_EDITING_FILES: false
       BLOCK_EDITING_FILES_OUTSIDE_OF_THE_PROJECT: true
       DIRECTORY_INDEX_IGNORE: ['/.git', '**/*.lock', '**/.DS_Store', '/app/assets/images/**', '/app/assets/fonts/**', '/app/assets/builds/**']
+      
+      # Rubocop configuration
       RUBOCOP_CONFIG_PATH: '.rubocop.yml'
+      
       # Workarounds of CSP restrictions for form JS execution from the extension
       FORM_JS_EXECUTION_TOKEN: <%= Digest::MD5.hexdigest(Rails.application.class.respond_to?(:module_parent_name) ? Rails.application.class.module_parent_name : Rails.application.class.parent_name)%>
-      # Rest of the configuration is required for ActionCable. It will be disabled automatically in when ActionCable is not available.
-      AUTO_MOUNT_ACTION_CABLE: false
-      ACTION_CABLE_MOUNT_PATH: /cable
+      
       # Required for all action cable features
-      USE_ACTION_CABLE: false
+      USE_CABLE: false
+      
+      # Rest of the configuration is required for ActionCable. It will be disabled automatically in when ActionCable is not available.
+      AUTO_MOUNT_CABLE: false
+      CABLE_MOUNT_PATH: /cable
+      
       # Experimental feature.
-      LIVE_LOGS_ENABLED: false
+      CABLE_LOGS_ENABLED: false
       DEFAULT_RS_SRC: default
-      LIVE_CONSOLE_ENABLED: false
+      
+      CABLE_CONSOLE_ENABLED: false
+      
       REQUEST_COMPLETED_BROADCAST_ENABLED: false
     YAML
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_spotlight
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Pawel Niemczyk
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-02 00:00:00.000000000 Z
+date: 2025-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack-contrib
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
@@ -36,20 +35,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.1'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: action-cable-testing
   requirement: !ruby/object:Gem::Requirement
@@ -218,10 +217,11 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
-- Dockerfile-rails-5.2
 - Dockerfile-rails-6.0
 - Dockerfile-rails-6.1
-- Dockerfile-rails-7.0
+- Dockerfile-rails-7.1
+- Dockerfile-rails-8.0
+- Dockerfile-rails-8.0.2
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -231,7 +231,9 @@ files:
 - docker-compose.dev.yml
 - docker-compose.yml
 - docker-variables.env
+- docs/assets/images/sql_execution_toggle.gif
 - exe/rails_spotlight
+- fake_spec_res/config/rails_spotlight.yml
 - fake_spec_res/dummy/index.html
 - fake_spec_res/dummy_controller.rb
 - fake_spec_res/rails_spotlight_spec.rb
@@ -241,7 +243,7 @@ files:
 - lib/rails_spotlight/app_request.rb
 - lib/rails_spotlight/channels.rb
 - lib/rails_spotlight/channels/handlers.rb
-- lib/rails_spotlight/channels/handlers/live_console_handler.rb
+- lib/rails_spotlight/channels/handlers/console_handler.rb
 - lib/rails_spotlight/channels/handlers/logs_handler.rb
 - lib/rails_spotlight/channels/silence_action_cable_broadcaster_logging.rb
 - lib/rails_spotlight/channels/spotlight_channel.rb
@@ -279,7 +281,6 @@ metadata:
   source_code_uri: https://github.com/pniemczyk/rails_spotlight
   changelog_uri: https://github.com/pniemczyk/rails_spotlight/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -287,15 +288,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Lets have a look at your rails application in details
 test_files: []