jirametrics 2.12.1 → 2.22

data/lib/jirametrics/change_item.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 class ChangeItem
-  attr_reader :field, :value_id, :old_value_id, :raw, :time, :author_raw
-  attr_accessor :value, :old_value
+  attr_reader :field, :value_id, :old_value_id, :raw, :author_raw, :field_id
+  attr_accessor :value, :old_value, :time
 
   def initialize raw:, author_raw:, time:, artificial: false
     @raw = raw
@@ -13,9 +13,15 @@ class ChangeItem
 
     @field = @raw['field']
     @value = @raw['toString']
-    @value_id = @raw['to'].to_i
     @old_value = @raw['fromString']
-    @old_value_id = @raw['from']&.to_i
+    if sprint?
+      @value_id = @raw['to'].split(', ').collect(&:to_i)
+      @old_value_id = (@raw['from'] || '').split(', ').collect(&:to_i)
+    else
+      @value_id = @raw['to'].to_i
+      @old_value_id = @raw['from']&.to_i
+    end
+    @field_id = @raw['fieldId']
     @artificial = artificial
   end
 
@@ -30,6 +36,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'
@@ -53,6 +60,7 @@ class ChangeItem
       message << ':' << old_value_id.inspect if status?
     end
     message << ", time: #{time_to_s(@time).inspect}"
+    message << ", field_id: #{@field_id.inspect}" if @field_id
     message << ', artificial' if artificial?
     message << ')'
     message

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
 
@@ -21,6 +22,14 @@ class ChartBase
     @canvas_responsive = true
   end
 
+  def call_before_run &proc
+    (@call_before_run_procs ||= []) << proc
+  end
+
+  def before_run
+    @call_before_run_procs&.each { |proc| proc.call }
+  end
+
   def aggregated_project?
     @aggregated_project
   end
@@ -44,7 +53,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 +75,8 @@ class ChartBase
   end
 
   def label_days days
+    return 'unknown' if days.nil?
+
     "#{days} day#{'s' unless days == 1}"
   end
 
@@ -276,4 +287,27 @@ class ChartBase
       </div>
     TEXT
   end
+
+  # Set a cycletime for just this one chart, overriding the one for the report.
+  def cycletime &block
+    call_before_run do
+      @cycletime = CycleTimeConfig.new(
+        possible_statuses: possible_statuses, label: nil, block: block, file_system: file_system,
+        settings: settings
+      )
+    end
+  end
+
+  # Returns the cycletime in use right now, which may be specific to the chart or across the report.
+  def cycletime_for_issue issue
+    @cycletime || issue.board.cycletime
+  end
+
+  def seam_start type = 'chart'
+    "\n<!-- seam-start | chart#{@@chart_counter} | #{self.class} | #{header_text} | #{type} -->"
+  end
+
+  def seam_end type = 'chart'
+    "\n<!-- seam-end | chart#{@@chart_counter} | #{self.class} | #{header_text} | #{type} -->"
+  end
 end

data/lib/jirametrics/cycletime_config.rb

@@ -6,12 +6,14 @@ require 'date'
 class CycleTimeConfig
   include SelfOrIssueDispatcher
 
-  attr_reader :label, :parent_config
+  attr_reader :label, :possible_statuses, :settings, :file_system
 
-  def initialize parent_config:, label:, block:, file_system: nil, today: Date.today
-    @parent_config = parent_config
+  def initialize possible_statuses:, label:, block:, settings:, file_system: nil, today: Date.today
+
+    @possible_statuses = possible_statuses
     @label = label
     @today = today
+    @settings = settings
 
     # If we hit something deprecated and this is nil then we'll blow up. Although it's ugly, this
     # may make it easier to find problems in the test code ;-)
@@ -63,6 +65,10 @@ class CycleTimeConfig
   end
 
   def started_stopped_changes issue
+    cache_key = "#{issue.key}:#{issue.board.id}"
+    last_result = (@cache ||= {})[cache_key]
+    return *last_result if last_result && settings['cache_cycletime_calculations']
+
     started = @start_at.call(issue)
     stopped = @stop_at.call(issue)
 
@@ -80,7 +86,15 @@ class CycleTimeConfig
     # for the start and not have it conflict.
     started = nil if started&.time == stopped&.time
 
-    [started, stopped]
+    result = [started, stopped]
+    if last_result && result != last_result
+      @file_system.error(
+        "Calculation mismatch; this could break caching. #{issue.inspect} new=#{result.inspect}, " \
+          "previous=#{last_result.inspect}"
+      )
+    end
+    @cache[cache_key] = result
+    result
   end
 
   def started_stopped_times issue
@@ -88,6 +102,10 @@ class CycleTimeConfig
     [started&.time, stopped&.time]
   end
 
+  def flush_cache
+    @cache = nil
+  end
+
   def started_stopped_dates issue
     started_time, stopped_time = started_stopped_times(issue)
     [started_time&.to_date, stopped_time&.to_date]

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

@@ -35,14 +35,33 @@ class CycletimeScatterplot < ChartBase
     end
 
     @percentage_lines = []
-    @highest_cycletime = 0
+    @highest_y_value = 0
   end
 
-  def run
-    completed_issues = completed_issues_in_range include_unstarted: false
+  def all_items
+    completed_issues_in_range include_unstarted: false
+  end
+
+  def x_value item
+    item.board.cycletime.started_stopped_times(item).last
+  end
+
+  def y_value item
+    item.board.cycletime.cycletime(item)
+  end
 
-    data_sets = create_datasets completed_issues
-    overall_percent_line = calculate_percent_line(completed_issues)
+  def title_value item
+    "#{item.key} : #{item.summary} (#{label_days(y_value(item))})"
+  end
+
+  def y_axis_heading
+    'Cycle time in days'
+  end
+
+  def run
+    items = all_items
+    data_sets = create_datasets items
+    overall_percent_line = calculate_percent_line(items)
     @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?
@@ -50,14 +69,14 @@ class CycletimeScatterplot < ChartBase
     wrap_and_render(binding, __FILE__)
   end
 
-  def create_datasets completed_issues
+  def create_datasets items
     data_sets = []
 
-    group_issues(completed_issues).each do |rules, completed_issues_by_type|
+    group_issues(items).each do |rules, completed_items_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) }
+      percent_line = calculate_percent_line completed_items_by_type
+      data = completed_items_by_type.filter_map { |issue| data_for_issue(issue) }
       data_sets << {
         label: "#{label} (85% at #{label_days(percent_line)})",
         data: data,
@@ -86,7 +105,7 @@ class CycletimeScatterplot < ChartBase
     calculator = TrendLineCalculator.new(points)
     data_points = calculator.chart_datapoints(
       range: time_range.begin.to_i..time_range.end.to_i,
-      max_y: @highest_cycletime
+      max_y: @highest_y_value
     )
     data_points.each do |point_hash|
       point_hash[:x] = chart_format Time.at(point_hash[:x])
@@ -106,21 +125,21 @@ class CycletimeScatterplot < ChartBase
     }
   end
 
-  def data_for_issue issue
-    cycle_time = issue.board.cycletime.cycletime(issue)
+  def data_for_issue item
+    cycle_time = y_value(item)
     return nil if cycle_time < 1 # These will get called out on the quality report
 
-    @highest_cycletime = cycle_time if @highest_cycletime < cycle_time
+    @highest_y_value = cycle_time if @highest_y_value < 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)})"]
+      x: chart_format(x_value(item)),
+      title: [title_value(item)]
     }
   end
 
-  def calculate_percent_line completed_issues
-    times = completed_issues.collect { |issue| issue.board.cycletime.cycletime(issue) }
+  def calculate_percent_line items
+    times = items.collect { |item| y_value(item) }
     index = times.size * 85 / 100
     times.sort[index]
   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,45 +162,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">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'
+      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 +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/daily_wip_by_age_chart.rb

@@ -51,8 +51,6 @@ class DailyWipByAgeChart < DailyWipChart
   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
-
     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
@@ -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

@@ -41,21 +41,30 @@ class DailyWipByBlockedStalledChart < DailyWipChart
   def default_grouping_rules issue:, rules:
     started, stopped = issue.board.cycletime.started_stopped_times(issue)
     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_chart.rb

@@ -66,7 +66,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

data/lib/jirametrics/data_quality_report.rb

@@ -266,6 +266,8 @@ class DataQualityReport < ChartBase
 
   def scan_for_items_blocked_on_closed_tickets entry:
     entry.issue.issue_links.each do |link|
+      next unless settings['blocked_link_text'].include?(link.label)
+
       this_active = !entry.stopped
       other_active = !link.other_issue.board.cycletime.started_stopped_times(link.other_issue).last
       next unless this_active && !other_active
@@ -410,14 +412,17 @@ class DataQualityReport < ChartBase
   def render_status_not_on_board problems
     <<-HTML
       #{label_issues problems.size} were not visible on the board for some period of time. This may impact
-      timings as the work was likely to have been forgotten if it wasn't visible.
+      timings as the work was likely to have been forgotten if it wasn't visible. What does "not visible"
+      mean in this context? The issue was in a status that is not mapped to any visible column on the board.
+      Look in "unmapped statuses" on your board.
     HTML
   end
 
   def render_created_in_wrong_status problems
     <<-HTML
-      #{label_issues problems.size} were created in a status not designated as Backlog. This will impact
-      the measurement of start times and will therefore impact whether it's shown as in progress or not.
+      #{label_issues problems.size} were created in a status that is not considered to be some varient
+      of To Do. Most likely this means that the issue was created from one of the columns on the board,
+      rather than in the backlog. Why Jira allows this is still a mystery.
     HTML
   end
 

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}"