RubyGems - coradoc-html - Versions diffs - 1.1.7 - Mend

coradoc-html 1.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (124) hide show

checksums.yaml +7 -0
data/LICENSE.txt +21 -0
data/lib/coradoc/html/base.rb +157 -0
data/lib/coradoc/html/config.rb +467 -0
data/lib/coradoc/html/converter_base.rb +177 -0
data/lib/coradoc/html/converters/admonition.rb +180 -0
data/lib/coradoc/html/converters/attribute.rb +68 -0
data/lib/coradoc/html/converters/attribute_reference.rb +60 -0
data/lib/coradoc/html/converters/audio.rb +165 -0
data/lib/coradoc/html/converters/base.rb +615 -0
data/lib/coradoc/html/converters/bibliography.rb +82 -0
data/lib/coradoc/html/converters/bibliography_entry.rb +108 -0
data/lib/coradoc/html/converters/block_image.rb +72 -0
data/lib/coradoc/html/converters/bold.rb +34 -0
data/lib/coradoc/html/converters/break.rb +32 -0
data/lib/coradoc/html/converters/comment_block.rb +42 -0
data/lib/coradoc/html/converters/comment_line.rb +54 -0
data/lib/coradoc/html/converters/cross_reference.rb +59 -0
data/lib/coradoc/html/converters/document.rb +108 -0
data/lib/coradoc/html/converters/example.rb +114 -0
data/lib/coradoc/html/converters/highlight.rb +34 -0
data/lib/coradoc/html/converters/include.rb +68 -0
data/lib/coradoc/html/converters/inline_image.rb +41 -0
data/lib/coradoc/html/converters/italic.rb +34 -0
data/lib/coradoc/html/converters/line_break.rb +31 -0
data/lib/coradoc/html/converters/link.rb +46 -0
data/lib/coradoc/html/converters/list_item.rb +75 -0
data/lib/coradoc/html/converters/listing.rb +99 -0
data/lib/coradoc/html/converters/literal.rb +102 -0
data/lib/coradoc/html/converters/monospace.rb +34 -0
data/lib/coradoc/html/converters/open.rb +78 -0
data/lib/coradoc/html/converters/ordered.rb +53 -0
data/lib/coradoc/html/converters/paragraph.rb +46 -0
data/lib/coradoc/html/converters/quote.rb +113 -0
data/lib/coradoc/html/converters/reviewer_comment.rb +74 -0
data/lib/coradoc/html/converters/reviewer_note.rb +134 -0
data/lib/coradoc/html/converters/section.rb +90 -0
data/lib/coradoc/html/converters/sidebar.rb +113 -0
data/lib/coradoc/html/converters/source.rb +137 -0
data/lib/coradoc/html/converters/source_code.rb +16 -0
data/lib/coradoc/html/converters/span.rb +61 -0
data/lib/coradoc/html/converters/strikethrough.rb +34 -0
data/lib/coradoc/html/converters/subscript.rb +34 -0
data/lib/coradoc/html/converters/superscript.rb +34 -0
data/lib/coradoc/html/converters/table.rb +85 -0
data/lib/coradoc/html/converters/table_cell.rb +203 -0
data/lib/coradoc/html/converters/table_row.rb +45 -0
data/lib/coradoc/html/converters/template_html_converter.rb +105 -0
data/lib/coradoc/html/converters/term.rb +58 -0
data/lib/coradoc/html/converters/text_element.rb +44 -0
data/lib/coradoc/html/converters/underline.rb +34 -0
data/lib/coradoc/html/converters/unordered.rb +47 -0
data/lib/coradoc/html/converters/verse.rb +105 -0
data/lib/coradoc/html/converters/video.rb +179 -0
data/lib/coradoc/html/element_mapping.rb +210 -0
data/lib/coradoc/html/entity.rb +137 -0
data/lib/coradoc/html/input/cleaner.rb +163 -0
data/lib/coradoc/html/input/config.rb +79 -0
data/lib/coradoc/html/input/converters/a.rb +90 -0
data/lib/coradoc/html/input/converters/aside.rb +23 -0
data/lib/coradoc/html/input/converters/audio.rb +50 -0
data/lib/coradoc/html/input/converters/base.rb +116 -0
data/lib/coradoc/html/input/converters/blockquote.rb +25 -0
data/lib/coradoc/html/input/converters/br.rb +19 -0
data/lib/coradoc/html/input/converters/bypass.rb +83 -0
data/lib/coradoc/html/input/converters/code.rb +25 -0
data/lib/coradoc/html/input/converters/div.rb +25 -0
data/lib/coradoc/html/input/converters/dl.rb +106 -0
data/lib/coradoc/html/input/converters/drop.rb +28 -0
data/lib/coradoc/html/input/converters/em.rb +23 -0
data/lib/coradoc/html/input/converters/figure.rb +58 -0
data/lib/coradoc/html/input/converters/h.rb +76 -0
data/lib/coradoc/html/input/converters/head.rb +30 -0
data/lib/coradoc/html/input/converters/hr.rb +20 -0
data/lib/coradoc/html/input/converters/ignore.rb +22 -0
data/lib/coradoc/html/input/converters/img.rb +110 -0
data/lib/coradoc/html/input/converters/li.rb +35 -0
data/lib/coradoc/html/input/converters/mark.rb +21 -0
data/lib/coradoc/html/input/converters/markup.rb +107 -0
data/lib/coradoc/html/input/converters/math.rb +46 -0
data/lib/coradoc/html/input/converters/ol.rb +46 -0
data/lib/coradoc/html/input/converters/p.rb +81 -0
data/lib/coradoc/html/input/converters/pass_through.rb +19 -0
data/lib/coradoc/html/input/converters/pre.rb +59 -0
data/lib/coradoc/html/input/converters/q.rb +24 -0
data/lib/coradoc/html/input/converters/strong.rb +22 -0
data/lib/coradoc/html/input/converters/sub.rb +40 -0
data/lib/coradoc/html/input/converters/sup.rb +40 -0
data/lib/coradoc/html/input/converters/table.rb +64 -0
data/lib/coradoc/html/input/converters/td.rb +70 -0
data/lib/coradoc/html/input/converters/text.rb +67 -0
data/lib/coradoc/html/input/converters/th.rb +20 -0
data/lib/coradoc/html/input/converters/tr.rb +28 -0
data/lib/coradoc/html/input/converters/video.rb +53 -0
data/lib/coradoc/html/input/converters.rb +122 -0
data/lib/coradoc/html/input/errors.rb +22 -0
data/lib/coradoc/html/input/html_converter.rb +170 -0
data/lib/coradoc/html/input/plugin.rb +169 -0
data/lib/coradoc/html/input/plugins/plateau.rb +229 -0
data/lib/coradoc/html/input/postprocessor.rb +31 -0
data/lib/coradoc/html/input.rb +68 -0
data/lib/coradoc/html/output.rb +95 -0
data/lib/coradoc/html/renderer.rb +409 -0
data/lib/coradoc/html/spa.rb +309 -0
data/lib/coradoc/html/static.rb +293 -0
data/lib/coradoc/html/template_config.rb +151 -0
data/lib/coradoc/html/template_helpers.rb +58 -0
data/lib/coradoc/html/template_locator.rb +114 -0
data/lib/coradoc/html/theme/base.rb +231 -0
data/lib/coradoc/html/theme/classic_renderer.rb +390 -0
data/lib/coradoc/html/theme/modern/components/ui_components.rb +344 -0
data/lib/coradoc/html/theme/modern/css_generator.rb +311 -0
data/lib/coradoc/html/theme/modern/javascript_generator.rb +314 -0
data/lib/coradoc/html/theme/modern/serializers/document_serializer.rb +382 -0
data/lib/coradoc/html/theme/modern/tailwind_config_builder.rb +164 -0
data/lib/coradoc/html/theme/modern/vue_template_generator.rb +374 -0
data/lib/coradoc/html/theme/modern_renderer.rb +250 -0
data/lib/coradoc/html/theme/registry.rb +153 -0
data/lib/coradoc/html/theme.rb +13 -0
data/lib/coradoc/html/transform/from_core_model.rb +32 -0
data/lib/coradoc/html/transform/to_core_model.rb +39 -0
data/lib/coradoc/html/version.rb +7 -0
data/lib/coradoc/html.rb +255 -0
metadata +264 -0

data/lib/coradoc/html/theme/classic_renderer.rb ADDED Viewed

@@ -0,0 +1,390 @@
+# frozen_string_literal: true
+require 'coradoc/html'
+require 'coradoc/html/config'
+require 'coradoc/html/converters/base'
+module Coradoc
+  module Html
+    module Theme
+      # Classic theme renderer
+      #
+      # This renderer wraps the existing Coradoc HTML generation system.
+      # It maintains backward compatibility with the classic theme while
+      # following the new theme system architecture.
+      #
+      # The classic theme is the default theme and provides the same output
+      # as the original Coradoc HTML converter.
+      class ClassicRenderer < Base
+        # Register this theme automatically
+        Registry.auto_register(self)
+        # Check if template rendering is enabled
+        #
+        # @return [Boolean]
+        def use_templates?
+          @options[:use_templates] == true
+        end
+        # Get the template renderer when templates are enabled
+        #
+        # @return [Coradoc::Html::Renderer, nil]
+        def template_renderer
+          return nil unless use_templates?
+          @template_renderer ||= begin
+            dirs = @options[:template_dirs] || global_template_dirs
+            Renderer.new(template_dirs: dirs)
+          end
+        end
+        # Supported features for classic theme
+        #
+        # @return [Array<Symbol>] Supported features
+        def supported_features
+          features = %i[
+            dark_mode
+            theme_toggle
+            syntax_highlighting
+            table_of_contents
+            section_numbering
+          ]
+          features << :template_rendering if use_templates?
+          features
+        end
+        # Render document to HTML
+        #
+        # Generates HTML body content from the document.
+        # Uses the HTML Converters directly to avoid circular dependency.
+        # When templates are enabled, uses the template renderer instead.
+        #
+        # @return [String] HTML string
+        def render
+          return template_renderer.render(@document) if use_templates? && template_renderer
+          # Use HTML converters directly to convert document model to HTML
+          # This avoids circular dependency with Coradoc::Output::Html
+          Coradoc::Html::Converters::Document.to_html(@document, @options)
+        end
+        # Render complete HTML5 document
+        #
+        # Builds the complete HTML5 document with head, body, and all assets.
+        # @return [String] Complete HTML5 document
+        def render_html5
+          html_body = render
+          lang = @options[:lang] || 'en'
+          body_classes = build_body_classes
+          # Apply section numbering if enabled
+          final_body = if @options[:sectnums]
+                         apply_section_numbering(html_body)
+                       else
+                         html_body
+                       end
+          # Build TOC if enabled
+          toc_html = build_toc
+          # Insert TOC based on placement
+          final_body = insert_toc(final_body, toc_html)
+          # Add theme toggle button if enabled
+          theme_button = build_theme_toggle_button
+          <<~HTML
+            <!DOCTYPE html>
+            <html lang="#{lang}">
+            <head>
+            #{build_head_content}
+            </head>
+            <body#{body_classes}>
+            #{final_body}
+            #{theme_button}
+            </body>
+            </html>
+          HTML
+        end
+        protected
+        # Get global template directories from configuration
+        def global_template_dirs
+          Coradoc::Html.configuration.template_dirs.map(&:to_s)
+        end
+        # Build body classes
+        #
+        # @return [String] Body class attribute
+        def build_body_classes
+          classes = []
+          # Add TOC placement class
+          if @options[:toc]
+            placement = @options[:toc_placement] || :auto
+            classes << "toc-#{placement}" unless placement == :auto
+          end
+          classes.empty? ? '' : %( class="#{classes.join(' ')}")
+        end
+        # Build CSS tags
+        #
+        # @return [String] CSS link or style tags
+        def build_css_tags
+          Coradoc::Html::Config.css_tags(@options).split("\n")
+                               .map { |line| "  #{line}" }.join("\n")
+        end
+        # Build script tags
+        #
+        # @return [String] Script tags
+        def build_script_tags
+          js = Coradoc::Html::Config.js_tags(@options)
+          return '' if js.empty?
+          js.split("\n").map { |line| "  #{line}" }.join("\n")
+        end
+        # Build syntax highlighter tags
+        #
+        # @return [String] Syntax highlighter tags HTML
+        def build_head_content
+          parts = []
+          parts << build_meta_tags
+          parts << build_title_tag
+          parts << build_css_tags
+          parts << build_script_tags
+          parts << build_syntax_highlighter_tags
+          parts.compact.reject(&:empty?).join("\n")
+        end
+        # Build syntax highlighter tags
+        #
+        # @return [String] Syntax highlighter tags HTML
+        def build_syntax_highlighter_tags
+          tags = Coradoc::Html::Config.syntax_highlighter_tags(@options)
+          return '' if tags.empty?
+          tags.split("\n").map { |line| "  #{line}" }.join("\n")
+        end
+        # Insert TOC into body HTML based on placement
+        #
+        # @param body_html [String] Body HTML content
+        # @param toc_html [String] TOC HTML
+        # @return [String] Combined HTML
+        def insert_toc(body_html, toc_html)
+          return body_html if toc_html.empty?
+          placement = @options[:toc_placement] || :auto
+          case placement
+          when :left, :right
+            # For sidebar placements, TOC is positioned via CSS
+            "#{toc_html}\n#{body_html}"
+          when :auto, :preamble
+            # Insert after header, before main content
+            if body_html =~ %r{(</h1>)}
+              body_html.sub(::Regexp.last_match(1), "#{::Regexp.last_match(1)}\n#{toc_html}")
+            else
+              "#{toc_html}\n#{body_html}"
+            end
+          else
+            # Default: prepend to body
+            "#{toc_html}\n#{body_html}"
+          end
+        end
+        # Build theme toggle button HTML
+        #
+        # @return [String] Theme toggle button HTML or empty string
+        def build_theme_toggle_button
+          return '' unless @options[:theme_toggle]
+          <<~HTML
+            <button id="theme-toggle" aria-label="Toggle dark mode" title="Toggle dark/light mode">
+              <span class="theme-toggle-icon">☀️</span>
+            </button>
+          HTML
+        end
+        # Build table of contents
+        #
+        # @return [String] TOC HTML or empty string
+        def build_toc
+          return '' unless @options[:toc]
+          toc_placement = @options[:toc_placement] || :auto
+          toc_class = toc_placement == :auto ? 'toc' : "toc toc-#{toc_placement}"
+          sections = extract_sections(@document)
+          return '' if sections.empty?
+          toc_title = @options[:toc_title] || 'Table of Contents'
+          toc_levels = @options[:toclevels] || 2
+          build_toc_html(sections, toc_levels, toc_class, toc_title)
+        end
+        # Extract sections from document
+        #
+        # @param doc [Coradoc::CoreModel::StructuralElement] Document to extract sections from
+        # @return [Array] Array of section objects
+        def extract_sections(doc)
+          sections = []
+          return sections unless doc.is_a?(Coradoc::CoreModel::StructuralElement)
+          collect_sections(doc.children, sections, 1)
+          sections
+        end
+        # Recursively collect sections
+        #
+        # @param items [Array] Items to process
+        # @param sections [Array] Accumulated sections
+        # @param level [Integer] Current section level
+        def collect_sections(items, sections, level)
+          return unless items
+          items.each do |item|
+            next unless item.is_a?(Coradoc::CoreModel::StructuralElement)
+            section_data = {
+              title: extract_section_title(item),
+              id: extract_section_id(item),
+              level: level,
+              children: []
+            }
+            # Recursively collect subsections
+            collect_sections(item.children, section_data[:children], level + 1)
+            sections << section_data
+          end
+        end
+        # Extract section title
+        #
+        # @param section [Coradoc::CoreModel::StructuralElement] Section to extract title from
+        # @return [String] Section title
+        def extract_section_title(section)
+          title = section.title
+          if title
+            if title.is_a?(Coradoc::CoreModel::Base) && title.text
+              title.text
+            elsif title.is_a?(Coradoc::CoreModel::Base) && title.content
+              Coradoc::Html::Converters::Base.get_text_content(title)
+            elsif title.is_a?(Array)
+              title.map { |t| t.is_a?(Coradoc::CoreModel::Base) && t.text ? t.text : t.to_s }.join
+            else
+              title.to_s
+            end
+          else
+            'Untitled Section'
+          end
+        end
+        # Extract section ID
+        #
+        # @param section [Coradoc::CoreModel::StructuralElement] Section to extract ID from
+        # @return [String] Section ID
+        def extract_section_id(section)
+          if section.id
+            section.id
+          else
+            # Generate ID from title
+            title = extract_section_title(section)
+            "_#{title.to_s.downcase.gsub(/[^a-z0-9]+/, '_').gsub(/^_+|_+$/, '')}"
+          end
+        end
+        # Build TOC HTML
+        #
+        # @param sections [Array] Section data
+        # @param max_level [Integer] Maximum level to include
+        # @param toc_class [String] CSS class for TOC
+        # @param toc_title [String] TOC title
+        # @return [String] TOC HTML
+        def build_toc_html(sections, max_level, toc_class, toc_title)
+          return '' if sections.empty?
+          html = []
+          html << %(<div id="toc" class="#{toc_class}">)
+          html << %(  <div class="toc-title">#{escape_html(toc_title)}</div>)
+          html << build_toc_list(sections, 1, max_level)
+          html << %(</div>)
+          html.join("\n")
+        end
+        # Build TOC list recursively
+        #
+        # @param sections [Array] Section data
+        # @param current_level [Integer] Current level
+        # @param max_level [Integer] Maximum level
+        # @return [String] List HTML
+        def build_toc_list(sections, current_level, max_level)
+          return '' if sections.empty? || current_level > max_level
+          html = []
+          html << %(  <ul class="sectlevel#{current_level}">)
+          sections.each do |section|
+            html << %(    <li>)
+            html << %(      <a href="##{section[:id]}">#{escape_html(section[:title])}</a>)
+            # Add nested list for children
+            if section[:children] && !section[:children].empty? && current_level < max_level
+              nested_html = build_toc_list(section[:children], current_level + 1, max_level)
+              html << nested_html if nested_html && !nested_html.empty?
+            end
+            html << %(    </li>)
+          end
+          html << %(  </ul>)
+          html.join("\n")
+        end
+        # Apply section numbering to HTML
+        #
+        # @param html [String] HTML content
+        # @return [String] HTML with section numbers
+        def apply_section_numbering(html)
+          require 'nokogiri'
+          max_level = @options[:sectnumlevels] || 3
+          doc = Nokogiri::HTML::DocumentFragment.parse(html)
+          # Track section numbers at each level
+          counters = Array.new(max_level + 1, 0)
+          # Find all headings (h2-h6, h1 is document title)
+          (2..6).each do |level|
+            doc.css("h#{level}").each do |heading|
+              section_level = level - 1 # h2 = level 1, h3 = level 2, etc.
+              next if section_level > max_level
+              # Increment counter for this level
+              counters[section_level] += 1
+              # Reset deeper level counters
+              ((section_level + 1)..max_level).each { |i| counters[i] = 0 }
+              # Build section number (e.g., "1.2.3")
+              section_number = counters[1..section_level].join('.')
+              # Add section number to heading
+              number_span = %(<span class="sectnum">#{section_number}. </span>)
+              heading.inner_html = number_span + heading.inner_html
+            end
+          end
+          doc.to_html
+        end
+      end
+    end
+  end
+end