jirametrics 1.0.0

data/lib/jirametrics/columns_config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'jirametrics/self_or_issue_dispatcher'
+
+class ColumnsConfig
+  include SelfOrIssueDispatcher
+
+  attr_reader :columns, :file_config
+
+  def initialize file_config:, block:
+    @columns = []
+    @file_config = file_config
+    @block = block
+  end
+
+  def run
+    instance_eval(&@block)
+  end
+
+  def write_headers headers = nil
+    @write_headers = headers unless headers.nil?
+    @write_headers
+  end
+
+  def date label, proc
+    @columns << [:date, label, proc]
+  end
+
+  def datetime label, proc
+    @columns << [:datetime, label, proc]
+  end
+
+  def string label, proc
+    @columns << [:string, label, proc]
+  end
+
+  def column_entry_times board_id: nil
+    @file_config.project_config.find_board_by_id(board_id).visible_columns.each do |column|
+      date column.name, first_time_in_status(*column.status_ids)
+    end
+  end
+end

data/lib/jirametrics/cycletime_config.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'jirametrics/self_or_issue_dispatcher'
+require 'date'
+
+class CycleTimeConfig
+  include SelfOrIssueDispatcher
+
+  attr_reader :label, :parent_config
+
+  def initialize parent_config:, label:, block:, today: Date.today
+    @parent_config = parent_config
+    @label = label
+    @today = today
+    instance_eval(&block) unless block.nil?
+  end
+
+  def start_at block = nil
+    @start_at = block unless block.nil?
+    @start_at
+  end
+
+  def stop_at block = nil
+    @stop_at = block unless block.nil?
+    @stop_at
+  end
+
+  def in_progress? issue
+    started_time(issue) && stopped_time(issue).nil?
+  end
+
+  def done? issue
+    stopped_time(issue)
+  end
+
+  def started_time issue
+    @start_at.call(issue)
+  end
+
+  def stopped_time issue
+    @stop_at.call(issue)
+  end
+
+  def cycletime issue
+    start = started_time(issue)
+    stop = stopped_time(issue)
+    return nil if start.nil? || stop.nil?
+
+    (stop.to_date - start.to_date).to_i + 1
+  end
+
+  def age issue, today: nil
+    start = started_time(issue)
+    stop = today || @today || Date.today
+    return nil if start.nil? || stop.nil?
+
+    (stop.to_date - start.to_date).to_i + 1
+  end
+
+  def possible_statuses
+    if parent_config.is_a? BoardConfig
+      project_config = parent_config.project_config
+    else
+      # TODO: This will go away when cycletimes are no longer supported inside html_reports
+      project_config = parent_config.file_config.project_config
+    end
+    project_config.possible_statuses
+  end
+end

data/lib/jirametrics/cycletime_histogram.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'jirametrics/groupable_issue_chart'
+
+class CycletimeHistogram < ChartBase
+  include GroupableIssueChart
+  attr_accessor :possible_statuses
+
+  def initialize block = nil
+    super()
+
+    header_text 'Cycletime Histogram'
+    description_text <<-HTML
+      <p>
+        The Cycletime Histogram shows how many items 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.
+      </p>
+    HTML
+
+    init_configuration_block(block) do
+      grouping_rules do |issue, rule|
+        rule.label = issue.type
+        rule.color = color_for type: issue.type
+      end
+    end
+  end
+
+  def run
+    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_time(issue) }
+    rules_to_issues = group_issues histogram_issues
+
+    data_sets = rules_to_issues.keys.collect do |rules|
+      data_set_for(
+        histogram_data: histogram_data_for(issues: rules_to_issues[rules]),
+        label: rules.label,
+        color: rules.color
+      )
+    end
+
+    wrap_and_render(binding, __FILE__)
+  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
+  end
+
+  def data_set_for histogram_data:, label:, color:
+    keys = histogram_data.keys.sort
+    {
+      type: 'bar',
+      label: label,
+      data: keys.sort.collect do |key|
+        next if histogram_data[key].zero?
+
+        {
+          x: key,
+          y: histogram_data[key],
+          title: "#{histogram_data[key]} items completed in #{label_days key}"
+        }
+      end.compact,
+      backgroundColor: color,
+      borderRadius: 0
+    }
+  end
+end

data/lib/jirametrics/cycletime_scatterplot.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'jirametrics/groupable_issue_chart'
+
+class CycletimeScatterplot < ChartBase
+  include GroupableIssueChart
+
+  attr_accessor :possible_statuses
+
+  def initialize block = nil
+    super()
+
+    header_text 'Cycletime Scatterplot'
+    description_text <<-HTML
+      <p>
+        This chart shows only completed work and indicates both what day it completed as well as
+        how many days it took to get done. Hovering over a dot will show you the ID of the work item.
+      </p>
+      <p>
+        The gray line indicates the 85th percentile (<%= overall_percent_line %> days). 85% of all
+        items on this chart fall on or below the line and the remaining 15% are above the line. 85%
+        is a reasonable proxy for "most" so that we can say that based on this data set, we can
+        predict that most work of this type will complete in <%= overall_percent_line %> days or
+        less. The other lines reflect the 85% line for that respective type of work.
+      </p>
+      <p>
+        The gray vertical bars indicate weekends, when theoretically we aren't working.
+      </p>
+    HTML
+
+    init_configuration_block block do
+      grouping_rules do |issue, rule|
+        rule.label = issue.type
+        rule.color = color_for type: issue.type
+      end
+    end
+
+    @percentage_lines = []
+    @highest_cycletime = 0
+  end
+
+  def run
+    completed_issues = completed_issues_in_range include_unstarted: false
+
+    data_sets = create_datasets completed_issues
+    overall_percent_line = calculate_percent_line(completed_issues)
+    @percentage_lines << [overall_percent_line, 'gray']
+
+    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 completed_issues
+    data_sets = []
+
+    groups = group_issues completed_issues
+
+    groups.each_key do |rules|
+      completed_issues_by_type = groups[rules]
+      label = rules.label
+      color = rules.color
+      percent_line = calculate_percent_line completed_issues_by_type
+      data = completed_issues_by_type.collect { |issue| data_for_issue(issue) }.compact
+      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
+  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_cycletime
+    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 issue
+    cycle_time = issue.board.cycletime.cycletime(issue)
+    return nil if cycle_time < 1 # These will get called out on the quality report
+
+    @highest_cycletime = cycle_time if @highest_cycletime < cycle_time
+
+    {
+      y: cycle_time,
+      x: chart_format(issue.board.cycletime.stopped_time(issue)),
+      title: ["#{issue.key} : #{issue.summary} (#{label_days(cycle_time)})"]
+    }
+  end
+
+  def calculate_percent_line completed_issues
+    times = completed_issues.collect { |issue| issue.board.cycletime.cycletime(issue) }
+    index = times.size * 85 / 100
+    times.sort[index]
+  end
+end

data/lib/jirametrics/daily_wip_by_age_chart.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'jirametrics/daily_wip_chart'
+
+class DailyWipByAgeChart < DailyWipChart
+  def default_header_text
+    'Daily WIP grouped by Age'
+  end
+
+  def default_description_text
+    <<-HTML
+      <p>
+        This chart shows the highest WIP on each given day. The WIP is color coded so you can see
+        how old it is and hovering over the bar will show you exactly which work items it relates
+        to. The green bar underneath, shows how many items completed on that day.
+      </p>
+      <p>
+        "Completed without being started" reflects the fact that while we know that it completed
+        that day, we were unable to determine when it had started. These items will show up in
+        white at the top. Note that the white is approximate because we don't know exactly when
+        it started so we're guessing.
+      </p>
+    HTML
+  end
+
+  def default_grouping_rules issue:, rules:
+    cycletime = issue.board.cycletime
+    started = cycletime.started_time(issue)&.to_date
+    stopped = cycletime.stopped_time(issue)&.to_date
+
+    rules.issue_hint = "(age: #{label_days (rules.current_date - started + 1).to_i})" if started
+
+    if stopped && started.nil? # We can't tell when it started
+      not_started stopped: stopped, rules: rules, created: issue.created.to_date
+    elsif stopped == rules.current_date
+      stopped_today rules: rules
+    else
+      group_by_age started: started, rules: rules
+    end
+  end
+
+  def not_started stopped:, rules:, created:
+    if stopped == rules.current_date
+      rules.label = 'Completed but not started'
+      rules.color = '#66FF66'
+      rules.group_priority = -1
+    else
+      rules.label = 'Start date unknown'
+      rules.color = 'white'
+      rules.group_priority = 11
+      created_days = rules.current_date - created + 1
+      rules.issue_hint = "(created: #{label_days created_days.to_i} earlier, stopped on #{stopped})"
+    end
+  end
+
+  def stopped_today rules:
+    rules.label = 'Completed'
+    rules.color = '#009900'
+    rules.group_priority = -2
+  end
+
+  def group_by_age started:, rules:
+    age = rules.current_date - started + 1
+
+    case age
+    when 1
+      rules.label = 'Less than a day'
+      rules.color = '#aaaaaa'
+      rules.group_priority = 10 # Highest is top
+    when 2..7
+      rules.label = 'A week or less'
+      rules.color = '#80bfff'
+      rules.group_priority = 9
+    when 8..14
+      rules.label = 'Two weeks or less'
+      rules.color = '#ffd700'
+      rules.group_priority = 8
+    when 15..28
+      rules.label = 'Four weeks or less'
+      rules.color = '#ce6300'
+      rules.group_priority = 7
+    else
+      rules.label = 'More than four weeks'
+      rules.color = '#990000'
+      rules.group_priority = 6
+    end
+  end
+end

data/lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'jirametrics/daily_wip_chart'
+
+class DailyWipByBlockedStalledChart < DailyWipChart
+  def default_header_text
+    'Daily WIP, grouped by Blocked and Stalled statuses'
+  end
+
+  def default_description_text
+    <<-HTML
+      <p>
+        This chart highlights work that is blocked or stalled on each given day. In Jira terms, blocked
+        means that the issue has been "flagged". Stalled indicates that the item hasn't had any updates in 5 days.
+      </p>
+      <p>
+        Note that if an item tracks as both blocked and stalled, it will only show up in the flagged totals.
+        It will not be double counted.
+      </p>
+      <p>
+        The white section reflects items that have stopped but for which we can't identify the start date. As
+        a result, we are unable to properly show the WIP for these items.
+      </p>
+    HTML
+  end
+
+  def key_blocked_stalled_change issue:, date:, end_time:
+    stalled_change = nil
+    blocked_change = nil
+
+    issue.blocked_stalled_changes_on_date(date: date, end_time: end_time) do |change|
+      blocked_change = change if change.blocked?
+      stalled_change = change if change.stalled?
+    end
+
+    return blocked_change if blocked_change
+    return stalled_change if stalled_change
+
+    nil
+  end
+
+  def default_grouping_rules issue:, rules:
+    started = issue.board.cycletime.started_time(issue)
+    stopped_date = issue.board.cycletime.stopped_time(issue)&.to_date
+    change = key_blocked_stalled_change issue: issue, date: rules.current_date, end_time: time_range.end
+
+    stopped_today = stopped_date == rules.current_date
+
+    if stopped_today && started.nil?
+      rules.label = 'Completed but not started'
+      rules.color = '#66FF66'
+      rules.group_priority = -1
+    elsif stopped_today
+      rules.label = 'Completed'
+      rules.color = '#009900'
+      rules.group_priority = -2
+    elsif started.nil?
+      rules.label = 'Start date unknown'
+      rules.color = 'white'
+      rules.group_priority = 4
+    elsif change&.blocked?
+      rules.label = 'Blocked'
+      rules.color = 'red'
+      rules.group_priority = 1
+      rules.issue_hint = "(#{change.reasons})"
+    elsif change&.stalled?
+      rules.label = 'Stalled'
+      rules.color = 'orange'
+      rules.group_priority = 2
+      rules.issue_hint = "(#{change.reasons})"
+    else
+      rules.label = 'Active'
+      rules.color = 'lightgray'
+      rules.group_priority = 3
+    end
+  end
+end

data/lib/jirametrics/daily_wip_chart.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'jirametrics/chart_base'
+
+class DailyGroupingRules < GroupingRules
+  attr_accessor :current_date, :group_priority, :issue_hint
+
+  def initialize
+    super()
+    @group_priority = 0
+  end
+end
+
+class DailyWipChart < ChartBase
+  attr_accessor :possible_statuses
+
+  def initialize block = nil
+    super()
+
+    header_text default_header_text
+    description_text default_description_text
+
+    if block
+      instance_eval(&block)
+    else
+      grouping_rules do |issue, rules|
+        default_grouping_rules issue: issue, rules: rules
+      end
+    end
+  end
+
+  def run
+    issue_rules_by_active_date = group_issues_by_active_dates
+    possible_rules = select_possible_rules issue_rules_by_active_date
+
+    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
+    end
+
+    wrap_and_render(binding, __FILE__)
+  end
+
+  def default_header_text = 'Daily WIP'
+  def default_description_text = ''
+
+  def default_grouping_rules issue:, rules: # rubocop:disable Lint/UnusedMethodArgument
+    raise 'If you use this class directly then you must provide grouping_rules'
+  end
+
+  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|
+        possible_rules << rules unless possible_rules.any? { |r| r.group == rules.group }
+      end
+    end
+    possible_rules.sort_by!(&:group_priority)
+  end
+
+  def group_issues_by_active_dates
+    hash = {}
+
+    @issues.each do |issue|
+      cycletime = issue.board.cycletime
+      start = cycletime.started_time(issue)&.to_date
+      stop = cycletime.stopped_time(issue)&.to_date
+      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
+
+  def make_data_set grouping_rule:, issue_rules_by_active_date:
+    positive = grouping_rule.group_priority >= 0
+
+    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
+
+      {
+        x: date,
+        y: positive ? issue_strings.size : -issue_strings.size,
+        title: title
+      }
+    end
+
+    {
+      type: 'bar',
+      label: grouping_rule.label,
+      data: data,
+      backgroundColor: grouping_rule.color || random_color,
+      borderColor: 'gray',
+      borderWidth: grouping_rule.color == 'white' ? 1 : 0,
+      borderRadius: positive ? 0 : 5
+    }
+  end
+
+  def configure_rule issue:, date:
+    raise '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
+
+  def grouping_rules &block
+    @group_by_block = block
+  end
+end