Class: EstimateAccuracyChart

Inherits:
ChartBase show all
Defined in:
lib/jirametrics/estimate_accuracy_chart.rb

Instance Attribute Summary

Attributes inherited from ChartBase

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

Instance Method Summary collapse

Methods inherited from ChartBase

#aggregated_project?, #canvas, #canvas_responsive?, #chart_format, #collapsible_issues_panel, #color_block, #color_for, #completed_issues_in_range, #current_board, #daily_chart_dataset, #describe_non_working_days, #description_text, #format_integer, #format_status, #header_text, #holidays, #html_directory, #icon_span, #label_days, #label_issues, #link_to_issue, #next_id, #random_color, #render, #render_top_text, #status_category_color, #working_days_annotation, #wrap_and_render

Constructor Details

#initialize(configuration_block) ⇒ EstimateAccuracyChart 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 4

def initialize configuration_block
  super()

  header_text 'Estimate Accuracy'
  description_text "    <div class=\"p\">\n      This chart graphs estimates against actual recorded cycle times. Since\n      estimates can change over time, we're graphing the estimate at the time that the story started.\n    </div>\n    <div class=\"p\">\n      The \#{color_block '--estimate-accuracy-chart-completed-fill-color'} completed dots indicate\n      cycletimes.\n      <% if @has_aging_data %>\n        The \#{color_block '--estimate-accuracy-chart-active-fill-color'} aging dots\n        (click on the legend to turn them on) show the current\n        age of items, which will give you a hint as to where they might end up. If they're already\n        far to the right then you know you have a problem.\n      <% end %>\n    </div>\n  HTML\n\n  @y_axis_type = 'linear'\n  @y_axis_block = ->(issue, start_time) { estimate_at(issue: issue, start_time: start_time)&.to_f }\n  @y_axis_sort_order = nil\n\n  instance_eval(&configuration_block)\nend\n"

Instance Method Details

#estimate_at(issue:, start_time:, estimation_configuration: current_board.estimation_configuration) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 149

def estimate_at issue:, start_time:, estimation_configuration: current_board.estimation_configuration
  estimate = nil

  issue.changes.each do |change|
    return estimate if change.time >= start_time

    if change.field == estimation_configuration.display_name || change.field == estimation_configuration.field_id
      estimate = change.value
      estimate = estimate.to_f / (24 * 60 * 60) if estimation_configuration.units == :seconds
    end
  end
  estimate
end

#estimate_label(estimate:, estimation_units:) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 88

def estimate_label estimate:, estimation_units:
  if @y_axis_type == 'linear'
    if estimation_units == :story_points
      estimate_label = "#{estimate}pts"
    elsif estimation_units == :seconds
      estimate_label = label_days estimate
    end
  end
  estimate_label = estimate.to_s if estimate_label.nil?
  estimate_label
end

#hash_sorter ⇒ Object 



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 124

def hash_sorter
  lambda do |arg1, arg2|
    estimate1 = arg1[0][0]
    estimate2 = arg2[0][0]
    sample_count1 = arg1.size
    sample_count2 = arg2.size

    if @y_axis_sort_order
      index1 = @y_axis_sort_order.index estimate1
      index2 = @y_axis_sort_order.index estimate2

      if index1.nil?
        comparison = 1
      elsif index2.nil?
        comparison = -1
      else
        comparison = index1 <=> index2
      end
      return comparison unless comparison.zero?
    end

    sample_count2 <=> sample_count1
  end
end

#run ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 32

def run
  if @y_axis_label.nil?
    text = current_board.estimation_configuration.units == :story_points ? 'Story Points' : 'Days'
    @y_axis_label = "Estimated #{text}"
  end
  data_sets = scan_issues

  return '' if data_sets.empty?

  wrap_and_render(binding, __FILE__)
end

#scan_issues ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 44

def scan_issues
  completed_hash, aging_hash = split_into_completed_and_aging issues: issues

  estimation_units = current_board.estimation_configuration.units
  @has_aging_data = !aging_hash.empty?

  [
    [completed_hash, 'Completed', 'completed', false],
    [aging_hash, 'Still in progress', 'active', true]
  ].filter_map do |hash, label, completed_or_active, starts_hidden|
    fill_color = CssVariable["--estimate-accuracy-chart-#{completed_or_active}-fill-color"]
    border_color = CssVariable["--estimate-accuracy-chart-#{completed_or_active}-border-color"]

    # We sort so that the smaller circles are in front of the bigger circles.
    data = hash.sort(&hash_sorter).collect do |key, values|
      estimate, cycle_time = *key

      title = [
        "Estimate: #{estimate_label(estimate: estimate, estimation_units: estimation_units)}, " \
          "Cycletime: #{label_days(cycle_time)}, " \
          "#{values.size} issues"
      ] + values.collect { |issue| "#{issue.key}: #{issue.summary}" }

      {
        'x' => cycle_time,
        'y' => estimate,
        'r' => values.size * 2,
        'title' => title
      }
    end
    next if data.empty?

    {
      'label' => label,
      'data' => data,
      'fill' => false,
      'showLine' => false,
      'backgroundColor' => fill_color,
      'borderColor' => border_color,
      'hidden' => starts_hidden
    }
  end
end

#split_into_completed_and_aging(issues:) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 100

def split_into_completed_and_aging issues:
  aging_hash = {}
  completed_hash = {}

  issues.each do |issue|
    cycletime = issue.board.cycletime
    start_time, stop_time = cycletime.started_stopped_times(issue)

    next unless start_time

    hash = stop_time ? completed_hash : aging_hash

    estimate = @y_axis_block.call issue, start_time
    cycle_time = ((stop_time&.to_date || date_range.end) - start_time.to_date).to_i + 1

    next if estimate.nil?

    key = [estimate, cycle_time]
    (hash[key] ||= []) << issue
  end

  [completed_hash, aging_hash]
end

#y_axis(label:, sort_order: nil, &block) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/jirametrics/estimate_accuracy_chart.rb', line 163

def y_axis label:, sort_order: nil, &block
  @y_axis_sort_order = sort_order
  @y_axis_label = label
  if sort_order
    @y_axis_type = 'category'
  else
    @y_axis_type = 'linear'
  end
  @y_axis_block = block
end