jirametrics 2.0 → 2.11

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

data/lib/jirametrics/daily_wip_chart.rb

@@ -6,7 +6,7 @@ class DailyGroupingRules < GroupingRules
   attr_accessor :current_date, :group_priority, :issue_hint
 
   def initialize
-    super()
+    super
     @group_priority = 0
   end
 end
@@ -14,18 +14,18 @@ end
 class DailyWipChart < ChartBase
   attr_accessor :possible_statuses
 
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text default_header_text
     description_text default_description_text
 
-    if block
-      instance_eval(&block)
-    else
-      grouping_rules do |issue, rules|
-        default_grouping_rules issue: issue, rules: rules
-      end
+    instance_eval(&block) if block
+
+    return if @group_by_block
+
+    grouping_rules do |issue, rules|
+      default_grouping_rules issue: issue, rules: rules
     end
   end
 
@@ -36,6 +36,11 @@ 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
 
     wrap_and_render(binding, __FILE__)
   end
@@ -61,9 +66,7 @@ class DailyWipChart < ChartBase
     hash = {}
 
     @issues.each do |issue|
-      cycletime = issue.board.cycletime
-      start = cycletime.started_time(issue)&.to_date
-      stop = cycletime.stopped_time(issue)&.to_date
+      start, stop = issue.board.cycletime.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
@@ -102,14 +105,14 @@ class DailyWipChart < ChartBase
       label: grouping_rule.label,
       data: data,
       backgroundColor: grouping_rule.color || random_color,
-      borderColor: 'gray',
-      borderWidth: grouping_rule.color == 'white' ? 1 : 0,
+      borderColor: CssVariable['--wip-chart-border-color'],
+      borderWidth: grouping_rule.color.to_s == 'var(--body-background)' ? 1 : 0,
       borderRadius: positive ? 0 : 5
     }
   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 +123,48 @@ 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
 end