Class: PullRequestCycleTimeHistogram

Inherits:
TimeBasedHistogram show all
Defined in:
lib/jirametrics/pull_request_cycle_time_histogram.rb

Constant Summary

Constants inherited from ChartBase

ChartBase::LABEL_POSITIONS

Instance Attribute Summary

Attributes inherited from TimeBasedHistogram

#show_stats

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 inherited from TimeBasedHistogram

#data_set_for, #disable_stats, #histogram_data_for, #percentiles, #run, #stats_for

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(block) ⇒ PullRequestCycleTimeHistogram

Returns a new instance of PullRequestCycleTimeHistogram.



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 6

def initialize block
  super()

  @cycletime_unit = :days
  @x_axis_title = 'Cycle time in days'

  header_text 'PR Histogram'
  description_text <<-HTML
    <div class="p">
      This cycletime Histogram shows how many pull requests completed in a certain timeframe. This can be
      useful for determining how many different types of work are flowing through, based on the
      lengths of time they take.
    </div>
  HTML

  init_configuration_block(block) do
    grouping_rules do |pull_request, rule|
      rule.label = pull_request.repo
    end
  end
end

Instance Method Details

#all_items ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 37

def all_items
  result = []
  issues.each do |issue|
    next unless issue.github_prs

    issue.github_prs.each do |pr|
      next unless pr.closed_at

      result << pr
    end
  end
  result.uniq
end

#cycletime_unit(unit) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 28

def cycletime_unit unit
  unless %i[minutes hours days].include?(unit)
    raise ArgumentError, "cycletime_unit must be :minutes, :hours, or :days, got #{unit.inspect}"
  end

  @cycletime_unit = unit
  @x_axis_title = "Cycle time in #{unit}"
end

#label_cycletime(value) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 56

def label_cycletime value
  case @cycletime_unit
  when :minutes then label_minutes(value)
  when :hours then label_hours(value)
  when :days then label_days(value)
  end
end

#label_for_item(item, hint:) ⇒ Object 



72
73
74
75
76
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 72

def label_for_item item, hint:
  label = "#{item.number} #{item.title}"
  label << hint if hint
  label
end

#sort_items(items) ⇒ Object 



68
69
70
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 68

def sort_items items
  items.sort_by(&:opened_at)
end

#title_for_item(count:, value:) ⇒ Object 



64
65
66
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 64

def title_for_item count:, value:
  "#{count} PR#{'s' unless count == 1} closed in #{label_cycletime value}"
end

#value_for_item(item) ⇒ Object 



51
52
53
54
 
# File 'lib/jirametrics/pull_request_cycle_time_histogram.rb', line 51

def value_for_item item
  divisor = { minutes: 60.0, hours: 3600.0, days: 86_400.0 }[@cycletime_unit]
  ((item.closed_at - item.opened_at) / divisor).ceil
end