jirametrics 2.20.1 → 2.30

data/lib/jirametrics/chart_base.rb

@@ -1,9 +1,20 @@
 # frozen_string_literal: true
 
 class ChartBase
+  # Okabe-Ito palette — perceptually distinct under the most common forms of colour blindness.
+  # Ordered from most- to least-commonly useful for chart series.
+  OKABE_ITO_PALETTE = %w[
+    #0072B2
+    #E69F00
+    #009E73
+    #56B4E9
+    #D55E00
+    #CC79A7
+    #F0E442
+  ].freeze
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
     :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system,
-    :atlassian_document_format
+    :atlassian_document_format, :x_axis_title, :y_axis_title, :fix_versions
   attr_writer :aggregated_project
   attr_reader :canvas_width, :canvas_height
 
@@ -22,6 +33,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
@@ -72,10 +91,26 @@ class ChartBase
     "#{days} day#{'s' unless days == 1}"
   end
 
+  def label_hours hours
+    return 'unknown' if hours.nil?
+
+    "#{hours} hour#{'s' unless hours == 1}"
+  end
+
+  def label_minutes minutes
+    return 'unknown' if minutes.nil?
+
+    "#{minutes} minute#{'s' unless minutes == 1}"
+  end
+
   def label_issues count
     "#{count} issue#{'s' unless count == 1}"
   end
 
+  def to_human_readable number
+    number.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+  end
+
   def daily_chart_dataset date_issues_list:, color:, label:, positive: true
     {
       type: 'bar',
@@ -147,6 +182,56 @@ class ChartBase
     end.join
   end
 
+  LABEL_POSITIONS = %w[5% 25% 45% 65%].freeze
+
+  def date_annotation
+    annotations = settings['date_annotations'] || []
+    in_range = annotations
+      .map { |a| [a, normalize_annotation_datetime(a['date'])] }
+      .select { |(_, dt)| date_range.cover?(Date.parse(dt)) }
+      .sort_by { |(_, dt)| dt }
+
+    positions = stagger_label_positions(in_range.map { |(_, dt)| dt })
+
+    in_range.each_with_index.collect do |(a, normalized), index|
+      <<~TEXT
+        dateAnnotation#{index}: {
+          type: 'line',
+          xMin: #{normalized.to_json},
+          xMax: #{normalized.to_json},
+          borderColor: 'rgba(0,0,0,0.7)',
+          borderWidth: 1,
+          label: {
+            display: true,
+            content: #{a['label'].to_json},
+            position: #{positions[index].to_json}
+          }
+        },
+      TEXT
+    end.join
+  end
+
+  def stagger_label_positions datetimes
+    return [] if datetimes.empty?
+
+    threshold_days = (date_range.end - date_range.begin).to_f / 5.0
+    slot = 0
+    [LABEL_POSITIONS[0]] + datetimes.each_cons(2).map do |a, b|
+      days_apart = (Date.parse(b) - Date.parse(a)).to_f.abs
+      slot = days_apart < threshold_days ? slot + 1 : 0
+      LABEL_POSITIONS[slot % LABEL_POSITIONS.size]
+    end
+  end
+
+  def normalize_annotation_datetime value
+    offset = timezone_offset || '+00:00'
+    if value.include?('T')
+      value.match?(/([+-]\d{2}:\d{2}|Z)$/) ? value : "#{value}#{offset}"
+    else
+      "#{value}T00:00:00#{offset}"
+    end
+  end
+
   # Return only the board columns for the current board.
   def current_board
     if @board_id.nil?
@@ -237,6 +322,13 @@ class ChartBase
     "<span title='#{title}' style='font-size: 0.8em;'>#{icon}</span>"
   end
 
+  def not_visible_text issue
+    reasons = issue.reasons_not_visible_on_board
+    return nil if reasons.empty?
+
+    "<span style='background: var(--warning-banner)'>Not visible on board: #{reasons.join(', ')}</span>"
+  end
+
   def status_category_color status
     case status.category.key
     when 'new' then CssVariable['--status-category-todo-color']
@@ -247,7 +339,8 @@ class ChartBase
   end
 
   def random_color
-    "##{Random.bytes(3).unpack1('H*')}"
+    @palette_index = (@palette_index || -1) + 1
+    OKABE_ITO_PALETTE[@palette_index % OKABE_ITO_PALETTE.size]
   end
 
   def canvas width:, height:, responsive: true
@@ -279,4 +372,46 @@ 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} -->\n"
+  end
+
+  def seam_end type = 'chart'
+    "\n<!-- seam-end | chart#{@@chart_counter} | #{self.class} | #{header_text} | #{type} -->"
+  end
+
+  def render_axis_title axis_direction
+    text = case axis_direction
+    when :x
+      x_axis_title
+    when :y
+      y_axis_title
+    else
+      raise "Unexpected axis_direction: #{axis_direction}"
+    end
+    return '' unless text
+
+    <<~CONTENT
+      title: {
+          display: true,
+          text: "#{text}"
+        },
+    CONTENT
+  end
 end

data/lib/jirametrics/css_variable.rb

@@ -16,7 +16,7 @@ class CssVariable
   end
 
   def to_json(*_args)
-    "getComputedStyle(document.body).getPropertyValue('#{@name}')"
+    "getComputedStyle(document.documentElement).getPropertyValue('#{@name}').trim()"
   end
 
   def to_s

data/lib/jirametrics/cumulative_flow_diagram.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'jirametrics/cfd_data_builder'
+
+class CumulativeFlowDiagram < ChartBase
+  # Used to embed a Chart.js segment callback (which contains JS functions) into
+  # a JSON-like dataset object. The custom to_json emits raw JS rather than a
+  # quoted string, following the same pattern as ExpeditedChart::EXPEDITED_SEGMENT.
+  class Segment
+    def initialize windows
+      # Build a JS array literal of [start_date, end_date] string pairs
+      @windows_js = windows
+        .map { |w| "[#{w[:start_date].to_json}, #{w[:end_date].to_json}]" }
+        .join(', ')
+    end
+
+    def to_json *_args
+      <<~JS
+        {
+          borderDash: function(ctx) {
+            const x = ctx.p1.parsed.x;
+            const windows = [#{@windows_js}];
+            return windows.some(function(w) {
+              return x >= new Date(w[0]).getTime() && x <= new Date(w[1]).getTime();
+            }) ? [6, 4] : undefined;
+          }
+        }
+      JS
+    end
+  end
+  private_constant :Segment
+
+  class CfdColumnRules < Rules
+    attr_accessor :color, :label, :label_hint
+  end
+  private_constant :CfdColumnRules
+
+  def initialize block
+    super()
+    header_text 'Cumulative Flow Diagram'
+    description_text <<~HTML
+      <div class="p">
+        A Cumulative Flow Diagram (CFD) shows how work accumulates across board columns over time.
+        Each coloured band represents a workflow stage. The top edge of the leftmost band shows
+        total work entered; the top edge of the rightmost band shows total work completed.
+      </div>
+      <div class="p">
+        A widening band means work is piling up in that stage — a bottleneck. Parallel top edges
+        (bands staying the same width) indicate smooth flow. Steep rises in the leftmost band
+        without corresponding rises on the right mean new work is arriving faster than it is
+        being finished.
+      </div>
+      <div class="p">
+        Dashed lines and hatched regions indicate periods where an item moved backwards through
+        the workflow (a correction). These highlight rework or process irregularities worth
+        investigating.
+      </div>
+      <div class="p">
+        The chart also overlays two trend lines and an interactive triangle. The <b>arrival rate</b>
+        trend line shows how fast work is entering the system; the <b>departure rate</b> trend line
+        shows how fast it is leaving. Move the mouse over the chart to see a Little's Law triangle
+        at that point in time, labelled with three derived metrics: <b>Work In Progress (WIP)</b> (items started
+        but not finished), <b>approximate average cycle time (CT)</b> (roughly how long an average item takes to complete), and
+        <b>average throughput (TP)</b> (items completed per day). Use the checkbox above the chart to toggle
+        between the triangle and the normal data tooltips.
+      </div>
+      <div class="p">
+        CT and TP require a future point C where cumulative completions catch up to current arrivals.
+        When the cursor is near the right edge and that point falls outside the visible date range,
+        CT and TP cannot be calculated and are hidden; only WIP is shown.
+      </div>
+      <div class="p">
+        See also: This article on <a href="https://blog.mikebowler.ca/2026/03/27/cumulative-flow-diagram/">how to read a CFD</a>.
+      </div>      
+    HTML
+    instance_eval(&block)
+  end
+
+  def column_rules &block
+    @column_rules_block = block
+  end
+
+  def triangle_color color
+    @triangle_color = parse_theme_color(color)
+  end
+
+  def arrival_rate_line_color color
+    @arrival_rate_line_color = parse_theme_color(color)
+  end
+
+  def departure_rate_line_color color
+    @departure_rate_line_color = parse_theme_color(color)
+  end
+
+  def run
+    all_columns = current_board.visible_columns
+
+    column_rules_list = all_columns.map do |column|
+      rules = CfdColumnRules.new
+      @column_rules_block&.call(column, rules)
+      rules
+    end
+
+    active_pairs   = all_columns.zip(column_rules_list).reject { |_, rules| rules.ignored? }
+    active_columns = active_pairs.map(&:first)
+    active_rules   = active_pairs.map(&:last)
+
+    cfd = CfdDataBuilder.new(
+      board: current_board,
+      issues: issues,
+      date_range: date_range,
+      columns: active_columns
+    ).run
+
+    columns            = cfd[:columns]
+    daily_counts       = cfd[:daily_counts]
+    correction_windows = cfd[:correction_windows]
+    column_count       = columns.size
+
+    # Convert cumulative totals to marginal band heights for Chart.js stacking.
+    # cumulative[i] = issues that reached column i or further.
+    # marginal[i]   = cumulative[i] - cumulative[i+1]  (last column: marginal = cumulative)
+    daily_marginals = daily_counts.transform_values do |cumulative|
+      cumulative.each_with_index.map do |count, i|
+        i < column_count - 1 ? count - cumulative[i + 1] : count
+      end
+    end
+
+    border_colors = active_rules.map { |rules| rules.color || random_color }
+
+    fill_colors = active_rules.zip(border_colors).map { |rules, border| fill_color_for(rules, border) }
+
+    # Datasets in reversed order: rightmost column first (bottom of stack), leftmost last (top).
+    data_sets = columns.each_with_index.map do |name, col_index|
+      col_windows = correction_windows
+        .select { |w| w[:column_index] == col_index }
+        .map { |w| { start_date: w[:start_date].to_s, end_date: w[:end_date].to_s } }
+
+      {
+        label: active_rules[col_index].label || name,
+        label_hint: active_rules[col_index].label_hint,
+        data: date_range.map { |date| { x: date.to_s, y: daily_marginals[date][col_index] } },
+        backgroundColor: fill_colors[col_index],
+        borderColor: border_colors[col_index],
+        fill: true,
+        tension: 0,
+        segment: Segment.new(col_windows)
+      }
+    end.reverse
+
+    # Correction windows for the afterDraw hatch plugin, with dataset index in
+    # Chart.js dataset array (reversed: done column = index 0).
+    hatch_windows = correction_windows.map do |w|
+      {
+        dataset_index: column_count - 1 - w[:column_index],
+        start_date: w[:start_date].to_s,
+        end_date: w[:end_date].to_s,
+        color: border_colors[w[:column_index]],
+        fill_color: fill_colors[w[:column_index]]
+      }
+    end
+
+    @triangle_color = parse_theme_color(['#333333', '#ffffff']) unless instance_variable_defined?(:@triangle_color)
+    unless instance_variable_defined?(:@arrival_rate_line_color)
+      @arrival_rate_line_color = 'rgba(255,138,101,0.85)'
+    end
+    unless instance_variable_defined?(:@departure_rate_line_color)
+      @departure_rate_line_color = 'rgba(128,203,196,0.85)'
+    end
+
+    wrap_and_render(binding, __FILE__)
+  end
+
+  private
+
+  def parse_theme_color color
+    return color unless color.is_a?(Array)
+
+    raise ArgumentError, 'Color pair must have exactly two elements: [light_color, dark_color]' unless color.size == 2
+    raise ArgumentError, 'Color pair elements must be strings' unless color.all?(String)
+
+    if color.any? { |c| c.start_with?('--') }
+      raise ArgumentError,
+        'CSS variable references are not supported as color pair elements; use a literal color value instead'
+    end
+
+    light, dark = color
+    RawJavascript.new(
+      "(document.documentElement.dataset.theme === 'dark' || " \
+      '(!document.documentElement.dataset.theme && ' \
+      "window.matchMedia('(prefers-color-scheme: dark)').matches)) " \
+      "? #{dark.to_json} : #{light.to_json}"
+    )
+  end
+
+  def hex_to_rgba hex, alpha
+    r, g, b = hex.delete_prefix('#').scan(/../).map { |c| c.to_i(16) }
+    "rgba(#{r}, #{g}, #{b}, #{alpha})"
+  end
+
+  def fill_color_for rules, border
+    if rules.color.nil? || rules.color.match?(/\A#[0-9a-fA-F]{6}\z/)
+      hex_to_rgba(border, 0.35)
+    else
+      rules.color
+    end
+  end
+end

data/lib/jirametrics/{cycletime_config.rb → cycle_time_config.rb}

@@ -6,15 +6,13 @@ require 'date'
 class CycleTimeConfig
   include SelfOrIssueDispatcher
 
-  attr_reader :label, :parent_config, :settings, :file_system
+  attr_reader :label, :settings, :file_system
 
-  def initialize parent_config:, label:, block:, settings:, 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
-    @cache_cycletime_calculations = settings['cache_cycletime_calculations']
 
     # 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 ;-)
@@ -68,7 +66,7 @@ class CycleTimeConfig
   def started_stopped_changes issue
     cache_key = "#{issue.key}:#{issue.board.id}"
     last_result = (@cache ||= {})[cache_key]
-    return *last_result if last_result && @cache_cycletime_calculations
+    return *last_result if last_result && settings['cache_cycletime_calculations']
 
     started = @start_at.call(issue)
     stopped = @stop_at.call(issue)

data/lib/jirametrics/cycletime_histogram.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
-require 'jirametrics/groupable_issue_chart'
+require 'jirametrics/time_based_histogram'
 
-class CycletimeHistogram < ChartBase
-  include GroupableIssueChart
+class CycletimeHistogram < TimeBasedHistogram
   attr_accessor :possible_statuses
-  attr_reader :show_stats
 
   def initialize block
     super()
 
-    percentiles [50, 85, 98]
-    @show_stats = true
+    @x_axis_title = 'Cycletime in days'
+    @y_axis_title = 'Count'
 
     header_text 'Cycletime Histogram'
     description_text <<-HTML
@@ -30,112 +28,26 @@ class CycletimeHistogram < ChartBase
     end
   end
 
-  def percentiles percs = nil
-    @percentiles = percs unless percs.nil?
-    @percentiles
-  end
-
-  def disable_stats
-    @show_stats = false
-  end
-
-  def run
+  def all_items
     stopped_issues = completed_issues_in_range include_unstarted: true
 
     # For the histogram, we only want to consider items that have both a start and a stop time.
-    histogram_issues = stopped_issues.select { |issue| issue.board.cycletime.started_stopped_times(issue).first }
-    rules_to_issues = group_issues histogram_issues
-
-    the_stats = {}
-
-    overall_stats = stats_for histogram_data: histogram_data_for(issues: histogram_issues), percentiles: @percentiles
-    the_stats[:all] = overall_stats
-    data_sets = rules_to_issues.keys.collect do |rules|
-      the_issue_type = rules.label
-      the_histogram = histogram_data_for(issues: rules_to_issues[rules])
-      the_stats[the_issue_type] = stats_for histogram_data: the_histogram, percentiles: @percentiles if @show_stats
-
-      data_set_for(
-        histogram_data: the_histogram,
-        label: the_issue_type,
-        color: rules.color
-      )
-    end
-
-    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__)
+    stopped_issues.select { |issue| issue.started_stopped_times.first }
   end
 
-  def histogram_data_for issues:
-    count_hash = {}
-    issues.each do |issue|
-      days = issue.board.cycletime.cycletime(issue)
-      count_hash[days] = (count_hash[days] || 0) + 1 if days.positive?
-    end
-    count_hash
+  def value_for_item issue
+    issue.board.cycletime.cycletime(issue)
   end
 
-  def stats_for histogram_data:, percentiles:
-    return {} if histogram_data.empty?
-
-    total_values = histogram_data.values.sum
-
-    # Calculate the average
-    weighted_sum = histogram_data.reduce(0) { |sum, (value, frequency)| sum + (value * frequency) }
-    average = total_values.zero? ? 0 : weighted_sum.to_f / total_values
-
-    # Find the mode (or modes!) and the spread of the distribution
-    sorted_histogram = histogram_data.sort_by { |_value, frequency| frequency }
-    max_freq = sorted_histogram[-1][1]
-    mode = sorted_histogram.select { |_v, f| f == max_freq }
-
-    minmax = histogram_data.keys.minmax
-
-    # Calculate percentiles
-    sorted_values = histogram_data.keys.sort
-    cumulative_counts = {}
-    cumulative_sum = 0
-
-    sorted_values.each do |value|
-      cumulative_sum += histogram_data[value]
-      cumulative_counts[value] = cumulative_sum
-    end
-
-    percentile_results = {}
-    percentiles.each do |percentile|
-      rank = (percentile / 100.0) * total_values
-      percentile_value = sorted_values.find { |value| cumulative_counts[value] >= rank }
-      percentile_results[percentile] = percentile_value
-    end
-
-    {
-      average: average,
-      mode: mode.collect(&:first).sort,
-      min: minmax[0],
-      max: minmax[1],
-      percentiles: percentile_results
-    }
+  def title_for_item count:, value:
+    "#{count} items completed in #{label_days value}"
   end
 
-  def data_set_for histogram_data:, label:, color:
-    keys = histogram_data.keys.sort
-    {
-      type: 'bar',
-      label: label,
-      data: keys.sort.filter_map do |key|
-        next if histogram_data[key].zero?
+  def sort_items items
+    items.sort_by(&:key_as_i)
+  end
 
-        {
-          x: key,
-          y: histogram_data[key],
-          title: "#{histogram_data[key]} items completed in #{label_days key}"
-        }
-      end,
-      backgroundColor: color,
-      borderRadius: 0
-    }
+  def label_for_item issue, hint:
+    "#{issue.key} : #{issue.summary}#{" #{hint}" if hint}"
   end
 end