jirametrics 2.22 → 2.24

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?
@@ -245,6 +305,13 @@ class ChartBase
     "<span title='#{title}' style='font-size: 0.8em;'>#{icon}</span>"
   end
 
+  def not_visible_text issue
+    reasons = issue.reasons_not_visible_on_board
+    return nil if reasons.empty?
+
+    "<span style='background: var(--warning-banner)'>Not visible on board: #{reasons.join(', ')}</span>"
+  end
+
   def status_category_color status
     case status.category.key
     when 'new' then CssVariable['--status-category-todo-color']
@@ -310,4 +377,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/css_variable.rb

@@ -16,7 +16,7 @@ class CssVariable
   end
 
   def to_json(*_args)
-    "getComputedStyle(document.body).getPropertyValue('#{@name}')"
+    "getComputedStyle(document.documentElement).getPropertyValue('#{@name}').trim()"
   end
 
   def to_s

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

data/lib/jirametrics/cycletime_histogram.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
-require 'jirametrics/groupable_issue_chart'
+require 'jirametrics/time_based_histogram'
 
-class CycletimeHistogram < ChartBase
-  include GroupableIssueChart
+class CycletimeHistogram < TimeBasedHistogram
   attr_accessor :possible_statuses
-  attr_reader :show_stats
 
   def initialize block
     super()
 
-    percentiles [50, 85, 98]
-    @show_stats = true
+    @x_axis_title = 'Cycletime in days'
+    @y_axis_title = 'Count'
 
     header_text 'Cycletime Histogram'
     description_text <<-HTML
@@ -30,112 +28,26 @@ class CycletimeHistogram < ChartBase
     end
   end
 
-  def percentiles percs = nil
-    @percentiles = percs unless percs.nil?
-    @percentiles
-  end
-
-  def disable_stats
-    @show_stats = false
-  end
-
-  def run
+  def all_items
     stopped_issues = completed_issues_in_range include_unstarted: true
 
     # For the histogram, we only want to consider items that have both a start and a stop time.
-    histogram_issues = stopped_issues.select { |issue| issue.board.cycletime.started_stopped_times(issue).first }
-    rules_to_issues = group_issues histogram_issues
-
-    the_stats = {}
-
-    overall_stats = stats_for histogram_data: histogram_data_for(issues: histogram_issues), percentiles: @percentiles
-    the_stats[:all] = overall_stats
-    data_sets = rules_to_issues.keys.collect do |rules|
-      the_issue_type = rules.label
-      the_histogram = histogram_data_for(issues: rules_to_issues[rules])
-      the_stats[the_issue_type] = stats_for histogram_data: the_histogram, percentiles: @percentiles if @show_stats
-
-      data_set_for(
-        histogram_data: the_histogram,
-        label: the_issue_type,
-        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__)
+    stopped_issues.select { |issue| issue.board.cycletime.started_stopped_times(issue).first }
   end
 
-  def histogram_data_for issues:
-    count_hash = {}
-    issues.each do |issue|
-      days = issue.board.cycletime.cycletime(issue)
-      count_hash[days] = (count_hash[days] || 0) + 1 if days.positive?
-    end
-    count_hash
+  def value_for_item issue
+    issue.board.cycletime.cycletime(issue)
   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
-    }
+  def title_for_item count:, value:
+    "#{count} items completed in #{label_days value}"
   end
 
-  def data_set_for histogram_data:, label:, color:
-    keys = histogram_data.keys.sort
-    {
-      type: 'bar',
-      label: label,
-      data: keys.sort.filter_map do |key|
-        next if histogram_data[key].zero?
+  def sort_items items
+    items.sort_by(&:key_as_i)
+  end
 
-        {
-          x: key,
-          y: histogram_data[key],
-          title: "#{histogram_data[key]} items completed in #{label_days key}"
-        }
-      end,
-      backgroundColor: color,
-      borderRadius: 0
-    }
+  def label_for_item issue, hint:
+    "#{issue.key} : #{issue.summary}#{" #{hint}" if hint}"
   end
 end

data/lib/jirametrics/cycletime_scatterplot.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require 'jirametrics/groupable_issue_chart'
-
-class CycletimeScatterplot < ChartBase
-  include GroupableIssueChart
+require 'jirametrics/time_based_scatterplot'
 
+class CycletimeScatterplot < TimeBasedScatterplot
   attr_accessor :possible_statuses
 
   def initialize block
@@ -26,6 +24,8 @@ class CycletimeScatterplot < ChartBase
       </div>
       #{describe_non_working_days}
     HTML
+    @x_axis_title = 'Date completed'
+    @y_axis_title = 'Cycletime in days'
 
     init_configuration_block block do
       grouping_rules do |issue, rule|
@@ -33,9 +33,6 @@ class CycletimeScatterplot < ChartBase
         rule.color = color_for type: issue.type
       end
     end
-
-    @percentage_lines = []
-    @highest_y_value = 0
   end
 
   def all_items
@@ -51,96 +48,10 @@ class CycletimeScatterplot < ChartBase
   end
 
   def title_value item
-    "#{item.key} : #{item.summary} (#{label_days(y_value(item))})"
-  end
-
-  def y_axis_heading
-    'Cycle time in days'
-  end
-
-  def run
-    items = all_items
-    data_sets = create_datasets items
-    overall_percent_line = calculate_percent_line(items)
-    @percentage_lines << [overall_percent_line, CssVariable['--cycletime-scatterplot-overall-trendline-color']]
-
-    return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if data_sets.empty?
-
-    wrap_and_render(binding, __FILE__)
-  end
-
-  def create_datasets items
-    data_sets = []
-
-    group_issues(items).each do |rules, completed_items_by_type|
-      label = rules.label
-      color = rules.color
-      percent_line = calculate_percent_line completed_items_by_type
-      data = completed_items_by_type.filter_map { |issue| data_for_issue(issue) }
-      data_sets << {
-        label: "#{label} (85% at #{label_days(percent_line)})",
-        data: data,
-        fill: false,
-        showLine: false,
-        backgroundColor: color
-      }
-
-      data_sets << trend_line_data_set(label: label, data: data, color: color)
-
-      @percentage_lines << [percent_line, color]
-    end
-    data_sets
+    hint = @issue_hints&.fetch(item, nil)
+    "#{item.key} : #{item.summary} (#{label_days(y_value(item))})#{" #{hint}" if hint}"
   end
 
-  def show_trend_lines
-    @show_trend_lines = true
-  end
-
-  def trend_line_data_set label:, data:, color:
-    points = data.collect do |hash|
-      [Time.parse(hash[:x]).to_i, hash[:y]]
-    end
-
-    # The trend calculation works with numbers only so convert Time to an int and back
-    calculator = TrendLineCalculator.new(points)
-    data_points = calculator.chart_datapoints(
-      range: time_range.begin.to_i..time_range.end.to_i,
-      max_y: @highest_y_value
-    )
-    data_points.each do |point_hash|
-      point_hash[:x] = chart_format Time.at(point_hash[:x])
-    end
-
-    {
-      type: 'line',
-      label: "#{label} Trendline",
-      data: data_points,
-      fill: false,
-      borderWidth: 1,
-      markerType: 'none',
-      borderColor: color,
-      borderDash: [6, 3],
-      pointStyle: 'dash',
-      hidden: !@show_trend_lines
-    }
-  end
-
-  def data_for_issue item
-    cycle_time = y_value(item)
-    return nil if cycle_time < 1 # These will get called out on the quality report
-
-    @highest_y_value = cycle_time if @highest_y_value < cycle_time
-
-    {
-      y: cycle_time,
-      x: chart_format(x_value(item)),
-      title: [title_value(item)]
-    }
-  end
-
-  def calculate_percent_line items
-    times = items.collect { |item| y_value(item) }
-    index = times.size * 85 / 100
-    times.sort[index]
-  end
+  # Kept for backwards compatibility with existing callers and specs
+  alias data_for_issue data_for_item
 end

data/lib/jirametrics/daily_view.rb

@@ -9,7 +9,8 @@ class DailyView < ChartBase
     header_text 'Daily View'
     description_text <<-HTML
       <div class="p">
-        This view shows all the items you'll want to discuss during your daily coordination meeting
+        This view shows all the items (<%= aging_issues.count %>) you'll want to discuss during your daily
+        coordination meeting
         (aka daily scrum, standup), in the order that you should be discussing them. The most important
         items are at the top, and the least at the bottom.
       </div>
@@ -86,9 +87,14 @@ class DailyView < ChartBase
       lines << ["#{marker} Blocked by flag"] if blocked_stalled.flag
       lines << ["#{marker} Blocked by status: #{blocked_stalled.status}"] if blocked_stalled.blocked_by_status?
       blocked_stalled.blocking_issue_keys&.each do |key|
-        lines << ["#{marker} Blocked by issue: #{key}"]
         blocking_issue = issues.find { |i| i.key == key }
-        lines << blocking_issue if blocking_issue
+        if blocking_issue
+          lines << "<section><div class=\"foldable startFolded\">#{marker} Blocked by issue: #{key}</div>"
+          lines << blocking_issue
+          lines << '</section>'
+        else
+          lines << ["#{marker} Blocked by issue: #{key}"]
+        end
       end
     elsif blocked_stalled.stalled_by_status?
       lines << ["#{color_block '--stalled-color'} Stalled by status: #{blocked_stalled.status}"]
@@ -146,7 +152,18 @@ class DailyView < ChartBase
       line << "Assignee: <img src='#{issue.assigned_to_icon_url}' class='icon' /> <b>#{issue.assigned_to}</b>"
     end
 
-    line << "Due: <b>#{issue.due_date}</b>" if issue.due_date
+    if issue.due_date
+      today = date_range.end
+      days = (issue.due_date - today).to_i
+      relative =
+        if days.zero? then 'today'
+        elsif days.positive? then "in #{label_days days}"
+        else "#{label_days(-days)} ago"
+        end
+      content = "#{issue.due_date} (#{relative})"
+      content = "<span style='background: var(--warning-banner)'>#{content}</span>" if days.negative?
+      line << "Due: <b>#{content}</b>"
+    end
 
     block = lambda do |collection, label|
       unless collection.empty?
@@ -166,7 +183,7 @@ class DailyView < ChartBase
 
     return lines if subtasks.empty?
 
-    lines << '<section><div class="foldable">Child issues</div>'
+    lines << "<section><div class=\"foldable startFolded\">Child issues (#{subtasks.count})</div>"
     lines += subtasks
     lines << '</section>'
 
@@ -237,9 +254,10 @@ class DailyView < ChartBase
 
   def make_description_lines issue
     description = issue.raw['fields']['description']
-    result = []
-    result << [atlassian_document_format.to_html(description)] if description
-    result
+    return [] unless description
+
+    text = "<div class='foldable startFolded'>Description</div><div>#{atlassian_document_format.to_html(description)}</div>"
+    [[text]]
   end
 
   def assemble_issue_lines issue, child:
@@ -247,6 +265,7 @@ class DailyView < ChartBase
 
     lines = []
     lines << [make_title_line(issue: issue, done: done)]
+    lines << make_not_visible_line(issue)
     lines += make_parent_lines(issue) unless child
     lines += make_stats_lines(issue: issue, done: done)
     unless done
@@ -256,7 +275,7 @@ class DailyView < ChartBase
       lines += make_child_lines(issue)
       lines += make_history_lines(issue)
     end
-    lines
+    lines.compact
   end
 
   def render_issue issue, child:
@@ -278,4 +297,8 @@ class DailyView < ChartBase
     end
     result << '</div>'
   end
+
+  def make_not_visible_line issue
+    not_visible_text issue
+  end
 end

data/lib/jirametrics/daily_wip_chart.rb

@@ -3,12 +3,16 @@
 require 'jirametrics/chart_base'
 
 class DailyGroupingRules < GroupingRules
-  attr_accessor :current_date, :group_priority, :issue_hint
+  attr_accessor :current_date, :group_priority, :issue_hint, :highlight
 
   def initialize
     super
     @group_priority = 0
   end
+
+  def group
+    [@label, @color, @highlight ? true : false]
+  end
 end
 
 class DailyWipChart < ChartBase
@@ -19,6 +23,8 @@ class DailyWipChart < ChartBase
 
     header_text default_header_text
     description_text default_description_text
+    @x_axis_title = nil
+    @y_axis_title = 'Count of items'
 
     instance_eval(&block) if block
 
@@ -33,8 +39,15 @@ class DailyWipChart < ChartBase
     issue_rules_by_active_date = group_issues_by_active_dates
     possible_rules = select_possible_rules issue_rules_by_active_date
 
+    conflicting_labels = possible_rules
+      .group_by(&:label)
+      .select { |_label, rules| rules.any?(&:highlight) && rules.any? { |r| !r.highlight } }
+      .keys
+
     data_sets = possible_rules.collect do |grouping_rule|
-      make_data_set grouping_rule: grouping_rule, issue_rules_by_active_date: issue_rules_by_active_date
+      suffix = conflicting_labels.include?(grouping_rule.label) && grouping_rule.highlight ? '*' : ''
+      make_data_set grouping_rule: grouping_rule, issue_rules_by_active_date: issue_rules_by_active_date,
+                    label_suffix: suffix
     end
     if @trend_lines
       data_sets = @trend_lines.filter_map do |group_labels, line_color|
@@ -82,16 +95,16 @@ class DailyWipChart < ChartBase
     hash
   end
 
-  def make_data_set grouping_rule:, issue_rules_by_active_date:
+  def make_data_set grouping_rule:, issue_rules_by_active_date:, label_suffix: ''
     positive = grouping_rule.group_priority >= 0
+    display_label = "#{grouping_rule.label}#{label_suffix}"
 
     data = issue_rules_by_active_date.collect do |date, issue_rules|
-      # issues = []
       issue_strings = issue_rules
         .select { |_issue, rules| rules.group == grouping_rule.group }
         .sort_by { |issue, _rules| issue.key_as_i }
         .collect { |issue, rules| "#{issue.key} : #{issue.summary.strip} #{rules.issue_hint}" }
-      title = ["#{grouping_rule.label} (#{label_issues issue_strings.size})"] + issue_strings
+      title = ["#{display_label} (#{label_issues issue_strings.size})"] + issue_strings
 
       {
         x: date,
@@ -100,11 +113,18 @@ class DailyWipChart < ChartBase
       }
     end
 
+    color = grouping_rule.color || random_color
+    background_color = if grouping_rule.highlight
+                         RawJavascript.new("createDiagonalPattern(#{color.to_json})")
+                       else
+                         color
+                       end
+
     {
       type: 'bar',
-      label: grouping_rule.label,
+      label: display_label,
       data: data,
-      backgroundColor: grouping_rule.color || random_color,
+      backgroundColor: background_color,
       borderColor: CssVariable['--wip-chart-border-color'],
       borderWidth: grouping_rule.color.to_s == 'var(--body-background)' ? 1 : 0,
       borderRadius: positive ? 0 : 5

data/lib/jirametrics/data_quality_report.rb

@@ -45,6 +45,7 @@ class DataQualityReport < ChartBase
       scan_for_completed_issues_without_a_start_time entry: entry
       scan_for_status_change_after_done entry: entry
       scan_for_backwards_movement entry: entry, backlog_statuses: backlog_statuses
+      scan_for_issue_not_in_active_sprint entry: entry
       scan_for_issues_not_created_in_a_backlog_status entry: entry, backlog_statuses: backlog_statuses
       scan_for_stopped_before_started entry: entry
       scan_for_issues_not_started_with_subtasks_that_have entry: entry
@@ -68,7 +69,7 @@ class DataQualityReport < ChartBase
     result << render_problem_type(:status_changes_after_done)
     result << render_problem_type(:backwards_through_status_categories)
     result << render_problem_type(:backwords_through_statuses)
-    result << render_problem_type(:status_not_on_board)
+    result << render_problem_type(:issue_not_visible_on_board)
     result << render_problem_type(:created_in_wrong_status)
     result << render_problem_type(:stopped_before_started)
     result << render_problem_type(:issue_not_started_but_subtasks_have)
@@ -194,7 +195,7 @@ class DataQualityReport < ChartBase
         # If it's been moved back to backlog then it's on a different report. Ignore it here.
         detail = nil if backlog_statuses.any? { |s| s.name == change.value }
 
-        entry.report(problem_key: :status_not_on_board, detail: detail) unless detail.nil?
+        entry.report(problem_key: :issue_not_visible_on_board, detail: detail) unless detail.nil?
       elsif change.old_value.nil?
         # Do nothing
       elsif index < last_index
@@ -223,6 +224,29 @@ class DataQualityReport < ChartBase
     end
   end
 
+  def scan_for_issue_not_in_active_sprint entry:
+    issue = entry.issue
+    return unless issue.board.scrum?
+    return if issue.sprints.any?(&:active?)
+
+    entry.report(problem_key: :issue_not_visible_on_board, detail: 'Issue is not in an active sprint')
+  end
+
+  def scan_for_issue_never_visible_on_board entry:
+    issue = entry.issue
+    ever_visible = issue.changes.any? do |change|
+      next unless change.status?
+
+      issue.board.visible_columns.any? { |col| col.status_ids.include?(change.value_id) }
+    end
+    return if ever_visible
+
+    entry.report(
+      problem_key: :issue_not_visible_on_board,
+      detail: 'Issue has never been in a status mapped to a visible column on the board'
+    )
+  end
+
   def scan_for_issues_not_created_in_a_backlog_status entry:, backlog_statuses:
     creation_change = entry.issue.changes.find { |issue| issue.status? }
 
@@ -295,7 +319,7 @@ class DataQualityReport < ChartBase
     return "#{delta} hours" if delta < 24
 
     delta /= 24
-    "#{delta} days"
+    label_days delta
   end
 
   def scan_for_incomplete_subtasks_when_issue_done entry:
@@ -409,12 +433,12 @@ class DataQualityReport < ChartBase
     HTML
   end
 
-  def render_status_not_on_board problems
+  def render_issue_not_visible_on_board problems
     <<-HTML
       #{label_issues problems.size} were not visible on the board for some period of time. This may impact
-      timings as the work was likely to have been forgotten if it wasn't visible. What does "not visible"
-      mean in this context? The issue was in a status that is not mapped to any visible column on the board.
-      Look in "unmapped statuses" on your board.
+      timings as the work was likely to have been forgotten if it wasn't visible. An issue can be not visible
+      for two reasons: the issue was in a status that is not mapped to any visible column on the board
+      (look in "unmapped statuses" on your board), or for scrum boards, the issue was not in an active sprint.
     HTML
   end