jirametrics 2.10 → 2.30

data/lib/jirametrics/expedited_chart.rb

@@ -38,6 +38,8 @@ class ExpeditedChart < ChartBase
       </div>
       #{describe_non_working_days}
     HTML
+    @x_axis_title = 'Date'
+    @y_axis_title = 'Age in days'
 
     instance_eval(&block)
   end
@@ -48,7 +50,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><div>There is no expedited work in this time period.</div>'
     else
       wrap_and_render(binding, __FILE__)
     end

data/lib/jirametrics/exporter.rb

@@ -8,7 +8,13 @@ class Exporter
 
   def self.configure &block
     logfile_name = 'jirametrics.log'
-    logfile = File.open logfile_name, 'w'
+    logfile = File.open(logfile_name, 'w')
+  rescue Errno::EACCES
+    # FileSystem can't be used here — it hasn't been created yet (it depends on this logfile).
+    warn "Error: Cannot write to #{File.expand_path(logfile_name)}. " \
+      'Please ensure the current directory is writable.'
+    exit 1
+  else
     file_system = FileSystem.new
     file_system.logfile = logfile
     file_system.logfile_name = logfile_name
@@ -40,6 +46,7 @@ class Exporter
 
   def download name_filter:
     @downloading = true
+    github_pr_cache = {}
     each_project_config(name_filter: name_filter) do |project|
       project.evaluate_next_level
       next if project.aggregated_project?
@@ -50,41 +57,54 @@ class Exporter
       end
 
       project.download_config.run
-      downloader = Downloader.new(
+      gateway = JiraGateway.new(
+        file_system: file_system, jira_config: project.jira_config, settings: project.settings
+      )
+      downloader = Downloader.create(
         download_config: project.download_config,
         file_system: file_system,
-        jira_gateway: JiraGateway.new(file_system: file_system)
+        jira_gateway: gateway,
+        github_pr_cache: github_pr_cache
       )
       downloader.run
     end
     puts "Full output from downloader in #{file_system.logfile_name}"
   end
 
-  def info keys, name_filter:
+  def info key, name_filter:
     selected = []
+    file_system.log_only = true
     each_project_config(name_filter: name_filter) do |project|
       project.evaluate_next_level
 
       project.run load_only: true
       project.issues.each do |issue|
-        selected << [project, issue] if keys.include? issue.key
+        selected << [project, issue] if key == issue.key
+        issue.subtasks.each do |subtask|
+          selected << [project, subtask] if key == subtask.key
+        end
       end
     rescue => e # rubocop:disable Style/RescueStandardError
       # This happens when we're attempting to load an aggregated project because it hasn't been
       # properly initialized. Since we don't care about aggregated projects, we just ignore it.
       raise unless e.message.start_with? 'This is an aggregated project and issues should have been included'
     end
+    file_system.log_only = false
 
     if selected.empty?
-      file_system.log "No issues found to match #{keys.collect(&:inspect).join(', ')}"
+      file_system.log "No issues found to match #{key.inspect}"
     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
 
+  def stitch stitch_file
+    Stitcher.new(file_system: file_system).run(stitch_file: stitch_file)
+  end
+
   def each_project_config name_filter:
     @project_configs.each do |project|
       yield project if project.name.nil? || File.fnmatch(name_filter, project.name)

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
@@ -65,22 +65,20 @@ class FileConfig
   # most common usecase - the Team Dashboard from FocusedObjective.com. The rule for that one
   # is that all empty values in the first column should be at the bottom.
   def sort_output all_lines
-    all_lines.sort do |a, b|
-      result = nil
-      if a[0] == b[0]
-        result = a[1..] <=> b[1..]
+    all_lines.each_with_index.sort do |(a, a_idx), (b, b_idx)|
+      result = if a[0] == b[0]
+        a[1..] <=> b[1..]
       elsif a[0].nil?
-        result = 1
+        1
       elsif b[0].nil?
-        result = -1
+        -1
       else
-        result = a[0] <=> b[0]
+        a[0] <=> b[0]
       end
 
-      # This will only happen if one of the objects isn't comparable. Seen in production.
-      result = -1 if result.nil?
-      result
-    end
+      # When objects aren't comparable, preserve original order for a stable sort.
+      result.nil? || result.zero? ? a_idx <=> b_idx : result
+    end.map(&:first)
   end
 
   def columns &block

data/lib/jirametrics/file_system.rb

@@ -3,7 +3,15 @@
 require 'json'
 
 class FileSystem
-  attr_accessor :logfile, :logfile_name
+  attr_accessor :logfile, :logfile_name, :log_only
+
+  def initialize
+    # In almost all cases, this will be immediately replaced in the Exporter
+    # but if we fail before we get that far, this will at least let a useful
+    # error show up on the console.
+    @logfile = $stdout
+    @log_only = false
+  end
 
   # Effectively the same as File.read except it forces the encoding to UTF-8
   def load filename, supress_deprecation: false
@@ -31,6 +39,14 @@ class FileSystem
     File.write(filename, content)
   end
 
+  def mkdir path
+    FileUtils.mkdir_p path
+  end
+
+  def utime file:, time:
+    File.utime time, time, file
+  end
+
   def warning message, more: nil
     log "Warning: #{message}", more: more, also_write_to_stderr: true
   end
@@ -44,11 +60,43 @@ class FileSystem
 
     logfile.puts message
     logfile.puts more if more
-    return unless also_write_to_stderr
+    return if log_only || !also_write_to_stderr
+
+    # Obscure edge-case where we're trying to log something before logging is even
+    # set up. Quick escape here so that we don't dump the error twice.
+    return if logfile == $stdout
 
     $stderr.puts message # rubocop:disable Style/StderrPuts
   end
 
+  def log_start message
+    logfile.puts message
+    return if log_only || logfile == $stdout
+
+    $stderr.print message
+    $stderr.flush
+  end
+
+  def start_progress
+    return if log_only
+
+    $stderr.print '  '
+    $stderr.flush
+  end
+
+  def progress_dot
+    return if log_only
+
+    $stderr.print '.'
+    $stderr.flush
+  end
+
+  def end_progress
+    return if log_only
+
+    $stderr.puts '' # rubocop:disable Style/StderrPuts
+  end
+
   # In some Jira instances, a sizeable portion of the JSON is made up of empty fields. I've seen
   # cases where this simple compression will drop the filesize by half.
   def compress node
@@ -66,7 +114,15 @@ class FileSystem
   end
 
   def file_exist? filename
-    File.exist? filename
+    File.exist?(filename) && File.file?(filename)
+  end
+
+  def dir_exist? path
+    File.exist?(path) && File.directory?(path)
+  end
+
+  def unlink filename
+    File.unlink filename
   end
 
   def deprecated message:, date:, depth: 2

data/lib/jirametrics/fix_version.rb

@@ -11,11 +11,24 @@ class FixVersion
     @raw['name']
   end
 
+  def description
+    @raw['description']
+  end
+
   def id
     @raw['id'].to_i
   end
 
+  def release_date
+    text = @raw['releaseDate']
+    text.nil? ? nil : Date.parse(text)
+  end
+
   def released?
     @raw['released']
   end
+
+  def archived?
+    @raw['archived']
+  end
 end

data/lib/jirametrics/flow_efficiency_scatterplot.rb

@@ -27,11 +27,13 @@ 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>
     HTML
+    @x_axis_title = 'Total time (days)'
+    @y_axis_title = 'Time adding value (days)'
 
     init_configuration_block block do
       grouping_rules do |issue, rule|
@@ -60,7 +62,9 @@ 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?
+    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/github_gateway.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'json'
+
+class GithubGateway
+  attr_reader :repo
+
+  def initialize repo:, project_keys:, file_system:, raw_pr_cache: {}
+    @repo = repo
+    @project_keys = project_keys
+    @file_system = file_system
+    @raw_pr_cache = raw_pr_cache
+    @issue_key_pattern = build_issue_key_pattern
+  end
+
+  def fetch_pull_requests since: nil
+    raw_prs = @raw_pr_cache[[@repo, since]] ||= fetch_raw_pull_requests(since: since)
+    raw_prs.filter_map { |pr| build_pr_data(pr) }
+  end
+
+  def fetch_raw_pull_requests since: nil
+    # Note: 'commits' is intentionally excluded — including it triggers GitHub's GraphQL node
+    # limit (authors sub-connection × PRs × commits exceeds 500,000 nodes). Branch name,
+    # title, and body are sufficient for issue key extraction in the vast majority of cases.
+    json_fields = %w[number title body headRefName createdAt closedAt mergedAt
+                     url state reviews additions deletions changedFiles].join(',')
+    args = ['pr', 'list', '--state', 'all', '--limit', '5000', '--json', json_fields]
+    args += ['--repo', @repo]
+    args += ['--search', "updated:>=#{since}"] if since
+
+    @file_system.log "  Downloading pull requests from #{@repo}", also_write_to_stderr: true
+    run_command(args)
+  end
+
+  def build_pr_data raw_pr
+    issue_keys = extract_issue_keys(raw_pr)
+    return nil if issue_keys.empty?
+
+    PullRequest.new(raw: {
+      'number'     => raw_pr['number'],
+      'repo'       => @repo,
+      'url'        => raw_pr['url'],
+      'title'      => raw_pr['title'],
+      'branch'     => raw_pr['headRefName'],
+      'opened_at'  => raw_pr['createdAt'],
+      'closed_at'  => raw_pr['closedAt'],
+      'merged_at'  => raw_pr['mergedAt'],
+      'state'      => raw_pr['state'],
+      'issue_keys'    => issue_keys,
+      'reviews'       => extract_reviews(raw_pr['reviews'] || []),
+      'additions'     => raw_pr['additions'],
+      'deletions'     => raw_pr['deletions'],
+      'changed_files' => raw_pr['changedFiles']
+    })
+  end
+
+  def extract_issue_keys raw_pr
+    return [] if @issue_key_pattern.nil?
+
+    sources = [
+      raw_pr['headRefName'],
+      raw_pr['title'],
+      raw_pr['body']
+    ]
+
+    keys = sources.compact.flat_map { |s| s.scan(@issue_key_pattern) }.uniq
+    return keys unless keys.empty?
+
+    commit_messages_for(raw_pr['number']).flat_map { |msg| msg.scan(@issue_key_pattern) }.uniq
+  end
+
+  def extract_reviews raw_reviews
+    raw_reviews
+      .select { |r| %w[APPROVED CHANGES_REQUESTED].include?(r['state']) }
+      .map do |r|
+        {
+          'author'       => r.dig('author', 'login'),
+          'submitted_at' => r['submittedAt'],
+          'state'        => r['state']
+        }
+      end
+  end
+
+  private
+
+  def commit_messages_for pr_number
+    args = ['pr', 'view', pr_number.to_s, '--json', 'commits', '--repo', @repo]
+    result = run_command(args)
+    (result['commits'] || []).flat_map do |commit|
+      [commit['messageHeadline'], commit['messageBody']].compact
+    end
+  end
+
+  def build_issue_key_pattern
+    return nil if @project_keys.empty?
+
+    keys_pattern = @project_keys.map { |k| Regexp.escape(k) }.join('|')
+    Regexp.new("\\b(?:#{keys_pattern})-\\d+(?![A-Za-z0-9])")
+  end
+
+  def run_command args
+    stdout, stderr, status = Open3.capture3('gh', *args)
+
+    # This extra check seems to only matter on Windows. On the mac, auth failures don't pass status.success?
+    if stderr.include?('SAML enforcement')
+      raise "GitHub CLI is not authorized to access #{@repo}. " \
+            'Run: gh auth refresh -h github.com -s read:org'
+    end
+
+    raise "GitHub CLI command failed for #{@repo}: #{stderr}" unless status.success?
+
+    JSON.parse(stdout)
+  end
+end

data/lib/jirametrics/groupable_issue_chart.rb

@@ -15,14 +15,24 @@ module GroupableIssueChart
 
   def group_issues completed_issues
     result = {}
+    ignored_issues = []
+    @issue_hints = {}
+    @issue_periods = {}
     completed_issues.each do |issue|
       rules = GroupingRules.new
       @group_by_block.call(issue, rules)
-      next if rules.ignored?
+      if rules.ignored?
+        ignored_issues << issue
+        next
+      end
 
+      @issue_hints[issue] = rules.issue_hint
+      @issue_periods[issue] = rules.last_day_of_period
       (result[rules] ||= []) << issue
     end
 
+    completed_issues.reject! { |issue| ignored_issues.include? issue }
+
     result.each_key do |rules|
       rules.color = random_color if rules.color.nil?
     end

data/lib/jirametrics/grouping_rules.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 class GroupingRules < Rules
-  attr_accessor :label
-  attr_reader :color
+  attr_accessor :label, :issue_hint, :label_hint
+  attr_reader :color, :last_day_of_period
+
+  def last_day_of_period= value
+    @last_day_of_period = value.is_a?(String) ? Date.parse(value) : value
+  end
 
   def eql? other
     other.label == @label && other.color == @color
@@ -13,7 +17,25 @@ class GroupingRules < Rules
   end
 
   def color= color
-    color = CssVariable[color] unless color.is_a?(CssVariable)
-    @color = color
+    if color.is_a?(Array)
+      raise ArgumentError, 'Color pair must have exactly two elements: [light_color, dark_color]' unless color.size == 2
+      raise ArgumentError, 'Color pair elements must be strings' unless color.all?(String)
+
+      if color.any? { |c| c.start_with?('--') }
+        raise ArgumentError,
+          'CSS variable references are not supported as color pair elements; use a literal color value instead'
+      end
+
+      light, dark = color
+      @color = RawJavascript.new(
+        "(document.documentElement.dataset.theme === 'dark' || " \
+        '(!document.documentElement.dataset.theme && ' \
+        "window.matchMedia('(prefers-color-scheme: dark)').matches)) " \
+        "? #{dark.to_json} : #{light.to_json}"
+      )
+    else
+      color = CssVariable[color] unless color.is_a?(CssVariable)
+      @color = color
+    end
   end
 end

data/lib/jirametrics/html/aging_work_bar_chart.erb

@@ -1,3 +1,4 @@
+<%= seam_start %>
 <div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
@@ -15,11 +16,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
       x: {
         type: 'time',
         min: '<%= @date_range.begin.to_s %>',
-        max: '<%= (@date_range.end ).to_s %>',
+        max: '<%= (@date_range.end + 1).to_s %>',
         stacked: false,
-        title: {
-          display: false
-        },
+        <%= render_axis_title :x %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -30,6 +29,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
         ticks: {
           display: true
         },
+        <%= render_axis_title :y %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -66,4 +66,4 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
   }
 });
 </script>
-
+<%= seam_end %>

data/lib/jirametrics/html/aging_work_in_progress_chart.erb

@@ -1,3 +1,4 @@
+<%= seam_start %>
 <div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
@@ -6,7 +7,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 +23,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 +38,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: false,
+        max: <%= (@max_age * 1.1).to_i %>
       }
     },
     plugins: {
@@ -44,15 +50,28 @@ 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('%');
+          }
+        }
       }
+
     }
   }
 });
 </script>
+<%= seam_end %>

data/lib/jirametrics/html/aging_work_table.erb

@@ -1,11 +1,14 @@
+<%= seam_start %>
 <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 +31,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)' %>
@@ -37,10 +41,14 @@
                 <%= link_to_issue parent, style: "color: #{color}" %>
               </span>
               <i><%= parent.summary.strip.inspect %></i>
+              <% if parent == issue && (text = not_visible_text(issue)) %>
+                <br /><%= text %>
+              <% end %>
             </div>
           <% 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>
@@ -50,3 +58,4 @@
     <% end %>
   </tbody>
 </table>
+<%= seam_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>