jirametrics 2.14 → 2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5b1b9e8d837f6d74990d377db007ed5e55670de77738ab38a04c6d023d865c3
-  data.tar.gz: 99e8ef3e85a3dfa2bd6d845a32d974718c0e9884d2f4750891ba491fd884ab0b
+  metadata.gz: 40a0ee85ee8d7d0d2ff071357afdea2aefdfeea8734f96eb789721d4a9f2607b
+  data.tar.gz: 11008f97848d8e3034cf95c5f615496c5677d8057f40b06d2724247d6087318d
 SHA512:
-  metadata.gz: 804a25c8a19df9ae9862e2f95539183ece53e3841e590c64b8deb7048601bfb2b42ad5b75c075b85058abb7cea0cc875d517f4208bd5edbf98e2129e5567af59
-  data.tar.gz: '0059cde9746423c5baf3ca1f47243b6489ccf77b8fd409255f7301f638eb1975b8b2815d266f720cd9f1cd51e2cf0bc9e33cbad3e34110ca1dedc4ad7fc9ff5b'
+  metadata.gz: 1e5ad6c1d5dddf5a89cc63498f1967f35c4761b6418c90019c8c6756599efb5b8badaf0ac4d50f94be4644508a97641430f178b3d40217cb02560aa017f33b80
+  data.tar.gz: a6a7f74dadbb8a2f7961a02e396a39dd994ff1a11756f57a5eadfd60af5c71bd79c3df65b7bfd77ca998059018f60cd6306b2006512b7cf5f760d75e2d0dfdf4

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 require 'jirametrics/chart_base'
+require 'jirametrics/bar_chart_range'
 
 class AgingWorkBarChart < ChartBase
   def initialize block
     super()
 
+    @age_cutoff = nil
     header_text 'Aging Work Bar Chart'
     description_text <<-HTML
       <p>
@@ -13,16 +15,16 @@ class AgingWorkBarChart < ChartBase
         newest at the bottom.
       </p>
       <p>
-        There are potentially three bars for each issue, although a bar may be missing if the issue has no
-        information relevant to that. Hovering over any of the bars will provide more details.
+        There are three bars for each issue, and hovering over any of the bars will provide more details.
         <ol>
-          <li>The top bar tells you what status the issue is in at any time. The colour indicates the
+          <li>Status: The status the issue was in at any time. The colour indicates the
           status category, which will be one of #{color_block '--status-category-todo-color'} To Do,
           #{color_block '--status-category-inprogress-color'} In Progress,
           or #{color_block '--status-category-done-color'} Done</li>
-          <li>The middle bar indicates #{color_block '--blocked-color'} blocked
+          <li>Activity: This bar indicates #{color_block '--blocked-color'} blocked
           or #{color_block '--stalled-color'} stalled.</li>
-          <li>The bottom bar indicated #{color_block '--expedited-color'} expedited.</li>
+          <li>Priority: This shows the priority over time. If one of these priorities is considered expedited
+          then it will be drawn with diagonal lines.</li>
         </ol>
       </p>
       #{describe_non_working_days}
@@ -36,6 +38,7 @@ class AgingWorkBarChart < ChartBase
 
   def run
     aging_issues = select_aging_issues issues: @issues
+    adjust_time_date_ranges_to_start_from_earliest_issue_start(aging_issues)
 
     today = date_range.end
     sort_by_age! issues: aging_issues, today: today
@@ -58,134 +61,125 @@ class AgingWorkBarChart < ChartBase
     wrap_and_render(binding, __FILE__)
   end
 
+  def adjust_time_date_ranges_to_start_from_earliest_issue_start aging_issues
+    earliest_start_time = aging_issues.collect do |issue|
+      issue.board.cycletime.started_stopped_times(issue).first
+    end.min
+    return if earliest_start_time.nil? || earliest_start_time >= @time_range.begin
+
+    @time_range = earliest_start_time..@time_range.end
+    @date_range = @time_range.begin.to_date..@time_range.end.to_date
+  end
+
   def data_sets_for_one_issue issue:, today:
     cycletime = issue.board.cycletime
-    issue_start_time, _stopped_time = cycletime.started_stopped_times(issue)
-    issue_start_date = issue_start_time.to_date
-    issue_label = "[#{label_days cycletime.age(issue, today: today)}] #{issue.key}: #{issue.summary}"[0..60]
-    [
-      status_data_sets(issue: issue, label: issue_label, today: today),
-      blocked_data_sets(
-        issue: issue,
-        issue_label: issue_label,
-        stack: 'blocked',
-        issue_start_time: issue_start_time
-      ),
-      data_set_by_block(
-        issue: issue,
-        issue_label: issue_label,
-        title_label: 'Expedited',
-        stack: 'expedited',
-        color: CssVariable['--expedited-color'],
-        start_date: issue_start_date
-      ) { |day| issue.expedited_on_date?(day) }
+    issue_start_time = cycletime.started_stopped_times(issue).first
+    end_of_today = Time.parse("#{today}T23:59:59#{@timezone_offset}")
+
+    bar_data = [
+      ['status', collect_status_ranges(issue: issue, now: end_of_today)],
+      ['blocked', collect_blocked_stalled_ranges(issue: issue, issue_start_time: issue_start_time)],
+      ['priority', collect_priority_ranges(issue: issue)]
     ]
+    bar_data << ['sprints', collect_sprint_ranges(issue: issue)] if current_board.scrum?
+
+    issue_label = "[#{label_days cycletime.age(issue, today: today)}] #{issue.key}: #{issue.summary}"[0..60]
+    bar_data.collect do |stack, ranges|
+      bar_chart_range_to_data_set y_value: issue_label, ranges: ranges, stack: stack, issue_start_time: issue_start_time
+    end
   end
 
   def sort_by_age! issues:, today:
     issues.sort! do |a, b|
-      a.board.cycletime.age(b, today: today) <=> b.board.cycletime.age(a, today: today)
+      b.board.cycletime.age(b, today: today) <=> a.board.cycletime.age(a, today: today)
     end
   end
 
   def select_aging_issues issues:
     issues.select do |issue|
       started_time, stopped_time = issue.board.cycletime.started_stopped_times(issue)
-      started_time && stopped_time.nil?
+      next false unless started_time && stopped_time.nil?
+
+      age = (date_range.end - started_time.to_date).to_i + 1
+      !(@age_cutoff && @age_cutoff >= age)
     end
   end
 
   def grow_chart_height_if_too_many_issues aging_issue_count:
-    px_per_bar = 8
+    px_per_bar = 10
     bars_per_issue = 3
+    bars_per_issue += 1 if current_board.scrum?
+
     preferred_height = aging_issue_count * px_per_bar * bars_per_issue
     @canvas_height = preferred_height if @canvas_height.nil? || @canvas_height < preferred_height
   end
 
-  def status_data_sets issue:, label:, today:
-    cycletime = issue.board.cycletime
-
-    issue_started_time, _issue_stopped_time = cycletime.started_stopped_times(issue)
-
+  def collect_status_ranges issue:, now:
+    ranges = []
+    issue_started_time = issue.board.cycletime.started_stopped_times(issue).first
     previous_start = nil
     previous_status = nil
-
-    data_sets = []
-    issue.changes.each do |change|
-      next unless change.status?
-
-      status = issue.find_or_create_status id: change.value_id, name: change.value
-
-      unless previous_start.nil? || previous_start < issue_started_time
-        hash = {
-          type: 'bar',
-          data: [{
-            x: [chart_format(previous_start), chart_format(change.time)],
-            y: label,
-            title: "#{issue.type} : #{change.value}"
-          }],
-          backgroundColor: status_category_color(status),
-          borderColor: CssVariable['--aging-work-bar-chart-separator-color'],
-          borderWidth: {
-             top: 0,
-             right: 1,
-             bottom: 0,
-             left: 0
-          },
-          stacked: true,
-          stack: 'status'
-        }
-        data_sets << hash if date_range.include?(change.time.to_date)
+    issue.status_changes.each do |change|
+      new_status = issue.find_or_create_status id: change.value_id, name: change.value
+      if previous_start.nil?
+        previous_start = change.time
+        previous_status = new_status
+        next
       end
 
+      previous_start = issue_started_time if issue_started_time > previous_start
+
+      ranges << BarChartRange.new(
+        start: previous_start,
+        stop: change.time,
+        color: status_category_color(previous_status),
+        title: previous_status.to_s
+      )
       previous_start = change.time
-      previous_status = status
+      previous_status = new_status
     end
 
-    if previous_start
-      data_sets << {
+    ranges << BarChartRange.new(
+      start: previous_start,
+      stop: now,
+      color: status_category_color(previous_status),
+      title: previous_status.to_s
+    )
+    ranges
+  end
+
+  def bar_chart_range_to_data_set y_value:, ranges:, stack:, issue_start_time:
+    ranges.filter_map do |bar_chart_range|
+      next if bar_chart_range.stop < issue_start_time
+
+      background_color = bar_chart_range.color
+      if bar_chart_range.highlight
+        background_color = RawJavascript.new("createDiagonalPattern(#{background_color.to_json})")
+      end
+
+      {
         type: 'bar',
         data: [{
-          x: [chart_format(previous_start), chart_format("#{today}T00:00:00#{@timezone_offset}")],
-          y: label,
-          title: "#{issue.type} : #{previous_status.name}"
+          x: [chart_format([bar_chart_range.start, issue_start_time].max), chart_format(bar_chart_range.stop)],
+          y: y_value,
+          title: bar_chart_range.title
         }],
-        backgroundColor: status_category_color(previous_status),
+        backgroundColor: background_color,
+        borderColor: CssVariable['--aging-work-bar-chart-separator-color'],
+        borderWidth: {
+           top: 0,
+           right: 1,
+           bottom: 0,
+           left: 0
+        },
         stacked: true,
-        stack: 'status'
+        stack: stack
       }
     end
-
-    data_sets
-  end
-
-  def one_block_change_data_set starting_change:, ending_time:, issue_label:, stack:, issue_start_time:
-    if settings['blocked_color']
-      file_system.deprecated message: 'blocked color should be set via css now', date: '2024-05-03'
-    end
-    if settings['stalled_color']
-      file_system.deprecated message: 'stalled color should be set via css now', date: '2024-05-03'
-    end
-
-    color = settings['blocked_color'] || '--blocked-color'
-    color = settings['stalled_color'] || '--stalled-color' if starting_change.stalled?
-    {
-      backgroundColor: CssVariable[color],
-      data: [
-        {
-          title: starting_change.reasons,
-          x: [chart_format([issue_start_time, starting_change.time].max), chart_format(ending_time)],
-          y: issue_label
-        }
-      ],
-      stack: stack,
-      stacked: true,
-      type: 'bar'
-    }
   end
 
-  def blocked_data_sets issue:, issue_label:, issue_start_time:, stack:
-    data_sets = []
+  def collect_blocked_stalled_ranges issue:, issue_start_time:
+    results = []
     starting_change = nil
 
     issue.blocked_stalled_changes(end_time: time_range.end).each do |change|
@@ -195,58 +189,102 @@ class AgingWorkBarChart < ChartBase
       end
 
       if change.time >= issue_start_time
-        data_sets << one_block_change_data_set(
-          starting_change: starting_change, ending_time: change.time,
-          issue_label: issue_label, stack: stack, issue_start_time: issue_start_time
+        color = settings['blocked_color'] || '--blocked-color'
+        color = settings['stalled_color'] || '--stalled-color' if starting_change.stalled?
+
+        results << BarChartRange.new(
+          start: starting_change.time, stop: change.time, color: CssVariable[color], title: starting_change.reasons
         )
       end
 
       starting_change = change
     end
+    results
+  end
+
+  def collect_priority_ranges issue:
+    expedited_priority_names = settings['expedited_priority_names']
+
+    previous_change = nil
+    results = []
+
+    issue.changes.each do |change|
+      next unless change.priority?
+
+      if previous_change.nil?
+        previous_change = change
+        next
+      end
+
+      results << create_range_for_priority(
+        previous_change: previous_change, stop_time: change.time,
+        expedited_priority_names: expedited_priority_names
+      )
+      previous_change = change
+    end
 
-    data_sets
+    results << create_range_for_priority(
+      previous_change: previous_change, stop_time: time_range.end,
+      expedited_priority_names: expedited_priority_names
+    )
+    results
   end
 
-  def data_set_by_block(
-    issue:, issue_label:, title_label:, stack:, color:, start_date:, end_date: date_range.end
-  )
-    started = nil
-    ended = nil
-    data = []
-
-    (start_date..end_date).each do |day|
-      if yield(day)
-        started = day if started.nil?
-        ended = day
-      elsif ended
-        data << {
-          x: [chart_format(started), chart_format(ended)],
-          y: issue_label,
-          title: "#{issue.type} : #{title_label} #{label_days (ended - started).to_i + 1}"
-        }
-
-        started = nil
-        ended = nil
+  def collect_sprint_ranges issue:
+    results = []
+    open_sprints = {}
+
+    issue.changes.each do |change|
+      next unless change.sprint?
+
+      removed_sprint_ids = change.old_value_id - change.value_id
+      added_sprint_ids = change.value_id - change.old_value_id
+
+      removed_sprint_ids.each do |id|
+        data = open_sprints.delete(id)
+        next unless data
+
+        completed = data[:sprint].completed_time
+        stop = completed ? [change.time, completed].min : change.time
+        results << BarChartRange.new(
+          start: data[:start_time], stop: stop,
+          color: CssVariable['--sprint-color'], title: data[:sprint].name
+        )
+      end
+
+      added_sprint_ids.each do |id|
+        sprint = issue.board.sprints.find { |s| s.id == id }
+        next unless sprint
+        next if sprint.future?
+
+        start_time = [sprint.start_time, change.time].max
+        open_sprints[id] = { start_time: start_time, sprint: sprint }
       end
     end
 
-    if started
-      data << {
-        x: [chart_format(started), chart_format(ended)],
-        y: issue_label,
-        title: "#{issue.type} : #{title_label} #{label_days (end_date - started).to_i + 1}"
-      }
+    open_sprints.each_value do |data|
+      stop = data[:sprint].completed_time || time_range.end
+      results << BarChartRange.new(
+        start: data[:start_time], stop: stop,
+        color: CssVariable['--sprint-color'], title: data[:sprint].name
+      )
     end
 
-    return [] if data.empty?
+    results
+  end
 
-    {
-      type: 'bar',
-      data: data,
-      backgroundColor: color,
-      stacked: true,
-      stack: stack
-    }
+  def create_range_for_priority previous_change:, stop_time:, expedited_priority_names:
+    expedited = expedited_priority_names.include?(previous_change.value)
+    title = "Priority: #{previous_change.value}"
+    title << ' (expedited)' if expedited
+
+    BarChartRange.new(
+      start: previous_change.time,
+      stop: stop_time,
+      color: CssVariable["--priority-color-#{previous_change.value.downcase.gsub(/\s/, '')}"],
+      title: title,
+      highlight: expedited
+    )
   end
 
   def calculate_percent_line percentage: 85
@@ -255,4 +293,8 @@ class AgingWorkBarChart < ChartBase
 
     days[days.length * percentage / 100]
   end
+
+  def age_cutoff days
+    @age_cutoff = days
+  end
 end

data/lib/jirametrics/anonymizer.rb

@@ -2,11 +2,12 @@
 
 require 'random-word'
 
-class Anonymizer
+class Anonymizer < ChartBase
   # needed for testing
   attr_reader :project_config, :issues
 
   def initialize project_config:, date_adjustment: -200
+    super()
     @project_config = project_config
     @issues = @project_config.issues
     @all_boards = @project_config.all_boards
@@ -130,18 +131,19 @@ class Anonymizer
     end
   end
 
-  def shift_all_dates
-    @file_system.log "Shifting all dates by #{@date_adjustment} days"
+  def shift_all_dates date_adjustment: @date_adjustment
+    adjustment_in_seconds = 60 * 60 * 24 * date_adjustment
+    @file_system.log "Shifting all dates by #{label_days date_adjustment}"
     @issues.each do |issue|
       issue.changes.each do |change|
-        change.time = change.time + @date_adjustment
+        change.time = change.time + adjustment_in_seconds
       end
 
-      issue.raw['fields']['updated'] = (issue.updated + @date_adjustment).to_s
+      issue.raw['fields']['updated'] = (issue.updated + adjustment_in_seconds).to_s
     end
 
     range = @project_config.time_range
-    @project_config.time_range = (range.begin + @date_adjustment)..(range.end + @date_adjustment)
+    @project_config.time_range = (range.begin + date_adjustment)..(range.end + date_adjustment)
   end
 
   def random_name

data/lib/jirametrics/atlassian_document_format.rb

@@ -13,9 +13,9 @@ class AtlassianDocumentFormat
       input
         .gsub(/{color:(#\w{6})}([^{]+){color}/, '<span style="color: \1">\2</span>') # Colours
         .gsub(/\[~accountid:([^\]]+)\]/) { expand_account_id $1 } # Tagged people
-        .gsub(/\[([^\|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
+        .gsub(/\[([^|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
         .gsub("\n", '<br />')
-    elsif input['content']
+    elsif input&.[]('content')
       input['content'].collect { |element| adf_node_to_html element }.join("\n")
     else
       # We have an actual ADF document with no content.
@@ -157,4 +157,4 @@ class AtlassianDocumentFormat
     text = "@#{user.display_name}" if user
     "<span class='account_id'>#{text}</span>"
   end
-end
+end

data/lib/jirametrics/bar_chart_range.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jirametrics/value_equality'
+
+class BarChartRange
+  include ValueEquality
+
+  attr_accessor :start, :stop, :color, :title, :highlight
+
+  def initialize start:, stop:, color:, title:, highlight: false
+    @start = start
+    @stop = stop
+    @color = color
+    @title = title
+    @highlight = highlight
+  end
+end

data/lib/jirametrics/board.rb

@@ -116,4 +116,8 @@ class Board
   def estimation_configuration
     EstimationConfiguration.new raw: raw['estimation']
   end
+
+  def inspect
+    "Board(id: #{id}, name: #{name.inspect}, board_type: #{board_type.inspect})"
+  end
 end

data/lib/jirametrics/board_config.rb

@@ -24,7 +24,9 @@ class BoardConfig
     end
 
     @board.cycletime = CycleTimeConfig.new(
-      parent_config: self, label: label, block: block, file_system: project_config.file_system
+      possible_statuses: project_config.possible_statuses,
+      label: label, block: block, file_system: project_config.file_system,
+      settings: project_config.settings
     )
   end
 

data/lib/jirametrics/change_item.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 class ChangeItem
-  attr_reader :field, :value_id, :old_value_id, :raw, :time, :author_raw
-  attr_accessor :value, :old_value
+  attr_reader :field, :value_id, :old_value_id, :raw, :author_raw, :field_id
+  attr_accessor :value, :old_value, :time
 
   def initialize raw:, author_raw:, time:, artificial: false
     @raw = raw
@@ -13,9 +13,15 @@ class ChangeItem
 
     @field = @raw['field']
     @value = @raw['toString']
-    @value_id = @raw['to'].to_i
     @old_value = @raw['fromString']
-    @old_value_id = @raw['from']&.to_i
+    if sprint?
+      @value_id = @raw['to'].split(', ').collect(&:to_i)
+      @old_value_id = (@raw['from'] || '').split(', ').collect(&:to_i)
+    else
+      @value_id = @raw['to'].to_i
+      @old_value_id = @raw['from']&.to_i
+    end
+    @field_id = @raw['fieldId']
     @artificial = artificial
   end
 
@@ -54,6 +60,7 @@ class ChangeItem
       message << ':' << old_value_id.inspect if status?
     end
     message << ", time: #{time_to_s(@time).inspect}"
+    message << ", field_id: #{@field_id.inspect}" if @field_id
     message << ', artificial' if artificial?
     message << ')'
     message

data/lib/jirametrics/chart_base.rb

@@ -2,7 +2,8 @@
 
 class ChartBase
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
-    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system, :users
+    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system,
+    :atlassian_document_format
   attr_writer :aggregated_project
   attr_reader :canvas_width, :canvas_height
 
@@ -21,6 +22,14 @@ class ChartBase
     @canvas_responsive = true
   end
 
+  def call_before_run &proc
+    (@call_before_run_procs ||= []) << proc
+  end
+
+  def before_run
+    @call_before_run_procs&.each { |proc| proc.call }
+  end
+
   def aggregated_project?
     @aggregated_project
   end
@@ -44,7 +53,7 @@ class ChartBase
 
   def render_top_text caller_binding
     result = +''
-    result << "<h1>#{@header_text}</h1>" if @header_text
+    result << "<h1 class='foldable'>#{@header_text}</h1>" if @header_text
     result << ERB.new(@description_text).result(caller_binding) if @description_text
     result
   end
@@ -278,4 +287,27 @@ class ChartBase
       </div>
     TEXT
   end
+
+  # Set a cycletime for just this one chart, overriding the one for the report.
+  def cycletime &block
+    call_before_run do
+      @cycletime = CycleTimeConfig.new(
+        possible_statuses: possible_statuses, label: nil, block: block, file_system: file_system,
+        settings: settings
+      )
+    end
+  end
+
+  # Returns the cycletime in use right now, which may be specific to the chart or across the report.
+  def cycletime_for_issue issue
+    @cycletime || issue.board.cycletime
+  end
+
+  def seam_start type = 'chart'
+    "\n<!-- seam-start | chart#{@@chart_counter} | #{self.class} | #{header_text} | #{type} -->"
+  end
+
+  def seam_end type = 'chart'
+    "\n<!-- seam-end | chart#{@@chart_counter} | #{self.class} | #{header_text} | #{type} -->"
+  end
 end

data/lib/jirametrics/cycletime_config.rb

@@ -6,12 +6,14 @@ require 'date'
 class CycleTimeConfig
   include SelfOrIssueDispatcher
 
-  attr_reader :label, :parent_config
+  attr_reader :label, :possible_statuses, :settings, :file_system
 
-  def initialize parent_config:, label:, block:, file_system: nil, today: Date.today
-    @parent_config = parent_config
+  def initialize possible_statuses:, label:, block:, settings:, file_system: nil, today: Date.today
+
+    @possible_statuses = possible_statuses
     @label = label
     @today = today
+    @settings = settings
 
     # If we hit something deprecated and this is nil then we'll blow up. Although it's ugly, this
     # may make it easier to find problems in the test code ;-)
@@ -63,6 +65,10 @@ class CycleTimeConfig
   end
 
   def started_stopped_changes issue
+    cache_key = "#{issue.key}:#{issue.board.id}"
+    last_result = (@cache ||= {})[cache_key]
+    return *last_result if last_result && settings['cache_cycletime_calculations']
+
     started = @start_at.call(issue)
     stopped = @stop_at.call(issue)
 
@@ -80,7 +86,15 @@ class CycleTimeConfig
     # for the start and not have it conflict.
     started = nil if started&.time == stopped&.time
 
-    [started, stopped]
+    result = [started, stopped]
+    if last_result && result != last_result
+      @file_system.error(
+        "Calculation mismatch; this could break caching. #{issue.inspect} new=#{result.inspect}, " \
+          "previous=#{last_result.inspect}"
+      )
+    end
+    @cache[cache_key] = result
+    result
   end
 
   def started_stopped_times issue
@@ -88,6 +102,10 @@ class CycleTimeConfig
     [started&.time, stopped&.time]
   end
 
+  def flush_cache
+    @cache = nil
+  end
+
   def started_stopped_dates issue
     started_time, stopped_time = started_stopped_times(issue)
     [started_time&.to_date, stopped_time&.to_date]