jirametrics 2.22 → 2.30

data/lib/jirametrics/board.rb

@@ -4,18 +4,18 @@ class Board
   attr_reader :visible_columns, :raw, :possible_statuses, :sprints
   attr_accessor :cycletime, :project_config
 
-  def initialize raw:, possible_statuses:
+  def initialize raw:, possible_statuses:, features: []
     @raw = raw
     @possible_statuses = possible_statuses
     @sprints = []
+    @features = features
 
     columns = raw['columnConfig']['columns']
     ensure_uniqueness_of_column_names! columns
 
-    # For a Kanban board, the first column here will always be called 'Backlog' and will NOT be
-    # visible on the board. If the board is configured to have a kanban backlog then it will have
-    # statuses matched to it and otherwise, there will be no statuses.
-    columns = columns.drop(1) if kanban?
+    # For a classic Kanban board (type 'kanban'), the first column will always be called 'Backlog'
+    # and will NOT be visible on the board. This does not apply to team-managed boards (type 'simple').
+    columns = columns.drop(1) if board_type == 'kanban'
 
     @backlog_statuses = []
     @visible_columns = columns.filter_map do |column|
@@ -25,7 +25,7 @@ class Board
   end
 
   def backlog_statuses
-    if @backlog_statuses.empty? && kanban?
+    if @backlog_statuses.empty? && board_type == 'kanban'
       status_ids = status_ids_from_column raw['columnConfig']['columns'].first
       @backlog_statuses = status_ids.filter_map do |id|
         @possible_statuses.find_by_id id
@@ -67,8 +67,28 @@ class Board
   end
 
   def board_type = raw['type']
-  def kanban? = (board_type == 'kanban')
-  def scrum? = (board_type == 'scrum')
+
+  def scrum?
+    return true if board_type == 'scrum'
+    return false unless board_type == 'simple'
+
+    has_sprints_feature?
+  end
+
+  def kanban?
+    return true if board_type == 'kanban'
+    return false unless board_type == 'simple'
+
+    !scrum?
+  end
+
+  def team_managed_kanban?
+    board_type == 'simple' && !has_sprints_feature?
+  end
+
+  def has_sprints_feature?
+    @features.any? { |f| f.name == 'jsw.agility.sprints' && f.enabled? }
+  end
 
   def id
     @raw['id'].to_i

data/lib/jirametrics/board_feature.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class BoardFeature
+  def initialize raw:
+    @raw = raw
+  end
+
+  def name = @raw['feature']
+  def enabled? = (@raw['state'] == 'ENABLED')
+
+  def self.from_raw features_json
+    features_json['features']&.map { |f| new(raw: f) } || []
+  end
+end

data/lib/jirametrics/board_movement_calculator.rb

@@ -10,7 +10,7 @@ class BoardMovementCalculator
   end
 
   def moves_backwards? issue
-    started, stopped = issue.board.cycletime.started_stopped_times(issue)
+    started, stopped = issue.started_stopped_times
     return false unless started
 
     previous_column = nil
@@ -70,7 +70,7 @@ class BoardMovementCalculator
     @issues.filter_map do |issue|
       this_column_start = issue.first_time_in_or_right_of_column(this_column.name)&.time
       next_column_start = next_column.nil? ? nil : issue.first_time_in_or_right_of_column(next_column.name)&.time
-      issue_start, issue_done = issue.board.cycletime.started_stopped_times(issue)
+      issue_start, issue_done = issue.started_stopped_times
 
       # Skip if we can't tell when it started.
       next if issue_start.nil?

data/lib/jirametrics/cfd_data_builder.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class CfdDataBuilder
+  def initialize board:, issues:, date_range:, columns: nil
+    @board = board
+    @issues = issues
+    @date_range = date_range
+    @columns = columns || board.visible_columns
+  end
+
+  def run
+    column_map = build_column_map
+    issue_states = @issues.map { |issue| process_issue(issue, column_map) }
+
+    {
+      columns: @columns.map(&:name),
+      daily_counts: build_daily_counts(issue_states),
+      correction_windows: issue_states.flat_map { |s| s[:correction_windows] }
+    }
+  end
+
+  private
+
+  def build_column_map
+    map = {}
+    @columns.each_with_index do |column, index|
+      column.status_ids.each { |id| map[id] = index }
+    end
+    map
+  end
+
+  # Returns { hwm_timeline: [[date, hwm_value], ...], correction_windows: [...] }
+  def process_issue issue, column_map
+    start_time = issue.started_stopped_times.first
+    return { hwm_timeline: [], correction_windows: [] } if start_time.nil?
+
+    high_water_mark = nil
+    correction_open_since = nil
+    correction_windows = []
+    hwm_timeline = [] # sorted chronologically by date
+
+    issue.status_changes.each do |change|
+      next if change.time < start_time
+
+      col_index = column_map[change.value_id]
+      next if col_index.nil?
+
+      if high_water_mark.nil? || col_index > high_water_mark
+        # Forward movement: advance hwm, close any open correction window, record timeline entry
+        if correction_open_since
+          correction_windows << {
+            start_date: correction_open_since,
+            end_date: change.time.to_date,
+            column_index: high_water_mark
+          }
+          correction_open_since = nil
+        end
+        high_water_mark = col_index
+        hwm_timeline << [change.time.to_date, high_water_mark]
+      elsif col_index == high_water_mark && correction_open_since
+        # Same-column recovery: close the correction window without changing hwm or adding timeline entry
+        correction_windows << {
+          start_date: correction_open_since,
+          end_date: change.time.to_date,
+          column_index: high_water_mark
+        }
+        correction_open_since = nil
+      elsif col_index < high_water_mark
+        # Backwards movement: open correction window if not already open
+        correction_open_since ||= change.time.to_date
+      end
+    end
+
+    if correction_open_since
+      correction_windows << {
+        start_date: correction_open_since,
+        end_date: @date_range.end,
+        column_index: high_water_mark
+      }
+    end
+
+    { hwm_timeline: hwm_timeline, correction_windows: correction_windows }
+  end
+
+  def hwm_at hwm_timeline, date
+    result = nil
+    hwm_timeline.each do |timeline_date, hwm|
+      break if timeline_date > date
+
+      result = hwm
+    end
+    result
+  end
+
+  def build_daily_counts issue_states
+    column_count = @columns.size
+    @date_range.each_with_object({}) do |date, result|
+      counts = Array.new(column_count, 0)
+      issue_states.each do |state|
+        hwm = hwm_at(state[:hwm_timeline], date)
+        next if hwm.nil?
+
+        (0..hwm).each { |i| counts[i] += 1 }
+      end
+      result[date] = counts
+    end
+  end
+end

data/lib/jirametrics/change_item.rb

@@ -18,7 +18,7 @@ class ChangeItem
       @value_id = @raw['to'].split(', ').collect(&:to_i)
       @old_value_id = (@raw['from'] || '').split(', ').collect(&:to_i)
     else
-      @value_id = @raw['to'].to_i
+      @value_id = @raw['to']&.to_i
       @old_value_id = @raw['from']&.to_i
     end
     @field_id = @raw['fieldId']
@@ -46,6 +46,7 @@ class ChangeItem
   def resolution? = (field == 'resolution')
   def sprint? = (field == 'Sprint')
   def status? = (field == 'status')
+  def fix_version? = (field == 'Fix Version')
 
   # An alias for time so that logic accepting a Time, Date, or ChangeItem can all respond to :to_time
   def to_time = @time
@@ -54,10 +55,10 @@ class ChangeItem
     message = +''
     message << "ChangeItem(field: #{field.inspect}"
     message << ", value: #{value.inspect}"
-    message << ':' << value_id.inspect if status?
+    message << ':' << value_id.inspect if value_id
     if old_value
       message << ", old_value: #{old_value.inspect}"
-      message << ':' << old_value_id.inspect if status?
+      message << ':' << old_value_id.inspect if old_value_id
     end
     message << ", time: #{time_to_s(@time).inspect}"
     message << ", field_id: #{@field_id.inspect}" if @field_id

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
 
@@ -80,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',
@@ -155,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?
@@ -245,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']
@@ -255,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
@@ -304,10 +389,29 @@ class ChartBase
   end
 
   def seam_start type = 'chart'
-    "\n<!-- seam-start | chart#{@@chart_counter} | #{self.class} | #{header_text} | #{type} -->"
+    "\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,10 +6,9 @@ require 'date'
 class CycleTimeConfig
   include SelfOrIssueDispatcher
 
-  attr_reader :label, :possible_statuses, :settings, :file_system
+  attr_reader :label, :settings, :file_system
 
   def initialize possible_statuses:, label:, block:, settings:, file_system: nil, today: Date.today
-
     @possible_statuses = possible_statuses
     @label = label
     @today = today