docwatch-bin 1.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e525886a59746464f8ba5986e89bdcb343acbd1a96378bb56521f8e20bcf0288
+  data.tar.gz: a6829868d17db749392a11db8418519298e80bbfa386add54e2258bf72e59079
+SHA512:
+  metadata.gz: e7e12d6b4188d3d29964d9c842bad38454c383aec54b2a55d38fe8ace8de68a21065abb7f1ade4cabe5ec88263d4790d1d3a8e63bccb40bd3bc4ee22f7095172
+  data.tar.gz: 270e381c2bbf7f2b28ecfbfccc407050a6aab5ed2c44342ba0f60a2c16d0227f00d33d8ba14be11e4820e27b60c085af83e039be2cd777fd7c54e9fb3bed641f

data/bin/docwatch

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+require_relative '../lib/docwatch'
+include Docwatch
+
+DOCS = <<~EOF
+    #{'Usage:'.bold}
+        #{File.basename($0)} [options] [<file-path>]
+
+    #{'Options:'.bold}
+        -p, --port=VALUE   Listen port [default: 8888]
+        -v, --verbose      Verbose
+        -h, --help         Help
+        -V, --version      Version
+
+    #{'Renderers:'.bold}
+        markdown (.md)
+        html     (.html)
+
+    If #{'--port'.bold} is #{'random'.bold} a random port will be chosen, otherwise
+    the specified one will be used. The default is 8888.
+
+    In #{'--verbose'.bold} mode, incoming HTTP requests and file change event
+    notifications will be printed to standard output.
+EOF
+
+class App
+    def initialize(opts)
+        @opts = opts
+    end
+
+    def self.run(opts)
+        new(opts).run
+    end
+
+    def params
+        @params ||= OpenStruct.new({
+            verbose: @opts['--verbose'],
+            version: @opts['--version'],
+            help: @opts['--help'],
+            file_path: @opts['<file-path>']
+        })
+    end
+
+    def port
+        @port ||= if @opts['--port'] == 'random'
+            # TODO: check if this port is in use
+            10000 + Random.random_number(50000)
+        else
+            @opts['--port']
+        end
+    end
+
+    def url
+        'http://localhost:%s' % port
+    end
+
+    def port_valid
+        true
+    end
+
+    def exit_usage
+        puts DOCS
+        exit 0
+    end
+
+    def exit_version
+        puts Docwatch::VERSION
+        exit 0
+    end
+
+    def exit_invalid_arguments
+        puts 'Invalid arguments'.red
+        exit 1
+    end
+
+    def exit_invalid_file
+        puts 'File does not exist: %s'.red % params.file_path
+        exit 2
+    end
+
+    def exit_unknown_renderer
+        puts 'No suitable renderer found for %s'.red % params.file_path
+        exit 3
+    end
+
+    def exit_invalid_port
+        puts 'Invalid port %s'.red % port
+    end
+
+    def run
+        exit_version if params.version
+        exit_usage if params.help
+        exit_invalid_arguments unless params.file_path
+        exit_invalid_file unless File.exist?(params.file_path)
+        exit_invalid_port unless port_valid
+
+        renderer = Renderer.by_filetype(params.file_path)
+        exit_unknown_renderer if renderer.nil?
+
+        server = TCPServer.new(port)
+        logger = Logger.new(params.verbose)
+        watcher = Watcher.new(params.file_path)
+
+        Thread.new do
+            while socket = server.accept
+                Thread.new do
+                    Connection.handle(
+                        renderer,
+                        watcher,
+                        logger,
+                        Session.new(socket, logger)
+                    )
+                end
+            end
+        end
+
+        puts ('Started server on %s, renderer %s' % [url, renderer.class]).yellow
+        puts 'Press enter to open page in the default handler (xdg-open)'.green
+
+        begin
+            while STDIN.gets
+                system('xdg-open %s' % url)
+            end
+        rescue Interrupt => e
+            puts
+            puts 'Bye'
+        end
+    end
+end
+
+begin
+    App.run(Docopt::docopt(DOCS, help: false))
+rescue Docopt::Exit => e
+    puts 'Invalid arguments.'.red
+    exit 1
+end

data/lib/docwatch/connection.rb

@@ -0,0 +1,24 @@
+module Docwatch
+    class Connection
+        def initialize(renderer, watcher, logger, session)
+            @renderer = renderer
+            @watcher = watcher
+            @logger = logger
+            @session = session
+        end
+
+        def self.handle(*opts)
+            new(*opts).handle
+        end
+
+        def handle
+            case @session.path
+                when '/'
+                    @session.respond_with_html @renderer.to_html
+                when '/wait'
+                    @watcher.wait
+                    @session.respond_with_text 'OK'
+            end
+        end
+    end
+end

data/lib/docwatch/logger.rb

@@ -0,0 +1,11 @@
+module Docwatch
+    class Logger
+        def initialize(verbose)
+            @verbose = verbose
+        end
+
+        def log(str)
+            puts str if @verbose
+        end
+    end
+end

data/lib/docwatch/renderer/html.rb

@@ -0,0 +1,17 @@
+module Docwatch
+    class HtmlRenderer < Renderer
+        extension :html
+
+        def doc
+            Nokogiri::HTML(contents)
+        end
+
+        def head
+            doc.at('head')&.inner_html
+        end
+
+        def body
+            doc.at('body')&.inner_html
+        end
+    end
+end

data/lib/docwatch/renderer/markdown.rb

@@ -0,0 +1,27 @@
+module Docwatch
+    class MarkdownRenderer < Renderer
+        extension :md
+
+        def head
+            return <<~EOF
+                <title>#{file_path} - docwatch</title>
+                <style>
+                body {
+                    font-family: Ubuntu;
+                    font-size: 15px;
+                }
+                </style>
+            EOF
+        end
+
+        def body
+            Redcarpet::Markdown.new(
+                Redcarpet::Render::HTML,
+                fenced_code_blocks: true,
+                autolink:  true,
+                tables:    true,
+                footnotes: true,
+            ).render(contents)
+        end
+    end
+end

data/lib/docwatch/renderer.rb

@@ -0,0 +1,53 @@
+module Docwatch
+    class Renderer
+        @@extensions = {}
+
+        # Set an extension (by symbol) as being supported by this class.
+        def self.extension(sym)
+            (@@extensions[sym] ||= []) << self
+        end
+
+        def self.by_filetype(file_path)
+            extname = File.extname(file_path)[1..]
+            return if extname.length == 0
+            @@extensions[extname.to_sym].first.new(file_path)
+        end
+
+        def initialize(file_path)
+            @file_path = file_path
+        end
+
+        def js
+            File.read(Docwatch.root + '/res/inject.js')
+        end
+
+        def to_html
+            return <<~EOF
+                <!doctype html>
+                <html>
+                <head>
+                #{head}
+                </head>
+                <body>
+                #{body}
+                <script>
+                (function() {
+                #{js}
+                })()
+                </script>
+                </body>
+                </html>
+            EOF
+        end
+
+        protected
+
+        def file_path
+            @file_path
+        end
+
+        def contents
+            File.read(@file_path)
+        end
+    end
+end

data/lib/docwatch/session.rb

@@ -0,0 +1,54 @@
+module Docwatch
+    class Session
+        def initialize(socket, logger)
+            @socket = socket
+            @logger = logger
+
+            logger.log first_request_line
+        end
+
+        def close
+            @socket.close
+        end
+
+        def path
+            first_request_line.split(' ')[1]
+        end
+
+        def respond_with_text(str)
+            respond_with(str, 'text/plain')
+        end
+
+        def respond_with_html(str)
+            respond_with(str, 'text/html')
+        end
+
+        def respond_with(str, content_type)
+            println 'HTTP/1.1 200'
+            println 'Content-Type: %s; charset=utf8' % content_type
+            # println 'Connection: close'
+            println
+            println str
+
+            close
+        end
+
+        private
+
+        def input_lines
+            @input_lines ||= @socket.recvmsg[0].lines rescue []
+        end
+
+        def first_request_line
+            input_lines.first.chomp
+        end
+
+        def print(msg)
+            @socket.print msg rescue nil
+        end
+
+        def println(msg = '')
+            print msg + "\r\n"
+        end
+    end
+end

data/lib/docwatch/version.rb

@@ -0,0 +1,3 @@
+module Docwatch
+    VERSION = "1.0.8"
+end

data/lib/docwatch/watcher.rb

@@ -0,0 +1,16 @@
+module Docwatch
+    class Watcher
+        def initialize(file_path)
+            @file_path = file_path
+        end
+
+        def mtime
+            File.mtime(@file_path)
+        end
+
+        def wait
+            now = mtime
+            sleep 0.2 while mtime <= now
+        end
+    end
+end

data/lib/docwatch.rb

@@ -0,0 +1,16 @@
+require 'require_all'
+require 'colorize'
+require 'docopt'
+require 'redcarpet'
+require 'nokogiri'
+
+require 'socket'
+require 'ostruct'
+
+require_rel 'docwatch'
+
+module Docwatch
+    def self.root
+        File.expand_path('../..', __FILE__)
+    end
+end

data/res/inject.js

@@ -0,0 +1,10 @@
+async function run() {
+    try {
+        await fetch('/wait')
+        document.location.reload()
+    } catch (e) {
+        setTimeout(run, 1000)
+    }
+}
+
+run()

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: docwatch-bin
+version: !ruby/object:Gem::Version
+  version: 1.0.8
+platform: ruby
+authors:
+- crdx
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+description: 
+email: 
+executables:
+- docwatch
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/docwatch
+- lib/docwatch.rb
+- lib/docwatch/connection.rb
+- lib/docwatch/logger.rb
+- lib/docwatch/renderer.rb
+- lib/docwatch/renderer/html.rb
+- lib/docwatch/renderer/markdown.rb
+- lib/docwatch/session.rb
+- lib/docwatch/version.rb
+- lib/docwatch/watcher.rb
+- res/inject.js
+homepage: https://github.com/crdx/docwatch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: preview markdown documents in the browser with reload on change
+test_files: []