coradoc-html 1.1.16 → 1.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 969890f3d4d45ed9363c1844aebe549fe0ac92df4d39af29c7ccdb46fce8048b
-  data.tar.gz: 9892092a47521897e7b5d008673cd5b25daa324022b34ddc9558c8e462945b7b
+  metadata.gz: d5c1e5cd6e38250709afed5441270974421958870420434743ec2dcc2080ef5d
+  data.tar.gz: 1b9c0d24cc15f6b535c85c993c0d8498ccaa572bec23be5e7f0bed4cd8661c93
 SHA512:
-  metadata.gz: ced9fbc9f7325b093b3d84e463b9a91df96b95c3f1eecbdbb34d2d6a63bcd4002d3f36bfff950242a2d6c7ea7d66e8cbb880d04a7433d63ce81771b4bc9d3b89
-  data.tar.gz: 9252a74bee993a960700efbc00733fb4bfb2d6500751014d462120aa0009da045ae85de4d943e1f01a78ffbe67b530c8c191ad1e1f4e37fe9e1321bdee25341b
+  metadata.gz: 86c7504af66e3a2933bc595eb1d6f6f628cfd07377a290927460ba94b96b44f4b2adf3b52bb26a2915c93527f6414ef0a35809810bfa2b1f8bd208633ea4c257
+  data.tar.gz: e0bcaf88a1d89d6b9e23ed71a7b7e8bd4f0a467780051db981e8d833a6e43fa3cf002d96efb5e7e6cdc17f368e0f8e5773f7df4af2d06f40bb85c94fde1c53b0

data/lib/coradoc/html/converter_base.rb

@@ -49,7 +49,7 @@ module Coradoc
 
         def initialize(**options)
           self.class.configuration_attributes.each do |name, default|
-            value = options.fetch(name) { default.respond_to?(:call) ? default.call : default }
+            value = options.fetch(name) { default.is_a?(Proc) ? default.call : default }
             public_send(:"#{name}=", value)
           end
         end

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

@@ -26,13 +26,25 @@ module Coradoc
         end
 
         def text
-          if %i[source_code literal listing].include?(resolved_semantic_type)
-            Escape.escape_html(@model.flat_text)
+          if verbatim?
+            Escape.escape_html(stripped_text)
           elsif resolved_semantic_type == :pass
             @model.flat_text.to_s
           end
         end
 
+        def callouts
+          return [] unless verbatim?
+
+          @callouts ||= CoreModel::CalloutText.ordered(@model.callouts).map do |callout|
+            { 'index' => callout.index, 'content' => Escape.escape_html(callout.content.to_s) }
+          end
+        end
+
+        def callouts?
+          !callouts.empty?
+        end
+
         def hidden?
           %i[comment reviewer].include?(resolved_semantic_type)
         end
@@ -50,6 +62,14 @@ module Coradoc
         def resolved_semantic_type
           @resolved_semantic_type ||= @model.resolve_semantic_type || :paragraph
         end
+
+        def verbatim?
+          %i[source_code literal listing].include?(resolved_semantic_type)
+        end
+
+        def stripped_text
+          CoreModel::CalloutText.strip_markers(@model.flat_text.to_s, @model.callouts)
+        end
       end
 
       DropFactory.register(CoreModel::Block, BlockDrop)

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

@@ -51,22 +51,22 @@ end
 
 # Load all drops — each self-registers with DropFactory.
 # Registration order doesn't matter (sorted by ancestor depth).
-require 'coradoc/html/drop/annotation_drop'
-require 'coradoc/html/drop/block_drop'
-require 'coradoc/html/drop/list_block_drop'
-require 'coradoc/html/drop/list_item_drop'
-require 'coradoc/html/drop/table_drop'
-require 'coradoc/html/drop/table_row_drop'
-require 'coradoc/html/drop/table_cell_drop'
-require 'coradoc/html/drop/image_drop'
-require 'coradoc/html/drop/inline_element_drop'
-require 'coradoc/html/drop/bibliography_entry_drop'
-require 'coradoc/html/drop/bibliography_drop'
-require 'coradoc/html/drop/toc_entry_drop'
-require 'coradoc/html/drop/toc_drop'
-require 'coradoc/html/drop/definition_item_drop'
-require 'coradoc/html/drop/definition_list_drop'
-require 'coradoc/html/drop/term_drop'
-require 'coradoc/html/drop/footnote_drop'
-require 'coradoc/html/drop/text_content_drop'
-require 'coradoc/html/drop/document_drop'
+require_relative 'annotation_drop'
+require_relative 'block_drop'
+require_relative 'list_block_drop'
+require_relative 'list_item_drop'
+require_relative 'table_drop'
+require_relative 'table_row_drop'
+require_relative 'table_cell_drop'
+require_relative 'image_drop'
+require_relative 'inline_element_drop'
+require_relative 'bibliography_entry_drop'
+require_relative 'bibliography_drop'
+require_relative 'toc_entry_drop'
+require_relative 'toc_drop'
+require_relative 'definition_item_drop'
+require_relative 'definition_list_drop'
+require_relative 'term_drop'
+require_relative 'footnote_drop'
+require_relative 'text_content_drop'
+require_relative 'document_drop'

data/lib/coradoc/html/drop.rb

@@ -13,6 +13,6 @@ module Coradoc
 end
 
 # Base must load first (DropFactory depends on it)
-require 'coradoc/html/drop/base'
+require_relative 'drop/base'
 # DropFactory loads next
-require 'coradoc/html/drop/drop_factory'
+require_relative 'drop/drop_factory'

data/lib/coradoc/html/frontmatter_meta.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Coradoc
+  module Html
+    # Single source of truth for FrontmatterBlock -> HTML `<meta>` and
+    # `<link>` tag mapping. (MECE: HTML-specific concerns live in the
+    # HTML gem; CoreModel has no knowledge of HTML.)
+    #
+    # The module produces a small data structure that layout templates
+    # and Nokogiri::HTML::Builder fallbacks both consume, so we never
+    # duplicate the mapping rule across output paths (DRY).
+    #
+    # Mapping table (single source of truth — extend here only):
+    #
+    #   | Frontmatter key       | Output                                  |
+    #   |-----------------------|-----------------------------------------|
+    #   | title                 | <title> (caller decides title priority) |
+    #   | author                | <meta name="author">                    |
+    #   | description, excerpt  | <meta name="description">               |
+    #   | date                  | <meta name="date"> (ISO 8601)           |
+    #   | subject               | <meta name="subject">                   |
+    #   | tags, categories      | <meta name="keywords"> (comma-joined)   |
+    #   | $schema               | <link rel="schema.X" href="...">        |
+    #   | (any other scalar)    | <meta name="<key>" content="<value>">   |
+    module FrontmatterMeta
+      Meta = Struct.new(:name, :content, keyword_init: true)
+      LinkTag = Struct.new(:rel, :href, keyword_init: true)
+
+      DESCRIPTION_KEYS = %w[description excerpt].freeze
+      KEYWORDS_KEYS = %w[tags categories].freeze
+
+      class << self
+        # Extract a meta-tag list and link-tag list from a
+        # FrontmatterBlock. `title` is returned separately so the caller
+        # can decide precedence (e.g., document title vs. frontmatter).
+        #
+        # @param block [Coradoc::CoreModel::FrontmatterBlock, nil]
+        # @return [Hash{Symbol=>Array<Meta>,Array<LinkTag>,String,nil}]
+        #   { metas:, links:, title: }
+        def extract(block)
+          return empty_result unless block.is_a?(Coradoc::CoreModel::FrontmatterBlock)
+
+          data = block.data || {}
+          {
+            metas: build_metas(data),
+            links: build_links(block.schema),
+            title: scalar_value(data['title'])
+          }
+        end
+
+        # Emit meta + link tags into a Nokogiri head builder context.
+        def emit_into_builder(builder_doc, block)
+          data = extract(block)
+          Array(data[:metas]).each do |meta|
+            builder_doc.meta(name: meta.name, content: meta.content)
+          end
+          Array(data[:links]).each do |link|
+            builder_doc.link(rel: link.rel, href: link.href)
+          end
+          data
+        end
+
+        private
+
+        def empty_result
+          { metas: [], links: [], title: nil }
+        end
+
+        def build_metas(data)
+          metas = []
+          consumed = []
+
+          if (v = find_first_scalar(data, DESCRIPTION_KEYS))
+            metas << Meta.new(name: 'description', content: v)
+            consumed += DESCRIPTION_KEYS
+          end
+          if (v = find_first_array_as_csv(data, KEYWORDS_KEYS))
+            metas << Meta.new(name: 'keywords', content: v)
+            consumed += KEYWORDS_KEYS
+          end
+          if (v = find_first_scalar(data, %w[date]))
+            metas << Meta.new(name: 'date', content: v)
+            consumed << 'date'
+          end
+          if (v = find_first_scalar(data, %w[author]))
+            metas << Meta.new(name: 'author', content: v)
+            consumed << 'author'
+          end
+          if (v = find_first_scalar(data, %w[subject]))
+            metas << Meta.new(name: 'subject', content: v)
+            consumed << 'subject'
+          end
+
+          data.each do |key, value|
+            next if consumed.include?(key) || key == 'title'
+
+            content = scalar_value(value)
+            next if content.nil? || content.empty?
+
+            metas << Meta.new(name: key, content: content)
+          end
+
+          metas
+        end
+
+        def build_links(schema)
+          return [] unless schema && !schema.to_s.strip.empty?
+
+          [LinkTag.new(rel: 'schema.dublin_core', href: schema.to_s)]
+        end
+
+        def find_first_scalar(data, keys)
+          keys.each do |k|
+            value = data[k]
+            next if value.nil?
+
+            str = scalar_value(value)
+            return str if str && !str.empty?
+          end
+          nil
+        end
+
+        def find_first_array_as_csv(data, keys)
+          keys.each do |k|
+            value = data[k]
+            next if value.nil?
+
+            csv = array_to_csv(value)
+            return csv if csv && !csv.empty?
+          end
+          nil
+        end
+
+        def scalar_value(value)
+          return nil if value.nil?
+
+          case value
+          when String then value
+          when Integer, Float, TrueClass, FalseClass then value.to_s
+          when Date, Time, DateTime then value.iso8601
+          when Symbol then value.to_s
+          when Array then array_to_csv(value)
+          when Hash then nil
+          else value.to_s
+          end
+        end
+
+        def array_to_csv(value)
+          return nil unless value.is_a?(Array)
+
+          strings = value.map { |i| scalar_value(i) }.compact
+          strings.any? ? strings.join(', ') : nil
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/html/input.rb

@@ -2,7 +2,7 @@
 
 require 'digest'
 require 'nokogiri'
-require 'coradoc/input'
+require 'coradoc'
 
 module Coradoc
   module Input

data/lib/coradoc/html/layout_renderer.rb

@@ -53,7 +53,28 @@ module Coradoc
         opts.lang || Config::DEFAULT_LANG
       end
 
+      # Pull a leading FrontmatterBlock out of the document's children,
+      # if present. Returns nil when there isn't one.
+      def extract_frontmatter(document)
+        return nil unless document.is_a?(Coradoc::CoreModel::DocumentElement)
+
+        Array(document.children).find { |c| c.is_a?(Coradoc::CoreModel::FrontmatterBlock) }
+      end
+
+      # Filter meta_tags so caller-supplied opts (author/description)
+      # take precedence and we never emit two <meta> tags with the same
+      # name. Single source of truth for the dedup rule (DRY): both the
+      # static and SPA layout paths route through here.
+      def dedup_meta_tags(metas, opts)
+        overridden = %w[author description].each_with_object([]) do |name, acc|
+          acc << name if opts.public_send(name)
+        end
+        metas.reject { |m| overridden.include?(m.name) }
+      end
+
       def build_static_layout_data(document, body_html, opts)
+        frontmatter = extract_frontmatter(document)
+        fm_metas, fm_links = FrontmatterMeta.extract(frontmatter).values_at(:metas, :links)
         {
           'lang' => resolve_lang(opts),
           'title' => resolve_escaped_title(document),
@@ -61,17 +82,21 @@ module Coradoc
           'description' => opts.description,
           'generator_version' => Coradoc::VERSION.to_s,
           'body' => body_html,
-          'custom_css' => opts.custom_css
+          'custom_css' => opts.custom_css,
+          'meta_tags' => dedup_meta_tags(fm_metas, opts).map { |m| { 'name' => m.name, 'content' => m.content } },
+          'link_tags' => fm_links.map { |l| { 'rel' => l.rel, 'href' => l.href } }
         }
       end
 
       def build_static_fallback(document, body_html, opts)
+        frontmatter = extract_frontmatter(document)
         Nokogiri::HTML::Builder.new do |doc|
           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')
               doc.title resolve_title(document)
+              FrontmatterMeta.emit_into_builder(doc, frontmatter)
             end
             doc.body { doc << body_html }
           end
@@ -109,6 +134,8 @@ module Coradoc
       end
 
       def build_spa_layout_data(document, opts, assets, safe_json)
+        frontmatter = extract_frontmatter(document)
+        fm_metas, fm_links = FrontmatterMeta.extract(frontmatter).values_at(:metas, :links)
         {
           'lang' => resolve_lang(opts),
           'title' => resolve_escaped_title(document),
@@ -117,11 +144,14 @@ module Coradoc
           'generator_version' => Coradoc::VERSION.to_s,
           'css' => assets[:css],
           'js' => assets[:js],
-          'data' => safe_json
+          'data' => safe_json,
+          'meta_tags' => dedup_meta_tags(fm_metas, opts).map { |m| { 'name' => m.name, 'content' => m.content } },
+          'link_tags' => fm_links.map { |l| { 'rel' => l.rel, 'href' => l.href } }
         }
       end
 
       def build_spa_fallback(document, opts, assets, safe_json)
+        frontmatter = extract_frontmatter(document)
         Nokogiri::HTML::Builder.new do |doc|
           doc.html(lang: resolve_lang(opts)) do
             doc.head do
@@ -129,6 +159,7 @@ module Coradoc
               doc.meta(name: 'viewport', content: 'width=device-width, initial-scale=1.0')
               doc.meta(name: 'generator', content: "Coradoc #{Coradoc::VERSION}")
               doc.title resolve_title(document)
+              FrontmatterMeta.emit_into_builder(doc, frontmatter)
               doc.style { doc.text assets[:css] } if assets[:css]
             end
             doc.body do

data/lib/coradoc/html/output.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'coradoc/output'
+require 'coradoc'
 
 module Coradoc
   module Output

data/lib/coradoc/html/spa.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'coradoc/html/renderer'
+require_relative 'renderer'
 
 module Coradoc
   module Html

data/lib/coradoc/html/static.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'coradoc/html/renderer'
+require_relative 'renderer'
 
 module Coradoc
   module Html

data/lib/coradoc/html/transform/from_core_model.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'coradoc/core_model'
+require 'coradoc'
 
 module Coradoc
   module Html

data/lib/coradoc/html/transform/to_core_model.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require 'coradoc/core_model'
+require 'coradoc'
 
 module Coradoc
   module Html

data/lib/coradoc/html/version.rb

@@ -2,6 +2,6 @@
 
 module Coradoc
   module Html
-    VERSION = '1.1.16'
+    VERSION = '1.1.17'
   end
 end

data/lib/coradoc/html.rb

@@ -13,9 +13,9 @@ module Coradoc
 end
 
 # Load HTML input module to register with Coradoc::Input
-require 'coradoc/html/input'
+require_relative 'html/input'
 # Load HTML output module to register with Coradoc::Output
-require 'coradoc/html/output'
+require_relative 'html/output'
 
 module Coradoc
   module Html
@@ -29,7 +29,10 @@ module Coradoc
     autoload :TitleText, 'coradoc/html/title_text'
 
     # Drop layer — self-registering drops loaded via parent namespace file
-    require 'coradoc/html/drop'
+    require_relative 'html/drop'
+
+    # FrontmatterBlock -> <meta> tag mapping (HTML-specific concern)
+    autoload :FrontmatterMeta, 'coradoc/html/frontmatter_meta'
 
     # Autoload HTML output converters
     autoload :ConverterBase, 'coradoc/html/converter_base'
@@ -42,7 +45,7 @@ module Coradoc
     autoload :TemplateLocator, 'coradoc/html/template_locator'
     autoload :TemplateConfig, 'coradoc/html/template_config'
     # Side-effect: registers Liquid filters on load
-    require 'coradoc/html/template_helpers'
+    require_relative 'html/template_helpers'
     autoload :Renderer, 'coradoc/html/renderer'
     autoload :LayoutRenderer, 'coradoc/html/layout_renderer'
     autoload :RenderOptions, 'coradoc/html/render_options'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc-html
 version: !ruby/object:Gem::Version
-  version: 1.1.16
+  version: 1.1.17
 platform: ruby
 authors:
 - Ribose Inc.
@@ -143,6 +143,7 @@ files:
 - lib/coradoc/html/drop/toc_drop.rb
 - lib/coradoc/html/drop/toc_entry_drop.rb
 - lib/coradoc/html/escape.rb
+- lib/coradoc/html/frontmatter_meta.rb
 - lib/coradoc/html/input.rb
 - lib/coradoc/html/input/cleaner.rb
 - lib/coradoc/html/input/config.rb