jirametrics 2.20.1 → 2.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbe1101b082615d38939850c0adc688aedefe02a74537503bcd390cdf11d0d4e
-  data.tar.gz: eeffbda7c7ba8280273e0d749ede1ed3c1caa33d06a1f50a2c47b2331035d5af
+  metadata.gz: 615528aa77577881d7658b0ce059e9e3972ce4285aeb3c1081c4347dd1a20ca4
+  data.tar.gz: 483cc9b7535da95ca2249813e5ad8ff924334f65c8b7fa84c5705367a9d1b147
 SHA512:
-  metadata.gz: b73533c90e457c2c5f7a7f2d1759ccd44d218ebe984052fcb581d8ab88225abf43b5612923217b4fa7467ed11e82ba5b4fe2cc656a324f269b71c2497bf67659
-  data.tar.gz: 57cbc54fe6c739d0c85f68cc0efcfbc6005975af0b40174ed9ee35790a83dac9b5e524601b770dffc6a3fefbd10f0d577d19b840560b3acfb63b0b542728d5fc
+  metadata.gz: 36acebeef4d036c6ed043f0073177944c390d5c80ba6ef162319f6a9bbb67bb2762ca4a345f4160d0f1d3fdc7047e257474920c09da9c5770c8a0e45a4748e59
+  data.tar.gz: 2c6f92cdb1d61b49ed7b318bc5c2108649ad387e9af51c312ade43f1522f3cc842dc949dde7d0373d41dc25630bbf9e5a3f883fc9255423ecd6e19c9008b3a4f

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

@@ -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,19 @@ 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 <%= current_board.scrum? ? 'four' : '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>
+          <% if current_board.scrum? %>
+            <li>Sprints: The sprints that the issue was in.</li>
+          <% end %>
         </ol>
       </p>
       #{describe_non_working_days}
@@ -36,6 +41,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 +64,134 @@ 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.started_stopped_times.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?
+
+    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
+    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?
+      started_time, stopped_time = issue.started_stopped_times
+      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
+  def clip_ranges_to_start_time ranges:, issue_start_time:
+    return if issue_start_time.nil?
 
-    issue_started_time, _issue_stopped_time = cycletime.started_stopped_times(issue)
+    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.started_stopped_times.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 +201,104 @@ 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?
 
-    data_sets
+      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
+
+    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|
+      next if data[:sprint].future?
+
+      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 +307,8 @@ class AgingWorkBarChart < ChartBase
 
     days[days.length * percentage / 100]
   end
+
+  def age_cutoff days
+    @age_cutoff = days
+  end
 end

data/lib/jirametrics/aging_work_table.rb

@@ -50,15 +50,14 @@ class AgingWorkTable < ChartBase
 
   def expedited_but_not_started
     @issues.select do |issue|
-      started_time, stopped_time = issue.board.cycletime.started_stopped_times(issue)
+      started_time, stopped_time = issue.started_stopped_times
       started_time.nil? && stopped_time.nil? && issue.expedited?
     end.sort_by(&:created)
   end
 
   def select_aging_issues
     aging_issues = @issues.select do |issue|
-      cycletime = issue.board.cycletime
-      started, stopped = cycletime.started_stopped_times(issue)
+      started, stopped = issue.started_stopped_times
       next false if started.nil? || stopped
       next true if issue.blocked_on_date?(@today, end_time: time_range.end) || issue.expedited?
 
@@ -77,7 +76,7 @@ class AgingWorkTable < ChartBase
   end
 
   def blocked_text issue
-    started_time, _stopped_time = issue.board.cycletime.started_stopped_times(issue)
+    started_time, _stopped_time = issue.started_stopped_times
     return nil if started_time.nil?
 
     current = issue.blocked_stalled_changes(end_time: time_range.end)[-1]
@@ -174,6 +173,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