jirametrics 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b424b3a1faea57826e0afa0d607b5edea1b824a14af63d2f4fc6b00e4f0c6190
-  data.tar.gz: c4fa2e71b82a118140cbcfaeb8000133917189c5449d7aa03a93d601b2df410b
+  metadata.gz: 0f5551ca8d38a0b12579429080055e21bb161066e7bb2237ada5d47628a212de
+  data.tar.gz: 7bd667226812044854dde31dfac4f347380b077369ec711bec5d6cb98a0082e8
 SHA512:
-  metadata.gz: b361d8f4ab3952de3fbc3b39f70704e6817a157d9166218ad436f80f13ca80d83b26a10a002c08528da298a9e8a961ed699dbb121fc6a7edda75572209c0501f
-  data.tar.gz: 86ce2be29726bf2870d8a8bda0e6fd12184f09946e1cbb04fd66b8666b2ae878ec405e20f2b1658f42ccc6f6b783222853d95cb1603b34158a0ada3e4e37c897
+  metadata.gz: 397a3c4eb84497df209c702858a77def1d9606eecf84d08a8ab7b4f0a6decd968f77ed617f8189acb4916e372742bfc8352bb0fcd2b5ad74e04880c03680fece
+  data.tar.gz: 8aa2cbc8d7e60ed80749bf58c48d78689adcb65892ad133a378956b308fdb3d326a665eb3a884bd9d29783142639813f696c77f393697e285a0b7769fbe0ad18

data/lib/jirametrics/aggregate_config.rb

@@ -3,7 +3,7 @@
 require 'date'
 
 class AggregateConfig
-  attr_reader :project_config
+  attr_reader :project_config, :included_projects
 
   def initialize project_config:, block:
     @project_config = project_config

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -27,10 +27,7 @@ class AgingWorkBarChart < ChartBase
           <li>The bottom bar indicated #{color_block '--expedited-color'} expedited.</li>
         </ol>
       </p>
-      <p>
-        The gray backgrounds indicate weekends and the red vertical line indicates the 85% point for all
-        items in this time period. Anything that started to the left of that is now an outlier.
-      </p>
+      #{ describe_non_working_days }
     HTML
 
     # Because this one will size itself as needed, we start with a smaller default size

data/lib/jirametrics/aging_work_table.rb

@@ -11,6 +11,18 @@ class AgingWorkTable < ChartBase
     @dead_threshold = 45
     @age_cutoff = 0
 
+    header_text 'Aging Work Table'
+    description_text <<-TEXT
+      <p>
+        This chart shows all active (started but not completed) work, ordered from oldest at the top to
+        newest at the bottom.
+      </p>
+      <p>
+        If there are expedited items that haven't yet started then they're at the bottom of the table.
+        By the very definition of expedited, if we haven't started them already, we'd better get on that.
+      </p>
+    TEXT
+
     instance_eval(&block) if block
   end
 
@@ -24,7 +36,7 @@ class AgingWorkTable < ChartBase
     end
     aging_issues += expedited_but_not_started.sort_by(&:created)
 
-    render(binding, __FILE__)
+    wrap_and_render(binding, __FILE__)
   end
 
   def select_aging_issues

data/lib/jirametrics/chart_base.rb

@@ -38,11 +38,16 @@ class ChartBase
     erb.result(caller_binding)
   end
 
-  # Render the file and then wrap it with standard headers and quality checks.
-  def wrap_and_render caller_binding, file
+  def render_top_text caller_binding
     result = +''
     result << "<h1>#{@header_text}</h1>" if @header_text
     result << ERB.new(@description_text).result(caller_binding) if @description_text
+  end
+
+  # Render the file and then wrap it with standard headers and quality checks.
+  def wrap_and_render caller_binding, file
+    result = +''
+    result << render_top_text(caller_binding)
     result << render(caller_binding, file)
     result
   end
@@ -238,4 +243,13 @@ class ChartBase
     result << '></div>'
     result
   end
+
+  def describe_non_working_days
+    <<-TEXT
+      <div class='p'>
+        The #{color_block '--non-working-days-color'} vertical bars indicate non-working days; weekends
+        and any other holidays mentioned in the configuration.
+      </div>
+    TEXT
+  end  
 end

data/lib/jirametrics/cycletime_scatterplot.rb

@@ -12,11 +12,11 @@ class CycletimeScatterplot < ChartBase
 
     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>
-      <div style="padding-bottom: 0.7em">
+      </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%
@@ -24,10 +24,7 @@ class CycletimeScatterplot < ChartBase
         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.
       </div>
-      <div>
-        The #{color_block '--non-working-days-color'} vertical bars indicate weekends, when theoretically
-        we aren't working.
-      </div>
+      #{ describe_non_working_days }
     HTML
 
     init_configuration_block block do

data/lib/jirametrics/daily_wip_by_age_chart.rb

@@ -3,23 +3,48 @@
 require 'jirametrics/daily_wip_chart'
 
 class DailyWipByAgeChart < DailyWipChart
+  def initialize block = nil
+    super(block)
+
+    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 this grouping 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
 
@@ -31,6 +56,7 @@ class DailyWipByAgeChart < DailyWipChart
     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

data/lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb

@@ -9,7 +9,7 @@ class DailyWipByBlockedStalledChart < DailyWipChart
 
   def default_description_text
     <<-HTML
-      <div>
+      <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.
@@ -21,14 +21,20 @@ class DailyWipByBlockedStalledChart < DailyWipChart
           item in five days.</li>
         </ul>
       </div>
-      <p>
+      <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>
-      <div>
-        The #{color_block '--body-background'} shaded 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.
       </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
 
@@ -55,6 +61,7 @@ class DailyWipByBlockedStalledChart < DailyWipChart
     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 = '--wip-chart-completed-but-not-started-color'
       rules.group_priority = -1

data/lib/jirametrics/daily_wip_by_parent_chart.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'jirametrics/daily_wip_chart'
+
+class DailyWipByParentChart < DailyWipChart
+  def initialize block
+    super(block)
+  end
+
+  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

data/lib/jirametrics/daily_wip_chart.rb

@@ -20,13 +20,16 @@ class DailyWipChart < ChartBase
     header_text default_header_text
     description_text default_description_text
 
-    if block
-      instance_eval(&block)
-    else
+    instance_eval(&block) if block
+
+    unless @group_by_block
       grouping_rules do |issue, rules|
         default_grouping_rules issue: issue, rules: rules
       end
     end
+
+    # Because this one will size itself as needed, we start with a smaller default size
+    # @canvas_height = 80
   end
 
   def run
@@ -36,6 +39,13 @@ class DailyWipChart < ChartBase
     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
     end
+    if @trend_lines
+      data_sets = @trend_lines.filter_map do |group_labels, line_color|
+        trend_line_data_set(data: data_sets, group_labels: group_labels, color: line_color)
+      end + data_sets
+    end
+
+    # grow_chart_height_if_too_many_data_sets data_sets.size
 
     wrap_and_render(binding, __FILE__)
   end
@@ -109,7 +119,7 @@ class DailyWipChart < ChartBase
   end
 
   def configure_rule issue:, date:
-    raise 'grouping_rules must be set' if @group_by_block.nil?
+    raise "#{self.class}: grouping_rules must be set" if @group_by_block.nil?
 
     rules = DailyGroupingRules.new
     rules.current_date = date
@@ -120,4 +130,55 @@ class DailyWipChart < ChartBase
   def grouping_rules &block
     @group_by_block = block
   end
+
+  def add_trend_line group_labels:, line_color:
+    (@trend_lines ||= []) << [group_labels, line_color]
+  end
+
+  def trend_line_data_set data:, group_labels:, color:
+    day_wip_hash = {}
+    data.each do |top_level|
+      next unless group_labels.include? top_level[:label]
+
+      top_level[:data].each do |datapoint|
+        date = datapoint[:x]
+        day_wip_hash[date] = (day_wip_hash[date] || 0) + datapoint[:y]
+      end
+    end
+
+    points = day_wip_hash
+      .collect { |date, wip| [date.jd, wip] }
+      .sort_by(&:first)
+
+    calculator = TrendLineCalculator.new(points)
+    return nil unless calculator.valid?
+
+    data_points = calculator.chart_datapoints(
+      range: date_range.begin.jd..date_range.end.jd,
+      max_y: points.collect { |_date, wip| wip }.max
+    )
+    data_points.each do |point_hash|
+      point_hash[:x] = chart_format Date.jd(point_hash[:x])
+    end
+
+    {
+      type: 'line',
+      label: "Trendline",
+      data: data_points,
+      fill: false,
+      borderWidth: 1,
+      markerType: 'none',
+      borderColor: CssVariable[color],
+      borderDash: [6, 3],
+      pointStyle: 'dash',
+      hidden: false
+    }
+  end
+
+  def grow_chart_height_if_too_many_data_sets count
+    px_per_bar = 8
+    bars_per_issue = 0.5
+    preferred_height = count * px_per_bar * bars_per_issue
+    @canvas_height = preferred_height if @canvas_height.nil? || @canvas_height < preferred_height
+  end
 end

data/lib/jirametrics/data_quality_report.rb

@@ -271,7 +271,7 @@ class DataQualityReport < ChartBase
       board_names = entry_list.collect { |entry| entry.issue.board.name.inspect }
       entry_list.first.report(
         problem_key: :issue_on_multiple_boards,
-        detail: "Found on boards: #{board_names.join(', ')}"
+        detail: "Found on boards: #{board_names.sort.join(', ')}"
       )
     end
   end

data/lib/jirametrics/downloader.rb

@@ -148,9 +148,9 @@ class Downloader
 
   def exit_if_call_failed json
     # Sometimes Jira returns the singular form of errorMessage and sometimes the plural. Consistency FTW.
-    return unless json['errorMessages'] || json['errorMessage']
+    return unless json['error'] || json['errorMessages'] || json['errorMessage']
 
-    log "Download failed. See #{@logfile_name} for details.", both: true
+    log "Download failed. See #{@file_system.logfile_name} for details.", both: true
     log "  #{JSON.pretty_generate(json)}"
     exit 1
   end
@@ -168,13 +168,16 @@ class Downloader
   def download_board_configuration board_id:
     log "  Downloading board configuration for board #{board_id}", both: true
     json = @jira_gateway.call_url relative_url: "/rest/agile/1.0/board/#{board_id}/configuration"
-    exit_if_call_failed json
 
-    @board_id_to_filter_id[board_id] = json['filter']['id'].to_i
+    exit_if_call_failed json
 
     file_prefix = @download_config.project_config.file_prefix
     @file_system.save_json json: json, filename: "#{@target_path}#{file_prefix}_board_#{board_id}_configuration.json"
 
+    # We have a reported bug that blew up on this line. Moved it after the save so we can
+    # actually look at the returned json.
+    @board_id_to_filter_id[board_id] = json['filter']['id'].to_i
+
     download_sprints board_id: board_id if json['type'] == 'scrum'
   end
 

data/lib/jirametrics/examples/aggregated_project.rb

@@ -30,32 +30,27 @@ class Exporter
         end
 
         html_report do
+          html '<h1>Boards included in this report</h1><ul>', type: :header
+          board_lines = []
+          included_projects.each do |project|
+            project.all_boards.values.each do |board|
+              board_lines << "<a href='#{project.file_prefix}.html'>#{board.name}</a> from project #{project.name}"
+            end
+          end
+          board_lines.sort.each { |line| html "<li>#{line}</li>", type: :header }
+          html '</ul>', type: :header
+
           cycletime_scatterplot do
             show_trend_lines
+            # For an aggregated report we group by board rather than by type
             grouping_rules do |issue, rules|
               rules.label = issue.board.name
             end
           end
           # aging_work_in_progress_chart
-          daily_wip_chart do
-            header_text 'Daily WIP by Parent'
-            description_text <<-TEXT
-              <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.</p>
-              <p>If you're expecting all work items to have parents and there are a lot that don't,
-              that's also something to look at. Consider whether there is even value in aggregating
-              these projects if they don't share parent dependencies. Aggregation helps us when we're
-              looking at related work and if there aren't parent dependencies then the work may not
-              be related.</p>
-            TEXT
-            grouping_rules do |issue, rules|
-              rules.label = issue.parent&.key || 'No parent'
-              rules.color = 'white' if rules.label == 'No parent'
-            end
+          daily_wip_by_parent_chart do
+            # When aggregating, the chart tends to need more vertical space
+            canvas height: 400, width: 800
           end
           aging_work_table do
             # In an aggregated report, we likely only care about items that are old so exclude anything

data/lib/jirametrics/examples/standard_project.rb

@@ -83,21 +83,7 @@ class Exporter
           aging_work_table
           daily_wip_by_age_chart
           daily_wip_by_blocked_stalled_chart
-          daily_wip_chart do
-            header_text 'Daily WIP by Parent'
-            description_text <<-TEXT
-              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.
-            TEXT
-            grouping_rules do |issue, rules|
-              rules.label = issue.parent&.key || 'No parent'
-              rules.color = '--body-background' if rules.label == 'No parent'
-            end
-          end
+          daily_wip_by_parent_chart
           expedited_chart
           sprint_burndown
           story_point_accuracy_chart

data/lib/jirametrics/expedited_chart.rb

@@ -25,19 +25,18 @@ class ExpeditedChart < ChartBase
 
     header_text 'Expedited work'
     description_text <<-HTML
-      <p>
+      <div class="p">
         This chart only shows issues that have been expedited at some point. We care about these as
         any form of expedited work will affect the entire system and will slow down non-expedited work.
         Refer to this article on
         <a href="https://improvingflow.com/2021/06/16/classes-of-service.html">classes of service</a>
         for a longer explanation on why we want to avoid expedited work.
-      </p>
-      <p>
-        The lines indicate time that this issue was expedited. When the line is red then the issue was
-        expedited at that time. When it's gray then it wasn't. Orange dots indicate the date the work
-        was started and green dots represent the completion date. Lastly, the vertical height of the
-        lines/dots indicates how long it's been since this issue was created.
-      </p>
+      </div>
+      <div class="p">
+        The colour of the line indicates time that this issue was #{color_block '--expedited-color'} expedited
+        or #{color_block '--expedited-chart-no-longer-expedited'} not expedited.
+      </div>
+      #{describe_non_working_days}
     HTML
   end
 
@@ -127,20 +126,20 @@ class ExpeditedChart < ChartBase
       case action
       when :issue_started
         data << make_point(issue: issue, time: time, label: 'Started', expedited: expedited)
-        dot_colors << 'orange'
+        dot_colors << CssVariable['--expedited-chart-dot-issue-started-color']
         point_styles << 'rect'
       when :issue_stopped
         data << make_point(issue: issue, time: time, label: 'Completed', expedited: expedited)
-        dot_colors << 'green'
+        dot_colors << CssVariable['--expedited-chart-dot-issue-stopped-color']
         point_styles << 'rect'
       when :expedite_start
         data << make_point(issue: issue, time: time, label: 'Expedited', expedited: true)
-        dot_colors << 'red'
+        dot_colors << CssVariable['--expedited-chart-dot-expedite-started-color']
         point_styles << 'circle'
         expedited = true
       when :expedite_stop
         data << make_point(issue: issue, time: time, label: 'Not expedited', expedited: false)
-        dot_colors << 'gray'
+        dot_colors << CssVariable['--expedited-chart-dot-expedite-stopped-color']
         point_styles << 'circle'
         expedited = false
       else
@@ -152,7 +151,7 @@ class ExpeditedChart < ChartBase
       last_change_time = expedite_data[-1][0].to_date
       if last_change_time && last_change_time <= date_range.end && stopped_time.nil?
         data << make_point(issue: issue, time: date_range.end, label: 'Still ongoing', expedited: expedited)
-        dot_colors << 'blue' # It won't be visible so it doesn't matter
+        dot_colors << '' # It won't be visible so it doesn't matter
         point_styles << 'dash'
       end
     end

data/lib/jirametrics/html/aging_work_table.erb

@@ -1,20 +1,3 @@
-<h1>Aging Work Table</h1>
-<p>
-  This chart shows all active (started but not completed) work, ordered from oldest at the top to 
-  newest at the bottom.
-</p>
-<p>
-  If there are expedited items that haven't yet started then they're at the bottom of the table. By the
-  very definition of expedited, if we haven't started them already, we'd better get on that.
-</p>
-<p>
-  <% if age_cutoff > 0 %>
-    Items less than <%= label_days age_cutoff %> old have been excluded from this chart to provide more
-    focus on the older items. The exception are items that are either expedited or blocked - these are
-    shown no matter how old they are.
-  <% end %>
-</p>
-
 <table class='standard'>
   <thead>
     <tr>
@@ -31,9 +14,18 @@
     </tr>
   </thead>
   <tbody>
+    <% show_age_cutoff_bar_at = age_cutoff %>
     <% aging_issues.each do |issue| %>
+      <% issue_age = issue.board.cycletime.age(issue, today: @today) %>
+      <% if show_age_cutoff_bar_at && issue_age&.<(show_age_cutoff_bar_at) %>
+        <tr><th colspan=100 style="text-align: left; padding-top: 1em;">
+          The items below are less than <%= label_days age_cutoff %> old, and are only on this report
+          because they're either expedited or blocked.
+        </th></tr>
+        <% show_age_cutoff_bar_at = nil %>
+      <% end %>
       <tr>
-        <td style="text-align: right;"><%= issue.board.cycletime.age(issue, today: @today) || 'Not started' %></td>
+        <td style="text-align: right;"><%= issue_age || 'Not started' %></td>
         <td><%= expedited_text(issue) %></td>
         <td><%= blocked_text(issue) %></td>
         <td>

data/lib/jirametrics/html/daily_wip_chart.erb

@@ -61,6 +61,14 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
           },
           <% end %>
         }
+      },
+      legend: {
+        labels: {
+          filter: function(item, chart) {
+            // Logic to remove a particular legend item goes here
+            return !item.text.includes('Trendline');
+          }
+        }
       }
     }
   }

data/lib/jirametrics/html/index.css

@@ -26,6 +26,7 @@
   --throughput_chart_total_line_color: gray;
   
   --aging-work-in-progress-chart-shading-color: lightgray;
+  --aging-work-in-progress-by-age-trend-line-color: gray;
   
   --hierarchy-table-inactive-item-text-color: gray;
 
@@ -45,12 +46,18 @@
   --estimate-accuracy-chart-active-border-color: red;
 
   --expedited-chart-no-longer-expedited: gray;
+  --expedited-chart-dot-issue-started-color: orange;
+  --expedited-chart-dot-issue-stopped-color: green;
+  --expedited-chart-dot-expedite-started-color: red;
+  --expedited-chart-dot-expedite-stopped-color: green;
 
   --sprint-burndown-sprint-color-1: blue;
   --sprint-burndown-sprint-color-2: orange;
   --sprint-burndown-sprint-color-3: green;
   --sprint-burndown-sprint-color-4: red;
   --sprint-burndown-sprint-color-5: brown;
+
+
 }
 
 body {
@@ -100,6 +107,11 @@ table.standard {
   background-color: white;
 }
 
+div.p {
+  margin: 0.5em 0;
+  padding: 0;
+}
+
 div.color_block {
   display: inline-block;
   width: 0.9em;
@@ -132,7 +144,7 @@ div.color_block {
 
     --hierarchy-table-inactive-item-text-color: #939393;
 
-     --wip-chart-completed-color: #03cb03;
+    --wip-chart-completed-color: #03cb03;
     --wip-chart-completed-but-not-started-color: #99FF99;
     --wip-chart-duration-less-than-day-color: #d2d988;
     --wip-chart-duration-week-or-less-color: #dfcd00;

data/lib/jirametrics/html_report_config.rb

@@ -26,6 +26,11 @@ class HtmlReportConfig
     end
   end
 
+  # Mostly this is its own method so it can be called from the config
+  def included_projects
+    @file_config.project_config.aggregate_config.included_projects
+  end
+
   def run
     instance_eval(&@block)
 
@@ -102,6 +107,10 @@ class HtmlReportConfig
     execute_chart DailyWipByBlockedStalledChart.new
   end
 
+  def daily_wip_by_parent_chart &block
+    execute_chart DailyWipByParentChart.new block
+  end
+
   def throughput_chart &block
     execute_chart ThroughputChart.new(block)
   end
@@ -119,7 +128,8 @@ class HtmlReportConfig
   end
 
   def html string, type: :body
-    raise "Unexpected type: #{type}" unless %i[body header].include? type
+    allowed_types = %i[body header]
+    raise "Unexpected type: #{type} allowed_types: #{allowed_types.inspect}" unless allowed_types.include? type
 
     @sections << [string, type]
   end

data/lib/jirametrics/issue.rb

@@ -284,8 +284,9 @@ class Issue
           blocking_status = change.value
         end
       elsif change.link?
+        # Example: "This issue is satisfied by ANON-30465"
         unless /^This issue (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
-          puts "Can't parse link text: #{change.value || change.old_value}"
+          puts "Issue(#{key}) Can't parse link text: #{change.value || change.old_value}"
           next
         end
 

data/lib/jirametrics/jira_gateway.rb

@@ -13,7 +13,10 @@ class JiraGateway
 
   def call_url relative_url:
     command = make_curl_command url: "#{@jira_url}#{relative_url}"
-    JSON.parse call_command command
+    result = call_command command
+    JSON.parse result
+  rescue => e # rubocop:disable Style/RescueStandardError
+    puts "Error #{e.inspect} when parsing result: #{result.inspect}"
   end
 
   def call_command command

data/lib/jirametrics/project_config.rb

@@ -8,7 +8,7 @@ class ProjectConfig
 
   attr_reader :target_path, :jira_config, :all_boards, :possible_statuses,
     :download_config, :file_configs, :exporter, :data_version, :name, :board_configs,
-    :settings
+    :settings, :aggregate_config
   attr_accessor :time_range, :jira_url, :id
 
   def initialize exporter:, jira_config:, block:, target_path: '.', name: '', id: nil
@@ -115,7 +115,7 @@ class ProjectConfig
       board_id = $1.to_i
       load_board board_id: board_id, filename: "#{@target_path}#{file}"
     end
-    raise "No boards found in #{@target_path.inspect}" if @all_boards.empty?
+    raise "No boards found for #{@file_prefix} in #{@target_path.inspect}" if @all_boards.empty?
   end
 
   def load_board board_id:, filename:

data/lib/jirametrics/sprint_burndown.rb

@@ -22,7 +22,13 @@ class SprintBurndown < ChartBase
 
     @summary_stats = {}
     header_text 'Sprint burndown'
-    description_text ''
+    description_text <<-TEXT
+      <div class="p">
+        Burndowns for all sprints in this time period. The different colours are only to
+        differentiate one sprint from another as they may overlap time periods.
+      </div>
+      #{describe_non_working_days}
+    TEXT
   end
 
   def options= arg
@@ -55,7 +61,7 @@ class SprintBurndown < ChartBase
     end
 
     result = +''
-    result << '<h1>Sprint Burndowns</h1>'
+    result << render_top_text(binding)
 
     possible_colours = (1..5).collect { |i| CssVariable["--sprint-burndown-sprint-color-#{i}"] }
     charts_to_generate = []

data/lib/jirametrics/story_point_accuracy_chart.rb

@@ -6,16 +6,20 @@ class StoryPointAccuracyChart < ChartBase
 
     header_text 'Estimate Accuracy'
     description_text <<-HTML
-      <p>
+      <div class="p">
         This chart graphs estimates against actual recorded cycle times. Since
         estimates can change over time, we're graphing the estimate at the time that the story started.
-      </p>
-      <p>
-        The completed dots indicate cycletimes. The aging dots (click on the legend to turn them on)
-        show the current
-        age of items, which will give you a hint as to where they might end up. If they're already
-        far to the right then you know you have a problem.
-      </p>
+      </div>
+      <div class="p">
+        The #{color_block '--estimate-accuracy-chart-completed-fill-color'} completed dots indicate
+        cycletimes. 
+        <% if @has_aging_data %>
+          The #{color_block '--estimate-accuracy-chart-active-fill-color'} aging dots
+          (click on the legend to turn them on) show the current
+          age of items, which will give you a hint as to where they might end up. If they're already
+          far to the right then you know you have a problem.
+        <% end %>
+      </div>
     HTML
 
     @y_axis_label = 'Story Point Estimates'
@@ -56,6 +60,8 @@ class StoryPointAccuracyChart < ChartBase
       (hash[key] ||= []) << issue
     end
 
+    @has_aging_data = !aging_hash.empty?
+
     [
       [completed_hash, 'Completed', 'completed', false],
       [aging_hash, 'Still in progress', 'active', true]

data/lib/jirametrics/throughput_chart.rb

@@ -9,7 +9,12 @@ class ThroughputChart < ChartBase
     super()
 
     header_text 'Throughput Chart'
-    description_text 'This chart shows how many items we completed per unit of time'
+    description_text <<-TEXT
+      <div class="p">
+        This chart shows how many items we completed per week
+      </div>
+      #{describe_non_working_days}
+    TEXT
 
     init_configuration_block(block) do
       grouping_rules do |issue, rule|

data/lib/jirametrics.rb

@@ -66,6 +66,7 @@ class JiraMetrics < Thor
     require 'jirametrics/sprint'
     require 'jirametrics/issue'
     require 'jirametrics/daily_wip_by_age_chart'
+    require 'jirametrics/daily_wip_by_parent_chart'
     require 'jirametrics/aging_work_in_progress_chart'
     require 'jirametrics/cycletime_scatterplot'
     require 'jirametrics/sprint_issue_change_data'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-08 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -80,6 +80,7 @@ files:
 - lib/jirametrics/cycletime_scatterplot.rb
 - lib/jirametrics/daily_wip_by_age_chart.rb
 - lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb
+- lib/jirametrics/daily_wip_by_parent_chart.rb
 - lib/jirametrics/daily_wip_chart.rb
 - lib/jirametrics/data_quality_report.rb
 - lib/jirametrics/dependency_chart.rb