commenter 0.3.1 → 0.5.0

data/spec/commenter/filler_spec.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "nokogiri"
+require "zip"
+
+RSpec.describe Commenter::Filler do
+  let(:template_path) { File.expand_path("../../data/iso_comment_template_2012-03.docx", __dir__) }
+
+  def comment(attrs)
+    Commenter::Comment.new({ body: "US", type: "technical", comments: "Text" }.merge(attrs))
+  end
+
+  def header_xml(output_path)
+    Zip::File.open(output_path) do |zip|
+      zip.entries.find { |entry| entry.name == "word/header2.xml" }.get_input_stream(&:read)
+    end
+  end
+
+  def body_xml(output_path)
+    Zip::File.open(output_path) do |zip|
+      zip.entries.find { |entry| entry.name == "word/document.xml" }.get_input_stream(&:read)
+    end
+  end
+
+  # Rows of the comment table as arrays of cell text. Read via Nokogiri over
+  # the extracted XML rather than Docx::Document, whose open zip handle keeps
+  # the file locked on Windows and breaks Dir.mktmpdir teardown.
+  def body_rows(output_path)
+    document = Nokogiri::XML(body_xml(output_path))
+    document.xpath("//w:tbl").flat_map { |table| table.xpath("./w:tr") }.map do |row|
+      row.xpath("./w:tc").map { |cell| cell.xpath(".//w:t").map(&:text).join }
+    end
+  end
+
+  it "writes comment rows into the template table" do
+    Dir.mktmpdir do |dir|
+      output = File.join(dir, "filled.docx")
+      described_class.new.fill(template_path, output, [
+                                 comment(id: "US-001", locality: { clause: "5.2.1", element: "Table 3", line_number: "45" },
+                                         proposed_change: "Fix them", observations: "Accepted")
+                               ])
+
+      row = body_rows(output).first
+      expect(row[0]).to include("US-001")
+      expect(row[1]).to include("45")
+      expect(row[2]).to include("5.2.1")
+      expect(row[3]).to include("Table 3")
+      expect(row[4]).to include("technical")
+      expect(row[5]).to include("Text")
+      expect(row[6]).to include("Fix them")
+      expect(row[7]).to include("Accepted")
+    end
+  end
+
+  it "keeps multiple comments in input order and accepts plain hashes" do
+    Dir.mktmpdir do |dir|
+      output = File.join(dir, "filled.docx")
+      described_class.new.fill(template_path, output, [
+                                 { "id" => "DE-001", "comments" => "First" },
+                                 comment(id: "US-001", comments: "Second")
+                               ])
+
+      rows = body_rows(output)
+      expect(rows.length).to eq(2)
+      expect(rows[0][0]).to include("DE-001")
+      expect(rows[1][0]).to include("US-001")
+    end
+  end
+
+  it "fills the header metadata labels in the page header" do
+    Dir.mktmpdir do |dir|
+      output = File.join(dir, "filled.docx")
+      described_class.new.fill(template_path, output, [comment(id: "US-001")],
+                               date: "2026-08-28", document: "ISO 2533:2026", project: "Ballot review")
+
+      header = header_xml(output)
+      expect(header).to include("Date: 2026-08-28")
+      expect(header).to include("Document: ISO 2533:2026")
+      expect(header).to include("Project: Ballot review")
+    end
+  end
+
+  it "leaves header labels untouched when no metadata is given" do
+    Dir.mktmpdir do |dir|
+      output = File.join(dir, "filled.docx")
+      described_class.new.fill(template_path, output, [comment(id: "US-001")])
+
+      header = header_xml(output)
+      expect(header).to include(">Date: <")
+      expect(header).to include(">Document:<")
+      expect(header).to include(">Project:<")
+    end
+  end
+
+  it "escapes XML special characters in metadata values" do
+    Dir.mktmpdir do |dir|
+      output = File.join(dir, "filled.docx")
+      described_class.new.fill(template_path, output, [comment(id: "US-001")],
+                               document: "A&B <standard>")
+
+      expect(header_xml(output)).to include("Document: A&amp;B &lt;standard&gt;")
+    end
+  end
+
+  it "shades observation cells according to disposition status" do
+    Dir.mktmpdir do |dir|
+      output = File.join(dir, "filled.docx")
+      described_class.new.fill(template_path, output, [
+                                 comment(id: "US-001", observations: "Accepted"),
+                                 comment(id: "US-002", observations: "Not accepted")
+                               ], shading: true)
+
+      xml = body_xml(output)
+      expect(xml).to include('w:fill="92D050"')
+      expect(xml).to include('w:fill="FF99CC"')
+    end
+  end
+end

data/spec/commenter/github_sync_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require "tempfile"
+
+RSpec.describe Commenter::GitHubSync do
+  describe ".reconcile_actions" do
+    def actions(**overrides)
+      described_class.reconcile_actions(
+        issue: { title: "Title", body: "Body", state: "open" },
+        rendered: { title: "Title", body: "Body" },
+        disposition: nil,
+        **overrides
+      )
+    end
+
+    it "reports nothing when the issue is in sync" do
+      expect(actions).to eq([])
+    end
+
+    it "re-renders differing content under the yaml policy" do
+      expect(actions(conflict: "yaml", issue: { title: "Title", body: "Old body", state: "open" })).to eq([:update_content])
+    end
+
+    it "keeps differing GitHub content under the github policy" do
+      expect(actions(conflict: "github", issue: { title: "Title", body: "Edited on GitHub", state: "open" }))
+        .to eq([:keep_github_content])
+    end
+
+    it "reports a conflict under the skip policy" do
+      expect(actions(conflict: "skip", issue: { title: "Edited on GitHub", body: "Body", state: "open" })).to eq([:conflict])
+    end
+
+    it "closes an open issue whose comment has a disposition" do
+      expect(actions(disposition: "Accepted.")).to eq([:close])
+    end
+
+    it "combines content update and close" do
+      expect(actions(issue: { title: "Title", body: "Old", state: "open" }, disposition: "Accepted.")).to eq(%i[update_content close])
+    end
+
+    it "does not close a closed issue, an undispositioned comment, or when disabled" do
+      expect(actions(disposition: "Accepted.", issue: { title: "Title", body: "Body", state: "closed" })).to eq([])
+      expect(actions(disposition: "  ")).to eq([])
+      expect(actions(disposition: "Accepted.", close_on_disposition: false)).to eq([])
+    end
+
+    it "ignores whitespace when comparing content" do
+      expect(actions(issue: { title: "Title", body: "  Body  ", state: "open" })).to eq([])
+    end
+  end
+
+  describe "#sync dry run" do
+    let(:config_file) do
+      file = Tempfile.new(["config", ".yaml"])
+      file.write({ "github" => { "repository" => "test-org/test-repo", "token" => "test-token" } }.to_yaml)
+      file.close
+      file
+    end
+
+    def yaml_file(comments)
+      file = Tempfile.new(["comments", ".yaml"])
+      file.write({ "version" => "2012-03", "stage" => "DIS", "comments" => comments }.to_yaml)
+      file.close
+      file
+    end
+
+    after { config_file.unlink }
+
+    it "plans creation for comments without issues and closure for dispositioned open ones" do
+      input = yaml_file([
+                          { "id" => "US-001", "body" => "US", "comments" => "No issue yet" },
+                          { "id" => "US-002", "body" => "US", "comments" => "Resolved", "observations" => "Accepted.",
+                            "github" => { "issue_number" => 12, "status" => "open" } }
+                        ])
+
+      sync = described_class.new(config_file.path)
+      results = sync.sync(input.path, dry_run: true)
+
+      expect(results[0]).to eq(comment_id: "US-001", actions: [:create])
+      expect(results[1][:issue_number]).to eq(12)
+      expect(results[1][:actions]).to include(:close)
+
+      input.unlink
+    end
+  end
+end

data/spec/commenter/osd_xlsx_parser_spec.rb

@@ -27,7 +27,8 @@ RSpec.describe Commenter::Parser::OsdXlsxParser do
 
         expect(comment.id).to eq("1")
         expect(comment.body).to eq("John Doe")
-        expect(comment.locality).to eq({ clause: "5.2.1", element: "Requirements" })
+        expect(comment.locality.clause).to eq("5.2.1")
+        expect(comment.locality.element).to eq("Requirements")
         expect(comment.comments).to eq("The values in Table 3 are inconsistent.")
         expect(comment.proposed_change).to eq("Correct the values in column 2.")
         expect(comment.comment_type).to eq("Editorial")
@@ -62,7 +63,7 @@ RSpec.describe Commenter::Parser::OsdXlsxParser do
         comments = described_class.new.parse(path).comments
 
         expect(comments.length).to eq(2)
-        expect(comments.last.locality).to eq({})
+        expect(comments.last.locality.clause).to be_nil
         expect(comments.last.proposed_change).to be_nil
       end
     end

data/spec/support/redline_docx_builder.rb

@@ -25,10 +25,17 @@ module RedlineDocxBuilder
   private_constant :HEADING_LEVEL_STYLE, :CHANGE_TAG
 
   def self.write(path, paragraphs, comments: [])
-    zip = Zip::File.new(path, create: true)
-    zip.get_output_stream("word/document.xml") { |stream| stream.write(document_xml(paragraphs)) }
-    zip.get_output_stream("word/comments.xml") { |stream| stream.write(comments_xml(comments)) }
-    zip.close
+    # 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
 

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.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-08-27 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,13 +151,20 @@ files:
 - data/iso_comment_template_2012-03.docx
 - exe/commenter
 - lib/commenter.rb
+- lib/commenter/ballot.rb
+- lib/commenter/ballot_diff.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/github_sync.rb
 - lib/commenter/parser.rb
 - lib/commenter/parser/osd_xlsx_parser.rb
 - lib/commenter/parser/track_change_docx_parser.rb
@@ -150,11 +172,17 @@ files:
 - schema/iso_comment_2012-03.yaml
 - schema/iso_comment_osd.yaml
 - sig/commenter.rbs
+- spec/commenter/ballot_diff_spec.rb
+- 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/github_sync_spec.rb
 - spec/commenter/osd_xlsx_parser_spec.rb
 - spec/commenter/track_change_docx_parser_spec.rb
 - spec/commenter_spec.rb