open_code-rails 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bd0991ca17a9e84ed33cd35e67a1075813a595e1b77a0b0b65a6ee030d76c84
-  data.tar.gz: 55d65a39e7721d8f1674c6378a004d65e9eb502e51e3298218ba94adf53c09c3
+  metadata.gz: ac340cbee917db96ba7cfa83c00849badd21dc922f38a199602a0423de957ac5
+  data.tar.gz: b493f03dd96915c4276929d5cc37c96a6e7bef8063e3ac3ead4b9caf35bfe33e
 SHA512:
-  metadata.gz: 266ca92d8f61df7b39cc9e9bc0277697b29eb27de4e36c30cfc8f3b67d5bed9453fec23bc89cced346cc4b72ca61ac22be25adb6f332237cffdf0fe79489dd33
-  data.tar.gz: 628b2b0c8a27d7d577e5ce8ab46c2c4ead4d990e3f1159fee2258be1123569cabb016048010322c4b8ab78499174a0fa80219eb57c6de48cdfdfb0a43c628b65
+  metadata.gz: 6487b7e205aa51e52a4336faebeebfe5e8e6516afdcadc9e9800f02337cf10893b88b51adb51e7ce22394b1c5efae40008b9d133d4fdd839cd3884b4af721e88
+  data.tar.gz: 75e8833be7373d620486c53c1306a055a174cfffdf072f584b8dfbe86b3f8c291c5740643f722c76d40566eb0fdf5d961ebdcd1f71bddee5fc978a29f31cc6cd

data/.travis.yml

@@ -6,7 +6,7 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
-before_install: gem install bundler -v '~> 1.17.3'
+before_install: gem update --system
 jobs:
   include:
     - stage: gem release

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    open_code-rails (0.2.3)
+    open_code-rails (0.3.0)
       railties (>= 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.2)
-      actionview (= 5.2.2)
-      activesupport (= 5.2.2)
+    actionpack (5.2.2.1)
+      actionview (= 5.2.2.1)
+      activesupport (= 5.2.2.1)
       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)
+    actionview (5.2.2.1)
+      activesupport (= 5.2.2.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.2)
+    activesupport (5.2.2.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -29,7 +29,7 @@ GEM
     builder (3.2.3)
     byebug (11.0.0)
     coderay (1.1.2)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     crass (1.0.4)
     diff-lcs (1.3)
     erubi (1.8.0)
@@ -63,9 +63,9 @@ GEM
       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)
+    railties (5.2.2.1)
+      actionpack (= 5.2.2.1)
+      activesupport (= 5.2.2.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)

data/README.md

@@ -70,7 +70,9 @@ You should put settings in `config/environments/development.rb` because this gem
     end
     ```
 
-### Advanced - via Environment Variables
+### Advanced
+
+#### Environment Variables
 
 Some flexibility is probably required for cooperation. Different people may have various preferences of IDE/editors, also the folder could be placed differently. So here you go.
 
@@ -93,3 +95,35 @@ Some flexibility is probably required for cooperation. Different people may have
     When is not blank, `config.open_code.root_dir` will be overridden.
 
         $ /usr/bin/env FORCE_OPEN_CODE_ROOT_DIR='/my/project/path' rails s
+
+#### Browser
+
+This functionality requires [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
+
+- `_openCode.settings()`
+
+    Should return keys below
+
+    - disabled
+    - iconUrl or placeHolder - you can only have one at the same time.
+    - rootDir
+    - scheme - same as `config.open_code.editor`
+    - linkBuilder - a function to build `href`. Default builder:
+
+        ```js
+        function (scheme, rootDir, path, line) {
+          return scheme + '://file/' + encodeURI(rootDir + '/' + path + ':' + line);
+        }
+        ```
+
+- `_openCode.getValue(key)`
+
+    Get individual value by given key.
+
+- `_openCode.setValue(key, value)`
+
+    Set individual value by given key.
+
+- `_openCode.reset()`
+
+    Reset all settings - back to default.

data/lib/open_code/rails/middleware.rb

@@ -1,4 +1,6 @@
 require 'active_support/all'
+require 'pathname'
+require 'json'
 
 module OpenCode
   module Rails
@@ -36,76 +38,38 @@ module OpenCode
         def loadable?(config)
           return false if %w[false off disabled].include?(config.editor)
 
-          css = generate_css(config.place_holder.blank?)
-          js = generate_js(config.editor, config.place_holder, config.root_dir)
-          self.html_code = "<style>#{css}</style><script>#{js}</script>"
+          dir = Pathname.new(__dir__)
+          css = dir.join('vcr.css').read
+          defaults = generate_defaults(dir, config.editor, config.place_holder, config.root_dir)
+          js = dir.join('vcr.js').read.sub('$$__DEFAULTS__$$', JSON.pretty_generate(defaults))
+          self.html_code = <<-HTML.strip_heredoc
+            <style id="_open-code-rails_">
+            #{css}
+            </style>
+            <script>
+            #{js}
+            </script>
+          HTML
           true
         end
 
         private
 
-        def generate_js(scheme, place_holder, root_dir)
-          <<-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 uri = [prefix, item.innerText.split(':in')[0]].join('/');
-                  var h = JSON.stringify(encodeURI(uri));
-                  var html = '<a href=' + h + ' class="open-code-rails-link">#{place_holder}</a>';
-
-                  var selFrameId = JSON.stringify(item.dataset.frameId);
-                  var links = document.querySelectorAll('[data-frame-id=' + selFrameId + ']');
-                  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
-        end
-
-        def generate_css(use_icon)
-          css = <<-CSS.strip_heredoc
-            .open-code-rails-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;
-            }
-            .open-code-rails-link:hover {
-              border-color: #C52E23;
-            }
-          CSS
-          return css unless use_icon
-
-          require 'pathname'
-          require 'base64'
-          icon = Base64.strict_encode64(Pathname.new(__dir__).join('vscode.svg').read)
+        def generate_defaults(dir, scheme, place_holder, root_dir)
+          icon_url = if place_holder.blank?
+            require 'base64'
+            "data:image/svg+xml;base64,#{Base64.strict_encode64(dir.join('vscode.svg').read)}"
+          else
+            false
+          end
 
-          css << <<-CSS.strip_heredoc
-            .open-code-rails-link {
-              padding: 3px;
-            }
-            .open-code-rails-link::after {
-              display: block;
-              content: '';
-              width: 12px;
-              height: 12px;
-              background-image: url('data:image/svg+xml;base64,#{icon}');
-            }
-          CSS
-          css
+          {
+            scheme: scheme,
+            rootDir: root_dir,
+            placeHolder: place_holder,
+            iconUrl: icon_url,
+            disabled: false,
+          }
         end
       end
     end

data/lib/open_code/rails/vcr.css

@@ -0,0 +1,15 @@
+.open-code-rails-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;
+}
+
+.open-code-rails-link:hover {
+  border-color: #C52E23;
+}

data/lib/open_code/rails/vcr.js

@@ -0,0 +1,162 @@
+(function () {
+  var CSS_ICON_POS = '/* _ICON_ */';
+  var defaults = $$__DEFAULTS__$$;
+
+  defaults.linkBuilder = function (scheme, rootDir, path, line) {
+    return scheme + '://file/' + encodeURI(rootDir + '/' + path + ':' + line);
+  };
+
+  var current = {
+    scheme: defaults.scheme,
+    rootDir: defaults.rootDir,
+    linkBuilder: defaults.linkBuilder,
+    placeHolder: defaults.placeHolder,
+    iconUrl: defaults.iconUrl,
+    disabled: false
+  };
+
+  function generateIconStyle() {
+    return current.placeHolder || !current.iconUrl ? null :
+      '.open-code-rails-link {' +
+      '  padding: 3px;' +
+      '}' +
+      '.open-code-rails-link::after {' +
+      '  display: block;' +
+      '  content: "";' +
+      '  width: 12px;' +
+      '  height: 12px;' +
+      '  background-image: url(' + JSON.stringify(current.iconUrl) + ');' +
+      '}';
+  }
+
+  function buildLink(path, line) {
+    return current.linkBuilder(current.scheme, current.rootDir, path, line);
+  }
+
+  var cssStyle = null;
+
+  function generateLinks() {
+    if (cssStyle == null) {
+      cssStyle = document.querySelector('style#_open-code-rails_') || false;
+      if (cssStyle) {
+        cssStyle.innerText = cssStyle.innerText + CSS_ICON_POS;
+      }
+    }
+
+    if (current.disabled) return;
+
+    var iconStyle = generateIconStyle();
+    if (iconStyle && cssStyle) {
+      cssStyle.innerText = cssStyle.innerText + iconStyle;
+    }
+    var tmp = document.createElement('div');
+    var items = document.querySelectorAll('#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 h = JSON.stringify(buildLink(pathLine[0], pathLine[1]));
+      var html = '<a href=' + h + ' class="open-code-rails-link">' + ph + '</a>';
+
+      var selFrameId = JSON.stringify(item.dataset.frameId);
+      var links = document.querySelectorAll('[data-frame-id=' + selFrameId + ']');
+      for (var j = 0; j < links.length; j += 1) {
+        var link = links[j];
+        tmp.innerHTML = html;
+        link.parentElement.insertBefore(tmp.firstChild, link.nextSibling);
+      }
+    }
+  }
+
+  setTimeout(generateLinks, 0);
+  if (!window.localStorage) return;
+
+  var ROOT_KEY = '_dbg-open_code_';
+  function loadLocalSettings() {
+    try {
+      var settings = JSON.parse(localStorage.getItem(ROOT_KEY) || '{}') || {};
+      var linkBuilder = settings.linkBuilder;
+      delete settings.linkBuilder;
+      for (var key in defaults) {
+        current[key] = settings[key];
+      }
+      try {
+        current.linkBuilder = linkBuilder && eval(linkBuilder);
+      } catch (_e) {
+        current.linkBuilder = null;
+      }
+    } catch (_e) {}
+
+    for (var key in defaults) {
+      if (current[key] != null) continue;
+      current[key] = defaults[key];
+    }
+  }
+
+  loadLocalSettings();
+
+  function regenerate() {
+    var links = document.querySelectorAll('.open-code-rails-link');
+    for (var j = 0; j < links.length; j += 1) {
+      var link = links[j];
+      link.parentElement.removeChild(link);
+    }
+
+    if (cssStyle) {
+      var css = cssStyle.innerText;
+      var pos = css.indexOf(CSS_ICON_POS);
+      cssStyle.innerText = css.slice(0, pos) + CSS_ICON_POS;
+    }
+
+    loadLocalSettings();
+    generateLinks();
+  }
+
+  function check(key) {
+    if (typeof defaults[key] == 'undefined') throw Error('Unsupported key: ' + key);
+  }
+
+  var ocr = {
+    settings: function () {
+      var r = {};
+      for (var key in defaults) {
+        var val = current[key]
+        r[key] = val == null ? defaults[key] : val;
+      }
+      return r;
+    },
+    getValue: function (key) {
+      check(key);
+      return (ocr.settings() || {})[key];
+    },
+    setValue: function(key, value) {
+      check(key);
+      var settings = ocr.settings();
+      var oldVal = key == 'linkBuilder' ? settings[key].toString() : settings[key];
+      var val = key == 'linkBuilder' && typeof value == 'function' ? value.toString() : value;
+      if (oldVal == val) return;
+
+      settings[key] = val;
+      if (key == 'placeHolder' && value || key == 'iconUrl' && !value) {
+        settings.iconUrl = null;
+      } else if (key == 'iconUrl' && value || key == 'placeHolder' && !value) {
+        settings.placeHolder = null;
+      }
+
+      var json = {};
+      for (var k in settings) {
+        var v = settings[k];
+        if (v == null || '' + v == '' + defaults[k]) continue;
+        json[k] = v;
+      }
+      localStorage.setItem(ROOT_KEY, JSON.stringify(json));
+      regenerate();
+      return settings[key];
+    },
+    reset() {
+      localStorage.removeItem(ROOT_KEY);
+      regenerate();
+    }
+  };
+  window._openCode = ocr;
+})();

data/lib/open_code/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: open_code-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - James Chen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-10 00:00:00.000000000 Z
+date: 2019-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -113,6 +113,8 @@ files:
 - lib/open_code/rails.rb
 - lib/open_code/rails/middleware.rb
 - lib/open_code/rails/railtie.rb
+- lib/open_code/rails/vcr.css
+- lib/open_code/rails/vcr.js
 - lib/open_code/rails/version.rb
 - lib/open_code/rails/vscode.svg
 - open_code-rails.gemspec