jirametrics 2.12.1 → 2.13pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7565c5b6320b9c4375a3feb27fcaf80f96d9c058041b71584f287e6a3d7eb399
-  data.tar.gz: 4554c7edbc7c42e01ad4838094ab922819c2e71818a46907f25740e35c327aa6
+  metadata.gz: 86cc390c570ee4e3dcbcc8544ff9f78c02c648f65051c4765809728bc8f60dee
+  data.tar.gz: fc700a3285e4e0ed5aac26e7490aac787bdd777070dad27b3ece23b8bbfe7d4b
 SHA512:
-  metadata.gz: 021c1f989117b1fbb8708183d9ad8e79b049060989c1f20d31121a486d25f1ae2d1c036e013279479cd3ac6f5b101a48d8c9f4943570107c9cc4b40485ea6a4f
-  data.tar.gz: 7f7e334a2161e23ef5ae8a754aa3f12524c1bb130893ca3df3e8574f7a44286ef33c8a03b2ac2790ccb8e8b792ce0fb6c17b1d69d2da068ea48dbce1b4c514a1
+  metadata.gz: db561b3fb89c5e102cafb5a1becd55d198cd8ef81f433b18a7e4a967c618fdace5f7b960c3f29efe20f240dff673898e435c0656a92a8fda5974f7346bfc27ce
+  data.tar.gz: dbcd7a50423efc68a69f889bfcfeabe56e78820946c3d5d68b4b28bf434a71fd308c62dd70c14d06edee2e85ba7b5dfe9d48bf388811300cbf869fe7d6215105

data/lib/jirametrics/atlassian_document_format.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class AtlassianDocumentFormat
+  attr_reader :users
+
+  def initialize users:
+    @users = users
+  end
+
+  def to_html input
+    if input.is_a? String
+      input
+        .gsub(/{color:(#\w{6})}([^{]+){color}/, '<span style="color: \1">\2</span>') # Colours
+        .gsub(/\[~accountid:([^\]]+)\]/) { expand_account_id $1 } # Tagged people
+        .gsub(/\[([^\|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
+        .gsub("\n", '<br />')
+    else
+      input['content'].collect { |element| adf_node_to_html element }.join("\n")
+    end
+  end
+
+  # ADF is Atlassian Document Format
+  # https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/
+  def adf_node_to_html node
+    closing_tag = nil
+    result = +''
+    case node['type']
+    when 'paragraph'
+      result << '<p>'
+      closing_tag = '</p>'
+    when 'text'
+      marks = adf_marks_to_html node['marks']
+      result << marks.collect(&:first).join
+      result << node['text']
+      result << marks.collect(&:last).join
+    when 'bulletList'
+      result << '<ul>'
+      closing_tag = '</ul>'
+    when 'orderedList'
+      result << '<ol>'
+      closing_tag = '</ol>'
+    when 'listItem'
+      result << '<li>'
+      closing_tag = '</li>'
+    when 'table'
+      result << '<table>'
+      closing_tag = '</table>'
+    when 'tableRow'
+      result << '<tr>'
+      closing_tag = '</tr>'
+    when 'tableCell'
+      result << '<td>'
+      closing_tag = '</td>'
+    when 'tableHeader'
+      result << '<th>'
+      closing_tag = '</th>'
+    when 'mention'
+      user = node['attrs']['text']
+      result << "<b>#{user}</b>"
+    when 'taskList'
+      result << "<ul class='taskList'>"
+      closing_tag = '</ul>'
+    when 'taskItem'
+      state = node['attrs']['state'] == 'TODO' ? '☐' : '☑'
+      result << "<li>#{state} "
+      closing_tag = '</li>'
+    when 'emoji'
+      result << node['attrs']['text']
+    else
+      result << "<p>Unparseable section: #{node['type']}</p>"
+    end
+
+    node['content']&.each do |child|
+      result << adf_node_to_html(child)
+    end
+
+    result << closing_tag if closing_tag
+    result
+  end
+
+  def adf_marks_to_html list
+    return [] if list.nil?
+
+    mappings = [
+      ['strong', '<b>', '</b>'],
+      ['code', '<code>', '</code>'],
+      ['em', '<em>', '</em>'],
+      ['strike', '<s>', '</s>'],
+      ['underline', '<u>', '</u>']
+    ]
+
+    list.filter_map do |mark|
+      type = mark['type']
+      if type == 'textColor'
+        color = mark['attrs']['color']
+        ["<span style='color: #{color}'>", '</span>']
+      elsif type == 'link'
+        href = mark['attrs']['href']
+        title = mark['attrs']['title']
+        ["<a href='#{href}' title='#{title}'>", '</a>']
+      else
+        line = mappings.find { |key, _open, _close| key == type }
+        [line[1], line[2]] if line
+      end
+    end
+  end
+
+  def expand_account_id account_id
+    user = @users.find { |u| u.account_id == account_id }
+    text = account_id
+    text = "@#{user.display_name}" if user
+    "<span class='account_id'>#{text}</span>"
+  end
+end

data/lib/jirametrics/change_item.rb

@@ -30,6 +30,7 @@ class ChangeItem
   def artificial? = @artificial
   def assignee? = (field == 'assignee')
   def comment? = (field == 'comment')
+  def description? = (field == 'description')
   def due_date? = (field == 'duedate')
   def flagged? = (field == 'Flagged')
   def issue_type? = field == 'issuetype'

data/lib/jirametrics/daily_view.rb

@@ -33,6 +33,10 @@ class DailyView < ChartBase
     result
   end
 
+  def atlassian_document_format
+    @atlassian_document_format ||= AtlassianDocumentFormat.new(users: users)
+  end
+
   def select_aging_issues
     aging_issues = issues.select do |issue|
       started_at, stopped_at = issue.board.cycletime.started_stopped_times(issue)
@@ -164,21 +168,6 @@ class DailyView < ChartBase
     lines
   end
 
-  def jira_rich_text_to_html text
-    text
-      .gsub(/{color:(#\w{6})}([^{]+){color}/, '<span style="color: \1">\2</span>') # Colours
-      .gsub(/\[~accountid:([^\]]+)\]/) { expand_account_id $1 } # Tagged people
-      .gsub(/\[([^\|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
-      .gsub("\n", '<br />')
-  end
-
-  def expand_account_id account_id
-    user = @users.find { |u| u.account_id == account_id }
-    text = account_id
-    text = "@#{user.display_name}" if user
-    "<span class='account_id'>#{text}</span>"
-  end
-
   def make_history_lines issue
     history = issue.changes.reverse
     lines = []
@@ -207,8 +196,8 @@ class DailyView < ChartBase
   end
 
   def history_text change:, board:
-    if change.comment?
-      jira_rich_text_to_html(change.value)
+    if change.comment? || change.description?
+      atlassian_document_format.to_html(change.value)
     elsif change.status?
       convertor = ->(id) { format_status(board.possible_statuses.find_by_id(id), board: board) }
       to = convertor.call(change.value_id)
@@ -245,11 +234,19 @@ class DailyView < ChartBase
       .join(' ')]]
   end
 
+  def make_description_lines issue
+    description = issue.raw['fields']['description']
+    result = []
+    result << [atlassian_document_format.to_html(description)] if description
+    result
+  end
+
   def assemble_issue_lines issue, child:
     lines = []
     lines << [make_title_line(issue)]
     lines += make_parent_lines(issue) unless child
     lines += make_stats_lines(issue)
+    lines += make_description_lines(issue)
     lines += make_sprints_lines(issue)
     lines += make_blocked_stalled_lines(issue)
     lines += make_child_lines(issue)

data/lib/jirametrics/downloader.rb

@@ -97,30 +97,59 @@ class Downloader
     log "  JQL: #{jql}"
     escaped_jql = CGI.escape jql
 
-    max_results = 100
-    start_at = 0
-    total = 1
-    while start_at < total
-      json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
-        "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
-
-      json['issues'].each do |issue_json|
-        issue_json['exporter'] = {
-          'in_initial_query' => initial_query
-        }
-        identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
-        file = "#{issue_json['key']}-#{board.id}.json"
-
-        @file_system.save_json(json: issue_json, filename: File.join(path, file))
+    if @jira_gateway.cloud?
+      max_results = 5_000 # The maximum allowed by Jira
+      next_page_token = nil
+      issue_count = 0
+
+      loop do
+        json = @jira_gateway.call_url relative_url: '/rest/api/3/search/jql' \
+          "?jql=#{escaped_jql}&maxResults=#{max_results}&" \
+          "nextPageToken=#{next_page_token}&expand=changelog&fields=*all"
+        next_page_token = json['nextPageToken']
+
+        json['issues'].each do |issue_json|
+          issue_json['exporter'] = {
+            'in_initial_query' => initial_query
+          }
+          identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
+          file = "#{issue_json['key']}-#{board.id}.json"
+
+          @file_system.save_json(json: issue_json, filename: File.join(path, file))
+          issue_count += 1
+        end
+
+        message = "    Downloaded #{issue_count} issues"
+        log message, both: true
+
+        break unless next_page_token
+      end
+    else
+      max_results = 100
+      start_at = 0
+      total = 1
+      while start_at < total
+        json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
+          "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
+
+        json['issues'].each do |issue_json|
+          issue_json['exporter'] = {
+            'in_initial_query' => initial_query
+          }
+          identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
+          file = "#{issue_json['key']}-#{board.id}.json"
+
+          @file_system.save_json(json: issue_json, filename: File.join(path, file))
+        end
+
+        total = json['total'].to_i
+        max_results = json['maxResults']
+
+        message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
+        log message, both: true
+
+        start_at += json['issues'].size
       end
-
-      total = json['total'].to_i
-      max_results = json['maxResults']
-
-      message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
-      log message, both: true
-
-      start_at += json['issues'].size
     end
   end
 

data/lib/jirametrics/html/index.erb

@@ -50,8 +50,8 @@
   </head>
   <body>
     <noscript>
-      <div style="padding: 1em; background: gray; color: white; font-size: 2em;">
-        Javascript is currently disabled and that means that almost all of the charts in this report won't render. If you'd loaded this from a folder on SharePoint then save it locally and load it again.
+      <div style="padding: 1em; background: red; color: white; font-size: 2em;">
+        Javascript is currently disabled and that means that almost all of the charts in this report won't render. If you've loaded this from a folder on SharePoint then save it locally and load it again.
       </div>
     </noscript>
     <%= "\n" + @sections.collect { |text, type| text if type == :header }.compact.join("\n\n") %>

data/lib/jirametrics/jira_gateway.rb

@@ -77,4 +77,8 @@ class JiraGateway
 
     true
   end
+
+  def cloud?
+    @jira_url.downcase.end_with? '.atlassian.net'
+  end
 end

data/lib/jirametrics.rb

@@ -117,6 +117,7 @@ class JiraMetrics < Thor
     require 'jirametrics/board'
     require 'jirametrics/daily_view'
     require 'jirametrics/user'
+    require 'jirametrics/atlassian_document_format'
     load config_file
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.12.1
+  version: 2.13pre2
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-07-13 00:00:00.000000000 Z
+date: 2025-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -65,6 +65,7 @@ files:
 - lib/jirametrics/aging_work_in_progress_chart.rb
 - lib/jirametrics/aging_work_table.rb
 - lib/jirametrics/anonymizer.rb
+- lib/jirametrics/atlassian_document_format.rb
 - lib/jirametrics/blocked_stalled_change.rb
 - lib/jirametrics/board.rb
 - lib/jirametrics/board_column.rb