rails_spotlight 0.2.5 → 0.3.0

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'tempfile'
+
+module RailsSpotlight
+  module Middlewares
+    module Handlers
+      class CodeAnalysisActionHandler < BaseActionHandler
+        def skip_project_validation?
+          true
+        end
+
+        def execute
+          raise UnprocessableEntity, 'Please add rubocop to your project' unless rubocop_installed?
+        end
+
+        private
+
+        def rubocop_installed?
+          Gem::Specification.find_all_by_name('rubocop').any?
+        rescue Gem::LoadError
+          false
+        end
+
+        def json_response_body # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+          require 'rubocop'
+
+          # Create a temporary file to hold the source code
+          tempfile = Tempfile.new(['source', '.rb'])
+          tempfile.write(source)
+          tempfile.rewind
+
+          # Create a temporary file to capture the RuboCop output
+          output_file = Tempfile.new(['rubocop_output', '.json'])
+
+          # Define RuboCop options
+          options = {
+            formatters: [['json', output_file.path]],
+            cache: false,
+            safe: true
+          }
+
+          options[:autocorrect] = variant == :autofix
+
+          # Check for custom .rubocop.yml configuration
+          config_file = ::RailsSpotlight.config.rubocop_config_path || File.join(RailsSpotlight::Configuration.rails_root, '.rubocop.yml')
+
+          # Run RuboCop with appropriate options
+          config_store = RuboCop::ConfigStore.new
+          config_store.options_config = config_file if File.exist?(config_file)
+          runner = RuboCop::Runner.new(options, config_store)
+
+          begin
+            runner.run([tempfile.path])
+
+            # Read the corrected source
+            tempfile.rewind
+            corrected_source = File.read(tempfile.path)
+
+            # Read the RuboCop analysis result from the output file
+            output_file.rewind
+            analysis_result = JSON.parse(output_file.read)
+
+            {
+              source: variant == :autofix ? corrected_source : source,
+              analysis_result: analysis_result,
+              variant: variant
+            }
+          ensure
+            # Close and unlink the tempfile
+            tempfile.close
+            tempfile.unlink
+            output_file.close
+            output_file.unlink
+          end
+        end
+
+        def source
+          @source ||= body_fetch('source')
+        end
+
+        def variant
+          @variant ||= body_fetch('variant', 'check').to_sym
+        end
+      end
+    end
+  end
+end

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

@@ -6,46 +6,28 @@ module RailsSpotlight
     module Handlers
       class ConsoleActionHandler < BaseActionHandler
         def execute
-          validate_project!
-
           RailsSpotlight.config.logger && RailsSpotlight.config.logger.info("Executing command: #{command}") # rubocop:disable Style/SafeNavigation
           executor.execute(command)
         end
 
         private
 
-        def validate_project!
-          return if for_project.blank?
-          return if for_project.include?(::RailsSpotlight.config.project_name)
-
-          raise UnprocessableEntity, "Check your connection settings the current command is not allowed to be executed on the #{::RailsSpotlight.config.project_name} project"
-        end
-
         def executor
           @executor ||= ::RailsSpotlight::RailsCommandExecutor.new
         end
 
         def inspect_types
-          @inspect_types ||= json_request_body.fetch('inspect_types')
+          @inspect_types ||= body_fetch('inspect_types')
         end
 
         def command
-          @command ||= json_request_body.fetch('command')
-        end
-
-        def for_project
-          @for_project ||= json_request_body['project']
+          @command ||= body_fetch('command')
         end
 
         def json_response_body
-          if executor.execution_successful?
-            {
-              result: executor.result_as_json(inspect_types: inspect_types),
-              project: ::RailsSpotlight.config.project_name
-            }
-          else
-            executor.result_as_json.merge(project: ::RailsSpotlight.config.project_name)
-          end
+          return executor.result_as_json unless executor.execution_successful?
+
+          { result: executor.result_as_json(inspect_types: inspect_types) }
         end
       end
     end

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

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'find'
+require 'pathname'
+
+module RailsSpotlight
+  module Middlewares
+    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
+        end
+
+        private
+
+        attr_reader :result
+
+        def directory_to_json(path) # rubocop:disable Metrics/CyclomaticComplexity
+          relative_path = Pathname.new(path).relative_path_from(::RailsSpotlight.config.rails_root).to_s
+          return nil if ignored?(relative_path)
+
+          entry = {
+            name: File.basename(path),
+            path: relative_path,
+            dir: File.directory?(path),
+            children: []
+          }
+
+          if entry[:dir]
+            children = sort_children(Dir.children(path), path)
+            children.each do |child|
+              child_path = File.join(path, child)
+              child_entry = directory_to_json(child_path)
+              entry[:children] << child_entry if child_entry
+            end
+          end
+
+          return entry unless entry[:dir]
+          return entry unless entry[:children].empty?
+
+          show_empty_directories ? entry : nil
+        end
+
+        def sort_children(children, parent_path)
+          if sort_folders_first
+            children.sort_by do |child|
+              child_path = File.join(parent_path, child)
+              [File.directory?(child_path) ? 0 : 1, child.downcase]
+            end
+          else
+            children.sort_by(&:downcase)
+          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 gitignore_patterns
+          @gitignore_patterns ||= if File.exist?(gitignore_file)
+                                    File.readlines(gitignore_file).map do |line|
+                                      line.strip!
+                                      next if line.empty? || line.start_with?('#') || line.start_with?('!')
+
+                                      line
+                                    end.compact
+                                  else
+                                    []
+                                  end
+        end
+
+        def ignored?(path)
+          return false if path == '.'
+
+          ignore_patterns.any? do |pattern|
+            File.fnmatch?(pattern, "/#{path}", File::FNM_PATHNAME | File::FNM_DOTMATCH)
+          end
+        end
+
+        def json_response_body
+          {
+            root_path: ::RailsSpotlight.config.rails_root,
+            result: result
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -23,14 +23,16 @@ module RailsSpotlight
         end
 
         def new_content
-          json_request_body.fetch('content')
+          body_fetch('content')
         end
 
         def json_response_body
           {
             source: text_response_body,
             changed: write_mode?,
-            project: ::RailsSpotlight.config.project_name
+            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
 
@@ -55,7 +57,7 @@ module RailsSpotlight
         end
 
         def request_mode
-          @request_mode ||= json_request_body.fetch('mode', 'read')
+          @request_mode ||= body_fetch('mode', 'read')
         end
 
         def path_valid?
@@ -67,13 +69,17 @@ module RailsSpotlight
                            original_file_path
                          elsif file_in_project?
                            File.join(::RailsSpotlight.config.rails_root, original_file_path)
+                         elsif file_in_project_app_dir?
+                           File.join(::RailsSpotlight.config.rails_root, 'app', original_file_path)
+                         elsif file_in_project_views_dir?
+                           File.join(::RailsSpotlight.config.rails_root, 'app', 'views', original_file_path)
                          else # rubocop:disable Lint/DuplicateBranch
                            original_file_path
                          end
         end
 
         def original_file_path
-          @original_file_path ||= json_request_body.fetch('file')
+          @original_file_path ||= body_fetch('file')
         end
 
         def path_file_in_project?
@@ -84,6 +90,14 @@ module RailsSpotlight
           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

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

@@ -11,7 +11,6 @@ module RailsSpotlight
         def json_response_body
           {
             events: events,
-            project: ::RailsSpotlight.config.project_name,
             root_path: ::RailsSpotlight.config.rails_root
           }
         end

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

@@ -5,7 +5,6 @@ module RailsSpotlight
     module Handlers
       class SqlActionHandler < BaseActionHandler
         def execute
-          validate_project!
           return transaction unless ActiveSupport.const_defined?('ExecutionContext')
 
           ActiveSupport::ExecutionContext.set(rails_spotlight: request_id) do
@@ -15,13 +14,6 @@ module RailsSpotlight
 
         private
 
-        def validate_project!
-          return if required_projects.blank?
-          return if required_projects.include?(::RailsSpotlight.config.project_name)
-
-          raise UnprocessableEntity, "Check your connection settings the current query is not allowed to be executed on the #{::RailsSpotlight.config.project_name} project"
-        end
-
         def transaction
           ActiveRecord::Base.transaction do
             begin # rubocop:disable Style/RedundantBegin
@@ -56,8 +48,7 @@ module RailsSpotlight
             result: result,
             logs: logs,
             error: error.present? ? error.inspect : nil,
-            query_mode: force_execution? ? 'force' : 'default',
-            project: ::RailsSpotlight.config.project_name
+          query_mode: force_execution? ? 'force' : 'default'
           }
         end
 
@@ -72,15 +63,15 @@ module RailsSpotlight
         end
 
         def query
-          @query ||= json_request_body.fetch('query')
+          @query ||= body_fetch('query')
         end
 
         def raw_options
-          @raw_options ||= json_request_body.fetch('options', {}) || {}
+          @raw_options ||= body_fetch('options', {}) || {}
         end
 
-        def required_projects
-          @required_projects ||= raw_options.fetch('projects', [])
+        def mode
+          @mode ||= body_fetch('mode', 'default')
         end
 
         def use
@@ -95,7 +86,7 @@ module RailsSpotlight
         end
 
         def force_execution?
-          @force_execution ||= json_request_body['mode'] == 'force'
+          @force_execution ||= mode == 'force'
         end
       end
     end

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

@@ -12,15 +12,19 @@ module RailsSpotlight
           "Rails Spotlight is working!\nRails version: #{Rails.version}\nRails environment: #{Rails.env}"
         end
 
+        def skip_project_validation?
+          true
+        end
+
         def json_response_body
           {
             params: request.params,
             body: request.body.read,
             content_type: request.content_type,
             request_method: request.request_method,
-            version: request.get_header('HTTP_X_RAILS_SPOTLIGHT'),
+            version: request_spotlight_version,
+            for_projects: request_for_projects,
             current_gem_version: ::RailsSpotlight::VERSION,
-            project: ::RailsSpotlight.config.project_name,
             action_cable_path: defined?(ActionCable) ? ActionCable&.server&.config&.mount_path : nil
           }
         end

data/lib/rails_spotlight/middlewares/request_completed.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'concerns/skip_request_paths'
+require_relative '../channels/spotlight_channel'
 
 module RailsSpotlight
   module Middlewares
@@ -13,6 +14,8 @@ module RailsSpotlight
       end
 
       def call(env)
+        return app.call(env) unless ::RailsSpotlight.config.request_completed_broadcast_enabled?
+
         if skip?(env['PATH_INFO']) || (env['HTTP_CONNECTION'] == 'Upgrade' && env['HTTP_UPGRADE'] == 'websocket')
           app.call(env)
         else
@@ -40,17 +43,18 @@ module RailsSpotlight
         request = ActionDispatch::Request.new(env)
 
         host, url = host_and_url(env)
-        ActionCable.server.broadcast(
-          'rails_spotlight_request_completed_channel',
+        RailsSpotlight::Channels::SpotlightChannel.broadcast(
           {
-            rails_spotlight_version: RailsSpotlight::VERSION,
-            id: rails_spotlight_request_id,
-            http_method: env['REQUEST_METHOD'],
-            host: host,
-            url: url,
-            format: request.format.symbol,
-            controller: request.path_parameters[:controller],
-            action: request.path_parameters[:action]
+            type: 'request_completed',
+            payload: {
+              id: rails_spotlight_request_id,
+              http_method: env['REQUEST_METHOD'],
+              host: host,
+              url: url,
+              format: request.format.symbol,
+              controller: request.path_parameters[:controller],
+              action: request.path_parameters[:action]
+            }
           }
         )
       end

data/lib/rails_spotlight/middlewares/request_handler.rb

@@ -2,11 +2,13 @@
 
 require_relative 'handlers/base_action_handler'
 require_relative 'handlers/file_action_handler'
+require_relative 'handlers/directory_index_action_handler'
 require_relative 'handlers/sql_action_handler'
 require_relative 'handlers/verify_action_handler'
 require_relative 'handlers/not_found_action_handler'
 require_relative 'handlers/meta_action_handler'
 require_relative 'handlers/console_action_handler'
+require_relative 'handlers/code_analysis_action_handler'
 
 module RailsSpotlight
   module Middlewares
@@ -27,14 +29,16 @@ module RailsSpotlight
 
       attr_reader :app
 
-      def handle(request, action, content_type = :json)
+      def handle(request, action, content_type = :json) # rubocop:disable Metrics/CyclomaticComplexity
         args = [SecureRandom.uuid, request, content_type]
         case action
         when 'file' then Handlers::FileActionHandler.new(*args).call
+        when 'directory_index' then Handlers::DirectoryIndexActionHandler.new(*args).call
         when 'sql' then Handlers::SqlActionHandler.new(*args).call
         when 'verify' then Handlers::VerifyActionHandler.new(*args).call
         when 'meta' then Handlers::MetaActionHandler.new(*args).call
         when 'console' then Handlers::ConsoleActionHandler.new(*args).call
+        when 'code_analysis' then Handlers::CodeAnalysisActionHandler.new(*args).call
         else
           Handlers::NotFoundActionHandler.new(*args).call
         end

data/lib/rails_spotlight/railtie.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rails/railtie'
+require_relative 'log_interceptor'
 
 module RailsSpotlight
   class Railtie < ::Rails::Railtie
@@ -9,7 +10,10 @@ module RailsSpotlight
     end
 
     initializer 'rails_spotlight.log_interceptor' do
-      Rails.logger&.extend(LogInterceptor) unless Rails.env.production?
+      unless Rails.env.production?
+        Rails.logger&.extend(LogInterceptor)
+        defined?(Sidekiq::Logger) && Sidekiq.logger&.extend(LogInterceptor)
+      end
     end
 
     initializer 'rails_spotlight.subscribe_to_notifications' do
@@ -26,8 +30,7 @@ module RailsSpotlight
       app.config.after_initialize do
         update_actioncable_allowed_request_origins!
 
-        require 'rails_spotlight/channels/request_completed_channel' if ::RailsSpotlight.config.request_completed_broadcast_enabled?
-        require 'rails_spotlight/channels/live_console_channel' if ::RailsSpotlight.config.live_console_enabled?
+        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?
       end
@@ -51,7 +54,12 @@ module RailsSpotlight
 
       return unless ::RailsSpotlight.config.request_completed_broadcast_enabled?
 
-      app.middleware.insert_after ::RailsSpotlight::Middlewares::HeaderMarker, RailsSpotlight::Middlewares::RequestCompleted, app.config
+      # app.middleware.insert_after ::RailsSpotlight::Middlewares::HeaderMarker, RailsSpotlight::Middlewares::RequestCompleted, app.config
+      if defined? ActionDispatch::Executor
+        app.middleware.insert_after ActionDispatch::Executor, ::RailsSpotlight::Middlewares::RequestCompleted, app.config
+      else
+        app.middleware.use ::RailsSpotlight::Middlewares::RequestCompleted
+      end
     end
 
     def app

data/lib/rails_spotlight/render_view_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsSpotlight
   class RenderViewReporter
     def self.report_rendered_view_locals(view, locals: nil, params: nil, show_devise: false, skip_vars: [], metadata: {})
@@ -12,7 +14,7 @@ module RailsSpotlight
 
     def self.serialize_as_json(value)
       value.respond_to?(:as_json) ? value.as_json : nil
-    rescue => e
+    rescue => e # rubocop:disable Style/RescueStandardError
       {
         __serialization_error: e.message,
         __source: value.inspect

data/lib/rails_spotlight/utils.rb

@@ -15,6 +15,8 @@ module RailsSpotlight
         line: line.to_i,
         method: method
       }
+    rescue
+      nil
     end
 
     def sub_source_path(path)

data/lib/rails_spotlight/version.rb

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

data/lib/tasks/init.rake

@@ -4,7 +4,7 @@ require 'rake'
 
 namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
   desc 'Generate rails_spotlight configuration file'
-  task generate_config: :environment do
+  task generate_config: :environment do # rubocop:disable Metrics/BlockLength
     require 'fileutils'
 
     config_path = Rails.root.join('config', 'rails_spotlight.yml')
@@ -19,15 +19,21 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
       MIDDLEWARE_SKIPPED_PATHS: []
       NOT_ENCODABLE_EVENT_VALUES:
       SKIP_RENDERED_IVARS: []
+      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_CONFIG_PATH: '.rubocop.yml'
       # Rest of the configuration is required for ActionCable. It will be disabled automatically in when ActionCable is not available.
-      # LIVE_CONSOLE_ENABLED from version 0.2.3 do not require ActionCable to be enabled.
+      AUTO_MOUNT_ACTION_CABLE: false
+      ACTION_CABLE_MOUNT_PATH: /cable
+      # Required for all action cable features
+      USE_ACTION_CABLE: false
       LIVE_CONSOLE_ENABLED: false
       # Experimental feature.
       REQUEST_COMPLETED_BROADCAST_ENABLED: false
-      AUTO_MOUNT_ACTION_CABLE: false
-      ACTION_CABLE_MOUNT_PATH: /cable
-      BLOCK_EDITING_FILES: false
-      BLOCK_EDITING_FILES_OUTSIDE_OF_THE_PROJECT: true
+      LIVE_LOGS_ENABLED: false
+      DEFAULT_RS_SRC: default
+      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)%>
     YAML
 
     if File.exist?(config_path)
@@ -38,4 +44,67 @@ namespace :rails_spotlight do # rubocop:disable Metrics/BlockLength
       puts 'Created config file: config/rails_spotlight.yml'
     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
+    # Define the partial name and path
+    partial_name = "_rails_spotlight_extension_js.html.erb"
+    partial_path = "app/views/layouts/#{partial_name}"
+
+    # Define the JavaScript code
+    js_code = <<~JS
+      <script>
+        try {
+          function executeScriptFromMessage(msg) {
+            if (msg.token === "<%=::RailsSpotlight.config.form_js_execution_token%>") {
+              try {
+                const func = new Function(msg.code);
+                func();
+                return {status: 'Executed'};
+              } catch (e) {
+                return {status: 'Error', error: e};
+              }
+            } else {
+              return {status: 'Error', error: 'Invalid token provided, script execution aborted.'};
+            }
+          }
+
+          window.addEventListener('message', (event) => {
+            if (event.data && event.data.type === 'RAILS_SPOTLIGHT_EXTENSION_JS_EXECUTION') {
+              var result = executeScriptFromMessage(event.data);
+              if (event.data.debug) {
+                console.log('Script execution result:', result);
+              }
+            }
+          });
+        } catch (e) {
+          console.error('Error initializing the RAILS_SPOTLIGHT_EXTENSION_JS_EXECUTION script listener:', e);
+        }
+      </script>
+    JS
+
+    # Generate the ERB partial
+    File.write(partial_path, js_code)
+    puts "Partial created: #{partial_path}"
+
+    layout_file = Dir.glob('app/views/layouts/application.html.{erb,slim,haml}').first
+    layout_format = layout_file.split('.').last
+
+    if layout_file
+      puts "Detected layout file: #{layout_file}"
+      puts 'Please add the following line to your layout file at the appropriate place:'
+    else
+      puts 'No application layout file detected.'
+      puts 'Please manually add the following line to your application layout file:'
+    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}'"
+    else
+      puts "<% if Rails.env.development? %>\n  <%= render 'layouts/#{partial_name.split('.').first}' %>\n<% end %>"
+    end
+  end
 end