jirametrics 2.10 → 2.13

data/lib/jirametrics/board_movement_calculator.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+class BoardMovementCalculator
+  attr_reader :board, :issues, :today
+
+  def initialize board:, issues:, today:
+    @board = board
+    @issues = issues.select { |issue| issue.board == board && issue.done? && !moves_backwards?(issue) }
+    @today = today
+  end
+
+  def moves_backwards? issue
+    started, stopped = issue.board.cycletime.started_stopped_times(issue)
+    return false unless started
+
+    previous_column = nil
+    issue.status_changes.each do |change|
+      column = board.visible_columns.index { |c| c.status_ids.include?(change.value_id) }
+      next if change.time < started
+      next if column.nil? # It disappeared from the board for a bit
+      return true if previous_column && column && column < previous_column
+
+      previous_column = column
+    end
+    false
+  end
+
+  def stacked_age_data_for percentages:
+    data_list = percentages.sort.collect do |percentage|
+      [percentage, age_data_for(percentage: percentage)]
+    end
+
+    stack_data data_list
+  end
+
+  def stack_data data_list
+    remainder = nil
+    data_list.collect do |percentage, data|
+      unless remainder.nil?
+        data = (0...data.length).collect do |i|
+          data[i] - remainder[i]
+        end
+
+      end
+      remainder = data
+
+      [percentage, data]
+    end
+  end
+
+  def age_data_for percentage:
+    data = []
+    board.visible_columns.each_with_index do |_column, column_index|
+      ages = ages_of_issues_when_leaving_column column_index: column_index, today: today
+
+      if ages.empty?
+        data << 0
+      else
+        index = ((ages.size - 1) * percentage / 100).to_i
+        data << ages[index]
+      end
+    end
+    data
+  end
+
+  def ages_of_issues_when_leaving_column column_index:, today:
+    this_column = board.visible_columns[column_index]
+    next_column = board.visible_columns[column_index + 1]
+
+    @issues.filter_map do |issue|
+      this_column_start = issue.first_time_in_or_right_of_column(this_column.name)&.time
+      next_column_start = next_column.nil? ? nil : issue.first_time_in_or_right_of_column(next_column.name)&.time
+      issue_start, issue_done = issue.board.cycletime.started_stopped_times(issue)
+
+      # Skip if we can't tell when it started.
+      next if issue_start.nil?
+
+      # Skip if it never entered this column
+      next if this_column_start.nil?
+
+      # Skip if it left this column before the item is considered started.
+      next 0 if next_column_start && next_column_start <= issue_start
+
+      # Skip if it was already done by the time it got to this column or it became done when it got to this column
+      next if issue_done && issue_done <= this_column_start
+
+      end_date = case # rubocop:disable Style/EmptyCaseCondition
+      when next_column_start.nil?
+        # If this is the last column then base age against today
+        today
+      when issue_done && issue_done < next_column_start
+        # it completed while in this column
+        issue_done.to_date
+      else
+        # It passed through this whole column
+        next_column_start.to_date
+      end
+      (end_date - issue_start.to_date).to_i + 1
+    end.sort
+  end
+
+  # Figure out what column this is issue is currently in and what time it entered that column. We need this for
+  # aging and forecasting purposes
+  def find_current_column_and_entry_time_in_column issue
+    column = board.visible_columns.find { |c| c.status_ids.include?(issue.status.id) }
+    return [] if column.nil? # This issue isn't visible on the board
+
+    status_ids = column.status_ids
+
+    entry_at = issue.changes.reverse.find { |change| change.status? && status_ids.include?(change.value_id) }&.time
+
+    [column.name, entry_at]
+  end
+
+  def label_days days
+    "#{days} day#{'s' unless days == 1}"
+  end
+
+  def forecasted_days_remaining_and_message issue:, today:
+    return [nil, 'Already done'] if issue.done?
+
+    likely_age_data = age_data_for percentage: 85
+
+    column_name, entry_time = find_current_column_and_entry_time_in_column issue
+    return [nil, 'This issue is not visible on the board. No way to predict when it will be done.'] if column_name.nil?
+
+    # This condition has been reported in production so we have a check for it. Having said that, we have no
+    # idea what conditions might make this possible and so there is no test for it.
+    if entry_time.nil?
+      message = "Unable to determine the time this issue entered column #{column_name.inspect} so no way to " \
+        'predict when it will be done'
+      return [nil, message]
+    end
+
+    age_in_column = (today - entry_time.to_date).to_i + 1
+
+    message = nil
+    column_index = board.visible_columns.index { |c| c.name == column_name }
+
+    last_non_zero_datapoint = likely_age_data.reverse.find { |d| !d.zero? }
+    return [nil, 'There is no historical data for this board. No forecast can be made.'] if last_non_zero_datapoint.nil?
+
+    remaining_in_current_column = likely_age_data[column_index] - age_in_column
+    if remaining_in_current_column.negative?
+      message = "This item is an outlier at #{label_days issue.board.cycletime.age(issue, today: today)} " \
+        "in the #{column_name.inspect} column. Most items on this board have left this column in " \
+        "#{label_days likely_age_data[column_index]} or less, so we cannot forecast when it will be done."
+      remaining_in_current_column = 0
+      return [nil, message]
+    end
+
+    forecasted_days = last_non_zero_datapoint - likely_age_data[column_index] + remaining_in_current_column
+    [forecasted_days, message]
+  end
+end

data/lib/jirametrics/change_item.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 class ChangeItem
-  attr_reader :field, :value_id, :old_value_id, :raw, :author, :time
+  attr_reader :field, :value_id, :old_value_id, :raw, :time, :author_raw
   attr_accessor :value, :old_value
 
-  def initialize raw:, time:, author:, artificial: false
+  def initialize raw:, author_raw:, time:, artificial: false
     @raw = raw
+    @author_raw = author_raw
     @time = time
     raise 'ChangeItem.new() time cannot be nil' if time.nil?
     raise "Time must be an object of type Time in the correct timezone: #{@time.inspect}" unless @time.is_a? Time
@@ -16,33 +17,43 @@ class ChangeItem
     @old_value = @raw['fromString']
     @old_value_id = @raw['from']&.to_i
     @artificial = artificial
-    @author = author
   end
 
-  def status? = (field == 'status')
+  def author
+    @author_raw&.[]('displayName') || @author_raw&.[]('name') || 'Unknown author'
+  end
 
-  def flagged? = (field == 'Flagged')
+  def author_icon_url
+    @author_raw&.[]('avatarUrls')&.[]('16x16')
+  end
 
+  def artificial? = @artificial
+  def assignee? = (field == 'assignee')
+  def comment? = (field == 'comment')
+  def description? = (field == 'description')
+  def due_date? = (field == 'duedate')
+  def flagged? = (field == 'Flagged')
+  def issue_type? = field == 'issuetype'
+  def labels? = (field == 'labels')
+  def link? = (field == 'Link')
   def priority? = (field == 'priority')
-
   def resolution? = (field == 'resolution')
-
-  def artificial? = @artificial
-
   def sprint? = (field == 'Sprint')
-
-  def story_points? = (field == 'Story Points')
-
-  def link? = (field == 'Link')
-
-  def labels? = (field == 'labels')
+  def status? = (field == 'status')
 
   # An alias for time so that logic accepting a Time, Date, or ChangeItem can all respond to :to_time
   def to_time = @time
 
   def to_s
     message = +''
-    message << "ChangeItem(field: #{field.inspect}, value: #{value.inspect}, time: #{time_to_s(@time).inspect}"
+    message << "ChangeItem(field: #{field.inspect}"
+    message << ", value: #{value.inspect}"
+    message << ':' << value_id.inspect if status?
+    if old_value
+      message << ", old_value: #{old_value.inspect}"
+      message << ':' << old_value_id.inspect if status?
+    end
+    message << ", time: #{time_to_s(@time).inspect}"
     message << ', artificial' if artificial?
     message << ')'
     message
@@ -84,6 +95,17 @@ class ChangeItem
     end
   end
 
+  def field_as_human_readable
+    case @field
+    when 'duedate' then 'Due date'
+    when 'timeestimate' then 'Time estimate'
+    when 'timeoriginalestimate' then 'Time original estimate'
+    when 'issuetype' then 'Issue type'
+    when 'IssueParentAssociation' then 'Issue parent association'
+    else @field.capitalize
+    end
+  end
+
   private
 
   def time_to_s time

data/lib/jirametrics/chart_base.rb

@@ -2,7 +2,7 @@
 
 class ChartBase
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
-    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system
+    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system, :users
   attr_writer :aggregated_project
   attr_reader :canvas_width, :canvas_height
 
@@ -38,7 +38,6 @@ class ChartBase
     # Insert a incrementing chart_id so that all the chart names on the page are unique
     caller_binding.eval "chart_id='chart#{next_id}'" # chart_id=chart3
 
-    # @html_directory = "#{pathname.dirname}/html"
     erb = ERB.new file_system.load "#{html_directory}/#{$1}.erb"
     erb.result(caller_binding)
   end
@@ -227,8 +226,8 @@ class ChartBase
         icon: ' 👀'
       )
     end
-    text = is_category ? status.category.name : status.name
-    "<span title='Category: #{status.category.name}'>#{color_block color.name} #{text}</span>#{visibility}"
+    text = is_category ? status.category : status
+    "<span title='Category: #{status.category}'>#{color_block color.name} #{text}</span>#{visibility}"
   end
 
   def icon_span title:, icon:
@@ -260,7 +259,10 @@ class ChartBase
 
   def color_block color, title: nil
     result = +''
-    result << "<div class='color_block' style='background: var(#{color});'"
+    result << "<div class='color_block' style='"
+    result << "background: #{CssVariable[color]};" if color
+    result << 'visibility: hidden;' unless color
+    result << "'"
     result << " title=#{title.inspect}" if title
     result << '></div>'
     result

data/lib/jirametrics/css_variable.rb

@@ -4,7 +4,7 @@ class CssVariable
   attr_reader :name
 
   def self.[](name)
-    if name.start_with? '--'
+    if name.is_a?(String) && name.start_with?('--')
       CssVariable.new name
     else
       name

data/lib/jirametrics/cycletime_config.rb

@@ -59,7 +59,7 @@ class CycleTimeConfig
       'from' => '0',
       'fromString' => ''
     }
-    ChangeItem.new raw: raw, time: time, author: 'unknown', artificial: true
+    ChangeItem.new raw: raw, time: time, artificial: true, author_raw: nil
   end
 
   def started_stopped_changes issue

data/lib/jirametrics/daily_view.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+class DailyView < ChartBase
+  attr_accessor :possible_statuses
+
+  def initialize _block
+    super()
+
+    header_text 'Daily View'
+    description_text <<-HTML
+      <div class="p">
+        This view shows all the items you'll want to discuss during your daily coordination meeting
+        (aka daily scrum, standup), in the order that you should be discussing them. The most important
+        items are at the top, and the least at the bottom.
+      </div>
+      <div class="p">
+        By default, we sort by priority first and then by age within each of those priorities.
+        Hover over the issue to make it stand out more.
+      </div>
+    HTML
+  end
+
+  def run
+    aging_issues = select_aging_issues
+
+    return "<h1>#{@header_text}</h1>There are no items currently in progress" if aging_issues.empty?
+
+    result = +''
+    result << render_top_text(binding)
+    aging_issues.each do |issue|
+      result << render_issue(issue, child: false)
+    end
+    result
+  end
+
+  def atlassian_document_format
+    @atlassian_document_format ||= AtlassianDocumentFormat.new(users: users, timezone_offset: timezone_offset)
+  end
+
+  def select_aging_issues
+    aging_issues = issues.select do |issue|
+      started_at, stopped_at = issue.board.cycletime.started_stopped_times(issue)
+      started_at && !stopped_at
+    end
+
+    today = date_range.end
+    aging_issues.collect do |issue|
+      [issue, issue.priority_name, issue.board.cycletime.age(issue, today: today)]
+    end.sort(&issue_sorter).collect(&:first)
+  end
+
+  def issue_sorter
+    priority_names = settings['priority_order']
+    lambda do |a, b|
+      a_issue, a_priority, a_age = *a
+      b_issue, b_priority, b_age = *b
+
+      a_priority_index = priority_names.index(a_priority)
+      b_priority_index = priority_names.index(b_priority)
+
+      if a_priority_index.nil? && b_priority_index.nil?
+        result = a_priority <=> b_priority
+      elsif a_priority_index.nil?
+        result = 1
+      elsif b_priority_index.nil?
+        result = -1
+      else
+        result = b_priority_index <=> a_priority_index
+      end
+
+      result = b_age <=> a_age if result.zero?
+      result = a_issue <=> b_issue if result.zero?
+      result
+    end
+  end
+
+  def make_blocked_stalled_lines issue
+    today = date_range.end
+    started_date = issue.board.cycletime.started_stopped_times(issue).first&.to_date
+    return [] unless started_date
+
+    blocked_stalled = issue.blocked_stalled_by_date(
+      date_range: today..today, chart_end_time: time_range.end, settings: settings
+    )[today]
+    return [] unless blocked_stalled
+
+    lines = []
+    if blocked_stalled.blocked?
+      marker = color_block '--blocked-color'
+      lines << ["#{marker} Blocked by flag"] if blocked_stalled.flag
+      lines << ["#{marker} Blocked by status: #{blocked_stalled.status}"] if blocked_stalled.blocked_by_status?
+      blocked_stalled.blocking_issue_keys&.each do |key|
+        lines << ["#{marker} Blocked by issue: #{key}"]
+        blocking_issue = issues.find { |i| i.key == key }
+        lines << blocking_issue if blocking_issue
+      end
+    elsif blocked_stalled.stalled_by_status?
+      lines << ["#{color_block '--stalled-color'} Stalled by status: #{blocked_stalled.status}"]
+    else
+      lines << ["#{color_block '--stalled-color'} Stalled by inactivity: #{blocked_stalled.stalled_days} days"]
+    end
+    lines
+  end
+
+  def make_issue_label issue
+    "<img src='#{issue.type_icon_url}' title='#{issue.type}' class='icon' /> " \
+      "<b><a href='#{issue.url}'>#{issue.key}</a></b> &nbsp;<i>#{issue.summary}</i>"
+  end
+
+  def make_title_line issue
+    title_line = +''
+    title_line << color_block('--expedited-color', title: 'Expedited') if issue.expedited?
+    title_line << make_issue_label(issue)
+    title_line
+  end
+
+  def make_parent_lines issue
+    lines = []
+    parent_key = issue.parent_key
+    if parent_key
+      parent = issues.find_by_key key: parent_key, include_hidden: true
+      text = parent ? make_issue_label(parent) : parent_key
+      lines << ["Parent: #{text}"]
+    end
+    lines
+  end
+
+  def make_stats_lines issue
+    line = []
+
+    line << "<img src='#{issue.priority_url}' class='icon' /> <b>#{issue.priority_name}</b>"
+
+    age = issue.board.cycletime.age(issue, today: date_range.end)
+    line << "Age: <b>#{age ? label_days(age) : '(Not Started)'}</b>"
+
+    line << "Status: <b>#{format_status issue.status, board: issue.board}</b>"
+
+    column = issue.board.visible_columns.find { |c| c.status_ids.include?(issue.status.id) }
+    line << "Column: <b>#{column&.name || '(not visible on board)'}</b>"
+
+    if issue.assigned_to
+      line << "Assignee: <img src='#{issue.assigned_to_icon_url}' class='icon' /> <b>#{issue.assigned_to}</b>"
+    end
+
+    line << "Due: <b>#{issue.due_date}</b>" if issue.due_date
+
+    block = lambda do |collection, label|
+      unless collection.empty?
+        text = collection.collect { |l| "<span class='label'>#{l}</span>" }.join(' ')
+        line << "#{label} #{text}"
+      end
+    end
+    block.call issue.labels, 'Labels:'
+    block.call issue.component_names, 'Components:'
+
+    [line]
+  end
+
+  def make_child_lines issue
+    lines = []
+    subtasks = issue.subtasks.reject { |i| i.done? }
+
+    unless subtasks.empty?
+      icon_urls = subtasks.collect(&:type_icon_url).uniq.collect { |url| "<img src='#{url}' class='icon' />" }
+      lines << (icon_urls << 'Incomplete child issues')
+      lines += subtasks
+    end
+    lines
+  end
+
+  def make_history_lines issue
+    history = issue.changes.reverse
+    lines = []
+
+    id = next_id
+    lines << [
+      "<a href=\"javascript:toggle_visibility('open#{id}', 'close#{id}', 'table#{id}');\">" \
+      "<span id='open#{id}'>▶ Issue History</span>" \
+      "<span id='close#{id}' style='display: none'>▼ Issue History</span></a>"
+    ]
+    table = +''
+    table << "<table id='table#{id}' style='display: none'>"
+    history.each do |c|
+      time = c.time.strftime '%b %d, %I:%M%P'
+
+      table << '<tr>'
+      table << "<td><span class='time' title='Timestamp: #{c.time}'>#{time}</span></td>"
+      table << "<td><img src='#{c.author_icon_url}' class='icon' title='#{c.author}' /></td>"
+      text = history_text change: c, board: issue.board
+      table << "<td><span class='field'>#{c.field_as_human_readable}</span> #{text}</td>"
+      table << '</tr>'
+    end
+    table << '</table>'
+    lines << [table]
+    lines
+  end
+
+  def history_text change:, board:
+    if change.comment? || change.description?
+      atlassian_document_format.to_html(change.value)
+    elsif change.status?
+      convertor = ->(id) { format_status(board.possible_statuses.find_by_id(id), board: board) }
+      to = convertor.call(change.value_id)
+      if change.old_value
+        from = convertor.call(change.old_value_id)
+        "Changed from #{from} to #{to}"
+      else
+        "Set to #{to}"
+      end
+    elsif %w[priority assignee duedate issuetype].include?(change.field)
+      "Changed from \"#{change.old_value}\" to \"#{change.value}\""
+    elsif change.flagged?
+      change.value == '' ? 'Off' : 'On'
+    else
+      change.value
+    end
+  end
+
+  def make_sprints_lines issue
+    return [] unless issue.board.scrum?
+
+    sprint_names = issue.sprints.collect do |sprint|
+      if sprint.closed?
+        "<s>#{sprint.name}</s>"
+      else
+        sprint.name
+      end
+    end
+
+    return [['Sprints: NONE']] if sprint_names.empty?
+
+    [[+'Sprints: ' << sprint_names
+      .collect { |name| "<span class='label'>#{name}</span>" }
+      .join(' ')]]
+  end
+
+  def make_description_lines issue
+    description = issue.raw['fields']['description']
+    result = []
+    result << [atlassian_document_format.to_html(description)] if description
+    result
+  end
+
+  def assemble_issue_lines issue, child:
+    lines = []
+    lines << [make_title_line(issue)]
+    lines += make_parent_lines(issue) unless child
+    lines += make_stats_lines(issue)
+    lines += make_description_lines(issue)
+    lines += make_sprints_lines(issue)
+    lines += make_blocked_stalled_lines(issue)
+    lines += make_child_lines(issue)
+    lines += make_history_lines(issue)
+    lines
+  end
+
+  def render_issue issue, child:
+    css_class = child ? 'child_issue' : 'daily_issue'
+    result = +''
+    result << "<div class='#{css_class}'>"
+    assemble_issue_lines(issue, child: child).each do |row|
+      if row.is_a? Issue
+        result << render_issue(row, child: true)
+      else
+        result << '<div class="heading">'
+        row.each do |chunk|
+          result << "<div>#{chunk}</div>"
+        end
+        result << '</div>'
+      end
+    end
+    result << '</div>'
+  end
+end

data/lib/jirametrics/downloader.rb

@@ -45,6 +45,7 @@ class Downloader
       board = download_board_configuration board_id: id
       download_issues board: board
     end
+    download_users
 
     save_metadata
   end
@@ -96,30 +97,59 @@ class Downloader
     log "  JQL: #{jql}"
     escaped_jql = CGI.escape jql
 
-    max_results = 100
-    start_at = 0
-    total = 1
-    while start_at < total
-      json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
-        "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
-
-      json['issues'].each do |issue_json|
-        issue_json['exporter'] = {
-          'in_initial_query' => initial_query
-        }
-        identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
-        file = "#{issue_json['key']}-#{board.id}.json"
-
-        @file_system.save_json(json: issue_json, filename: File.join(path, file))
-      end
+    if @jira_gateway.cloud?
+      max_results = 5_000 # The maximum allowed by Jira
+      next_page_token = nil
+      issue_count = 0
 
-      total = json['total'].to_i
-      max_results = json['maxResults']
+      loop do
+        json = @jira_gateway.call_url relative_url: '/rest/api/3/search/jql' \
+          "?jql=#{escaped_jql}&maxResults=#{max_results}&" \
+          "nextPageToken=#{next_page_token}&expand=changelog&fields=*all"
+        next_page_token = json['nextPageToken']
 
-      message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
-      log message, both: true
+        json['issues'].each do |issue_json|
+          issue_json['exporter'] = {
+            'in_initial_query' => initial_query
+          }
+          identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
+          file = "#{issue_json['key']}-#{board.id}.json"
 
-      start_at += json['issues'].size
+          @file_system.save_json(json: issue_json, filename: File.join(path, file))
+          issue_count += 1
+        end
+
+        message = "    Downloaded #{issue_count} issues"
+        log message, both: true
+
+        break unless next_page_token
+      end
+    else
+      max_results = 100
+      start_at = 0
+      total = 1
+      while start_at < total
+        json = @jira_gateway.call_url relative_url: '/rest/api/2/search' \
+          "?jql=#{escaped_jql}&maxResults=#{max_results}&startAt=#{start_at}&expand=changelog&fields=*all"
+
+        json['issues'].each do |issue_json|
+          issue_json['exporter'] = {
+            'in_initial_query' => initial_query
+          }
+          identify_other_issues_to_be_downloaded raw_issue: issue_json, board: board
+          file = "#{issue_json['key']}-#{board.id}.json"
+
+          @file_system.save_json(json: issue_json, filename: File.join(path, file))
+        end
+
+        total = json['total'].to_i
+        max_results = json['maxResults']
+
+        message = "    Downloaded #{start_at + 1}-#{[start_at + max_results, total].min} of #{total} issues to #{path} "
+        log message, both: true
+
+        start_at += json['issues'].size
+      end
     end
   end
 
@@ -147,6 +177,16 @@ class Downloader
     )
   end
 
+  def download_users
+    log '  Downloading all users', both: true
+    json = @jira_gateway.call_url relative_url: '/rest/api/2/users'
+
+    @file_system.save_json(
+      json: json,
+      filename: File.join(@target_path, "#{file_prefix}_users.json")
+    )
+  end
+
   def update_status_history_file
     status_filename = File.join(@target_path, "#{file_prefix}_statuses.json")
     return unless file_system.file_exist? status_filename