jirametrics 2.0 → 2.12.1

data/lib/jirametrics/cycletime_scatterplot.rb

@@ -7,25 +7,24 @@ class CycletimeScatterplot < ChartBase
 
   attr_accessor :possible_statuses
 
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text 'Cycletime Scatterplot'
     description_text <<-HTML
-      <p>
+      <div class="p">
         This chart shows only completed work and indicates both what day it completed as well as
         how many days it took to get done. Hovering over a dot will show you the ID of the work item.
-      </p>
-      <p>
-        The gray line indicates the 85th percentile (<%= overall_percent_line %> days). 85% of all
+      </div>
+      <div class="p">
+        The #{color_block '--cycletime-scatterplot-overall-trendline-color'} line indicates the 85th
+        percentile (<%= overall_percent_line %> days). 85% of all
         items on this chart fall on or below the line and the remaining 15% are above the line. 85%
         is a reasonable proxy for "most" so that we can say that based on this data set, we can
         predict that most work of this type will complete in <%= overall_percent_line %> days or
         less. The other lines reflect the 85% line for that respective type of work.
-      </p>
-      <p>
-        The gray vertical bars indicate weekends, when theoretically we aren't working.
-      </p>
+      </div>
+      #{describe_non_working_days}
     HTML
 
     init_configuration_block block do
@@ -44,7 +43,7 @@ class CycletimeScatterplot < ChartBase
 
     data_sets = create_datasets completed_issues
     overall_percent_line = calculate_percent_line(completed_issues)
-    @percentage_lines << [overall_percent_line, 'gray']
+    @percentage_lines << [overall_percent_line, CssVariable['--cycletime-scatterplot-overall-trendline-color']]
 
     return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
 
@@ -54,10 +53,7 @@ class CycletimeScatterplot < ChartBase
   def create_datasets completed_issues
     data_sets = []
 
-    groups = group_issues completed_issues
-
-    groups.each_key do |rules|
-      completed_issues_by_type = groups[rules]
+    group_issues(completed_issues).each do |rules, completed_issues_by_type|
       label = rules.label
       color = rules.color
       percent_line = calculate_percent_line completed_issues_by_type
@@ -118,7 +114,7 @@ class CycletimeScatterplot < ChartBase
 
     {
       y: cycle_time,
-      x: chart_format(issue.board.cycletime.stopped_time(issue)),
+      x: chart_format(issue.board.cycletime.started_stopped_times(issue).last),
       title: ["#{issue.key} : #{issue.summary} (#{label_days(cycle_time)})"]
     }
   end

data/lib/jirametrics/daily_view.rb

@@ -0,0 +1,277 @@
+# 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 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 [] unless blocked_stalled
+
+    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
+    "<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>"
+  end
+
+  def make_title_line issue
+    title_line = +''
+    title_line << color_block('--expedited-color', title: 'Expedited') if issue.expedited?
+    title_line << make_issue_label(issue)
+    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(parent) : parent_key
+      lines << ["Parent: #{text}"]
+    end
+    lines
+  end
+
+  def make_stats_lines issue
+    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>"
+
+    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.reject { |i| i.done? }
+
+    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
+
+  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 = []
+
+    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:
+    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)
+      if change.old_value
+        from = convertor.call(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
+      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 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_sprints_lines(issue)
+    lines += make_blocked_stalled_lines(issue)
+    lines += make_child_lines(issue)
+    lines += make_history_lines(issue)
+    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)
+      else
+        result << '<div class="heading">'
+        row.each do |chunk|
+          result << "<div>#{chunk}</div>"
+        end
+        result << '</div>'
+      end
+    end
+    result << '</div>'
+  end
+end

data/lib/jirametrics/daily_wip_by_age_chart.rb

@@ -3,34 +3,58 @@
 require 'jirametrics/daily_wip_chart'
 
 class DailyWipByAgeChart < DailyWipChart
+  def initialize block
+    super
+
+    add_trend_line line_color: '--aging-work-in-progress-by-age-trend-line-color', group_labels: [
+      'Less than a day',
+      'A week or less',
+      'Two weeks or less',
+      'Four weeks or less',
+      'More than four weeks'
+    ]
+  end
+
   def default_header_text
     'Daily WIP grouped by Age'
   end
 
   def default_description_text
     <<-HTML
-      <p>
+      <div class="p">
         This chart shows the highest WIP on each given day. The WIP is color coded so you can see
         how old it is and hovering over the bar will show you exactly which work items it relates
-        to. The green bar underneath, shows how many items completed on that day.
-      </p>
-      <p>
-        "Completed without being started" reflects the fact that while we know that it completed
-        that day, we were unable to determine when it had started. These items will show up in
-        white at the top. Note that the white is approximate because we don't know exactly when
-        it started so we're guessing.
-      </p>
+        to. The #{color_block '--wip-chart-completed-color'}
+        #{color_block '--wip-chart-completed-but-not-started-color'}
+        bars underneath, show how many items completed on that day.
+      </div>
+      <% if @has_completed_but_not_started %>
+      <div class="p">
+        #{color_block '--wip-chart-completed-but-not-started-color'} "Completed but not started"
+        reflects the fact that while we know that it completed that day, we were unable to determine when
+        it had started; it had moved directly from a To Do status to a Done status.
+        The #{color_block '--body-background'} shading at the top shows when they might
+        have been active. Note that the this grouping is approximate as we just don't know for sure.
+      </div>
+      <% end %>
+      #{describe_non_working_days}
+      <div class="p">
+        The #{color_block '--aging-work-in-progress-by-age-trend-line-color'} dashed line is a general trend line.
+        <% if @has_completed_but_not_started %>
+        Note that this trend line only includes items where we know both the start and end times of
+        the work so it may not be as accurate as we hope.
+        <% end %>
+      </div>
     HTML
   end
 
   def default_grouping_rules issue:, rules:
-    cycletime = issue.board.cycletime
-    started = cycletime.started_time(issue)&.to_date
-    stopped = cycletime.stopped_time(issue)&.to_date
+    started, stopped = issue.board.cycletime.started_stopped_dates(issue)
 
     rules.issue_hint = "(age: #{label_days (rules.current_date - started + 1).to_i})" if started
 
     if stopped && started.nil? # We can't tell when it started
+      @has_completed_but_not_started = true
       not_started stopped: stopped, rules: rules, created: issue.created.to_date
     elsif stopped == rules.current_date
       stopped_today rules: rules
@@ -42,11 +66,11 @@ class DailyWipByAgeChart < DailyWipChart
   def not_started stopped:, rules:, created:
     if stopped == rules.current_date
       rules.label = 'Completed but not started'
-      rules.color = '#66FF66'
+      rules.color = '--wip-chart-completed-but-not-started-color'
       rules.group_priority = -1
     else
       rules.label = 'Start date unknown'
-      rules.color = 'white'
+      rules.color = '--body-background'
       rules.group_priority = 11
       created_days = rules.current_date - created + 1
       rules.issue_hint = "(created: #{label_days created_days.to_i} earlier, stopped on #{stopped})"
@@ -55,7 +79,7 @@ class DailyWipByAgeChart < DailyWipChart
 
   def stopped_today rules:
     rules.label = 'Completed'
-    rules.color = '#009900'
+    rules.color = '--wip-chart-completed-color'
     rules.group_priority = -2
   end
 
@@ -65,23 +89,23 @@ class DailyWipByAgeChart < DailyWipChart
     case age
     when 1
       rules.label = 'Less than a day'
-      rules.color = '#aaaaaa'
+      rules.color = '--wip-chart-duration-less-than-day-color'
       rules.group_priority = 10 # Highest is top
     when 2..7
       rules.label = 'A week or less'
-      rules.color = '#80bfff'
+      rules.color = '--wip-chart-duration-week-or-less-color'
       rules.group_priority = 9
     when 8..14
       rules.label = 'Two weeks or less'
-      rules.color = '#ffd700'
+      rules.color = '--wip-chart-duration-two-weeks-or-less-color'
       rules.group_priority = 8
     when 15..28
       rules.label = 'Four weeks or less'
-      rules.color = '#ce6300'
+      rules.color = '--wip-chart-duration-four-weeks-or-less-color'
       rules.group_priority = 7
     else
       rules.label = 'More than four weeks'
-      rules.color = '#990000'
+      rules.color = '--wip-chart-duration-more-than-four-weeks-color'
       rules.group_priority = 6
     end
   end

data/lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb

@@ -9,68 +9,70 @@ class DailyWipByBlockedStalledChart < DailyWipChart
 
   def default_description_text
     <<-HTML
-      <p>
-        This chart highlights work that is blocked or stalled on each given day. In Jira terms, blocked
-        means that the issue has been "flagged". Stalled indicates that the item hasn't had any updates in 5 days.
-      </p>
-      <p>
-        Note that if an item tracks as both blocked and stalled, it will only show up in the flagged totals.
+      <div class="p">
+        This chart highlights work that is #{color_block '--blocked-color'} blocked,
+        #{color_block '--stalled-color'} stalled, or
+        #{color_block '--wip-chart-active-color'} active on each given day.
+        <ul>
+          <li>#{color_block '--blocked-color'} Blocked could mean that the item has been flagged or it's
+            in a status that is configured as blocked, or it could have a link showing that it is blocked
+          by another item. It all depends how the report has been configured.</li>
+          <li>#{color_block '--stalled-color'} Stalled indicates that there has been no activity on this
+          item in five days.</li>
+        </ul>
+      </div>
+      <div class="p">
+        Note that if an item tracks as both blocked and stalled, it will only show up in the blocked totals.
         It will not be double counted.
-      </p>
-      <p>
-        The white section reflects items that have stopped but for which we can't identify the start date. As
-        a result, we are unable to properly show the WIP for these items.
-      </p>
+      </div>
+      <% if @has_completed_but_not_started %>
+      <div class="p">
+        #{color_block '--wip-chart-completed-but-not-started-color'} "Completed but not started"
+        reflects the fact that while we know that it completed that day, we were unable to determine when
+        it had started; it had moved directly from a To Do status to a Done status.
+        The #{color_block '--body-background'} shading at the top shows when they might
+        have been active. Note that the this grouping is approximate as we just don't know for sure.
+      </div>
+      <% end %>
+      #{describe_non_working_days}
     HTML
   end
 
-  def key_blocked_stalled_change issue:, date:, end_time:
-    stalled_change = nil
-    blocked_change = nil
-
-    issue.blocked_stalled_changes_on_date(date: date, end_time: end_time) do |change|
-      blocked_change = change if change.blocked?
-      stalled_change = change if change.stalled?
-    end
-
-    return blocked_change if blocked_change
-    return stalled_change if stalled_change
-
-    nil
-  end
-
   def default_grouping_rules issue:, rules:
-    started = issue.board.cycletime.started_time(issue)
-    stopped_date = issue.board.cycletime.stopped_time(issue)&.to_date
-    change = key_blocked_stalled_change issue: issue, date: rules.current_date, end_time: time_range.end
+    started, stopped = issue.board.cycletime.started_stopped_times(issue)
+    stopped_date = stopped&.to_date
+
+    date = rules.current_date
+    change = issue.blocked_stalled_by_date(date_range: date..date, chart_end_time: time_range.end)[date]
 
     stopped_today = stopped_date == rules.current_date
 
     if stopped_today && started.nil?
+      @has_completed_but_not_started = true
       rules.label = 'Completed but not started'
-      rules.color = '#66FF66'
+      rules.color = '--wip-chart-completed-but-not-started-color'
       rules.group_priority = -1
     elsif stopped_today
       rules.label = 'Completed'
-      rules.color = '#009900'
+      rules.color = '--wip-chart-completed-color'
       rules.group_priority = -2
     elsif started.nil?
       rules.label = 'Start date unknown'
-      rules.color = 'white'
+      rules.color = '--body-background'
       rules.group_priority = 4
     elsif change&.blocked?
       rules.label = 'Blocked'
-      rules.color = 'red'
+      rules.color = '--blocked-color'
       rules.group_priority = 1
       rules.issue_hint = "(#{change.reasons})"
     elsif change&.stalled?
       rules.label = 'Stalled'
-      rules.color = 'orange'
+      rules.color = '--stalled-color'
       rules.group_priority = 2
       rules.issue_hint = "(#{change.reasons})"
     else
       rules.label = 'Active'
-      rules.color = 'lightgray'
+      rules.color = '--wip-chart-active-color'
       rules.group_priority = 3
     end
   end

data/lib/jirametrics/daily_wip_by_parent_chart.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'jirametrics/daily_wip_chart'
+
+class DailyWipByParentChart < DailyWipChart
+  def default_header_text
+    'Daily WIP, grouped by the parent ticket (Epic, Feature, etc)'
+  end
+
+  def default_description_text
+    <<-HTML
+      <div class="p">
+        How much work is in progress, grouped by the parent of the issue. This will give us an
+        indication of how focused we are on higher level objectives. If there are many parent
+        tickets in progress at the same time, either this team has their focus scattered or we
+        aren't doing a good job of
+        <a href="https://improvingflow.com/2024/02/21/slicing-epics.html">splitting those parent
+        tickets</a>. Neither of those is desirable.
+      </div>
+      <div class="p">
+        The #{color_block '--body-background'} shading at the top shows items that don't have a parent
+        at all.
+      </div>
+      #{describe_non_working_days}
+    HTML
+  end
+
+  def default_grouping_rules issue:, rules:
+    parent = issue.parent&.key
+    if parent
+      rules.label = parent
+    else
+      rules.label = 'No parent'
+      rules.group_priority = 1000
+      rules.color = '--body-background'
+    end
+  end
+end