editor_opener 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97e3fda047f6c339f6b1e5c85ac7a6e7442438adf1be5698cc74509dc277cab2
-  data.tar.gz: 86a624869961333ebb914c16f5c8e4a9aa27d2fd11959a4c43ca04eebeeb1782
+  metadata.gz: 6d7652583a50398a131c7f55eb47307dc5aec0a521d3663462e37345afc3e206
+  data.tar.gz: 2428aeee0b984176fddfd3c1307039be50d38296725990384f8465a18a578d6a
 SHA512:
-  metadata.gz: '039d8837645d9a93163a08693939eabeebc8179176ead4bc8e113906bc80a1b219e57a7c47cdab904e8571bbd005fac2cdd91ecb87d7529d154c2ed59cd99e76'
-  data.tar.gz: 2598ff96c36081386a3d8ec4692c9aff666d322a268e11ec47cfe92c625816d9516baaaea8b866779ab7130a4aa9c8f6723c1a8d6c09d1a6e445995a32e07ccf
+  metadata.gz: 59d2f5d010666fe3b600e87fbb044d14850abd6b7a71673ff8672398040e389f90d9c844022f41683fa2fca18303823e346dc478d9a48ad20416589419efe709
+  data.tar.gz: 29be85c61c83125543cb25c3a2348c6ae94597118e5f3cb97244c0e91ecff11b7d1659df7f125fb4c2d4fb80a42e3a36506b3057b57e994b81c8257266d54f97

data/README.md

@@ -1,28 +1,191 @@
-# EditorOpener
-Short description and motivation.
+# editor_opener
 
-## Usage
-How to use my plugin.
+Open source files in your editor directly from Rails error pages. This gem adds clickable links to file paths in Rails error pages, allowing you to instantly open files at the exact line where errors occur.
+
+![editor_opener](docs/editor_opener.gif)
+
+## Features
+
+- 🔗 **Clickable file links** in Rails error pages
+- 📝 **Multiple editor support** - Works with 13+ popular editors
+- 🎯 **Precise line targeting** - Opens files at the exact error line
+- 🔧 **Easy configuration** - Set via initializer or environment variable
+- 🚀 **Zero configuration** - Works out of the box with `EDITOR` environment variable
+- 📱 **Custom URL schemes** - Uses editor-specific protocols for seamless integration
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "editor_opener"
+group :development do
+  gem "editor_opener"
+end
 ```
 
 And then execute:
 ```bash
-$ bundle
+$ bundle install
+```
+
+## Configuration
+
+### Option 1: Generate and configure initializer (Recommended)
+
+```bash
+$ rails generate editor_opener:install
+```
+
+This creates `config/initializers/editor_opener.rb` with all supported editors listed as comments.
+
+Edit the initializer to set your preferred editor:
+
+```ruby
+EditorOpener.setup do |config|
+  config.editor = :cursor  # or any other supported editor
+end
 ```
 
-Or install it yourself as:
+### Option 2: Environment variable
+
+Set the `EDITOR` environment variable:
+
 ```bash
-$ gem install editor_opener
+export EDITOR=cursor  # for Cursor
+export EDITOR=atom    # for Atom
+export EDITOR=subl    # for Sublime Text
+```
+
+## Usage
+
+1. **Install and configure** the gem (see above)
+2. **Restart your Rails server**
+3. **Trigger an error** in your Rails application
+4. **Click the edit icons** (✏️) or line numbers in the error page to open files in your editor
+
+The gem automatically detects error traces from:
+- Application code
+- Gem files
+- Direct file paths
+
+## Supported Editors
+
+The gem supports the following editors with their respective symbols:
+
+| Editor | Symbols | Protocol |
+|--------|---------|----------|
+| **Atom** | `:atom` | `atom://` |
+| **Cursor** | `:cursor` | `cursor://` |
+| **Emacs** | `:emacs`, `:emacsclient` | `emacs://` |
+| **IntelliJ IDEA** | `:idea` | `idea://` |
+| **MacVim** | `:macvim`, `:mvim` | `mvim://` |
+| **Nova** | `:nova` | `nova://` |
+| **RubyMine** | `:rubymine` | `x-mine://` |
+| **Sublime Text** | `:sublime`, `:subl`, `:st` | `subl://` |
+| **TextMate** | `:textmate`, `:txmt`, `:tm` | `txmt://` |
+| **Visual Studio Code** | `:vscode`, `:code` | `vscode://` |
+| **VSCodium** | `:vscodium`, `:codium` | `vscodium://` |
+| **Windsurf** | `:windsurf` | `windsurf://` |
+| **Zed** | `:zed` | `zed://` |
+
+## Examples
+
+### Basic Configuration
+
+```ruby
+# config/initializers/editor_opener.rb
+EditorOpener.setup do |config|
+  config.editor = :cursor
+end
+```
+
+### Environment Variable
+
+```bash
+# In your shell profile (~/.bashrc, ~/.zshrc, etc.)
+export EDITOR=cursor
+
+# Or in your .env file (if using dotenv)
+EDITOR=cursor
+```
+
+### Multiple Environments
+
+```ruby
+# config/initializers/editor_opener.rb
+EditorOpener.setup do |config|
+  config.editor = Rails.env.development? ? :cursor : nil
+end
+```
+
+## How It Works
+
+1. **Error Detection**: The gem overrides Rails error pages
+2. **Trace Parsing**: Extracts file paths and line numbers from stack traces
+3. **Editor Detection**: Matches configured editor with supported protocols
+4. **URL Generation**: Creates editor-specific URLs for file opening
+5. **Link Enhancement**: Adds clickable links to error page templates
+
+## Troubleshooting
+
+### Editor doesn't open files
+
+1. **Check editor configuration**: Ensure your editor symbol is correct
+2. **Verify protocol support**: Make sure your editor supports URL protocols
+3. **Test environment variable**: Try setting `EDITOR` environment variable
+4. **Restart Rails server**: Configuration changes require server restart
+
+### Links don't appear
+
+1. **Check gem is loaded**: Ensure gem is in development group
+2. **Verify Rails environment**: Gem typically only works in development
+3. **Test with simple error**: Create a basic error to test functionality
+
+## Development
+
+After checking out the repo, run:
+
+```bash
+$ bin/setup
+$ bin/test
+```
+
+To run tests:
+
+```bash
+$ bin/test
+$ bin/rubocop
 ```
 
 ## Contributing
-Contribution directions go here.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/igorkasyanchuk/editor_opener.
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Make your changes
+4. Add tests for your changes
+5. Ensure all tests pass (`bin/test`)
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create a new Pull Request
+
+## TODO
+
+- verify it works with old Rails versions
+- more tests
+- support for more error pages?
+- support for more editors
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Created by [Igor Kasyanchuk](https://github.com/igorkasyanchuk).
+
+## Related Projects
+
+- [better_errors](https://github.com/BetterErrors/better_errors) - Better error pages for Rails
+- [web-console](https://github.com/rails/web-console) - Rails console in your browser

data/app/views/rescues/_source.html.erb

@@ -0,0 +1,34 @@
+<% error_index = local_assigns[:error_index] || 0 %>
+
+<% source_extracts.each_with_index do |source_extract, index| %>
+  <% if source_extract[:code] %>
+    <div class="source <%= "hidden" if show_source_idx != index %>" id="frame-source-<%= error_index %>-<%= index %>">
+      <div class="info">
+        Extracted source (around line <strong>#<%= source_extract[:line_number] %></strong>):
+      </div>
+      <div class="data">
+        <table cellpadding="0" cellspacing="0" class="lines">
+          <tr>
+            <td>
+              <pre class="line_numbers">
+                <% source_extract[:code].each_key do |line_number| %>
+                  <% file_url = ActionDispatch::TraceToFileExtractor.open_in_editor? && ActionDispatch::TraceToFileExtractor.new(source_extract[:trace], line_number:).call %>
+<span><%= file_url ? raw("<a class=\"edit-line-link\" href=\"#{file_url}\">#{line_number}</a>") : line_number -%></span>
+                <% end %>
+              </pre>
+            </td>
+<td width="100%">
+<pre>
+<% source_extract[:code].each do |line, source| -%>
+<div class="line<%= " active" if line == source_extract[:line_number] -%>"><% if source.is_a?(Array) -%><%= source[0] -%><span class="error_highlight"><%= source[1] -%></span><%= source[2] -%>
+<% else -%>
+<%= source -%>
+<% end -%></div><% end -%>
+</pre>
+</td>
+          </tr>
+        </table>
+      </div>
+    </div>
+  <% end %>
+<% end %>

data/app/views/rescues/layout.erb

@@ -70,7 +70,11 @@
       display: flex;
       align-items: center;
       justify-content: center;
-      color: #B0B0B0;
+      color: #A0A0A0;
+    }
+
+    .edit-line-link {
+      color: #A0A0A0;
     }
 
     .response-heading, .request-heading {

data/lib/editor_opener/action_dispatch/exception_wrapper_overrides.rb

@@ -0,0 +1,9 @@
+module ActionDispatch
+  module ExceptionWrapperOverrides
+    def source_extracts
+      backtrace.map do |trace|
+        extract_source(trace).merge(trace: trace)
+      end
+    end
+  end
+end

data/lib/editor_opener/action_dispatch/trace_to_file_extractor.rb

@@ -27,12 +27,19 @@ module ActionDispatch
       end
 
       def editor
-        @editor ||= ENV["EDITOR"].present? && KNOWN_EDITORS.find { |editor| editor[:symbols].include?(ENV["EDITOR"].to_sym) }
+        @editor ||= potential_editor.present? && KNOWN_EDITORS.find { |editor| editor[:symbols].include?(potential_editor.to_sym) }
+      end
+
+      private
+
+      def potential_editor
+        EditorOpener.editor || ENV["EDITOR"]
       end
     end
 
-    def initialize(trace)
+    def initialize(trace, line_number: nil)
       @trace = trace.to_s.strip
+      @line_number = line_number
     end
 
     def call
@@ -55,14 +62,14 @@ module ActionDispatch
       if file_name
         file, line = file_name.split(":")
 
-        self.class.editor[:url] % { file: file, line: line }
+        self.class.editor[:url] % { file: file, line: line_number || line }
       else
         raise @trace
       end
     end
 
     private
-      attr_reader :trace
+      attr_reader :trace, :line_number
 
       def detect_trace_type
         if trace[0] == "/" || trace.match?(/^[A-Z]:/)

data/lib/editor_opener/railtie.rb

@@ -1,4 +1,5 @@
 require_relative "action_dispatch/trace_to_file_extractor"
+require_relative "action_dispatch/exception_wrapper_overrides"
 
 module EditorOpener
   class Railtie < ::Rails::Railtie
@@ -9,6 +10,8 @@ module EditorOpener
         # DebugView has custom templates path, that cannot be overridden by prepend_view_path
         ActionDispatch::DebugView::RESCUES_TEMPLATE_PATHS.unshift(path)
       end
+
+      ActionDispatch::ExceptionWrapper.prepend(ActionDispatch::ExceptionWrapperOverrides)
     end
   end
 end

data/lib/editor_opener/version.rb

@@ -1,3 +1,3 @@
 module EditorOpener
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/editor_opener.rb

@@ -2,4 +2,10 @@ require "editor_opener/version"
 require "editor_opener/railtie"
 
 module EditorOpener
+  mattr_accessor :editor
+  @@editor = nil
+
+  def self.setup
+    yield self
+  end
 end

data/lib/generators/editor_opener/install_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators/base"
+
+module EditorOpener
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Create an initializer file for EditorOpener configuration"
+
+      def create_initializer_file
+        template "initializer.rb", "config/initializers/editor_opener.rb"
+      end
+
+      def show_readme
+        readme "README"
+      end
+    end
+  end
+end

data/lib/generators/editor_opener/templates/README

@@ -0,0 +1,26 @@
+===============================================================================
+
+editor_opener initializer has been created!
+
+The initializer has been created at:
+  config/initializers/editor_opener.rb
+
+To get started:
+1. Edit the initializer file to set your preferred editor
+2. Uncomment the line with your editor (e.g., config.editor = :cursor)
+3. Restart your Rails server
+4. Trigger an error in your Rails app to see the editor links
+
+Supported editors include:
+- Visual Studio Code (:vscode)
+- Cursor (:cursor)
+- Atom (:atom)
+- Sublime Text (:sublime, :subl, or :st)
+- RubyMine (:rubymine)
+- Zed (:zed)
+- And many more!
+
+For more information, visit:
+https://github.com/igorkasyanchuk/editor_opener
+
+===============================================================================

data/lib/generators/editor_opener/templates/initializer.rb

@@ -0,0 +1,43 @@
+# Configuration
+# This gem allows you to open files in your editor directly from Rails error pages.
+# Configure your preferred editor by setting the editor symbol below.
+
+EditorOpener.setup do |config|
+  # Set your preferred editor
+  # You can use any of the supported editors listed below:
+  # config.editor = :cursor
+
+  # Alternatively, you can set the EDITOR environment variable
+  # export EDITOR=cursor
+
+  # Supported editors:
+  # :atom          - Atom editor
+  # :cursor        - Cursor editor
+  # :emacs         - Emacs editor
+  # :emacsclient   - Emacs client
+  # :idea          - IntelliJ IDEA
+  # :macvim        - MacVim
+  # :mvim          - MacVim (alternative)
+  # :nova          - Nova editor
+  # :rubymine      - RubyMine
+  # :sublime       - Sublime Text
+  # :subl          - Sublime Text (alternative)
+  # :st            - Sublime Text (alternative)
+  # :textmate      - TextMate
+  # :txmt          - TextMate (alternative)
+  # :tm            - TextMate (alternative)
+  # :vscode        - Visual Studio Code
+  # :code          - Visual Studio Code (alternative)
+  # :vscodium      - VSCodium
+  # :codium        - VSCodium (alternative)
+  # :windsurf      - Windsurf editor
+  # :zed           - Zed editor
+
+  # Examples:
+  # config.editor = :vscode     # For Visual Studio Code
+  # config.editor = :atom       # For Atom
+  # config.editor = :sublime    # For Sublime Text
+  # config.editor = :rubymine   # For RubyMine
+  # config.editor = :cursor     # For Cursor
+  # config.editor = :zed        # For Zed
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: editor_opener
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Kasyanchuk
@@ -75,12 +75,17 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/views/rescues/_source.html.erb
 - app/views/rescues/_trace.html.erb
 - app/views/rescues/layout.erb
 - lib/editor_opener.rb
+- lib/editor_opener/action_dispatch/exception_wrapper_overrides.rb
 - lib/editor_opener/action_dispatch/trace_to_file_extractor.rb
 - lib/editor_opener/railtie.rb
 - lib/editor_opener/version.rb
+- lib/generators/editor_opener/install_generator.rb
+- lib/generators/editor_opener/templates/README
+- lib/generators/editor_opener/templates/initializer.rb
 homepage: https://github.com/igorkasyanchuk/editor_opener
 licenses:
 - MIT