jirametrics 2.11 → 2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 670df42835c7d41e30dcde01ead744a132f81313165297d434334e272de795c7
-  data.tar.gz: 12822842210b4aeddb7f59e6681a9f1bd25060bae0ff98e8490d14e895dea657
+  metadata.gz: d5b1b9e8d837f6d74990d377db007ed5e55670de77738ab38a04c6d023d865c3
+  data.tar.gz: 99e8ef3e85a3dfa2bd6d845a32d974718c0e9884d2f4750891ba491fd884ab0b
 SHA512:
-  metadata.gz: a4f36b8921c94a457710dc68251a9a2ddb38be2f0f7027991cf381fdf1cff28d2e549e508314733a3c753f583fd3c695b7e4979e1bb7be43c45de90ec001cbab
-  data.tar.gz: 28a2553b31cd4de5fce0c943da38643ad13dbfad3a8bddc77f4764e179394968966bb676e70daa75a4faeb42a67027fb7efb63895b56c01a3db563a029df66aa
+  metadata.gz: 804a25c8a19df9ae9862e2f95539183ece53e3841e590c64b8deb7048601bfb2b42ad5b75c075b85058abb7cea0cc875d517f4208bd5edbf98e2129e5567af59
+  data.tar.gz: '0059cde9746423c5baf3ca1f47243b6489ccf77b8fd409255f7301f638eb1975b8b2815d266f720cd9f1cd51e2cf0bc9e33cbad3e34110ca1dedc4ad7fc9ff5b'

data/lib/jirametrics/aging_work_table.rb

@@ -108,20 +108,11 @@ class AgingWorkTable < ChartBase
   end
 
   def sprints_text issue
-    sprint_ids = []
-
-    issue.changes.each do |change|
-      next unless change.sprint?
-
-      sprint_ids << change.raw['to'].split(/\s*,\s*/).collect { |id| id.to_i }
-    end
-    sprint_ids.flatten!
-
-    issue.board.sprints.select { |s| sprint_ids.include? s.id }.collect do |sprint|
+    issue.sprints.collect do |sprint|
       icon_text = nil
       if sprint.active?
         icon_text = icon_span title: 'Active sprint', icon: '➡️'
-      else
+      elsif sprint.closed?
         icon_text = icon_span title: 'Sprint closed', icon: '✅'
       end
       "#{sprint.name} #{icon_text}"
@@ -181,4 +172,8 @@ class AgingWorkTable < ChartBase
 
     result.reverse
   end
+
+  def priority_text issue
+    "<img src='#{issue.priority_url}' title='Priority: #{issue.priority_name}' />"
+  end
 end

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

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 class Board
-  attr_reader :visible_columns, :raw, :possible_statuses, :sprints, :board_type
+  attr_reader :visible_columns, :raw, :possible_statuses, :sprints
   attr_accessor :cycletime, :project_config
 
   def initialize raw:, possible_statuses:
     @raw = raw
-    @board_type = raw['type']
     @possible_statuses = possible_statuses
     @sprints = []
 
@@ -67,13 +66,9 @@ class Board
     status_ids
   end
 
-  def kanban?
-    @board_type == 'kanban'
-  end
-
-  def scrum?
-    @board_type == 'scrum'
-  end
+  def board_type = raw['type']
+  def kanban? = (board_type == 'kanban')
+  def scrum? = (board_type == 'scrum')
 
   def id
     @raw['id'].to_i
@@ -117,4 +112,8 @@ class Board
       all_names << name
     end
   end
+
+  def estimation_configuration
+    EstimationConfiguration.new raw: raw['estimation']
+  end
 end

data/lib/jirametrics/board_config.rb

@@ -11,8 +11,10 @@ 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?
   end
 
   def cycletime label = nil, &block

data/lib/jirametrics/board_movement_calculator.rb

@@ -124,6 +124,14 @@ class BoardMovementCalculator
     column_name, entry_time = find_current_column_and_entry_time_in_column issue
     return [nil, 'This issue is not visible on the board. No way to predict when it will be done.'] if column_name.nil?
 
+    # This condition has been reported in production so we have a check for it. Having said that, we have no
+    # idea what conditions might make this possible and so there is no test for it.
+    if entry_time.nil?
+      message = "Unable to determine the time this issue entered column #{column_name.inspect} so no way to " \
+        'predict when it will be done'
+      return [nil, message]
+    end
+
     age_in_column = (today - entry_time.to_date).to_i + 1
 
     message = nil

data/lib/jirametrics/change_item.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 class ChangeItem
-  attr_reader :field, :value_id, :old_value_id, :raw, :author, :time
+  attr_reader :field, :value_id, :old_value_id, :raw, :time, :author_raw
   attr_accessor :value, :old_value
 
-  def initialize raw:, time:, author:, artificial: false
+  def initialize raw:, author_raw:, time:, artificial: false
     @raw = raw
+    @author_raw = author_raw
     @time = time
     raise 'ChangeItem.new() time cannot be nil' if time.nil?
     raise "Time must be an object of type Time in the correct timezone: #{@time.inspect}" unless @time.is_a? Time
@@ -16,26 +17,29 @@ class ChangeItem
     @old_value = @raw['fromString']
     @old_value_id = @raw['from']&.to_i
     @artificial = artificial
-    @author = author
   end
 
-  def status? = (field == 'status')
+  def author
+    @author_raw&.[]('displayName') || @author_raw&.[]('name') || 'Unknown author'
+  end
 
-  def flagged? = (field == 'Flagged')
+  def author_icon_url
+    @author_raw&.[]('avatarUrls')&.[]('16x16')
+  end
 
+  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'
+  def labels? = (field == 'labels')
+  def link? = (field == 'Link')
   def priority? = (field == 'priority')
-
   def resolution? = (field == 'resolution')
-
-  def artificial? = @artificial
-
   def sprint? = (field == 'Sprint')
-
-  def story_points? = (field == 'Story Points')
-
-  def link? = (field == 'Link')
-
-  def labels? = (field == 'labels')
+  def status? = (field == 'status')
 
   # An alias for time so that logic accepting a Time, Date, or ChangeItem can all respond to :to_time
   def to_time = @time
@@ -91,6 +95,17 @@ class ChangeItem
     end
   end
 
+  def field_as_human_readable
+    case @field
+    when 'duedate' then 'Due date'
+    when 'timeestimate' then 'Time estimate'
+    when 'timeoriginalestimate' then 'Time original estimate'
+    when 'issuetype' then 'Issue type'
+    when 'IssueParentAssociation' then 'Issue parent association'
+    else @field.capitalize
+    end
+  end
+
   private
 
   def time_to_s time

data/lib/jirametrics/chart_base.rb

@@ -2,7 +2,7 @@
 
 class ChartBase
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
-    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system
+    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system, :users
   attr_writer :aggregated_project
   attr_reader :canvas_width, :canvas_height
 
@@ -38,7 +38,6 @@ class ChartBase
     # Insert a incrementing chart_id so that all the chart names on the page are unique
     caller_binding.eval "chart_id='chart#{next_id}'" # chart_id=chart3
 
-    # @html_directory = "#{pathname.dirname}/html"
     erb = ERB.new file_system.load "#{html_directory}/#{$1}.erb"
     erb.result(caller_binding)
   end
@@ -67,6 +66,8 @@ class ChartBase
   end
 
   def label_days days
+    return 'unknown' if days.nil?
+
     "#{days} day#{'s' unless days == 1}"
   end
 
@@ -227,8 +228,8 @@ class ChartBase
         icon: ' 👀'
       )
     end
-    text = is_category ? status.category.name : status.name
-    "<span title='Category: #{status.category.name}'>#{color_block color.name} #{text}</span>#{visibility}"
+    text = is_category ? status.category : status
+    "<span title='Category: #{status.category}'>#{color_block color.name} #{text}</span>#{visibility}"
   end
 
   def icon_span title:, icon:

data/lib/jirametrics/cycletime_config.rb

@@ -59,7 +59,7 @@ class CycleTimeConfig
       'from' => '0',
       'fromString' => ''
     }
-    ChangeItem.new raw: raw, time: time, author: 'unknown', artificial: true
+    ChangeItem.new raw: raw, time: time, artificial: true, author_raw: nil
   end
 
   def started_stopped_changes issue

data/lib/jirametrics/daily_view.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+class DailyView < ChartBase
+  attr_accessor :possible_statuses
+
+  def initialize _block
+    super()
+
+    header_text 'Daily View'
+    description_text <<-HTML
+      <div class="p">
+        This view shows all the items you'll want to discuss during your daily coordination meeting
+        (aka daily scrum, standup), in the order that you should be discussing them. The most important
+        items are at the top, and the least at the bottom.
+      </div>
+      <div class="p">
+        By default, we sort by priority first and then by age within each of those priorities.
+        Hover over the issue to make it stand out more.
+      </div>
+    HTML
+  end
+
+  def run
+    aging_issues = select_aging_issues
+
+    return "<h1>#{@header_text}</h1>There are no items currently in progress" if aging_issues.empty?
+
+    result = +''
+    result << render_top_text(binding)
+    aging_issues.each do |issue|
+      result << render_issue(issue, child: false)
+    end
+    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)
+      started_at && !stopped_at
+    end
+
+    today = date_range.end
+    aging_issues.collect do |issue|
+      [issue, issue.priority_name, issue.board.cycletime.age(issue, today: today)]
+    end.sort(&issue_sorter).collect(&:first)
+  end
+
+  def issue_sorter
+    priority_names = settings['priority_order']
+    lambda do |a, b|
+      a_issue, a_priority, a_age = *a
+      b_issue, b_priority, b_age = *b
+
+      a_priority_index = priority_names.index(a_priority)
+      b_priority_index = priority_names.index(b_priority)
+
+      if a_priority_index.nil? && b_priority_index.nil?
+        result = a_priority <=> b_priority
+      elsif a_priority_index.nil?
+        result = 1
+      elsif b_priority_index.nil?
+        result = -1
+      else
+        result = b_priority_index <=> a_priority_index
+      end
+
+      result = b_age <=> a_age if result.zero?
+      result = a_issue <=> b_issue if result.zero?
+      result
+    end
+  end
+
+  def make_blocked_stalled_lines issue
+    today = date_range.end
+    started_date = issue.board.cycletime.started_stopped_times(issue).first&.to_date
+    return [] unless started_date
+
+    blocked_stalled = issue.blocked_stalled_by_date(
+      date_range: today..today, chart_end_time: time_range.end, settings: settings
+    )[today]
+    return [] if blocked_stalled.active?
+
+    lines = []
+    if blocked_stalled.blocked?
+      marker = color_block '--blocked-color'
+      lines << ["#{marker} Blocked by flag"] if blocked_stalled.flag
+      lines << ["#{marker} Blocked by status: #{blocked_stalled.status}"] if blocked_stalled.blocked_by_status?
+      blocked_stalled.blocking_issue_keys&.each do |key|
+        lines << ["#{marker} Blocked by issue: #{key}"]
+        blocking_issue = issues.find { |i| i.key == key }
+        lines << blocking_issue if blocking_issue
+      end
+    elsif blocked_stalled.stalled_by_status?
+      lines << ["#{color_block '--stalled-color'} Stalled by status: #{blocked_stalled.status}"]
+    else
+      lines << ["#{color_block '--stalled-color'} Stalled by inactivity: #{blocked_stalled.stalled_days} days"]
+    end
+    lines
+  end
+
+  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:, done:
+    title_line = +''
+    title_line << color_block('--expedited-color', title: 'Expedited') if issue.expedited?
+    title_line << make_issue_label(issue: issue, done: done)
+    title_line
+  end
+
+  def make_parent_lines issue
+    lines = []
+    parent_key = issue.parent_key
+    if parent_key
+      parent = issues.find_by_key key: parent_key, include_hidden: true
+      text = parent ? make_issue_label(issue: parent, done: parent.done?) : parent_key
+      lines << ["Parent: #{text}"]
+    end
+    lines
+  end
+
+  def make_stats_lines issue:, done:
+    line = []
+
+    line << "<img src='#{issue.priority_url}' class='icon' /> <b>#{issue.priority_name}</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) }
+    line << "Column: <b>#{column&.name || '(not visible on board)'}</b>"
+
+    if issue.assigned_to
+      line << "Assignee: <img src='#{issue.assigned_to_icon_url}' class='icon' /> <b>#{issue.assigned_to}</b>"
+    end
+
+    line << "Due: <b>#{issue.due_date}</b>" if issue.due_date
+
+    block = lambda do |collection, label|
+      unless collection.empty?
+        text = collection.collect { |l| "<span class='label'>#{l}</span>" }.join(' ')
+        line << "#{label} #{text}"
+      end
+    end
+    block.call issue.labels, 'Labels:'
+    block.call issue.component_names, 'Components:'
+
+    [line]
+  end
+
+  def make_child_lines issue
+    lines = []
+    subtasks = issue.subtasks
+
+    return lines if subtasks.empty?
+
+    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}'>"
+
+    lines += subtasks
+    lines << '</section>'
+
+    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>"
+    ]
+    table = +''
+    table << "<table id='table#{id}' style='display: none'>"
+    history.each do |c|
+      time = c.time.strftime '%b %d, %I:%M%P'
+
+      table << '<tr>'
+      table << "<td><span class='time' title='Timestamp: #{c.time}'>#{time}</span></td>"
+      table << "<td><img src='#{c.author_icon_url}' class='icon' title='#{c.author}' /></td>"
+      text = history_text change: c, board: issue.board
+      table << "<td><span class='field'>#{c.field_as_human_readable}</span> #{text}</td>"
+      table << '</tr>'
+    end
+    table << '</table>'
+    lines << [table]
+    lines
+  end
+
+  def history_text change:, board:
+    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, change.old_value_id)
+        "Changed from #{from} to #{to}"
+      else
+        "Set to #{to}"
+      end
+    elsif change.flagged?
+      change.value == '' ? 'Off' : 'On'
+    else
+      change.value
+    end
+  end
+
+  def make_sprints_lines issue
+    return [] unless issue.board.scrum?
+
+    sprint_names = issue.sprints.collect do |sprint|
+      if sprint.closed?
+        "<s>#{sprint.name}</s>"
+      else
+        sprint.name
+      end
+    end
+
+    return [['Sprints: NONE']] if sprint_names.empty?
+
+    [[+'Sprints: ' << sprint_names
+      .collect { |name| "<span class='label'>#{name}</span>" }
+      .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: issue, done: done)]
+    lines += make_parent_lines(issue) unless child
+    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
+
+  def render_issue issue, child:
+    css_class = child ? 'child_issue' : 'daily_issue'
+    result = +''
+    result << "<div class='#{css_class}'>"
+    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|
+          result << "<div>#{chunk}</div>"
+        end
+        result << '</div>'
+      end
+    end
+    result << '</div>'
+  end
+end