kdwatch 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a061720f05736d7be0f68e3e18887c799f94bdc5d83be4ac0b0553f7f65b822
-  data.tar.gz: 66ba9346da80aa7a1587baa978163290c59f3f3f6255964fae1a2a89913c3047
+  metadata.gz: 2e2ba541b81a0758e14930c2daeeb13f8795ef86f13db41d2099ba2c863ae6a8
+  data.tar.gz: 225edec007a3005fb9e401888073d3e74fd6d92db622560685d812d0a37527ea
 SHA512:
-  metadata.gz: a42cd6df0ec3c6c8562ab41809d7676162d08dd1b34993f4e3aa8010d1edbe4930bb94507489176996f15c55b7e43d4b29642913a8305e157d009bf5dc0567cb
-  data.tar.gz: 50856210e599e8aa2e37af01da0e6173a349cd3d94858c3ff90f4b9b1ad5510a403fb11248f0f0fbe0f4a5c132a088c891a5412a5bdf0a90f6148a0490789302
+  metadata.gz: 7f61fd99900cb3e4b1951863424816438e7e426b84c3cc0e4854f4a64954f26e2ec56f13b08394d4c086fe2d9b919cd4fa66ed4486ef10daebace7d30767c0b1
+  data.tar.gz: 4c0853a737166b50b728d6ecbd29845c908fa5e1fcc4b07ea88bbd762c3b6f71b281a7429acbc07f452e3a1a6e9e18f29d7198b97e6d96edef98bbdaef8aa6ad

data/README.md

@@ -1,6 +1,6 @@
 # Kdwatch
 
-Autoreloading display of [kramdown-rfc][] document in browser
+Auto-formatting, auto-reloading display of formatted [kramdown-rfc][] document in browser
 
 [kramdown-rfc]: http://rfc.space
 
@@ -14,11 +14,11 @@ $ gem install kdwatch
 
 * For some reason, the initial `gem install` takes a couple of minutes,
   during the first few of which it may seem nothing happens.
-* If the above `pip3` doesn't work, no problem: in a pinch, kdrfc will
-  use the IETF web service for xml2rfc processing (but that may be a
-  bit slower).
-* Depending on system configuration, add `sudo` (but don't if it isn't
-  actually needed).
+* If the above `pip3` (or `pip`) doesn't work, no problem: in a pinch,
+  kdrfc will use the IETF web service for xml2rfc processing (but that
+  may be a bit slower).
+* Depending on system configuration, add `sudo` on the pip/gem
+  commands (but don't if it isn't actually needed).
 
 ## Usage
 
@@ -34,12 +34,16 @@ $ kdwatch
 pop up with the URL to use, which depends on the options given, but
 defaults to <http://127.0.0.1:7991/>).
 
-Now, whenever you do an editor save of the markdown file, after a
-couple of seconds (1.6 s for my Intel Mac, 0.8 s for my M1 Mac) you
-see an updated HTML in the browser.
+Now, whenever you do an editor save of the kramdown-rfc markdown file,
+kdwatch auto-formats and, after a couple of seconds(*), you see an
+updated HTML in the browser without pressing buttons or switching windows.
 
 You will need to keep the `kdwatch` terminal/screen open to see
 potential error messages, e.g., if you break the markdown in some way.
+(The author uses an Emacs "Async Shell Command" buffer for that.)
+
+(*) The latency depends on your computer and a bit on the size of the
+    file, say, around 1.6 s for my Intel Mac, 0.8 s for my M1 Mac.
 
 ### There can only be one (per host/port)
 

data/bin/kdwatch

@@ -6,11 +6,24 @@ ENV["KRAMDOWN_PERSISTENT"]="yes"
 
 require 'optparse'
 require 'ostruct'
+require 'socket'
 
 require_relative "../lib/kdwatch/version"
 
 KDWATCH_PORT = 7991             # currently unregistered...
 
+def socket_is_free(host, port, uri)
+  begin
+    TCPSocket.new(host, port, connect_timeout: 1)
+  rescue Errno::ECONNREFUSED => e
+    return true
+  rescue => e
+    warn "*** #{uri} -- #{e.inspect}"
+    return nil                  # break, but don't use
+  end
+  return false
+end
+
 options = OpenStruct.new
 
 op = OptionParser.new do |opts|
@@ -30,7 +43,7 @@ BANNER
   opts.on("-r", "--[no-]replace", "Replace existing server")
   opts.on("-oNAME", "--host=NAME", String, "Server host (127.0.0.1)")
   opts.on("-i", "--internet", 'Abbr. "on the Internet" (host = "::")')
-  opts.on("-pNUM", "--port=NUM", Integer, "Port number (#{KDWATCH_PORT})")
+  opts.on("-pNUM", "--port=NUM", Integer, "Port number (#{KDWATCH_PORT}...)")
   opts.on("-[1-6]", "--[1-6]", Integer, "Abbr. port number (#{KDWATCH_PORT/10}x), must be last")
 end
 begin
@@ -52,7 +65,26 @@ if short_port = options[""]
   warn "** overriding port #{options.port} with #{port}" if options.port
   options.port = port
 else
-  options.port ||= KDWATCH_PORT
+  unless options.port
+    port = KDWATCH_PORT
+    host = options.host
+    host = "[#{host}]" if host =~ /:/
+    uri = nil
+    found = false
+    100.times do
+      uri = "http://#{host}:#{port}"
+      # warn "Trying URI #{uri}"
+      found = socket_is_free(options.host, port, uri)
+      break unless found == false
+      port += 1
+    end
+    unless found
+      warn "*** Cannot find port number available to serve from!"
+      exit 1
+    end
+    warn "*** Using URI: #{uri}"
+    options.port = port
+  end
 end
 
 # p options

data/lib/kdwatch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kdwatch
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/kdwatch-app.rb

@@ -9,7 +9,7 @@ require "rack-livereload"
 require "guard"
 require "sinatra"
 require "kramdown-rfc2629"
-ENV["KDRFC_PREPEND"] = "time"
+ENV["KDRFC_PREPEND"] = "time" if system("time", "true", err: "/dev/null")
 require "kramdown-rfc/kdrfc-processor"
 require "net/http/persistent"
 
@@ -40,7 +40,18 @@ get "/" do
       warn "...done"
     end
   end
-  File.read(dfn)
+  dfc = File.stat(dfn).ctime rescue Time.at(0)
+  ret = File.read(dfn)
+  if sfc > dfc # somehow the above went wrong
+    ret.gsub!(<<CSS, <<RED)
+/* general and mobile first */
+html {
+CSS
+/* general and mobile first */
+html { border: 5px solid red;
+RED
+  end
+  ret
 end
 
 get "/metadata.min.js" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kdwatch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-10 00:00:00.000000000 Z
+date: 2022-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: 'kdwatch: open auto-reloaded HTML for kramdown-rfc in a browser.'