jirametrics 2.12.1 → 2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7565c5b6320b9c4375a3feb27fcaf80f96d9c058041b71584f287e6a3d7eb399
-  data.tar.gz: 4554c7edbc7c42e01ad4838094ab922819c2e71818a46907f25740e35c327aa6
+  metadata.gz: c8045db95ffbb1368c3df8be3ee88c88ddb1a3d2fee46c989ba9d94e8fdb4ac3
+  data.tar.gz: a4a245da182c96238ec99918eefaf097c3fcc3cd3f4a09f85d4fbdd25020b713
 SHA512:
-  metadata.gz: 021c1f989117b1fbb8708183d9ad8e79b049060989c1f20d31121a486d25f1ae2d1c036e013279479cd3ac6f5b101a48d8c9f4943570107c9cc4b40485ea6a4f
-  data.tar.gz: 7f7e334a2161e23ef5ae8a754aa3f12524c1bb130893ca3df3e8574f7a44286ef33c8a03b2ac2790ccb8e8b792ce0fb6c17b1d69d2da068ea48dbce1b4c514a1
+  metadata.gz: cb301db36a63ec0e2da49c5f7ce1f7c58ee44f9c1ab1dad7811667a72d598a8a36282bccc795bebf755706ea1b0d1f0ebdf092f75fe89dc128203645182b9a30
+  data.tar.gz: e1d08efa142f9d824621831cfc465fd6d17ba3c374f0259d860798feec2706214989c9eac9e41c5eafbd66be0d4c147c29bdec638eec7e956b87858384bf6bb8

data/lib/jirametrics/atlassian_document_format.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+class AtlassianDocumentFormat
+  attr_reader :users
+
+  def initialize users:, timezone_offset:
+    @users = users
+    @timezone_offset = timezone_offset
+  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 />')
+    elsif input['content']
+      input['content'].collect { |element| adf_node_to_html element }.join("\n")
+    else
+      # We have an actual ADF document with no content.
+      ''
+    end
+  end
+
+  # ADF is Atlassian Document Format
+  # https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/
+  def adf_node_to_html node # rubocop:disable Metrics/CyclomaticComplexity
+    closing_tag = nil
+    node_attrs = node['attrs']
+
+    result = +''
+    case node['type']
+    when 'blockquote'
+      result << '<blockquote>'
+      closing_tag = '</blockquote>'
+    when 'bulletList'
+      result << '<ul>'
+      closing_tag = '</ul>'
+    when 'codeBlock'
+      result << '<code>'
+      closing_tag = '</code>'
+    when 'date'
+      result << Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s
+    when 'decisionItem'
+      result << '<li>'
+      closing_tag = '</li>'
+    when 'decisionList'
+      result << '<div>Decisions<ul>'
+      closing_tag = '</ul></div>'
+    when 'emoji'
+      result << node_attrs['text']
+    when 'expand'
+      # TODO: Maybe, someday, make this actually expandable. For now it's always open
+      result << "<div>#{node_attrs['title']}</div>"
+    when 'hardBreak'
+      result << '<br />'
+    when 'heading'
+      level = node_attrs['level']
+      result << "<h#{level}>"
+      closing_tag = "</h#{level}>"
+    when 'inlineCard'
+      url = node_attrs['url']
+      result << "[Inline card]: <a href='#{url}'>#{url}</a>"
+    when 'listItem'
+      result << '<li>'
+      closing_tag = '</li>'
+    when 'media'
+      text = node_attrs['alt'] || node_attrs['id']
+      result << "Media: #{text}"
+    when 'mediaSingle', 'mediaGroup'
+      result << '<div>'
+      closing_tag = '</div>'
+    when 'mention'
+      user = node_attrs['text']
+      result << "<b>#{user}</b>"
+    when 'orderedList'
+      result << '<ol>'
+      closing_tag = '</ol>'
+    when 'panel'
+      type = node_attrs['panelType']
+      result << "<div>#{type.upcase}</div>"
+    when 'paragraph'
+      result << '<p>'
+      closing_tag = '</p>'
+    when 'rule'
+      result << '<hr />'
+    when 'status'
+      text = node_attrs['text']
+      result << text
+    when 'table'
+      result << '<table>'
+      closing_tag = '</table>'
+    when 'tableCell'
+      result << '<td>'
+      closing_tag = '</td>'
+    when 'tableHeader'
+      result << '<th>'
+      closing_tag = '</th>'
+    when 'tableRow'
+      result << '<tr>'
+      closing_tag = '</tr>'
+    when 'text'
+      marks = adf_marks_to_html node['marks']
+      result << marks.collect(&:first).join
+      result << node['text']
+      result << marks.collect(&:last).join
+    when 'taskItem'
+      state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
+      result << "<li>#{state} "
+      closing_tag = '</li>'
+    when 'taskList'
+      result << "<ul class='taskList'>"
+      closing_tag = '</ul>'
+    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/board_config.rb

@@ -11,6 +11,7 @@ class BoardConfig
 
   def run
     @board = @project_config.all_boards[id]
+    raise "Can't find board #{id.inspect} in #{@project_config.all_boards.keys.inspect}" unless @board
 
     instance_eval(&@block)
     raise "Must specify a cycletime for board #{@id}" if @board.cycletime.nil?

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/chart_base.rb

@@ -2,7 +2,8 @@
 
 class ChartBase
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
-    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system, :users
+    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system,
+    :atlassian_document_format
   attr_writer :aggregated_project
   attr_reader :canvas_width, :canvas_height
 
@@ -44,7 +45,7 @@ class ChartBase
 
   def render_top_text caller_binding
     result = +''
-    result << "<h1>#{@header_text}</h1>" if @header_text
+    result << "<h1 class='foldable'>#{@header_text}</h1>" if @header_text
     result << ERB.new(@description_text).result(caller_binding) if @description_text
     result
   end
@@ -66,6 +67,8 @@ class ChartBase
   end
 
   def label_days days
+    return 'unknown' if days.nil?
+
     "#{days} day#{'s' unless days == 1}"
   end
 

data/lib/jirametrics/cycletime_histogram.rb

@@ -62,7 +62,9 @@ class CycletimeHistogram < ChartBase
       )
     end
 
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
+    if data_sets.empty?
+      return "<h1 class='foldable'>#{@header_text}</h1><div>No data matched the selected criteria. Nothing to show.</div>"
+    end
 
     wrap_and_render(binding, __FILE__)
   end

data/lib/jirametrics/daily_view.rb

@@ -23,7 +23,7 @@ class DailyView < ChartBase
   def run
     aging_issues = select_aging_issues
 
-    return "<h1>#{@header_text}</h1>There are no items currently in progress" if aging_issues.empty?
+    return "<h1 class='foldable'>#{@header_text}</h1>There are no items currently in progress" if aging_issues.empty?
 
     result = +''
     result << render_top_text(binding)
@@ -78,7 +78,7 @@ class DailyView < ChartBase
     blocked_stalled = issue.blocked_stalled_by_date(
       date_range: today..today, chart_end_time: time_range.end, settings: settings
     )[today]
-    return [] unless blocked_stalled
+    return [] if blocked_stalled.active?
 
     lines = []
     if blocked_stalled.blocked?
@@ -98,15 +98,18 @@ class DailyView < ChartBase
     lines
   end
 
-  def make_issue_label issue
-    "<img src='#{issue.type_icon_url}' title='#{issue.type}' class='icon' /> " \
-      "<b><a href='#{issue.url}'>#{issue.key}</a></b> &nbsp;<i>#{issue.summary}</i>"
+  def make_issue_label issue:, done:
+    label = "<img src='#{issue.type_icon_url}' title='#{issue.type}' class='icon' /> "
+    label << '<s>' if done
+    label << "<b><a href='#{issue.url}'>#{issue.key}</a></b> &nbsp;<i>#{issue.summary}</i>"
+    label << '</s>' if done
+    label
   end
 
-  def make_title_line issue
+  def make_title_line issue:, done:
     title_line = +''
     title_line << color_block('--expedited-color', title: 'Expedited') if issue.expedited?
-    title_line << make_issue_label(issue)
+    title_line << make_issue_label(issue: issue, done: done)
     title_line
   end
 
@@ -115,20 +118,25 @@ class DailyView < ChartBase
     parent_key = issue.parent_key
     if parent_key
       parent = issues.find_by_key key: parent_key, include_hidden: true
-      text = parent ? make_issue_label(parent) : parent_key
+      text = parent ? make_issue_label(issue: parent, done: parent.done?) : parent_key
       lines << ["Parent: #{text}"]
     end
     lines
   end
 
-  def make_stats_lines issue
+  def make_stats_lines issue:, done:
     line = []
 
     line << "<img src='#{issue.priority_url}' class='icon' /> <b>#{issue.priority_name}</b>"
 
-    age = issue.board.cycletime.age(issue, today: date_range.end)
-    line << "Age: <b>#{age ? label_days(age) : '(Not Started)'}</b>"
+    if done
+      cycletime = issue.board.cycletime.cycletime(issue)
 
+      line << "Cycletime: <b>#{label_days cycletime}</b>"
+    else
+      age = issue.board.cycletime.age(issue, today: date_range.end)
+      line << "Age: <b>#{age ? label_days(age) : '(Not Started)'}</b>"
+    end
     line << "Status: <b>#{format_status issue.status, board: issue.board}</b>"
 
     column = issue.board.visible_columns.find { |c| c.status_ids.include?(issue.status.id) }
@@ -154,43 +162,24 @@ class DailyView < ChartBase
 
   def make_child_lines issue
     lines = []
-    subtasks = issue.subtasks.reject { |i| i.done? }
+    subtasks = issue.subtasks
 
-    unless subtasks.empty?
-      icon_urls = subtasks.collect(&:type_icon_url).uniq.collect { |url| "<img src='#{url}' class='icon' />" }
-      lines << (icon_urls << 'Incomplete child issues')
-      lines += subtasks
-    end
-    lines
-  end
+    return lines if subtasks.empty?
 
-  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
+    lines << '<section><div class="foldable">Child issues</div>'
+    lines += subtasks
+    lines << '</section>'
 
-  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>"
+    lines
   end
 
   def make_history_lines issue
     history = issue.changes.reverse
     lines = []
 
-    id = next_id
-    lines << [
-      "<a href=\"javascript:toggle_visibility('open#{id}', 'close#{id}', 'table#{id}');\">" \
-      "<span id='open#{id}'>▶ Issue History</span>" \
-      "<span id='close#{id}' style='display: none'>▼ Issue History</span></a>"
-    ]
+    lines << '<section><div class="foldable startFolded">Issue history</div>'
     table = +''
-    table << "<table id='table#{id}' style='display: none'>"
+    table << '<table>'
     history.each do |c|
       time = c.time.strftime '%b %d, %I:%M%P'
 
@@ -203,23 +192,24 @@ class DailyView < ChartBase
     end
     table << '</table>'
     lines << [table]
+    lines << '</section>'
     lines
   end
 
   def history_text change:, board:
-    if change.comment?
-      jira_rich_text_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)
+    convertor = ->(value, _id) { value.inspect }
+    convertor = ->(_value, id) { format_status(board.possible_statuses.find_by_id(id), board: board) } if change.status?
+
+    if change.comment? || change.description?
+      atlassian_document_format.to_html(change.value)
+    elsif %w[status priority assignee duedate issuetype].include?(change.field)
+      to = convertor.call(change.value, change.value_id)
       if change.old_value
-        from = convertor.call(change.old_value_id)
+        from = convertor.call(change.old_value, change.old_value_id)
         "Changed from #{from} to #{to}"
       else
         "Set to #{to}"
       end
-    elsif %w[priority assignee duedate issuetype].include?(change.field)
-      "Changed from \"#{change.old_value}\" to \"#{change.value}\""
     elsif change.flagged?
       change.value == '' ? 'Off' : 'On'
     else
@@ -245,15 +235,27 @@ 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:
+    done = issue.done?
+
     lines = []
-    lines << [make_title_line(issue)]
+    lines << [make_title_line(issue: issue, done: done)]
     lines += make_parent_lines(issue) unless child
-    lines += make_stats_lines(issue)
-    lines += make_sprints_lines(issue)
-    lines += make_blocked_stalled_lines(issue)
-    lines += make_child_lines(issue)
-    lines += make_history_lines(issue)
+    lines += make_stats_lines(issue: issue, done: done)
+    unless done
+      lines += make_description_lines(issue)
+      lines += make_sprints_lines(issue)
+      lines += make_blocked_stalled_lines(issue)
+      lines += make_child_lines(issue)
+      lines += make_history_lines(issue)
+    end
     lines
   end
 
@@ -264,6 +266,8 @@ class DailyView < ChartBase
     assemble_issue_lines(issue, child: child).each do |row|
       if row.is_a? Issue
         result << render_issue(row, child: true)
+      elsif row.is_a?(String)
+        result << row
       else
         result << '<div class="heading">'
         row.each do |chunk|

data/lib/jirametrics/dependency_chart.rb

@@ -51,7 +51,10 @@ class DependencyChart < ChartBase
     instance_eval(&@rules_block) if @rules_block
 
     dot_graph = build_dot_graph
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if dot_graph.nil?
+    if dot_graph.nil?
+      return "<h1 class='foldable'>#{@header_text}</h1>" \
+        '<div>No data matched the selected criteria. Nothing to show.</div>'
+    end
 
     svg = execute_graphviz(dot_graph.join("\n"))
     "<h1>#{@header_text}</h1><div>#{@description_text}</div>#{shrink_svg svg}"

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/expedited_chart.rb

@@ -48,7 +48,7 @@ class ExpeditedChart < ChartBase
     end
 
     if data_sets.empty?
-      '<h1>Expedited work</h1>There is no expedited work in this time period.'
+      '<h1 class="foldable">Expedited work</h1><p>There is no expedited work in this time period.</p>'
     else
       wrap_and_render(binding, __FILE__)
     end

data/lib/jirametrics/flow_efficiency_scatterplot.rb

@@ -60,7 +60,7 @@ class FlowEfficiencyScatterplot < ChartBase
       create_dataset(issues: issues, label: rules.label, color: rules.color)
     end
 
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
+    return "<h1 class='foldable'>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
 
     wrap_and_render(binding, __FILE__)
   end

data/lib/jirametrics/html/collapsible_issues_panel.erb

@@ -1,5 +1,5 @@
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<table class='standard' id='<%= issues_id %>' style='display: none;'>
+<div class='foldable startFolded'>Show details</div>
+<table class='standard' id='<%= issues_id %>'>
   <thead>
     <tr>
       <th>Issue</th>

data/lib/jirametrics/html/cycletime_histogram.erb

@@ -6,8 +6,8 @@ if show_stats
   link_id = next_id
   issues_id = next_id
 %>
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<div id="<%= issues_id %>" style="display: none;">
+<div class='foldable' style="padding-left: 1em;">Statistics</div>
+<div id="<%= issues_id %>" style="padding-left: 1em;">
   <div>
      <table class="standard">
       <tr>

data/lib/jirametrics/html/index.css

@@ -78,11 +78,6 @@ body {
   color: var(--default-text-color);
 }
 
-h1 {
-  border: 1px solid black;
-  background: lightgray;
-  padding-left: 0.2em;
-}
 dl, dd, dt {
   padding: 0;
   margin: 0;
@@ -191,6 +186,11 @@ div.daily_issue {
     padding-right: 0.2em;
     border-radius: 0.2em;
   }
+  h1 {
+    border: none;
+    background: none;
+    padding-left: 0;
+  }
   margin-bottom: 0.5em;
 }
 div.child_issue:hover {
@@ -239,11 +239,6 @@ div.child_issue {
     --daily-view-selected-issue-background: #474747;
   }
 
-  h1 {
-    color: #e0e0e0;
-    background-color: #656565;
-  }
-
   a[href] {
     color: #1e8ad6;
   }

data/lib/jirametrics/html/index.erb

@@ -7,39 +7,7 @@
     <script src="https://cdn.jsdelivr.net/npm/chartjs-adapter-moment@^1"></script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-annotation/1.2.2/chartjs-plugin-annotation.min.js" integrity="sha512-HycvvBSFvDEVyJ0tjE2rPmymkt6XqsP/Zo96XgLRjXwn6SecQqsn+6V/7KYev66OshZZ9+f9AttCGmYqmzytiw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
     <script type="text/javascript">
-      function expand_collapse(link_id, issues_id)  {
-        link_text = document.getElementById(link_id).textContent
-        if( link_text == 'Show details') {
-          document.getElementById(link_id).textContent = 'Hide details'
-          document.getElementById(issues_id).style.display = 'block'
-        }
-        else {
-          document.getElementById(link_id).textContent = 'Show details'
-          document.getElementById(issues_id).style.display = 'none'
-        }
-      }
-
-      function toggle_visibility(open_link_id, close_link_id, toggleable_id) {
-        let open_link = document.getElementById(open_link_id)
-        let close_link = document.getElementById(close_link_id)
-        let toggleable_element = document.getElementById(toggleable_id)
-
-        if(open_link.style.display == 'none') {
-          open_link.style.display = 'block'
-          close_link.style.display = 'none'
-          toggleable_element.style.display = 'none'
-        }
-        else {
-          open_link.style.display = 'none'
-          close_link.style.display = 'block'
-          toggleable_element.style.display = 'block'
-        }
-      }
-      // If we switch between light/dark mode then force a refresh so all charts will redraw correctly
-      // in the other colour scheme.
-      window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
-        location.reload()
-      })
+<%= javascript %>
     </script>
     <style>
 <%= css %>
@@ -50,8 +18,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/html/index.js

@@ -0,0 +1,90 @@
+function makeFoldable() {
+  // Get all elements with the "foldable" class
+  const foldableElements = document.querySelectorAll('.foldable');
+  
+  if (foldableElements.length === 0) {
+    return; // No foldable elements found
+  }
+  
+  // Process each foldable element
+  foldableElements.forEach((element, index) => {
+    // Skip if this is the footer element
+    if (element.id === 'footer') {
+      return;
+    }
+    
+    // Create a unique ID for this section
+    const sectionId = `foldable-section-${index}`;
+    const toggleId = `foldable-toggle-${index}`;
+    
+    // Create a container div for the foldable element and its content
+    const container = document.createElement('div');
+    container.className = 'foldable-section';
+    container.id = sectionId;
+    
+    // Create a toggle button
+    const toggleButton = document.createElement(element.tagName); //'button');
+    toggleButton.id = toggleId;
+    toggleButton.className = 'foldable-toggle-btn';
+    toggleButton.innerHTML = '▼ ' + element.textContent;
+    
+    // Create a content container
+    const contentContainer = document.createElement('div');
+    contentContainer.className = 'foldable-content';
+    contentContainer.style.cssText = `
+      border-left: 2px solid #ccc;
+      padding-left: 15px;
+    `;
+    
+    // Move the foldable element into the container and replace it with the toggle button
+    element.parentNode.insertBefore(container, element);
+    container.appendChild(toggleButton);
+    container.appendChild(contentContainer);
+    
+    // Move all elements between this foldable element and the next foldable element (or end of document) into the content container
+    let nextElement = element.nextElementSibling;
+    while (nextElement && !nextElement.classList.contains('foldable')) {
+      // Skip the footer element
+      if (nextElement.id === 'footer') {
+        break;
+      }
+      
+      const temp = nextElement.nextElementSibling;
+      contentContainer.appendChild(nextElement);
+      nextElement = temp;
+    }
+    
+    // Remove the original foldable element
+    element.remove();
+    
+    // Add click event to toggle visibility
+    toggleButton.addEventListener('click', function() {
+      const content = this.nextElementSibling;
+      if (content.style.display === 'none') {
+        content.style.display = 'block';
+        this.innerHTML = '▼ ' + this.innerHTML.substring(2);
+      } else {
+        content.style.display = 'none';
+        this.innerHTML = '▶ ' + this.innerHTML.substring(2);
+      }
+    });
+    
+    // Initially show the content (you can change this to 'none' if you want sections collapsed by default)
+    contentContainer.style.display = 'block';
+    if(element.classList.contains('startFolded')) {
+      toggleButton.click();
+    }
+  });
+}
+
+// Auto-initialize when DOM is loaded
+document.addEventListener('DOMContentLoaded', function() {
+  makeFoldable();
+});
+
+
+// If we switch between light/dark mode then force a refresh so all charts will redraw correctly
+// in the other colour scheme.
+window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
+  location.reload()
+})

data/lib/jirametrics/html/sprint_burndown.erb

@@ -68,8 +68,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
   link_id = next_id
   issues_id = next_id
 %>
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<div id="<%= issues_id %>" style="display: none;">
+<section>
+<div class='foldable startFolded'>Show statistics</div>
+<div id="<%= issues_id %>">
 <table class='standard' style="margin-left: 1em;">
   <thead>
     <th>Sprint</th>
@@ -109,4 +110,5 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     <% end %>
   </ul>
 </p>
-</div>
+</div>
+</section>

data/lib/jirametrics/html_report_config.rb

@@ -72,6 +72,7 @@ class HtmlReportConfig
 
     html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
     css = load_css html_directory: html_directory
+    javascript = file_system.load(File.join(html_directory, 'index.js'))
     erb = ERB.new file_system.load(File.join(html_directory, 'index.erb'))
     file_system.save_file content: erb.result(binding), filename: @file_config.output_filename
   end
@@ -87,7 +88,6 @@ class HtmlReportConfig
   def load_css html_directory:
     base_css_filename = File.join(html_directory, 'index.css')
     base_css = file_system.load(base_css_filename)
-    log("Loaded CSS:  #{base_css_filename}")
 
     extra_css_filename = settings['include_css']
     if extra_css_filename
@@ -160,7 +160,7 @@ class HtmlReportConfig
     chart.time_range = project_config.time_range
     chart.timezone_offset = timezone_offset
     chart.settings = settings
-    chart.users = project_config.users
+    chart.atlassian_document_format = project_config.atlassian_document_format
 
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id

data/lib/jirametrics/issue.rb

@@ -345,7 +345,7 @@ class Issue
         end
       elsif change.link?
         # Example: "This issue is satisfied by ANON-30465"
-        unless /^This issue (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
+        unless /^This (?<_>issue|work item) (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
           puts "Issue(#{key}) Can't parse link text: #{change.value || change.old_value}"
           next
         end
@@ -608,7 +608,7 @@ class Issue
 
   def dump
     result = +''
-    result << "#{key} (#{type}): #{compact_text summary, 200}\n"
+    result << "#{key} (#{type}): #{compact_text summary, max: 200}\n"
 
     assignee = raw['fields']['assignee']
     result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
@@ -681,9 +681,8 @@ class Issue
   def done?
     if artificial? || board.cycletime.nil?
       # This was probably loaded as a linked issue, which means we don't know what board it really
-      # belonged to. The best we can do is look at the status category. This case should be rare but
-      # it can happen.
-      status.category.name == 'Done'
+      # belonged to. The best we can do is look at the status key
+      status.category.done?
     else
       board.cycletime.done? self
     end
@@ -706,6 +705,19 @@ class Issue
     board.sprints.select { |s| sprint_ids.include? s.id }
   end
 
+  def compact_text text, max: 60
+    return '' if text.nil?
+
+    if text.is_a? Hash
+      # We can't effectively compact it but we can convert it into a string.
+      text = @board.project_config.atlassian_document_format.to_html(text)
+    else
+      text = text.gsub(/\s+/, ' ').strip
+      text = "#{text[0...max]}..." if text.length > max
+    end
+    text
+  end
+
   private
 
   def load_history_into_changes
@@ -730,14 +742,6 @@ class Issue
     end
   end
 
-  def compact_text text, max = 60
-    return nil if text.nil?
-
-    text = text.gsub(/\s+/, ' ').strip
-    text = "#{text[0..max]}..." if text.length > max
-    text
-  end
-
   def sort_changes!
     @changes.sort! do |a, b|
       # It's common that a resolved will happen at the same time as a status change.

data/lib/jirametrics/jira_gateway.rb

@@ -17,7 +17,9 @@ class JiraGateway
     begin
       json = JSON.parse(result)
     rescue # rubocop:disable Style/RescueStandardError
-      raise "Error when parsing result: #{result.inspect}"
+      message = "Unable to parse results from #{sanitize_message(command)}"
+      @file_system.error message, more: result
+      raise message
     end
 
     raise "Download failed with: #{JSON.pretty_generate(json)}" unless json_successful?(json)
@@ -25,9 +27,16 @@ class JiraGateway
     json
   end
 
+  def sanitize_message message
+    token = @jira_api_token || @jira_personal_access_token
+    raise 'Neither Jira API Token or personal access token has been set' unless token
+
+    message.gsub(@jira_api_token, '[API_TOKEN]')
+  end
+
   def call_command command
     log_entry = "  #{command.gsub(/\s+/, ' ')}"
-    log_entry = log_entry.gsub(@jira_api_token, '[API_TOKEN]') if @jira_api_token
+    log_entry = sanitize_message log_entry if @jira_api_token
     @file_system.log log_entry
 
     result = `#{command}`
@@ -77,4 +86,8 @@ class JiraGateway
 
     true
   end
+
+  def cloud?
+    @jira_url.downcase.end_with? '.atlassian.net'
+  end
 end

data/lib/jirametrics/project_config.rb

@@ -114,10 +114,14 @@ class ProjectConfig
   def file_prefix prefix
     # The file_prefix has to be set before almost everything else. It really should have been an attribute
     # on the project declaration itself. Hindsight is 20/20.
+
+    # There can only be one of these
     if @file_prefix
-      raise "file_prefix should only be set once. Was #{@file_prefix.inspect} and now changed to #{prefix.inspect}."
+      raise "file_prefix can only be set once. Was #{@file_prefix.inspect} and now changed to #{prefix.inspect}."
     end
 
+    raise_if_prefix_already_used(prefix)
+
     @file_prefix = prefix
 
     # Yes, this is a wierd place to be initializing this. Unfortunately, it has to happen after the file_prefix
@@ -130,8 +134,21 @@ class ProjectConfig
     @file_prefix
   end
 
-  def get_file_prefix # rubocop:disable Naming/AccessorMethodName
-    raise 'file_prefix has not been set yet. Move it to the top of the project declaration.' unless @file_prefix
+  def raise_if_prefix_already_used prefix
+    @exporter.project_configs.each do |project|
+      next unless project.get_file_prefix(raise_if_not_set: false) == prefix && project.target_path == target_path
+
+      raise "Project #{name.inspect} specifies file prefix #{prefix.inspect}, " \
+        "but that is already used by project #{project.name.inspect} in the same target path #{target_path.inspect}. " \
+        'This is almost guaranteed to be too much copy and paste in your configuration. ' \
+        'File prefixes must be unique within a directory.'
+    end
+  end
+
+  def get_file_prefix raise_if_not_set: true
+    if @file_prefix.nil? && raise_if_not_set
+      raise 'file_prefix has not been set yet. Move it to the top of the project declaration.'
+    end
 
     @file_prefix
   end
@@ -335,6 +352,12 @@ class ProjectConfig
     json.each { |user_data| @users << User.new(raw: user_data) }
   end
 
+  def atlassian_document_format
+    @atlassian_document_format ||= AtlassianDocumentFormat.new(
+      users: @users, timezone_offset: exporter.timezone_offset
+    )
+  end
+
   def to_time string, end_of_day: false
     time = end_of_day ? '23:59:59' : '00:00:00'
     string = "#{string}T#{time}#{exporter.timezone_offset}" if string.match?(/^\d{4}-\d{2}-\d{2}$/)

data/lib/jirametrics/status_collection.rb

@@ -19,6 +19,7 @@ class StatusCollection
   def find_by_id! id
     status = @list.find { |status| status.id == id }
     raise "Can't find any status for id #{id} in #{self}" unless status
+
     status
   end
 

data/lib/jirametrics.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'require_all'
+
+# This one does need to be loaded early. The rest will be loaded later.
+require './lib/jirametrics/file_system'
 
 class JiraMetrics < Thor
   def self.exit_on_failure?
@@ -48,75 +52,21 @@ class JiraMetrics < Thor
     Exporter.instance.info(keys, name_filter: options[:name] || '*')
   end
 
-  private
+  no_commands do
+    def load_config config_file, file_system: FileSystem.new
+      config_file = './config.rb' if config_file.nil?
 
-  def load_config config_file
-    config_file = './config.rb' if config_file.nil?
+      if File.exist? config_file
+        # The fact that File.exist can see the file does not mean that require will be
+        # able to load it. Convert this to an absolute pathname now for require.
+        config_file = File.absolute_path(config_file).to_s
+      else
+        file_system.error "Cannot find configuration file #{config_file.inspect}"
+        exit 1
+      end
 
-    if File.exist? config_file
-      # The fact that File.exist can see the file does not mean that require will be
-      # able to load it. Convert this to an absolute pathname now for require.
-      config_file = File.absolute_path(config_file).to_s
-    else
-      puts "Cannot find configuration file #{config_file.inspect}"
-      exit 1
+      require_rel 'jirametrics'
+      load config_file
     end
-
-    require 'jirametrics/value_equality'
-    require 'jirametrics/chart_base'
-    require 'jirametrics/rules'
-    require 'jirametrics/grouping_rules'
-    require 'jirametrics/daily_wip_chart'
-    require 'jirametrics/groupable_issue_chart'
-    require 'jirametrics/css_variable'
-    require 'jirametrics/issue_collection'
-
-    require 'jirametrics/aggregate_config'
-    require 'jirametrics/expedited_chart'
-    require 'jirametrics/board_config'
-    require 'jirametrics/file_config'
-    require 'jirametrics/jira_gateway'
-    require 'jirametrics/trend_line_calculator'
-    require 'jirametrics/status'
-    require 'jirametrics/issue_link'
-    require 'jirametrics/estimate_accuracy_chart'
-    require 'jirametrics/status_collection'
-    require 'jirametrics/sprint'
-    require 'jirametrics/issue'
-    require 'jirametrics/daily_wip_by_age_chart'
-    require 'jirametrics/daily_wip_by_parent_chart'
-    require 'jirametrics/aging_work_in_progress_chart'
-    require 'jirametrics/cycletime_scatterplot'
-    require 'jirametrics/flow_efficiency_scatterplot'
-    require 'jirametrics/sprint_issue_change_data'
-    require 'jirametrics/cycletime_histogram'
-    require 'jirametrics/daily_wip_by_blocked_stalled_chart'
-    require 'jirametrics/html_report_config'
-    require 'jirametrics/data_quality_report'
-    require 'jirametrics/aging_work_bar_chart'
-    require 'jirametrics/change_item'
-    require 'jirametrics/project_config'
-    require 'jirametrics/dependency_chart'
-    require 'jirametrics/cycletime_config'
-    require 'jirametrics/tree_organizer'
-    require 'jirametrics/aging_work_table'
-    require 'jirametrics/sprint_burndown'
-    require 'jirametrics/self_or_issue_dispatcher'
-    require 'jirametrics/throughput_chart'
-    require 'jirametrics/exporter'
-    require 'jirametrics/file_system'
-    require 'jirametrics/blocked_stalled_change'
-    require 'jirametrics/board_column'
-    require 'jirametrics/anonymizer'
-    require 'jirametrics/downloader'
-    require 'jirametrics/fix_version'
-    require 'jirametrics/download_config'
-    require 'jirametrics/columns_config'
-    require 'jirametrics/hierarchy_table'
-    require 'jirametrics/estimation_configuration'
-    require 'jirametrics/board'
-    require 'jirametrics/daily_view'
-    require 'jirametrics/user'
-    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.15'
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-07-13 00:00:00.000000000 Z
+date: 2025-09-08 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
@@ -112,6 +113,7 @@ files:
 - lib/jirametrics/html/hierarchy_table.erb
 - lib/jirametrics/html/index.css
 - lib/jirametrics/html/index.erb
+- lib/jirametrics/html/index.js
 - lib/jirametrics/html/sprint_burndown.erb
 - lib/jirametrics/html/throughput_chart.erb
 - lib/jirametrics/html_report_config.rb