rails_spotlight 0.4.2 → 0.5.0

data/lib/rails_spotlight/configuration.rb

@@ -4,12 +4,14 @@ require 'yaml'
 require 'erb'
 
 module RailsSpotlight
-  class Configuration # rubocop:disable Metrics/ClassLength
+  class Configuration
     DEFAULT_NOT_ENCODABLE_EVENT_VALUES = {
       'ActiveRecord' => [
         'ActiveRecord::ConnectionAdapters::AbstractAdapter',
         'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter',
-        'ActiveRecord::ConnectionAdapters::RealTransaction'
+        'ActiveRecord::ConnectionAdapters::RealTransaction',
+        'ActiveRecord::Transaction',
+        'ActiveRecord::SchemaMigration'
       ],
       'ActionDispatch' => ['ActionDispatch::Request', 'ActionDispatch::Response']
     }.freeze
@@ -39,10 +41,10 @@ module RailsSpotlight
     ].freeze
 
     attr_reader :project_name, :source_path, :logger, :storage_path, :storage_pool_size, :middleware_skipped_paths,
-                :not_encodable_event_values, :action_cable_mount_path,
-                :block_editing_files, :block_editing_files_outside_of_the_project, :skip_rendered_ivars,
-                :directory_index_ignore, :rubocop_config_path, :use_action_cable, :default_rs_src,
-                :form_js_execution_token
+                :not_encodable_event_values, :cable_mount_path,
+                :file_manager_enabled, :block_editing_files, :block_editing_files_outside_of_the_project, :skip_rendered_ivars,
+                :directory_index_ignore, :rubocop_enabled, :rubocop_config_path, :use_cable, :default_rs_src,
+                :form_js_execution_token, :sql_console_enabled, :irb_console_enabled, :data_access_token
 
     def initialize(opts = {}) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
       @project_name = opts[:project_name] || detect_project_name
@@ -50,50 +52,43 @@ module RailsSpotlight
       @logger = opts[:logger] || Logger.new(File.join(self.class.rails_root, 'log', 'rails_spotlight.log'))
       @storage_path = opts[:storage_path] || File.join(self.class.rails_root, 'tmp', 'data', 'rails_spotlight')
       @storage_pool_size = opts[:storage_pool_size] || 20
-      @live_console_enabled = opts[:live_console_enabled].nil? ? false : true?(opts[:live_console_enabled])
-      @request_completed_broadcast_enabled = opts[:request_completed_broadcast_enabled].nil? ? false : true?(opts[:request_completed_broadcast_enabled])
+      @cable_console_enabled = bool_val(:cable_console_enabled, opts)
+      @request_completed_broadcast_enabled = bool_val(:request_completed_broadcast_enabled, opts)
       @middleware_skipped_paths = opts[:middleware_skipped_paths] || []
       @not_encodable_event_values = DEFAULT_NOT_ENCODABLE_EVENT_VALUES.merge(opts[:not_encodable_event_values] || {})
-      @use_action_cable = opts[:use_action_cable].nil? ? false : true?(opts[:use_action_cable])
-      @auto_mount_action_cable = opts[:auto_mount_action_cable].nil? ? false : true?(opts[:auto_mount_action_cable])
-      @action_cable_mount_path = opts[:action_cable_mount_path] || '/cable'
-      @block_editing_files = opts[:block_editing_files].nil? ? false : true?(opts[:block_editing_files])
-      @block_editing_files_outside_of_the_project = opts[:block_editing_files_outside_of_the_project].nil? ? true : true?(opts[:block_editing_files_outside_of_the_project])
+      @use_cable = bool_val(:use_cable, opts)
+      @auto_mount_cable = bool_val(:auto_mount_cable, opts)
+      @cable_mount_path = opts[:cable_mount_path] || '/cable'
+      @block_editing_files = bool_val(:block_editing_files, opts)
+      @block_editing_files_outside_of_the_project = bool_val(:block_editing_files_outside_of_the_project, opts, default: true)
+      @file_manager_enabled = bool_val(:file_manager_enabled, opts, default: true)
       @skip_rendered_ivars = SKIP_RENDERED_IVARS + (opts[:skip_rendered_ivars] || []).map(&:to_sym)
       @directory_index_ignore = opts[:directory_index_ignore] || DEFAULT_DIRECTORY_INDEX_IGNORE
+      @rubocop_enabled = bool_val(:rubocop_enabled, opts, default: true)
       @rubocop_config_path = opts[:rubocop_config_path] ? File.join(self.class.rails_root, opts[:rubocop_config_path]) : nil
-      @live_logs_enabled = opts[:live_logs_enabled].nil? ? false : true?(opts[:live_logs_enabled])
+      @cable_logs_enabled = bool_val(:cable_logs_enabled, opts)
       @default_rs_src = opts[:default_rs_src] || 'default'
       @form_js_execution_token = opts[:form_js_execution_token] || Digest::MD5.hexdigest(detect_project_name)
+      @sql_console_enabled = bool_val(:sql_console_enabled, opts, default: true)
+      @irb_console_enabled = bool_val(:irb_console_enabled, opts, default: true)
+      @data_access_token = opts[:data_access_token].present? ? opts[:data_access_token] : nil
     end
 
-    def live_console_enabled
-      @live_console_enabled && use_action_cable && action_cable_present?
-    end
-
-    def live_logs_enabled
-      @live_logs_enabled && use_action_cable && action_cable_present?
-    end
-
-    alias live_console_enabled? live_console_enabled
-    alias live_logs_enabled? live_logs_enabled
-    alias use_action_cable? use_action_cable
-
-    def request_completed_broadcast_enabled
-      @request_completed_broadcast_enabled && use_action_cable && action_cable_present?
-    end
+    def cable_console_enabled = @cable_console_enabled && use_cable && action_cable_present?
+    def cable_logs_enabled = @cable_logs_enabled && use_cable && action_cable_present?
+    def request_completed_broadcast_enabled = @request_completed_broadcast_enabled && use_cable && action_cable_present?
+    def auto_mount_cable = @auto_mount_cable && use_cable && action_cable_present?
+    def action_cable_present? = defined?(ActionCable) && true
 
+    alias cable_console_enabled? cable_console_enabled
+    alias cable_logs_enabled? cable_logs_enabled
+    alias use_cable? use_cable
     alias request_completed_broadcast_enabled? request_completed_broadcast_enabled
-
-    def auto_mount_action_cable
-      @auto_mount_action_cable && use_action_cable && action_cable_present?
-    end
-
-    alias auto_mount_action_cable? auto_mount_action_cable
-
-    def action_cable_present?
-      defined?(ActionCable) && true
-    end
+    alias auto_mount_cable? auto_mount_cable
+    alias file_manager_enabled? file_manager_enabled
+    alias rubocop_enabled? rubocop_enabled
+    alias sql_console_enabled? sql_console_enabled
+    alias irb_console_enabled? irb_console_enabled
 
     def self.load_config
       config_file = File.join(rails_root, 'config', 'rails_spotlight.yml')
@@ -111,32 +106,19 @@ module RailsSpotlight
       new(opts)
     end
 
-    def self.rails_root
-      @rails_root ||= (Rails.root.to_s.presence || Dir.pwd).freeze
-    end
-
-    def rails_root
-      self.class.rails_root
-    end
+    def self.rails_root = @rails_root ||= (Rails.root.to_s.presence || Dir.pwd).freeze
+    def rails_root = self.class.rails_root
 
     private
 
-    def true?(value)
-      [true, 'true', 1, '1'].include?(value)
-    end
-
     def detect_project_name
       return ENV['RAILS_SPOTLIGHT_PROJECT'] if ENV['RAILS_SPOTLIGHT_PROJECT'].present?
 
-      if app_class.respond_to?(:module_parent_name)
-        app_class.module_parent_name
-      else
-        app_class.parent_name
-      end
+      app_class.respond_to?(:module_parent_name) ? app_class.module_parent_name : app_class.parent_name
     end
 
-    def app_class
-      @app_class ||= Rails.application.class
-    end
+    def app_class = @app_class ||= Rails.application.class
+    def true?(value) = [true, 'true', 1, '1'].include?(value)
+    def bool_val(key, opts, default: false) = opts[key].nil? ? default : true?(opts[key])
   end
 end

data/lib/rails_spotlight/event.rb

@@ -15,6 +15,8 @@ module RailsSpotlight
     def initialize(name, start, ending, transaction_id, payload)
       super(name, start, ending, transaction_id, json_encodable(payload))
       @duration = 1000.0 * (ending - start)
+    rescue # rubocop:disable Lint/RedundantCopDisableDirective, Style/RescueStandardError
+      @duration = 0
     end
 
     def self.events_for_exception(exception_wrapper)
@@ -28,7 +30,7 @@ module RailsSpotlight
       end
       trace.unshift "#{exception.class} (#{exception.message})"
       trace.map do |call|
-        Event.new('process_action.action_controller.exception', 0, 0, nil, call: call)
+        Event.new('process_action.action_controller.exception', 0, 0, nil, call:)
       end
     end
 
@@ -42,7 +44,7 @@ module RailsSpotlight
           value = value.to_h.select { |k, _| k.upcase == k }
         elsif value.is_a?(Array) && defined?(ActiveRecord::Relation::QueryAttribute) && value.first.is_a?(ActiveRecord::Relation::QueryAttribute)
           value = value.map(&method(:map_relation_query_attribute))
-        elsif not_encodable?(value)
+        elsif !value.respond_to?(:to_json) || not_encodable?(value)
           value = NOT_JSON_ENCODABLE
         end
 
@@ -54,6 +56,8 @@ module RailsSpotlight
         end
         hash[key] = new_value # encode_value(value)
       end.with_indifferent_access
+    rescue # rubocop:disable Lint/RedundantCopDisableDirective, Style/RescueStandardError
+      {}
     end
 
     # ActiveRecord::Relation::QueryAttribute implementation changed in Rails 7.1 it getting binds need to be manually added
@@ -71,13 +75,25 @@ module RailsSpotlight
 
     def not_encodable?(value)
       ::RailsSpotlight.config.not_encodable_event_values.any? do |module_name, class_names|
-        next unless defined?(module_name.constantize)
+        next unless safe_constantize(module_name)
 
-        class_names.any? { |class_name| value.is_a?(class_name.constantize) }
-      rescue # rubocop:disable Lint/SuppressedException, Style/RescueStandardError
+        class_names.any? do |class_name|
+          klass = safe_constantize(class_name)
+          next false unless klass
+
+          value.is_a?(klass)
+        end
+      rescue # rubocop:disable Style/RescueStandardError
+        true
       end
     end
 
+    def safe_constantize(name)
+      name.constantize
+    rescue NameError
+      nil
+    end
+
     def transform_hash(original, options = {}, &block)
       options[:safe_descent] ||= {}.compare_by_identity
 

data/lib/rails_spotlight/log_interceptor.rb

@@ -4,95 +4,72 @@ require_relative 'channels'
 
 module RailsSpotlight
   module LogInterceptor
-    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) # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
-      severity ||= 5
-      return true if @logdev.nil? || severity < level
-
-      progname = @progname if progname.nil?
-
-      if message.nil?
-        if block_given?
-          message = yield
-        else
-          message = progname
-          progname = @progname
-        end
-      end
-      return true if _skip_logging?(message)
-
-      _rails_spotlight_log(SEVERITY_MAP[severity], message, progname, :broadcast)
-      super(severity, message, progname) if defined?(super)
-      true
-    end
-
-
-    def debug(message = nil, *args, &block)
-      _rails_spotlight_log(:debug, message, nil, :event, &block)
+    def debug(message = nil, *args, &)
+      _rails_spotlight_log(:debug, message, nil, &)
       super
     end
 
-    def info(message = nil, *args, &block)
-      _rails_spotlight_log(:info, message, nil, :event, &block)
+    def info(message = nil, *args, &)
+      _rails_spotlight_log(:info, message, nil, &)
       super
     end
 
-    def warn(message = nil, *args, &block)
-      _rails_spotlight_log(:warn, message, nil, :event, &block)
+    def warn(message = nil, *args, &)
+      _rails_spotlight_log(:warn, message, nil, &)
       super
     end
 
-    def error(message = nil, *args, &block)
-      _rails_spotlight_log(:error, message, nil, :event, &block)
+    def error(message = nil, *args, &)
+      _rails_spotlight_log(:error, message, nil, &)
       super
     end
 
-    def fatal(message = nil, *args, &block)
-      _rails_spotlight_log(:fatal, message, nil, :event, &block)
+    def fatal(message = nil, *args, &)
+      _rails_spotlight_log(:fatal, message, nil, &)
       super
     end
 
-    def unknown(message = nil, *args, &block)
-      _rails_spotlight_log(:unknown, message, nil, :event, &block)
+    def unknown(message = nil, *args, &)
+      _rails_spotlight_log(:unknown, message, nil, &)
       super
     end
 
     private
 
     def _skip_logging?(message)
-      return false unless ::RailsSpotlight.config.use_action_cable?
+      return false unless ::RailsSpotlight.config.use_cable?
       return false unless message.is_a?(String)
 
       message.include?(::RailsSpotlight::Channels::SPOTLIGHT_CHANNEL)
     end
 
-    def _rails_spotlight_log(level, message, progname = nil, output = :event)
-      callsite = Utils.dev_callsite(caller.drop(1))
-      name = progname.is_a?(String) || progname.is_a?(Symbol) ? progname : nil
-      message = yield if output == :event && message.nil? && block_given?
-      output == :event ? _push_event(level, message, name, callsite) : _broadcast_log(message, level, callsite, name)
-    rescue StandardError => e
-      RailsSpotlight.config.logger.fatal("#{e.message}\n #{e.backtrace.join("\n ")}")
-    end
+    def _rails_spotlight_log(severity, message, progname = nil) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      return if message.nil? && !block_given?
 
-    def _push_event(level, message, progname = nil, callsite = {})
-      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
-    rescue StandardError => e
-      RailsSpotlight.config.logger.fatal("#{e.message}\n #{e.backtrace.join("\n ")}")
-    end
+      severity ||= :unknown
+      level = SEVERITY_MAP[severity.to_s]
+
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+          progname = @progname
+        end
+      end
+
+      return if _skip_logging?(message)
 
-    def _broadcast_log(message, level, callsite = {}, name = nil)
-      return unless ::RailsSpotlight.config.use_action_cable?
-      return if message.blank?
+      callsite = Utils.dev_callsite(caller.drop(1))
+      name = progname.is_a?(String) || progname.is_a?(Symbol) ? progname : nil
+      message = yield if message.nil? && block_given?
 
-      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)
+      AppRequest.current.events << Event.new('rsl.notification.log', 0, 0, 0, (callsite || {}).merge(message:, level: severity, progname: name)) if AppRequest.current
+      ::RailsSpotlight::Channels::SpotlightChannel.broadcast_log(message, level, callsite, name)
     rescue StandardError => e
-      RailsSpotlight.config.logger.fatal("#{e.message}\n #{e.backtrace.join("\n ")}")
+      RailsSpotlight.config.logger.fatal("#{e.message}\n #{e.backtrace&.join("\n ")}")
     end
   end
 end

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

@@ -4,10 +4,25 @@ module RailsSpotlight
   module Middlewares
     module Handlers
       class BaseActionHandler
-        IncorrectResponseContentType = Class.new(StandardError)
-        NotFound = Class.new(StandardError)
-        UnprocessableEntity = Class.new(StandardError)
-        Forbidden = Class.new(StandardError)
+        BaseError = Class.new(StandardError) do
+          attr_reader :code, :status
+
+          def initialize(message = nil, code: nil)
+            super(message)
+            @code = code
+            @status = case self.class.name.demodulize.underscore
+                      when 'unsupported_media_type' then 415
+                      when 'not_found' then 404
+                      when 'unprocessable_entity' then 422
+                      when 'forbidden' then 403
+                      else 500
+                      end
+          end
+        end
+        UnsupportedMediaType = Class.new(BaseError)
+        NotFound = Class.new(BaseError)
+        UnprocessableEntity = Class.new(BaseError)
+        Forbidden = Class.new(BaseError)
 
         def initialize(request_id, request, content_type)
           @request_id = request_id
@@ -18,45 +33,34 @@ module RailsSpotlight
         attr_reader :request_id, :request, :content_type
 
         def call
+          validate_data_access! if data_access_token
           validate_project! unless skip_project_validation?
           execute
           response
-        rescue NotFound => e
-          not_found_response(e.message)
-        rescue UnprocessableEntity => e
-          unprocessed_response(e.message)
-        rescue Forbidden => e
-          forbidden_response(e.message)
+        rescue BaseError => e
+          error_response(e)
         rescue => e # rubocop:disable Style/RescueStandardError
-          internal_server_error_response(e.message)
+          error_response(BaseError.new(e.message))
         end
 
         protected
 
         attr_writer :status, :headers
 
-        def skip_project_validation?
-          false
-        end
-
-        def headers
-          @headers ||= {}
-        end
-
-        def status
-          @status ||= 200
-        end
+        def skip_project_validation? = false
+        def headers = @headers ||= {}
+        def status = @status ||= 200
 
         def execute
           raise 'Not implemented yet'
         end
 
         def json_response_body
-          raise IncorrectResponseContentType, content_type
+          raise UnsupportedMediaType.new(content_type, code: :unsupported_media_type_json)
         end
 
         def text_response_body
-          raise IncorrectResponseContentType, content_type
+          raise UnsupportedMediaType.new(content_type, code: :unsupported_media_type_text)
         end
 
         def json_request_body
@@ -65,29 +69,9 @@ module RailsSpotlight
           raise 'Invalid JSON'
         end
 
-        def body_fetch(*args)
-          json_request_body.fetch(*args)
-        end
-
-        def internal_server_error_response(message)
-          response(500, message_to_body(message))
-        end
-
-        def unprocessed_response(message)
-          response(422, message_to_body(message))
-        end
-
-        def forbidden_response(message)
-          response(403, message_to_body(message))
-        end
-
-        def not_found_response(message)
-          response(404, message_to_body(message))
-        end
-
-        def message_to_body(message)
-          content_type == :json ? { message: message } : message
-        end
+        def body_fetch(*args) = json_request_body.fetch(*args)
+        def error_response(error) = response(error.status || 500, message_to_body(error.message, code: error.code, status: error.status || 500))
+        def message_to_body(message, code: :none, status: 500) = content_type == :json ? { message:, code:, status: } : message
 
         def response_headers(headers = {})
           {
@@ -107,19 +91,25 @@ module RailsSpotlight
           [overridden_status.present? ? overridden_status : status, response_headers(headers), [body]]
         end
 
-        def request_spotlight_version
-          @request_spotlight_version ||= request.get_header('HTTP_X_RAILS_SPOTLIGHT')
-        end
-
-        def request_for_projects
-          @request_for_projects ||= (request.get_header('HTTP_X_FOR_PROJECTS') || '').split(',').map(&:strip)
-        end
+        def request_spotlight_version = @request_spotlight_version ||= request.get_header('HTTP_X_RAILS_SPOTLIGHT')
+        def request_for_projects = @request_for_projects ||= (request.get_header('HTTP_X_FOR_PROJECTS') || '').split(',').map(&:strip)
 
         def validate_project!
           return if request_for_projects.blank?
           return if request_for_projects.include?(::RailsSpotlight.config.project_name)
 
-          raise Forbidden, "Check your settings the current request is not allowed to be executed on the #{::RailsSpotlight.config.project_name} project"
+          raise Forbidden.new(
+            "Check your settings the current request is not allowed to be executed on the #{::RailsSpotlight.config.project_name} project",
+            code: :project_mismatch
+          )
+        end
+
+        def data_access_token = ::RailsSpotlight.config.data_access_token
+
+        def validate_data_access!
+          return if request.get_header('HTTP_X_DATA_ACCESS_TOKEN') == data_access_token
+
+          raise Forbidden.new('Invalid data access token', code: :invalid_data_access_token)
         end
       end
     end

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

@@ -7,12 +7,11 @@ module RailsSpotlight
   module Middlewares
     module Handlers
       class CodeAnalysisActionHandler < BaseActionHandler
-        def skip_project_validation?
-          true
-        end
+        def skip_project_validation? = true
 
         def execute
-          raise UnprocessableEntity, 'Please add rubocop to your project' unless rubocop_installed?
+          raise Forbidden.new('Code analysis is disabled', code: :disabled_rubocop_settings) unless enabled?
+          raise UnprocessableEntity.new('Please add rubocop to your project', code: :rubocop_not_installed) unless rubocop_installed?
         end
 
         private
@@ -64,8 +63,8 @@ module RailsSpotlight
 
             {
               source: variant == :autofix ? corrected_source : source,
-              analysis_result: analysis_result,
-              variant: variant
+              analysis_result:,
+              variant:
             }
           ensure
             # Close and unlink the tempfile
@@ -76,13 +75,9 @@ module RailsSpotlight
           end
         end
 
-        def source
-          @source ||= body_fetch('source')
-        end
-
-        def variant
-          @variant ||= body_fetch('variant', 'check').to_sym
-        end
+        def source = @source ||= body_fetch('source')
+        def variant = @variant ||= body_fetch('variant', 'check').to_sym
+        def enabled? = ::RailsSpotlight.config.rubocop_enabled?
       end
     end
   end

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

@@ -6,29 +6,25 @@ module RailsSpotlight
     module Handlers
       class ConsoleActionHandler < BaseActionHandler
         def execute
+          raise Forbidden.new('Console is disabled', code: :disabled_irb_console_settings) unless enabled?
+
           RailsSpotlight.config.logger && RailsSpotlight.config.logger.info("Executing command: #{command}") # rubocop:disable Style/SafeNavigation
           executor.execute(command)
         end
 
         private
 
-        def executor
-          @executor ||= ::RailsSpotlight::RailsCommandExecutor.new
-        end
-
-        def inspect_types
-          @inspect_types ||= body_fetch('inspect_types')
-        end
-
-        def command
-          @command ||= body_fetch('command')
-        end
+        def executor = @executor ||= ::RailsSpotlight::RailsCommandExecutor.new
+        def inspect_types = @inspect_types ||= body_fetch('inspect_types')
+        def command = @command ||= body_fetch('command')
 
         def json_response_body
           return executor.result_as_json unless executor.execution_successful?
 
-          { result: executor.result_as_json(inspect_types: inspect_types) }
+          { result: executor.result_as_json(inspect_types:) }
         end
+
+        def enabled? = ::RailsSpotlight.config.irb_console_enabled?
       end
     end
   end

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

@@ -9,9 +9,13 @@ module RailsSpotlight
     module Handlers
       class DirectoryIndexActionHandler < BaseActionHandler
         def execute
-          @result = directory_to_json(::RailsSpotlight.config.rails_root)
-        rescue => e # rubocop:disable Style/RescueStandardError
-          raise UnprocessableEntity, e.message
+          raise Forbidden.new('File manager is disabled', code: :disabled_file_manager_settings) unless enabled?
+
+          @result = begin
+            directory_to_json(::RailsSpotlight.config.rails_root)
+          rescue => e # rubocop:disable Style/RescueStandardError
+            raise UnprocessableEntity.new(e.message, code: :directory_index_error)
+          end
         end
 
         private
@@ -55,29 +59,12 @@ module RailsSpotlight
           end
         end
 
-        def ignore
-          @ignore ||= body_fetch('ignore', [])
-        end
-
-        def sort_folders_first
-          @sort_folders_first ||= body_fetch('sort_folders_first', true)
-        end
-
-        def omnit_gitignore
-          @omnit_gitignore ||= body_fetch('omnit_gitignore', false)
-        end
-
-        def ignore_patterns
-          @ignore_patterns ||= ignore + ::RailsSpotlight.config.directory_index_ignore + (omnit_gitignore ? [] : gitignore_patterns)
-        end
-
-        def gitignore_file
-          @gitignore_file ||= File.join(::RailsSpotlight.config.rails_root, '.gitignore')
-        end
-
-        def show_empty_directories
-          @show_empty_directories ||= body_fetch('show_empty_directories', false)
-        end
+        def ignore = @ignore ||= body_fetch('ignore', [])
+        def sort_folders_first = @sort_folders_first ||= body_fetch('sort_folders_first', true)
+        def omnit_gitignore = @omnit_gitignore ||= body_fetch('omnit_gitignore', false)
+        def ignore_patterns = @ignore_patterns ||= ignore + ::RailsSpotlight.config.directory_index_ignore + (omnit_gitignore ? [] : gitignore_patterns)
+        def gitignore_file = @gitignore_file ||= File.join(::RailsSpotlight.config.rails_root, '.gitignore')
+        def show_empty_directories = @show_empty_directories ||= body_fetch('show_empty_directories', false)
 
         def gitignore_patterns
           @gitignore_patterns ||= if File.exist?(gitignore_file)
@@ -103,9 +90,11 @@ module RailsSpotlight
         def json_response_body
           {
             root_path: ::RailsSpotlight.config.rails_root,
-            result: result
+            result:
           }
         end
+
+        def enabled? = ::RailsSpotlight.config.file_manager_enabled
       end
     end
   end