Class: DailyWipChart

Inherits:
ChartBase show all
Defined in:
lib/jirametrics/daily_wip_chart.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 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) ⇒ DailyWipChart

Returns a new instance of DailyWipChart.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 21

def initialize block
  super()

  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

  return if @group_by_block

  grouping_rules do |issue, rules|
    default_grouping_rules issue: issue, rules: rules
  end
end

Instance Attribute Details

#possible_statuses ⇒ Object

Returns the value of attribute possible_statuses.



19
20
21
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 19

def possible_statuses
  @possible_statuses
end

Instance Method Details

#add_trend_line(group_labels:, line_color:) ⇒ Object 



149
150
151
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 149

def add_trend_line group_labels:, line_color:
  (@trend_lines ||= []) << [group_labels, line_color]
end

#configure_rule(issue:, date:) ⇒ Object 



136
137
138
139
140
141
142
143
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 136

def configure_rule issue:, date:
  raise "#{self.class}: grouping_rules must be set" if @group_by_block.nil?

  rules = DailyGroupingRules.new
  rules.current_date = date
  @group_by_block.call issue, rules
  rules
end

#default_description_text ⇒ Object 



62
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 62

def default_description_text = ''

#default_grouping_rules(issue:, rules:) ⇒ Object

rubocop:disable Lint/UnusedMethodArgument



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

def default_grouping_rules issue:, rules: # rubocop:disable Lint/UnusedMethodArgument
  raise 'If you use this class directly then you must provide grouping_rules'
end

#default_header_text ⇒ Object 



61
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 61

def default_header_text = 'Daily WIP'

#group_issues_by_active_dates ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 78

def group_issues_by_active_dates
  hash = {}

  @issues.each do |issue|
    start, stop = cycletime_for_issue(issue).started_stopped_dates(issue)
    next if start.nil? && stop.nil?

    # If it stopped but never started then assume it started at creation so the data points
    # will be available for the config.
    start = issue.created.to_date if stop && start.nil?
    start = @date_range.begin if start < @date_range.begin

    start.upto(stop || @date_range.end) do |date|
      rule = configure_rule issue: issue, date: date
      (hash[date] ||= []) << [issue, rule] unless rule.ignored?
    end
  end
  hash
end

#grouping_rules(&block) ⇒ Object 



145
146
147
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 145

def grouping_rules &block
  @group_by_block = block
end

#make_data_set(grouping_rule:, issue_rules_by_active_date:, label_suffix: '') ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 98

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|
    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_label = grouping_rule.label_hint || display_label
    title = ["#{title_label} (#{label_issues issue_strings.size})"] + issue_strings

    {
      x: date,
      y: positive ? issue_strings.size : -issue_strings.size,
      title: title
    }
  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: display_label,
    label_hint: grouping_rule.label_hint,
    data: data,
    backgroundColor: background_color,
    borderColor: CssVariable['--wip-chart-border-color'],
    borderWidth: grouping_rule.color.to_s == 'var(--body-background)' ? 1 : 0,
    borderRadius: positive ? 0 : 5
  }
end

#run ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 38

def run
  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|
    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|
      trend_line_data_set(data: data_sets, group_labels: group_labels, color: line_color)
    end + data_sets
  end

  wrap_and_render(binding, __FILE__)
end

#select_possible_rules(issue_rules_by_active_date) ⇒ Object 



68
69
70
71
72
73
74
75
76
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 68

def select_possible_rules issue_rules_by_active_date
  possible_rules = []
  issue_rules_by_active_date.each_pair do |_date, issues_rules_list|
    issues_rules_list.each do |_issue, rules| # rubocop:disable Style/HashEachMethods
      possible_rules << rules unless possible_rules.any? { |r| r.group == rules.group }
    end
  end
  possible_rules.sort_by!(&:group_priority)
end

#trend_line_data_set(data:, group_labels:, color:) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/jirametrics/daily_wip_chart.rb', line 153

def trend_line_data_set data:, group_labels:, color:
  day_wip_hash = {}
  data.each do |top_level|
    next unless group_labels.include? top_level[:label]

    top_level[:data].each do |datapoint|
      date = datapoint[:x]
      day_wip_hash[date] = (day_wip_hash[date] || 0) + datapoint[:y]
    end
  end

  points = day_wip_hash
    .collect { |date, wip| [date.jd, wip] }
    .sort_by(&:first)

  calculator = TrendLineCalculator.new(points)
  return nil unless calculator.valid?

  data_points = calculator.chart_datapoints(
    range: date_range.begin.jd..date_range.end.jd,
    max_y: points.collect { |_date, wip| wip }.max
  )
  data_points.each do |point_hash|
    point_hash[:x] = chart_format Date.jd(point_hash[:x])
  end

  {
    type: 'line',
    label: 'Trendline',
    data: data_points,
    fill: false,
    borderWidth: 1,
    markerType: 'none',
    borderColor: CssVariable[color],
    borderDash: [6, 3],
    pointStyle: 'dash',
    hidden: false
  }
end