kdwatch 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a50fa7ebbda382c852684c4b440e2a75213450af0e02e68130d9fd8fccabb8
-  data.tar.gz: 366e1aef8fcc0144c8ccc6adc74ee5492fba1088febaeee9a47e699ce9f57496
+  metadata.gz: 2a061720f05736d7be0f68e3e18887c799f94bdc5d83be4ac0b0553f7f65b822
+  data.tar.gz: 66ba9346da80aa7a1587baa978163290c59f3f3f6255964fae1a2a89913c3047
 SHA512:
-  metadata.gz: 64ebdd540be0d137d8b436552044ec1b67f17ec7ad3eabfc9c64640fdfcc31249de52f4f9e62b1562031287908e232a815663a1d31b9be04ae80bc0d9578514a
-  data.tar.gz: 242b365d72a33ebc24f36b4743baf3af43a0018348d88dcdf1b9fbd95da72ff65c3ef670a822d7f3a34d55fd847ab574ca1f182cfc52157247482a604dbc04c5
+  metadata.gz: a42cd6df0ec3c6c8562ab41809d7676162d08dd1b34993f4e3aa8010d1edbe4930bb94507489176996f15c55b7e43d4b29642913a8305e157d009bf5dc0567cb
+  data.tar.gz: 50856210e599e8aa2e37af01da0e6173a349cd3d94858c3ff90f4b9b1ad5510a403fb11248f0f0fbe0f4a5c132a088c891a5412a5bdf0a90f6148a0490789302

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -14,8 +14,9 @@ $ 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: in a pinch, kdrfc will use the IETF
-  web service for xml2rfc processing (but that may be a bit slower).
+* 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).
 
@@ -29,7 +30,7 @@ $ gem install kdwatch
 $ kdwatch
 ```
 
-After about 10 seconds, a browser will open (or an error message will
+* After about 10 seconds, a browser will open (or an error message will
 pop up with the URL to use, which depends on the options given, but
 defaults to <http://127.0.0.1:7991/>).
 
@@ -43,20 +44,18 @@ potential error messages, e.g., if you break the markdown in some way.
 ### There can only be one (per host/port)
 
 There can only be one kdwatch active on each host and port.  You will
-need to specify a different port (or host!) to start more than one
-pkdwatch.
+need to specify a different port (or host!) to run more than one
+kdwatch at the same time.
 
-* `-o host` to select an address on the serving host (default: 127.0.0.1)
-* `-i` as a shortcut for `-o ::`
 * `-p port` to select a port number (default: 7991)
-* `-1` to `6` as a shortcut for `-p 7991` to `-p 7996` (must be last
+* `-1` to `6` as a shortcut for `-p 7991` (default) to `-p 7996` (must be last
   option because of an idiosyncrasy of the optionparser library)
 
 kdwatch has two flags to simplify handling servers that might be
 accumulating on one host/port:
 
 * `-e` to kill (SIGINT) any current holder of the port given and exit
-* `-r` to do this, and to start a new instance
+* `-r` to do this, and to start a new instance as well
 
 So the most likely use is going to be:
 
@@ -64,40 +63,57 @@ So the most likely use is going to be:
 kdwatch -r
 ```
 
-or, if your drafts are weirdly named or you need to select one out of
-many
+or maybe
 
 ```
-kdwatch -r weird-draft.md
+kdwatch -r2
 ```
 
-### This is a web server
-
-The fun thing with the `-i` option is that you can replace the local
-URL by filling in the hostname of the laptop and use the resulting URL
-on a different browser (e.g., `http://mylaptop.local:7991` on your iPad or
-another laptop), and save some screen real-estate on your laptop.
+for the second draft you are editing at the same time,
 
-kdwatch essentially is a web server and, unless used on 127.0.0.1 (or
-::1), is accessible to anyone who can access your laptop over IP.
+or, if your drafts are weirdly named or you need to select one out of
+many
 
-That may be a security problem -- do not specify non-local hosts
-unless you are not “on the Internet” (or trust the way I cobble
-together software).
-If you did, maybe `kdwatch -e` before going there!
+```
+kdwatch -r5 weird-draft.md
+```
 
-The web-server function may also be a feature -- it even can be used for joint viewing...
+(Glitches are to be expected if you *start* more than one server out of
+the same directory at the same instant; TODO; for now, wait 10 seconds
+before starting another from the same directory.)
 
 ### 7991, haven't I heard that number before?
 
 The default port number was chosen after [RFC 7991], the initial (no
 longer really authoritative) version of the v3 RFCXML specification,
-and the port shortcuts 1 to 6 point to further RFCs from this series.
+and the port shortcuts 1 to 6 point to this and further RFCs from this
+series.
 (7997 is a particularly lame RFC, so it cannot be chosen by a
 shortcut [actually: this port is already registered for something else].)
 
 [RFC 7991]: https://rfc-editor.org/rfc/rfc7991.html
 
+### kdwatch is a web server
+
+kdwatch essentially is a web server and can listen on any host
+interface you might have:
+
+* `-o host` to select an interface address on the serving host (default: 127.0.0.1)
+* `-i` as a shortcut for `-o :: ` (`i` stands for "on the Internet")
+
+Unless used on 127.0.0.1 (or ::1), kdwatch is accessible to anyone who
+can access your laptop over IP.  That may be a security problem -- do
+not specify a non-local interface unless you know you are not “on the
+Internet” (or trust the way I cobble together software).  If you are,
+maybe `kdwatch -e` before going there!
+
+The fun thing with the `-i` option is that you can replace the local
+URL by filling in the hostname of the laptop and use the resulting URL
+on a different browser (e.g., `http://mylaptop.local:7991` on your iPad or
+another laptop), and save some screen real-estate on your laptop.
+With a globally routable address, kdwatch even can be used for joint
+viewing in a team.
+
 ## Feedback, please
 
 This has only been tested on macOS and briefly on Linux.  No idea about WSL.

data/kdwatch.gemspec

@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rack-livereload", '~> 0.3'
   spec.add_dependency "guard", '~> 2.17'
   spec.add_dependency "sinatra", '~> 2.1'
-  spec.add_dependency "kramdown-rfc2629", '~> 1.4'
+  spec.add_dependency "kramdown-rfc2629", '~> 1.5'
   spec.add_dependency "net-http-persistent", '~> 4.0'
 end

data/lib/kdwatch-app.rb

@@ -9,6 +9,8 @@ require "rack-livereload"
 require "guard"
 require "sinatra"
 require "kramdown-rfc2629"
+ENV["KDRFC_PREPEND"] = "time"
+require "kramdown-rfc/kdrfc-processor"
 require "net/http/persistent"
 
 host = ENV["KDWATCH_HOST"]
@@ -21,13 +23,22 @@ dfn = File.join(File.dirname(sfn), "#{File.basename(sfn, ".*")}.html")
 
 puts dfn
 
+kdrfc = KramdownRFC::KDRFC.new
+kdrfc.options.v3 = true
+kdrfc.options.html = true
+
 get "/" do
   sfc = File.stat(sfn).ctime
   dfc = File.stat(dfn).ctime rescue Time.at(0)
   if sfc > dfc
     warn "Rebuilding..."
-    system("time kdrfc -3h --no-txt #{sfn}")
-    warn "...done"
+    begin
+      kdrfc.process sfn
+    rescue StandardError => e
+      warn e.to_s
+    else
+      warn "...done"
+    end
   end
   File.read(dfn)
 end

data/lib/kdwatch/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kdwatch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -157,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: 'kdwatch: open auto-reloaded HTML for kramdown-rfc in a browser.'