jirametrics 2.7 → 2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73e2f2e8408a55ccecb221ba0c6d241c77f19de18d2100a9b05213a6470ed65f
-  data.tar.gz: d0f9056615c44e783c824ca1c6566c95bf68f16a26f81a596475c1d458fee9f1
+  metadata.gz: 670df42835c7d41e30dcde01ead744a132f81313165297d434334e272de795c7
+  data.tar.gz: 12822842210b4aeddb7f59e6681a9f1bd25060bae0ff98e8490d14e895dea657
 SHA512:
-  metadata.gz: e58594175d798269e0e4b8ec1fd4c0f8b693767670222bc6144be19646b04f83e5edb508e4f933f8466865018e8802f789ecb348db368c3f626318df7774c0e0
-  data.tar.gz: 4555628c33a398cd3aaedd6e36a074b54d89f5a431f47d8617344e4af45e389e529ba54dd9cbd7d9e7d8ad7f673a68f664d00b951451b433d47f90c6feb439a5
+  metadata.gz: a4f36b8921c94a457710dc68251a9a2ddb38be2f0f7027991cf381fdf1cff28d2e549e508314733a3c753f583fd3c695b7e4979e1bb7be43c45de90ec001cbab
+  data.tar.gz: 28a2553b31cd4de5fce0c943da38643ad13dbfad3a8bddc77f4764e179394968966bb676e70daa75a4faeb42a67027fb7efb63895b56c01a3db563a029df66aa

data/lib/jirametrics/aggregate_config.rb

@@ -41,7 +41,7 @@ class AggregateConfig
   def include_issues_from project_name
     project = @project_config.exporter.project_configs.find { |p| p.name == project_name }
     if project.nil?
-      log "Warning: Aggregated project #{@project_config.name.inspect} is attempting to load " \
+      file_system.warning "Aggregated project #{@project_config.name.inspect} is attempting to load " \
         "project #{project_name.inspect} but it can't be found. Is it disabled?"
       return
     end
@@ -64,7 +64,7 @@ class AggregateConfig
     end
 
     if issues.nil?
-      log "No issues found for #{project_name}"
+      file_system.warning "No issues found for #{project_name}"
     else
       @project_config.add_issues issues
     end
@@ -86,7 +86,7 @@ class AggregateConfig
 
   private
 
-  def log message
-    @project_config.exporter.file_system.log message
+  def file_system
+    @project_config.exporter.file_system
   end
 end

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -3,8 +3,6 @@
 require 'jirametrics/chart_base'
 
 class AgingWorkBarChart < ChartBase
-  @@next_id = 0
-
   def initialize block
     super()
 
@@ -116,7 +114,7 @@ class AgingWorkBarChart < ChartBase
     issue.changes.each do |change|
       next unless change.status?
 
-      status = issue.find_status_by_name change.value
+      status = issue.find_or_create_status id: change.value_id, name: change.value
 
       unless previous_start.nil? || previous_start < issue_started_time
         hash = {
@@ -162,8 +160,12 @@ class AgingWorkBarChart < ChartBase
   end
 
   def one_block_change_data_set starting_change:, ending_time:, issue_label:, stack:, issue_start_time:
-    deprecated message: 'blocked color should be set via css now', date: '2024-05-03' if settings['blocked_color']
-    deprecated message: 'blocked color should be set via css now', date: '2024-05-03' if settings['stalled_color']
+    if settings['blocked_color']
+      file_system.deprecated message: 'blocked color should be set via css now', date: '2024-05-03'
+    end
+    if settings['stalled_color']
+      file_system.deprecated message: 'stalled color should be set via css now', date: '2024-05-03'
+    end
 
     color = settings['blocked_color'] || '--blocked-color'
     color = settings['stalled_color'] || '--stalled-color' if starting_change.stalled?

data/lib/jirametrics/aging_work_in_progress_chart.rb

@@ -2,6 +2,7 @@
 
 require 'jirametrics/chart_base'
 require 'jirametrics/groupable_issue_chart'
+require 'jirametrics/board_movement_calculator'
 
 class AgingWorkInProgressChart < ChartBase
   include GroupableIssueChart
@@ -16,13 +17,33 @@ class AgingWorkInProgressChart < ChartBase
         This chart shows only work items that have started but not completed, grouped by the column
         they're currently in. Hovering over a dot will show you the ID of that work item.
       </p>
-      <div>
-        The #{color_block '--non-working-days-color'} shaded area indicates the 85%
-        mark for work items that have passed through here; 85% of
-        previous work items left this column while still inside the shaded area. Any work items above
-        the shading are outliers and they are the items that you should pay special attention to.
+      <p>
+        The shaded areas indicate what percentage of the work has passed that column within that time.
+        Notes:
+        <ul>
+          <li>It only shows columns that are considered "in progress". If you see a column that wouldn't normally
+          be thought of that way, then likely issues were moving backwards or continued to progress after hitting
+          that column.</li>
+          <li>If you see a colour group that drops as it moves to the right, that generally indicates that
+            a different number of data points is being included in each column. Probably because tickets moved
+             backwards athough it could also indicate that a ticket jumped over columns as it moved to the right.
+           </li>
+        </ul>
+      </p>
+      <div style="border: 1px solid gray; padding: 0.2em">
+        <% @percentiles.keys.sort.reverse.each do |percent| %>
+          <span style="padding-left: 0.5em; padding-right: 0.5em; vertical-align: middle;"><%= color_block @percentiles[percent] %> <%= percent %>%</span>
+        <% end %>
       </div>
     HTML
+    percentiles(
+      50 => '--aging-work-in-progress-chart-shading-50-color',
+      85 => '--aging-work-in-progress-chart-shading-85-color',
+      98 => '--aging-work-in-progress-chart-shading-98-color',
+      100 => '--aging-work-in-progress-chart-shading-100-color'
+    )
+    show_all_columns false
+
     init_configuration_block(block) do
       grouping_rules do |issue, rule|
         rule.label = issue.type
@@ -36,13 +57,17 @@ class AgingWorkInProgressChart < ChartBase
 
     @header_text += " on board: #{@all_boards[@board_id].name}"
     data_sets = make_data_sets
-    column_headings = @board_columns.collect(&:name)
 
-    adjust_visibility_of_unmapped_status_column data_sets: data_sets, column_headings: column_headings
+    adjust_visibility_of_unmapped_status_column data_sets: data_sets
+    adjust_chart_height
 
     wrap_and_render(binding, __FILE__)
   end
 
+  def show_all_columns show = true # rubocop:disable Style/OptionalBooleanParameter
+    @show_all_columns = show
+  end
+
   def determine_board_columns
     unmapped_statuses = current_board.possible_statuses.collect(&:id)
 
@@ -51,7 +76,7 @@ class AgingWorkInProgressChart < ChartBase
 
     @fake_column = BoardColumn.new({
       'name' => '[Unmapped Statuses]',
-      'statuses' => unmapped_statuses.collect { |id| { 'id' => id.to_s } }.uniq
+      'statuses' => unmapped_statuses.collect { |id| { 'id' => id.to_s } }.uniq # rubocop:disable Performance/ChainArrayAllocation
     })
     @board_columns = columns + [@fake_column]
   end
@@ -62,7 +87,7 @@ class AgingWorkInProgressChart < ChartBase
       board.id == @board_id && board.cycletime.in_progress?(issue)
     end
 
-    percentage = 85
+    @max_age = 20
     rules_to_issues = group_issues aging_issues
     data_sets = rules_to_issues.keys.collect do |rules|
       {
@@ -73,7 +98,10 @@ class AgingWorkInProgressChart < ChartBase
             column = column_for issue: issue
             next if column.nil?
 
-            { 'y' => age,
+            @max_age = age if age > @max_age
+
+            {
+              'y' => age,
               'x' => column.name,
               'title' => ["#{issue.key} : #{issue.summary} (#{label_days age})"]
             }
@@ -83,45 +111,70 @@ class AgingWorkInProgressChart < ChartBase
         'backgroundColor' => rules.color
       }
     end
-    data_sets << {
-      'type' => 'bar',
-      'label' => "#{percentage}%",
-      'barPercentage' => 1.0,
-      'categoryPercentage' => 1.0,
-      'backgroundColor' => CssVariable['--aging-work-in-progress-chart-shading-color'],
-      'data' => days_at_percentage_threshold_for_all_columns(percentage: percentage, issues: @issues).drop(1)
-    }
-  end
 
-  def days_at_percentage_threshold_for_all_columns percentage:, issues:
-    accumulated_status_ids_per_column.collect do |_column, status_ids|
-      ages = ages_of_issues_that_crossed_column_boundary issues: issues, status_ids: status_ids
-      index = ages.size * percentage / 100
-      ages.sort[index.to_i] || 0
+    calculator = BoardMovementCalculator.new board: @all_boards[@board_id], issues: issues, today: date_range.end
+
+    column_indexes_to_remove = []
+    unless @show_all_columns
+      column_indexes_to_remove = indexes_of_leading_and_trailing_zeros(calculator.age_data_for(percentage: 100))
+
+      column_indexes_to_remove.reverse_each do |index|
+        @board_columns.delete_at index
+      end
+    end
+
+    @row_index_offset = data_sets.size
+
+    bar_data = []
+    calculator.stacked_age_data_for(percentages: @percentiles.keys).each do |percentage, data|
+      column_indexes_to_remove.reverse_each { |index| data.delete_at index }
+      color = @percentiles[percentage]
+
+      data_sets << {
+        'type' => 'bar',
+        'label' => "#{percentage}%",
+        'barPercentage' => 1.0,
+        'categoryPercentage' => 1.0,
+        'backgroundColor' => color,
+        'data' => data
+      }
+      bar_data << data
     end
+    @bar_data = adjust_bar_data bar_data
+
+    data_sets
   end
 
-  def accumulated_status_ids_per_column
-    accumulated_status_ids = []
-    @board_columns.reverse.filter_map do |column|
-      next if column == @fake_column
+  def adjust_bar_data input
+    return [] if input.empty?
+
+    row_size = input.first.size
 
-      accumulated_status_ids += column.status_ids
-      [column.name, accumulated_status_ids.dup]
-    end.reverse
+    output = []
+    output << input.first
+    input.drop(1).each do |row|
+      previous_row = output.last
+      output << 0.upto(row_size - 1).collect { |i| row[i] + previous_row[i] }
+    end
+
+    output
   end
 
-  def ages_of_issues_that_crossed_column_boundary issues:, status_ids:
-    issues.filter_map do |issue|
-      stop = issue.first_time_in_status(*status_ids)
-      start, = issue.board.cycletime.started_stopped_times(issue)
+  def indexes_of_leading_and_trailing_zeros list
+    result = []
+    0.upto(list.size - 1) do |index|
+      break unless list[index].zero?
 
-      # Skip if either it hasn't crossed the boundary or we can't tell when it started.
-      next if stop.nil? || start.nil?
-      next if stop < start
+      result << index
+    end
 
-      (stop.to_date - start.to_date).to_i + 1
+    stop_at = result.empty? ? 0 : (result.last + 1)
+    (list.size - 1).downto(stop_at).each do |index|
+      break unless list[index].zero?
+
+      result << index if list[index].zero?
     end
+    result
   end
 
   def column_for issue:
@@ -130,7 +183,7 @@ class AgingWorkInProgressChart < ChartBase
     end
   end
 
-  def adjust_visibility_of_unmapped_status_column data_sets:, column_headings:
+  def adjust_visibility_of_unmapped_status_column data_sets:
     column_name = @fake_column.name
 
     has_unmapped = data_sets.any? do |set|
@@ -143,8 +196,19 @@ class AgingWorkInProgressChart < ChartBase
       @description_text += "<p>The items shown in #{column_name.inspect} are not visible on the " \
         'board but are still active. Most likely everyone has forgotten about them.</p>'
     else
-      column_headings.pop
+      # @column_headings.pop
       @board_columns.pop
     end
   end
+
+  def percentiles percentile_color_hash
+    @percentiles = percentile_color_hash.transform_values { |value| CssVariable[value] }
+  end
+
+  def adjust_chart_height
+    min_height = @max_age * 5
+
+    @canvas_height = min_height if min_height > @canvas_height
+    @canvas_height = 400 if min_height > 400
+  end
 end

data/lib/jirametrics/aging_work_table.rb

@@ -3,7 +3,7 @@
 require 'jirametrics/chart_base'
 
 class AgingWorkTable < ChartBase
-  attr_accessor :today, :board_id
+  attr_accessor :today
   attr_reader :any_scrum_boards
 
   def initialize block
@@ -22,18 +22,32 @@ class AgingWorkTable < ChartBase
         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>
+        Legend:
+        <ul>
+        <li><b>E:</b> Whether this item is <b>E</b>xpedited.</li>
+        <li><b>B/S:</b> Whether this item is either <b>B</b>locked or <b>S</b>talled.</li>
+        <li><b>Forecast:</b> A forecast of how long it is likely to take to finish this work item.</li>
+        </ul>
+      </p>
     TEXT
 
     instance_eval(&block)
   end
 
   def run
-    @today = date_range.end
+    initialize_calculator
     aging_issues = select_aging_issues + expedited_but_not_started
 
     wrap_and_render(binding, __FILE__)
   end
 
+  # This is its own method simply so the tests can initialize the calculator without doing a full run.
+  def initialize_calculator
+    @today = date_range.end
+    @calculator = BoardMovementCalculator.new board: current_board, issues: issues, today: @today
+  end
+
   def expedited_but_not_started
     @issues.select do |issue|
       started_time, stopped_time = issue.board.cycletime.started_stopped_times(issue)
@@ -114,6 +128,40 @@ class AgingWorkTable < ChartBase
     end.join('<br />')
   end
 
+  def dates_text issue
+    date = date_range.end
+    due = issue.due_date
+    message = nil
+
+    days_remaining, error = @calculator.forecasted_days_remaining_and_message issue: issue, today: @today
+
+    unless error
+      if due
+        if due < date
+          message = "Due: <b>#{due}</b> (#{label_days (@today - due).to_i} ago)"
+          error = 'Overdue'
+        elsif due == date
+          message = 'Due: <b>today</b>'
+        else
+          error = 'Due date at risk' if date_range.end + days_remaining > due
+          message = "Due: <b>#{due}</b> (#{label_days (due - @today).to_i})"
+        end
+      else
+        "#{label_days days_remaining} left."
+      end
+    end
+
+    text = +''
+    text << "<span title='#{error}' style='color: red'>ⓘ </span>" if error
+    if days_remaining
+      text << "#{label_days days_remaining} left"
+    else
+      text << 'Unable to forecast'
+    end
+    text << ' | ' << message if message
+    text
+  end
+
   def age_cutoff age = nil
     @age_cutoff = age.to_i if age
     @age_cutoff

data/lib/jirametrics/board.rb

@@ -4,18 +4,19 @@ class Board
   attr_reader :visible_columns, :raw, :possible_statuses, :sprints, :board_type
   attr_accessor :cycletime, :project_config
 
-  def initialize raw:, possible_statuses: StatusCollection.new
+  def initialize raw:, possible_statuses:
     @raw = raw
     @board_type = raw['type']
     @possible_statuses = possible_statuses
     @sprints = []
 
     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[1..] if kanban?
+    columns = columns.drop(1) if kanban?
 
     @backlog_statuses = []
     @visible_columns = columns.filter_map do |column|
@@ -27,9 +28,8 @@ class Board
   def backlog_statuses
     if @backlog_statuses.empty? && kanban?
       status_ids = status_ids_from_column raw['columnConfig']['columns'].first
-      @backlog_statuses = @possible_statuses.expand_statuses(status_ids) do |unknown_status|
-        # If a status is returned here that is no longer in the system then there's nothing useful
-        # we can do about it. Ignore it.
+      @backlog_statuses = status_ids.filter_map do |id|
+        @possible_statuses.find_by_id id
       end
     end
     @backlog_statuses
@@ -89,4 +89,32 @@ class Board
   def name
     @raw['name']
   end
+
+  def accumulated_status_ids_per_column
+    accumulated_status_ids = []
+    visible_columns.reverse.filter_map do |column|
+      next if column == @fake_column
+
+      accumulated_status_ids += column.status_ids
+      [column.name, accumulated_status_ids.dup]
+    end.reverse
+  end
+
+  def ensure_uniqueness_of_column_names! json
+    all_names = []
+    json.each do |column_json|
+      name = column_json['name']
+      if all_names.include? name
+        (2..).each do |i|
+          new_name = "#{name}-#{i}"
+          next if all_names.include?(new_name)
+
+          name = new_name
+          column_json['name'] = new_name
+          break
+        end
+      end
+      all_names << name
+    end
+  end
 end

data/lib/jirametrics/board_config.rb

@@ -21,11 +21,15 @@ class BoardConfig
         'If so, remove it from there.'
     end
 
-    @board.cycletime = CycleTimeConfig.new(parent_config: self, label: label, block: block)
+    @board.cycletime = CycleTimeConfig.new(
+      parent_config: self, label: label, block: block, file_system: project_config.file_system
+    )
   end
 
   def expedited_priority_names *priority_names
-    deprecated date: '2024-09-15', message: 'Expedited priority names are now specified in settings'
+    project_config.exporter.file_system.deprecated(
+      date: '2024-09-15', message: 'Expedited priority names are now specified in settings'
+    )
     @project_config.settings['expedited_priority_names'] = priority_names
   end
 end

data/lib/jirametrics/board_movement_calculator.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+class BoardMovementCalculator
+  attr_reader :board, :issues, :today
+
+  def initialize board:, issues:, today:
+    @board = board
+    @issues = issues.select { |issue| issue.board == board && issue.done? && !moves_backwards?(issue) }
+    @today = today
+  end
+
+  def moves_backwards? issue
+    started, stopped = issue.board.cycletime.started_stopped_times(issue)
+    return false unless started
+
+    previous_column = nil
+    issue.status_changes.each do |change|
+      column = board.visible_columns.index { |c| c.status_ids.include?(change.value_id) }
+      next if change.time < started
+      next if column.nil? # It disappeared from the board for a bit
+      return true if previous_column && column && column < previous_column
+
+      previous_column = column
+    end
+    false
+  end
+
+  def stacked_age_data_for percentages:
+    data_list = percentages.sort.collect do |percentage|
+      [percentage, age_data_for(percentage: percentage)]
+    end
+
+    stack_data data_list
+  end
+
+  def stack_data data_list
+    remainder = nil
+    data_list.collect do |percentage, data|
+      unless remainder.nil?
+        data = (0...data.length).collect do |i|
+          data[i] - remainder[i]
+        end
+
+      end
+      remainder = data
+
+      [percentage, data]
+    end
+  end
+
+  def age_data_for percentage:
+    data = []
+    board.visible_columns.each_with_index do |_column, column_index|
+      ages = ages_of_issues_when_leaving_column column_index: column_index, today: today
+
+      if ages.empty?
+        data << 0
+      else
+        index = ((ages.size - 1) * percentage / 100).to_i
+        data << ages[index]
+      end
+    end
+    data
+  end
+
+  def ages_of_issues_when_leaving_column column_index:, today:
+    this_column = board.visible_columns[column_index]
+    next_column = board.visible_columns[column_index + 1]
+
+    @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)
+
+      # Skip if we can't tell when it started.
+      next if issue_start.nil?
+
+      # Skip if it never entered this column
+      next if this_column_start.nil?
+
+      # Skip if it left this column before the item is considered started.
+      next 0 if next_column_start && next_column_start <= issue_start
+
+      # Skip if it was already done by the time it got to this column or it became done when it got to this column
+      next if issue_done && issue_done <= this_column_start
+
+      end_date = case # rubocop:disable Style/EmptyCaseCondition
+      when next_column_start.nil?
+        # If this is the last column then base age against today
+        today
+      when issue_done && issue_done < next_column_start
+        # it completed while in this column
+        issue_done.to_date
+      else
+        # It passed through this whole column
+        next_column_start.to_date
+      end
+      (end_date - issue_start.to_date).to_i + 1
+    end.sort
+  end
+
+  # Figure out what column this is issue is currently in and what time it entered that column. We need this for
+  # aging and forecasting purposes
+  def find_current_column_and_entry_time_in_column issue
+    column = board.visible_columns.find { |c| c.status_ids.include?(issue.status.id) }
+    return [] if column.nil? # This issue isn't visible on the board
+
+    status_ids = column.status_ids
+
+    entry_at = issue.changes.reverse.find { |change| change.status? && status_ids.include?(change.value_id) }&.time
+
+    [column.name, entry_at]
+  end
+
+  def label_days days
+    "#{days} day#{'s' unless days == 1}"
+  end
+
+  def forecasted_days_remaining_and_message issue:, today:
+    return [nil, 'Already done'] if issue.done?
+
+    likely_age_data = age_data_for percentage: 85
+
+    column_name, entry_time = find_current_column_and_entry_time_in_column issue
+    return [nil, 'This issue is not visible on the board. No way to predict when it will be done.'] if column_name.nil?
+
+    age_in_column = (today - entry_time.to_date).to_i + 1
+
+    message = nil
+    column_index = board.visible_columns.index { |c| c.name == column_name }
+
+    last_non_zero_datapoint = likely_age_data.reverse.find { |d| !d.zero? }
+    return [nil, 'There is no historical data for this board. No forecast can be made.'] if last_non_zero_datapoint.nil?
+
+    remaining_in_current_column = likely_age_data[column_index] - age_in_column
+    if remaining_in_current_column.negative?
+      message = "This item is an outlier at #{label_days issue.board.cycletime.age(issue, today: today)} " \
+        "in the #{column_name.inspect} column. Most items on this board have left this column in " \
+        "#{label_days likely_age_data[column_index]} or less, so we cannot forecast when it will be done."
+      remaining_in_current_column = 0
+      return [nil, message]
+    end
+
+    forecasted_days = last_non_zero_datapoint - likely_age_data[column_index] + remaining_in_current_column
+    [forecasted_days, message]
+  end
+end

data/lib/jirametrics/change_item.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 class ChangeItem
-  attr_reader :field, :value_id, :old_value_id, :raw, :author
-  attr_accessor :value, :old_value, :time
+  attr_reader :field, :value_id, :old_value_id, :raw, :author, :time
+  attr_accessor :value, :old_value
 
   def initialize raw:, time:, author:, artificial: false
     @raw = raw
     @time = time
-    raise "Time must be an object of type Time in the correct timezone: #{@time}" if @time.is_a? String
+    raise 'ChangeItem.new() time cannot be nil' if time.nil?
+    raise "Time must be an object of type Time in the correct timezone: #{@time.inspect}" unless @time.is_a? Time
 
-    @field = field || @raw['field']
-    @value = value || @raw['toString']
+    @field = @raw['field']
+    @value = @raw['toString']
     @value_id = @raw['to'].to_i
     @old_value = @raw['fromString']
     @old_value_id = @raw['from']&.to_i
@@ -34,9 +35,21 @@ class ChangeItem
 
   def link? = (field == 'Link')
 
+  def labels? = (field == 'labels')
+
+  # An alias for time so that logic accepting a Time, Date, or ChangeItem can all respond to :to_time
+  def to_time = @time
+
   def to_s
     message = +''
-    message << "ChangeItem(field: #{field.inspect}, value: #{value.inspect}, time: #{time_to_s(@time).inspect}"
+    message << "ChangeItem(field: #{field.inspect}"
+    message << ", value: #{value.inspect}"
+    message << ':' << value_id.inspect if status?
+    if old_value
+      message << ", old_value: #{old_value.inspect}"
+      message << ':' << old_value_id.inspect if status?
+    end
+    message << ", time: #{time_to_s(@time).inspect}"
     message << ', artificial' if artificial?
     message << ')'
     message