jirametrics 2.13 → 2.22

data/lib/jirametrics/html/index.css

@@ -67,10 +67,21 @@
   --sprint-burndown-sprint-color-4: red;
   --sprint-burndown-sprint-color-5: brown;
 
+  --sprint-color: lightblue;
+
   --daily-view-selected-issue-background: lightgray;
   --daily-view-issue-border: green;
   --daily-view-selected-issue-border: red;
 
+  /* The first five are the standard priorities that Jira creates by default. */
+  --priority-color-highest: #dc2626;  /* red-600 - urgent red */
+  --priority-color-high: #ea580c;     /* orange-600 - warning orange */
+  --priority-color-medium: #9ca3af;   /* gray-400 - neutral light gray */
+  --priority-color-low: #0891b2;      /* cyan-600 - calm blue */
+  --priority-color-lowest: #64748b;   /* slate-500 - muted slate */
+  /* Then here are some values we've seen in multiple instances. */
+  --priority-color-notset: gray;
+  --priority-color-critical: red;
 }
 
 body {
@@ -78,11 +89,6 @@ body {
   color: var(--default-text-color);
 }
 
-h1 {
-  border: 1px solid black;
-  background: lightgray;
-  padding-left: 0.2em;
-}
 dl, dd, dt {
   padding: 0;
   margin: 0;
@@ -191,6 +197,11 @@ div.daily_issue {
     padding-right: 0.2em;
     border-radius: 0.2em;
   }
+  h1 {
+    border: none;
+    background: none;
+    padding-left: 0;
+  }
   margin-bottom: 0.5em;
 }
 div.child_issue:hover {
@@ -237,11 +248,12 @@ div.child_issue {
     --wip-chart-duration-more-than-four-weeks-color: #8e0000;
 
     --daily-view-selected-issue-background: #474747;
-  }
 
-  h1 {
-    color: #e0e0e0;
-    background-color: #656565;
+    --priority-color-highest: #ef4444;  /* red-500 - bright urgent red */
+    --priority-color-high: #f97316;     /* orange-500 - bright orange */
+    --priority-color-medium: #9ca3af;   /* gray-400 - neutral light gray */
+    --priority-color-low: #06b6d4;      /* cyan-500 - bright calm blue */
+    --priority-color-lowest: #94a3b8;   /* slate-400 - muted light slate */  
   }
 
   a[href] {

data/lib/jirametrics/html/index.erb

@@ -5,41 +5,9 @@
     <script src="https://cdn.jsdelivr.net/npm/moment@2.29.1/moment.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/chartjs-adapter-moment@^1"></script>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-annotation/1.2.2/chartjs-plugin-annotation.min.js" integrity="sha512-HycvvBSFvDEVyJ0tjE2rPmymkt6XqsP/Zo96XgLRjXwn6SecQqsn+6V/7KYev66OshZZ9+f9AttCGmYqmzytiw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-annotation/3.1.0/chartjs-plugin-annotation.min.js"></script>
     <script type="text/javascript">
-      function expand_collapse(link_id, issues_id)  {
-        link_text = document.getElementById(link_id).textContent
-        if( link_text == 'Show details') {
-          document.getElementById(link_id).textContent = 'Hide details'
-          document.getElementById(issues_id).style.display = 'block'
-        }
-        else {
-          document.getElementById(link_id).textContent = 'Show details'
-          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()
-      })
+<%= javascript %>
     </script>
     <style>
 <%= css %>
@@ -55,6 +23,6 @@
       </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") %>
+    <%= "\n" + @sections.collect { |text, type| text if type != :header }.compact.join("\n\n") %>
   </body>
 </html>

data/lib/jirametrics/html/index.js

@@ -0,0 +1,114 @@
+function makeFoldable() {
+  // Get all elements with the "foldable" class
+  const foldableElements = document.querySelectorAll('.foldable');
+  
+  if (foldableElements.length === 0) {
+    return; // No foldable elements found
+  }
+  
+  // Process each foldable element
+  foldableElements.forEach((element, index) => {
+    // Skip if this is the footer element
+    if (element.id === 'footer') {
+      return;
+    }
+    
+    // Create a unique ID for this section
+    const sectionId = `foldable-section-${index}`;
+    const toggleId = `foldable-toggle-${index}`;
+    
+    // Create a container div for the foldable element and its content
+    const container = document.createElement('div');
+    container.className = 'foldable-section';
+    container.id = sectionId;
+    
+    // Create a toggle button
+    const toggleButton = document.createElement(element.tagName); //'button');
+    toggleButton.id = toggleId;
+    toggleButton.className = 'foldable-toggle-btn';
+    toggleButton.innerHTML = '▼ ' + element.textContent;
+    
+    // Create a content container
+    const contentContainer = document.createElement('div');
+    contentContainer.className = 'foldable-content';
+    contentContainer.style.cssText = `
+      border-left: 2px solid #ccc;
+      padding-left: 15px;
+    `;
+    
+    // Move the foldable element into the container and replace it with the toggle button
+    element.parentNode.insertBefore(container, element);
+    container.appendChild(toggleButton);
+    container.appendChild(contentContainer);
+    
+    // Move all elements between this foldable element and the next foldable element (or end of document) into the content container
+    let nextElement = element.nextElementSibling;
+    while (nextElement && !nextElement.classList.contains('foldable')) {
+      // Skip the footer element
+      if (nextElement.id === 'footer') {
+        break;
+      }
+      
+      const temp = nextElement.nextElementSibling;
+      contentContainer.appendChild(nextElement);
+      nextElement = temp;
+    }
+    
+    // Remove the original foldable element
+    element.remove();
+    
+    // Add click event to toggle visibility
+    toggleButton.addEventListener('click', function() {
+      const content = this.nextElementSibling;
+      if (content.style.display === 'none') {
+        content.style.display = 'block';
+        this.innerHTML = '▼ ' + this.innerHTML.substring(2);
+      } else {
+        content.style.display = 'none';
+        this.innerHTML = '▶ ' + this.innerHTML.substring(2);
+      }
+    });
+    
+    // Initially show the content (you can change this to 'none' if you want sections collapsed by default)
+    contentContainer.style.display = 'block';
+    if(element.classList.contains('startFolded')) {
+      toggleButton.click();
+    }
+  });
+}
+
+// Auto-initialize when DOM is loaded
+document.addEventListener('DOMContentLoaded', function() {
+  makeFoldable();
+});
+
+
+// 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()
+})
+
+// Draw a diagonal pattern to highlight sections of a bar chart. Based on code found at:
+// https://stackoverflow.com/questions/28569667/fill-chart-js-bar-chart-with-diagonal-stripes-or-other-patterns
+function createDiagonalPattern(color = 'black') {
+  // create a 5x5 px canvas for the pattern's base shape
+  let shape = document.createElement('canvas')
+  shape.width = 5
+  shape.height = 5
+  // get the context for drawing
+  let c = shape.getContext('2d')
+  // draw 1st line of the shape 
+  c.strokeStyle = color
+  c.beginPath()
+  c.moveTo(1, 0)
+  c.lineTo(5, 4)
+  c.stroke()
+  // draw 2nd line of the shape 
+  c.beginPath()
+  c.moveTo(0, 4)
+  c.lineTo(1, 5)
+  c.stroke()
+  // create the pattern from the shape
+  return c.createPattern(shape, 'repeat')
+}

data/lib/jirametrics/html/sprint_burndown.erb

@@ -1,5 +1,6 @@
 <h2>Burndown by <%= y_axis_title %></h2>
 
+<%= seam_start %>
 <div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
@@ -63,16 +64,20 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
   }
 });
 </script>
+<%= seam_end %>
 
 <%
   link_id = next_id
   issues_id = next_id
 %>
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<div id="<%= issues_id %>" style="display: none;">
+<section>
+<div class='foldable startFolded'>Show statistics</div>
+<div id="<%= issues_id %>">
+<%= seam_start 'stats_table' %>
 <table class='standard' style="margin-left: 1em;">
   <thead>
     <th>Sprint</th>
+    <th>Length</th>
     <th>State</th>
     <th>Started</th>
     <th>Completed</th>
@@ -85,6 +90,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     <% @summary_stats.keys.sort_by(&:start_time).each do |sprint| %>
       <tr>
         <td><%= sprint.name %></td>
+        <td><%= sprint.day_count %></td>
         <td><%= sprint.raw['state'] %></td>
         <% stats = @summary_stats[sprint] %>
         <td><%= stats.started %></td>
@@ -101,6 +107,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     <% end %>
   </tbody>
 </table>
+<%= seam_end 'stats_table' %>
 
 <p>Legend:
   <ul>
@@ -109,4 +116,5 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     <% end %>
   </ul>
 </p>
-</div>
+</div>
+</section>

data/lib/jirametrics/html/throughput_chart.erb

@@ -1,4 +1,4 @@
-
+<%= seam_start %>
 <div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
@@ -59,4 +59,4 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
   }
 });
 </script>
-
+<%= seam_end %>

data/lib/jirametrics/html_generator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class HtmlGenerator
+  attr_accessor :file_system, :settings
+
+  def create_html output_filename:, settings:
+    @settings = settings
+    html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
+    css = load_css html_directory: html_directory
+    javascript = file_system.load(File.join(html_directory, 'index.js'))
+    erb = ERB.new file_system.load(File.join(html_directory, 'index.erb'))
+    file_system.save_file content: erb.result(binding), filename: output_filename
+  end
+
+  def load_css html_directory:
+    base_css_filename = File.join(html_directory, 'index.css')
+    base_css = file_system.load(base_css_filename)
+
+    extra_css_filename = settings['include_css']
+    if extra_css_filename
+      if File.exist?(extra_css_filename)
+        base_css << "\n\n" << file_system.load(extra_css_filename)
+        log("Loaded CSS:  #{extra_css_filename}")
+      else
+        log("Unable to find specified CSS file: #{extra_css_filename}")
+      end
+    end
+
+    base_css
+  end
+end

data/lib/jirametrics/html_report_config.rb

@@ -3,7 +3,7 @@
 require 'erb'
 require 'jirametrics/self_or_issue_dispatcher'
 
-class HtmlReportConfig
+class HtmlReportConfig < HtmlGenerator
   include SelfOrIssueDispatcher
 
   attr_reader :file_config, :sections, :charts
@@ -51,7 +51,10 @@ class HtmlReportConfig
     @file_config.project_config.all_boards.each_value do |board|
       raise 'Multiple cycletimes not supported' if board.cycletime
 
-      board.cycletime = CycleTimeConfig.new(parent_config: self, label: label, block: block, file_system: file_system)
+      board.cycletime = CycleTimeConfig.new(
+        possible_statuses: file_config.project_config, label: label, block: block,
+        file_system: file_system, settings: settings
+      )
     end
   end
 
@@ -70,10 +73,7 @@ class HtmlReportConfig
 
     html create_footer
 
-    html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
-    css = load_css html_directory: html_directory
-    erb = ERB.new file_system.load(File.join(html_directory, 'index.erb'))
-    file_system.save_file content: erb.result(binding), filename: @file_config.output_filename
+    create_html output_filename: @file_config.output_filename, settings: settings
   end
 
   def file_system
@@ -84,24 +84,6 @@ class HtmlReportConfig
     file_system.log message
   end
 
-  def load_css html_directory:
-    base_css_filename = File.join(html_directory, 'index.css')
-    base_css = file_system.load(base_css_filename)
-    log("Loaded CSS:  #{base_css_filename}")
-
-    extra_css_filename = settings['include_css']
-    if extra_css_filename
-      if File.exist?(extra_css_filename)
-        base_css << "\n\n" << file_system.load(extra_css_filename)
-        log("Loaded CSS:  #{extra_css_filename}")
-      else
-        log("Unable to find specified CSS file: #{extra_css_filename}")
-      end
-    end
-
-    base_css
-  end
-
   def board_id id
     @board_id = id
   end
@@ -160,7 +142,7 @@ class HtmlReportConfig
     chart.time_range = project_config.time_range
     chart.timezone_offset = timezone_offset
     chart.settings = settings
-    chart.users = project_config.users
+    chart.atlassian_document_format = project_config.atlassian_document_format
 
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id
@@ -173,6 +155,7 @@ class HtmlReportConfig
     after_init_block&.call chart
 
     @charts << chart
+    chart.before_run
     html chart.run
   end
 

data/lib/jirametrics/issue.rb

@@ -19,9 +19,10 @@ class Issue
 
     # There are cases where we create an Issue of fragments like linked issues and those won't have
     # changelogs.
-    return unless @raw['changelog']
+    load_history_into_changes if @raw['changelog']
 
-    load_history_into_changes
+    # As above with fragments, there may not be a fields section
+    return unless @raw['fields']
 
     # If this is an older pull of data then comments may not be there.
     load_comments_into_changes if @raw['fields']['comment']
@@ -152,7 +153,7 @@ class Issue
   # 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?
+    return nil if change.nil?
 
     change if change.current_status_matches(*status_names)
   end
@@ -162,7 +163,7 @@ class Issue
     category_ids = find_status_category_ids_by_names category_names
 
     change = most_recent_status_change
-    return false if change.nil?
+    return nil if change.nil?
 
     status = find_or_create_status id: change.value_id, name: change.value
     change if status && category_ids.include?(status.category.id)
@@ -211,8 +212,91 @@ class Issue
     first_time_in_status(*board.visible_columns.collect(&:status_ids).flatten)
   end
 
+  # If this issue will ever be in an active sprint then return the time that it
+  # was first added to that sprint, whether or not the sprint was active at that
+  # time. Although it seems like an odd thing to calculate, it's a reasonable proxy
+  # for 'ready' in cases where the team doesn't have an explicit 'ready' status.
+  # You'd be better off with an explicit 'ready' but sometimes that's not an option.
+  def first_time_added_to_active_sprint
+    unless board.scrum?
+      raise 'first_time_added_to_active_sprint() can only be used with Scrum boards: ' \
+          "issue=#{key}, board=#{board.inspect}"
+    end
+    data_clazz = Struct.new(:sprint_id, :sprint_start, :sprint_stop, :change)
+
+    matching_changes = []
+    all_datas = []
+
+    @changes.each do |change|
+      next unless change.sprint?
+
+      added_sprint_ids = change.value_id - change.old_value_id
+      added_sprint_ids.each do |id|
+        data = data_clazz.new
+        data.sprint_id = id
+        data.change = change
+        data.sprint_start, data.sprint_stop = find_sprint_start_end(sprint_id: id, change: change)
+        all_datas << data
+      end
+
+      removed_sprint_ids = change.old_value_id - change.value_id
+      removed_sprint_ids.each do |id|
+        data = all_datas.find { |d| d.sprint_id == id }
+        # It's possible for an issue to be created inside a sprint and therefore for
+        # that add-to-sprint not show in the history.
+        next unless data
+
+        all_datas.delete(data)
+        next if data.sprint_start.nil? || data.sprint_start >= change.time
+
+        matching_changes << data.change
+      end
+    end
+
+    # There can't be any more removes so whatever is left is a valid option
+    # Now all we care about is if the sprint has started.
+    all_datas.each do |data|
+      matching_changes << data.change if data.sprint_start
+    end
+
+    matching_changes.min_by(&:time)
+  end
+
+  def find_sprint_start_end sprint_id:, change:
+    # There are two different places that sprint data could be found. In theory all
+    # sprints would be found in both places. In practice, sometimes what we need is
+    # in one or the other but not both.
+
+    # First look in the actual sprints json. If any issues are in this sprint then it should
+    # be here.
+    sprint = board.sprints.find { |s| s.id == sprint_id }
+    return [sprint.start_time, sprint.completed_time] if sprint
+
+    # Then look at the sprints inside the issue. Even though the field id may be specified,
+    # that custom field may not be present. This happens if it was in that sprint but was
+    # then removed, whether or not that sprint had ever started.
+    sprint_data = raw['fields'][change.field_id]&.find { |sd| sd['id'].to_i == sprint_id }
+    if sprint_data
+      start = parse_time(sprint_data['startDate'])
+      stop = parse_time(sprint_data['completeDate'])
+      return [start, stop]
+    end
+
+    # If we got this far then the sprint can't be found anywhere, so we pretend that it never
+    # started. Is this guaranteed to be true? No. In theory if all issues were removed from
+    # an active sprint then it would also disappear, even though it had started. Nothing we
+    # can do to detect that edge-case though.
+    [nil, nil]
+  end
+
   def parse_time text
-    Time.parse(text).getlocal(@timezone_offset)
+    if text.nil?
+      nil
+    elsif text.is_a? String
+      Time.parse(text).getlocal(@timezone_offset)
+    else
+      Time.at(text / 1000).getlocal(@timezone_offset)
+    end
   end
 
   def created
@@ -220,6 +304,10 @@ class Issue
     parse_time @raw['fields']['created'] if @raw['fields']['created']
   end
 
+  def time_created
+    @changes.first
+  end
+
   def updated
     parse_time @raw['fields']['updated']
   end
@@ -233,11 +321,11 @@ class Issue
   end
 
   def assigned_to
-    @raw['fields']&.[]('assignee')&.[]('displayName')
+    @raw['fields']['assignee']&.[]('displayName')
   end
 
   def assigned_to_icon_url
-    @raw['fields']&.[]('assignee')&.[]('avatarUrls')&.[]('16x16')
+    @raw['fields']['assignee']&.[]('avatarUrls')&.[]('16x16')
   end
 
   # Many test failures are simply unreadable because the default inspect on this class goes
@@ -300,9 +388,7 @@ class Issue
     results
   end
 
-  def blocked_stalled_changes end_time:, settings: nil
-    settings ||= @board.project_config.settings
-
+  def blocked_stalled_statuses settings
     blocked_statuses = settings['blocked_statuses']
     stalled_statuses = settings['stalled_statuses']
     unless blocked_statuses.is_a?(Array) && stalled_statuses.is_a?(Array)
@@ -310,6 +396,14 @@ class Issue
         "stalled_statuses(#{stalled_statuses.inspect}) must both be arrays"
     end
 
+    [blocked_statuses, stalled_statuses]
+  end
+
+  def blocked_stalled_changes end_time:, settings: nil
+    settings ||= @board.project_config.settings
+
+    blocked_statuses, stalled_statuses = blocked_stalled_statuses(settings)
+
     blocked_link_texts = settings['blocked_link_text']
     stalled_threshold = settings['stalled_threshold_days']
     flagged_means_blocked = !!settings['flagged_means_blocked'] # rubocop:disable Style/DoubleNegation
@@ -608,7 +702,7 @@ class Issue
 
   def dump
     result = +''
-    result << "#{key} (#{type}): #{compact_text summary, 200}\n"
+    result << "#{key} (#{type}): #{compact_text summary, max: 200}\n"
 
     assignee = raw['fields']['assignee']
     result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
@@ -681,9 +775,8 @@ class Issue
   def done?
     if artificial? || board.cycletime.nil?
       # This was probably loaded as a linked issue, which means we don't know what board it really
-      # belonged to. The best we can do is look at the status category. This case should be rare but
-      # it can happen.
-      status.category.name == 'Done'
+      # belonged to. The best we can do is look at the status key
+      status.category.done?
     else
       board.cycletime.done? self
     end
@@ -706,6 +799,23 @@ class Issue
     board.sprints.select { |s| sprint_ids.include? s.id }
   end
 
+  def started_sprints
+    sprints.reject { |sprint| sprint.future? }
+  end
+
+  def compact_text text, max: 60
+    return '' if text.nil?
+
+    if text.is_a? Hash
+      # We can't effectively compact it but we can convert it into a string.
+      text = @board.project_config.atlassian_document_format.to_html(text)
+    else
+      text = text.gsub(/\s+/, ' ').strip
+      text = "#{text[0...max]}..." if text.length > max
+    end
+    text
+  end
+
   private
 
   def load_history_into_changes
@@ -730,14 +840,6 @@ class Issue
     end
   end
 
-  def compact_text text, max = 60
-    return nil if text.nil?
-
-    text = text.gsub(/\s+/, ' ').strip
-    text = "#{text[0..max]}..." if text.length > max
-    text
-  end
-
   def sort_changes!
     @changes.sort! do |a, b|
       # It's common that a resolved will happen at the same time as a status change.
@@ -755,6 +857,9 @@ class Issue
     first_status = nil
     first_status_id = nil
 
+    # There won't be a created timestamp in cases where this was a linked issue
+    return unless @raw['fields']['created']
+
     created_time = parse_time @raw['fields']['created']
     first_change = @changes.find { |change| change.field == field_name }
     if first_change.nil?