jirametrics 1.0.0 → 2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dbe04bbc480c61f2bb1d09cdab71e9ed47fb8265336b2a1f05551bff78dec17
-  data.tar.gz: 69c590731144d58f3235e72fb04f7d766b47a635c47301c5c87f1dbfc2cb13d5
+  metadata.gz: 670df42835c7d41e30dcde01ead744a132f81313165297d434334e272de795c7
+  data.tar.gz: 12822842210b4aeddb7f59e6681a9f1bd25060bae0ff98e8490d14e895dea657
 SHA512:
-  metadata.gz: 494a2760b3f32fab17432735527e20fdd60105ca670437bb6cf382bd2844d78313f985db7cf3e1534f5bc67f7f2def4d598a58d46009018d14dbbb0ab70e2ce2
-  data.tar.gz: c77baf2ff091972595cc126de4a03dea02f756b01db33cf90144583d65de81d07f5b37856a920d3870d72f4b7100709a243099e29fe79f78b52d96d207641545
+  metadata.gz: a4f36b8921c94a457710dc68251a9a2ddb38be2f0f7027991cf381fdf1cff28d2e549e508314733a3c753f583fd3c695b7e4979e1bb7be43c45de90ec001cbab
+  data.tar.gz: 28a2553b31cd4de5fce0c943da38643ad13dbfad3a8bddc77f4764e179394968966bb676e70daa75a4faeb42a67027fb7efb63895b56c01a3db563a029df66aa

data/bin/jirametrics

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'jirametrics'
 JiraMetrics.start(ARGV)

data/lib/jirametrics/aggregate_config.rb

@@ -3,7 +3,7 @@
 require 'date'
 
 class AggregateConfig
-  attr_reader :project_config
+  attr_reader :project_config, :included_projects
 
   def initialize project_config:, block:
     @project_config = project_config
@@ -19,14 +19,15 @@ class AggregateConfig
       raise "#{@project_config.name}: When aggregating, you must include at least one other project"
     end
 
-    # If the date range wasn't set then calculate it now
+    # If the time range wasn't set then calculate it now
     @project_config.time_range = find_time_range projects: @included_projects if @project_config.time_range.nil?
 
-    adjust_issue_links
+    adjust_issue_links issues: @project_config.issues
   end
 
-  def adjust_issue_links
-    issues = @project_config.issues
+  # IssueLinks just have a reference to the key. Walk through all of them to see if we have a full
+  # issue that we'd already loaded. If we do, then replace it.
+  def adjust_issue_links issues:
     issues.each do |issue|
       issue.issue_links.each do |link|
         other_issue_key = link.other_issue.key
@@ -40,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?
-      puts "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
@@ -48,28 +49,25 @@ class AggregateConfig
     @project_config.jira_url = project.jira_url if @project_config.jira_url.nil?
     unless @project_config.jira_url == project.jira_url
       raise 'Not allowed to aggregate projects from different Jira instances: ' \
-        "#{@project_config.jira_url.inspect} and #{project.jira_url.inspect}"
+        "#{@project_config.jira_url.inspect} and #{project.jira_url.inspect}. For project #{project_name}"
     end
 
     @included_projects << project
-    @project_config.add_issues project.issues
-  end
-
-  def date_range range
-    @project_config.time_range = date_range_to_time_range(
-      date_range: range, timezone_offset: project_config.exporter.timezone_offset
-    )
-  end
-
-  def date_range_to_time_range date_range:, timezone_offset:
-    start_of_first_day = Time.new(
-      date_range.begin.year, date_range.begin.month, date_range.begin.day, 0, 0, 0, timezone_offset
-    )
-    end_of_last_day = Time.new(
-      date_range.end.year, date_range.end.month, date_range.end.day, 23, 59, 59, timezone_offset
-    )
+    if project.file_configs.empty?
+      issues = project.issues
+    else
+      issues = project.file_configs.first.issues
+      if project.file_configs.size > 1
+        log 'More than one file section is defined. For the aggregated view, we always use ' \
+          'the first file section'
+      end
+    end
 
-    start_of_first_day..end_of_last_day
+    if issues.nil?
+      file_system.warning "No issues found for #{project_name}"
+    else
+      @project_config.add_issues issues
+    end
   end
 
   def find_time_range projects:
@@ -83,7 +81,12 @@ class AggregateConfig
       latest = range.end if latest.nil? || range.end > latest
     end
 
-    raise "Can't calculate range" if earliest.nil? || latest.nil?
     earliest..latest
   end
+
+  private
+
+  def file_system
+    @project_config.exporter.file_system
+  end
 end

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -3,9 +3,7 @@
 require 'jirametrics/chart_base'
 
 class AgingWorkBarChart < ChartBase
-  @@next_id = 0
-
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text 'Aging Work Bar Chart'
@@ -17,71 +15,87 @@ class AgingWorkBarChart < ChartBase
       <p>
         There are potentially three bars for each issue, although a bar may be missing if the issue has no
         information relevant to that. Hovering over any of the bars will provide more details.
-        <ol><li>The top bar tells you what status the issue is in at any time. Any statuses in the status
-        category of "To Do" will be in blue. Any in the category of "In Progress" will be in a
-        yellow and any in "Done" will be green.</li>
-        <li>The middle bar indicates blocked and stalled states. A lighter orange is stalled and a darker,
-        reddish colour is blocked.</li>
-        <li>The bottom bar indicated an expedited state.</li></ol>
-      </p>
-      <p>
-        The gray backgrounds indicate weekends and the red vertical line indicates the 85% point for all
-        items in this time period. Anything that started to the left of that is now an outlier.
+        <ol>
+          <li>The top bar tells you what status the issue is in at any time. The colour indicates the
+          status category, which will be one of #{color_block '--status-category-todo-color'} To Do,
+          #{color_block '--status-category-inprogress-color'} In Progress,
+          or #{color_block '--status-category-done-color'} Done</li>
+          <li>The middle bar indicates #{color_block '--blocked-color'} blocked
+          or #{color_block '--stalled-color'} stalled.</li>
+          <li>The bottom bar indicated #{color_block '--expedited-color'} expedited.</li>
+        </ol>
       </p>
+      #{describe_non_working_days}
     HTML
 
     # Because this one will size itself as needed, we start with a smaller default size
     @canvas_height = 80
 
-    instance_eval(&block) if block
+    instance_eval(&block)
   end
 
   def run
-    aging_issues = @issues.select do |issue|
-      cycletime = issue.board.cycletime
-      cycletime.started_time(issue) && cycletime.stopped_time(issue).nil?
-    end
-
-    grow_chart_height_if_too_many_issues aging_issues.size
+    aging_issues = select_aging_issues issues: @issues
 
     today = date_range.end
-    aging_issues.sort! do |a, b|
-      a.board.cycletime.age(b, today: today) <=> b.board.cycletime.age(a, today: today)
-    end
-    data_sets = []
-    aging_issues.each do |issue|
-      cycletime = issue.board.cycletime
-      issue_start_time = cycletime.started_time(issue)
-      issue_start_date = issue_start_time.to_date
-      issue_label = "[#{label_days cycletime.age(issue, today: today)}] #{issue.key}: #{issue.summary}"[0..60]
-      [
-        status_data_sets(issue: issue, label: issue_label, today: today),
-        blocked_data_sets(
-          issue: issue,
-          issue_label: issue_label,
-          stack: 'blocked',
-          issue_start_time: issue_start_time
-        ),
-        data_set_by_block(
-          issue: issue,
-          issue_label: issue_label,
-          title_label: 'Expedited',
-          stack: 'expedited',
-          color: 'red',
-          start_date: issue_start_date
-        ) { |day| issue.expedited_on_date?(day) }
-      ].compact.flatten.each do |data|
-        data_sets << data
-      end
-    end
+    sort_by_age! issues: aging_issues, today: today
+
+    grow_chart_height_if_too_many_issues aging_issue_count: aging_issues.size
+
+    data_sets = aging_issues
+      .collect { |issue| data_sets_for_one_issue issue: issue, today: today }
+      .flatten
+      .compact
 
     percentage = calculate_percent_line
     percentage_line_x = date_range.end - calculate_percent_line if percentage
 
+    if aging_issues.empty?
+      @description_text = '<p>There is no aging work</p>'
+      return render_top_text(binding)
+    end
+
     wrap_and_render(binding, __FILE__)
   end
 
-  def grow_chart_height_if_too_many_issues aging_issue_count
+  def data_sets_for_one_issue issue:, today:
+    cycletime = issue.board.cycletime
+    issue_start_time, _stopped_time = cycletime.started_stopped_times(issue)
+    issue_start_date = issue_start_time.to_date
+    issue_label = "[#{label_days cycletime.age(issue, today: today)}] #{issue.key}: #{issue.summary}"[0..60]
+    [
+      status_data_sets(issue: issue, label: issue_label, today: today),
+      blocked_data_sets(
+        issue: issue,
+        issue_label: issue_label,
+        stack: 'blocked',
+        issue_start_time: issue_start_time
+      ),
+      data_set_by_block(
+        issue: issue,
+        issue_label: issue_label,
+        title_label: 'Expedited',
+        stack: 'expedited',
+        color: CssVariable['--expedited-color'],
+        start_date: issue_start_date
+      ) { |day| issue.expedited_on_date?(day) }
+    ]
+  end
+
+  def sort_by_age! issues:, today:
+    issues.sort! do |a, b|
+      a.board.cycletime.age(b, today: today) <=> b.board.cycletime.age(a, today: today)
+    end
+  end
+
+  def select_aging_issues issues:
+    issues.select do |issue|
+      started_time, stopped_time = issue.board.cycletime.started_stopped_times(issue)
+      started_time && stopped_time.nil?
+    end
+  end
+
+  def grow_chart_height_if_too_many_issues aging_issue_count:
     px_per_bar = 8
     bars_per_issue = 3
     preferred_height = aging_issue_count * px_per_bar * bars_per_issue
@@ -91,7 +105,7 @@ class AgingWorkBarChart < ChartBase
   def status_data_sets issue:, label:, today:
     cycletime = issue.board.cycletime
 
-    issue_started_time = cycletime.started_time(issue)
+    issue_started_time, _issue_stopped_time = cycletime.started_stopped_times(issue)
 
     previous_start = nil
     previous_status = nil
@@ -100,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 = {
@@ -111,7 +125,7 @@ class AgingWorkBarChart < ChartBase
             title: "#{issue.type} : #{change.value}"
           }],
           backgroundColor: status_category_color(status),
-          borderColor: 'white',
+          borderColor: CssVariable['--aging-work-bar-chart-separator-color'],
           borderWidth: {
              top: 0,
              right: 1,
@@ -146,10 +160,17 @@ class AgingWorkBarChart < ChartBase
   end
 
   def one_block_change_data_set starting_change:, ending_time:, issue_label:, stack:, issue_start_time:
-    color = settings['colors']['blocked']
-    color = settings['colors']['stalled'] if starting_change.stalled?
+    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?
     {
-      backgroundColor: color,
+      backgroundColor: CssVariable[color],
       data: [
         {
           title: starting_change.reasons,
@@ -187,14 +208,14 @@ class AgingWorkBarChart < ChartBase
   end
 
   def data_set_by_block(
-    issue:, issue_label:, title_label:, stack:, color:, start_date:, end_date: date_range.end, &block
+    issue:, issue_label:, title_label:, stack:, color:, start_date:, end_date: date_range.end
   )
     started = nil
     ended = nil
     data = []
 
     (start_date..end_date).each do |day|
-      if block.call(day)
+      if yield(day)
         started = day if started.nil?
         ended = day
       elsif ended
@@ -217,6 +238,8 @@ class AgingWorkBarChart < ChartBase
       }
     end
 
+    return [] if data.empty?
+
     {
       type: 'bar',
       data: data,
@@ -227,7 +250,7 @@ class AgingWorkBarChart < ChartBase
   end
 
   def calculate_percent_line percentage: 85
-    days = completed_issues_in_range.collect { |issue| issue.board.cycletime.cycletime(issue) }.compact.sort
+    days = completed_issues_in_range.filter_map { |issue| issue.board.cycletime.cycletime(issue) }.sort
     return nil if days.empty?
 
     days[days.length * percentage / 100]

data/lib/jirametrics/aging_work_in_progress_chart.rb

@@ -2,26 +2,48 @@
 
 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
 
-  def initialize block = nil
+  def initialize block
     super()
     header_text 'Aging Work in Progress'
     description_text <<-HTML
       <p>
         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.
+        they're currently in. Hovering over a dot will show you the ID of that work item.
       </p>
       <p>
-        The gray 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 gray area. Any work items above
-        the gray area are outliers and they are the items that you should pay special attention to.
+        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
@@ -35,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)
 
@@ -50,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
@@ -61,65 +87,94 @@ 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|
       {
         'type' => 'line',
         'label' => rules.label,
-        'data' => rules_to_issues[rules].collect do |issue|
+        'data' => rules_to_issues[rules].filter_map do |issue|
             age = issue.board.cycletime.age(issue, today: date_range.end)
             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})"]
             }
-          end.compact,
+          end,
         'fill' => false,
         'showLine' => false,
         'backgroundColor' => rules.color
       }
     end
-    data_sets << {
-      'type' => 'bar',
-      'label' => "#{percentage}%",
-      'barPercentage' => 1.0,
-      'categoryPercentage' => 1.0,
-      '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.collect do |column|
-      next if column == @fake_column
+  def adjust_bar_data input
+    return [] if input.empty?
+
+    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
 
-      accumulated_status_ids += column.status_ids
-      [column.name, accumulated_status_ids.dup]
-    end.compact.reverse
+    output
   end
 
-  def ages_of_issues_that_crossed_column_boundary issues:, status_ids:
-    issues.collect 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?
+
+      result << index
+    end
 
-      # 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
+    stop_at = result.empty? ? 0 : (result.last + 1)
+    (list.size - 1).downto(stop_at).each do |index|
+      break unless list[index].zero?
 
-      (stop.to_date - start.to_date).to_i + 1
-    end.compact
+      result << index if list[index].zero?
+    end
+    result
   end
 
   def column_for issue:
@@ -128,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|
@@ -141,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