jirametrics 2.12.1 → 2.30

data/lib/jirametrics/cycletime_scatterplot.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'jirametrics/groupable_issue_chart'
-
-class CycletimeScatterplot < ChartBase
-  include GroupableIssueChart
+require 'jirametrics/time_based_scatterplot'
 
+class CycletimeScatterplot < TimeBasedScatterplot
   attr_accessor :possible_statuses
 
   def initialize block
@@ -26,6 +24,8 @@ class CycletimeScatterplot < ChartBase
       </div>
       #{describe_non_working_days}
     HTML
+    @x_axis_title = 'Date completed'
+    @y_axis_title = 'Cycletime in days'
 
     init_configuration_block block do
       grouping_rules do |issue, rule|
@@ -33,95 +33,29 @@ class CycletimeScatterplot < ChartBase
         rule.color = color_for type: issue.type
       end
     end
-
-    @percentage_lines = []
-    @highest_cycletime = 0
   end
 
-  def run
-    completed_issues = completed_issues_in_range include_unstarted: false
-
-    data_sets = create_datasets completed_issues
-    overall_percent_line = calculate_percent_line(completed_issues)
-    @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?
-
-    wrap_and_render(binding, __FILE__)
+  def minimum_y_value
+    1 # Values under 1 day are data quality problems; they're flagged in the quality report instead
   end
 
-  def create_datasets completed_issues
-    data_sets = []
-
-    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
-      data = completed_issues_by_type.filter_map { |issue| data_for_issue(issue) }
-      data_sets << {
-        label: "#{label} (85% at #{label_days(percent_line)})",
-        data: data,
-        fill: false,
-        showLine: false,
-        backgroundColor: color
-      }
-
-      data_sets << trend_line_data_set(label: label, data: data, color: color)
-
-      @percentage_lines << [percent_line, color]
-    end
-    data_sets
+  def all_items
+    completed_issues_in_range include_unstarted: false
   end
 
-  def show_trend_lines
-    @show_trend_lines = true
+  def x_value item
+    item.started_stopped_times.last
   end
 
-  def trend_line_data_set label:, data:, color:
-    points = data.collect do |hash|
-      [Time.parse(hash[:x]).to_i, hash[:y]]
-    end
-
-    # The trend calculation works with numbers only so convert Time to an int and back
-    calculator = TrendLineCalculator.new(points)
-    data_points = calculator.chart_datapoints(
-      range: time_range.begin.to_i..time_range.end.to_i,
-      max_y: @highest_cycletime
-    )
-    data_points.each do |point_hash|
-      point_hash[:x] = chart_format Time.at(point_hash[:x])
-    end
-
-    {
-      type: 'line',
-      label: "#{label} Trendline",
-      data: data_points,
-      fill: false,
-      borderWidth: 1,
-      markerType: 'none',
-      borderColor: color,
-      borderDash: [6, 3],
-      pointStyle: 'dash',
-      hidden: !@show_trend_lines
-    }
+  def y_value item
+    item.board.cycletime.cycletime(item)
   end
 
-  def data_for_issue issue
-    cycle_time = issue.board.cycletime.cycletime(issue)
-    return nil if cycle_time < 1 # These will get called out on the quality report
-
-    @highest_cycletime = cycle_time if @highest_cycletime < cycle_time
-
-    {
-      y: cycle_time,
-      x: chart_format(issue.board.cycletime.started_stopped_times(issue).last),
-      title: ["#{issue.key} : #{issue.summary} (#{label_days(cycle_time)})"]
-    }
+  def title_value item, rules: nil
+    hint = @issue_hints&.fetch(item, nil)
+    "#{item.key} : #{item.summary} (#{label_days(y_value(item))})#{" #{hint}" if hint}"
   end
 
-  def calculate_percent_line completed_issues
-    times = completed_issues.collect { |issue| issue.board.cycletime.cycletime(issue) }
-    index = times.size * 85 / 100
-    times.sort[index]
-  end
+  # Kept for backwards compatibility with existing callers and specs
+  alias data_for_issue data_for_item
 end

data/lib/jirametrics/daily_view.rb

@@ -9,7 +9,8 @@ class DailyView < ChartBase
     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
+        This view shows all the items (<%= aging_issues.count %>) 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>
@@ -23,7 +24,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><div>There are no items currently in progress</div>" if aging_issues.empty?
 
     result = +''
     result << render_top_text(binding)
@@ -35,7 +36,7 @@ class DailyView < ChartBase
 
   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 = issue.started_stopped_times
       started_at && !stopped_at
     end
 
@@ -72,13 +73,13 @@ class DailyView < ChartBase
 
   def make_blocked_stalled_lines issue
     today = date_range.end
-    started_date = issue.board.cycletime.started_stopped_times(issue).first&.to_date
+    started_date = issue.started_stopped_times.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
+    return [] if blocked_stalled.active?
 
     lines = []
     if blocked_stalled.blocked?
@@ -86,9 +87,15 @@ class DailyView < ChartBase
       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
+        blocking_issue = issues.find_by_key key: key, include_hidden: true
+        if blocking_issue
+          lines << "<section><div class=\"foldable startFolded\">#{marker} Blocked by issue: " \
+            "#{make_issue_label issue: blocking_issue, done: blocking_issue.done?}</div>"
+          lines << blocking_issue
+          lines << '</section>'
+        else
+          lines << ["#{marker} Blocked by issue: #{key} (no description found)"]
+        end
       end
     elsif blocked_stalled.stalled_by_status?
       lines << ["#{color_block '--stalled-color'} Stalled by status: #{blocked_stalled.status}"]
@@ -98,15 +105,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 +125,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) }
@@ -138,7 +153,18 @@ class DailyView < ChartBase
       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
+    if issue.due_date
+      today = date_range.end
+      days = (issue.due_date - today).to_i
+      relative =
+        if days.zero? then 'today'
+        elsif days.positive? then "in #{label_days days}"
+        else "#{label_days(-days)} ago"
+        end
+      content = "#{issue.due_date} (#{relative})"
+      content = "<span style='background: var(--warning-banner)'>#{content}</span>" if days.negative?
+      line << "Due: <b>#{content}</b>"
+    end
 
     block = lambda do |collection, label|
       unless collection.empty?
@@ -154,45 +180,26 @@ 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 startFolded\">Child issues (#{subtasks.count})</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'
+      time = c.time.strftime '%b %d, %Y @ %I:%M%P'
 
       table << '<tr>'
       table << "<td><span class='time' title='Timestamp: #{c.time}'>#{time}</span></td>"
@@ -203,23 +210,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,16 +253,31 @@ class DailyView < ChartBase
       .join(' ')]]
   end
 
+  def make_description_lines issue
+    description = issue.raw['fields']['description']
+    return [] unless description
+
+    text = "<div class='foldable startFolded'>Description</div>" \
+           "<div>#{atlassian_document_format.to_html(description)}</div>"
+    [[text]]
+  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_not_visible_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
+    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.compact
   end
 
   def render_issue issue, child:
@@ -264,6 +287,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|
@@ -274,4 +299,8 @@ class DailyView < ChartBase
     end
     result << '</div>'
   end
+
+  def make_not_visible_line issue
+    not_visible_text issue
+  end
 end

data/lib/jirametrics/daily_wip_by_age_chart.rb

@@ -49,9 +49,7 @@ class DailyWipByAgeChart < DailyWipChart
   end
 
   def default_grouping_rules issue:, rules:
-    started, stopped = issue.board.cycletime.started_stopped_dates(issue)
-
-    rules.issue_hint = "(age: #{label_days (rules.current_date - started + 1).to_i})" if started
+    started, stopped = issue.started_stopped_dates
 
     if stopped && started.nil? # We can't tell when it started
       @has_completed_but_not_started = true
@@ -72,7 +70,7 @@ class DailyWipByAgeChart < DailyWipChart
       rules.label = 'Start date unknown'
       rules.color = '--body-background'
       rules.group_priority = 11
-      created_days = rules.current_date - created + 1
+      created_days = rules.current_date - created
       rules.issue_hint = "(created: #{label_days created_days.to_i} earlier, stopped on #{stopped})"
     end
   end
@@ -84,7 +82,8 @@ class DailyWipByAgeChart < DailyWipChart
   end
 
   def group_by_age started:, rules:
-    age = rules.current_date - started + 1
+    age = (rules.current_date - started).to_i + 1
+    rules.issue_hint = "(age: #{label_days age})"
 
     case age
     when 1

data/lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb

@@ -39,23 +39,32 @@ class DailyWipByBlockedStalledChart < DailyWipChart
   end
 
   def default_grouping_rules issue:, rules:
-    started, stopped = issue.board.cycletime.started_stopped_times(issue)
+    started, stopped = issue.started_stopped_times
     stopped_date = stopped&.to_date
+    started_date = started&.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
 
+    days = nil
+    if started_date && stopped_date
+      days = (stopped_date - started_date).to_i + 1 # cycletime
+    elsif started_date
+      days = (time_range.end.to_date - started_date).to_i + 1 # age
+    end
+
     if stopped_today && started.nil?
       @has_completed_but_not_started = true
       rules.label = 'Completed but not started'
       rules.color = '--wip-chart-completed-but-not-started-color'
       rules.group_priority = -1
+      rules.issue_hint = '(Cycle time: Unknown)'
     elsif stopped_today
       rules.label = 'Completed'
       rules.color = '--wip-chart-completed-color'
       rules.group_priority = -2
+      rules.issue_hint = "(Cycle time: #{label_days days})"
     elsif started.nil?
       rules.label = 'Start date unknown'
       rules.color = '--body-background'
@@ -64,16 +73,17 @@ class DailyWipByBlockedStalledChart < DailyWipChart
       rules.label = 'Blocked'
       rules.color = '--blocked-color'
       rules.group_priority = 1
-      rules.issue_hint = "(#{change.reasons})"
+      rules.issue_hint = "(Age: #{label_days days}, #{change.reasons})"
     elsif change&.stalled?
       rules.label = 'Stalled'
       rules.color = '--stalled-color'
       rules.group_priority = 2
-      rules.issue_hint = "(#{change.reasons})"
+      rules.issue_hint = "(Age: #{label_days days}, #{change.reasons})"
     else
       rules.label = 'Active'
       rules.color = '--wip-chart-active-color'
       rules.group_priority = 3
+      rules.issue_hint = "(Age: #{label_days days})"
     end
   end
 end

data/lib/jirametrics/daily_wip_by_parent_chart.rb

@@ -26,11 +26,13 @@ class DailyWipByParentChart < DailyWipChart
   end
 
   def default_grouping_rules issue:, rules:
-    parent = issue.parent&.key
+    parent = issue.parent
     if parent
-      rules.label = parent
+      rules.label = parent.key
+      rules.label_hint = "#{parent.key} : #{parent.summary}"
     else
       rules.label = 'No parent'
+      rules.label_hint = 'No parent'
       rules.group_priority = 1000
       rules.color = '--body-background'
     end

data/lib/jirametrics/daily_wip_chart.rb

@@ -3,12 +3,16 @@
 require 'jirametrics/chart_base'
 
 class DailyGroupingRules < GroupingRules
-  attr_accessor :current_date, :group_priority, :issue_hint
+  attr_accessor :current_date, :group_priority, :issue_hint, :highlight
 
   def initialize
     super
     @group_priority = 0
   end
+
+  def group
+    [@label, @color, @highlight ? true : false]
+  end
 end
 
 class DailyWipChart < ChartBase
@@ -19,6 +23,8 @@ class DailyWipChart < ChartBase
 
     header_text default_header_text
     description_text default_description_text
+    @x_axis_title = nil
+    @y_axis_title = 'Count of items'
 
     instance_eval(&block) if block
 
@@ -33,8 +39,15 @@ class DailyWipChart < ChartBase
     issue_rules_by_active_date = group_issues_by_active_dates
     possible_rules = select_possible_rules issue_rules_by_active_date
 
+    conflicting_labels = possible_rules
+      .group_by(&:label)
+      .select { |_label, rules| rules.any?(&:highlight) && rules.any? { |r| !r.highlight } }
+      .keys
+
     data_sets = possible_rules.collect do |grouping_rule|
-      make_data_set grouping_rule: grouping_rule, issue_rules_by_active_date: issue_rules_by_active_date
+      suffix = conflicting_labels.include?(grouping_rule.label) && grouping_rule.highlight ? '*' : ''
+      make_data_set grouping_rule: grouping_rule, issue_rules_by_active_date: issue_rules_by_active_date,
+                    label_suffix: suffix
     end
     if @trend_lines
       data_sets = @trend_lines.filter_map do |group_labels, line_color|
@@ -66,7 +79,7 @@ class DailyWipChart < ChartBase
     hash = {}
 
     @issues.each do |issue|
-      start, stop = issue.board.cycletime.started_stopped_dates(issue)
+      start, stop = cycletime_for_issue(issue).started_stopped_dates(issue)
       next if start.nil? && stop.nil?
 
       # If it stopped but never started then assume it started at creation so the data points
@@ -82,16 +95,17 @@ class DailyWipChart < ChartBase
     hash
   end
 
-  def make_data_set grouping_rule:, issue_rules_by_active_date:
+  def make_data_set grouping_rule:, issue_rules_by_active_date:, label_suffix: ''
     positive = grouping_rule.group_priority >= 0
+    display_label = "#{grouping_rule.label}#{label_suffix}"
 
     data = issue_rules_by_active_date.collect do |date, issue_rules|
-      # issues = []
       issue_strings = issue_rules
         .select { |_issue, rules| rules.group == grouping_rule.group }
         .sort_by { |issue, _rules| issue.key_as_i }
         .collect { |issue, rules| "#{issue.key} : #{issue.summary.strip} #{rules.issue_hint}" }
-      title = ["#{grouping_rule.label} (#{label_issues issue_strings.size})"] + issue_strings
+      title_label = grouping_rule.label_hint || display_label
+      title = ["#{title_label} (#{label_issues issue_strings.size})"] + issue_strings
 
       {
         x: date,
@@ -100,11 +114,19 @@ class DailyWipChart < ChartBase
       }
     end
 
+    color = grouping_rule.color || random_color
+    background_color = if grouping_rule.highlight
+                         RawJavascript.new("createDiagonalPattern(#{color.to_json})")
+                       else
+                         color
+                       end
+
     {
       type: 'bar',
-      label: grouping_rule.label,
+      label: display_label,
+      label_hint: grouping_rule.label_hint,
       data: data,
-      backgroundColor: grouping_rule.color || random_color,
+      backgroundColor: background_color,
       borderColor: CssVariable['--wip-chart-border-color'],
       borderWidth: grouping_rule.color.to_s == 'var(--body-background)' ? 1 : 0,
       borderRadius: positive ? 0 : 5