open_code-rails 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac340cbee917db96ba7cfa83c00849badd21dc922f38a199602a0423de957ac5
-  data.tar.gz: b493f03dd96915c4276929d5cc37c96a6e7bef8063e3ac3ead4b9caf35bfe33e
+  metadata.gz: 7c34fdda9d2a73c18e7835c3c8598cb7773f3678099c90094f2fe808df74345b
+  data.tar.gz: d5d17fa18ea9dc4623260e771335fa811a618127ff7fe05020b40793a31029c7
 SHA512:
-  metadata.gz: 6487b7e205aa51e52a4336faebeebfe5e8e6516afdcadc9e9800f02337cf10893b88b51adb51e7ce22394b1c5efae40008b9d133d4fdd839cd3884b4af721e88
-  data.tar.gz: 75e8833be7373d620486c53c1306a055a174cfffdf072f584b8dfbe86b3f8c291c5740643f722c76d40566eb0fdf5d961ebdcd1f71bddee5fc978a29f31cc6cd
+  metadata.gz: a11d06848544a5643b9f38e71ba47f8194d1a55d89c45a098635472753cba1e9ae9441711c42ebbfe70262cacb4af7e7585a23862ff7012d87384aad23ba6168
+  data.tar.gz: bb324baaf1676d73d5be77c6dc3e2c096d6c0c91a63da1189d84b2b67c92a4d8cb1b7a5ad4eeb8190defdf9e01e5e26c2917fec9cfa2c2f323ae54c062d1752b

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
 before_install: gem update --system
 jobs:
   include:

data/Gemfile.lock

@@ -1,104 +1,107 @@
 PATH
   remote: .
   specs:
-    open_code-rails (0.3.0)
+    open_code-rails (0.6.0)
       railties (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.2.1)
-      actionview (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
-      rack (~> 2.0)
+    actionpack (6.0.3.4)
+      actionview (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.2.1)
-      activesupport (= 5.2.2.1)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.3.4)
+      activesupport (= 6.0.3.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.2.1)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.3.4)
       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.5)
-    crass (1.0.4)
-    diff-lcs (1.3)
-    erubi (1.8.0)
-    i18n (1.6.0)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.9.0)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.2)
-    loofah (2.2.3)
+    loofah (2.7.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    method_source (0.9.2)
+    method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.1)
+    minitest (5.14.2)
+    nokogiri (1.10.10)
       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)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
       byebug (~> 11.0)
-      pry (~> 0.10)
-    psych (3.1.0)
-    rack (2.0.6)
+      pry (~> 0.13.0)
+    rack (2.2.3)
     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.1)
-      actionpack (= 5.2.2.1)
-      activesupport (= 5.2.2.1)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.4)
+      actionpack (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
+      thor (>= 0.20.3, < 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)
+    rake (13.0.1)
+    regexp_parser (1.8.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.65.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.93.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      psych (>= 3.1.0)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    thor (0.20.3)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    unicode-display_width (1.4.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -107,9 +110,9 @@ DEPENDENCIES
   bundler (>= 1.10)
   open_code-rails!
   pry-byebug
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README.md

@@ -12,6 +12,10 @@ Add links in exception page to open Application Trace file to line in VSCode. No
     ![to_line](screenshots/to_line.png)
 - Custom Settings and Full Trace
     ![config_full_trace](screenshots/config_full_trace.png)
+- Display URLs in console/log files
+    ![logger_url](screenshots/logger_url.png)
+- Per browser settings in localStorage
+    ![browser_settings](screenshots/browser_settings.png)
 
 ## Installation
 
@@ -70,6 +74,12 @@ You should put settings in `config/environments/development.rb` because this gem
     end
     ```
 
+4. `config.open_code.logger_url` - default: `false`
+
+    Display VSCode/VSCodium urls rather than relative filenames in Rails Logger. So you should see URLs in dev mode console and `development.log`.
+
+    > This option directly replaces the results of `::Rails.backtrace_cleaner.clean`.
+
 ### Advanced
 
 #### Environment Variables
@@ -96,6 +106,14 @@ Some flexibility is probably required for cooperation. Different people may have
 
         $ /usr/bin/env FORCE_OPEN_CODE_ROOT_DIR='/my/project/path' rails s
 
+4. `FORCE_OPEN_CODE_LOGGER_URL`
+
+    When is not blank, `config.open_code.logger_url` will be overridden.
+
+    Set to `false`, `off` or `disabled` to disable this functionality. Blank value will be ignored. All other values will enable this functionality.
+
+        $ /usr/bin/env FORCE_OPEN_CODE_LOGGER_URL=on rails s
+
 #### Browser
 
 This functionality requires [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
@@ -127,3 +145,5 @@ This functionality requires [localStorage](https://developer.mozilla.org/en-US/d
 - `_openCode.reset()`
 
     Reset all settings - back to default.
+
+> Changing this settings only applies to the current browser. It does not have any impacts to Rails app.

data/lib/open_code/rails/railtie.rb

@@ -5,6 +5,7 @@ module OpenCode
     class Railtie < ::Rails::Railtie
       config.open_code = ActiveSupport::OrderedOptions.new
       config.open_code.editor = 'vscode'
+      config.open_code.logger_url = false
 
       initializer "open_code.initialize" do
         abort('open_code-rails should not be used in production mode!') if ::Rails.env.production?
@@ -24,6 +25,30 @@ module OpenCode
         next unless Middleware.loadable?(cfg)
 
         app.middleware.insert_before(ActionDispatch::DebugExceptions, Middleware)
+
+        logger_url = ENV['FORCE_OPEN_CODE_LOGGER_URL']
+        logger_url = if logger_url.blank?
+          cfg.logger_url
+        else
+          !%w[OFF FALSE DISABLED].include?(logger_url.upcase)
+        end
+        next unless logger_url
+
+        scheme = cfg.editor
+        root_dir = cfg.root_dir
+
+        bc = ::Rails.backtrace_cleaner
+        bc.class_eval { alias_method :vcr_clean, :clean }
+        bc.define_singleton_method(:clean) do |*args|
+          vcr_clean(*args).map do |ln|
+            begin
+              next ln unless ln =~ %r(^\w+\/.+?:in)
+              " #{scheme}://file/#{root_dir}/#{ln.split(':in').join(' in')}"
+            rescue => _e
+              ln
+            end
+          end
+        end
       end
     end
   end

data/lib/open_code/rails/vcr.js

@@ -35,6 +35,19 @@
 
   var cssStyle = null;
 
+  function removeLoggerUri() {
+    var items = document.querySelectorAll('[id^="Application-Trace"] .trace-frames, [id^="Full-Trace"] .trace-frames');
+    var rootPath = defaults.rootDir + '/';
+    for (var i = 0; i < items.length; i += 1) {
+      var item = items[i];
+      var line = item.innerText;
+      if (line.indexOf(rootPath) < 0) continue;
+
+      var parts = line.split(rootPath);
+      item.innerText = parts[parts.length - 1];
+    }
+  }
+
   function generateLinks() {
     if (cssStyle == null) {
       cssStyle = document.querySelector('style#_open-code-rails_') || false;
@@ -50,11 +63,11 @@
       cssStyle.innerText = cssStyle.innerText + iconStyle;
     }
     var tmp = document.createElement('div');
-    var items = document.querySelectorAll('#Application-Trace .trace-frames');
+    var items = document.querySelectorAll('[id^="Application-Trace"] .trace-frames');
     var ph = current.placeHolder || '';
     for (var i = 0; i < items.length; i += 1) {
       var item = items[i];
-      var pathLine = item.innerText.split(':in')[0].split(':');
+      var pathLine = item.innerText.split(/:(\d+)/, 2);
       var h = JSON.stringify(buildLink(pathLine[0], pathLine[1]));
       var html = '<a href=' + h + ' class="open-code-rails-link">' + ph + '</a>';
 
@@ -68,7 +81,10 @@
     }
   }
 
-  setTimeout(generateLinks, 0);
+  setTimeout(function () {
+    removeLoggerUri();
+    generateLinks();
+  }, 0);
   if (!window.localStorage) return;
 
   var ROOT_KEY = '_dbg-open_code_';
@@ -123,6 +139,7 @@
         var val = current[key]
         r[key] = val == null ? defaults[key] : val;
       }
+      if (r.placeHolder) r.iconUrl = null;
       return r;
     },
     getValue: function (key) {

data/lib/open_code/rails/version.rb

@@ -1,5 +1,5 @@
 module OpenCode
   module Rails
-    VERSION = "0.3.0".freeze
+    VERSION = "0.6.0".freeze
   end
 end

data/open_code-rails.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency("railties", ">= 4.2")
 
   spec.add_development_dependency("bundler", ">= 1.10")
-  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("rake", "~> 13.0")
   spec.add_development_dependency("rspec", "~> 3.0")
   spec.add_development_dependency("pry-byebug")
   spec.add_development_dependency("rubocop")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_code-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - James Chen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2020-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Open file in editor in Rails exception pages