marlens-jira-api 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0cf8ed2ffd471d5f4c71da18861f1b4da2bb13e91192e61d36d1905139527fa
-  data.tar.gz: ab15b83bebe592a06b8d1f1636f6045cb2da32b39e2c4939f2207e3f7016c160
+  metadata.gz: '08ccc21d16f1e2593da0304416dabc4e08b0d60891b2fcf05f03ccc249244081'
+  data.tar.gz: 551652ac549e8034ec3633b9b42db59c6ddf3e44485b8b15b602286f8bf9c525
 SHA512:
-  metadata.gz: b5c66a4d1d404a4a3703ae18f80a71f56061003eac7b1eea824b9a3581aa7d7c5ada4808a43abcc39d7a94843a07a41ed8115048e7c2f7e25b044ae0ba2aea56
-  data.tar.gz: 44853c868153491b53f85549c6266a04a153162ddb0b998b0cfcd4381554de4917275a477fb3c9306aab660409c9d26e09285c0049b6d1b189cc6329da0ccc1c
+  metadata.gz: bb82c632c653f9d421849d2d217d3560173a04a4235f0322b243862cadb1658f1ea4dd1d9afca7ea191a7f013112c04f51f91f1e589d0e1ce19ad6abd4ec6ac3
+  data.tar.gz: 38def1ee536eba0d1fd8b4283f961737bc0c26ac0e10af78b6fb886372f574f29c0a28359c5dd697ff2f475d8ebddee27eb993a872b3e3ca3bc412d163f0b9a6

data/README.md

@@ -39,6 +39,14 @@ client.update_markdown_comment(
 client.delete_comment(issue_key: "WRAPX-123", comment_id: created.fetch("id"))
 ```
 
+### ADF to Markdown
+
+```ruby
+markdown = Marlens::JiraApi::AdfToMarkdown.call(issue.fetch("fields").fetch("description"))
+```
+
+Supports ADF documents, paragraphs, headings, block quotes, ordered and bullet lists, list items, text, and strong, emphasis, code, link, and strike marks. Unsupported nodes preserve traversable `content`; nodes without traversable content render nothing.
+
 ### Read errors
 
 `get_issue` and `list_remote_links` return parsed Jira JSON. A non-2xx response raises `RuntimeError` with the HTTP method, request path, status, and response body. A successful response with malformed JSON raises `JSON::ParserError`.

data/lib/marlens/jira_api/adf_to_markdown.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Marlens
+  module JiraApi
+    class AdfToMarkdown
+      BLOCK_TYPES = %w[doc paragraph heading blockquote orderedList bulletList listItem].freeze
+
+      def self.call(document)
+        new(document).to_markdown
+      end
+
+      def initialize(document)
+        @document = document.is_a?(Hash) ? document : {}
+      end
+
+      def to_markdown
+        render_block(@document).strip
+      end
+
+      private
+
+      def render_block(node)
+        case node["type"]
+        when "doc"
+          render_blocks(children(node)).join("\n\n")
+        when "paragraph"
+          render_inline_nodes(children(node))
+        when "heading"
+          "#{"#" * heading_level(node)} #{render_inline_nodes(children(node))}".rstrip
+        when "blockquote"
+          quote(render_blocks(children(node)).join("\n\n"))
+        when "orderedList", "bulletList"
+          render_list(node)
+        when "listItem"
+          render_list_item(node, marker: "-", indent: 0)
+        when "text", "hardBreak"
+          render_inline(node)
+        else
+          render_unknown(node)
+        end
+      end
+
+      def render_blocks(nodes)
+        nodes.filter_map do |node|
+          rendered = render_block(node)
+          rendered unless rendered.empty?
+        end
+      end
+
+      def render_unknown(node)
+        content = children(node)
+        return "" if content.empty?
+
+        if content.any? { |child| BLOCK_TYPES.include?(child["type"]) }
+          render_blocks(content).join("\n\n")
+        else
+          render_inline_nodes(content)
+        end
+      end
+
+      def render_list(node, indent: 0)
+        start = node.dig("attrs", "order").to_i
+        start = 1 if start.zero?
+
+        children(node).each_with_index.map do |item, index|
+          marker = node["type"] == "orderedList" ? "#{start + index}." : "-"
+          render_list_item(item, marker:, indent:)
+        end.join("\n")
+      end
+
+      def render_list_item(node, marker:, indent:)
+        item_children = children(node)
+        first_child = item_children.shift
+        indentation = " " * indent
+        prefix = "#{marker} "
+
+        if first_child&.fetch("type", nil) == "paragraph"
+          lines = ["#{indentation}#{prefix}#{render_inline_nodes(children(first_child))}".rstrip]
+        else
+          lines = ["#{indentation}#{marker}"]
+          item_children.unshift(first_child) unless first_child.nil?
+        end
+
+        continuation_indent = indent + prefix.length
+        item_children.each do |child|
+          rendered = if ["orderedList", "bulletList"].include?(child["type"])
+                       render_list(child, indent: continuation_indent)
+                     else
+                       indent_lines(render_block(child), continuation_indent)
+                     end
+          lines << rendered unless rendered.empty?
+        end
+
+        lines.join("\n")
+      end
+
+      def render_inline_nodes(nodes)
+        nodes.map { |node| render_inline(node) }.join
+      end
+
+      def render_inline(node)
+        case node["type"]
+        when "text"
+          apply_marks(node.fetch("text", ""), node["marks"])
+        when "hardBreak"
+          "\n"
+        else
+          render_inline_nodes(children(node))
+        end
+      end
+
+      def apply_marks(text, marks)
+        Array(marks).reduce(text) do |markdown, mark|
+          case mark["type"]
+          when "strong", "bold"
+            "**#{markdown}**"
+          when "em", "italic"
+            "*#{markdown}*"
+          when "code"
+            "`#{markdown}`"
+          when "link"
+            href = mark.dig("attrs", "href")
+            href.to_s.empty? ? markdown : "[#{markdown}](#{href})"
+          when "strike"
+            "~~#{markdown}~~"
+          else
+            markdown
+          end
+        end
+      end
+
+      def heading_level(node)
+        level = node.dig("attrs", "level").to_i
+        level.zero? ? 1 : level
+      end
+
+      def quote(content)
+        content.split("\n", -1).map { |line| line.empty? ? ">" : "> #{line}" }.join("\n")
+      end
+
+      def indent_lines(text, indent)
+        return "" if text.empty?
+
+        text.lines(chomp: true).map { |line| "#{" " * indent}#{line}" }.join("\n")
+      end
+
+      def children(node)
+        Array(node["content"]).select { |child| child.is_a?(Hash) }
+      end
+    end
+  end
+end

data/lib/marlens/jira_api/version.rb

@@ -2,6 +2,6 @@
 
 module Marlens
   module JiraApi
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

data/lib/marlens/jira_api.rb

@@ -3,6 +3,7 @@
 require_relative "jira_api/version"
 require_relative "jira_api/client"
 require_relative "jira_api/markdown_to_adf"
+require_relative "jira_api/adf_to_markdown"
 require_relative "jira_api/remote_image_attachment_uploader"
 require_relative "jira_api/cli"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marlens-jira-api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Marlen Brunner
@@ -92,6 +92,7 @@ files:
 - README.md
 - bin/jira-comment
 - lib/marlens/jira_api.rb
+- lib/marlens/jira_api/adf_to_markdown.rb
 - lib/marlens/jira_api/cli.rb
 - lib/marlens/jira_api/client.rb
 - lib/marlens/jira_api/markdown_to_adf.rb