jirametrics 2.5 → 2.30

data/lib/jirametrics/aging_work_in_progress_chart.rb

@@ -2,9 +2,11 @@
 
 require 'jirametrics/chart_base'
 require 'jirametrics/groupable_issue_chart'
+require 'jirametrics/board_movement_calculator'
 
 class AgingWorkInProgressChart < ChartBase
   include GroupableIssueChart
+
   attr_accessor :possible_statuses, :board_id
   attr_reader :board_columns
 
@@ -16,13 +18,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
@@ -34,15 +56,19 @@ class AgingWorkInProgressChart < ChartBase
   def run
     determine_board_columns
 
-    @header_text += " on board: #{@all_boards[@board_id].name}"
+    @header_text += " on board: #{current_board.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)
 
@@ -62,7 +88,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 +99,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 +112,101 @@ 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 = trim_board_columns data_sets: data_sets, calculator: calculator
+
+    @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?
 
-      accumulated_status_ids += column.status_ids
-      [column.name, accumulated_status_ids.dup]
-    end.reverse
+    row_size = input.first.size
+
+    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_time(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 trim_board_columns data_sets:, calculator:
+    return [] if @show_all_columns
+
+    columns_with_aging_items = data_sets.flat_map do |set|
+      set['data'].filter_map { |d| d['x'] if d.is_a? Hash }
+    end.uniq
+
+    # @fake_column is always the last element and is handled separately.
+    real_column_count = @board_columns.size - 1
+
+    # The last visible column always has artificially inflated age_data because
+    # ages_of_issues_when_leaving_column uses `today` as end_date when there is no
+    # next column. Exclude it from the right-boundary search so it is only kept when
+    # it has current aging items (handled by the last_aging fallback below).
+    age_data = calculator.age_data_for(percentage: 100)
+    last_data = (0...(real_column_count - 1)).to_a.reverse.find { |i| !age_data[i].zero? }
+
+    in_current = ->(i) { columns_with_aging_items.include?(@board_columns[i].name) }
+    first_aging = (0...real_column_count).find(&in_current)
+    last_aging  = (0...real_column_count).to_a.reverse.find(&in_current)
+
+    # Combine: include any column with age_data (up to but not including the last visible
+    # column) and any column with current aging items.
+    first_data = (0...real_column_count).find { |i| !age_data[i].zero? }
+    left_bound  = [first_data, first_aging].compact.min
+    right_bound = [last_data, last_aging].compact.max
+
+    indexes_to_remove =
+      if left_bound && right_bound
+        (0...left_bound).to_a + ((right_bound + 1)...real_column_count).to_a
+      else
+        (0...real_column_count).to_a
+      end
+
+    indexes_to_remove.reverse_each { |index| @board_columns.delete_at index }
+    indexes_to_remove
   end
 
   def column_for issue:
@@ -130,7 +215,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|
@@ -139,12 +224,23 @@ class AgingWorkInProgressChart < ChartBase
       end
     end
 
-    if has_unmapped
+    if has_unmapped && @description_text
       @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,30 +22,44 @@ 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
+    @calculators = @all_boards.transform_values do |board|
+      BoardMovementCalculator.new board: board, issues: issues, today: @today
+    end
+  end
+
   def expedited_but_not_started
     @issues.select do |issue|
-      cycletime = issue.board.cycletime
-      cycletime.started_time(issue).nil? && cycletime.stopped_time(issue).nil? && issue.expedited?
+      started_time, stopped_time = issue.started_stopped_times
+      started_time.nil? && stopped_time.nil? && issue.expedited?
     end.sort_by(&:created)
   end
 
   def select_aging_issues
     aging_issues = @issues.select do |issue|
-      cycletime = issue.board.cycletime
-      started = cycletime.started_time(issue)
-      stopped = cycletime.stopped_time(issue)
+      started, stopped = issue.started_stopped_times
       next false if started.nil? || stopped
       next true if issue.blocked_on_date?(@today, end_time: time_range.end) || issue.expedited?
 
@@ -64,7 +78,7 @@ class AgingWorkTable < ChartBase
   end
 
   def blocked_text issue
-    started_time = issue.board.cycletime.started_time(issue)
+    started_time, _stopped_time = issue.started_stopped_times
     return nil if started_time.nil?
 
     current = issue.blocked_stalled_changes(end_time: time_range.end)[-1]
@@ -95,26 +109,52 @@ class AgingWorkTable < ChartBase
   end
 
   def sprints_text issue
-    sprint_ids = []
-
-    issue.changes.each do |change|
-      next unless change.sprint?
-
-      sprint_ids << change.raw['to'].split(/\s*,\s*/).collect { |id| id.to_i }
-    end
-    sprint_ids.flatten!
-
-    issue.board.sprints.select { |s| sprint_ids.include? s.id }.collect do |sprint|
+    issue.sprints.collect do |sprint|
       icon_text = nil
       if sprint.active?
         icon_text = icon_span title: 'Active sprint', icon: '➡️'
-      else
+      elsif sprint.closed?
         icon_text = icon_span title: 'Sprint closed', icon: '✅'
       end
       "#{sprint.name} #{icon_text}"
     end.join('<br />')
   end
 
+  def dates_text issue
+    date = date_range.end
+    due = issue.due_date
+    message = nil
+
+    calculator = @calculators[issue.board.id]
+    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
@@ -134,4 +174,8 @@ class AgingWorkTable < ChartBase
 
     result.reverse
   end
+
+  def priority_text issue
+    "<img src='#{issue.priority_url}' title='Priority: #{issue.priority_name}' style='max-width: 1em;'/>"
+  end
 end

data/lib/jirametrics/anonymizer.rb

@@ -2,11 +2,12 @@
 
 require 'random-word'
 
-class Anonymizer
+class Anonymizer < ChartBase
   # needed for testing
   attr_reader :project_config, :issues
 
   def initialize project_config:, date_adjustment: -200
+    super()
     @project_config = project_config
     @issues = @project_config.issues
     @all_boards = @project_config.all_boards
@@ -20,6 +21,10 @@ class Anonymizer
     anonymize_column_names
     # anonymize_issue_statuses
     anonymize_board_names
+    anonymize_labels_and_components
+    anonymize_sprints
+    anonymize_fix_versions
+    anonymize_server_url
     shift_all_dates unless @date_adjustment.zero?
     @file_system.log 'Anonymize done'
   end
@@ -37,13 +42,25 @@ class Anonymizer
 
   def anonymize_issue_keys_and_titles issues: @issues
     counter = 0
+    seen_author_raws = {}
     issues.each do |issue|
       new_key = "ANON-#{counter += 1}"
 
       issue.raw['key'] = new_key
       issue.raw['fields']['summary'] = random_phrase
+      issue.raw['fields']['description'] = nil
       issue.raw['fields']['assignee']['displayName'] = random_name unless issue.raw['fields']['assignee'].nil?
 
+      anonymize_author_raw(issue.raw['fields']['creator'], seen_author_raws)
+
+      issue.changes.each do |change|
+        anonymize_author_raw(change.author_raw, seen_author_raws)
+        if change.comment? || change.description?
+          change.value = nil
+          change.old_value = nil
+        end
+      end
+
       issue.issue_links.each do |link|
         other_issue = link.other_issue
         next if other_issue.key.match?(/^ANON-\d+$/) # Already anonymized?
@@ -54,6 +71,49 @@ class Anonymizer
     end
   end
 
+  def anonymize_labels_and_components
+    @issues.each do |issue|
+      issue.raw['fields']['labels'] = []
+      issue.raw['fields']['components'] = []
+    end
+  end
+
+  def anonymize_sprints
+    sprint_counter = 0
+    sprint_name_map = {}
+    @all_boards.each_value do |board|
+      board.sprints.each do |sprint|
+        name = sprint.raw['name']
+        unless sprint_name_map[name]
+          sprint_counter += 1
+          sprint_name_map[name] = "Sprint-#{sprint_counter}"
+        end
+        sprint.raw['name'] = sprint_name_map[name]
+      end
+    end
+  end
+
+  def anonymize_fix_versions
+    version_counter = 0
+    version_name_map = {}
+    @issues.each do |issue|
+      issue.raw['fields']['fixVersions']&.each do |fix_version|
+        name = fix_version['name']
+        unless version_name_map[name]
+          version_counter += 1
+          version_name_map[name] = "Version-#{version_counter}"
+        end
+        fix_version['name'] = version_name_map[name]
+      end
+    end
+  end
+
+  def anonymize_server_url
+    @all_boards.each_value do |board|
+      board.raw['self'] = board.raw['self']&.sub(/^https?:\/\/[^\/]+/, 'https://anon.example.com')
+    end
+  end
+
   def anonymize_column_names
     @all_boards.each_key do |board_id|
       @file_system.log "Anonymizing column names for board #{board_id}"
@@ -130,18 +190,19 @@ class Anonymizer
     end
   end
 
-  def shift_all_dates
-    @file_system.log "Shifting all dates by #{@date_adjustment} days"
+  def shift_all_dates date_adjustment: @date_adjustment
+    adjustment_in_seconds = 60 * 60 * 24 * date_adjustment
+    @file_system.log "Shifting all dates by #{label_days date_adjustment}"
     @issues.each do |issue|
       issue.changes.each do |change|
-        change.time = change.time + @date_adjustment
+        change.time = change.time + adjustment_in_seconds
       end
 
-      issue.raw['fields']['updated'] = (issue.updated + @date_adjustment).to_s
+      issue.raw['fields']['updated'] = (issue.updated + adjustment_in_seconds).to_s
     end
 
     range = @project_config.time_range
-    @project_config.time_range = (range.begin + @date_adjustment)..(range.end + @date_adjustment)
+    @project_config.time_range = (range.begin + adjustment_in_seconds)..(range.end + adjustment_in_seconds)
   end
 
   def random_name
@@ -184,4 +245,18 @@ class Anonymizer
       board.raw['name'] = "#{random_phrase} board"
     end
   end
+
+  private
+
+  def anonymize_author_raw author_raw, seen
+    return unless author_raw
+    return if seen[author_raw.object_id]
+
+    seen[author_raw.object_id] = true
+    name = random_name
+    author_raw['displayName'] = name
+    author_raw['name'] = name
+    author_raw.delete('emailAddress')
+    author_raw.delete('avatarUrls')
+  end
 end