jirametrics 2.11 → 2.14

data/lib/jirametrics/downloader.rb

@@ -45,6 +45,7 @@ class Downloader
       board = download_board_configuration board_id: id
       download_issues board: board
     end
+    download_users
 
     save_metadata
   end
@@ -96,30 +97,59 @@ class Downloader
     log "  JQL: #{jql}"
     escaped_jql = CGI.escape jql
 
-    max_results = 100
-    start_at = 0
-    total = 1
-    while start_at < total
-      json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
-        "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
-
-      json['issues'].each do |issue_json|
-        issue_json['exporter'] = {
-          'in_initial_query' => initial_query
-        }
-        identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
-        file = "#{issue_json['key']}-#{board.id}.json"
-
-        @file_system.save_json(json: issue_json, filename: File.join(path, file))
-      end
+    if @jira_gateway.cloud?
+      max_results = 5_000 # The maximum allowed by Jira
+      next_page_token = nil
+      issue_count = 0
 
-      total = json['total'].to_i
-      max_results = json['maxResults']
+      loop do
+        json = @jira_gateway.call_url relative_url: '/rest/api/3/search/jql' \
+          "?jql=#{escaped_jql}&maxResults=#{max_results}&" \
+          "nextPageToken=#{next_page_token}&expand=changelog&fields=*all"
+        next_page_token = json['nextPageToken']
 
-      message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
-      log message, both: true
+        json['issues'].each do |issue_json|
+          issue_json['exporter'] = {
+            'in_initial_query' => initial_query
+          }
+          identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
+          file = "#{issue_json['key']}-#{board.id}.json"
 
-      start_at += json['issues'].size
+          @file_system.save_json(json: issue_json, filename: File.join(path, file))
+          issue_count += 1
+        end
+
+        message = "    Downloaded #{issue_count} issues"
+        log message, both: true
+
+        break unless next_page_token
+      end
+    else
+      max_results = 100
+      start_at = 0
+      total = 1
+      while start_at < total
+        json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
+          "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
+
+        json['issues'].each do |issue_json|
+          issue_json['exporter'] = {
+            'in_initial_query' => initial_query
+          }
+          identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
+          file = "#{issue_json['key']}-#{board.id}.json"
+
+          @file_system.save_json(json: issue_json, filename: File.join(path, file))
+        end
+
+        total = json['total'].to_i
+        max_results = json['maxResults']
+
+        message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
+        log message, both: true
+
+        start_at += json['issues'].size
+      end
     end
   end
 
@@ -147,6 +177,16 @@ class Downloader
     )
   end
 
+  def download_users
+    log '  Downloading all users', both: true
+    json = @jira_gateway.call_url relative_url: '/rest/api/2/users'
+
+    @file_system.save_json(
+      json: json,
+      filename: File.join(@target_path, "#{file_prefix}_users.json")
+    )
+  end
+
   def update_status_history_file
     status_filename = File.join(@target_path, "#{file_prefix}_statuses.json")
     return unless file_system.file_exist? status_filename

data/lib/jirametrics/estimate_accuracy_chart.rb

@@ -22,15 +22,18 @@ class EstimateAccuracyChart < ChartBase
       </div>
     HTML
 
-    @y_axis_label = 'Story Point Estimates'
     @y_axis_type = 'linear'
-    @y_axis_block = ->(issue, start_time) { story_points_at(issue: issue, start_time: start_time)&.to_f }
+    @y_axis_block = ->(issue, start_time) { estimate_at(issue: issue, start_time: start_time)&.to_f }
     @y_axis_sort_order = nil
 
     instance_eval(&configuration_block)
   end
 
   def run
+    if @y_axis_label.nil?
+      text = current_board.estimation_configuration.units == :story_points ? 'Story Points' : 'Days'
+      @y_axis_label = "Estimated #{text}"
+    end
     data_sets = scan_issues
 
     return '' if data_sets.empty?
@@ -41,6 +44,7 @@ class EstimateAccuracyChart < ChartBase
   def scan_issues
     completed_hash, aging_hash = split_into_completed_and_aging issues: issues
 
+    estimation_units = current_board.estimation_configuration.units
     @has_aging_data = !aging_hash.empty?
 
     [
@@ -53,9 +57,13 @@ class EstimateAccuracyChart < ChartBase
       # We sort so that the smaller circles are in front of the bigger circles.
       data = hash.sort(&hash_sorter).collect do |key, values|
         estimate, cycle_time = *key
-        estimate_label = "#{estimate}#{'pts' if @y_axis_type == 'linear'}"
-        title = ["Estimate: #{estimate_label}, Cycletime: #{label_days(cycle_time)}, #{values.size} issues"] +
-          values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
+        title = [
+          "Estimate: #{estimate_label(estimate: estimate, estimation_units: estimation_units)}, " \
+            "Cycletime: #{label_days(cycle_time)}, " \
+            "#{values.size} issues"
+        ] + values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
         {
           'x' => cycle_time,
           'y' => estimate,
@@ -77,6 +85,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
+  def estimate_label estimate:, estimation_units:
+    if @y_axis_type == 'linear'
+      if estimation_units == :story_points
+        estimate_label = "#{estimate}pts"
+      elsif estimation_units == :seconds
+        estimate_label = label_days estimate
+      end
+    end
+    estimate_label = estimate.to_s if estimate_label.nil?
+    estimate_label
+  end
+
   def split_into_completed_and_aging issues:
     aging_hash = {}
     completed_hash = {}
@@ -126,14 +146,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
-  def story_points_at issue:, start_time:
-    story_points = nil
+  def estimate_at issue:, start_time:, estimation_configuration: current_board.estimation_configuration
+    estimate = nil
+
     issue.changes.each do |change|
-      return story_points if change.time >= start_time
+      return estimate if change.time >= start_time
 
-      story_points = change.value if change.story_points?
+      if change.field == estimation_configuration.display_name || change.field == estimation_configuration.field_id
+        estimate = change.value
+        estimate = estimate.to_f / (24 * 60 * 60) if estimation_configuration.units == :seconds
+      end
     end
-    story_points
+    estimate
   end
 
   def y_axis label:, sort_order: nil, &block

data/lib/jirametrics/estimation_configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class EstimationConfiguration
+  attr_reader :units, :display_name, :field_id
+
+  def initialize raw:
+    @units = :story_points
+    @display_name = 'Story Points'
+
+    # If there wasn't an estimation section they rely on all defaults
+    return if raw.nil?
+
+    if raw['type'] == 'field'
+      @field_id = raw['field']['fieldId']
+      @display_name = raw['field']['displayName']
+      if @field_id == 'timeoriginalestimate'
+        @units = :seconds
+        @display_name = 'Original estimate'
+      end
+    elsif raw['type'] == 'issueCount'
+      @display_name = 'Issue Count'
+      @units = :issue_count
+    end
+  end
+end

data/lib/jirametrics/examples/standard_project.rb

@@ -58,6 +58,8 @@ class Exporter
                  type: :header
           end
 
+          daily_view
+
           cycletime_scatterplot do
             show_trend_lines
           end

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

data/lib/jirametrics/html/aging_work_table.erb

@@ -4,6 +4,7 @@
       <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>
@@ -29,6 +30,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)' %>

data/lib/jirametrics/html/index.css

@@ -67,6 +67,9 @@
   --sprint-burndown-sprint-color-4: red;
   --sprint-burndown-sprint-color-5: brown;
 
+  --daily-view-selected-issue-background: lightgray;
+  --daily-view-issue-border: green;
+  --daily-view-selected-issue-border: red;
 
 }
 
@@ -142,6 +145,69 @@ ul.quality_report {
   border-top: 1px solid gray;
 }
 
+div.daily_issue:hover {
+  background: var(--daily-view-selected-issue-background);
+  border-color: var(--daily-view-selected-issue-border);
+}
+
+div.daily_issue {
+  border: 1px solid var(--daily-view-issue-border);
+  padding: 0.5em;
+  .heading {
+    vertical-align: middle;
+    display: flex;
+    flex-wrap: wrap;
+    column-gap: 0.5em;
+    align-items: center;
+  }
+  table {
+    margin-left: 1em;
+    td {
+      vertical-align: top;
+    }
+    .time {
+      white-space: nowrap;
+      font-size: 0.8em;
+    }
+  }
+  .icon {
+    width: 1em;
+    height: 1em;
+  }
+  .account_id {
+    font-weight: bold;
+  }
+  .field {
+    border: 1px solid black;
+    color: white;
+    background: black;
+    padding-left: 0.2em;
+    padding-right: 0.2em;
+    border-radius: 0.2em;
+  }
+  .label {
+    border: 1px solid black;
+    padding-left: 0.2em;
+    padding-right: 0.2em;
+    border-radius: 0.2em;
+  }
+  h1 {
+    border: none;
+    background: none;
+    padding-left: 0;
+  }
+  margin-bottom: 0.5em;
+}
+div.child_issue:hover {
+  background: var(--body-background);
+}
+div.child_issue {
+  border: 1px dashed green;
+  margin: 0.2em;
+  margin-left: 1.5em;
+  padding: 0.5em;
+}
+
 @media screen and (prefers-color-scheme: dark) {
   :root {
     --warning-banner: #9F2B00;
@@ -174,6 +240,8 @@ ul.quality_report {
     --wip-chart-duration-two-weeks-or-less-color: #cf9400;
     --wip-chart-duration-four-weeks-or-less-color: #c25e00;
     --wip-chart-duration-more-than-four-weeks-color: #8e0000;
+
+    --daily-view-selected-issue-background: #474747;
   }
 
   h1 {
@@ -206,4 +274,12 @@ ul.quality_report {
   div.color_block {
     border: 1px solid lightgray;
   }
+
+  div.daily_issue {
+    .field {
+      color: var(--default-text-color);
+    }
+  }
+}
+
 }

data/lib/jirametrics/html/index.erb

@@ -18,6 +18,23 @@
           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 => {
@@ -33,8 +50,8 @@
   </head>
   <body>
     <noscript>
-      <div style="padding: 1em; background: gray; color: white; font-size: 2em;">
-        Javascript is currently disabled and that means that almost all of the charts in this report won't render. If you'd loaded this from a folder on SharePoint then save it locally and load it again.
+      <div style="padding: 1em; background: red; color: white; font-size: 2em;">
+        Javascript is currently disabled and that means that almost all of the charts in this report won't render. If you've loaded this from a folder on SharePoint then save it locally and load it again.
       </div>
     </noscript>
     <%= "\n" + @sections.collect { |text, type| text if type == :header }.compact.join("\n\n") %>

data/lib/jirametrics/html_report_config.rb

@@ -33,6 +33,7 @@ class HtmlReportConfig
   define_chart name: 'estimate_accuracy_chart', classname: 'EstimateAccuracyChart'
   define_chart name: 'hierarchy_table', classname: 'HierarchyTable'
   define_chart name: 'flow_efficiency_scatterplot', classname: 'FlowEfficiencyScatterplot'
+  define_chart name: 'daily_view', classname: 'DailyView'
 
   define_chart name: 'daily_wip_by_type', classname: 'DailyWipChart',
     deprecated_warning: 'This is the same as daily_wip_chart. Please use that one', deprecated_date: '2024-05-23'
@@ -159,6 +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.all_boards = project_config.all_boards
     chart.board_id = find_board_id

data/lib/jirametrics/issue.rb

@@ -44,9 +44,11 @@ class Issue
   def key = @raw['key']
 
   def type = @raw['fields']['issuetype']['name']
-
   def type_icon_url = @raw['fields']['issuetype']['iconUrl']
 
+  def priority_name = @raw['fields']['priority']['name']
+  def priority_url = @raw['fields']['priority']['iconUrl']
+
   def summary = @raw['fields']['summary']
 
   def labels = @raw['fields']['labels'] || []
@@ -205,6 +207,10 @@ class Issue
     nil
   end
 
+  def first_time_visible_on_board
+    first_time_in_status(*board.visible_columns.collect(&:status_ids).flatten)
+  end
+
   def parse_time text
     Time.parse(text).getlocal(@timezone_offset)
   end
@@ -230,6 +236,10 @@ class Issue
     @raw['fields']&.[]('assignee')&.[]('displayName')
   end
 
+  def assigned_to_icon_url
+    @raw['fields']&.[]('assignee')&.[]('avatarUrls')&.[]('16x16')
+  end
+
   # Many test failures are simply unreadable because the default inspect on this class goes
   # on for pages. Shorten it up.
   def inspect
@@ -315,7 +325,7 @@ class Issue
 
     # This mock change is to force the writing of one last entry at the end of the time range.
     # By doing this, we're able to eliminate a lot of duplicated code in charts.
-    mock_change = ChangeItem.new time: end_time, author: '', artificial: true, raw: { 'field' => '' }
+    mock_change = ChangeItem.new time: end_time, artificial: true, raw: { 'field' => '' }, author_raw: nil
 
     (changes + [mock_change]).each do |change|
       previous_was_active = false if check_for_stalled(
@@ -335,7 +345,7 @@ class Issue
         end
       elsif change.link?
         # Example: "This issue is satisfied by ANON-30465"
-        unless /^This issue (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
+        unless /^This (?<_>issue|work item) (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
           puts "Issue(#{key}) Can't parse link text: #{change.value || change.old_value}"
           next
         end
@@ -462,8 +472,6 @@ class Issue
   end
 
   def expedited?
-    return false unless @board&.project_config
-
     names = @board.project_config.settings['expedited_priority_names']
     return false unless names
 
@@ -580,7 +588,7 @@ class Issue
     /(?<project_code1>[^-]+)-(?<id1>.+)/ =~ key
     /(?<project_code2>[^-]+)-(?<id2>.+)/ =~ other.key
     comparison = project_code1 <=> project_code2
-    comparison = id1 <=> id2 if comparison.zero?
+    comparison = id1.to_i <=> id2.to_i if comparison.zero?
     comparison
   end
 
@@ -611,9 +619,13 @@ class Issue
     end
     history = [] # time, type, detail
 
-    started_at, stopped_at = board.cycletime.started_stopped_times(self)
-    history << [started_at, nil, '↓↓↓↓ Started here ↓↓↓↓', true] if started_at
-    history << [stopped_at, nil, '↑↑↑↑ Finished here ↑↑↑↑', true] if stopped_at
+    if board.cycletime
+      started_at, stopped_at = board.cycletime.started_stopped_times(self)
+      history << [started_at, nil, '↓↓↓↓ Started here ↓↓↓↓', true] if started_at
+      history << [stopped_at, nil, '↑↑↑↑ Finished here ↑↑↑↑', true] if stopped_at
+    else
+      result << "  Unable to determine start/end times as board #{board.id} has no cycletime specified\n"
+    end
 
     @discarded_change_times&.each do |time|
       history << [time, nil, '↑↑↑↑ Changes discarded ↑↑↑↑', true]
@@ -669,9 +681,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
@@ -681,34 +692,40 @@ class Issue
     @changes.select { |change| change.status? }
   end
 
-  private
+  def sprints
+    sprint_ids = []
 
-  def assemble_author raw
-    raw['author']&.[]('displayName') || raw['author']&.[]('name') || 'Unknown author'
+    changes.each do |change|
+      next unless change.sprint?
+
+      sprint_ids << change.raw['to'].split(/\s*,\s*/).collect { |id| id.to_i }
+    end
+    sprint_ids.flatten!
+
+    board.sprints.select { |s| sprint_ids.include? s.id }
   end
 
+  private
+
   def load_history_into_changes
     @raw['changelog']['histories']&.each do |history|
       created = parse_time(history['created'])
 
-      # It should be impossible to not have an author but we've seen it in production
-      author = assemble_author history
       history['items']&.each do |item|
-        @changes << ChangeItem.new(raw: item, time: created, author: author)
+        @changes << ChangeItem.new(raw: item, time: created, author_raw: history['author'])
       end
     end
   end
 
   def load_comments_into_changes
     @raw['fields']['comment']['comments']&.each do |comment|
-      raw = {
+      raw = comment.merge({
         'field' => 'comment',
         'to' => comment['id'],
         'toString' =>  comment['body']
-      }
-      author = assemble_author comment
+      })
       created = parse_time(comment['created'])
-      @changes << ChangeItem.new(raw: raw, time: created, author: author, artificial: true)
+      @changes << ChangeItem.new(raw: raw, time: created, artificial: true, author_raw: comment['author'])
     end
   end
 
@@ -750,7 +767,9 @@ class Issue
       first_status = first_change.old_value
       first_status_id = first_change.old_value_id
     end
-    ChangeItem.new time: created_time, artificial: true, author: author, raw: {
+
+    creator = raw['fields']['creator']
+    ChangeItem.new time: created_time, artificial: true, author_raw: creator, raw: {
       'field' => field_name,
       'to' => first_status_id,
       'toString' => first_status

data/lib/jirametrics/issue_collection.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class IssueCollection < Array
+  attr_reader :hidden
+
+  def self.[] *issues
+    collection = new
+    issues.each { |i| collection << i }
+    collection
+  end
+
+  def initialize
+    super
+    @hidden = []
+  end
+
+  def reject! &block
+    select(&block).each do |issue|
+      @hidden << issue
+    end
+    super
+  end
+
+  def find_by_key key:, include_hidden: false
+    block = ->(issue) { issue.key == key }
+    issue = find(&block)
+    issue = hidden.find(&block) if issue.nil? && include_hidden
+    issue
+  end
+  def clone
+    raise 'baboom'
+  end
+end

data/lib/jirametrics/jira_gateway.rb

@@ -26,7 +26,10 @@ class JiraGateway
   end
 
   def call_command command
-    @file_system.log "  #{command.gsub(/\s+/, ' ')}"
+    log_entry = "  #{command.gsub(/\s+/, ' ')}"
+    log_entry = log_entry.gsub(@jira_api_token, '[API_TOKEN]') if @jira_api_token
+    @file_system.log log_entry
+
     result = `#{command}`
     @file_system.log result unless $CHILD_STATUS.success?
     return result if $CHILD_STATUS.success?
@@ -74,4 +77,8 @@ class JiraGateway
 
     true
   end
+
+  def cloud?
+    @jira_url.downcase.end_with? '.atlassian.net'
+  end
 end