commenter 0.3.0 → 0.4.0

data/spec/support/redline_docx_builder.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "zip"
+
+# Builds minimal redline DOCX files for specs, without binary fixtures. The
+# document body is assembled from a paragraph DSL:
+#
+#   { heading: "1", level: 1, text: "Scope" }
+#   { text: "Body text " }
+#   { change: :ins, id: "1", author: "CHEN Yvonne", date: "2025-12-05T20:10:00Z",
+#     text: "inserted" }
+#   { marker: true }  # self-closing paragraph-mark insertion inside rPr
+#   { anchor: "74", text: "Anchored text" }  # w:commentRangeStart/End around text
+#
+# Multiple entries in one paragraph can be given via :parts.
+#
+# comments: [{ id: "74", author: "CHEN Yvonne", date: "...", text: "remark" }]
+# are written to word/comments.xml.
+module RedlineDocxBuilder
+  W_NS = "http://schemas.openxmlformats.org/wordprocessingml/2006/main"
+  private_constant :W_NS
+
+  HEADING_LEVEL_STYLE = { 1 => "Heading1", 2 => "Heading2", 3 => "Heading3" }.freeze
+  CHANGE_TAG = { ins: "w:ins", del: "w:del", moveFrom: "w:moveFrom", moveTo: "w:moveTo" }.freeze
+  private_constant :HEADING_LEVEL_STYLE, :CHANGE_TAG
+
+  def self.write(path, paragraphs, comments: [])
+    # Written via an in-memory buffer and File.binwrite rather than
+    # Zip::File#create + close: rubyzip commits the latter with File.rename,
+    # which fails with EACCES on Windows when the caller still holds an open
+    # handle on the destination (e.g. an unclosed Tempfile).
+    buffer = Zip::OutputStream.write_buffer do |out|
+      out.put_next_entry("word/document.xml")
+      out.write(document_xml(paragraphs))
+      out.put_next_entry("word/comments.xml")
+      out.write(comments_xml(comments))
+    end
+    File.binwrite(path, buffer.string)
+    path
+  end
+
+  def self.document_xml(paragraphs)
+    <<~XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <w:document xmlns:w="#{W_NS}"><w:body>#{paragraphs.map { |p| paragraph_xml(p) }.join}</w:body></w:document>
+    XML
+  end
+
+  def self.comments_xml(comments)
+    entries = comments.map do |c|
+      attrs = %(w:id="#{c[:id]}" w:author="#{c[:author]}" w:date="#{c[:date]}" w:initials="X")
+      %(<w:comment #{attrs}><w:p><w:r><w:t>#{c[:text]}</w:t></w:r></w:p></w:comment>)
+    end
+
+    <<~XML
+      <?xml version="1.0" encoding="UTF-8"?>
+      <w:comments xmlns:w="#{W_NS}">#{entries.join}</w:comments>
+    XML
+  end
+
+  def self.paragraph_xml(paragraph)
+    if paragraph[:marker]
+      return %(<w:p><w:pPr><w:rPr><w:ins w:id="#{paragraph[:id]}" w:author="#{paragraph[:author]}"/></w:rPr></w:pPr></w:p>)
+    end
+
+    inner = if paragraph[:parts]
+              paragraph[:parts].map { |part| part_xml(part) }.join
+            elsif paragraph[:heading]
+              %(<w:r><w:t>#{paragraph[:text]}</w:t></w:r>)
+            elsif paragraph[:change]
+              change_xml(paragraph)
+            else
+              %(<w:r><w:t>#{paragraph[:text]}</w:t></w:r>)
+            end
+
+    ppr = paragraph[:heading] ? %(<w:pPr><w:pStyle w:val="#{HEADING_LEVEL_STYLE.fetch(paragraph[:level], 1)}"/></w:pPr>) : ""
+    anchor = paragraph[:anchor] ? %(<w:commentRangeStart w:id="#{paragraph[:anchor]}"/>) : ""
+    anchor_end = paragraph[:anchor] ? %(<w:commentRangeEnd w:id="#{paragraph[:anchor]}"/>) : ""
+    "<w:p>#{ppr}#{anchor}#{inner}#{anchor_end}</w:p>"
+  end
+
+  def self.part_xml(part)
+    part[:change] ? change_xml(part) : %(<w:r><w:t>#{part[:text]}</w:t></w:r>)
+  end
+
+  def self.change_xml(change)
+    tag = CHANGE_TAG.fetch(change[:change])
+    attrs = %(w:id="#{change[:id]}" w:author="#{change[:author]}" w:date="#{change[:date]}")
+
+    return %(<#{tag} #{attrs}>#{change[:nested].map { |child| change_xml(child) }.join}</#{tag}>) if change[:nested]
+
+    text_tag = change[:change] == :del ? "w:delText" : "w:t"
+    %(<#{tag} #{attrs}><w:r><#{text_tag}>#{change[:text]}</#{text_tag}></w:r></#{tag}>)
+  end
+end

data/spec/support/xlsx_builder.rb

@@ -18,22 +18,27 @@ module XlsxBuilder
     shared = []
     worksheets = sheets.map { |name, rows| [name, worksheet_xml(rows, shared)] }
 
-    zip = Zip::File.new(path, create: true)
-    write_entry(zip, "[Content_Types].xml", content_types_xml(worksheets.size))
-    write_entry(zip, "_rels/.rels", root_rels_xml)
-    write_entry(zip, "xl/workbook.xml", workbook_xml(worksheets.map(&:first)))
-    write_entry(zip, "xl/_rels/workbook.xml.rels", workbook_rels_xml(worksheets.size))
-    write_entry(zip, "xl/sharedStrings.xml", shared_strings_xml(shared))
-    write_entry(zip, "xl/styles.xml", styles_xml)
-    worksheets.each_with_index do |(_name, xml), index|
-      write_entry(zip, "xl/worksheets/sheet#{index + 1}.xml", xml)
+    # In-memory buffer + File.binwrite rather than Zip::File#create + close:
+    # rubyzip commits the latter with File.rename, which fails with EACCES on
+    # Windows when the caller still holds an open handle on the destination.
+    buffer = Zip::OutputStream.write_buffer do |out|
+      write_entry(out, "[Content_Types].xml", content_types_xml(worksheets.size))
+      write_entry(out, "_rels/.rels", root_rels_xml)
+      write_entry(out, "xl/workbook.xml", workbook_xml(worksheets.map(&:first)))
+      write_entry(out, "xl/_rels/workbook.xml.rels", workbook_rels_xml(worksheets.size))
+      write_entry(out, "xl/sharedStrings.xml", shared_strings_xml(shared))
+      write_entry(out, "xl/styles.xml", styles_xml)
+      worksheets.each_with_index do |(_name, xml), index|
+        write_entry(out, "xl/worksheets/sheet#{index + 1}.xml", xml)
+      end
     end
-    zip.close
+    File.binwrite(path, buffer.string)
     path
   end
 
-  def self.write_entry(zip, name, content)
-    zip.get_output_stream(name) { |stream| stream.write(content) }
+  def self.write_entry(out, name, content)
+    out.put_next_entry(name)
+    out.write(content)
   end
 
   def self.worksheet_xml(rows, shared)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commenter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-08-26 00:00:00.000000000 Z
+date: 2026-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +139,7 @@ files:
 - ".rubocop_todo.yml"
 - CLAUDE.md
 - CODE_OF_CONDUCT.md
+- CONTEXT.md
 - Gemfile
 - README.adoc
 - Rakefile
@@ -136,25 +151,40 @@ files:
 - data/iso_comment_template_2012-03.docx
 - exe/commenter
 - lib/commenter.rb
+- lib/commenter/ballot.rb
+- lib/commenter/ballot_report.rb
 - lib/commenter/cli.rb
 - lib/commenter/comment.rb
+- lib/commenter/comment_locality.rb
 - lib/commenter/comment_sheet.rb
+- lib/commenter/comment_type.rb
+- lib/commenter/disposition_status.rb
 - lib/commenter/filler.rb
+- lib/commenter/github_info.rb
 - lib/commenter/github_integration.rb
+- lib/commenter/github_session.rb
 - lib/commenter/parser.rb
 - lib/commenter/parser/osd_xlsx_parser.rb
+- lib/commenter/parser/track_change_docx_parser.rb
 - lib/commenter/version.rb
 - schema/iso_comment_2012-03.yaml
 - schema/iso_comment_osd.yaml
 - sig/commenter.rbs
+- spec/commenter/ballot_report_spec.rb
+- spec/commenter/ballot_spec.rb
 - spec/commenter/cli_spec.rb
 - spec/commenter/comment_sheet_spec.rb
 - spec/commenter/comment_spec.rb
+- spec/commenter/comment_type_spec.rb
+- spec/commenter/disposition_status_spec.rb
+- spec/commenter/filler_spec.rb
 - spec/commenter/github_integration_spec.rb
 - spec/commenter/osd_xlsx_parser_spec.rb
+- spec/commenter/track_change_docx_parser_spec.rb
 - spec/commenter_spec.rb
 - spec/spec_helper.rb
 - spec/support/osd_fixtures.rb
+- spec/support/redline_docx_builder.rb
 - spec/support/xlsx_builder.rb
 homepage: https://github.com/metanorma/commenter
 licenses: