Class: ActionDispatch::TraceToFileExtractor

Inherits:
Object
  • Object
show all
Defined in:
lib/editor_opener/action_dispatch/trace_to_file_extractor.rb

Overview

Extract file and line from a trace and open it in the editor

This is used to open the file in the editor when the user clicks on the edit icon. You have to set the EDITOR environment variable to the editor you want to use.

Constant Summary collapse

KNOWN_EDITORS = 
[
  { symbols: [ :atom ], sniff: /atom/i, url: "atom://core/open/file?filename=%{file}&line=%{line}" },
  { symbols: [ :emacs, :emacsclient ], sniff: /emacs/i, url: "emacs://open?url=file://%{file}&line=%{line}" },
  { symbols: [ :idea ], sniff: /idea/i, url: "idea://open?file=%{file}&line=%{line}" },
  { symbols: [ :macvim, :mvim ], sniff: /vim/i, url: "mvim://open?url=file://%{file_unencoded}&line=%{line}" },
  { symbols: [ :rubymine ], sniff: /mine/i, url: "x-mine://open?file=%{file}&line=%{line}" },
  { symbols: [ :sublime, :subl, :st ], sniff: /subl/i, url: "subl://open?url=file://%{file}&line=%{line}" },
  { symbols: [ :textmate, :txmt, :tm ], sniff: /mate/i, url: "txmt://open?url=file://%{file}&line=%{line}" },
  { symbols: [ :vscode, :code ], sniff: /code/i, url: "vscode://file/%{file}:%{line}" },
  { symbols: [ :vscodium, :codium ], sniff: /codium/i, url: "vscodium://file/%{file}:%{line}" },
  { symbols: [ :windsurf ], sniff: /windsurf/i, url: "windsurf://file/%{file}:%{line}" },
  { symbols: [ :zed ], sniff: /zed/i, url: "zed://file/%{file}:%{line}" },
  { symbols: [ :nova ], sniff: /nova/i, url: "nova://open?path=%{file}&line=%{line}" },
  { symbols: [ :cursor ], sniff: /cursor/i, url: "cursor://file/%{file}:%{line}" },
  { symbols: [ :kiro ], sniff: /kiro/i, url: "kiro://file/%{file}:%{line}" }
]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(trace, line_number: nil) ⇒ TraceToFileExtractor

Returns a new instance of TraceToFileExtractor.



41
42
43
44
 
# File 'lib/editor_opener/action_dispatch/trace_to_file_extractor.rb', line 41

def initialize(trace, line_number: nil)
  @trace = trace.to_s.strip
  @line_number = line_number
end

Class Method Details

.editor ⇒ Object 



30
31
32
 
# File 'lib/editor_opener/action_dispatch/trace_to_file_extractor.rb', line 30

def editor
  @editor ||= potential_editor.present? && KNOWN_EDITORS.find { |editor| editor[:symbols].include?(potential_editor.to_sym) }
end

.open_in_editor? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/editor_opener/action_dispatch/trace_to_file_extractor.rb', line 26

def open_in_editor?
  editor.present?
end

Instance Method Details

#call ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/editor_opener/action_dispatch/trace_to_file_extractor.rb', line 46

def call
  return nil unless self.class.open_in_editor?

  file_name = file_name_in_the_trace
  return nil if file_name.blank?

  case detect_trace_type
  when :gem_reference
    gem_name = trace.split(" ").first
    gem_spec = Gem.loaded_specs[gem_name]
    file_name = gem_spec.present? ? "#{gem_spec.full_gem_path}/#{file_name}" : nil
  when :app_code
    file_name = "#{Rails.root}/#{file_name}"
  when :direct_path
    # do nothing, we already have the full path
  end

  if file_name
    file, line = file_name.split(":")

    self.class.editor[:url] % { file: file, line: line_number || line }
  else
    raise @trace
  end
end