jirametrics 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0dbe04bbc480c61f2bb1d09cdab71e9ed47fb8265336b2a1f05551bff78dec17
+  data.tar.gz: 69c590731144d58f3235e72fb04f7d766b47a635c47301c5c87f1dbfc2cb13d5
+SHA512:
+  metadata.gz: 494a2760b3f32fab17432735527e20fdd60105ca670437bb6cf382bd2844d78313f985db7cf3e1534f5bc67f7f2def4d598a58d46009018d14dbbb0ab70e2ce2
+  data.tar.gz: c77baf2ff091972595cc126de4a03dea02f756b01db33cf90144583d65de81d07f5b37856a920d3870d72f4b7100709a243099e29fe79f78b52d96d207641545

data/bin/jirametrics

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'jirametrics'
+JiraMetrics.start(ARGV)

data/lib/jirametrics/aggregate_config.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'date'
+
+class AggregateConfig
+  attr_reader :project_config
+
+  def initialize project_config:, block:
+    @project_config = project_config
+    @block = block
+
+    @included_projects = []
+  end
+
+  def evaluate_next_level
+    instance_eval(&@block)
+
+    if @included_projects.empty?
+      raise "#{@project_config.name}: When aggregating, you must include at least one other project"
+    end
+
+    # If the date range wasn't set then calculate it now
+    @project_config.time_range = find_time_range projects: @included_projects if @project_config.time_range.nil?
+
+    adjust_issue_links
+  end
+
+  def adjust_issue_links
+    issues = @project_config.issues
+    issues.each do |issue|
+      issue.issue_links.each do |link|
+        other_issue_key = link.other_issue.key
+        other_issue = issues.find { |i| i.key == other_issue_key }
+
+        link.other_issue = other_issue if other_issue
+      end
+    end
+  end
+
+  def include_issues_from project_name
+    project = @project_config.exporter.project_configs.find { |p| p.name == project_name }
+    if project.nil?
+      puts "Warning: Aggregated project #{@project_config.name.inspect} is attempting to load " \
+        "project #{project_name.inspect} but it can't be found. Is it disabled?"
+      return
+    end
+
+    @project_config.jira_url = project.jira_url if @project_config.jira_url.nil?
+    unless @project_config.jira_url == project.jira_url
+      raise 'Not allowed to aggregate projects from different Jira instances: ' \
+        "#{@project_config.jira_url.inspect} and #{project.jira_url.inspect}"
+    end
+
+    @included_projects << project
+    @project_config.add_issues project.issues
+  end
+
+  def date_range range
+    @project_config.time_range = date_range_to_time_range(
+      date_range: range, timezone_offset: project_config.exporter.timezone_offset
+    )
+  end
+
+  def date_range_to_time_range date_range:, timezone_offset:
+    start_of_first_day = Time.new(
+      date_range.begin.year, date_range.begin.month, date_range.begin.day, 0, 0, 0, timezone_offset
+    )
+    end_of_last_day = Time.new(
+      date_range.end.year, date_range.end.month, date_range.end.day, 23, 59, 59, timezone_offset
+    )
+
+    start_of_first_day..end_of_last_day
+  end
+
+  def find_time_range projects:
+    raise "Can't calculate aggregated range as no projects were included." if projects.empty?
+
+    earliest = nil
+    latest = nil
+    projects.each do |project|
+      range = project.time_range
+      earliest = range.begin if earliest.nil? || range.begin < earliest
+      latest = range.end if latest.nil? || range.end > latest
+    end
+
+    raise "Can't calculate range" if earliest.nil? || latest.nil?
+    earliest..latest
+  end
+end

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+require 'jirametrics/chart_base'
+
+class AgingWorkBarChart < ChartBase
+  @@next_id = 0
+
+  def initialize block = nil
+    super()
+
+    header_text 'Aging Work Bar Chart'
+    description_text <<-HTML
+      <p>
+        This chart shows all active (started but not completed) work, ordered from oldest at the top to
+        newest at the bottom.
+      </p>
+      <p>
+        There are potentially three bars for each issue, although a bar may be missing if the issue has no
+        information relevant to that. Hovering over any of the bars will provide more details.
+        <ol><li>The top bar tells you what status the issue is in at any time. Any statuses in the status
+        category of "To Do" will be in blue. Any in the category of "In Progress" will be in a
+        yellow and any in "Done" will be green.</li>
+        <li>The middle bar indicates blocked and stalled states. A lighter orange is stalled and a darker,
+        reddish colour is blocked.</li>
+        <li>The bottom bar indicated an expedited state.</li></ol>
+      </p>
+      <p>
+        The gray backgrounds indicate weekends and the red vertical line indicates the 85% point for all
+        items in this time period. Anything that started to the left of that is now an outlier.
+      </p>
+    HTML
+
+    # Because this one will size itself as needed, we start with a smaller default size
+    @canvas_height = 80
+
+    instance_eval(&block) if block
+  end
+
+  def run
+    aging_issues = @issues.select do |issue|
+      cycletime = issue.board.cycletime
+      cycletime.started_time(issue) && cycletime.stopped_time(issue).nil?
+    end
+
+    grow_chart_height_if_too_many_issues aging_issues.size
+
+    today = date_range.end
+    aging_issues.sort! do |a, b|
+      a.board.cycletime.age(b, today: today) <=> b.board.cycletime.age(a, today: today)
+    end
+    data_sets = []
+    aging_issues.each do |issue|
+      cycletime = issue.board.cycletime
+      issue_start_time = cycletime.started_time(issue)
+      issue_start_date = issue_start_time.to_date
+      issue_label = "[#{label_days cycletime.age(issue, today: today)}] #{issue.key}: #{issue.summary}"[0..60]
+      [
+        status_data_sets(issue: issue, label: issue_label, today: today),
+        blocked_data_sets(
+          issue: issue,
+          issue_label: issue_label,
+          stack: 'blocked',
+          issue_start_time: issue_start_time
+        ),
+        data_set_by_block(
+          issue: issue,
+          issue_label: issue_label,
+          title_label: 'Expedited',
+          stack: 'expedited',
+          color: 'red',
+          start_date: issue_start_date
+        ) { |day| issue.expedited_on_date?(day) }
+      ].compact.flatten.each do |data|
+        data_sets << data
+      end
+    end
+
+    percentage = calculate_percent_line
+    percentage_line_x = date_range.end - calculate_percent_line if percentage
+
+    wrap_and_render(binding, __FILE__)
+  end
+
+  def grow_chart_height_if_too_many_issues aging_issue_count
+    px_per_bar = 8
+    bars_per_issue = 3
+    preferred_height = aging_issue_count * px_per_bar * bars_per_issue
+    @canvas_height = preferred_height if @canvas_height.nil? || @canvas_height < preferred_height
+  end
+
+  def status_data_sets issue:, label:, today:
+    cycletime = issue.board.cycletime
+
+    issue_started_time = cycletime.started_time(issue)
+
+    previous_start = nil
+    previous_status = nil
+
+    data_sets = []
+    issue.changes.each do |change|
+      next unless change.status?
+
+      status = issue.find_status_by_name change.value
+
+      unless previous_start.nil? || previous_start < issue_started_time
+        hash = {
+          type: 'bar',
+          data: [{
+            x: [chart_format(previous_start), chart_format(change.time)],
+            y: label,
+            title: "#{issue.type} : #{change.value}"
+          }],
+          backgroundColor: status_category_color(status),
+          borderColor: 'white',
+          borderWidth: {
+             top: 0,
+             right: 1,
+             bottom: 0,
+             left: 0
+          },
+          stacked: true,
+          stack: 'status'
+        }
+        data_sets << hash if date_range.include?(change.time.to_date)
+      end
+
+      previous_start = change.time
+      previous_status = status
+    end
+
+    if previous_start
+      data_sets << {
+        type: 'bar',
+        data: [{
+          x: [chart_format(previous_start), chart_format("#{today}T00:00:00#{@timezone_offset}")],
+          y: label,
+          title: "#{issue.type} : #{previous_status.name}"
+        }],
+        backgroundColor: status_category_color(previous_status),
+        stacked: true,
+        stack: 'status'
+      }
+    end
+
+    data_sets
+  end
+
+  def one_block_change_data_set starting_change:, ending_time:, issue_label:, stack:, issue_start_time:
+    color = settings['colors']['blocked']
+    color = settings['colors']['stalled'] if starting_change.stalled?
+    {
+      backgroundColor: color,
+      data: [
+        {
+          title: starting_change.reasons,
+          x: [chart_format([issue_start_time, starting_change.time].max), chart_format(ending_time)],
+          y: issue_label
+        }
+      ],
+      stack: stack,
+      stacked: true,
+      type: 'bar'
+    }
+  end
+
+  def blocked_data_sets issue:, issue_label:, issue_start_time:, stack:
+    data_sets = []
+    starting_change = nil
+
+    issue.blocked_stalled_changes(end_time: time_range.end).each do |change|
+      if starting_change.nil? || starting_change.active?
+        starting_change = change
+        next
+      end
+
+      if change.time >= issue_start_time
+        data_sets << one_block_change_data_set(
+          starting_change: starting_change, ending_time: change.time,
+          issue_label: issue_label, stack: stack, issue_start_time: issue_start_time
+        )
+      end
+
+      starting_change = change
+    end
+
+    data_sets
+  end
+
+  def data_set_by_block(
+    issue:, issue_label:, title_label:, stack:, color:, start_date:, end_date: date_range.end, &block
+  )
+    started = nil
+    ended = nil
+    data = []
+
+    (start_date..end_date).each do |day|
+      if block.call(day)
+        started = day if started.nil?
+        ended = day
+      elsif ended
+        data << {
+          x: [chart_format(started), chart_format(ended)],
+          y: issue_label,
+          title: "#{issue.type} : #{title_label} #{label_days (ended - started).to_i + 1}"
+        }
+
+        started = nil
+        ended = nil
+      end
+    end
+
+    if started
+      data << {
+        x: [chart_format(started), chart_format(ended)],
+        y: issue_label,
+        title: "#{issue.type} : #{title_label} #{label_days (end_date - started).to_i + 1}"
+      }
+    end
+
+    {
+      type: 'bar',
+      data: data,
+      backgroundColor: color,
+      stacked: true,
+      stack: stack
+    }
+  end
+
+  def calculate_percent_line percentage: 85
+    days = completed_issues_in_range.collect { |issue| issue.board.cycletime.cycletime(issue) }.compact.sort
+    return nil if days.empty?
+
+    days[days.length * percentage / 100]
+  end
+end

data/lib/jirametrics/aging_work_in_progress_chart.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require 'jirametrics/chart_base'
+require 'jirametrics/groupable_issue_chart'
+
+class AgingWorkInProgressChart < ChartBase
+  include GroupableIssueChart
+  attr_accessor :possible_statuses, :board_id
+  attr_reader :board_columns
+
+  def initialize block = nil
+    super()
+    header_text 'Aging Work in Progress'
+    description_text <<-HTML
+      <p>
+        This chart shows only work items that have started but not completed, grouped by the column
+      they're currently in. Hovering over a dot will show you the ID of that work item.
+      </p>
+      <p>
+        The gray area indicates the 85% mark for work items that have passed through here - 85% of
+        previous work items left this column while still inside the gray area. Any work items above
+        the gray area are outliers and they are the items that you should pay special attention to.
+      </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
+    determine_board_columns
+
+    @header_text += " on board: #{@all_boards[@board_id].name}"
+    data_sets = make_data_sets
+    column_headings = @board_columns.collect(&:name)
+
+    adjust_visibility_of_unmapped_status_column data_sets: data_sets, column_headings: column_headings
+
+    wrap_and_render(binding, __FILE__)
+  end
+
+  def determine_board_columns
+    unmapped_statuses = current_board.possible_statuses.collect(&:id)
+
+    columns = current_board.visible_columns
+    columns.each { |c| unmapped_statuses -= c.status_ids }
+
+    @fake_column = BoardColumn.new({
+      'name' => '[Unmapped Statuses]',
+      'statuses' => unmapped_statuses.collect { |id| { 'id' => id.to_s } }.uniq
+    })
+    @board_columns = columns + [@fake_column]
+  end
+
+  def make_data_sets
+    aging_issues = @issues.select do |issue|
+      board = issue.board
+      board.id == @board_id && board.cycletime.in_progress?(issue)
+    end
+
+    percentage = 85
+    rules_to_issues = group_issues aging_issues
+    data_sets = rules_to_issues.keys.collect do |rules|
+      {
+        'type' => 'line',
+        'label' => rules.label,
+        'data' => rules_to_issues[rules].collect do |issue|
+            age = issue.board.cycletime.age(issue, today: date_range.end)
+            column = column_for issue: issue
+            next if column.nil?
+
+            { 'y' => age,
+              'x' => column.name,
+              'title' => ["#{issue.key} : #{issue.summary} (#{label_days age})"]
+            }
+          end.compact,
+        'fill' => false,
+        'showLine' => false,
+        'backgroundColor' => rules.color
+      }
+    end
+    data_sets << {
+      'type' => 'bar',
+      'label' => "#{percentage}%",
+      'barPercentage' => 1.0,
+      'categoryPercentage' => 1.0,
+      'data' => days_at_percentage_threshold_for_all_columns(percentage: percentage, issues: @issues).drop(1)
+    }
+  end
+
+  def days_at_percentage_threshold_for_all_columns percentage:, issues:
+    accumulated_status_ids_per_column.collect do |_column, status_ids|
+      ages = ages_of_issues_that_crossed_column_boundary issues: issues, status_ids: status_ids
+      index = ages.size * percentage / 100
+      ages.sort[index.to_i] || 0
+    end
+  end
+
+  def accumulated_status_ids_per_column
+    accumulated_status_ids = []
+    @board_columns.reverse.collect do |column|
+      next if column == @fake_column
+
+      accumulated_status_ids += column.status_ids
+      [column.name, accumulated_status_ids.dup]
+    end.compact.reverse
+  end
+
+  def ages_of_issues_that_crossed_column_boundary issues:, status_ids:
+    issues.collect do |issue|
+      stop = issue.first_time_in_status(*status_ids)
+      start = issue.board.cycletime.started_time(issue)
+
+      # Skip if either it hasn't crossed the boundary or we can't tell when it started.
+      next if stop.nil? || start.nil?
+      next if stop < start
+
+      (stop.to_date - start.to_date).to_i + 1
+    end.compact
+  end
+
+  def column_for issue:
+    @board_columns.find do |board_column|
+      board_column.status_ids.include? issue.status.id
+    end
+  end
+
+  def adjust_visibility_of_unmapped_status_column data_sets:, column_headings:
+    column_name = @fake_column.name
+
+    has_unmapped = data_sets.any? do |set|
+      set['data'].any? do |data|
+        data['x'] == column_name if data.is_a? Hash
+      end
+    end
+
+    if has_unmapped
+      @description_text += "<p>The items shown in #{column_name.inspect} are not visible on the " \
+        'board but are still active. Most likely everyone has forgotten about them.</p>'
+    else
+      column_headings.pop
+      @board_columns.pop
+    end
+  end
+end

data/lib/jirametrics/aging_work_table.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'jirametrics/chart_base'
+
+class AgingWorkTable < ChartBase
+  attr_accessor :today, :board_id
+
+  def initialize block
+    super()
+    @blocked_icon = '🛑'
+    @expedited_icon = '🔥'
+    @stalled_icon = '🟧'
+    @stalled_threshold = 5
+    @dead_icon = '⬛'
+    @dead_threshold = 45
+    @age_cutoff = 0
+
+    instance_eval(&block) if block
+  end
+
+  def run
+    @today = date_range.end
+    aging_issues = select_aging_issues
+
+    expedited_but_not_started = @issues.select do |issue|
+      cycletime = issue.board.cycletime
+      cycletime.started_time(issue).nil? && cycletime.stopped_time(issue).nil? && issue.expedited?
+    end
+    aging_issues += expedited_but_not_started.sort_by(&:created)
+
+    render(binding, __FILE__)
+  end
+
+  def select_aging_issues
+    aging_issues = @issues.select do |issue|
+      cycletime = issue.board.cycletime
+      started = cycletime.started_time(issue)
+      stopped = cycletime.stopped_time(issue)
+      next false if started.nil? || stopped
+      next true if issue.blocked_on_date?(@today, end_time: time_range.end) || issue.expedited?
+
+      age = (@today - started.to_date).to_i + 1
+      age > @age_cutoff
+    end
+    @any_scrum_boards = aging_issues.any? { |issue| issue.board.scrum? }
+    aging_issues.sort { |a, b| b.board.cycletime.age(b, today: @today) <=> a.board.cycletime.age(a, today: @today) }
+  end
+
+  def icon_span title:, icon:
+    "<span title='#{title}' style='font-size: 0.8em;'>#{icon}</span>"
+  end
+
+  def expedited_text issue
+    return unless issue.expedited?
+
+    name = issue.raw['fields']['priority']['name']
+    icon_span(title: "Expedited: Has a priority of &quot;#{name}&quot;", icon: @expedited_icon)
+  end
+
+  def blocked_text issue
+    started_time = issue.board.cycletime.started_time(issue)
+    return nil if started_time.nil?
+
+    current = issue.blocked_stalled_changes(end_time: time_range.end)[-1]
+    if current.blocked?
+      icon_span title: current.reasons, icon: @blocked_icon
+    elsif current.stalled?
+      if current.stalled_days && current.stalled_days > @dead_threshold
+        icon_span(
+          title: "Dead? Hasn&apos;t had any activity in #{label_days current.stalled_days}. " \
+            'Does anyone still care about this?',
+          icon: @dead_icon
+        )
+      else
+        icon_span(
+          title: current.reasons,
+          icon: @stalled_icon
+        )
+      end
+    end
+  end
+
+  def unmapped_status_text issue
+    icon_span(
+      title: "The status #{issue.status.name.inspect} is not mapped to any column and will not be visible",
+      icon: ' ⁉️'
+    )
+  end
+
+  def fix_versions_text issue
+    issue.fix_versions.collect do |fix|
+      if fix.released?
+        icon_text = icon_span title: 'Released. Likely not on the board anymore.', icon: '✅'
+        "#{fix.name} #{icon_text}"
+      else
+        fix.name
+      end
+    end.join('<br />')
+  end
+
+  def sprints_text issue
+    sprint_ids = []
+
+    issue.changes.each do |change|
+      next unless change.sprint?
+
+      sprint_ids << change.raw['to'].split(/\s*,\s*/).collect { |id| id.to_i }
+    end
+    sprint_ids.flatten!
+
+    issue.board.sprints.select { |s| sprint_ids.include? s.id }.collect do |sprint|
+      icon_text = nil
+      if sprint.active?
+        icon_text = icon_span title: 'Active sprint', icon: '➡️'
+      else
+        icon_text = icon_span title: 'Sprint closed', icon: '✅'
+      end
+      "#{sprint.name} #{icon_text}"
+    end.join('<br />')
+  end
+
+  def current_status_visible? issue
+    issue.board.visible_columns.any? { |column| column.status_ids.include? issue.status.id }
+  end
+
+  def age_cutoff age = nil
+    @age_cutoff = age.to_i if age
+    @age_cutoff
+  end
+
+  def any_scrum_boards?
+    @any_scrum_boards
+  end
+
+  def parent_hierarchy issue
+    result = []
+
+    while issue
+      cyclical_parent_links = result.include? issue
+      result << issue
+
+      break if cyclical_parent_links
+
+      issue = issue.parent
+    end
+
+    result.reverse
+  end
+end