jirametrics 2.22 → 2.23

data/lib/jirametrics/issue.rb

@@ -3,14 +3,15 @@
 require 'time'
 
 class Issue
-  attr_reader :changes, :raw, :subtasks, :board
-  attr_accessor :parent
+  attr_reader :changes, :raw, :subtasks, :board, :discarded_changes, :discarded_change_times
+  attr_accessor :parent, :github_prs
 
   def initialize raw:, board:, timezone_offset: '+00:00'
     @raw = raw
     @timezone_offset = timezone_offset
     @subtasks = []
     @changes = []
+    @github_prs = []
     @board = board
 
     # We only check for this here because if a board isn't passed in then things will fail much
@@ -270,13 +271,19 @@ class Issue
     # First look in the actual sprints json. If any issues are in this sprint then it should
     # be here.
     sprint = board.sprints.find { |s| s.id == sprint_id }
-    return [sprint.start_time, sprint.completed_time] if sprint
+    if sprint
+      return [nil, nil] if sprint.future?
+
+      return [sprint.start_time, sprint.completed_time]
+    end
 
     # Then look at the sprints inside the issue. Even though the field id may be specified,
     # that custom field may not be present. This happens if it was in that sprint but was
     # then removed, whether or not that sprint had ever started.
     sprint_data = raw['fields'][change.field_id]&.find { |sd| sd['id'].to_i == sprint_id }
     if sprint_data
+      return [nil, nil] if sprint_data['state'] == 'future'
+
       start = parse_time(sprint_data['startDate'])
       stop = parse_time(sprint_data['completeDate'])
       return [start, stop]
@@ -416,6 +423,7 @@ class Issue
 
     blocking_status = nil
     flag = nil
+    flag_reason = nil
 
     # 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.
@@ -430,8 +438,7 @@ class Issue
       )
 
       if change.flagged? && flagged_means_blocked
-        flag = change.value
-        flag = nil if change.value == ''
+        flag, flag_reason = blocked_stalled_changes_flag_logic change
       elsif change.status?
         blocking_status = nil
         if blocked_statuses.include?(change.value) || stalled_statuses.include?(change.value)
@@ -455,6 +462,7 @@ class Issue
 
       new_change = BlockedStalledChange.new(
         flagged: flag,
+        flag_reason: flag_reason,
         status: blocking_status,
         status_is_blocking: blocking_status.nil? || blocked_statuses.include?(blocking_status),
         blocking_issue_keys: (blocking_issue_keys.empty? ? nil : blocking_issue_keys.dup),
@@ -475,6 +483,7 @@ class Issue
       hack = result.pop
       result << BlockedStalledChange.new(
         flagged: hack.flag,
+        flag_reason: hack.flag_reason,
         status: hack.status,
         status_is_blocking: hack.status_is_blocking,
         blocking_issue_keys: hack.blocking_issue_keys,
@@ -486,6 +495,28 @@ class Issue
     result
   end
 
+  def blocked_stalled_changes_flag_logic change
+    flag = change.value
+    flag = nil if change.value == ''
+    if flag
+      # When the user is adding a comment to explain why a flag was set, the flag is set immediately
+      # and the comment is inserted after the user hits enter, which means that there is some time
+      # gap. If a comment happened shortly after the flag was set, we assume they're linked. This
+      # won't always be true and so there will be false positives, but it's a reasonable assumption.
+      max_seconds_between_flag_and_comment = 30
+      comment_change = changes.find do |c|
+        c.comment? && c.time >= change.time && (c.time - change.time) <= max_seconds_between_flag_and_comment
+      end
+      flag_reason = comment_change && @board.project_config.atlassian_document_format.to_text(comment_change.value)
+      # Newer Jira instances may add this extra text but older instances did not. Strip it out if found.
+      flag_reason = flag_reason&.sub(/\A:flag_on: Flag added\s*/m, '')&.strip
+      flag_reason = nil if flag_reason&.empty?
+    else
+      flag_reason = nil
+    end
+    [flag, flag_reason]
+  end
+
   def check_for_stalled change_time:, previous_change_time:, stalled_threshold:, blocking_stalled_changes:
     stalled_threshold_seconds = stalled_threshold * 60 * 60 * 24
 
@@ -701,75 +732,7 @@ class Issue
   end
 
   def dump
-    result = +''
-    result << "#{key} (#{type}): #{compact_text summary, max: 200}\n"
-
-    assignee = raw['fields']['assignee']
-    result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
-
-    raw['fields']['issuelinks']&.each do |link|
-      result << "  [link] #{link['type']['outward']} #{link['outwardIssue']['key']}\n" if link['outwardIssue']
-      result << "  [link] #{link['type']['inward']} #{link['inwardIssue']['key']}\n" if link['inwardIssue']
-    end
-    history = [] # time, type, detail
-
-    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|
-      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 << "#{old_value} -> " unless old_value.nil? || old_value.empty?
-      message << value
-      if change.artificial?
-        message << ' (Artificial entry)' if change.artificial?
-      else
-        message << " (Author: #{change.author})"
-      end
-      history << [change.time, change.field, message, change.artificial?]
-    end
-
-    result << "  History:\n"
-    type_width = history.collect { |_time, type, _detail, _artificial| type&.length || 0 }.max
-    history.sort! do |a, b|
-      if a[0] == b[0]
-        if a[1].nil?
-          1
-        elsif b[1].nil?
-          -1
-        else
-          a[1] <=> b[1]
-        end
-      else
-        a[0] <=> b[0]
-      end
-    end
-    history.each do |time, type, detail, _artificial|
-      if type.nil?
-        type = '-' * type_width
-      else
-        type = (' ' * (type_width - type.length)) << type
-      end
-      result << "    #{time.strftime '%Y-%m-%d %H:%M:%S %z'} [#{type}] #{detail}\n"
-    end
-
-    result
+    IssuePrinter.new(self).to_s
   end
 
   def done?

data/lib/jirametrics/issue_printer.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+class IssuePrinter
+  def initialize issue
+    @issue = issue
+  end
+
+  def to_s
+    issue = @issue
+    result = +''
+    result << "#{issue.key} (#{issue.type}): #{issue.compact_text issue.summary, max: 200}\n"
+
+    assignee = issue.raw['fields']['assignee']
+    result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
+
+    issue.raw['fields']['issuelinks']&.each do |link|
+      result << "  [link] #{link['type']['outward']} #{link['outwardIssue']['key']}\n" if link['outwardIssue']
+      result << "  [link] #{link['type']['inward']} #{link['inwardIssue']['key']}\n" if link['inwardIssue']
+    end
+
+    history = [] # time, type, detail
+
+    if issue.board.cycletime
+      started_at, stopped_at = issue.board.cycletime.started_stopped_times(issue)
+      history << [started_at, nil, 'vvvv Started here vvvv', true] if started_at
+      history << [stopped_at, nil, '^^^^ Finished here ^^^^', true] if stopped_at
+    else
+      result << "  Unable to determine start/end times as board #{issue.board.id} has no cycletime specified\n"
+    end
+
+    issue.discarded_change_times&.each do |time|
+      history << [time, nil, '^^^^ Changes discarded ^^^^', true]
+    end
+
+    (issue.changes + (issue.discarded_changes || [])).each do |change|
+      history << [change.time, change.field, create_change_message(change: change, issue: issue), change.artificial?]
+    end
+
+    result << "  History:\n"
+    type_width = history.collect { |_time, type, _detail, _artificial| type&.length || 0 }.max
+    sort_history!(history)
+    history.each do |time, type, detail, _artificial|
+      type = type.nil? ? '-' * type_width : type.rjust(type_width)
+      result << "    #{time.strftime '%Y-%m-%d %H:%M:%S %z'} [#{type}] #{detail}\n"
+    end
+
+    result
+  end
+
+  def create_change_message change:, issue:
+    value, old_value = format_change_values(change: change, issue: issue)
+
+    message = +''
+    message << "#{old_value} -> " unless old_value.nil? || old_value.empty?
+    message << value
+    if change.artificial?
+      message << ' (Artificial entry)'
+    else
+      message << " (Author: #{change.author})"
+    end
+    message
+  end
+
+  def format_change_values change:, issue:
+    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
+    elsif change.sprint?
+      added = change.value_id - change.old_value_id
+      removed = change.old_value_id - change.value_id
+      value = "#{change.value.inspect} #{change.value_id}"
+      value << " (added: #{added})" unless added.empty?
+      value << " (removed: #{removed})" unless removed.empty?
+      old_value = nil
+    else
+      value = issue.compact_text(change.value).inspect
+      old_value = change.old_value ? issue.compact_text(change.old_value).inspect : nil
+    end
+    [value, old_value]
+  end
+
+  def sort_history! history
+    history.sort! do |a, b|
+      if a[0] == b[0]
+        if a[1].nil?
+          1
+        elsif b[1].nil?
+          -1
+        else
+          a[1] <=> b[1]
+        end
+      else
+        a[0] <=> b[0]
+      end
+    end
+  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, :users
+    :settings, :aggregate_config, :discarded_changes_data, :users, :fix_versions
   attr_accessor :time_range, :jira_url, :id
 
   def initialize exporter:, jira_config:, block:, target_path: '.', name: '', id: nil
@@ -23,6 +23,7 @@ class ProjectConfig
     @settings = load_settings
     @id = id
     @has_loaded_data = false
+    @fix_versions = []
   end
 
   def evaluate_next_level
@@ -40,6 +41,7 @@ class ProjectConfig
     @id = guess_project_id
     load_project_metadata
     load_sprints
+    load_fix_versions
     load_users
   end
 
@@ -47,10 +49,11 @@ class ProjectConfig
     return if @exporter.downloading?
 
     load_data unless aggregated_project?
-    anonymize_data if @anonymizer_needed
 
     return if load_only
 
+    anonymize_data if @anonymizer_needed
+
     @file_configs.each do |file_config|
       file_config.run
     end
@@ -267,9 +270,12 @@ class ProjectConfig
   end
 
   def load_board board_id:, filename:
-    board = Board.new(
-      raw: file_system.load_json(filename), possible_statuses: @possible_statuses
-    )
+    raw = file_system.load_json(filename)
+
+    features_filename = File.join(@target_path, "#{get_file_prefix}_board_#{board_id}_features.json")
+    features_raw = file_system.load_json(features_filename) if file_system.file_exist?(features_filename)
+
+    board = Board.new(raw: raw, possible_statuses: @possible_statuses, features_raw: features_raw)
     board.project_config = self
     @all_boards[board_id] = board
   end
@@ -326,6 +332,13 @@ class ProjectConfig
     end
   end
 
+  def load_fix_versions
+    filename = File.join(@target_path, "#{get_file_prefix}_fix_versions.json")
+    return unless file_system.file_exist?(filename)
+
+    @fix_versions = file_system.load_json(filename).map { |raw| FixVersion.new(raw) }
+  end
+
   def load_project_metadata
     filename = File.join @target_path, "#{get_file_prefix}_meta.json"
     json = file_system.load_json(filename)
@@ -362,6 +375,19 @@ class ProjectConfig
     json.each { |user_data| @users << User.new(raw: user_data) }
   end
 
+  def attach_github_prs
+    filename = File.join(@target_path, "#{get_file_prefix}_github_prs.json")
+    return unless File.exist?(filename)
+
+    prs_by_issue_key = Hash.new { |h, k| h[k] = [] }
+    file_system.load_json(filename).each do |raw|
+      pr = PullRequest.new(raw: raw)
+      pr.issue_keys.each { |key| prs_by_issue_key[key] << pr }
+    end
+
+    @issues.each { |issue| issue.github_prs = prs_by_issue_key[issue.key] }
+  end
+
   def atlassian_document_format
     @atlassian_document_format ||= AtlassianDocumentFormat.new(
       users: @users, timezone_offset: exporter.timezone_offset
@@ -444,6 +470,7 @@ class ProjectConfig
       # attached them in the appropriate places, remove any that aren't part of that initial set.
       issues.reject! { |i| !i.in_initial_query? } # rubocop:disable Style/InverseMethods
       @issues = issues
+      attach_github_prs
     end
 
     @issues

data/lib/jirametrics/pull_request.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'jirametrics/pull_request_review'
+
+class PullRequest
+  attr_reader :raw
+
+  def initialize raw:
+    @raw = raw
+  end
+
+  def number     = @raw['number']
+  def repo       = @raw['repo']
+  def url        = @raw['url']
+  def title      = @raw['title']
+  def branch     = @raw['branch']
+  def state      = @raw['state']
+  def issue_keys = @raw['issue_keys']
+
+  def opened_at = Time.parse(@raw['opened_at'])
+  def closed_at = @raw['closed_at'] ? Time.parse(@raw['closed_at']) : nil
+  def merged_at = @raw['merged_at'] ? Time.parse(@raw['merged_at']) : nil
+
+  def reviews       = (@raw['reviews'] || []).map { |r| PullRequestReview.new(raw: r) }
+  def additions     = @raw['additions']
+  def deletions     = @raw['deletions']
+  def changed_files = @raw['changed_files']
+  def lines_changed = (additions || 0) + (deletions || 0)
+end

data/lib/jirametrics/pull_request_review.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'time'
+
+class PullRequestReview
+  def initialize raw:
+    @raw = raw
+  end
+
+  def author = @raw['author']
+  def state = @raw['state']
+  def submitted_at = Time.parse(@raw['submitted_at'])
+end

data/lib/jirametrics/raw_javascript.rb

@@ -10,4 +10,8 @@ class RawJavascript
   def to_json(*_args)
     @content
   end
+
+  def == other
+    other.is_a?(RawJavascript) && to_json == other.to_json
+  end
 end

data/lib/jirametrics/settings.json

@@ -9,5 +9,7 @@
   "expedited_priority_names": ["Critical", "Highest"],
   "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"],
 
-  "cache_cycletime_calculations": true
+  "cache_cycletime_calculations": true,
+
+  "date_annotations": []
 }

data/lib/jirametrics/sprint_burndown.rb

@@ -29,6 +29,8 @@ class SprintBurndown < ChartBase
       </div>
       #{describe_non_working_days}
     TEXT
+    @x_axis_title = 'Date'
+    @y_axis_title = 'Items remaining'
   end
 
   def options= arg

data/lib/jirametrics/stitcher.rb

@@ -44,7 +44,8 @@ class Stitcher < HtmlGenerator
     stitch_content = @all_stitches.find { |s| s.file == from_file && s.title == title && s.type == type }
     return stitch_content.content if stitch_content
 
-    raise "Unable to find content in file #{from_file.inspect} matching title: #{title.inspect}"
+    file_system.error "Unable to find content in file #{from_file.inspect} matching title: #{title.inspect}"
+    ''
   end
 
   def parse_file filename

data/lib/jirametrics/throughput_chart.rb

@@ -15,6 +15,9 @@ class ThroughputChart < ChartBase
       </div>
       #{describe_non_working_days}
     TEXT
+    @x_axis_title = nil
+    @y_axis_title = 'Count of items'
+
 
     init_configuration_block(block) do
       grouping_rules do |issue, rule|
@@ -92,7 +95,10 @@ class ThroughputChart < ChartBase
       { y: closed_issues.size,
         x: "#{period.end}T23:59:59",
         title: ["#{closed_issues.size} items completed #{date_label}"] +
-          closed_issues.collect { |_stop_date, issue| "#{issue.key} : #{issue.summary}" }
+          closed_issues.collect do |_stop_date, issue|
+            hint = @issue_hints&.fetch(issue, nil)
+            "#{issue.key} : #{issue.summary}#{" #{hint}" if hint}"
+          end
       }
     end
   end

data/lib/jirametrics/time_based_histogram.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'jirametrics/groupable_issue_chart'
+
+class TimeBasedHistogram < ChartBase
+  include GroupableIssueChart
+
+  attr_reader :show_stats
+
+  def initialize
+    super
+
+    percentiles [50, 85, 98]
+    @show_stats = true
+  end
+
+  def percentiles percs = nil
+    @percentiles = percs unless percs.nil?
+    @percentiles
+  end
+
+  def disable_stats
+    @show_stats = false
+  end
+
+  def run
+    histogram_items = all_items
+    rules_to_items = group_issues histogram_items
+
+    the_stats = {}
+
+    overall_histogram = histogram_data_for(items: histogram_items).transform_values(&:size)
+    the_stats[:all] = stats_for histogram_data: overall_histogram, percentiles: @percentiles
+    data_sets = rules_to_items.keys.collect do |rules|
+      the_label = rules.label
+      the_histogram = histogram_data_for(items: rules_to_items[rules])
+      if @show_stats
+        the_stats[the_label] = stats_for(
+          histogram_data: the_histogram.transform_values(&:size), percentiles: @percentiles
+        )
+      end
+
+      data_set_for(
+        histogram_data: the_histogram,
+        label: the_label,
+        color: rules.color
+      )
+    end
+
+    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
+
+  def histogram_data_for items:
+    items_hash = {}
+    items.each do |item|
+      days = value_for_item item
+      (items_hash[days] ||= []) << item if days.positive?
+    end
+    items_hash
+  end
+
+  def stats_for histogram_data:, percentiles:
+    return {} if histogram_data.empty?
+
+    total_values = histogram_data.values.sum
+
+    # Calculate the average
+    weighted_sum = histogram_data.reduce(0) { |sum, (value, frequency)| sum + (value * frequency) }
+    average = total_values.zero? ? 0 : weighted_sum.to_f / total_values
+
+    # Find the mode (or modes!) and the spread of the distribution
+    sorted_histogram = histogram_data.sort_by { |_value, frequency| frequency }
+    max_freq = sorted_histogram[-1][1]
+    mode = sorted_histogram.select { |_v, f| f == max_freq }
+
+    minmax = histogram_data.keys.minmax
+
+    # Calculate percentiles
+    sorted_values = histogram_data.keys.sort
+    cumulative_counts = {}
+    cumulative_sum = 0
+
+    sorted_values.each do |value|
+      cumulative_sum += histogram_data[value]
+      cumulative_counts[value] = cumulative_sum
+    end
+
+    percentile_results = {}
+    percentiles.each do |percentile|
+      rank = (percentile / 100.0) * total_values
+      percentile_value = sorted_values.find { |value| cumulative_counts[value] >= rank }
+      percentile_results[percentile] = percentile_value
+    end
+
+    {
+      average: average,
+      mode: mode.collect(&:first).sort,
+      min: minmax[0],
+      max: minmax[1],
+      percentiles: percentile_results
+    }
+  end
+
+  def sort_items items
+    items
+  end
+
+  def label_for_item item, hint:
+    raise NotImplementedError, "#{self.class} must implement label_for_item"
+  end
+
+  def data_set_for histogram_data:, label:, color:
+    {
+      type: 'bar',
+      label: label,
+      data: histogram_data.keys.sort.filter_map do |days|
+        items = histogram_data[days]
+        next if items.empty?
+
+        {
+          x: days,
+          y: items.size,
+          title: [title_for_item(count: items.size, value: days)] +
+            sort_items(items).collect do |item|
+              hint = @issue_hints&.fetch(item, nil)
+              label_for_item(item, hint: hint)
+            end
+        }
+      end,
+      backgroundColor: color,
+      borderRadius: 0
+    }
+  end
+end