jirametrics 2.14 → 2.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5b1b9e8d837f6d74990d377db007ed5e55670de77738ab38a04c6d023d865c3
-  data.tar.gz: 99e8ef3e85a3dfa2bd6d845a32d974718c0e9884d2f4750891ba491fd884ab0b
+  metadata.gz: c8045db95ffbb1368c3df8be3ee88c88ddb1a3d2fee46c989ba9d94e8fdb4ac3
+  data.tar.gz: a4a245da182c96238ec99918eefaf097c3fcc3cd3f4a09f85d4fbdd25020b713
 SHA512:
-  metadata.gz: 804a25c8a19df9ae9862e2f95539183ece53e3841e590c64b8deb7048601bfb2b42ad5b75c075b85058abb7cea0cc875d517f4208bd5edbf98e2129e5567af59
-  data.tar.gz: '0059cde9746423c5baf3ca1f47243b6489ccf77b8fd409255f7301f638eb1975b8b2815d266f720cd9f1cd51e2cf0bc9e33cbad3e34110ca1dedc4ad7fc9ff5b'
+  metadata.gz: cb301db36a63ec0e2da49c5f7ce1f7c58ee44f9c1ab1dad7811667a72d598a8a36282bccc795bebf755706ea1b0d1f0ebdf092f75fe89dc128203645182b9a30
+  data.tar.gz: e1d08efa142f9d824621831cfc465fd6d17ba3c374f0259d860798feec2706214989c9eac9e41c5eafbd66be0d4c147c29bdec638eec7e956b87858384bf6bb8

data/lib/jirametrics/atlassian_document_format.rb

@@ -157,4 +157,4 @@ class AtlassianDocumentFormat
     text = "@#{user.display_name}" if user
     "<span class='account_id'>#{text}</span>"
   end
-end
+end

data/lib/jirametrics/chart_base.rb

@@ -2,7 +2,8 @@
 
 class ChartBase
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
-    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system, :users
+    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system,
+    :atlassian_document_format
   attr_writer :aggregated_project
   attr_reader :canvas_width, :canvas_height
 
@@ -44,7 +45,7 @@ class ChartBase
 
   def render_top_text caller_binding
     result = +''
-    result << "<h1>#{@header_text}</h1>" if @header_text
+    result << "<h1 class='foldable'>#{@header_text}</h1>" if @header_text
     result << ERB.new(@description_text).result(caller_binding) if @description_text
     result
   end

data/lib/jirametrics/cycletime_histogram.rb

@@ -62,7 +62,9 @@ class CycletimeHistogram < ChartBase
       )
     end
 
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
+    if data_sets.empty?
+      return "<h1 class='foldable'>#{@header_text}</h1><div>No data matched the selected criteria. Nothing to show.</div>"
+    end
 
     wrap_and_render(binding, __FILE__)
   end

data/lib/jirametrics/daily_view.rb

@@ -23,7 +23,7 @@ class DailyView < ChartBase
   def run
     aging_issues = select_aging_issues
 
-    return "<h1>#{@header_text}</h1>There are no items currently in progress" if aging_issues.empty?
+    return "<h1 class='foldable'>#{@header_text}</h1>There are no items currently in progress" if aging_issues.empty?
 
     result = +''
     result << render_top_text(binding)
@@ -33,10 +33,6 @@ class DailyView < ChartBase
     result
   end
 
-  def atlassian_document_format
-    @atlassian_document_format ||= AtlassianDocumentFormat.new(users: users, timezone_offset: timezone_offset)
-  end
-
   def select_aging_issues
     aging_issues = issues.select do |issue|
       started_at, stopped_at = issue.board.cycletime.started_stopped_times(issue)
@@ -170,13 +166,7 @@ class DailyView < ChartBase
 
     return lines if subtasks.empty?
 
-    id = next_id
-    lines <<
-      "<a href=\"javascript:toggle_visibility('open#{id}', 'close#{id}', 'section#{id}');\">" \
-      "<span id='open#{id}' style='display: none'>▶ Child issues</span>" \
-      "<span id='close#{id}'>▼ Child issues</span></a>"
-    lines << "<section id='section#{id}'>"
-
+    lines << '<section><div class="foldable">Child issues</div>'
     lines += subtasks
     lines << '</section>'
 
@@ -187,14 +177,9 @@ class DailyView < ChartBase
     history = issue.changes.reverse
     lines = []
 
-    id = next_id
-    lines << [
-      "<a href=\"javascript:toggle_visibility('open#{id}', 'close#{id}', 'table#{id}');\">" \
-      "<span id='open#{id}'>▶ Issue History</span>" \
-      "<span id='close#{id}' style='display: none'>▼ Issue History</span></a>"
-    ]
+    lines << '<section><div class="foldable startFolded">Issue history</div>'
     table = +''
-    table << "<table id='table#{id}' style='display: none'>"
+    table << '<table>'
     history.each do |c|
       time = c.time.strftime '%b %d, %I:%M%P'
 
@@ -207,6 +192,7 @@ class DailyView < ChartBase
     end
     table << '</table>'
     lines << [table]
+    lines << '</section>'
     lines
   end
 

data/lib/jirametrics/dependency_chart.rb

@@ -51,7 +51,10 @@ class DependencyChart < ChartBase
     instance_eval(&@rules_block) if @rules_block
 
     dot_graph = build_dot_graph
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if dot_graph.nil?
+    if dot_graph.nil?
+      return "<h1 class='foldable'>#{@header_text}</h1>" \
+        '<div>No data matched the selected criteria. Nothing to show.</div>'
+    end
 
     svg = execute_graphviz(dot_graph.join("\n"))
     "<h1>#{@header_text}</h1><div>#{@description_text}</div>#{shrink_svg svg}"

data/lib/jirametrics/expedited_chart.rb

@@ -48,7 +48,7 @@ class ExpeditedChart < ChartBase
     end
 
     if data_sets.empty?
-      '<h1>Expedited work</h1>There is no expedited work in this time period.'
+      '<h1 class="foldable">Expedited work</h1><p>There is no expedited work in this time period.</p>'
     else
       wrap_and_render(binding, __FILE__)
     end

data/lib/jirametrics/flow_efficiency_scatterplot.rb

@@ -60,7 +60,7 @@ class FlowEfficiencyScatterplot < ChartBase
       create_dataset(issues: issues, label: rules.label, color: rules.color)
     end
 
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
+    return "<h1 class='foldable'>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
 
     wrap_and_render(binding, __FILE__)
   end

data/lib/jirametrics/html/collapsible_issues_panel.erb

@@ -1,5 +1,5 @@
-[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
-<table class='standard' id='<%= issues_id %>' style='display: none;'>
+<div class='foldable startFolded'>Show details</div>
+<table class='standard' id='<%= issues_id %>'>
   <thead>
     <tr>
       <th>Issue</th>

data/lib/jirametrics/html/cycletime_histogram.erb

@@ -6,8 +6,8 @@ if show_stats
   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;">
+<div class='foldable' style="padding-left: 1em;">Statistics</div>
+<div id="<%= issues_id %>" style="padding-left: 1em;">
   <div>
      <table class="standard">
       <tr>

data/lib/jirametrics/html/index.css

@@ -78,11 +78,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;
@@ -244,11 +239,6 @@ div.child_issue {
     --daily-view-selected-issue-background: #474747;
   }
 
-  h1 {
-    color: #e0e0e0;
-    background-color: #656565;
-  }
-
   a[href] {
     color: #1e8ad6;
   }

data/lib/jirametrics/html/index.erb

@@ -7,39 +7,7 @@
     <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 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 %>

data/lib/jirametrics/html/index.js

@@ -0,0 +1,90 @@
+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()
+})

data/lib/jirametrics/html/sprint_burndown.erb

@@ -68,8 +68,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
   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 %>">
 <table class='standard' style="margin-left: 1em;">
   <thead>
     <th>Sprint</th>
@@ -109,4 +110,5 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     <% end %>
   </ul>
 </p>
-</div>
+</div>
+</section>

data/lib/jirametrics/html_report_config.rb

@@ -72,6 +72,7 @@ class HtmlReportConfig
 
     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: @file_config.output_filename
   end
@@ -87,7 +88,6 @@ class HtmlReportConfig
   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
@@ -160,7 +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.atlassian_document_format = project_config.atlassian_document_format
 
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id

data/lib/jirametrics/issue.rb

@@ -608,7 +608,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?
@@ -705,6 +705,19 @@ class Issue
     board.sprints.select { |s| sprint_ids.include? s.id }
   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
@@ -729,14 +742,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.

data/lib/jirametrics/jira_gateway.rb

@@ -17,7 +17,9 @@ class JiraGateway
     begin
       json = JSON.parse(result)
     rescue # rubocop:disable Style/RescueStandardError
-      raise "Error when parsing result: #{result.inspect}"
+      message = "Unable to parse results from #{sanitize_message(command)}"
+      @file_system.error message, more: result
+      raise message
     end
 
     raise "Download failed with: #{JSON.pretty_generate(json)}" unless json_successful?(json)
@@ -25,9 +27,16 @@ class JiraGateway
     json
   end
 
+  def sanitize_message message
+    token = @jira_api_token || @jira_personal_access_token
+    raise 'Neither Jira API Token or personal access token has been set' unless token
+
+    message.gsub(@jira_api_token, '[API_TOKEN]')
+  end
+
   def call_command command
     log_entry = "  #{command.gsub(/\s+/, ' ')}"
-    log_entry = log_entry.gsub(@jira_api_token, '[API_TOKEN]') if @jira_api_token
+    log_entry = sanitize_message log_entry if @jira_api_token
     @file_system.log log_entry
 
     result = `#{command}`

data/lib/jirametrics/project_config.rb

@@ -352,6 +352,12 @@ class ProjectConfig
     json.each { |user_data| @users << User.new(raw: user_data) }
   end
 
+  def atlassian_document_format
+    @atlassian_document_format ||= AtlassianDocumentFormat.new(
+      users: @users, timezone_offset: exporter.timezone_offset
+    )
+  end
+
   def to_time string, end_of_day: false
     time = end_of_day ? '23:59:59' : '00:00:00'
     string = "#{string}T#{time}#{exporter.timezone_offset}" if string.match?(/^\d{4}-\d{2}-\d{2}$/)

data/lib/jirametrics.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'require_all'
+
+# This one does need to be loaded early. The rest will be loaded later.
+require './lib/jirametrics/file_system'
 
 class JiraMetrics < Thor
   def self.exit_on_failure?
@@ -48,76 +52,21 @@ class JiraMetrics < Thor
     Exporter.instance.info(keys, name_filter: options[:name] || '*')
   end
 
-  private
+  no_commands do
+    def load_config config_file, file_system: FileSystem.new
+      config_file = './config.rb' if config_file.nil?
 
-  def load_config config_file
-    config_file = './config.rb' if config_file.nil?
+      if File.exist? config_file
+        # The fact that File.exist can see the file does not mean that require will be
+        # able to load it. Convert this to an absolute pathname now for require.
+        config_file = File.absolute_path(config_file).to_s
+      else
+        file_system.error "Cannot find configuration file #{config_file.inspect}"
+        exit 1
+      end
 
-    if File.exist? config_file
-      # The fact that File.exist can see the file does not mean that require will be
-      # able to load it. Convert this to an absolute pathname now for require.
-      config_file = File.absolute_path(config_file).to_s
-    else
-      puts "Cannot find configuration file #{config_file.inspect}"
-      exit 1
+      require_rel 'jirametrics'
+      load config_file
     end
-
-    require 'jirametrics/value_equality'
-    require 'jirametrics/chart_base'
-    require 'jirametrics/rules'
-    require 'jirametrics/grouping_rules'
-    require 'jirametrics/daily_wip_chart'
-    require 'jirametrics/groupable_issue_chart'
-    require 'jirametrics/css_variable'
-    require 'jirametrics/issue_collection'
-
-    require 'jirametrics/aggregate_config'
-    require 'jirametrics/expedited_chart'
-    require 'jirametrics/board_config'
-    require 'jirametrics/file_config'
-    require 'jirametrics/jira_gateway'
-    require 'jirametrics/trend_line_calculator'
-    require 'jirametrics/status'
-    require 'jirametrics/issue_link'
-    require 'jirametrics/estimate_accuracy_chart'
-    require 'jirametrics/status_collection'
-    require 'jirametrics/sprint'
-    require 'jirametrics/issue'
-    require 'jirametrics/daily_wip_by_age_chart'
-    require 'jirametrics/daily_wip_by_parent_chart'
-    require 'jirametrics/aging_work_in_progress_chart'
-    require 'jirametrics/cycletime_scatterplot'
-    require 'jirametrics/flow_efficiency_scatterplot'
-    require 'jirametrics/sprint_issue_change_data'
-    require 'jirametrics/cycletime_histogram'
-    require 'jirametrics/daily_wip_by_blocked_stalled_chart'
-    require 'jirametrics/html_report_config'
-    require 'jirametrics/data_quality_report'
-    require 'jirametrics/aging_work_bar_chart'
-    require 'jirametrics/change_item'
-    require 'jirametrics/project_config'
-    require 'jirametrics/dependency_chart'
-    require 'jirametrics/cycletime_config'
-    require 'jirametrics/tree_organizer'
-    require 'jirametrics/aging_work_table'
-    require 'jirametrics/sprint_burndown'
-    require 'jirametrics/self_or_issue_dispatcher'
-    require 'jirametrics/throughput_chart'
-    require 'jirametrics/exporter'
-    require 'jirametrics/file_system'
-    require 'jirametrics/blocked_stalled_change'
-    require 'jirametrics/board_column'
-    require 'jirametrics/anonymizer'
-    require 'jirametrics/downloader'
-    require 'jirametrics/fix_version'
-    require 'jirametrics/download_config'
-    require 'jirametrics/columns_config'
-    require 'jirametrics/hierarchy_table'
-    require 'jirametrics/estimation_configuration'
-    require 'jirametrics/board'
-    require 'jirametrics/daily_view'
-    require 'jirametrics/user'
-    require 'jirametrics/atlassian_document_format'
-    load config_file
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.14'
+  version: '2.15'
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-08-18 00:00:00.000000000 Z
+date: 2025-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -113,6 +113,7 @@ files:
 - lib/jirametrics/html/hierarchy_table.erb
 - lib/jirametrics/html/index.css
 - lib/jirametrics/html/index.erb
+- lib/jirametrics/html/index.js
 - lib/jirametrics/html/sprint_burndown.erb
 - lib/jirametrics/html/throughput_chart.erb
 - lib/jirametrics/html_report_config.rb