open_code-rails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac340cbee917db96ba7cfa83c00849badd21dc922f38a199602a0423de957ac5
-  data.tar.gz: b493f03dd96915c4276929d5cc37c96a6e7bef8063e3ac3ead4b9caf35bfe33e
+  metadata.gz: 5cab12220ce096856bb5513b33ebc3a79945c240fedc8f4ed70e8dc48f296a14
+  data.tar.gz: 521be2a9f86a5205c3f06631928745dfa3f373d32e2e7429da76ef150b1a65f0
 SHA512:
-  metadata.gz: 6487b7e205aa51e52a4336faebeebfe5e8e6516afdcadc9e9800f02337cf10893b88b51adb51e7ce22394b1c5efae40008b9d133d4fdd839cd3884b4af721e88
-  data.tar.gz: 75e8833be7373d620486c53c1306a055a174cfffdf072f584b8dfbe86b3f8c291c5740643f722c76d40566eb0fdf5d961ebdcd1f71bddee5fc978a29f31cc6cd
+  metadata.gz: 7abbdd875653c94807aa09ddd6966583fce3a2889381985b93b542d054b791676afdee50c29675ba6285ba796df9c34c73ca1814ac17352ceb9cd3a77c2c8b68
+  data.tar.gz: e3281d678ab8b9880494a872753ffcfd32cb73faecd790eec24ddf5f65bb66713a1be5ce226fc2250d914a59587f871a461153db8e491f2ada24f6093abec248

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    open_code-rails (0.3.0)
+    open_code-rails (0.4.0)
       railties (>= 4.2)
 
 GEM

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_LOGGOR_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('#Application-Trace .trace-frames, #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;
@@ -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.4.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_code-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - James Chen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-19 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties