coradoc-html 1.1.13 → 1.1.15

data/lib/coradoc/html/drop/list_block_drop.rb

@@ -5,11 +5,7 @@ module Coradoc
     module Drop
       class ListBlockDrop < Base
         def html_tag
-          case @model.marker_type
-          when 'ordered' then 'ol'
-          when 'definition' then 'dl'
-          else 'ul'
-          end
+          TagMapping.tag_for(@model.marker_type)
         end
 
         def items

data/lib/coradoc/html/drop/table_cell_drop.rb

@@ -9,7 +9,7 @@ module Coradoc
         end
 
         def html_tag
-          header? ? 'th' : 'td'
+          TagMapping.tag_for(header? ? :table_header : :table_cell)
         end
 
         def colspan

data/lib/coradoc/html/drop.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Drop namespace — manages Liquid drop layer for template rendering.
+#
+# Loading order matters: Base must load before DropFactory, and all
+# concrete drops must load after DropFactory (they self-register).
+# Each drop calls DropFactory.register at load time.
+module Coradoc
+  module Html
+    module Drop
+    end
+  end
+end
+
+# Base must load first (DropFactory depends on it)
+require 'coradoc/html/drop/base'
+# DropFactory loads next
+require 'coradoc/html/drop/drop_factory'

data/lib/coradoc/html/input/converters/audio.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'media_base'
-
 module Coradoc
   module Input
     module Html

data/lib/coradoc/html/input/converters/sub.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'positional_formatting'
-
 module Coradoc
   module Input
     module Html

data/lib/coradoc/html/input/converters/sup.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'positional_formatting'
-
 module Coradoc
   module Input
     module Html

data/lib/coradoc/html/input/converters/video.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'media_base'
-
 module Coradoc
   module Input
     module Html

data/lib/coradoc/html/input/converters.rb

@@ -4,43 +4,51 @@ module Coradoc
   module Input
     module Html
       module Converters
-        # Autoload converter classes - they will register themselves when first accessed
-        autoload :Base, 'coradoc/html/input/converters/base'
-        autoload :Markup, 'coradoc/html/input/converters/markup'
-        autoload :A, 'coradoc/html/input/converters/a'
-        autoload :Aside, 'coradoc/html/input/converters/aside'
-        autoload :Audio, 'coradoc/html/input/converters/audio'
-        autoload :Blockquote, 'coradoc/html/input/converters/blockquote'
-        autoload :Br, 'coradoc/html/input/converters/br'
-        autoload :Bypass, 'coradoc/html/input/converters/bypass'
-        autoload :Code, 'coradoc/html/input/converters/code'
-        autoload :Div, 'coradoc/html/input/converters/div'
-        autoload :Dl, 'coradoc/html/input/converters/dl'
-        autoload :Skip, 'coradoc/html/input/converters/drop'
-        autoload :Em, 'coradoc/html/input/converters/em'
-        autoload :Figure, 'coradoc/html/input/converters/figure'
-        autoload :H, 'coradoc/html/input/converters/h'
-        autoload :Head, 'coradoc/html/input/converters/head'
-        autoload :Hr, 'coradoc/html/input/converters/hr'
-        autoload :Img, 'coradoc/html/input/converters/img'
-        autoload :Li, 'coradoc/html/input/converters/li'
-        autoload :Mark, 'coradoc/html/input/converters/mark'
-        autoload :Math, 'coradoc/html/input/converters/math'
-        autoload :MediaBase, 'coradoc/html/input/converters/media_base'
-        autoload :Ol, 'coradoc/html/input/converters/ol'
-        autoload :P, 'coradoc/html/input/converters/p'
-        autoload :PassThrough, 'coradoc/html/input/converters/pass_through'
-        autoload :PositionalFormatting, 'coradoc/html/input/converters/positional_formatting'
-        autoload :Pre, 'coradoc/html/input/converters/pre'
-        autoload :Q, 'coradoc/html/input/converters/q'
-        autoload :Strong, 'coradoc/html/input/converters/strong'
-        autoload :Sup, 'coradoc/html/input/converters/sup'
-        autoload :Sub, 'coradoc/html/input/converters/sub'
-        autoload :Table, 'coradoc/html/input/converters/table'
-        autoload :Td, 'coradoc/html/input/converters/td'
-        autoload :Text, 'coradoc/html/input/converters/text'
-        autoload :Tr, 'coradoc/html/input/converters/tr'
-        autoload :Video, 'coradoc/html/input/converters/video'
+        # Autoload converter classes — they self-register when loaded.
+        # Adding a new converter requires only adding one entry here.
+        CONVERTERS = {
+          Base: 'coradoc/html/input/converters/base',
+          Markup: 'coradoc/html/input/converters/markup',
+          A: 'coradoc/html/input/converters/a',
+          Aside: 'coradoc/html/input/converters/aside',
+          Audio: 'coradoc/html/input/converters/audio',
+          Blockquote: 'coradoc/html/input/converters/blockquote',
+          Br: 'coradoc/html/input/converters/br',
+          Bypass: 'coradoc/html/input/converters/bypass',
+          Code: 'coradoc/html/input/converters/code',
+          Div: 'coradoc/html/input/converters/div',
+          Dl: 'coradoc/html/input/converters/dl',
+          Skip: 'coradoc/html/input/converters/drop',
+          Em: 'coradoc/html/input/converters/em',
+          Figure: 'coradoc/html/input/converters/figure',
+          H: 'coradoc/html/input/converters/h',
+          Head: 'coradoc/html/input/converters/head',
+          Hr: 'coradoc/html/input/converters/hr',
+          Img: 'coradoc/html/input/converters/img',
+          Li: 'coradoc/html/input/converters/li',
+          Mark: 'coradoc/html/input/converters/mark',
+          Math: 'coradoc/html/input/converters/math',
+          MediaBase: 'coradoc/html/input/converters/media_base',
+          Ol: 'coradoc/html/input/converters/ol',
+          P: 'coradoc/html/input/converters/p',
+          PassThrough: 'coradoc/html/input/converters/pass_through',
+          PositionalFormatting: 'coradoc/html/input/converters/positional_formatting',
+          Pre: 'coradoc/html/input/converters/pre',
+          Q: 'coradoc/html/input/converters/q',
+          Strong: 'coradoc/html/input/converters/strong',
+          Sup: 'coradoc/html/input/converters/sup',
+          Sub: 'coradoc/html/input/converters/sub',
+          Table: 'coradoc/html/input/converters/table',
+          Td: 'coradoc/html/input/converters/td',
+          Text: 'coradoc/html/input/converters/text',
+          Tr: 'coradoc/html/input/converters/tr',
+          Video: 'coradoc/html/input/converters/video'
+        }.freeze
+        private_constant :CONVERTERS
+
+        CONVERTERS.each do |name, path|
+          autoload name, path
+        end
 
         @converters = {}
         @converters_loaded = false
@@ -57,12 +65,7 @@ module Coradoc
           return if @converters_loaded
 
           @converters_loaded = true
-
-          [
-            Base, Markup, A, Aside, Audio, Blockquote, Br, Bypass, Code, Div, Dl,
-            Skip, Em, Figure, H, Head, Hr, Img, Li, Mark, Math, Ol, P,
-            PassThrough, Pre, Q, Strong, Sup, Sub, Table, Td, Text, Tr, Video
-          ].each { |converter| _ = converter }
+          CONVERTERS.each_key { |name| const_get(name) }
         end
 
         def self.lookup(tag_name)

data/lib/coradoc/html/input/plugin.rb

@@ -65,13 +65,6 @@ module Coradoc
           Coradoc::Html::Input::Converters.process_coradoc(tree, state)
         end
 
-        def html_tree_preview
-          Tempfile.open(%w[coradoc .html]) do |i|
-            i << html_tree.to_html
-            system 'chromium-browser', '--no-sandbox', i.path
-          end
-        end
-
         # define preprocess_html_tree to process HTML trees
 
         # Creates a hook to be called instead of converting an element

data/lib/coradoc/html/layout_renderer.rb

@@ -15,25 +15,27 @@ module Coradoc
         @dist_assets_cache = {}
       end
 
-      def render_static(document, body_html, options)
+      def render_static(document, body_html, opts)
+        opts = RenderOptions.new(**opts) unless opts.is_a?(RenderOptions)
         layout_template = load_layout('default')
-        return build_static_fallback(document, body_html, options) unless layout_template
+        return build_static_fallback(document, body_html, opts) unless layout_template
 
-        layout_template.render(build_static_layout_data(document, body_html, options)).strip
+        layout_template.render(build_static_layout_data(document, body_html, opts)).strip
       end
 
-      def render_spa(document, options, body_html, toc_data)
-        dist_dir = options[:dist_dir] || File.expand_path('../../../frontend/dist', __dir__)
+      def render_spa(document, opts, body_html, toc_data)
+        opts = RenderOptions.new(**opts) unless opts.is_a?(RenderOptions)
+        dist_dir = opts.dist_dir || File.expand_path('../../../frontend/dist', __dir__)
         assets = load_dist_assets(dist_dir)
 
-        content_data = build_spa_content_data(document, body_html, options, toc_data)
+        content_data = build_spa_content_data(document, body_html, opts, toc_data)
         safe_json = Escape.safe_json(content_data)
 
         layout_template = load_layout('spa')
         if layout_template
-          layout_template.render(build_spa_layout_data(document, options, assets, safe_json)).strip
+          layout_template.render(build_spa_layout_data(document, opts, assets, safe_json)).strip
         else
-          build_spa_fallback(document, options, assets, safe_json)
+          build_spa_fallback(document, opts, assets, safe_json)
         end
       end
 
@@ -47,25 +49,25 @@ module Coradoc
         TitleText.escape(document&.title) || Config::DEFAULT_TITLE
       end
 
-      def resolve_lang(options)
-        options[:lang] || Config::DEFAULT_LANG
+      def resolve_lang(opts)
+        opts.lang || Config::DEFAULT_LANG
       end
 
-      def build_static_layout_data(document, body_html, options)
+      def build_static_layout_data(document, body_html, opts)
         {
-          'lang' => resolve_lang(options),
+          'lang' => resolve_lang(opts),
           'title' => resolve_escaped_title(document),
-          'author' => options[:author],
-          'description' => options[:description],
+          'author' => opts.author,
+          'description' => opts.description,
           'generator_version' => Coradoc::VERSION.to_s,
           'body' => body_html,
-          'custom_css' => options[:custom_css]
+          'custom_css' => opts.custom_css
         }
       end
 
-      def build_static_fallback(document, body_html, options)
+      def build_static_fallback(document, body_html, opts)
         Nokogiri::HTML::Builder.new do |doc|
-          doc.html(lang: resolve_lang(options)) do
+          doc.html(lang: resolve_lang(opts)) do
             doc.head do
               doc.meta(charset: 'UTF-8')
               doc.meta(name: 'viewport', content: 'width=device-width, initial-scale=1.0')
@@ -76,42 +78,42 @@ module Coradoc
         end.to_html
       end
 
-      def build_spa_content_data(document, body_html, options, toc_data)
+      def build_spa_content_data(document, body_html, opts, toc_data)
         {
           mode: 'classic',
           contentHtml: body_html,
           toc: toc_data,
-          meta: build_spa_meta(document, options),
-          options: build_spa_options(options)
+          meta: build_spa_meta(document, opts),
+          options: build_spa_options(opts)
         }
       end
 
-      def build_spa_meta(document, options)
+      def build_spa_meta(document, _opts)
         {
           title: TitleText.resolve(document&.title) || Config::DEFAULT_TITLE,
-          author: options[:author],
-          date: options[:revdate],
+          author: _opts.author,
+          date: nil,
           generator: "Coradoc #{Coradoc::VERSION}"
         }
       end
 
-      def build_spa_options(options)
+      def build_spa_options(opts)
         {
-          toc: options[:toc] ? true : false,
-          tocPlacement: (options[:toc_placement] || :auto).to_s,
-          sectnums: options[:section_numbers] == true,
-          themeToggle: options[:theme_toggle] != false,
-          readingProgress: options[:reading_progress] != false,
-          lang: resolve_lang(options)
+          toc: opts.toc ? true : false,
+          tocPlacement: (opts.toc_placement || :auto).to_s,
+          sectnums: opts.section_numbers == true,
+          themeToggle: opts.theme_toggle != false,
+          readingProgress: opts.reading_progress != false,
+          lang: resolve_lang(opts)
         }
       end
 
-      def build_spa_layout_data(document, options, assets, safe_json)
+      def build_spa_layout_data(document, opts, assets, safe_json)
         {
-          'lang' => resolve_lang(options),
+          'lang' => resolve_lang(opts),
           'title' => resolve_escaped_title(document),
-          'author' => options[:author],
-          'description' => options[:description],
+          'author' => opts.author,
+          'description' => opts.description,
           'generator_version' => Coradoc::VERSION.to_s,
           'css' => assets[:css],
           'js' => assets[:js],
@@ -119,9 +121,9 @@ module Coradoc
         }
       end
 
-      def build_spa_fallback(document, options, assets, safe_json)
+      def build_spa_fallback(document, opts, assets, safe_json)
         Nokogiri::HTML::Builder.new do |doc|
-          doc.html(lang: resolve_lang(options)) do
+          doc.html(lang: resolve_lang(opts)) do
             doc.head do
               doc.meta(charset: 'UTF-8')
               doc.meta(name: 'viewport', content: 'width=device-width, initial-scale=1.0')

data/lib/coradoc/html/render_options.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module Html
+    class RenderOptions
+      attr_reader :layout, :lang, :toc, :toc_levels, :section_numbers,
+                  :section_number_levels, :author, :description, :custom_css,
+                  :dist_dir, :theme_toggle, :reading_progress, :toc_placement
+
+      def initialize(layout: :static, lang: 'en', toc: false, toc_levels: 2,
+                     section_numbers: false, section_number_levels: 3,
+                     author: nil, description: nil, custom_css: nil,
+                     dist_dir: nil, theme_toggle: true, reading_progress: true,
+                     toc_placement: :auto)
+        @layout = layout
+        @lang = lang
+        @toc = toc
+        @toc_levels = toc_levels
+        @section_numbers = section_numbers
+        @section_number_levels = section_number_levels
+        @author = author
+        @description = description
+        @custom_css = custom_css
+        @dist_dir = dist_dir
+        @theme_toggle = theme_toggle
+        @reading_progress = reading_progress
+        @toc_placement = toc_placement
+        freeze
+      end
+
+      def spa?
+        @layout == :spa
+      end
+
+      def static?
+        @layout == :static
+      end
+    end
+  end
+end

data/lib/coradoc/html/renderer.rb

@@ -48,14 +48,21 @@ module Coradoc
         template.render(assigns, registers: { renderer: self, section_numbers: @section_numbers }).strip
       end
 
-      def render_html5(document, **options)
-        @section_numbers = compute_section_numbers(document, options)
+      def render_html5(document, **)
+        opts = RenderOptions.new(**)
+        builder = TocBuilder.from_options(opts)
+        @toc, @section_numbers = if document.is_a?(CoreModel::StructuralElement)
+                                   builder.build_with_numbers(document)
+                                 else
+                                   [nil, {}]
+                                 end
+
         body_html = render(document)
 
-        if options[:layout] == :spa
-          render_spa_layout(document, body_html, options)
+        if opts.spa?
+          render_spa_layout(document, body_html, opts)
         else
-          render_static_layout(document, body_html, options)
+          render_static_layout(document, body_html, opts)
         end
       end
 
@@ -73,34 +80,22 @@ module Coradoc
 
       private
 
-      def build_toc(_document, options)
-        TocBuilder.from_options(options)
-      end
-
-      def compute_section_numbers(document, options)
-        if options[:section_numbers] && document.is_a?(CoreModel::StructuralElement)
-          build_toc(document, options).section_number_map(document)
-        else
-          {}
-        end
-      end
-
-      def render_toc_for(document, options)
-        toc = build_toc(document, options).build(document)
-        render(toc)
-      end
-
-      def render_static_layout(document, body_html, options)
-        if options[:toc] && document.is_a?(CoreModel::StructuralElement)
-          toc_html = render_toc_for(document, options)
+      def render_static_layout(document, body_html, opts)
+        if opts.toc && @toc
+          toc_html = render(@toc)
           body_html = "#{toc_html}\n#{body_html}" unless toc_html.empty?
         end
-        @layout_renderer.render_static(document, body_html, options)
+        @layout_renderer.render_static(document, body_html, opts)
       end
 
-      def render_spa_layout(document, body_html, options)
-        toc_data = TocSerializer.new.build_json(document, options)
-        @layout_renderer.render_spa(document, options, body_html, toc_data)
+      def render_spa_layout(document, body_html, opts)
+        numbered = opts.section_numbers == true
+        toc_data = if @toc
+                     { entries: TocSerializer.new.serialize_entries(@toc.entries), numbered: numbered }
+                   else
+                     { entries: [], numbered: false }
+                   end
+        @layout_renderer.render_spa(document, opts, body_html, toc_data)
       end
 
       def find_and_load_template(type_name)
@@ -123,11 +118,12 @@ module Coradoc
         resolved = TitleText.resolve(drop.model)
         text = resolved ? Escape.escape_html(resolved) : ''
 
-        doc = Nokogiri::HTML::Document.new
-        fragment = Nokogiri::HTML::Builder.with(doc) do |builder|
-          builder.div(class: "element element-#{type}") { builder.text text }
-        end
-        fragment.at_css('div').to_html
+        fragment = Nokogiri::HTML.fragment
+        div = Nokogiri::XML::Node.new('div', fragment.document)
+        div['class'] = "element element-#{type}"
+        div.content = text
+        fragment.add_child(div)
+        fragment.to_html
       end
 
       def normalize_dirs(dirs)

data/lib/coradoc/html/spa.rb

@@ -12,33 +12,16 @@ module Coradoc
     # Uses the unified Liquid template pipeline.
     class Spa < ConverterBase
       class Configuration < ConverterBase::ConfigurationBase
-        attr_accessor :theme_toggle, :reading_progress,
-                      :toc_sticky, :toc_levels, :lang,
-                      :template_dirs, :dist_dir
-
-        def initialize(**options)
-          @theme_toggle = options.fetch(:theme_toggle, true)
-          @reading_progress = options.fetch(:reading_progress, true)
-          @toc_sticky = options.fetch(:toc_sticky, true)
-          @toc_levels = options[:toc_levels] || 2
-          @lang = options[:lang] || 'en'
-          @template_dirs = options[:template_dirs]
-          @dist_dir = options[:dist_dir]
-        end
-
-        def to_h
-          {
-            theme_toggle: @theme_toggle, reading_progress: @reading_progress,
-            toc_sticky: @toc_sticky, toc_levels: @toc_levels,
-            lang: @lang, template_dirs: @template_dirs, dist_dir: @dist_dir
-          }
-        end
+        attribute :theme_toggle, default: true
+        attribute :reading_progress, default: true
+        attribute :toc_sticky, default: true
+        attribute :toc_levels, default: 2
+        attribute :lang, default: 'en'
+        attribute :template_dirs
+        attribute :dist_dir
 
         def validate!
-          return if @toc_levels.is_a?(Integer) && @toc_levels.between?(1, 5)
-
-          raise ConverterBase::ValidationError,
-                'TOC levels must be an integer between 1 and 5'
+          range_check(:toc_levels, 1, 5, label: 'TOC levels')
         end
       end
 

data/lib/coradoc/html/static.rb

@@ -12,44 +12,19 @@ module Coradoc
     # the unified Liquid template pipeline.
     class Static < ConverterBase
       class Configuration < ConverterBase::ConfigurationBase
-        attr_accessor :include_toc, :toc_levels,
-                      :section_numbering, :section_numbering_levels,
-                      :lang, :meta_tags, :custom_css, :embedded,
-                      :template_dirs
-
-        def initialize(**options)
-          @include_toc = options.fetch(:include_toc, false)
-          @toc_levels = options[:toc_levels] || 2
-          @section_numbering = options.fetch(:section_numbering, false)
-          @section_numbering_levels = options[:section_numbering_levels] || 3
-          @lang = options[:lang] || 'en'
-          @meta_tags = options[:meta_tags] || {}
-          @custom_css = options[:custom_css]
-          @embedded = options.fetch(:embedded, false)
-          @template_dirs = options[:template_dirs]
-        end
-
-        def to_h
-          {
-            include_toc: @include_toc, toc_levels: @toc_levels,
-            section_numbering: @section_numbering,
-            section_numbering_levels: @section_numbering_levels,
-            lang: @lang, meta_tags: @meta_tags, custom_css: @custom_css,
-            embedded: @embedded, template_dirs: @template_dirs
-          }
-        end
+        attribute :include_toc, default: false
+        attribute :toc_levels, default: 2
+        attribute :section_numbering, default: false
+        attribute :section_numbering_levels, default: 3
+        attribute :lang, default: 'en'
+        attribute :meta_tags, default: {}
+        attribute :custom_css
+        attribute :embedded, default: false
+        attribute :template_dirs
 
         def validate!
-          unless @toc_levels.is_a?(Integer) && @toc_levels.between?(1, 5)
-            raise ConverterBase::ValidationError,
-                  'TOC levels must be an integer between 1 and 5'
-          end
-
-          unless @section_numbering_levels.is_a?(Integer) &&
-                 @section_numbering_levels.between?(1, 6)
-            raise ConverterBase::ValidationError,
-                  'Section numbering levels must be an integer between 1 and 6'
-          end
+          range_check(:toc_levels, 1, 5, label: 'TOC levels')
+          range_check(:section_numbering_levels, 1, 6, label: 'Section numbering levels')
         end
       end