jirametrics 2.22 → 2.23

data/lib/jirametrics/examples/standard_project.rb

@@ -6,8 +6,8 @@ class Exporter
   def standard_project name:, file_prefix:, ignore_issues: nil, starting_status: nil, boards: {},
       default_board: nil, anonymize: false, settings: {}, status_category_mappings: {},
       rolling_date_count: 90, no_earlier_than: nil, ignore_types: %w[Sub-task Subtask Epic],
-      show_experimental_charts: false
-
+      show_experimental_charts: false, github_repos: nil
+    exporter = self
     project name: name do
       puts name
       file_prefix file_prefix
@@ -35,19 +35,20 @@ class Exporter
       download do
         self.rolling_date_count(rolling_date_count) if rolling_date_count
         self.no_earlier_than(no_earlier_than) if no_earlier_than
+        github_repo github_repos if github_repos
       end
 
       issues.reject! do |issue|
         ignore_types.include? issue.type
       end
 
+      exporter.filter_issues issues, ignore_issues
+
       discard_changes_before status_becomes: (starting_status || :backlog) # rubocop:disable Style/RedundantParentheses
 
       file do
         file_suffix '.html'
 
-        issues.reject! { |issue| ignore_issues.include? issue.key } if ignore_issues
-
         html_report do
           board_id default_board if default_board
 
@@ -87,7 +88,6 @@ class Exporter
           daily_wip_by_blocked_stalled_chart
           daily_wip_by_parent_chart
           flow_efficiency_scatterplot if show_experimental_charts
-          expedited_chart
           sprint_burndown
           estimate_accuracy_chart
           dependency_chart
@@ -95,4 +95,14 @@ class Exporter
       end
     end
   end
+
+  # Extracted as a separate method so it can be tested independently, without needing to invoke
+  # the full standard_project DSL setup.
+  def filter_issues issues, ignore_issues
+    return unless ignore_issues
+
+    issues.reject! do |issue|
+      ignore_issues.is_a?(Proc) ? ignore_issues.call(issue) : ignore_issues.include?(issue.key)
+    end
+  end
 end

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

data/lib/jirametrics/exporter.rb

@@ -40,6 +40,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 +57,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

data/lib/jirametrics/file_system.rb

@@ -61,6 +61,10 @@ class FileSystem
     logfile.puts more if more
     return unless 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
 

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|

data/lib/jirametrics/github_gateway.rb

@@ -0,0 +1,99 @@
+# 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']
+    ]
+
+    sources.compact
+           .flat_map { |s| s.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 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+\\b")
+  end
+
+  def run_command args
+    stdout, stderr, status = Open3.capture3('gh', *args)
+    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,7 @@ module GroupableIssueChart
   def group_issues completed_issues
     result = {}
     ignored_issues = []
+    @issue_hints = {}
     completed_issues.each do |issue|
       rules = GroupingRules.new
       @group_by_block.call(issue, rules)
@@ -24,6 +25,7 @@ module GroupableIssueChart
         next
       end
 
+      @issue_hints[issue] = rules.issue_hint
       (result[rules] ||= []) << issue
     end
 

data/lib/jirametrics/grouping_rules.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class GroupingRules < Rules
-  attr_accessor :label
+  attr_accessor :label, :issue_hint
   attr_reader :color
 
   def eql? other

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/daily_wip_chart.erb

@@ -21,7 +21,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
         time: {
           unit: 'day'
         },
+        min: "<%= date_range.begin.to_s %>",
+        max: "<%= (date_range.end + 1).to_s %>",
         stacked: true,
+        <%= render_axis_title :x %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -32,10 +35,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
           display: true,
           labelString: 'WIP'
         },
-        title: {
-          display: true,
-          text: 'Count of items'
-        },
+        <%= render_axis_title :y %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -52,6 +52,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
       annotation: {
         annotations: {
           <%= working_days_annotation %>
+          <%= date_annotation %>
         }
       },
       legend: {

data/lib/jirametrics/html/estimate_accuracy_chart.erb

@@ -9,10 +9,6 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     datasets: <%= JSON.generate(data_sets) %>
   },
   options: {
-    title: {
-      display: true,
-      text: "Sprint Burndown"
-    },
     responsive: <%= canvas_responsive? %>, // If responsive is true then it fills the screen
     scales: {
       x: {
@@ -21,10 +17,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           labelString: 'Date'
         },
-        title: {
-          display: true,
-          text: "Cycletime (days)"
-        },
+        <%= render_axis_title :x %>
         min: 0,
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
@@ -39,10 +32,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           labelString: 'Items remaining'
         },
-        title: {
-          display: true,
-          text: "<%= @y_axis_label %>"
-        },
+        <%= render_axis_title :y %>
         min: 0.0,
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>

data/lib/jirametrics/html/expedited_chart.erb

@@ -20,25 +20,15 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
     scales: {
       x: {
         type: "time",
-        scaleLabel: {
-          display: true,
-          labelString: 'Date Completed'
-        },
+        <%= render_axis_title :x %>
         min: "<%= date_range.begin.to_s %>",
-        max: "<%= date_range.end.to_s %>",
+        max: "<%= (date_range.end + 1).to_s %>",
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
       },
       y: {
-        scaleLabel: {
-          display: true,
-          labelString: 'Days'
-        },
-        title: {
-          display: true,
-          text: 'Age in days'
-        },        
+        <%= render_axis_title :y %>
         min: 0,
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>

data/lib/jirametrics/html/flow_efficiency_scatterplot.erb

@@ -20,10 +20,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           labelString: 'Days'
         },
-        title: {
-          display: true,
-          text: 'Total time (days)'
-        },
+        <%= render_axis_title :x %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -36,10 +33,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           min: 0,
           max: <%= @highest_cycletime %>
         },
-        title: {
-          display: true,
-          text: 'Time adding value (days)'
-        },
+        <%= render_axis_title :y %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },

data/lib/jirametrics/html/sprint_burndown.erb

@@ -22,10 +22,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
         time: {
             format: 'YYYY-MM-DD'
         },
-        scaleLabel: {
-          display: true,
-          labelString: 'Date'
-        },
+        <%= render_axis_title :x %>
         min: "<%= date_range.begin.to_s %>",
         max: "<%= (date_range.end + 1).to_s %>",
         grid: {
@@ -33,14 +30,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
         },
       },
       y: {
-        scaleLabel: {
-          display: true,
-          labelString: 'Items remaining'
-        },
-        title: {
-          display: true,
-          text: "<%= y_axis_title %>"
-        },
+        <%= render_axis_title :y %>
         min: 0.0,
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
@@ -77,7 +67,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
 <table class='standard' style="margin-left: 1em;">
   <thead>
     <th>Sprint</th>
-    <th>Length</th>
+    <th>Started</th>
+    <th>Completed</th>
+    <th>Days</th>
     <th>State</th>
     <th>Started</th>
     <th>Completed</th>
@@ -90,6 +82,8 @@ 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.start_time.to_date %></td>
+        <td><%= sprint.completed_time&.to_date %></td>
         <td><%= sprint.day_count %></td>
         <td><%= sprint.raw['state'] %></td>
         <% stats = @summary_stats[sprint] %>

data/lib/jirametrics/html/throughput_chart.erb

@@ -20,10 +20,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
         time: {
             format: 'YYYY-MM-DD'
         },
-        scaleLabel: {
-          display: true,
-          labelString: 'Date Completed'
-        },
+        min: "<%= date_range.begin.to_s %>",
+        max: "<%= (date_range.end + 1).to_s %>",
+        <%= render_axis_title :x %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -32,10 +31,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
         scaleLabel: {
           display: true,
         },
-        title: {
-          display: true,
-          text: 'Count of items'
-        },
+        <%= render_axis_title :y %>
         min: 0,
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
@@ -53,6 +49,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
       annotation: {
         annotations: {
           <%= working_days_annotation %>
+          <%= date_annotation %>
         }
       }
     }

data/lib/jirametrics/html/{cycletime_histogram.erb → time_based_histogram.erb}

@@ -2,57 +2,6 @@
 <div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
-<%
-if show_stats 
-  link_id = next_id
-  issues_id = next_id
-%>
-<div class='foldable' style="padding-left: 1em;">Statistics</div>
-<div id="<%= issues_id %>" style="padding-left: 1em;">
-  <div>
-     <table class="standard">
-      <tr>
-        <th>Issue Type</th>
-        <th>Min</th>
-        <th>Max</th>
-        <th>Avg</th>
-        <th>Mode</th>
-        <% percentiles.each do |p| %>
-           <th><%= p %>th</th>
-        <% end %>
-      </tr>
-      <% the_stats.each do |k, v| %>
-          <tr>
-            <td><%= k %></td>
-            <td style="text-align: right;"><%= v[:min] %></td>
-            <td style="text-align: right;"><%= v[:max] %></td>
-            <td style="text-align: right;"><%= sprintf('%.2f', v[:average]) %></td>
-            <td><%= v[:mode].join(', ') %></td>
-            <% percentiles.each do |p| %>
-               <td style="text-align: right;"><%= v[:percentiles][p] %></td>
-            <% end %>
-          </tr>
-       <% end %>
-     </table>
-  </div>
-  <div>
-    <p>These statistics help understand the <i>"shape"</i> of the cycletime histogram distribution, to help us with predictions.</p>
-    <ul>
-      <li><b>Min & Max:</b> the observed spread for the data set. Useful to judge how wide the variation is. </li>
-      <li><b>Average:</b> the arithmetic mean of the data set. Useful as a <i>"typical representative"</i> of the complete set.</li>
-      <li><b>Mode:</b> the most repeated value(s) in the data set. This is the value we're most likely to remember. </li>
-      <li><b>Percentiles:</b> they partition the data set. If X is the Nth percentile, it means that N% of cycletime values are X or less. Typical percentiles of interest are:</li>
-      <ul>
-        <li><b>50%</b>: also known as the <b>Median</b>. Useful to establish short feedback loops, to monitor that it's not drifting to the right.</li>
-        <li><b>85%</b>: useful to establish service level expectations, accounting for rare events..</li>
-        <li><b>98% (or higher)</b>: useful to gauge worst case expectations..</li>
-      </ul>
-    </ul>
-  </div>
-</div>
-<%
-end
-%>
 <script>
 new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
 {
@@ -66,22 +15,17 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
       x: {
         type: 'linear',
         stacked: true,
-        title: {
-          display: true,
-          text: 'Cycletime in days'
-        },
+        <%= render_axis_title :x %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
         min: 0,
+        <%= @max_x_value.nil? ? '' : "max: #{@max_x_value}," %>
         offset: false, // Gets rid of the ugly padding on left.
       },
       y: {
         stacked: true,
-        title: {
-          display: true,
-          text: 'Number of items that had that cycletime'
-        },
+        <%= render_axis_title :y %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -121,3 +65,57 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
 });
 </script>
 <%= seam_end %>
+
+<%= seam_start 'stats_table' %>
+<%
+if show_stats
+  link_id = next_id
+  issues_id = next_id
+%>
+<div class='foldable' style="padding-left: 1em;">Statistics</div>
+<div id="<%= issues_id %>" style="padding-left: 1em;">
+  <div>
+     <table class="standard">
+      <tr>
+        <th>Type</th>
+        <th>Min</th>
+        <th>Max</th>
+        <th>Avg</th>
+        <th>Mode</th>
+        <% percentiles.each do |p| %>
+           <th><%= p %>th</th>
+        <% end %>
+      </tr>
+      <% the_stats.each do |k, v| %>
+          <tr>
+            <td><%= k %></td>
+            <td style="text-align: right;"><%= v[:min] %></td>
+            <td style="text-align: right;"><%= v[:max] %></td>
+            <td style="text-align: right;"><%= sprintf('%.2f', v[:average]) %></td>
+            <td><%= v[:mode].join(', ') %></td>
+            <% percentiles.each do |p| %>
+               <td style="text-align: right;"><%= v[:percentiles][p] %></td>
+            <% end %>
+          </tr>
+       <% end %>
+     </table>
+  </div>
+  <div>
+    <p>These statistics help understand the <i>"shape"</i> of the histogram distribution, to help us with predictions.</p>
+    <ul>
+      <li><b>Min & Max:</b> the observed spread for the data set. Useful to judge how wide the variation is. </li>
+      <li><b>Average:</b> the arithmetic mean of the data set. Useful as a <i>"typical representative"</i> of the complete set.</li>
+      <li><b>Mode:</b> the most repeated value(s) in the data set. This is the value we're most likely to remember. </li>
+      <li><b>Percentiles:</b> they partition the data set. If X is the Nth percentile, it means that N% of values are X or less. Typical percentiles of interest are:</li>
+      <ul>
+        <li><b>50%</b>: also known as the <b>Median</b>. Useful to establish short feedback loops, to monitor that it's not drifting to the right.</li>
+        <li><b>85%</b>: useful to establish service level expectations, accounting for rare events..</li>
+        <li><b>98% (or higher)</b>: useful to gauge worst case expectations..</li>
+      </ul>
+    </ul>
+  </div>
+</div>
+<%
+end
+%>
+<%= seam_end 'stats_table' %>

data/lib/jirametrics/html/{cycletime_scatterplot.erb → time_based_scatterplot.erb}

@@ -23,6 +23,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
+        <%= render_axis_title :x %>
         min: "<%= date_range.begin.to_s %>",
         max: "<%= (date_range.end + 1).to_s %>"
       },
@@ -32,10 +33,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           min: 0,
           max: <%= @highest_y_value %>
         },
-        title: {
-          display: true,
-          text: '<%= y_axis_heading %>'
-        },
+        <%= render_axis_title :y %>
         grid: {
           color: <%= CssVariable['--grid-line-color'].to_json %>
         },
@@ -53,6 +51,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
       annotation: {
         annotations: {
           <%= working_days_annotation %>
+          <%= date_annotation %>
 
           <% @percentage_lines.each_with_index do |args, index| %>
           <%   percent, color = args %>

data/lib/jirametrics/html_report_config.rb

@@ -147,6 +147,7 @@ class HtmlReportConfig < HtmlGenerator
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id
     chart.holiday_dates = project_config.exporter.holiday_dates
+    chart.fix_versions = project_config.fix_versions
 
     time_range = @file_config.project_config.time_range
     chart.date_range = time_range.begin.to_date..time_range.end.to_date