octodown 1.8.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f90a2ef4162d809a6a4b3b36317b68be7f5634c9
-  data.tar.gz: 3ec9707771065783b2ec7450d51b6cfc3cd4b61d
+  metadata.gz: 873f8e9bccb9cea287afa902146a4932ca71e83a
+  data.tar.gz: 5d88a4c9b7a26f981d10671a76a7a5bfc5271959
 SHA512:
-  metadata.gz: 55e9a5523ef91ce72831232c8ee4bd30a3e730bb05f62b490358acdfd3eea44fb3d32d06de1fe54d5d7c6c704816c82b9c2a1b2e9e56e74dba54114ba45a8471
-  data.tar.gz: d5fe2d2797b00fb9f33cf073aacf8eb55556a7ea22c7a2148a3c1d190ca6b373aeef819ef0310f583a1e22dd3fd847fa9407ac168e76628dc7bcfa88b9aed72c
+  metadata.gz: 358cc97c065769a35c69c608ab41268d7eb2d4fa23fd84b92702cd3f727e51a8e486249609bc7d6da1f1fb91bd59ff4c63ce4a00c7555269b19b3ebc914781ae
+  data.tar.gz: 720403b3d42ce1b2c1b83f908aebab01dca2e3d8a8c6783b165951a8acfd3495c8cf76823dfd1c55f2de5baa521b3136d85a27df7f2773ca41ac1854fd5f1520

data/bin/octodown

@@ -37,6 +37,11 @@ OptionParser.new do |opts|
     options[:logger].level = Logger::FATAL
   end
 
+  opts.on '--debug', 'Debug the gem' do
+    ENV['LISTEN_GEM_DEBUGGING'] = '2'
+    options[:logger].level = Logger::DEBUG
+  end
+
   opts.on '-r', '--raw', 'Print raw HTML to STDOUT' do
     options[:presenter] = :raw
   end
@@ -68,7 +73,6 @@ end.parse!
 
 require 'tty-prompt'
 
-STDOUT.sync = true
 TUI = TTY::Prompt.new(enable_color: true)
 
 options[:file] = if ARGF.file == STDIN && options[:stdin]

data/lib/octodown/renderer/server.rb

@@ -17,7 +17,6 @@ module Octodown
         @path = File.dirname(File.expand_path(file.path))
         @port = options[:port]
         @websockets = []
-        @already_opened = false
         @mutex = Mutex.new
       end
 
@@ -27,7 +26,6 @@ module Octodown
         Thread.new do
           Thread.abort_on_exception = true
           maybe_launch_browser
-          Thread.exit
         end
 
         boot_server
@@ -45,10 +43,11 @@ module Octodown
         sleep 2.5
 
         @mutex.synchronize do
-          if @already_opened == false
-            @already_opened = true
+          if @websockets.empty?
             logger.info 'Loading preview in a new browser tab'
             Launchy.open "http://localhost:#{port}"
+          else
+            logger.info 'Re-using existing browser tab'
           end
         end
       end
@@ -65,34 +64,25 @@ module Octodown
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       def render_ws(env)
         md = render_md(file)
 
         socket = ::Faye::WebSocket.new(env)
 
         socket.on(:open) do
-          @mutex.synchronize do
-            if @already_opened == false
-              logger.info 'Re-using octodown client from previous browser tab'
-            end
-
-            @already_opened = true
-          end
+          log_clients('Client joined')
 
           socket.send md
-          logger.debug "Clients: #{@websockets.size}"
         end
 
         socket.on(:close) do
           @websockets = @websockets.reject { |s| s == socket }
-          logger.debug "Clients: #{@websockets.size}"
+          log_clients('Client left')
         end
 
         @websockets << socket
         socket.rack_response
       end
-      # rubocop:enable Metrics/MethodLength
 
       def render_http(env)
         Rack::Response.new.tap do |res|
@@ -124,6 +114,10 @@ module Octodown
       def render_md(f)
         Renderer::GithubMarkdown.render f, options
       end
+
+      def log_clients(msg)
+        logger.debug "#{msg}. Number of websocket clients: #{@websockets.size}"
+      end
     end
   end # Support
 end # Octodown

data/lib/octodown/support/logger.rb

@@ -6,6 +6,7 @@ module Octodown
       FORMAT = "%-5s: %s\n".freeze
 
       def self.build(dev: STDOUT, level: ::Logger::INFO)
+        dev.sync = true
         logger = ::Logger.new(dev)
         logger.level = level
         logger.formatter = method(:formatter)

data/lib/octodown/support/services/riposter.rb

@@ -6,7 +6,8 @@ module Octodown
           require 'listen'
 
           path = File.dirname(File.expand_path(file.path))
-          regex = Regexp.new("^#{File.basename(file.path)}$")
+          escaped_path = Regexp.escape(file.path)
+          regex = Regexp.new("^#{escaped_path}$")
 
           @listener ||= Listen.to(path, only: regex) do |modified, added, _rm|
             listener_callback.call if modified.any? || added.any?

data/lib/octodown/template/octodown.html.erb

@@ -8,37 +8,6 @@
 
     <%= highlight_stylesheet %>
     <%= stylesheet %>
-
-    <script type='text/javascript'>
-      'use strict';
-
-      document.addEventListener("DOMContentLoaded", function() {
-        var ws = null;
-        var interval = 2500;
-
-        function start() {
-          ws = new WebSocket(<%= host %>);
-
-          ws.onmessage = function(event) {
-            var body =  document.querySelector('article.markdown-body');
-            if (body) body.innerHTML = event.data;
-          };
-
-          ws.onclose = function() {
-            check();
-          };
-        }
-
-        function check(){
-          if(ws.readyState == 3) start();
-        }
-
-        start();
-
-        setInterval(check, interval);
-      });
-    </script>
-
   </head>
 
   <body>
@@ -56,4 +25,21 @@
       </div>
     </div>
   </body>
+
+  <%# reconnecting-websocket.min.js %>
+
+  <script type='text/javascript'>
+    !function(a,b){"function"==typeof define&&define.amd?define([],b):"undefined"!=typeof module&&module.exports?module.exports=b():a.ReconnectingWebSocket=b()}(this,function(){function a(b,c,d){function l(a,b){var c=document.createEvent("CustomEvent");return c.initCustomEvent(a,!1,!1,b),c}var e={debug:!1,automaticOpen:!0,reconnectInterval:1e3,maxReconnectInterval:3e4,reconnectDecay:1.5,timeoutInterval:2e3};d||(d={});for(var f in e)this[f]="undefined"!=typeof d[f]?d[f]:e[f];this.url=b,this.reconnectAttempts=0,this.readyState=WebSocket.CONNECTING,this.protocol=null;var h,g=this,i=!1,j=!1,k=document.createElement("div");k.addEventListener("open",function(a){g.onopen(a)}),k.addEventListener("close",function(a){g.onclose(a)}),k.addEventListener("connecting",function(a){g.onconnecting(a)}),k.addEventListener("message",function(a){g.onmessage(a)}),k.addEventListener("error",function(a){g.onerror(a)}),this.addEventListener=k.addEventListener.bind(k),this.removeEventListener=k.removeEventListener.bind(k),this.dispatchEvent=k.dispatchEvent.bind(k),this.open=function(b){h=new WebSocket(g.url,c||[]),b||k.dispatchEvent(l("connecting")),(g.debug||a.debugAll)&&console.debug("ReconnectingWebSocket","attempt-connect",g.url);var d=h,e=setTimeout(function(){(g.debug||a.debugAll)&&console.debug("ReconnectingWebSocket","connection-timeout",g.url),j=!0,d.close(),j=!1},g.timeoutInterval);h.onopen=function(){clearTimeout(e),(g.debug||a.debugAll)&&console.debug("ReconnectingWebSocket","onopen",g.url),g.protocol=h.protocol,g.readyState=WebSocket.OPEN,g.reconnectAttempts=0;var d=l("open");d.isReconnect=b,b=!1,k.dispatchEvent(d)},h.onclose=function(c){if(clearTimeout(e),h=null,i)g.readyState=WebSocket.CLOSED,k.dispatchEvent(l("close"));else{g.readyState=WebSocket.CONNECTING;var d=l("connecting");d.code=c.code,d.reason=c.reason,d.wasClean=c.wasClean,k.dispatchEvent(d),b||j||((g.debug||a.debugAll)&&console.debug("ReconnectingWebSocket","onclose",g.url),k.dispatchEvent(l("close")));var e=g.reconnectInterval*Math.pow(g.reconnectDecay,g.reconnectAttempts);setTimeout(function(){g.reconnectAttempts++,g.open(!0)},e>g.maxReconnectInterval?g.maxReconnectInterval:e)}},h.onmessage=function(b){(g.debug||a.debugAll)&&console.debug("ReconnectingWebSocket","onmessage",g.url,b.data);var c=l("message");c.data=b.data,k.dispatchEvent(c)},h.onerror=function(b){(g.debug||a.debugAll)&&console.debug("ReconnectingWebSocket","onerror",g.url,b),k.dispatchEvent(l("error"))}},1==this.automaticOpen&&this.open(!1),this.send=function(b){if(h)return(g.debug||a.debugAll)&&console.debug("ReconnectingWebSocket","send",g.url,b),h.send(b);throw"INVALID_STATE_ERR : Pausing to reconnect websocket"},this.close=function(a,b){"undefined"==typeof a&&(a=1e3),i=!0,h&&h.close(a,b)},this.refresh=function(){h&&h.close()}}return a.prototype.onopen=function(){},a.prototype.onclose=function(){},a.prototype.onconnecting=function(){},a.prototype.onmessage=function(){},a.prototype.onerror=function(){},a.debugAll=!1,a.CONNECTING=WebSocket.CONNECTING,a.OPEN=WebSocket.OPEN,a.CLOSING=WebSocket.CLOSING,a.CLOSED=WebSocket.CLOSED,a});
+  </script>
+
+  <script type='text/javascript'>
+    'use strict';
+
+    var ws = new ReconnectingWebSocket(<%= host %>, [], { maxReconnectInterval: 1000 });
+
+    ws.onmessage = function(event) {
+      var body =  document.querySelector('article.markdown-body');
+      if (body) body.innerHTML = event.data;
+    };
+  </script>
 </html>

data/lib/octodown/version.rb

@@ -1,3 +1,3 @@
 module Octodown
-  VERSION = '1.8.0'.freeze
+  VERSION = '1.8.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octodown
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
 platform: ruby
 authors:
 - Ian Ker-Seymer