jirametrics 2.9 → 2.12.1

data/lib/jirametrics/html/sprint_burndown.erb

@@ -56,16 +56,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
       },
       annotation: {
         annotations: {
-          <% holidays().each_with_index do |range, index| %>
-          holiday<%= index %>: {
-            drawTime: 'beforeDraw',
-            type: 'box',
-            xMin: '<%= range.begin %>T00:00:00',
-            xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
-            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
-          },
-          <% end %>
+          <%= working_days_annotation %>
         }
       }
     }

data/lib/jirametrics/html/throughput_chart.erb

@@ -52,16 +52,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
       },
       annotation: {
         annotations: {
-          <% holidays.each_with_index do |range, index| %>
-          holiday<%= index %>: {
-            drawTime: 'beforeDraw',
-            type: 'box',
-            xMin: '<%= range.begin %>T00:00:00',
-            xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
-            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
-          },
-          <% end %>
+          <%= working_days_annotation %>
         }
       }
     }

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,12 +44,12 @@ class Issue
   def key = @raw['key']
 
   def type = @raw['fields']['issuetype']['name']
-
   def type_icon_url = @raw['fields']['issuetype']['iconUrl']
 
-  def summary = @raw['fields']['summary']
+  def priority_name = @raw['fields']['priority']['name']
+  def priority_url = @raw['fields']['priority']['iconUrl']
 
-  def status = Status.from_raw(@raw['fields']['status'])
+  def summary = @raw['fields']['summary']
 
   def labels = @raw['fields']['labels'] || []
 
@@ -57,6 +57,20 @@ class Issue
 
   def resolution = @raw['fields']['resolution']&.[]('name')
 
+  def status
+    @status = Status.from_raw(@raw['fields']['status']) unless @status
+    @status
+  end
+
+  def status= status
+    @status = status
+  end
+
+  def due_date
+    text = @raw['fields']['duedate']
+    text.nil? ? nil : Date.parse(text)
+  end
+
   def url
     # Strangely, the URL isn't anywhere in the returned data so we have to fabricate it.
     "#{@board.server_url_prefix}/browse/#{key}"
@@ -129,13 +143,16 @@ class Issue
   end
 
   def most_recent_status_change
-    # We artificially insert a status change to represent creation so by definition there will always be at least one.
-    changes.reverse.find { |change| change.status? }
+    # Any issue that we loaded from its own file will always have a status as we artificially insert a status
+    # change to represent creation. Issues that were just fragments referenced from a main issue (ie a linked issue)
+    # may not have any status changes as we have no idea when it was created. This will be nil in that case
+    status_changes.last
   end
 
   # Are we currently in this status? If yes, then return the most recent status change.
   def currently_in_status *status_names
     change = most_recent_status_change
+    return false if change.nil?
 
     change if change.current_status_matches(*status_names)
   end
@@ -145,6 +162,7 @@ class Issue
     category_ids = find_status_category_ids_by_names category_names
 
     change = most_recent_status_change
+    return false if change.nil?
 
     status = find_or_create_status id: change.value_id, name: change.value
     change if status && category_ids.include?(status.category.id)
@@ -189,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
@@ -214,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
@@ -299,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(
@@ -446,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
 
@@ -564,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
 
@@ -595,21 +619,30 @@ 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]
     end
 
     (changes + (@discarded_changes || [])).each do |change|
-      value = change.value
-      old_value = change.old_value
+      if change.status?
+        value = "#{change.value.inspect}:#{change.value_id.inspect}"
+        old_value = change.old_value ? "#{change.old_value.inspect}:#{change.old_value_id.inspect}" : nil
+      else
+        value = compact_text(change.value).inspect
+        old_value = change.old_value ? compact_text(change.old_value).inspect : nil
+      end
 
       message = +''
-      message << "#{compact_text(old_value).inspect} -> " unless old_value.nil? || old_value.empty?
-      message << compact_text(value).inspect
+      message << "#{old_value} -> " unless old_value.nil? || old_value.empty?
+      message << value
       if change.artificial?
         message << ' (Artificial entry)' if change.artificial?
       else
@@ -660,34 +693,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
 
@@ -729,7 +768,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

@@ -14,13 +14,22 @@ class JiraGateway
   def call_url relative_url:
     command = make_curl_command url: "#{@jira_url}#{relative_url}"
     result = call_command command
-    JSON.parse result
-  rescue => e # rubocop:disable Style/RescueStandardError
-    raise "Error #{e.message.inspect} when parsing result: #{result.inspect}"
+    begin
+      json = JSON.parse(result)
+    rescue # rubocop:disable Style/RescueStandardError
+      raise "Error when parsing result: #{result.inspect}"
+    end
+
+    raise "Download failed with: #{JSON.pretty_generate(json)}" unless json_successful?(json)
+
+    json
   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?
@@ -61,4 +70,11 @@ class JiraGateway
     command << " --url \"#{url}\""
     command
   end
+
+  def json_successful? json
+    return false if json.is_a?(Hash) && (json['error'] || json['errorMessages'] || json['errorMessage'])
+    return false if json.is_a?(Array) && json.first == 'errorMessage'
+
+    true
+  end
 end

data/lib/jirametrics/project_config.rb

@@ -6,7 +6,7 @@ require 'jirametrics/status_collection'
 class ProjectConfig
   attr_reader :target_path, :jira_config, :all_boards, :possible_statuses,
     :download_config, :file_configs, :exporter, :data_version, :name, :board_configs,
-    :settings, :aggregate_config, :discarded_changes_data
+    :settings, :aggregate_config, :discarded_changes_data, :users
   attr_accessor :time_range, :jira_url, :id
 
   def initialize exporter:, jira_config:, block:, target_path: '.', name: '', id: nil
@@ -40,6 +40,7 @@ class ProjectConfig
     @id = guess_project_id
     load_project_metadata
     load_sprints
+    load_users
   end
 
   def run load_only: false
@@ -106,7 +107,7 @@ class ProjectConfig
 
   def board id:, &block
     config = BoardConfig.new(id: id, block: block, project_config: self)
-    config.run
+    config.run if data_downloaded?
     @board_configs << config
   end
 
@@ -151,6 +152,8 @@ class ProjectConfig
   end
 
   def status_category_mapping status:, category:
+    return if @exporter.downloading?
+
     status, status_id = possible_statuses.parse_name_id status
     category, category_id = possible_statuses.parse_name_id category
 
@@ -323,6 +326,15 @@ class ProjectConfig
     raise
   end
 
+  def load_users
+    @users = []
+    filename = File.join @target_path, "#{get_file_prefix}_users.json"
+    return unless File.exist? filename
+
+    json = file_system.load_json(filename)
+    json.each { |user_data| @users << User.new(raw: user_data) }
+  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}$/)
@@ -356,7 +368,7 @@ class ProjectConfig
 
   # To be used by the aggregate_config only. Not intended to be part of the public API
   def add_issues issues_list
-    @issues = [] if @issues.nil?
+    @issues = IssueCollection.new if @issues.nil?
     @all_boards = {}
 
     issues_list.each do |issue|
@@ -373,7 +385,7 @@ class ProjectConfig
           'declaration but none are here. Check your config.'
       end
 
-      return @issues = [] if @exporter.downloading?
+      return @issues = IssueCollection.new if @exporter.downloading?
       raise 'No data found. Must do a download before an export' unless data_downloaded?
 
       load_data if all_boards.empty?
@@ -385,7 +397,7 @@ class ProjectConfig
         issues = load_issues_from_issues_directory path: issues_path, timezone_offset: timezone_offset
       else
         file_system.log "Can't find directory #{issues_path}. Has a download been done?", also_write_to_stderr: true
-        return []
+        return IssueCollection.new
       end
 
       # Attach related issues
@@ -397,7 +409,8 @@ class ProjectConfig
 
       # We'll have some issues that are in the list that weren't part of the initial query. Once we've
       # attached them in the appropriate places, remove any that aren't part of that initial set.
-      @issues = issues.select { |i| i.in_initial_query? }
+      issues.reject! { |i| !i.in_initial_query? } # rubocop:disable Style/InverseMethods
+      @issues = issues
     end
 
     @issues
@@ -438,7 +451,7 @@ class ProjectConfig
   end
 
   def load_issues_from_issues_directory path:, timezone_offset:
-    issues = []
+    issues = IssueCollection.new
     default_board = nil
 
     group_filenames_and_board_ids(path: path).each do |filename, board_ids|
@@ -450,6 +463,10 @@ class ProjectConfig
       end
 
       boards.each do |board|
+        if board.cycletime.nil?
+          raise "The board declaration for board #{board.id} must come before the " \
+            "first usage of 'issues' in the configuration"
+        end
         issues << Issue.new(raw: content, timezone_offset: timezone_offset, board: board)
       end
     end
@@ -462,7 +479,7 @@ class ProjectConfig
   # board ids appropriately.
   def group_filenames_and_board_ids path:
     hash = {}
-    Dir.foreach(path) do |filename|
+    file_system.foreach(path) do |filename|
       # Matches either FAKE-123.json or FAKE-123-456.json
       if /^(?<key>[^-]+-\d+)(?<_>-(?<board_id>\d+))?\.json$/ =~ filename
         (hash[key] ||= []) << [filename, board_id&.to_i || :unknown]

data/lib/jirametrics/settings.json

@@ -6,5 +6,6 @@
   "blocked_statuses": [],
   "flagged_means_blocked": true,
 
-  "expedited_priority_names": ["Critical", "Highest"]
+  "expedited_priority_names": ["Critical", "Highest"],
+  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"]
 }

data/lib/jirametrics/sprint.rb

@@ -12,6 +12,7 @@ class Sprint
 
   def id = @raw['id']
   def active? = (@raw['state'] == 'active')
+  def closed? = (@raw['state'] == 'closed')
 
   def completed_at? time
     completed_at = completed_time

data/lib/jirametrics/sprint_burndown.rb

@@ -121,11 +121,13 @@ class SprintBurndown < ChartBase
 
   # select all the changes that are relevant for the sprint. If this issue never appears in this sprint then return [].
   def changes_for_one_issue issue:, sprint:
-    story_points = 0.0
+    estimate = 0.0
     ever_in_sprint = false
     currently_in_sprint = false
     change_data = []
 
+    estimate_display_name = current_board.estimation_configuration.display_name
+
     issue_completed_time = issue.board.cycletime.started_stopped_times(issue).last
     completed_has_been_tracked = false
 
@@ -140,26 +142,26 @@ class SprintBurndown < ChartBase
         if currently_in_sprint == false && in_change_item
           action = :enter_sprint
           ever_in_sprint = true
-          value = story_points
+          value = estimate
         elsif currently_in_sprint && in_change_item == false
           action = :leave_sprint
-          value = -story_points
+          value = -estimate
         end
         currently_in_sprint = in_change_item
-      elsif change.story_points? && (issue_completed_time.nil? || change.time < issue_completed_time)
+      elsif change.field == estimate_display_name && (issue_completed_time.nil? || change.time < issue_completed_time)
         action = :story_points
-        story_points = change.value.to_f
-        value = story_points - change.old_value.to_f
+        estimate = change.value.to_f
+        value = estimate - change.old_value.to_f
       elsif completed_has_been_tracked == false && change.time == issue_completed_time
         completed_has_been_tracked = true
         action = :issue_stopped
-        value = -story_points
+        value = -estimate
       end
 
       next unless action
 
       change_data << SprintIssueChangeData.new(
-        time: change.time, issue: issue, action: action, value: value, story_points: story_points
+        time: change.time, issue: issue, action: action, value: value, estimate: estimate
       )
     end
 
@@ -176,7 +178,7 @@ class SprintBurndown < ChartBase
     summary_stats = SprintSummaryStats.new
     summary_stats.completed = 0.0
 
-    story_points = 0.0
+    estimate = 0.0
     start_data_written = false
     data_set = []
 
@@ -185,11 +187,11 @@ class SprintBurndown < ChartBase
     change_data_for_sprint.each do |change_data|
       if start_data_written == false && change_data.time >= sprint.start_time
         data_set << {
-          y: story_points,
+          y: estimate,
           x: chart_format(sprint.start_time),
-          title: "Sprint started with #{story_points} points"
+          title: "Sprint started with #{estimate} points"
         }
-        summary_stats.started = story_points
+        summary_stats.started = estimate
         start_data_written = true
       end
 
@@ -198,12 +200,12 @@ class SprintBurndown < ChartBase
       case change_data.action
       when :enter_sprint
         issues_currently_in_sprint << change_data.issue.key
-        story_points += change_data.story_points
+        estimate += change_data.estimate
       when :leave_sprint
         issues_currently_in_sprint.delete change_data.issue.key
-        story_points -= change_data.story_points
+        estimate -= change_data.estimate
       when :story_points
-        story_points += change_data.value if issues_currently_in_sprint.include? change_data.issue.key
+        estimate += change_data.value if issues_currently_in_sprint.include? change_data.issue.key
       end
 
       next unless change_data.time >= sprint.start_time
@@ -213,26 +215,26 @@ class SprintBurndown < ChartBase
       when :story_points
         next unless issues_currently_in_sprint.include? change_data.issue.key
 
-        old_story_points = change_data.story_points - change_data.value
-        message = "Story points changed from #{old_story_points} points to #{change_data.story_points} points"
+        old_estimate = change_data.estimate - change_data.value
+        message = "Story points changed from #{old_estimate} points to #{change_data.estimate} points"
         summary_stats.points_values_changed = true
       when :enter_sprint
-        message = "Added to sprint with #{change_data.story_points || 'no'} points"
-        summary_stats.added += change_data.story_points
+        message = "Added to sprint with #{change_data.estimate || 'no'} points"
+        summary_stats.added += change_data.estimate
       when :issue_stopped
-        story_points -= change_data.story_points
-        message = "Completed with #{change_data.story_points || 'no'} points"
+        estimate -= change_data.estimate
+        message = "Completed with #{change_data.estimate || 'no'} points"
         issues_currently_in_sprint.delete change_data.issue.key
-        summary_stats.completed += change_data.story_points
+        summary_stats.completed += change_data.estimate
       when :leave_sprint
-        message = "Removed from sprint with #{change_data.story_points || 'no'} points"
-        summary_stats.removed += change_data.story_points
+        message = "Removed from sprint with #{change_data.estimate || 'no'} points"
+        summary_stats.removed += change_data.estimate
       else
         raise "Unexpected action: #{change_data.action}"
       end
 
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(change_data.time),
         title: "#{change_data.issue.key} #{message}"
       }
@@ -241,27 +243,27 @@ class SprintBurndown < ChartBase
     unless start_data_written
       # There was nothing that triggered us to write the sprint started block so do it now.
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(sprint.start_time),
-        title: "Sprint started with #{story_points} points"
+        title: "Sprint started with #{estimate} points"
       }
-      summary_stats.started = story_points
+      summary_stats.started = estimate
     end
 
     if sprint.completed_time
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(sprint.completed_time),
-        title: "Sprint ended with #{story_points} points unfinished"
+        title: "Sprint ended with #{estimate} points unfinished"
       }
-      summary_stats.remaining = story_points
+      summary_stats.remaining = estimate
     end
 
     unless sprint.completed_at?(time_range.end)
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(time_range.end),
-        title: "Sprint still active. #{story_points} points still in progress."
+        title: "Sprint still active. #{estimate} points still in progress."
       }
     end
 

data/lib/jirametrics/sprint_issue_change_data.rb

@@ -4,14 +4,14 @@ require 'jirametrics/value_equality'
 
 class SprintIssueChangeData
   include ValueEquality
-  attr_reader :time, :action, :value, :issue, :story_points
+  attr_reader :time, :action, :value, :issue, :estimate
 
-  def initialize time:, action:, value:, issue:, story_points:
+  def initialize time:, action:, value:, issue:, estimate:
     @time = time
     @action = action
     @value = value
     @issue = issue
-    @story_points = story_points
+    @estimate = estimate
   end
 
   def inspect

data/lib/jirametrics/status.rb

@@ -36,13 +36,10 @@ class Status
   end
 
   def self.from_raw raw
-    category_config = raw['statusCategory']
+    raise "raw cannot be nil" if raw.nil?
 
-    legal_keys = %w[new indeterminate done]
-    unless legal_keys.include? category_config['key']
-      puts "Category key #{category_config['key'].inspect} should be one of #{legal_keys.inspect}. Found:\n" \
-        "#{category_config}"
-    end
+    category_config = raw['statusCategory']
+    raise "statusCategory can't be nil in #{category_config.inspect}" if category_config.nil?
 
     Status.new(
       name: raw['name'],