docwatch-bin 2.4.2 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 111689573811afcf77ecae63b7ff791cb13cd0a57a2396699028d5f00f477477
-  data.tar.gz: b1eb2983e15aed8b0020d6f15cc4319017ec66a1ee757329e771065069ad7fd6
+  metadata.gz: 3ddc0126c46e08dfd0af49f1028ee92a4bfef1b514d7a22f766d1fa7e03e7c60
+  data.tar.gz: 9fc3d2e2b6395170f909fef7feb6c18c7588d17a47f86b57d953810919855ec2
 SHA512:
-  metadata.gz: 60dca5f3e30f8c2e9becec5ebf69f85e8abf3214472cff1acf79f7be4c5ecd081b2354efc203e3c47d9e211d32ae65adfb811de947d75bdde4fca04cbb7b6086
-  data.tar.gz: 6c2ab9e155a31552041dc99fea3ae52d171427a6d8d5c701d523591e99518c8a01545aebda70de826a191303cafdb6a707848adda7cea853ae8f0ef9dfe22663
+  metadata.gz: 300eea8d4c9785b6f501b5f89cf1e0cde40a0a2e02da3f9b2634b779060f0b25d330e5c29975f48f303f090901451d9a76955a4c71e7978b0d8b89de89f7ef7c
+  data.tar.gz: 674e64b87624473666b6b900e473f2c0746f456dd5d3dc0e69e5e4346d9fa461f02580cccdc11e0b6d03184dc5fec1a4e661ad4306701e2f0a5a5f67192d70bb

data/bin/docwatch

@@ -7,6 +7,8 @@ Params = Struct.new(
     :version,
     :file_path,
     :default_styles,
+    :style,
+    :output,
     keyword_init: true,
 )
 
@@ -25,6 +27,8 @@ class Main
             version: @opts['--version'],
             file_path: @opts['<file-path>'],
             default_styles: @opts['--default-styles'],
+            style: @opts['--style'],
+            output: @opts['--output'],
         )
     end
 
@@ -41,7 +45,7 @@ class Main
         'http://localhost:%s' % port
     end
 
-    def port_valid
+    def port_valid?
         true
     end
 
@@ -67,11 +71,25 @@ class Main
     def run
         exit_version if params.version
         exit_invalid_file unless File.exist?(params.file_path)
-        exit_invalid_port unless port_valid
 
-        renderer = Renderer.by_filetype(params.file_path, params.default_styles)
+        config = Docwatch::Config.new
+
+        if params.style && config.styles_path(profile: params.style).nil?
+            puts('Unknown or missing style profile: %s'.red % params.style)
+            exit 4
+        end
+
+        renderer = Renderer.by_filetype(params.file_path, params.default_styles, config, params.style)
         exit_unknown_renderer if renderer.nil?
 
+        if params.output
+            File.write(params.output, renderer.to_html(static: true))
+            puts 'Wrote %s'.green % params.output
+            exit 0
+        end
+
+        exit_invalid_port unless port_valid?
+
         server = TCPServer.new(port)
         logger = Logger.new(params.verbose)
         watcher = Watcher.new(params.file_path)
@@ -110,8 +128,10 @@ usage = <<~EOF
         #{PROGRAM_NAME} --version
 
     Options:
+        -o, --output FILE       Render once to file and exit
         -p, --port VALUE        Listen port [default: 8888]
                                 Set to 'random' for a random port
+        -s, --style NAME        Use named style profile
         -d, --default-styles    Use default styling
         --verbose               Be verbose
         -v, --version           Show version

data/lib/docwatch/config.rb

@@ -0,0 +1,52 @@
+module Docwatch
+    class Config
+        def initialize
+            @config_dir = ENV.fetch('XDG_CONFIG_HOME', File.expand_path('~/.config'))
+            @dir = File.join(@config_dir, 'org.crdx', 'docwatch')
+            @data = load
+        end
+
+        def styles_path(profile: nil)
+            name = profile || @data&.dig('profile')
+
+            if name
+                profile_path(name)
+            else
+                legacy_path
+            end
+        end
+
+        def profiles
+            @data&.dig('profiles') || {}
+        end
+
+        private
+
+        def profile_path(name)
+            file = profiles[name]
+            return nil unless file
+
+            path = File.join(@dir, file)
+            path if File.exist?(path)
+        end
+
+        def legacy_path
+            path = File.join(@dir, 'styles.css')
+            return path if File.exist?(path)
+
+            # Old location: $XDG_CONFIG_HOME/docwatch/styles.css
+            old = File.join(@config_dir, 'docwatch', 'styles.css')
+            old if File.exist?(old)
+        end
+
+        def load
+            path = File.join(@dir, 'config.toml')
+            return nil unless File.exist?(path)
+
+            TomlRB.parse(File.read(path))
+        rescue TomlRB::ParseError => e
+            $stderr.puts('Warning: failed to parse %s: %s' % [path, e.message])
+            nil
+        end
+    end
+end

data/lib/docwatch/renderer/markdown.rb

@@ -13,12 +13,12 @@ module Docwatch
 
         def css
             return default_css if @default_styles
+            return default_css unless @config
 
-            config_dir = ENV.fetch('XDG_CONFIG_HOME', File.expand_path('~/.config'))
-            styles_path = File.join(config_dir, 'docwatch', 'styles.css')
+            path = @config.styles_path(profile: @style)
 
-            if File.exist?(styles_path)
-                File.read(styles_path)
+            if path
+                File.read(path)
             else
                 default_css
             end

data/lib/docwatch/renderer.rb

@@ -7,39 +7,33 @@ module Docwatch
             (@@extensions[sym] ||= []) << self
         end
 
-        def self.by_filetype(file_path, default_styles)
+        def self.by_filetype(file_path, default_styles, config = nil, style = nil)
             extname = File.extname(file_path)[1..]
             return if extname.length == 0
 
-            @@extensions[extname.to_sym].first.new(file_path, default_styles)
+            @@extensions[extname.to_sym].first.new(file_path, default_styles, config, style)
         end
 
-        def initialize(file_path, default_styles)
+        def initialize(file_path, default_styles, config = nil, style = nil)
             @file_path = file_path
             @default_styles = default_styles
+            @config = config
+            @style = style
         end
 
         def js
             File.read(Docwatch.root_dir + '/res/inject.js')
         end
 
-        def to_html
-            return <<~EOF
-                <!doctype html>
-                <html>
-                <head>
-                #{head}
-                </head>
-                <body>
-                #{body}
-                <script>
-                (function() {
-                #{js}
-                })()
-                </script>
-                </body>
-                </html>
-            EOF
+        def to_html(static: false)
+            parts = ['<!doctype html>', '<html>', '<head>', head, '</head>', '<body>', body]
+
+            if !static
+                parts << "<script>\n(function() {\n#{js}\n})()\n</script>"
+            end
+
+            parts.push('</body>', '</html>')
+            parts.join("\n")
         end
 
         protected

data/lib/docwatch/version.rb

@@ -1,3 +1,3 @@
 module Docwatch
-    VERSION = '2.4.2'
+    VERSION = '2.7.0'
 end

data/lib/docwatch.rb

@@ -1,10 +1,10 @@
-require 'require_all'
 require 'rouge'
 require 'rouge/plugins/redcarpet'
 require 'redcarpet'
 require 'colorize'
 require 'nokogiri'
 require 'docopt'
+require 'toml-rb'
 
 require 'ostruct'
 require 'socket'
@@ -18,4 +18,15 @@ module Docwatch
     end
 end
 
-require_rel 'docwatch'
+require_relative 'docwatch/config'
+require_relative 'docwatch/connection'
+require_relative 'docwatch/logger'
+require_relative 'docwatch/parser'
+require_relative 'docwatch/parser/frontmatter'
+require_relative 'docwatch/renderer'
+require_relative 'docwatch/renderer/html'
+require_relative 'docwatch/renderer/markdown'
+require_relative 'docwatch/session'
+require_relative 'docwatch/util/html'
+require_relative 'docwatch/version'
+require_relative 'docwatch/watcher'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: docwatch-bin
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.7.0
 platform: ruby
 authors:
 - crdx
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -81,33 +80,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.5'
 - !ruby/object:Gem::Dependency
-  name: require_all
+  name: rouge
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rouge
+  name: toml-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,8 +121,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description:
-email:
 executables:
 - docwatch
 extensions: []
@@ -131,6 +128,7 @@ extra_rdoc_files: []
 files:
 - bin/docwatch
 - lib/docwatch.rb
+- lib/docwatch/config.rb
 - lib/docwatch/connection.rb
 - lib/docwatch/logger.rb
 - lib/docwatch/parser.rb
@@ -149,7 +147,6 @@ licenses:
 - GPLv3
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.25
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Preview markdown documents in the browser with reload on change
 test_files: []