Class: TimeBasedHistogram

Inherits:
ChartBase show all
Includes:
GroupableIssueChart
Defined in:
lib/jirametrics/time_based_histogram.rb

Constant Summary

Constants inherited from ChartBase

ChartBase::LABEL_POSITIONS

Instance Attribute Summary collapse

Attributes inherited from ChartBase

#aggregated_project, #all_boards, #atlassian_document_format, #board_id, #canvas_height, #canvas_width, #data_quality, #date_range, #file_system, #fix_versions, #holiday_dates, #issues, #settings, #time_range, #timezone_offset, #x_axis_title, #y_axis_title

Instance Method Summary collapse

Methods included from GroupableIssueChart

#group_issues, #grouping_rules, #init_configuration_block

Methods inherited from ChartBase

#aggregated_project?, #before_run, #call_before_run, #canvas, #canvas_responsive?, #chart_format, #collapsible_issues_panel, #color_block, #color_for, #completed_issues_in_range, #current_board, #cycletime, #cycletime_for_issue, #daily_chart_dataset, #date_annotation, #describe_non_working_days, #description_text, #format_integer, #format_status, #header_text, #holidays, #html_directory, #icon_span, #label_days, #label_hours, #label_issues, #label_minutes, #link_to_issue, #next_id, #normalize_annotation_datetime, #not_visible_text, #random_color, #render, #render_axis_title, #render_top_text, #seam_end, #seam_start, #stagger_label_positions, #status_category_color, #to_human_readable, #working_days_annotation, #wrap_and_render

Constructor Details

#initialize ⇒ TimeBasedHistogram

Returns a new instance of TimeBasedHistogram.



10
11
12
13
14
15
 
# File 'lib/jirametrics/time_based_histogram.rb', line 10

def initialize
  super

  percentiles [50, 85, 98]
  @show_stats = true
end

Instance Attribute Details

#show_stats ⇒ Object (readonly)

Returns the value of attribute show_stats.



8
9
10
 
# File 'lib/jirametrics/time_based_histogram.rb', line 8

def show_stats
  @show_stats
end

Instance Method Details

#data_set_for(histogram_data:, label:, color:) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/jirametrics/time_based_histogram.rb', line 117

def data_set_for histogram_data:, label:, color:
  {
    type: 'bar',
    label: label,
    data: histogram_data.keys.sort.filter_map do |days|
      items = histogram_data[days]
      next if items.empty?

      {
        x: days,
        y: items.size,
        title: [title_for_item(count: items.size, value: days)] +
          sort_items(items).collect do |item|
            hint = @issue_hints&.fetch(item, nil)
            label_for_item(item, hint: hint)
          end
      }
    end,
    backgroundColor: color,
    borderRadius: 0
  }
end

#disable_stats ⇒ Object 



22
23
24
 
# File 'lib/jirametrics/time_based_histogram.rb', line 22

def disable_stats
  @show_stats = false
end

#histogram_data_for(items:) ⇒ Object 



58
59
60
61
62
63
64
65
 
# File 'lib/jirametrics/time_based_histogram.rb', line 58

def histogram_data_for items:
  items_hash = {}
  items.each do |item|
    days = value_for_item item
    (items_hash[days] ||= []) << item if days.positive?
  end
  items_hash
end

#label_for_item(item, hint:) ⇒ Object

Raises:

  • (NotImplementedError) 


113
114
115
 
# File 'lib/jirametrics/time_based_histogram.rb', line 113

def label_for_item item, hint:
  raise NotImplementedError, "#{self.class} must implement label_for_item"
end

#percentiles(percs = nil) ⇒ Object 



17
18
19
20
 
# File 'lib/jirametrics/time_based_histogram.rb', line 17

def percentiles percs = nil
  @percentiles = percs unless percs.nil?
  @percentiles
end

#run ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/jirametrics/time_based_histogram.rb', line 26

def run
  histogram_items = all_items
  rules_to_items = group_issues histogram_items

  the_stats = {}

  overall_histogram = histogram_data_for(items: histogram_items).transform_values(&:size)
  the_stats[:all] = stats_for histogram_data: overall_histogram, percentiles: @percentiles
  data_sets = rules_to_items.keys.collect do |rules|
    the_label = rules.label
    the_histogram = histogram_data_for(items: rules_to_items[rules])
    if @show_stats
      the_stats[the_label] = stats_for(
        histogram_data: the_histogram.transform_values(&:size), percentiles: @percentiles
      )
    end

    data_set_for(
      histogram_data: the_histogram,
      label: the_label,
      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__)
end

#sort_items(items) ⇒ Object 



109
110
111
 
# File 'lib/jirametrics/time_based_histogram.rb', line 109

def sort_items items
  items
end

#stats_for(histogram_data:, percentiles:) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/jirametrics/time_based_histogram.rb', line 67

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
  }
end