open_code-rails 0.1.0

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in open_code-rails.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    open_code-rails (0.1.0)
+      railties (>= 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.2)
+      actionview (= 5.2.2)
+      activesupport (= 5.2.2)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    builder (3.2.3)
+    byebug (11.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.14.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.2)
+      actionpack (= 5.2.2)
+      activesupport (= 5.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.58.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.10.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  open_code-rails!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 James
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# OpenCode::Rails
+
+Add links in exception page to open Application Trace file to line in VSCode. Now only support [VSCode](https://code.visualstudio.com/) or [VSCodium](https://github.com/VSCodium/vscodium).
+
+- Show VSCode icons
+    ![icons](screenshots/icons.png)
+- Click to open vscode/vscodium
+    ![open](screenshots/open.png)
+- Open file to line
+    ![to_line](screenshots/to_line.png)
+- Custom Settings and Full Trace
+    ![config_full_trace](screenshots/config_full_trace.png)
+
+## Installation
+
+Add following to your Rails `Gemfile`:
+
+```ruby
+group :development do
+  gem 'open_code-rails'
+end
+```
+
+## How it works
+
+VSCode supports [Opening VS Code with URLs](https://code.visualstudio.com/docs/editor/command-line#_opening-vs-code-with-urls).
+
+This gem simply inject some CSS and JS to HTML response while status is 500. Your browser will parse DOM and generate new links.
+
+## Configuration
+
+You should put settings in `config/environments/development.rb` because this gem should only work in dev server. It will prevent production server starting up.
+
+1. `config.open_code.editor` - default: `'vscode'`
+
+    Currently only support `'vscode'` and `'vscodium'`. It will be used to link's scheme part, like `vscode://` or `vscodium://`. You can set it any string but probably won't work, unless your editor supports `<scheme>://file/<absolute file path>`.
+
+    ```ruby
+    # config/environments/development.rb
+    Rails.application.configure do
+      config.open_code.editor = 'vscodium'
+    end
+    ```
+
+2. `config.open_code.place_holder` - default: `''` (blank)
+
+    Leave it blank will display links as VSCode icon. If you set it to a string, it will display text rather than icon. In case your browser does not support SVG Data URI in CSS, or you don't like the icon.
+
+    ```ruby
+    # config/environments/development.rb
+    Rails.application.configure do
+      config.open_code.place_holder = 'Open in VSCodium'
+    end
+    ```
+
+3. `config.open_code.root_dir` - default: `::Rails.root`
+
+    The absolute path of your Rails project folder. Sometimes you may run dev server remotely, so you need to set it to your local path.
+
+    ```ruby
+    # config/environments/development.rb
+    Rails.application.configure do
+      config.open_code.editor = '/Users/MyName/projects'
+    end
+    ```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task(default: :spec)

data/lib/open_code/rails.rb

@@ -0,0 +1,7 @@
+require "open_code/rails/version"
+require "open_code/rails/railtie"
+
+module OpenCode
+  module Rails
+  end
+end

data/lib/open_code/rails/const_assets.rb

@@ -0,0 +1,26 @@
+module OpenCode
+  module Rails
+    module ConstAssets
+      ICONS = {
+        vscode: <<-XML.strip_heredoc,
+          <?xml version="1.0" encoding="UTF-8" standalone="no"?>
+          <svg xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:cc="http://creativecommons.org/ns#" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:svg="http://www.w3.org/2000/svg" xmlns="http://www.w3.org/2000/svg" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" viewBox="0 0 261 260" fill-rule="evenodd" clip-rule="evenodd" stroke-linejoin="round" stroke-miterlimit="1.414" version="1.1" id="svg4" sodipodi:docname="vscode.svg" inkscape:version="0.92.2 (unknown)">
+            <metadata id="metadata10">
+              <rdf:RDF>
+                <cc:Work rdf:about="">
+                  <dc:format>image/svg+xml</dc:format>
+                  <dc:type rdf:resource="http://purl.org/dc/dcmitype/StillImage"/>
+                  <dc:title/>
+                </cc:Work>
+              </rdf:RDF>
+            </metadata>
+            <defs id="defs8"/>
+            <sodipodi:namedview pagecolor="#ffffff" bordercolor="#666666" borderopacity="1" objecttolerance="10" gridtolerance="10" guidetolerance="10" inkscape:pageopacity="0" inkscape:pageshadow="2" inkscape:window-width="1360" inkscape:window-height="722" id="namedview6" showgrid="false" inkscape:zoom="0.64183539" inkscape:cx="112.48701" inkscape:cy="128.72041" inkscape:window-x="0" inkscape:window-y="24" inkscape:window-maximized="1" inkscape:current-layer="svg4"/>
+            <path d="M 195.47461 -0.005859375 L 195.47461 223.29688 L 0.49609375 194.33789 L 195.47461 259.99219 L 260.47461 232.95312 L 260.47461 31.064453 L 260.49609 31.054688 L 260.47461 31.011719 L 260.47461 27.035156 L 195.47461 -0.005859375 z " id="path951" style="fill:#C52E23;fill-opacity:1"/>
+            <path d="M 127.24219 38.037109 L 67.521484 97.070312 L 31.566406 69.992188 L 16.748047 74.941406 L 53.328125 111.10156 L 16.748047 147.25977 L 31.566406 152.21094 L 67.521484 125.13086 L 67.523438 125.13086 L 127.24023 184.16016 L 163.00781 168.96289 L 163.00781 53.234375 L 127.24219 38.037109 z M 127.24023 80.158203 L 127.24023 142.03711 L 86.154297 111.09766 L 127.24023 80.158203 z " id="path887" style="fill:#C52E23;fill-opacity:1"/>
+          </svg>
+        XML
+      }
+    end
+  end
+end

data/lib/open_code/rails/middleware.rb

@@ -0,0 +1,64 @@
+require 'base64'
+
+module OpenCode
+  module Rails
+    class Middleware
+      cattr_accessor :css
+      cattr_accessor :place_holder
+      cattr_accessor :root_dir
+      cattr_accessor :scheme
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        res = nil
+        begin
+          res = @app.call(env)
+          status, headers, body = res
+          return res unless status == 500 && headers['Content-Type'].to_s.include?('html')
+
+          script = <<-JS.strip_heredoc
+            (function () {
+              setTimeout(function () {
+                var prefix = '#{scheme}://file/#{root_dir}';
+                var tmp = document.createElement('div');
+                var items = document.querySelectorAll('#Application-Trace .trace-frames');
+                for (var i = 0; i < items.length; i += 1) {
+                  var item = items[i];
+                  var frameId = item.dataset.frameId;
+                  var uri = encodeURI([prefix, item.innerText.split(':in')[0]].join('/'));
+                  var html = '<a href="' + uri + '" class="-gem-open-me-link">#{place_holder}</a>';
+
+                  var links = document.querySelectorAll('[data-frame-id=' + JSON.stringify(frameId) + ']');
+                  for (var j = 0; j < links.length; j += 1) {
+                    var link = links[j];
+                    tmp.innerHTML = html;
+                    link.parentElement.insertBefore(tmp.firstChild, link.nextSibling);
+                  }
+                }
+              }, 0);
+            })();
+          JS
+
+          html = ''
+          body.each { |part| html << part }
+          html.sub!('</body>', "<style>#{css}</style><script>#{script}</script></body>")
+          body = html.encode('utf-8')
+          headers['Content-Length'] = body.size
+          [status, headers, [body]]
+        rescue => e
+          ::Rails.logger.error do
+            <<-LOG.strip_heredoc
+              [OpenCode::Rails::Middleware] #{e.class}: #{e}
+                Sorry still something went wrong
+                from #{e.backtrace.join("\n  ")}
+            LOG
+          end
+          res
+        end
+      end
+    end
+  end
+end

data/lib/open_code/rails/railtie.rb

@@ -0,0 +1,61 @@
+require "rails/railtie"
+
+module OpenCode
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.open_code = ActiveSupport::OrderedOptions.new
+      config.open_code.editor = 'vscode'
+
+      initializer "open_code.initialize" do
+        abort('open_code-rails should not be used in production mode!') if ::Rails.env.production?
+      end
+
+      initializer "open_code.insert_middleware" do |app|
+        next if ::Rails.env.production? || !defined?(::Rails::Server)
+
+        require 'open_code/rails/const_assets'
+        require 'open_code/rails/middleware'
+
+        css = <<-CSS.strip_heredoc
+          .-gem-open-me-link {
+            box-sizing: border-box;
+            display: inline-block;
+            margin-left: 8px;
+            padding: 1px 6px;
+            vertical-align: middle;
+            border: 1px solid #FFCCCB;
+            color: #C52E23;
+            border-radius: 4px;
+            text-decoration: none;
+          }
+          .-gem-open-me-link:hover {
+            border-color: #C52E23;
+          }
+        CSS
+
+        cfg = config.open_code
+        if cfg.place_holder.blank?
+          b64 = Base64.strict_encode64(ConstAssets::ICONS[:vscode])
+          css << <<-CSS.strip_heredoc
+            .-gem-open-me-link {
+              padding: 3px;
+            }
+            .-gem-open-me-link::after {
+              display: block;
+              content: '';
+              width: 12px;
+              height: 12px;
+              background-image: url('data:image/svg+xml;base64,#{b64}');
+            }
+          CSS
+        end
+
+        Middleware.css = css.freeze
+        Middleware.place_holder = cfg.place_holder
+        Middleware.root_dir = (cfg.root_dir.presence || ::Rails.root).to_s.tr('\\', '/').chomp('/')
+        Middleware.scheme = cfg.editor.presence || 'vscode'
+        app.middleware.insert_before(ActionDispatch::DebugExceptions, Middleware)
+      end
+    end
+  end
+end

data/lib/open_code/rails/version.rb

@@ -0,0 +1,5 @@
+module OpenCode
+  module Rails
+    VERSION = "0.1.0".freeze
+  end
+end

data/open_code-rails.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "open_code/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_code-rails"
+  spec.version       = OpenCode::Rails::VERSION
+  spec.authors       = ["James Chen"]
+  spec.email         = ["egustc@gmail.com"]
+
+  spec.summary       = 'Open file in editor in Rails exception pages'
+  spec.description   = 'Add an link beside files on exception'
+  spec.homepage      = "https://github.com/eGust/open_code-rails"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    %x(git ls-files -z).split("\x0").reject { |f| f.match(%r{^(test|spec|features|screenshots)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.required_ruby_version = ">= 2.2"
+  spec.add_dependency("railties", ">= 4.2")
+
+  spec.add_development_dependency("bundler", ">= 1.10")
+  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_development_dependency("pry-byebug")
+  spec.add_development_dependency("rubocop")
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: open_code-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add an link beside files on exception
+email:
+- egustc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".shopify-rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/open_code/rails.rb
+- lib/open_code/rails/const_assets.rb
+- lib/open_code/rails/middleware.rb
+- lib/open_code/rails/railtie.rb
+- lib/open_code/rails/version.rb
+- open_code-rails.gemspec
+homepage: https://github.com/eGust/open_code-rails
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Open file in editor in Rails exception pages
+test_files: []