coradoc-docx 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c3d4bb0be28a10758044449cbd23105ebf3b954813322561ae3f338af085e4a
-  data.tar.gz: 8fed48bf56249e71de9e8117f4345f25f6828558c3a1067ee37a786fa52e8506
+  metadata.gz: b2d3e5bd2f76d67000623cf3a2cb3889d5b49105a7420494f6f09622bac8a61b
+  data.tar.gz: 2c611f389f427ac79c73b5ce6e727e602b1d392f97f6090af837d2c6a5d05d9a
 SHA512:
-  metadata.gz: b9ea07f47f7468155c3c3aa4e502284193c54609006ffb2768659fca3f0e77e8abd4edb7274bf07a6cf50f06c5922bd119d966f9ba5dfa1de419c65833619537
-  data.tar.gz: f323b453647188ac9ffb716c82263e9bb13bce2ca24efdb6eead3562f01925f07769d39d6f369de37d14e1ef464ea47d07369bbbcf716fb467f5d22ab5c8eceb
+  metadata.gz: faff02134845b773db02e2e8e8f4a0f99e58548b013db9ad99212fe349f1e8be7088fc153465bb32b54c584c05030d24c8cc5a07dbf0e8365ab2cd3368ed5bc6
+  data.tar.gz: 308659e8aaee319757fb35fd19abf69296aebe00e8d31d4405b9d262454cd1e8e020aed702a6ab043664dd13e64670bf2758bcfda41ef7c80115d6c02d4f513b

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

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

@@ -82,57 +82,26 @@ module Coradoc
         private
 
         def transform_structural_element(element)
-          case element.element_type
-          when 'document'
-            transform_document(element)
-          when 'section'
-            transform_section(element)
-          else
-            transform_section(element)
-          end
+          transform_document(element)
         end
 
         def transform_document(element)
           doc = Uniword::Builder::DocumentBuilder.new
           doc.title(element.title) if element.title
 
+          FrontmatterCoreProperties.apply(doc, FrontmatterCoreProperties.extract(element))
+
           transform_children(element.children, doc)
 
           doc.build
         end
 
-        def transform_section(element)
-          paragraphs = []
-
-          paragraphs << build_heading(element.title, level: element.heading_level) if element.title
-
-          element.children&.each do |child|
-            case child
-            when Coradoc::CoreModel::StructuralElement
-              paragraphs << transform_section(child)
-            when Coradoc::CoreModel::AnnotationBlock
-              paragraphs << transform_annotation_block(child)
-            when Coradoc::CoreModel::Block
-              paragraphs << build_ooxml_paragraph(child)
-            when Coradoc::CoreModel::ListBlock
-              paragraphs.concat(build_ooxml_list(child))
-            when Coradoc::CoreModel::Table
-              paragraphs << build_ooxml_table(child)
-            when Coradoc::CoreModel::Image
-              paragraphs << build_ooxml_image(child)
-            end
-          end
-
-          paragraphs
-        end
-
         def transform_block(block)
-          case block.element_type
-          when 'page_break'
+          semantic = block.resolve_semantic_type
+          case semantic
+          when :page_break
             build_page_break
-          when 'paragraph', nil
-            build_ooxml_paragraph(block)
-          when 'comment'
+          when :comment
             nil
           else
             build_ooxml_paragraph(block)
@@ -206,8 +175,8 @@ module Coradoc
         end
 
         def add_block_to_builder(block, builder)
-          case block.element_type
-          when 'page_break'
+          case block.resolve_semantic_type
+          when :page_break
             builder.page_break
           else
             add_paragraph_to_builder(block, builder)
@@ -224,10 +193,12 @@ module Coradoc
         def add_paragraph_to_builder(block, builder)
           content = block.renderable_content
 
-          if content.is_a?(Array) && content.any? { |c| !c.is_a?(String) }
+          if content.is_a?(Array) && content.any? { |c| !c.is_a?(Coradoc::CoreModel::TextContent) }
             builder.paragraph do |p|
               content.each do |child|
                 case child
+                when Coradoc::CoreModel::TextContent
+                  p << child.text
                 when String
                   p << child
                 when Coradoc::CoreModel::InlineElement
@@ -242,7 +213,7 @@ module Coradoc
         end
 
         def add_list_to_builder(list_block, builder)
-          list_method = list_block.marker_type == 'numbered' ? :numbered_list : :bullet_list
+          list_method = list_block.marker_type == 'ordered' ? :numbered_list : :bullet_list
 
           if list_method == :numbered_list
             builder.numbered_list do |list|
@@ -300,9 +271,9 @@ module Coradoc
           if content.is_a?(Array)
             content.each do |child|
               case child
-              when String
+              when Coradoc::CoreModel::TextContent
                 run = Uniword::Wordprocessingml::Run.new
-                run.text = Uniword::Wordprocessingml::Text.new(content: child)
+                run.text = Uniword::Wordprocessingml::Text.new(content: child.text)
                 para.runs << run
               when Coradoc::CoreModel::InlineElement
                 para.runs << build_ooxml_run(child)

data/lib/coradoc/docx/transform/frontmatter_core_properties.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Coradoc
+  module Docx
+    module Transform
+      # Single source of truth for FrontmatterBlock -> OOXML core
+      # properties mapping. (MECE: DOCX-specific concerns live in the
+      # DOCX gem; CoreModel has no knowledge of OOXML.)
+      #
+      # Uniword's DocumentBuilder exposes setter methods (title, author,
+      # subject, keywords, description, date_field) that write the
+      # docProps/core.xml Dublin Core elements. This module reads
+      # FrontmatterBlock entries and invokes the right setters, so the
+      # mapping table lives in exactly one place.
+      #
+      # Mapping table (single source of truth):
+      #
+      #   | Frontmatter key       | OOXML element        | Builder method |
+      #   |-----------------------|----------------------|----------------|
+      #   | title                 | dc:title             | title          |
+      #   | author                | dc:creator           | author         |
+      #   | date                  | dc:date              | created        |
+      #   | description, excerpt  | dc:description       | description    |
+      #   | subject               | dc:subject           | subject        |
+      #   | tags, categories      | cp:keywords          | keywords       |
+      module FrontmatterCoreProperties
+        DESCRIPTION_KEYS = %w[description excerpt].freeze
+        KEYWORDS_KEYS = %w[tags categories].freeze
+
+        class << self
+          # Apply FrontmatterBlock data to a Uniword DocumentBuilder.
+          # Skips nil/empty values. Does not overwrite builder values
+          # that the caller has set explicitly (caller invokes this
+          # AFTER setting document.title, for example).
+          #
+          # @param builder [Uniword::Builder::DocumentBuilder]
+          # @param block [Coradoc::CoreModel::FrontmatterBlock, nil]
+          # @return [void]
+          def apply(builder, block)
+            return unless block.is_a?(Coradoc::CoreModel::FrontmatterBlock)
+
+            data = block.data || {}
+
+            if (v = find_first_scalar(data, KEYWORDS_KEYS))
+              builder.keywords(v)
+            end
+            if (v = find_first_scalar(data, %w[author]))
+              builder.author(v)
+            end
+            if (v = find_first_scalar(data, %w[subject]))
+              builder.subject(v)
+            end
+            if (v = find_first_scalar(data, DESCRIPTION_KEYS))
+              builder.description(v)
+            end
+            if (v = find_first_scalar(data, %w[date]))
+              builder.created(v)
+            end
+          end
+
+          # Locate the FrontmatterBlock in a DocumentElement's children,
+          # if any.
+          #
+          # @param document [Coradoc::CoreModel::DocumentElement]
+          # @return [Coradoc::CoreModel::FrontmatterBlock, nil]
+          def extract(document)
+            return nil unless document.is_a?(Coradoc::CoreModel::DocumentElement)
+
+            Array(document.children).find { |c| c.is_a?(Coradoc::CoreModel::FrontmatterBlock) }
+          end
+
+          private
+
+          def find_first_scalar(data, keys)
+            keys.each do |k|
+              value = data[k.to_s]
+              next if value.nil?
+
+              str = scalar_value(value)
+              return str if str && !str.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)
+            strings = value.map { |i| scalar_value(i) }.compact
+            strings.any? ? strings.join(', ') : nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/coradoc/docx/transform/numbering_resolver.rb

@@ -112,13 +112,13 @@ module Coradoc
 
         def marker_type_for(fmt)
           case fmt
-          when 'decimal' then 'numbered'
+          when 'decimal' then 'ordered'
           when 'lowerLetter' then 'lower_alpha'
           when 'upperLetter' then 'upper_alpha'
           when 'lowerRoman' then 'lower_roman'
           when 'upperRoman' then 'upper_roman'
-          when 'bullet' then 'asterisk'
-          else 'numbered'
+          when 'bullet' then 'unordered'
+          else 'ordered'
           end
         end
       end

data/lib/coradoc/docx/transform/ordered_content.rb

@@ -21,12 +21,24 @@ module Coradoc
           order = paragraph.is_a?(Uniword::Wordprocessingml::Paragraph) ? paragraph.element_order : nil
 
           if order && !order.empty?
-            transform_ordered(paragraph, order, context)
+            wrap_text_children(transform_ordered(paragraph, order, context))
           else
-            transform_sequential(paragraph, context)
+            wrap_text_children(transform_sequential(paragraph, context))
           end
         end
 
+        # Wrap raw strings in TextContent so all children are Base instances.
+        #
+        # @param items [Array] mixed Strings and CoreModel::Base
+        # @return [Array<CoreModel::Base>]
+        def wrap_text_children(items)
+          items.map do |item|
+            next nil if item.nil?
+
+            item.is_a?(String) ? CoreModel::TextContent.new(text: item) : item
+          end.compact
+        end
+
         # Flatten children array to plain text string.
         #
         # @param children [Array] mixed content (Strings, InlineElements, Blocks)
@@ -34,7 +46,7 @@ module Coradoc
         def extract_plain_text(children)
           children.map do |c|
             case c
-            when String then c
+            when CoreModel::TextContent then c.text
             when CoreModel::InlineElement then c.content.to_s
             when CoreModel::Block then c.content.to_s
             else c.to_s

data/lib/coradoc/docx/transform/rules/break_rule.rb

@@ -16,7 +16,7 @@ module Coradoc
 
           def apply(brk, _context)
             if brk.type == 'page'
-              Coradoc::CoreModel::Block.new(element_type: 'page_break')
+              Coradoc::CoreModel::Block.new(block_semantic_type: 'page_break')
             else
               Coradoc::CoreModel::InlineElement.new(
                 format_type: 'hard_line_break'

data/lib/coradoc/docx/transform/rules/heading_rule.rb

@@ -25,8 +25,7 @@ module Coradoc
             title = extract_title(paragraph, context)
             id = extract_bookmark_id(paragraph)
 
-            CoreModel::StructuralElement.new(
-              element_type: 'section',
+            CoreModel::SectionElement.new(
               level: level,
               title: title,
               id: id

data/lib/coradoc/docx/transform/rules/math_rule.rb

@@ -23,8 +23,7 @@ module Coradoc
             latex = omml_to_latex(element)
 
             if display_math?(element)
-              CoreModel::Block.new(
-                element_type: 'block',
+              CoreModel::PassBlock.new(
                 delimiter_type: '++++',
                 language: 'latexmath',
                 content: latex

data/lib/coradoc/docx/transform/rules/paragraph_rule.rb

@@ -32,7 +32,7 @@ module Coradoc
             id = extract_bookmark_id(paragraph)
 
             block = CoreModel::Block.new(
-              element_type: block_type,
+              block_semantic_type: block_type,
               content: extract_plain_text(children)
             )
             block.children = children

data/lib/coradoc/docx/transform/style_resolver.rb

@@ -94,7 +94,12 @@ module Coradoc
           return false unless paragraph.properties
 
           num_id = paragraph.properties.num_id
-          num_id.to_i.positive?
+          # Uniword (via lutaml-model) returns an UninitializedClass
+          # sentinel for attributes that weren't deserialized from source.
+          # Treat anything that isn't a real Integer as "no list id".
+          return false unless num_id.is_a?(Integer)
+
+          num_id.positive?
         end
 
         # Check if paragraph has a specific role based on style name

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

@@ -56,8 +56,7 @@ module Coradoc
             children.shift
           end
 
-          doc = Coradoc::CoreModel::StructuralElement.new(
-            element_type: 'document',
+          doc = Coradoc::CoreModel::DocumentElement.new(
             title: doc_title,
             children: children
           )
@@ -147,7 +146,7 @@ module Coradoc
           else
             # Standalone section break → thematic break
             Coradoc::CoreModel::Block.new(
-              element_type: 'thematic_break'
+              block_semantic_type: 'thematic_break'
             )
           end
         end

data/lib/coradoc/docx/transform.rb

@@ -11,6 +11,7 @@ module Coradoc
       autoload :StyleResolver, 'coradoc/docx/transform/style_resolver'
       autoload :NumberingResolver, 'coradoc/docx/transform/numbering_resolver'
       autoload :OrderedContent, 'coradoc/docx/transform/ordered_content'
+      autoload :FrontmatterCoreProperties, 'coradoc/docx/transform/frontmatter_core_properties'
 
       # Element transform rules
       module Rules

data/lib/coradoc/docx/version.rb

@@ -2,6 +2,6 @@
 
 module Coradoc
   module Docx
-    VERSION = '0.1.0'
+    VERSION = '0.1.3'
   end
 end

data/lib/coradoc/docx.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'coradoc'
-require 'coradoc/core_model'
 require 'uniword'
 
 # Coradoc::Docx provides DOCX (OOXML) format support for Coradoc.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coradoc-docx
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Ribose Inc.
@@ -103,10 +103,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.adoc
+- Rakefile
 - lib/coradoc/docx.rb
 - lib/coradoc/docx/transform.rb
 - lib/coradoc/docx/transform/context.rb
 - lib/coradoc/docx/transform/from_core_model.rb
+- lib/coradoc/docx/transform/frontmatter_core_properties.rb
 - lib/coradoc/docx/transform/numbering_resolver.rb
 - lib/coradoc/docx/transform/ordered_content.rb
 - lib/coradoc/docx/transform/rule.rb
@@ -135,6 +137,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/lutaml/coradoc
   source_code_uri: https://github.com/lutaml/coradoc
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -142,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="