coradoc-html 1.1.7

data/lib/coradoc/html.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+# Load HTML input module to register with Coradoc::Input
+require 'coradoc/html/input'
+# Load HTML output module to register with Coradoc::Output
+require 'coradoc/html/output'
+
+module Coradoc
+  module Html
+    module Converters
+      # Autoload HTML converters - they will be loaded when accessed
+      autoload :Base, 'coradoc/html/converters/base'
+      autoload :Admonition, 'coradoc/html/converters/admonition'
+      autoload :AttributeReference, 'coradoc/html/converters/attribute_reference'
+      autoload :Attribute, 'coradoc/html/converters/attribute'
+      autoload :Audio, 'coradoc/html/converters/audio'
+      autoload :BibliographyEntry, 'coradoc/html/converters/bibliography_entry'
+      autoload :Bibliography, 'coradoc/html/converters/bibliography'
+      autoload :BlockImage, 'coradoc/html/converters/block_image'
+      autoload :Bold, 'coradoc/html/converters/bold'
+      autoload :Break, 'coradoc/html/converters/break'
+      autoload :CommentBlock, 'coradoc/html/converters/comment_block'
+      autoload :CommentLine, 'coradoc/html/converters/comment_line'
+      autoload :CrossReference, 'coradoc/html/converters/cross_reference'
+      autoload :Document, 'coradoc/html/converters/document'
+      autoload :Example, 'coradoc/html/converters/example'
+      autoload :Highlight, 'coradoc/html/converters/highlight'
+      autoload :Include, 'coradoc/html/converters/include'
+      autoload :InlineImage, 'coradoc/html/converters/inline_image'
+      autoload :Italic, 'coradoc/html/converters/italic'
+      autoload :LineBreak, 'coradoc/html/converters/line_break'
+      autoload :Link, 'coradoc/html/converters/link'
+      autoload :ListItem, 'coradoc/html/converters/list_item'
+      autoload :Listing, 'coradoc/html/converters/listing'
+      autoload :Literal, 'coradoc/html/converters/literal'
+      autoload :Monospace, 'coradoc/html/converters/monospace'
+      autoload :Ordered, 'coradoc/html/converters/ordered'
+      autoload :Open, 'coradoc/html/converters/open'
+      autoload :Paragraph, 'coradoc/html/converters/paragraph'
+      autoload :Quote, 'coradoc/html/converters/quote'
+      autoload :ReviewerComment, 'coradoc/html/converters/reviewer_comment'
+      autoload :ReviewerNote, 'coradoc/html/converters/reviewer_note'
+      autoload :Section, 'coradoc/html/converters/section'
+      autoload :Sidebar, 'coradoc/html/converters/sidebar'
+      autoload :Source, 'coradoc/html/converters/source'
+      autoload :SourceCode, 'coradoc/html/converters/source_code'
+      autoload :Span, 'coradoc/html/converters/span'
+      autoload :Strikethrough, 'coradoc/html/converters/strikethrough'
+      autoload :Subscript, 'coradoc/html/converters/subscript'
+      autoload :Superscript, 'coradoc/html/converters/superscript'
+      autoload :TableCell, 'coradoc/html/converters/table_cell'
+      autoload :TableRow, 'coradoc/html/converters/table_row'
+      autoload :Table, 'coradoc/html/converters/table'
+      autoload :Term, 'coradoc/html/converters/term'
+      autoload :TextElement, 'coradoc/html/converters/text_element'
+      autoload :Underline, 'coradoc/html/converters/underline'
+      autoload :Unordered, 'coradoc/html/converters/unordered'
+      autoload :Verse, 'coradoc/html/converters/verse'
+      autoload :Video, 'coradoc/html/converters/video'
+    end
+
+    # Autoload HTML components
+    autoload :Config, 'coradoc/html/config'
+    autoload :Base, 'coradoc/html/base'
+    autoload :Entity, 'coradoc/html/entity'
+    autoload :ElementMapping, 'coradoc/html/element_mapping'
+
+    # Autoload HTML output converters
+    autoload :ConverterBase, 'coradoc/html/converter_base'
+    autoload :Static, 'coradoc/html/static'
+    autoload :Spa, 'coradoc/html/spa'
+
+    # Theme system
+    autoload :Theme, 'coradoc/html/theme'
+    autoload :TemplateLocator, 'coradoc/html/template_locator'
+    autoload :TemplateConfig, 'coradoc/html/template_config'
+    autoload :TemplateHelpers, 'coradoc/html/template_helpers'
+    autoload :Renderer, 'coradoc/html/renderer'
+
+    # CoreModel transformers
+    module Transform
+      autoload :ToCoreModel, 'coradoc/html/transform/to_core_model'
+      autoload :FromCoreModel, 'coradoc/html/transform/from_core_model'
+    end
+
+    # Validate that input is a CoreModel type
+    #
+    # @param document [Object] Document to validate
+    # @raise [ArgumentError] If document is not a CoreModel type
+    # @return [Object] The validated document
+    def self.validate_core_model!(document)
+      return document if document.nil?
+
+      unless document.is_a?(Coradoc::CoreModel::Base)
+        raise ArgumentError,
+              'coradoc-html only accepts CoreModel types. ' \
+              "Got: #{document.class}. " \
+              'Transform your document to CoreModel before passing to HTML conversion.'
+      end
+
+      document
+    end
+
+    # Parse HTML content and return CoreModel elements (may be an Array)
+    def self.parse(html, options = {})
+      # Input::Html is autoloaded via Coradoc::Input
+      ::Coradoc::Html::Input.to_coradoc(html, options)
+    end
+
+    # Parse HTML content directly into a CoreModel document
+    #
+    # Unlike #parse which returns an Array of CoreModel elements,
+    # this wraps the result into a top-level StructuralElement document
+    # suitable for use with Coradoc.serialize and other CoreModel pipelines.
+    #
+    # @param html [String] HTML content
+    # @param options [Hash] Parse options
+    # @return [Coradoc::CoreModel::StructuralElement] CoreModel document
+    def self.parse_to_core(html, options = {})
+      elements = parse(html, options)
+
+      return elements if elements.is_a?(Coradoc::CoreModel::Base)
+
+      # Extract document title from the first heading element
+      title = nil
+      children = elements
+      if elements.is_a?(Array) && !elements.empty?
+        first = elements.first
+        if first.is_a?(Coradoc::CoreModel::StructuralElement) &&
+           first.section? && first.level == 1
+          title = first.title
+          children = first.children + elements[1..]
+        end
+      end
+
+      Coradoc::CoreModel::StructuralElement.new(
+        element_type: 'document',
+        title: title,
+        children: Array(children)
+      )
+    end
+
+    # Parse HTML file
+    def self.from_file(filename, **options)
+      content = File.read(filename)
+      parse(content, **options)
+    end
+
+    # Serialize CoreModel document to HTML
+    #
+    # Uses the theme system to render HTML. Default theme is :classic.
+    #
+    # @param document [Coradoc::CoreModel::Base] CoreModel document to serialize
+    # @param options [Hash] Output options
+    # @return [String] HTML output
+    def self.serialize(document, options = {})
+      # Validate input is CoreModel
+      validate_core_model!(document)
+
+      # Trigger theme autoloads to ensure renderers are registered
+      Theme::ClassicRenderer if options[:theme].nil? || options[:theme] == :classic
+      Theme::ModernRenderer if options[:theme] == :modern
+
+      # Use theme registry to find and use the appropriate renderer
+      theme = options[:theme] || :classic
+      renderer_class = Theme::Registry.find(theme)
+      renderer = renderer_class.new(document, options)
+      renderer.render_html5
+    end
+
+    # Serialize CoreModel document to static HTML
+    #
+    # Uses the classic theme renderer for traditional HTML output.
+    #
+    # @param document [Coradoc::CoreModel::Base] CoreModel document to serialize
+    # @param config [Hash, Static::Configuration] Static converter configuration
+    # @return [String] HTML output
+    def self.serialize_static(document, config = {})
+      # Validate input is CoreModel
+      validate_core_model!(document)
+
+      Static.convert(document, config)
+    end
+
+    # Serialize CoreModel document to SPA HTML
+    #
+    # Uses the modern theme renderer for Vue.js + Tailwind output.
+    #
+    # @param document [Coradoc::CoreModel::Base] CoreModel document to serialize
+    # @param config [Hash, Spa::Configuration] SPA converter configuration
+    # @return [String] HTML output
+    def self.serialize_spa(document, config = {})
+      # Validate input is CoreModel
+      validate_core_model!(document)
+
+      Spa.convert(document, config)
+    end
+
+    # Serialize CoreModel document to HTML with specified format
+    #
+    # @param document [Coradoc::CoreModel::Base] CoreModel document to serialize
+    # @param format [Symbol] Output format (:static, :spa, :classic)
+    # @param options [Hash] Converter options
+    # @return [String] HTML output
+    def self.serialize_as(document, format, options = {})
+      # Validate input is CoreModel
+      validate_core_model!(document)
+
+      case format.to_sym
+      when :static, :html_static, :classic
+        serialize_static(document, options)
+      when :spa, :html_spa, :modern
+        serialize_spa(document, options)
+      else
+        raise ArgumentError, "Unknown output format: #{format}. " \
+          'Valid formats: :static, :spa'
+      end
+    end
+
+    # Transform HTML model to CoreModel
+    #
+    # @param document [Object] HTML input model
+    # @return [Coradoc::CoreModel::Base] CoreModel document
+    def self.to_core_model(document)
+      Transform::ToCoreModel.transform(document)
+    end
+
+    # Check if this format can transform the given model to CoreModel
+    #
+    # HTML produces CoreModel directly, so it only handles already-CoreModel objects.
+    #
+    # @param model [Object] The model to check
+    # @return [Boolean] true if the model is already CoreModel
+    def self.handles_model?(model)
+      model.is_a?(Coradoc::CoreModel::Base)
+    end
+
+    def self.to_core(document)
+      to_core_model(document)
+    end
+
+    # Transform CoreModel to HTML-ready structure
+    #
+    # @param core_document [Coradoc::CoreModel::Base] CoreModel document
+    # @return [Object] HTML-ready structure
+    def self.from_core_model(core_document)
+      Transform::FromCoreModel.transform(core_document)
+    end
+  end
+end
+
+# Register after all module methods are defined
+Coradoc.register_format(:html, Coradoc::Html,
+                        aliases: %w[html htm],
+                        extensions: %w[.html .htm])

metadata

@@ -0,0 +1,264 @@
+--- !ruby/object:Gem::Specification
+name: coradoc-html
+version: !ruby/object:Gem::Version
+  version: 1.1.7
+platform: ruby
+authors:
+- Ribose Inc.
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coradoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coradoc-adoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides HTML to AsciiDoc conversion and AsciiDoc to HTML rendering with
+  both classic and modern Vue.js SPA themes
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/coradoc/html.rb
+- lib/coradoc/html/base.rb
+- lib/coradoc/html/config.rb
+- lib/coradoc/html/converter_base.rb
+- lib/coradoc/html/converters/admonition.rb
+- lib/coradoc/html/converters/attribute.rb
+- lib/coradoc/html/converters/attribute_reference.rb
+- lib/coradoc/html/converters/audio.rb
+- lib/coradoc/html/converters/base.rb
+- lib/coradoc/html/converters/bibliography.rb
+- lib/coradoc/html/converters/bibliography_entry.rb
+- lib/coradoc/html/converters/block_image.rb
+- lib/coradoc/html/converters/bold.rb
+- lib/coradoc/html/converters/break.rb
+- lib/coradoc/html/converters/comment_block.rb
+- lib/coradoc/html/converters/comment_line.rb
+- lib/coradoc/html/converters/cross_reference.rb
+- lib/coradoc/html/converters/document.rb
+- lib/coradoc/html/converters/example.rb
+- lib/coradoc/html/converters/highlight.rb
+- lib/coradoc/html/converters/include.rb
+- lib/coradoc/html/converters/inline_image.rb
+- lib/coradoc/html/converters/italic.rb
+- lib/coradoc/html/converters/line_break.rb
+- lib/coradoc/html/converters/link.rb
+- lib/coradoc/html/converters/list_item.rb
+- lib/coradoc/html/converters/listing.rb
+- lib/coradoc/html/converters/literal.rb
+- lib/coradoc/html/converters/monospace.rb
+- lib/coradoc/html/converters/open.rb
+- lib/coradoc/html/converters/ordered.rb
+- lib/coradoc/html/converters/paragraph.rb
+- lib/coradoc/html/converters/quote.rb
+- lib/coradoc/html/converters/reviewer_comment.rb
+- lib/coradoc/html/converters/reviewer_note.rb
+- lib/coradoc/html/converters/section.rb
+- lib/coradoc/html/converters/sidebar.rb
+- lib/coradoc/html/converters/source.rb
+- lib/coradoc/html/converters/source_code.rb
+- lib/coradoc/html/converters/span.rb
+- lib/coradoc/html/converters/strikethrough.rb
+- lib/coradoc/html/converters/subscript.rb
+- lib/coradoc/html/converters/superscript.rb
+- lib/coradoc/html/converters/table.rb
+- lib/coradoc/html/converters/table_cell.rb
+- lib/coradoc/html/converters/table_row.rb
+- lib/coradoc/html/converters/template_html_converter.rb
+- lib/coradoc/html/converters/term.rb
+- lib/coradoc/html/converters/text_element.rb
+- lib/coradoc/html/converters/underline.rb
+- lib/coradoc/html/converters/unordered.rb
+- lib/coradoc/html/converters/verse.rb
+- lib/coradoc/html/converters/video.rb
+- lib/coradoc/html/element_mapping.rb
+- lib/coradoc/html/entity.rb
+- lib/coradoc/html/input.rb
+- lib/coradoc/html/input/cleaner.rb
+- lib/coradoc/html/input/config.rb
+- lib/coradoc/html/input/converters.rb
+- lib/coradoc/html/input/converters/a.rb
+- lib/coradoc/html/input/converters/aside.rb
+- lib/coradoc/html/input/converters/audio.rb
+- lib/coradoc/html/input/converters/base.rb
+- lib/coradoc/html/input/converters/blockquote.rb
+- lib/coradoc/html/input/converters/br.rb
+- lib/coradoc/html/input/converters/bypass.rb
+- lib/coradoc/html/input/converters/code.rb
+- lib/coradoc/html/input/converters/div.rb
+- lib/coradoc/html/input/converters/dl.rb
+- lib/coradoc/html/input/converters/drop.rb
+- lib/coradoc/html/input/converters/em.rb
+- lib/coradoc/html/input/converters/figure.rb
+- lib/coradoc/html/input/converters/h.rb
+- lib/coradoc/html/input/converters/head.rb
+- lib/coradoc/html/input/converters/hr.rb
+- lib/coradoc/html/input/converters/ignore.rb
+- lib/coradoc/html/input/converters/img.rb
+- lib/coradoc/html/input/converters/li.rb
+- lib/coradoc/html/input/converters/mark.rb
+- lib/coradoc/html/input/converters/markup.rb
+- lib/coradoc/html/input/converters/math.rb
+- lib/coradoc/html/input/converters/ol.rb
+- lib/coradoc/html/input/converters/p.rb
+- lib/coradoc/html/input/converters/pass_through.rb
+- lib/coradoc/html/input/converters/pre.rb
+- lib/coradoc/html/input/converters/q.rb
+- lib/coradoc/html/input/converters/strong.rb
+- lib/coradoc/html/input/converters/sub.rb
+- lib/coradoc/html/input/converters/sup.rb
+- lib/coradoc/html/input/converters/table.rb
+- lib/coradoc/html/input/converters/td.rb
+- lib/coradoc/html/input/converters/text.rb
+- lib/coradoc/html/input/converters/th.rb
+- lib/coradoc/html/input/converters/tr.rb
+- lib/coradoc/html/input/converters/video.rb
+- lib/coradoc/html/input/errors.rb
+- lib/coradoc/html/input/html_converter.rb
+- lib/coradoc/html/input/plugin.rb
+- lib/coradoc/html/input/plugins/plateau.rb
+- lib/coradoc/html/input/postprocessor.rb
+- lib/coradoc/html/output.rb
+- lib/coradoc/html/renderer.rb
+- lib/coradoc/html/spa.rb
+- lib/coradoc/html/static.rb
+- lib/coradoc/html/template_config.rb
+- lib/coradoc/html/template_helpers.rb
+- lib/coradoc/html/template_locator.rb
+- lib/coradoc/html/theme.rb
+- lib/coradoc/html/theme/base.rb
+- lib/coradoc/html/theme/classic_renderer.rb
+- lib/coradoc/html/theme/modern/components/ui_components.rb
+- lib/coradoc/html/theme/modern/css_generator.rb
+- lib/coradoc/html/theme/modern/javascript_generator.rb
+- lib/coradoc/html/theme/modern/serializers/document_serializer.rb
+- lib/coradoc/html/theme/modern/tailwind_config_builder.rb
+- lib/coradoc/html/theme/modern/vue_template_generator.rb
+- lib/coradoc/html/theme/modern_renderer.rb
+- lib/coradoc/html/theme/registry.rb
+- lib/coradoc/html/transform/from_core_model.rb
+- lib/coradoc/html/transform/to_core_model.rb
+- lib/coradoc/html/version.rb
+homepage: https://github.com/metanorma/coradoc
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/metanorma/coradoc
+  source_code_uri: https://github.com/metanorma/coradoc
+  changelog_uri: https://github.com/metanorma/coradoc/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: HTML input/output converters for Coradoc
+test_files: []