jirametrics 2.22 → 2.30

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?
@@ -56,7 +63,8 @@ class Exporter
       downloader = Downloader.create(
         download_config: project.download_config,
         file_system: file_system,
-        jira_gateway: gateway
+        jira_gateway: gateway,
+        github_pr_cache: github_pr_cache
       )
       downloader.run
     end
@@ -65,18 +73,23 @@ class Exporter
 
   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 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 #{key.inspect}"

data/lib/jirametrics/file_config.rb

@@ -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,13 +3,14 @@
 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
@@ -59,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

data/lib/jirametrics/flow_efficiency_scatterplot.rb

@@ -32,6 +32,8 @@ class FlowEfficiencyScatterplot < ChartBase
         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 class='foldable'>#{@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

@@ -16,6 +16,8 @@ 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)
@@ -24,6 +26,8 @@ module GroupableIssueChart
         next
       end
 
+      @issue_hints[issue] = rules.issue_hint
+      @issue_periods[issue] = rules.last_day_of_period
       (result[rules] ||= []) << issue
     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

@@ -16,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 %>
         },
@@ -31,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 %>
         },

data/lib/jirametrics/html/aging_work_table.erb

@@ -41,6 +41,9 @@
                 <%= 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>