jirametrics 2.12.1 → 2.14pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7565c5b6320b9c4375a3feb27fcaf80f96d9c058041b71584f287e6a3d7eb399
-  data.tar.gz: 4554c7edbc7c42e01ad4838094ab922819c2e71818a46907f25740e35c327aa6
+  metadata.gz: ddc2265d15bc52422942f009082fd92fea0b296860297b6a6fa5fd0aee1788f4
+  data.tar.gz: e76799a3576b4e1e667268b823c99d6be8068ee196a76766e07fb646a44b17ee
 SHA512:
-  metadata.gz: 021c1f989117b1fbb8708183d9ad8e79b049060989c1f20d31121a486d25f1ae2d1c036e013279479cd3ac6f5b101a48d8c9f4943570107c9cc4b40485ea6a4f
-  data.tar.gz: 7f7e334a2161e23ef5ae8a754aa3f12524c1bb130893ca3df3e8574f7a44286ef33c8a03b2ac2790ccb8e8b792ce0fb6c17b1d69d2da068ea48dbce1b4c514a1
+  metadata.gz: 0d60ce44257fcd466d092963ec7a58e86d9cf9252bc83262ac3c3b3621941df44b5c686b71e57be68bef06352d964f369b3cd9281324e3235cdad2c94e2f1869
+  data.tar.gz: 217c6e8a37ad3b5ae4e25d454a27b77b023ccd87e73ece9a1d3853f55e9c1330e24e64a7578f99289007925c2310482f200ac4f5d5affae6dd0ccb649978269b

data/lib/jirametrics/atlassian_document_format.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+class AtlassianDocumentFormat
+  attr_reader :users
+
+  def initialize users:, timezone_offset:
+    @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
+    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

@@ -66,6 +66,8 @@ class ChartBase
   end
 
   def label_days days
+    return 'unknown' if days.nil?
+
     "#{days} day#{'s' unless days == 1}"
   end
 

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, timezone_offset: timezone_offset)
+  end
+
   def select_aging_issues
     aging_issues = issues.select do |issue|
       started_at, stopped_at = issue.board.cycletime.started_stopped_times(issue)
@@ -78,7 +82,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 +102,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 +122,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,29 +166,23 @@ 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
+    id = next_id
+    lines <<
+      "<a href=\"javascript:toggle_visibility('open#{id}', 'close#{id}', 'section#{id}');\">" \
+      "<span id='open#{id}' style='display: none'>▶ Child issues</span>" \
+      "<span id='close#{id}'>▼ Child issues</span></a>"
+    lines << "<section id='section#{id}'>"
+
+    # icon_urls = subtasks.collect(&:type_icon_url).uniq.collect { |url| "<img src='#{url}' class='icon' />" }
+    # lines << (icon_urls << 'Child issues')
+    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
@@ -207,8 +213,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,15 +251,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 +282,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/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.css

@@ -191,6 +191,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 {

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/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
@@ -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

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/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

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

@@ -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.14pre2
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-07-13 00:00:00.000000000 Z
+date: 2025-08-11 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