jirametrics 2.22 → 2.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40a0ee85ee8d7d0d2ff071357afdea2aefdfeea8734f96eb789721d4a9f2607b
-  data.tar.gz: 11008f97848d8e3034cf95c5f615496c5677d8057f40b06d2724247d6087318d
+  metadata.gz: 2145950e91bf010e3c2790151b32f859fc479a871002f2057e2070ef23a6e1ae
+  data.tar.gz: 00bff5cffee6fc49862ae15fdc78f142982337a03abb4ea33735b07a2f0f3426
 SHA512:
-  metadata.gz: 1e5ad6c1d5dddf5a89cc63498f1967f35c4761b6418c90019c8c6756599efb5b8badaf0ac4d50f94be4644508a97641430f178b3d40217cb02560aa017f33b80
-  data.tar.gz: a6a7f74dadbb8a2f7961a02e396a39dd994ff1a11756f57a5eadfd60af5c71bd79c3df65b7bfd77ca998059018f60cd6306b2006512b7cf5f760d75e2d0dfdf4
+  metadata.gz: d16248d2502890619c3da712ebb7f0b6aa864994013a599d29e6795f687ccbd782d9e7f33f253f7f5db81a3c78f1be0898bf27cd4e8a981137f0a3ca55da8c8f
+  data.tar.gz: ee3e5d4fdd783a025c9666a6080f587f82cd70f0fb6aeeda9a12a862c454baab64fb635bdf2727b821760e75822638378c87b18e59b68fa8903b3bd87a05f9f8

data/lib/jirametrics/aggregate_config.rb

@@ -65,8 +65,16 @@ class AggregateConfig
 
     if issues.nil?
       file_system.warning "No issues found for #{project_name}"
-    else
-      @project_config.add_issues issues
+      return
+    end
+
+    @project_config.add_issues issues
+
+    # Bring fix versions over
+    project.fix_versions.each do |fix_version|
+      unless @project_config.fix_versions.find { |fv| fv.id == fix_version.id }
+        @project_config.fix_versions << fix_version
+      end
     end
   end
 

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -83,6 +83,8 @@ class AgingWorkBarChart < ChartBase
     ]
     bar_data << ['sprints', collect_sprint_ranges(issue: issue)] if current_board.scrum?
 
+    bar_data.each { |entry| clip_ranges_to_start_time(ranges: entry.last, issue_start_time: issue_start_time) }
+
     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
@@ -114,6 +116,13 @@ class AgingWorkBarChart < ChartBase
     @canvas_height = preferred_height if @canvas_height.nil? || @canvas_height < preferred_height
   end
 
+  def clip_ranges_to_start_time ranges:, issue_start_time:
+    return if issue_start_time.nil?
+
+    ranges.each { |range| range.start = issue_start_time if range.start < issue_start_time }
+    ranges.reject! { |range| range.start >= range.stop }
+  end
+
   def collect_status_ranges issue:, now:
     ranges = []
     issue_started_time = issue.board.cycletime.started_stopped_times(issue).first
@@ -263,6 +272,8 @@ class AgingWorkBarChart < ChartBase
     end
 
     open_sprints.each_value do |data|
+      next if data[:sprint].future?
+
       stop = data[:sprint].completed_time || time_range.end
       results << BarChartRange.new(
         start: data[:start_time], stop: stop,

data/lib/jirametrics/aging_work_table.rb

@@ -174,6 +174,6 @@ class AgingWorkTable < ChartBase
   end
 
   def priority_text issue
-    "<img src='#{issue.priority_url}' title='Priority: #{issue.priority_name}' />"
+    "<img src='#{issue.priority_url}' title='Priority: #{issue.priority_name}' style='max-width: 1em;'/>"
   end
 end

data/lib/jirametrics/anonymizer.rb

@@ -21,6 +21,10 @@ class Anonymizer < ChartBase
     anonymize_column_names
     # anonymize_issue_statuses
     anonymize_board_names
+    anonymize_labels_and_components
+    anonymize_sprints
+    anonymize_fix_versions
+    anonymize_server_url
     shift_all_dates unless @date_adjustment.zero?
     @file_system.log 'Anonymize done'
   end
@@ -38,13 +42,25 @@ class Anonymizer < ChartBase
 
   def anonymize_issue_keys_and_titles issues: @issues
     counter = 0
+    seen_author_raws = {}
     issues.each do |issue|
       new_key = "ANON-#{counter += 1}"
 
       issue.raw['key'] = new_key
       issue.raw['fields']['summary'] = random_phrase
+      issue.raw['fields']['description'] = nil
       issue.raw['fields']['assignee']['displayName'] = random_name unless issue.raw['fields']['assignee'].nil?
 
+      anonymize_author_raw(issue.raw['fields']['creator'], seen_author_raws)
+
+      issue.changes.each do |change|
+        anonymize_author_raw(change.author_raw, seen_author_raws)
+        if change.comment? || change.description?
+          change.value = nil
+          change.old_value = nil
+        end
+      end
+
       issue.issue_links.each do |link|
         other_issue = link.other_issue
         next if other_issue.key.match?(/^ANON-\d+$/) # Already anonymized?
@@ -55,6 +71,49 @@ class Anonymizer < ChartBase
     end
   end
 
+  def anonymize_labels_and_components
+    @issues.each do |issue|
+      issue.raw['fields']['labels'] = []
+      issue.raw['fields']['components'] = []
+    end
+  end
+
+  def anonymize_sprints
+    sprint_counter = 0
+    sprint_name_map = {}
+    @all_boards.each_value do |board|
+      board.sprints.each do |sprint|
+        name = sprint.raw['name']
+        unless sprint_name_map[name]
+          sprint_counter += 1
+          sprint_name_map[name] = "Sprint-#{sprint_counter}"
+        end
+        sprint.raw['name'] = sprint_name_map[name]
+      end
+    end
+  end
+
+  def anonymize_fix_versions
+    version_counter = 0
+    version_name_map = {}
+    @issues.each do |issue|
+      issue.raw['fields']['fixVersions']&.each do |fix_version|
+        name = fix_version['name']
+        unless version_name_map[name]
+          version_counter += 1
+          version_name_map[name] = "Version-#{version_counter}"
+        end
+        fix_version['name'] = version_name_map[name]
+      end
+    end
+  end
+
+  def anonymize_server_url
+    @all_boards.each_value do |board|
+      board.raw['self'] = board.raw['self']&.sub(/^https?:\/\/[^\/]+/, 'https://anon.example.com')
+    end
+  end
+
   def anonymize_column_names
     @all_boards.each_key do |board_id|
       @file_system.log "Anonymizing column names for board #{board_id}"
@@ -143,7 +202,7 @@ class Anonymizer < ChartBase
     end
 
     range = @project_config.time_range
-    @project_config.time_range = (range.begin + date_adjustment)..(range.end + date_adjustment)
+    @project_config.time_range = (range.begin + adjustment_in_seconds)..(range.end + adjustment_in_seconds)
   end
 
   def random_name
@@ -186,4 +245,18 @@ class Anonymizer < ChartBase
       board.raw['name'] = "#{random_phrase} board"
     end
   end
+
+  private
+
+  def anonymize_author_raw author_raw, seen
+    return unless author_raw
+    return if seen[author_raw.object_id]
+
+    seen[author_raw.object_id] = true
+    name = random_name
+    author_raw['displayName'] = name
+    author_raw['name'] = name
+    author_raw.delete('emailAddress')
+    author_raw.delete('avatarUrls')
+  end
 end

data/lib/jirametrics/atlassian_document_format.rb

@@ -23,105 +23,106 @@ class AtlassianDocumentFormat
     end
   end
 
+  def to_text input
+    if input.is_a? String
+      input
+    elsif input&.[]('content')
+      input['content'].collect { |element| adf_node_to_text element }.join
+    else
+      ''
+    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>"
+    adf_node_render(node) do |n|
+      node_attrs = n['attrs']
+      case n['type']
+      when 'blockquote'                then ['<blockquote>', '</blockquote>']
+      when 'bulletList'                then ['<ul>', '</ul>']
+      when 'codeBlock'                 then ['<code>', '</code>']
+      when 'date'
+        [Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s, nil]
+      when 'decisionItem'              then ['<li>', '</li>']
+      when 'decisionList'              then ['<div>Decisions<ul>', '</ul></div>']
+      when 'emoji'                     then [node_attrs['text'], nil]
+      when 'expand'                    then ["<div>#{node_attrs['title']}</div>", nil]
+      when 'hardBreak'                 then ['<br />', nil]
+      when 'heading'
+        level = node_attrs['level']
+        ["<h#{level}>", "</h#{level}>"]
+      when 'inlineCard'
+        url = node_attrs['url']
+        ["[Inline card]: <a href='#{url}'>#{url}</a>", nil]
+      when 'listItem'                  then ['<li>', '</li>']
+      when 'media'
+        text = node_attrs['alt'] || node_attrs['id']
+        ["Media: #{text}", nil]
+      when 'mediaSingle', 'mediaGroup' then ['<div>', '</div>']
+      when 'mention'                   then ["<b>#{node_attrs['text']}</b>", nil]
+      when 'orderedList'               then ['<ol>', '</ol>']
+      when 'panel'                     then ["<div>#{node_attrs['panelType'].upcase}</div>", nil]
+      when 'paragraph'                 then ['<p>', '</p>']
+      when 'rule'                      then ['<hr />', nil]
+      when 'status'                    then [node_attrs['text'], nil]
+      when 'table'                     then ['<table>', '</table>']
+      when 'tableCell'                 then ['<td>', '</td>']
+      when 'tableHeader'               then ['<th>', '</th>']
+      when 'tableRow'                  then ['<tr>', '</tr>']
+      when 'text'
+        marks = adf_marks_to_html(n['marks'])
+        [marks.collect(&:first).join + n['text'], marks.collect(&:last).join]
+      when 'taskItem'
+        state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
+        ["<li>#{state} ", '</li>']
+      when 'taskList'                  then ["<ul class='taskList'>", '</ul>']
+      else
+        ["<p>Unparseable section: #{n['type']}</p>", nil]
+      end
     end
+  end
 
-    node['content']&.each do |child|
-      result << adf_node_to_html(child)
+  def adf_node_to_text node # rubocop:disable Metrics/CyclomaticComplexity
+    adf_node_render(node) do |n|
+      node_attrs = n['attrs']
+      case n['type']
+      when 'blockquote'                then ['', nil]
+      when 'bulletList'                then ['', nil]
+      when 'codeBlock'                 then ['', nil]
+      when 'date'
+        [Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s, nil]
+      when 'decisionItem'              then ['- ', "\n"]
+      when 'decisionList'              then ["Decisions:\n", nil]
+      when 'emoji'                     then [node_attrs['text'], nil]
+      when 'expand'                    then ["#{node_attrs['title']}\n", nil]
+      when 'hardBreak'                 then ["\n", nil]
+      when 'heading'                   then ['', "\n"]
+      when 'inlineCard'                then [node_attrs['url'], nil]
+      when 'listItem'                  then ['- ', nil]
+      when 'media'
+        text = node_attrs['alt'] || node_attrs['id']
+        ["Media: #{text}", nil]
+      when 'mediaSingle', 'mediaGroup' then ['', nil]
+      when 'mention'                   then [node_attrs['text'], nil]
+      when 'orderedList'               then ['', nil]
+      when 'panel'                     then ["#{node_attrs['panelType'].upcase}\n", nil]
+      when 'paragraph'                 then ['', "\n"]
+      when 'rule'                      then ["---\n", nil]
+      when 'status'                    then [node_attrs['text'], nil]
+      when 'table'                     then ['', nil]
+      when 'tableCell'                 then ['', "\t"]
+      when 'tableHeader'               then ['', "\t"]
+      when 'tableRow'                  then ['', "\n"]
+      when 'text'                      then [n['text'], nil]
+      when 'taskItem'
+        state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
+        ["#{state} ", "\n"]
+      when 'taskList'                  then ['', nil]
+      else
+        ["[Unparseable: #{n['type']}]\n", nil]
+      end
     end
-
-    result << closing_tag if closing_tag
-    result
   end
 
   def adf_marks_to_html list
@@ -157,4 +158,14 @@ class AtlassianDocumentFormat
     text = "@#{user.display_name}" if user
     "<span class='account_id'>#{text}</span>"
   end
+
+  private
+
+  def adf_node_render node, &render_node
+    prefix, suffix = render_node.call(node)
+    result = +(prefix || '')
+    node['content']&.each { |child| result << adf_node_render(child, &render_node) }
+    result << suffix if suffix
+    result
+  end
 end

data/lib/jirametrics/blocked_stalled_change.rb

@@ -4,10 +4,12 @@ require 'jirametrics/value_equality'
 
 class BlockedStalledChange
   include ValueEquality
-  attr_reader :time, :blocking_issue_keys, :flag, :status, :stalled_days, :status_is_blocking
+  attr_reader :time, :blocking_issue_keys, :flag, :flag_reason, :status, :stalled_days, :status_is_blocking
 
-  def initialize time:, flagged: nil, status: nil, status_is_blocking: true, blocking_issue_keys: nil, stalled_days: nil
+  def initialize time:, flagged: nil, flag_reason: nil, status: nil, status_is_blocking: true,
+    blocking_issue_keys: nil, stalled_days: nil
     @flag = flagged
+    @flag_reason = flag_reason
     @status = status
     @status_is_blocking = status_is_blocking
     @blocking_issue_keys = blocking_issue_keys
@@ -25,7 +27,7 @@ class BlockedStalledChange
   def reasons
     result = []
     if blocked?
-      result << 'Blocked by flag' if @flag
+      result << (@flag_reason ? "Blocked by flag: #{@flag_reason}" : 'Blocked by flag') if @flag
       result << "Blocked by status: #{@status}" if blocked_by_status?
       result << "Blocked by issues: #{@blocking_issue_keys.join(', ')}" if @blocking_issue_keys
     elsif stalled_by_status?

data/lib/jirametrics/board.rb

@@ -4,10 +4,11 @@ class Board
   attr_reader :visible_columns, :raw, :possible_statuses, :sprints
   attr_accessor :cycletime, :project_config
 
-  def initialize raw:, possible_statuses:
+  def initialize raw:, possible_statuses:, features_raw: nil
     @raw = raw
     @possible_statuses = possible_statuses
     @sprints = []
+    @features_raw = features_raw
 
     columns = raw['columnConfig']['columns']
     ensure_uniqueness_of_column_names! columns
@@ -67,8 +68,21 @@ class Board
   end
 
   def board_type = raw['type']
-  def kanban? = (board_type == 'kanban')
-  def scrum? = (board_type == 'scrum')
+
+  def scrum?
+    return true if board_type == 'scrum'
+    return false unless board_type == 'simple'
+
+    @features_raw&.[]('features')
+               &.any? { |f| f['feature'] == 'jsw.agility.sprints' && f['state'] == 'ENABLED' } || false
+  end
+
+  def kanban?
+    return true if board_type == 'kanban'
+    return false unless board_type == 'simple'
+
+    !scrum?
+  end
 
   def id
     @raw['id'].to_i

data/lib/jirametrics/change_item.rb

@@ -18,7 +18,7 @@ class ChangeItem
       @value_id = @raw['to'].split(', ').collect(&:to_i)
       @old_value_id = (@raw['from'] || '').split(', ').collect(&:to_i)
     else
-      @value_id = @raw['to'].to_i
+      @value_id = @raw['to']&.to_i
       @old_value_id = @raw['from']&.to_i
     end
     @field_id = @raw['fieldId']
@@ -46,6 +46,7 @@ class ChangeItem
   def resolution? = (field == 'resolution')
   def sprint? = (field == 'Sprint')
   def status? = (field == 'status')
+  def fix_version? = (field == 'Fix Version')
 
   # An alias for time so that logic accepting a Time, Date, or ChangeItem can all respond to :to_time
   def to_time = @time
@@ -54,10 +55,10 @@ class ChangeItem
     message = +''
     message << "ChangeItem(field: #{field.inspect}"
     message << ", value: #{value.inspect}"
-    message << ':' << value_id.inspect if status?
+    message << ':' << value_id.inspect if value_id
     if old_value
       message << ", old_value: #{old_value.inspect}"
-      message << ':' << old_value_id.inspect if status?
+      message << ':' << old_value_id.inspect if old_value_id
     end
     message << ", time: #{time_to_s(@time).inspect}"
     message << ", field_id: #{@field_id.inspect}" if @field_id

data/lib/jirametrics/chart_base.rb

@@ -3,7 +3,7 @@
 class ChartBase
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
     :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system,
-    :atlassian_document_format
+    :atlassian_document_format, :x_axis_title, :y_axis_title, :fix_versions
   attr_writer :aggregated_project
   attr_reader :canvas_width, :canvas_height
 
@@ -80,10 +80,20 @@ class ChartBase
     "#{days} day#{'s' unless days == 1}"
   end
 
+  def label_hours hours
+    return 'unknown' if hours.nil?
+
+    "#{hours} hour#{'s' unless hours == 1}"
+  end
+
   def label_issues count
     "#{count} issue#{'s' unless count == 1}"
   end
 
+  def to_human_readable number
+    number.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+  end
+
   def daily_chart_dataset date_issues_list:, color:, label:, positive: true
     {
       type: 'bar',
@@ -155,6 +165,56 @@ class ChartBase
     end.join
   end
 
+  LABEL_POSITIONS = %w[5% 25% 45% 65%].freeze
+
+  def date_annotation
+    annotations = settings['date_annotations'] || []
+    in_range = annotations
+      .map { |a| [a, normalize_annotation_datetime(a['date'])] }
+      .select { |(_, dt)| date_range.cover?(Date.parse(dt)) }
+      .sort_by { |(_, dt)| dt }
+
+    positions = stagger_label_positions(in_range.map { |(_, dt)| dt })
+
+    in_range.each_with_index.collect do |(a, normalized), index|
+      <<~TEXT
+        dateAnnotation#{index}: {
+          type: 'line',
+          xMin: #{normalized.to_json},
+          xMax: #{normalized.to_json},
+          borderColor: 'rgba(0,0,0,0.7)',
+          borderWidth: 1,
+          label: {
+            display: true,
+            content: #{a['label'].to_json},
+            position: #{positions[index].to_json}
+          }
+        },
+      TEXT
+    end.join
+  end
+
+  def stagger_label_positions datetimes
+    return [] if datetimes.empty?
+
+    threshold_days = (date_range.end - date_range.begin).to_f / 5.0
+    slot = 0
+    [LABEL_POSITIONS[0]] + datetimes.each_cons(2).map do |a, b|
+      days_apart = (Date.parse(b) - Date.parse(a)).to_f.abs
+      slot = days_apart < threshold_days ? slot + 1 : 0
+      LABEL_POSITIONS[slot % LABEL_POSITIONS.size]
+    end
+  end
+
+  def normalize_annotation_datetime value
+    offset = timezone_offset || '+00:00'
+    if value.include?('T')
+      value.match?(/([+-]\d{2}:\d{2}|Z)$/) ? value : "#{value}#{offset}"
+    else
+      "#{value}T00:00:00#{offset}"
+    end
+  end
+
   # Return only the board columns for the current board.
   def current_board
     if @board_id.nil?
@@ -310,4 +370,23 @@ class ChartBase
   def seam_end type = 'chart'
     "\n<!-- seam-end | chart#{@@chart_counter} | #{self.class} | #{header_text} | #{type} -->"
   end
+
+  def render_axis_title axis_direction
+    text = case axis_direction
+    when :x
+      x_axis_title
+    when :y
+      y_axis_title
+    else
+      raise "Unexpected axis_direction: #{axis_direction}"
+    end
+    return '' unless text
+
+    <<~CONTENT
+      title: {
+          display: true,
+          text: "#{text}"
+        },
+    CONTENT
+  end
 end

data/lib/jirametrics/{cycletime_config.rb → cycle_time_config.rb}

@@ -6,10 +6,9 @@ require 'date'
 class CycleTimeConfig
   include SelfOrIssueDispatcher
 
-  attr_reader :label, :possible_statuses, :settings, :file_system
+  attr_reader :label, :settings, :file_system
 
   def initialize possible_statuses:, label:, block:, settings:, file_system: nil, today: Date.today
-
     @possible_statuses = possible_statuses
     @label = label
     @today = today