commenter 0.2.1 → 0.2.3

data/data/github_config_sample.yaml

@@ -0,0 +1,86 @@
+# GitHub configuration for commenter gem
+# Copy this file and customize for your project
+
+github:
+  # Repository in owner/repo format
+  repository: "owner/repo-name"
+
+  # GitHub token (recommended to use GITHUB_TOKEN environment variable instead)
+  # token: "ghp_xxxxxxxxxxxx"
+
+  # Milestone configuration
+  milestone:
+    # Use existing milestone by name
+    name: "ISO Comment Review"
+
+    # Alternative: Use existing milestone by number
+    # number: 5
+
+    # Create milestone if it doesn't exist (optional)
+    # create_if_missing: true
+    # description: "Review comments for ISO standard"
+    # due_date: "2024-12-31"
+
+  # Stage-specific milestones (optional)
+  stage_milestones:
+    WD: "Working Draft Review"
+    CD: "Committee Draft Review"
+    DIS: "DIS National Review"
+    FDIS: "Final DIS Review"
+    PRF: "Proof Review"
+    PUB: "Publication Review"
+
+  # Default labels for all issues
+  default_labels:
+    - "comment-review"
+    - "iso-standard"
+
+  # Stage-specific labels
+  stage_labels:
+    WD:
+      - "working-draft"
+      - "early-review"
+    CD:
+      - "committee-draft"
+      - "committee-review"
+    DIS:
+      - "draft-international-standard"
+      - "national-review"
+    FDIS:
+      - "final-draft"
+      - "final-review"
+    PRF:
+      - "proof-stage"
+      - "editorial"
+    PUB:
+      - "publication"
+      - "published"
+
+  # Default assignee (GitHub username)
+  default_assignee: "reviewer-handle"
+
+  # Custom template paths (optional)
+  templates:
+    # Title template for GitHub issues
+    # The {{ unique_id }} variable is required for duplicate detection
+    title: "custom_title_template.liquid"
+    body: "custom_body_template.liquid"
+
+    # Unique identifier template for duplicate detection
+    # This is rendered and used to search for existing issues
+    # Default: "[{{ stage | upcase }}] {{ comment_id }}"
+    # The unique_id is also available as {{ unique_id }} in title/body templates
+    unique_id: "[{{ stage | upcase }}] {{ comment_id }}"
+
+  # Retrieval configuration for github-retrieve command
+  retrieval:
+    # Magic comment markers to look for in GitHub issue comments
+    observation_markers:
+      - "**OBSERVATION:**"
+      - "**COMMENTER OBSERVATION:**"
+
+    # Fallback to last comment if no magic comment found
+    fallback_to_last_comment: true
+
+    # Only retrieve from closed issues (recommended)
+    closed_issues_only: true

data/data/github_issue_body_template.liquid

@@ -0,0 +1,35 @@
+# {% if stage %}[{{ stage | upcase }}] {% endif %}{{ comment_id }} {% if document %}({{ document }}){% endif %}
+
+**Stage:** {{ stage | default: "Not specified" }}
+**Document:** {{ document | default: "Not specified" }}
+**Comment type:** {{ type }} ({{ type_full_name }})
+**Member body:** {{ body }}
+
+## Location
+
+{% if clause or element or line_number %}
+{% if clause %}* **Clause:** {{ clause }}{% endif %}
+{% if element %}* **Element:** {{ element }}{% endif %}
+{% if line_number %}* **Line number:** {{ line_number }}{% endif %}
+{% else %}
+* Location not specified
+{% endif %}
+
+## Comment
+
+{{ comments | default: "No comment provided" }}
+
+{% if has_proposed_change %}
+## Proposed change
+
+{{ proposed_change }}
+{% endif %}
+
+{% if has_observations %}
+## Observations
+
+{{ observations }}
+{% endif %}
+
+---
+*Generated from ISO comment sheet via commenter gem*

data/data/github_issue_title_template.liquid

@@ -0,0 +1 @@
+{{ unique_id }}: {{ brief_summary }} {% if document %}({{ document }}){% endif %}

data/exe/commenter

@@ -4,4 +4,4 @@
 require "thor"
 require "commenter/cli"
 
-Commenter::CLI.start(ARGV)
+Commenter::Cli.start(ARGV)

data/lib/commenter/cli.rb

@@ -5,9 +5,10 @@ require "yaml"
 require "fileutils"
 require "commenter/parser"
 require "commenter/filler"
+require "commenter/github_integration"
 
 module Commenter
-  class CLI < Thor
+  class Cli < Thor
     desc "import INPUT.docx", "Convert DOCX comment sheet to YAML"
     option :output, type: :string, aliases: :o, default: "comments.yaml", desc: "Output YAML file"
     option :exclude_observations, type: :boolean, aliases: :e, desc: "Exclude observations column"
@@ -33,7 +34,8 @@ module Commenter
 
       # Only copy if source and target are different
       unless File.expand_path(schema_source) == File.expand_path(schema_target)
-        FileUtils.cp(schema_source, schema_target)
+        FileUtils.cp(schema_source,
+                     schema_target)
       end
 
       puts "Converted #{input_docx} to #{output_yaml}"
@@ -67,6 +69,140 @@ module Commenter
       puts "Filled template to #{output_docx}"
     end
 
+    desc "github-create INPUT.yaml", "Create GitHub issues from comments"
+    option :config, type: :string, aliases: :c, required: true, desc: "GitHub configuration YAML file"
+    option :output, type: :string, aliases: :o, desc: "Output YAML file (default: update original)"
+    option :stage, type: :string, desc: "Override approval stage (WD/CD/DIS/FDIS/PRF/PUB)"
+    option :milestone, type: :string, desc: "Override milestone name or number"
+    option :assignee, type: :string, desc: "Override assignee GitHub handle"
+    option :title_template, type: :string, desc: "Custom title template file"
+    option :body_template, type: :string, desc: "Custom body template file"
+    option :dry_run, type: :boolean, desc: "Preview issues without creating them"
+    def github_create(input_yaml)
+      creator = GitHubIssueCreator.new(
+        options[:config],
+        options[:title_template],
+        options[:body_template]
+      )
+
+      github_options = {
+        stage: options[:stage],
+        milestone: options[:milestone],
+        assignee: options[:assignee],
+        dry_run: options[:dry_run],
+        output: options[:output]
+      }.compact
+
+      results = creator.create_issues_from_yaml(input_yaml, github_options)
+
+      if options[:dry_run]
+        puts "DRY RUN - Preview of issues to be created:"
+        puts "=" * 50
+        results.each do |result|
+          puts "\nComment ID: #{result[:comment_id]}"
+          puts "Title: #{result[:title]}"
+          puts "Labels: #{result[:labels].join(", ")}" if result[:labels]&.any?
+          puts "Assignees: #{result[:assignees].join(", ")}" if result[:assignees]&.any?
+          puts "Milestone: #{result[:milestone]}" if result[:milestone]
+          puts "\nBody preview (first 200 chars):"
+          puts result[:body][0...200] + (result[:body].length > 200 ? "..." : "")
+          puts "-" * 30
+        end
+      else
+        puts "GitHub issue creation results:"
+        puts "=" * 40
+
+        created_count = 0
+        skipped_count = 0
+        error_count = 0
+
+        results.each do |result|
+          case result[:status]
+          when :created
+            created_count += 1
+            puts "✓ #{result[:comment_id]}: Created issue ##{result[:issue_number]}"
+            puts "  URL: #{result[:issue_url]}"
+          when :skipped
+            skipped_count += 1
+            puts "- #{result[:comment_id]}: Skipped (#{result[:message]})"
+            puts "  URL: #{result[:issue_url]}" if result[:issue_url]
+          when :error
+            error_count += 1
+            puts "✗ #{result[:comment_id]}: Error - #{result[:message]}"
+          end
+        end
+
+        puts "\nSummary:"
+        puts "Created: #{created_count}, Skipped: #{skipped_count}, Errors: #{error_count}"
+      end
+    rescue StandardError => e
+      puts "Error: #{e.message}"
+      exit 1
+    end
+
+    desc "github-retrieve INPUT.yaml", "Retrieve observations from GitHub issues"
+    option :config, type: :string, aliases: :c, required: true, desc: "GitHub configuration YAML file"
+    option :output, type: :string, aliases: :o, desc: "Output YAML file (default: update original)"
+    option :include_open, type: :boolean, desc: "Include observations from open issues"
+    option :dry_run, type: :boolean, desc: "Preview observations without updating"
+    def github_retrieve(input_yaml)
+      retriever = GitHubIssueRetriever.new(options[:config])
+
+      retrieve_options = {
+        output: options[:output],
+        include_open: options[:include_open],
+        dry_run: options[:dry_run]
+      }.compact
+
+      results = retriever.retrieve_observations_from_yaml(input_yaml, retrieve_options)
+
+      if options[:dry_run]
+        puts "DRY RUN - Preview of observations to be retrieved:"
+        puts "=" * 50
+        results.each do |result|
+          puts "\nComment ID: #{result[:comment_id]}"
+          puts "Issue ##{result[:issue_number]}: #{result[:status]}"
+          if result[:observation]
+            puts "Observation preview (first 200 chars):"
+            puts result[:observation][0...200] + (result[:observation].length > 200 ? "..." : "")
+          else
+            puts "No observation found"
+          end
+          puts "-" * 30
+        end
+      else
+        puts "GitHub observation retrieval results:"
+        puts "=" * 40
+
+        retrieved_count = 0
+        skipped_count = 0
+        error_count = 0
+
+        results.each do |result|
+          case result[:status]
+          when :retrieved
+            retrieved_count += 1
+            puts "✓ #{result[:comment_id]}: Retrieved observation from issue ##{result[:issue_number]}"
+          when :skipped
+            skipped_count += 1
+            puts "- #{result[:comment_id]}: Skipped (#{result[:message]})"
+          when :error
+            error_count += 1
+            puts "✗ #{result[:comment_id]}: Error - #{result[:message]}"
+          end
+        end
+
+        puts "\nSummary:"
+        puts "Retrieved: #{retrieved_count}, Skipped: #{skipped_count}, Errors: #{error_count}"
+
+        output_file = options[:output] || input_yaml
+        puts "Updated YAML file: #{output_file}"
+      end
+    rescue StandardError => e
+      puts "Error: #{e.message}"
+      exit 1
+    end
+
     def self.exit_on_failure?
       true
     end

data/lib/commenter/comment.rb

@@ -2,7 +2,7 @@
 
 module Commenter
   class Comment
-    attr_accessor :id, :body, :locality, :type, :comments, :proposed_change, :observations
+    attr_accessor :id, :body, :locality, :type, :comments, :proposed_change, :observations, :github
 
     def initialize(attributes = {})
       # Normalize input to symbols
@@ -11,10 +11,20 @@ module Commenter
       @id = attrs[:id]
       @body = attrs[:body]
       @locality = symbolize_keys(attrs[:locality] || {})
-      @type = attrs[:type]
+      @type = expand_comment_type(attrs[:type])
       @comments = attrs[:comments]
       @proposed_change = attrs[:proposed_change]
       @observations = attrs[:observations]
+      @github = symbolize_keys(attrs[:github] || {})
+    end
+
+    def expand_comment_type(type)
+      case type&.downcase
+      when "ge" then "general"
+      when "te" then "technical"
+      when "ed" then "editorial"
+      else type
+      end
     end
 
     def line_number
@@ -41,6 +51,63 @@ module Commenter
       @locality[:element] = value
     end
 
+    def brief_summary(max_length = 80)
+      parts = []
+
+      # Add locality information first
+      parts << "Clause #{clause}" if clause && !clause.strip.empty?
+      parts << element if element && !element.strip.empty?
+      parts << "Line #{line_number}" if line_number && !line_number.strip.empty?
+
+      locality_text = parts.join(", ")
+
+      # Add description from comment text
+      if @comments && !@comments.strip.empty?
+        # Extract first sentence or truncate
+        clean_text = @comments.strip.gsub(/\s+/, " ")
+        first_sentence = clean_text.split(/[.!?]/).first&.strip
+        description = if first_sentence && first_sentence.length < max_length
+                        first_sentence
+                      else
+                        clean_text[0...50]
+                      end
+
+        if locality_text.empty?
+          description
+        else
+          # Combine locality + description, respecting max_length
+          combined = "#{locality_text}: #{description}"
+          combined.length <= max_length ? combined : "#{locality_text}: #{description[0...(max_length - locality_text.length - 2)]}"
+        end
+      else
+        locality_text.empty? ? "No description" : locality_text
+      end
+    end
+
+    def github_issue_number
+      @github[:issue_number]
+    end
+
+    def github_issue_url
+      @github[:issue_url]
+    end
+
+    def github_status
+      @github[:status]
+    end
+
+    def github_created_at
+      @github[:created_at]
+    end
+
+    def github_updated_at
+      @github[:updated_at]
+    end
+
+    def has_github_issue?
+      !@github[:issue_number].nil?
+    end
+
     def to_h
       {
         id: @id,
@@ -49,8 +116,9 @@ module Commenter
         type: @type,
         comments: @comments,
         proposed_change: @proposed_change,
-        observations: @observations
-      }
+        observations: @observations,
+        github: @github.empty? ? nil : @github
+      }.compact
     end
 
     def to_yaml_h

data/lib/commenter/comment_sheet.rb

@@ -4,7 +4,7 @@ require_relative "comment"
 
 module Commenter
   class CommentSheet
-    attr_accessor :version, :date, :document, :project, :comments
+    attr_accessor :version, :date, :document, :project, :stage, :comments
 
     def initialize(attributes = {})
       # Normalize input to symbols
@@ -14,6 +14,7 @@ module Commenter
       @date = attrs[:date]
       @document = attrs[:document]
       @project = attrs[:project]
+      @stage = attrs[:stage]
       @comments = (attrs[:comments] || []).map { |c| c.is_a?(Comment) ? c : Comment.from_hash(c) }
     end
 
@@ -27,6 +28,7 @@ module Commenter
         date: @date,
         document: @document,
         project: @project,
+        stage: @stage,
         comments: @comments.map(&:to_h)
       }
     end
@@ -57,13 +59,13 @@ module Commenter
       hash.each_with_object({}) do |(key, value), result|
         new_key = key.to_s
         new_value = case value
-                   when Hash
-                     stringify_keys(value)
-                   when Array
-                     value.map { |item| item.is_a?(Hash) ? stringify_keys(item) : item }
-                   else
-                     value
-                   end
+                    when Hash
+                      stringify_keys(value)
+                    when Array
+                      value.map { |item| item.is_a?(Hash) ? stringify_keys(item) : item }
+                    else
+                      value
+                    end
         result[new_key] = new_value
       end
     end

data/lib/commenter/filler.rb

@@ -15,7 +15,7 @@ module Commenter
       template_row = table.rows.first
 
       # Add new rows for each comment by copying the template row
-      comments.each_with_index do |comment, index|
+      comments.each_with_index do |comment, _index|
         # Convert comment to symbol keys for consistent access
         comment_data = symbolize_keys(comment)
 
@@ -24,7 +24,7 @@ module Commenter
           new_row = template_row.copy
           new_row.insert_before(template_row)
           row = new_row
-        rescue => e
+        rescue StandardError => e
           puts "Warning: Could not add row for comment #{comment_data[:id]}: #{e.message}"
           next
         end
@@ -64,27 +64,25 @@ module Commenter
         paragraph.each_text_run do |text_run|
           # Get current text and substitute it with new text
           current_text = text_run.text
-          if current_text && !current_text.empty?
-            text_run.substitute(current_text, text)
-            text_set = true
-            return # Only substitute in the first text run found
-          end
+          next unless current_text && !current_text.empty?
+
+          text_run.substitute(current_text, text)
+          text_set = true
+          return # Only substitute in the first text run found
         end
       end
 
       # If no text runs with content were found, add text to the first paragraph
-      unless text_set
-        if cell.paragraphs.any?
-          paragraph = cell.paragraphs.first
-          # Try to add a text run to the paragraph
-          if paragraph.respond_to?(:add_text)
-            paragraph.add_text(text)
-          elsif paragraph.respond_to?(:text=)
-            paragraph.text = text
-          end
+      if !text_set && cell.paragraphs.any?
+        paragraph = cell.paragraphs.first
+        # Try to add a text run to the paragraph
+        if paragraph.respond_to?(:add_text)
+          paragraph.add_text(text)
+        elsif paragraph.respond_to?(:text=)
+          paragraph.text = text
         end
       end
-    rescue => e
+    rescue StandardError => e
       puts "Warning: Could not set text '#{text}' in cell: #{e.message}"
     end
 
@@ -99,9 +97,65 @@ module Commenter
     end
 
     def apply_shading(cell, observation)
-      # Shading functionality is not fully supported by the docx gem
-      # This is a placeholder for future implementation
-      puts "Shading requested for: #{observation}" if observation
+      return unless observation && !observation.empty?
+
+      # Determine shading color based on status patterns
+      shading_color = determine_shading_color(observation)
+      return unless shading_color
+
+      puts "Applying #{shading_color} cell shading for: #{observation.strip}"
+
+      # Apply shading to the table cell itself
+      apply_cell_shading(cell, shading_color)
+    rescue StandardError => e
+      puts "Warning: Could not apply shading to cell: #{e.message}"
+    end
+
+    def determine_shading_color(observation)
+      text = observation.downcase.strip
+
+      case text
+      when /awm|accept with modifications/
+        "C4D79B"  # Olive Green
+      when /accept(ed)?/
+        "92D050"  # Green
+      when /noted/
+        "8DB4E2"  # Blue
+      when /reject(ed)?/
+        "FF99CC"  # Pink
+      when /todo/
+        "D9D9D9"  # Light Gray (for diagonal stripes, we'll use solid for now)
+      end
+    end
+
+    def apply_cell_shading(cell, color)
+      # Access the cell's XML node
+      cell_node = cell.node
+
+      # Find or create the table cell properties (tcPr) element
+      tcpr_node = cell_node.at_xpath(".//w:tcPr", "w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main")
+
+      unless tcpr_node
+        # Create table cell properties if they don't exist
+        tcpr_node = cell_node.document.create_element("tcPr")
+        cell_node.prepend_child(tcpr_node)
+      end
+
+      # Remove existing shading if present
+      existing_shd = tcpr_node.at_xpath(".//w:shd", "w" => "http://schemas.openxmlformats.org/wordprocessingml/2006/main")
+      existing_shd&.remove
+
+      # Create new shading element for the cell
+      shd_node = cell_node.document.create_element("shd")
+      shd_node["w:val"] = "clear"
+      shd_node["w:color"] = "auto"
+      shd_node["w:fill"] = color
+
+      # Add namespace declaration
+      shd_node.namespace = cell_node.document.root.namespace_definitions.find { |ns| ns.prefix == "w" }
+
+      # Add the shading to table cell properties
+      tcpr_node.add_child(shd_node)
     end
   end
 end