jirametrics 2.12.1 → 2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7565c5b6320b9c4375a3feb27fcaf80f96d9c058041b71584f287e6a3d7eb399
-  data.tar.gz: 4554c7edbc7c42e01ad4838094ab922819c2e71818a46907f25740e35c327aa6
+  metadata.gz: 40a0ee85ee8d7d0d2ff071357afdea2aefdfeea8734f96eb789721d4a9f2607b
+  data.tar.gz: 11008f97848d8e3034cf95c5f615496c5677d8057f40b06d2724247d6087318d
 SHA512:
-  metadata.gz: 021c1f989117b1fbb8708183d9ad8e79b049060989c1f20d31121a486d25f1ae2d1c036e013279479cd3ac6f5b101a48d8c9f4943570107c9cc4b40485ea6a4f
-  data.tar.gz: 7f7e334a2161e23ef5ae8a754aa3f12524c1bb130893ca3df3e8574f7a44286ef33c8a03b2ac2790ccb8e8b792ce0fb6c17b1d69d2da068ea48dbce1b4c514a1
+  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

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+class AtlassianDocumentFormat
+  attr_reader :users
+
+  def initialize users:, timezone_offset:
+    @users = users
+    @timezone_offset = timezone_offset
+  end
+
+  def to_html input
+    if input.is_a? String
+      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("\n", '<br />')
+    elsif input&.[]('content')
+      input['content'].collect { |element| adf_node_to_html element }.join("\n")
+    else
+      # We have an actual ADF document with no content.
+      ''
+    end
+  end
+
+  # ADF is Atlassian Document Format
+  # https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/
+  def adf_node_to_html node # rubocop:disable Metrics/CyclomaticComplexity
+    closing_tag = nil
+    node_attrs = node['attrs']
+
+    result = +''
+    case node['type']
+    when 'blockquote'
+      result << '<blockquote>'
+      closing_tag = '</blockquote>'
+    when 'bulletList'
+      result << '<ul>'
+      closing_tag = '</ul>'
+    when 'codeBlock'
+      result << '<code>'
+      closing_tag = '</code>'
+    when 'date'
+      result << Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s
+    when 'decisionItem'
+      result << '<li>'
+      closing_tag = '</li>'
+    when 'decisionList'
+      result << '<div>Decisions<ul>'
+      closing_tag = '</ul></div>'
+    when 'emoji'
+      result << node_attrs['text']
+    when 'expand'
+      # TODO: Maybe, someday, make this actually expandable. For now it's always open
+      result << "<div>#{node_attrs['title']}</div>"
+    when 'hardBreak'
+      result << '<br />'
+    when 'heading'
+      level = node_attrs['level']
+      result << "<h#{level}>"
+      closing_tag = "</h#{level}>"
+    when 'inlineCard'
+      url = node_attrs['url']
+      result << "[Inline card]: <a href='#{url}'>#{url}</a>"
+    when 'listItem'
+      result << '<li>'
+      closing_tag = '</li>'
+    when 'media'
+      text = node_attrs['alt'] || node_attrs['id']
+      result << "Media: #{text}"
+    when 'mediaSingle', 'mediaGroup'
+      result << '<div>'
+      closing_tag = '</div>'
+    when 'mention'
+      user = node_attrs['text']
+      result << "<b>#{user}</b>"
+    when 'orderedList'
+      result << '<ol>'
+      closing_tag = '</ol>'
+    when 'panel'
+      type = node_attrs['panelType']
+      result << "<div>#{type.upcase}</div>"
+    when 'paragraph'
+      result << '<p>'
+      closing_tag = '</p>'
+    when 'rule'
+      result << '<hr />'
+    when 'status'
+      text = node_attrs['text']
+      result << text
+    when 'table'
+      result << '<table>'
+      closing_tag = '</table>'
+    when 'tableCell'
+      result << '<td>'
+      closing_tag = '</td>'
+    when 'tableHeader'
+      result << '<th>'
+      closing_tag = '</th>'
+    when 'tableRow'
+      result << '<tr>'
+      closing_tag = '</tr>'
+    when 'text'
+      marks = adf_marks_to_html node['marks']
+      result << marks.collect(&:first).join
+      result << node['text']
+      result << marks.collect(&:last).join
+    when 'taskItem'
+      state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
+      result << "<li>#{state} "
+      closing_tag = '</li>'
+    when 'taskList'
+      result << "<ul class='taskList'>"
+      closing_tag = '</ul>'
+    else
+      result << "<p>Unparseable section: #{node['type']}</p>"
+    end
+
+    node['content']&.each do |child|
+      result << adf_node_to_html(child)
+    end
+
+    result << closing_tag if closing_tag
+    result
+  end
+
+  def adf_marks_to_html list
+    return [] if list.nil?
+
+    mappings = [
+      ['strong', '<b>', '</b>'],
+      ['code', '<code>', '</code>'],
+      ['em', '<em>', '</em>'],
+      ['strike', '<s>', '</s>'],
+      ['underline', '<u>', '</u>']
+    ]
+
+    list.filter_map do |mark|
+      type = mark['type']
+      if type == 'textColor'
+        color = mark['attrs']['color']
+        ["<span style='color: #{color}'>", '</span>']
+      elsif type == 'link'
+        href = mark['attrs']['href']
+        title = mark['attrs']['title']
+        ["<a href='#{href}' title='#{title}'>", '</a>']
+      else
+        line = mappings.find { |key, _open, _close| key == type }
+        [line[1], line[2]] if line
+      end
+    end
+  end
+
+  def expand_account_id account_id
+    user = @users.find { |u| u.account_id == account_id }
+    text = account_id
+    text = "@#{user.display_name}" if user
+    "<span class='account_id'>#{text}</span>"
+  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

@@ -11,6 +11,7 @@ class BoardConfig
 
   def run
     @board = @project_config.all_boards[id]
+    raise "Can't find board #{id.inspect} in #{@project_config.all_boards.keys.inspect}" unless @board
 
     instance_eval(&@block)
     raise "Must specify a cycletime for board #{@id}" if @board.cycletime.nil?
@@ -23,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