jirametrics 2.10 → 2.13

data/lib/jirametrics/estimate_accuracy_chart.rb

@@ -22,15 +22,18 @@ class EstimateAccuracyChart < ChartBase
       </div>
     HTML
 
-    @y_axis_label = 'Story Point Estimates'
     @y_axis_type = 'linear'
-    @y_axis_block = ->(issue, start_time) { story_points_at(issue: issue, start_time: start_time)&.to_f }
+    @y_axis_block = ->(issue, start_time) { estimate_at(issue: issue, start_time: start_time)&.to_f }
     @y_axis_sort_order = nil
 
     instance_eval(&configuration_block)
   end
 
   def run
+    if @y_axis_label.nil?
+      text = current_board.estimation_configuration.units == :story_points ? 'Story Points' : 'Days'
+      @y_axis_label = "Estimated #{text}"
+    end
     data_sets = scan_issues
 
     return '' if data_sets.empty?
@@ -41,6 +44,7 @@ class EstimateAccuracyChart < ChartBase
   def scan_issues
     completed_hash, aging_hash = split_into_completed_and_aging issues: issues
 
+    estimation_units = current_board.estimation_configuration.units
     @has_aging_data = !aging_hash.empty?
 
     [
@@ -53,9 +57,13 @@ class EstimateAccuracyChart < ChartBase
       # We sort so that the smaller circles are in front of the bigger circles.
       data = hash.sort(&hash_sorter).collect do |key, values|
         estimate, cycle_time = *key
-        estimate_label = "#{estimate}#{'pts' if @y_axis_type == 'linear'}"
-        title = ["Estimate: #{estimate_label}, Cycletime: #{label_days(cycle_time)}, #{values.size} issues"] +
-          values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
+        title = [
+          "Estimate: #{estimate_label(estimate: estimate, estimation_units: estimation_units)}, " \
+            "Cycletime: #{label_days(cycle_time)}, " \
+            "#{values.size} issues"
+        ] + values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
         {
           'x' => cycle_time,
           'y' => estimate,
@@ -77,6 +85,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
+  def estimate_label estimate:, estimation_units:
+    if @y_axis_type == 'linear'
+      if estimation_units == :story_points
+        estimate_label = "#{estimate}pts"
+      elsif estimation_units == :seconds
+        estimate_label = label_days estimate
+      end
+    end
+    estimate_label = estimate.to_s if estimate_label.nil?
+    estimate_label
+  end
+
   def split_into_completed_and_aging issues:
     aging_hash = {}
     completed_hash = {}
@@ -126,14 +146,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
-  def story_points_at issue:, start_time:
-    story_points = nil
+  def estimate_at issue:, start_time:, estimation_configuration: current_board.estimation_configuration
+    estimate = nil
+
     issue.changes.each do |change|
-      return story_points if change.time >= start_time
+      return estimate if change.time >= start_time
 
-      story_points = change.value if change.story_points?
+      if change.field == estimation_configuration.display_name || change.field == estimation_configuration.field_id
+        estimate = change.value
+        estimate = estimate.to_f / (24 * 60 * 60) if estimation_configuration.units == :seconds
+      end
     end
-    story_points
+    estimate
   end
 
   def y_axis label:, sort_order: nil, &block

data/lib/jirametrics/estimation_configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class EstimationConfiguration
+  attr_reader :units, :display_name, :field_id
+
+  def initialize raw:
+    @units = :story_points
+    @display_name = 'Story Points'
+
+    # If there wasn't an estimation section they rely on all defaults
+    return if raw.nil?
+
+    if raw['type'] == 'field'
+      @field_id = raw['field']['fieldId']
+      @display_name = raw['field']['displayName']
+      if @field_id == 'timeoriginalestimate'
+        @units = :seconds
+        @display_name = 'Original estimate'
+      end
+    elsif raw['type'] == 'issueCount'
+      @display_name = 'Issue Count'
+      @units = :issue_count
+    end
+  end
+end

data/lib/jirametrics/examples/standard_project.rb

@@ -58,6 +58,8 @@ class Exporter
                  type: :header
           end
 
+          daily_view
+
           cycletime_scatterplot do
             show_trend_lines
           end

data/lib/jirametrics/exporter.rb

@@ -79,8 +79,8 @@ class Exporter
       file_system.log "No issues found to match #{keys.collect(&:inspect).join(', ')}"
     else
       selected.each do |project, issue|
-        file_system.log "\nProject #{project.name}"
-        file_system.log issue.dump
+        file_system.log "\nProject #{project.name}", also_write_to_stderr: true
+        file_system.log issue.dump, also_write_to_stderr: true
       end
     end
   end

data/lib/jirametrics/file_config.rb

@@ -13,7 +13,7 @@ class FileConfig
   end
 
   def run
-    @issues = project_config.issues.dup
+    @issues = project_config.issues
     instance_eval(&@block)
 
     if @columns

data/lib/jirametrics/flow_efficiency_scatterplot.rb

@@ -27,7 +27,7 @@ class FlowEfficiencyScatterplot < ChartBase
           </mfrac>
         </math>
       </div>
-      <div style="background: yellow">Note that for this calculation to be accurate, we must be moving items into a
+      <div style="background: var(--warning-banner)">Note that for this calculation to be accurate, we must be moving items into a
         blocked or stalled state the moment we stop working on it, and most teams don't do that.
         So be aware that your team may have to change their behaviours if you want this chart to be useful.
       </div>

data/lib/jirametrics/html/aging_work_in_progress_chart.erb

@@ -6,7 +6,7 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
 {
   type: 'bar',
   data: {
-    labels: [<%= column_headings.collect(&:inspect).join(',') %>],
+    labels: [<%= @board_columns.collect { |c| c.name.inspect }.join(',') %>],
     datasets: <%= JSON.generate(data_sets) %>
   },
   options: {
@@ -22,8 +22,10 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
           labelString: 'Date Completed'
         },
         grid: {
-          color: <%= CssVariable['--grid-line-color'].to_json %>
+          color: <%= CssVariable['--grid-line-color'].to_json %>,
+          z: 1 // draw the grid lines on top of the bars
         },
+        stacked: true
       },
       y: {
         scaleLabel: {
@@ -35,8 +37,11 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
           text: 'Age in days'
         },
         grid: {
-          color: <%= CssVariable['--grid-line-color'].to_json %>
+          color: <%= CssVariable['--grid-line-color'].to_json %>,
+          z: 1 // draw the grid lines on top of the bars
         },
+        stacked: true,
+        max: <%= (@max_age * 1.1).to_i %>
       }
     },
     plugins: {
@@ -44,14 +49,26 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
         callbacks: {
           label: function(context) {
             if( typeof(context.dataset.data[context.dataIndex]) == "number" ) {
-              return "85% of the issues, leave this column in "+context.dataset.data[context.dataIndex]+" days";
+              let full_data = <%= @bar_data.inspect %>;
+              let columnIndex = context.dataIndex;
+              let rowIndex = context.datasetIndex - <%= @row_index_offset %>;
+              return context.dataset.label + " of completed work items left this column in " +full_data[rowIndex][columnIndex] + " days or less";
             }
             else {
-              return context.dataset.data[context.dataIndex].title
+              return context.dataset.data[context.dataIndex].title;
             }
           }
         }
+      },
+      legend: {
+        labels: {
+          filter: function(item, chart) {
+            // Logic to remove a particular legend item goes here
+            return !item.text.includes('%');
+          }
+        }
       }
+
     }
   }
 });

data/lib/jirametrics/html/aging_work_table.erb

@@ -1,11 +1,13 @@
 <table class='standard'>
   <thead>
     <tr>
-      <th>Age (days)</th>
-      <th>E</th>
-      <th>B</th>
+      <th title="Age in days">Age</th>
+      <th title="Expedited">E</th>
+      <th title="Blocked / Stalled">B/S</th>
+      <th title="Priority">P</th>
       <th>Issue</th>
       <th>Status</th>
+      <th>Forecast</th>
       <th>Fix versions</th>
       <% if any_scrum_boards %>
         <th>Sprints</th>
@@ -28,6 +30,7 @@
         <td style="text-align: right;"><%= issue_age || 'Not started' %></td>
         <td><%= expedited_text(issue) %></td>
         <td><%= blocked_text(issue) %></td>
+        <td><%= priority_text(issue) %></td>
         <td>
           <% parent_hierarchy(issue).each_with_index do |parent, index| %>
             <% color = parent != issue ? "var(--hierarchy-table-inactive-item-text-color)" : 'var(--default-text-color)' %>
@@ -41,6 +44,7 @@
           <% end %>
         </td>
         <td><%= format_status issue.status, board: issue.board %></td>
+        <td><%= dates_text(issue) %></td>
         <td><%= fix_versions_text(issue) %></td>
         <% if any_scrum_boards %>
           <td><%= sprints_text(issue) %></td>

data/lib/jirametrics/html/index.css

@@ -2,6 +2,7 @@
   --body-background: white;
   --default-text-color: black;
   --grid-line-color: lightgray;
+  --warning-banner: yellow;
 
   --cycletime-scatterplot-overall-trendline-color: gray;
 
@@ -27,8 +28,16 @@
   --throughput_chart_total_line_color: gray;
   
   --aging-work-in-progress-chart-shading-color: lightgray;
+  --aging-work-in-progress-chart-shading-50-color: #2E8BC0; // green;
+  --aging-work-in-progress-chart-shading-85-color: #ADD8E6; // yellow;
+  --aging-work-in-progress-chart-shading-98-color: #FF8A8A; // orange;
+  --aging-work-in-progress-chart-shading-100-color: #FF2E2E; // red;
+  
   --aging-work-in-progress-by-age-trend-line-color: gray;
   
+  --aging-work-table-date-in-jeopardy: yellow;
+  --aging-work-table-date-overdue: red;
+
   --hierarchy-table-inactive-item-text-color: gray;
 
   --wip-chart-completed-color: #00ff00;
@@ -58,6 +67,9 @@
   --sprint-burndown-sprint-color-4: red;
   --sprint-burndown-sprint-color-5: brown;
 
+  --daily-view-selected-issue-background: lightgray;
+  --daily-view-issue-border: green;
+  --daily-view-selected-issue-border: red;
 
 }
 
@@ -133,8 +145,68 @@ ul.quality_report {
   border-top: 1px solid gray;
 }
 
+div.daily_issue:hover {
+  background: var(--daily-view-selected-issue-background);
+  border-color: var(--daily-view-selected-issue-border);
+}
+
+div.daily_issue {
+  border: 1px solid var(--daily-view-issue-border);
+  padding: 0.5em;
+  .heading {
+    vertical-align: middle;
+    display: flex;
+    flex-wrap: wrap;
+    column-gap: 0.5em;
+    align-items: center;
+  }
+  table {
+    margin-left: 1em;
+    td {
+      vertical-align: top;
+    }
+    .time {
+      white-space: nowrap;
+      font-size: 0.8em;
+    }
+  }
+  .icon {
+    width: 1em;
+    height: 1em;
+  }
+  .account_id {
+    font-weight: bold;
+  }
+  .field {
+    border: 1px solid black;
+    color: white;
+    background: black;
+    padding-left: 0.2em;
+    padding-right: 0.2em;
+    border-radius: 0.2em;
+  }
+  .label {
+    border: 1px solid black;
+    padding-left: 0.2em;
+    padding-right: 0.2em;
+    border-radius: 0.2em;
+  }
+  margin-bottom: 0.5em;
+}
+div.child_issue:hover {
+  background: var(--body-background);
+}
+div.child_issue {
+  border: 1px dashed green;
+  margin: 0.2em;
+  margin-left: 1.5em;
+  padding: 0.5em;
+}
+
 @media screen and (prefers-color-scheme: dark) {
   :root {
+    --warning-banner: #9F2B00;
+
     --non-working-days-color: #2f2f2f;
     --type-story-color: #6fb86f;
     --type-task-color: #0021b3;
@@ -150,8 +222,6 @@ ul.quality_report {
     --dead-color: black;
     --wip-chart-active-color: #2551c1;
 
-    --aging-work-in-progress-chart-shading-color: #b4b4b4;
-
     --status-category-inprogress-color: #1c49bb;
 
     --cycletime-scatterplot-overall-trendline-color: gray;
@@ -165,6 +235,8 @@ ul.quality_report {
     --wip-chart-duration-two-weeks-or-less-color: #cf9400;
     --wip-chart-duration-four-weeks-or-less-color: #c25e00;
     --wip-chart-duration-more-than-four-weeks-color: #8e0000;
+
+    --daily-view-selected-issue-background: #474747;
   }
 
   h1 {
@@ -197,4 +269,12 @@ ul.quality_report {
   div.color_block {
     border: 1px solid lightgray;
   }
+
+  div.daily_issue {
+    .field {
+      color: var(--default-text-color);
+    }
+  }
+}
+
 }

data/lib/jirametrics/html/index.erb

@@ -18,18 +18,42 @@
           document.getElementById(issues_id).style.display = 'none'
         }
       }
+
+      function toggle_visibility(open_link_id, close_link_id, toggleable_id) {
+        let open_link = document.getElementById(open_link_id)
+        let close_link = document.getElementById(close_link_id)
+        let toggleable_element = document.getElementById(toggleable_id)
+
+        if(open_link.style.display == 'none') {
+          open_link.style.display = 'block'
+          close_link.style.display = 'none'
+          toggleable_element.style.display = 'none'
+        }
+        else {
+          open_link.style.display = 'none'
+          close_link.style.display = 'block'
+          toggleable_element.style.display = 'block'
+        }
+      }
       // If we switch between light/dark mode then force a refresh so all charts will redraw correctly
       // in the other colour scheme.
       window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
         location.reload()
       })
-
     </script>
     <style>
 <%= css %>
     </style>
+    <script type="text/javascript">
+      Chart.defaults.color = getComputedStyle(document.documentElement).getPropertyValue('--default-text-color');
+    </script>
   </head>
   <body>
+    <noscript>
+      <div style="padding: 1em; background: red; color: white; font-size: 2em;">
+        Javascript is currently disabled and that means that almost all of the charts in this report won't render. If you've loaded this from a folder on SharePoint then save it locally and load it again.
+      </div>
+    </noscript>
     <%= "\n" + @sections.collect { |text, type| text if type == :header }.compact.join("\n\n") %>
     <%= "\n" + @sections.collect { |text, type| text if type == :body }.compact.join("\n\n") %>
   </body>

data/lib/jirametrics/html_report_config.rb

@@ -33,6 +33,7 @@ class HtmlReportConfig
   define_chart name: 'estimate_accuracy_chart', classname: 'EstimateAccuracyChart'
   define_chart name: 'hierarchy_table', classname: 'HierarchyTable'
   define_chart name: 'flow_efficiency_scatterplot', classname: 'FlowEfficiencyScatterplot'
+  define_chart name: 'daily_view', classname: 'DailyView'
 
   define_chart name: 'daily_wip_by_type', classname: 'DailyWipChart',
     deprecated_warning: 'This is the same as daily_wip_chart. Please use that one', deprecated_date: '2024-05-23'
@@ -159,6 +160,7 @@ class HtmlReportConfig
     chart.time_range = project_config.time_range
     chart.timezone_offset = timezone_offset
     chart.settings = settings
+    chart.users = project_config.users
 
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id

data/lib/jirametrics/issue.rb

@@ -44,12 +44,12 @@ class Issue
   def key = @raw['key']
 
   def type = @raw['fields']['issuetype']['name']
-
   def type_icon_url = @raw['fields']['issuetype']['iconUrl']
 
-  def summary = @raw['fields']['summary']
+  def priority_name = @raw['fields']['priority']['name']
+  def priority_url = @raw['fields']['priority']['iconUrl']
 
-  def status = Status.from_raw(@raw['fields']['status'])
+  def summary = @raw['fields']['summary']
 
   def labels = @raw['fields']['labels'] || []
 
@@ -57,6 +57,20 @@ class Issue
 
   def resolution = @raw['fields']['resolution']&.[]('name')
 
+  def status
+    @status = Status.from_raw(@raw['fields']['status']) unless @status
+    @status
+  end
+
+  def status= status
+    @status = status
+  end
+
+  def due_date
+    text = @raw['fields']['duedate']
+    text.nil? ? nil : Date.parse(text)
+  end
+
   def url
     # Strangely, the URL isn't anywhere in the returned data so we have to fabricate it.
     "#{@board.server_url_prefix}/browse/#{key}"
@@ -129,13 +143,16 @@ class Issue
   end
 
   def most_recent_status_change
-    # We artificially insert a status change to represent creation so by definition there will always be at least one.
-    changes.reverse.find { |change| change.status? }
+    # Any issue that we loaded from its own file will always have a status as we artificially insert a status
+    # change to represent creation. Issues that were just fragments referenced from a main issue (ie a linked issue)
+    # may not have any status changes as we have no idea when it was created. This will be nil in that case
+    status_changes.last
   end
 
   # Are we currently in this status? If yes, then return the most recent status change.
   def currently_in_status *status_names
     change = most_recent_status_change
+    return false if change.nil?
 
     change if change.current_status_matches(*status_names)
   end
@@ -145,6 +162,7 @@ class Issue
     category_ids = find_status_category_ids_by_names category_names
 
     change = most_recent_status_change
+    return false if change.nil?
 
     status = find_or_create_status id: change.value_id, name: change.value
     change if status && category_ids.include?(status.category.id)
@@ -189,6 +207,10 @@ class Issue
     nil
   end
 
+  def first_time_visible_on_board
+    first_time_in_status(*board.visible_columns.collect(&:status_ids).flatten)
+  end
+
   def parse_time text
     Time.parse(text).getlocal(@timezone_offset)
   end
@@ -214,6 +236,10 @@ class Issue
     @raw['fields']&.[]('assignee')&.[]('displayName')
   end
 
+  def assigned_to_icon_url
+    @raw['fields']&.[]('assignee')&.[]('avatarUrls')&.[]('16x16')
+  end
+
   # Many test failures are simply unreadable because the default inspect on this class goes
   # on for pages. Shorten it up.
   def inspect
@@ -299,7 +325,7 @@ class Issue
 
     # This mock change is to force the writing of one last entry at the end of the time range.
     # By doing this, we're able to eliminate a lot of duplicated code in charts.
-    mock_change = ChangeItem.new time: end_time, author: '', artificial: true, raw: { 'field' => '' }
+    mock_change = ChangeItem.new time: end_time, artificial: true, raw: { 'field' => '' }, author_raw: nil
 
     (changes + [mock_change]).each do |change|
       previous_was_active = false if check_for_stalled(
@@ -319,7 +345,7 @@ class Issue
         end
       elsif change.link?
         # Example: "This issue is satisfied by ANON-30465"
-        unless /^This issue (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
+        unless /^This (?<_>issue|work item) (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
           puts "Issue(#{key}) Can't parse link text: #{change.value || change.old_value}"
           next
         end
@@ -446,8 +472,6 @@ class Issue
   end
 
   def expedited?
-    return false unless @board&.project_config
-
     names = @board.project_config.settings['expedited_priority_names']
     return false unless names
 
@@ -564,7 +588,7 @@ class Issue
     /(?<project_code1>[^-]+)-(?<id1>.+)/ =~ key
     /(?<project_code2>[^-]+)-(?<id2>.+)/ =~ other.key
     comparison = project_code1 <=> project_code2
-    comparison = id1 <=> id2 if comparison.zero?
+    comparison = id1.to_i <=> id2.to_i if comparison.zero?
     comparison
   end
 
@@ -595,21 +619,30 @@ class Issue
     end
     history = [] # time, type, detail
 
-    started_at, stopped_at = board.cycletime.started_stopped_times(self)
-    history << [started_at, nil, '↓↓↓↓ Started here ↓↓↓↓', true] if started_at
-    history << [stopped_at, nil, '↑↑↑↑ Finished here ↑↑↑↑', true] if stopped_at
+    if board.cycletime
+      started_at, stopped_at = board.cycletime.started_stopped_times(self)
+      history << [started_at, nil, '↓↓↓↓ Started here ↓↓↓↓', true] if started_at
+      history << [stopped_at, nil, '↑↑↑↑ Finished here ↑↑↑↑', true] if stopped_at
+    else
+      result << "  Unable to determine start/end times as board #{board.id} has no cycletime specified\n"
+    end
 
     @discarded_change_times&.each do |time|
       history << [time, nil, '↑↑↑↑ Changes discarded ↑↑↑↑', true]
     end
 
     (changes + (@discarded_changes || [])).each do |change|
-      value = change.value
-      old_value = change.old_value
+      if change.status?
+        value = "#{change.value.inspect}:#{change.value_id.inspect}"
+        old_value = change.old_value ? "#{change.old_value.inspect}:#{change.old_value_id.inspect}" : nil
+      else
+        value = compact_text(change.value).inspect
+        old_value = change.old_value ? compact_text(change.old_value).inspect : nil
+      end
 
       message = +''
-      message << "#{compact_text(old_value).inspect} -> " unless old_value.nil? || old_value.empty?
-      message << compact_text(value).inspect
+      message << "#{old_value} -> " unless old_value.nil? || old_value.empty?
+      message << value
       if change.artificial?
         message << ' (Artificial entry)' if change.artificial?
       else
@@ -660,34 +693,40 @@ class Issue
     @changes.select { |change| change.status? }
   end
 
-  private
+  def sprints
+    sprint_ids = []
 
-  def assemble_author raw
-    raw['author']&.[]('displayName') || raw['author']&.[]('name') || 'Unknown author'
+    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!
+
+    board.sprints.select { |s| sprint_ids.include? s.id }
   end
 
+  private
+
   def load_history_into_changes
     @raw['changelog']['histories']&.each do |history|
       created = parse_time(history['created'])
 
-      # It should be impossible to not have an author but we've seen it in production
-      author = assemble_author history
       history['items']&.each do |item|
-        @changes << ChangeItem.new(raw: item, time: created, author: author)
+        @changes << ChangeItem.new(raw: item, time: created, author_raw: history['author'])
       end
     end
   end
 
   def load_comments_into_changes
     @raw['fields']['comment']['comments']&.each do |comment|
-      raw = {
+      raw = comment.merge({
         'field' => 'comment',
         'to' => comment['id'],
         'toString' =>  comment['body']
-      }
-      author = assemble_author comment
+      })
       created = parse_time(comment['created'])
-      @changes << ChangeItem.new(raw: raw, time: created, author: author, artificial: true)
+      @changes << ChangeItem.new(raw: raw, time: created, artificial: true, author_raw: comment['author'])
     end
   end
 
@@ -729,7 +768,9 @@ class Issue
       first_status = first_change.old_value
       first_status_id = first_change.old_value_id
     end
-    ChangeItem.new time: created_time, artificial: true, author: author, raw: {
+
+    creator = raw['fields']['creator']
+    ChangeItem.new time: created_time, artificial: true, author_raw: creator, raw: {
       'field' => field_name,
       'to' => first_status_id,
       'toString' => first_status