jirametrics 2.10 → 2.12.1

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,277 @@
+# 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 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 jira_rich_text_to_html text
+    text
+      .gsub(/{color:(#\w{6})}([^{]+){color}/, '<span style="color: \1">\2</span>') # Colours
+      .gsub(/\[~accountid:([^\]]+)\]/) { expand_account_id $1 } # Tagged people
+      .gsub(/\[([^\|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
+      .gsub("\n", '<br />')
+  end
+
+  def expand_account_id account_id
+    user = @users.find { |u| u.account_id == account_id }
+    text = account_id
+    text = "@#{user.display_name}" if user
+    "<span class='account_id'>#{text}</span>"
+  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?
+      jira_rich_text_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 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_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
@@ -147,6 +148,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

data/lib/jirametrics/estimate_accuracy_chart.rb

@@ -22,15 +22,18 @@ class EstimateAccuracyChart < ChartBase
       </div>
     HTML
 
-    @y_axis_label = 'Story Point Estimates'
     @y_axis_type = 'linear'
-    @y_axis_block = ->(issue, start_time) { story_points_at(issue: issue, start_time: start_time)&.to_f }
+    @y_axis_block = ->(issue, start_time) { estimate_at(issue: issue, start_time: start_time)&.to_f }
     @y_axis_sort_order = nil
 
     instance_eval(&configuration_block)
   end
 
   def run
+    if @y_axis_label.nil?
+      text = current_board.estimation_configuration.units == :story_points ? 'Story Points' : 'Days'
+      @y_axis_label = "Estimated #{text}"
+    end
     data_sets = scan_issues
 
     return '' if data_sets.empty?
@@ -41,6 +44,7 @@ class EstimateAccuracyChart < ChartBase
   def scan_issues
     completed_hash, aging_hash = split_into_completed_and_aging issues: issues
 
+    estimation_units = current_board.estimation_configuration.units
     @has_aging_data = !aging_hash.empty?
 
     [
@@ -53,9 +57,13 @@ class EstimateAccuracyChart < ChartBase
       # We sort so that the smaller circles are in front of the bigger circles.
       data = hash.sort(&hash_sorter).collect do |key, values|
         estimate, cycle_time = *key
-        estimate_label = "#{estimate}#{'pts' if @y_axis_type == 'linear'}"
-        title = ["Estimate: #{estimate_label}, Cycletime: #{label_days(cycle_time)}, #{values.size} issues"] +
-          values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
+        title = [
+          "Estimate: #{estimate_label(estimate: estimate, estimation_units: estimation_units)}, " \
+            "Cycletime: #{label_days(cycle_time)}, " \
+            "#{values.size} issues"
+        ] + values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
         {
           'x' => cycle_time,
           'y' => estimate,
@@ -77,6 +85,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
+  def estimate_label estimate:, estimation_units:
+    if @y_axis_type == 'linear'
+      if estimation_units == :story_points
+        estimate_label = "#{estimate}pts"
+      elsif estimation_units == :seconds
+        estimate_label = label_days estimate
+      end
+    end
+    estimate_label = estimate.to_s if estimate_label.nil?
+    estimate_label
+  end
+
   def split_into_completed_and_aging issues:
     aging_hash = {}
     completed_hash = {}
@@ -126,14 +146,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
-  def story_points_at issue:, start_time:
-    story_points = nil
+  def estimate_at issue:, start_time:, estimation_configuration: current_board.estimation_configuration
+    estimate = nil
+
     issue.changes.each do |change|
-      return story_points if change.time >= start_time
+      return estimate if change.time >= start_time
 
-      story_points = change.value if change.story_points?
+      if change.field == estimation_configuration.display_name || change.field == estimation_configuration.field_id
+        estimate = change.value
+        estimate = estimate.to_f / (24 * 60 * 60) if estimation_configuration.units == :seconds
+      end
     end
-    story_points
+    estimate
   end
 
   def y_axis label:, sort_order: nil, &block

data/lib/jirametrics/estimation_configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class EstimationConfiguration
+  attr_reader :units, :display_name, :field_id
+
+  def initialize raw:
+    @units = :story_points
+    @display_name = 'Story Points'
+
+    # If there wasn't an estimation section they rely on all defaults
+    return if raw.nil?
+
+    if raw['type'] == 'field'
+      @field_id = raw['field']['fieldId']
+      @display_name = raw['field']['displayName']
+      if @field_id == 'timeoriginalestimate'
+        @units = :seconds
+        @display_name = 'Original estimate'
+      end
+    elsif raw['type'] == 'issueCount'
+      @display_name = 'Issue Count'
+      @units = :issue_count
+    end
+  end
+end

data/lib/jirametrics/examples/standard_project.rb

@@ -58,6 +58,8 @@ class Exporter
                  type: :header
           end
 
+          daily_view
+
           cycletime_scatterplot do
             show_trend_lines
           end

data/lib/jirametrics/exporter.rb

@@ -79,8 +79,8 @@ class Exporter
       file_system.log "No issues found to match #{keys.collect(&:inspect).join(', ')}"
     else
       selected.each do |project, issue|
-        file_system.log "\nProject #{project.name}"
-        file_system.log issue.dump
+        file_system.log "\nProject #{project.name}", also_write_to_stderr: true
+        file_system.log issue.dump, also_write_to_stderr: true
       end
     end
   end

data/lib/jirametrics/file_config.rb

@@ -13,7 +13,7 @@ class FileConfig
   end
 
   def run
-    @issues = project_config.issues.dup
+    @issues = project_config.issues
     instance_eval(&@block)
 
     if @columns

data/lib/jirametrics/flow_efficiency_scatterplot.rb

@@ -27,7 +27,7 @@ class FlowEfficiencyScatterplot < ChartBase
           </mfrac>
         </math>
       </div>
-      <div style="background: yellow">Note that for this calculation to be accurate, we must be moving items into a
+      <div style="background: var(--warning-banner)">Note that for this calculation to be accurate, we must be moving items into a
         blocked or stalled state the moment we stop working on it, and most teams don't do that.
         So be aware that your team may have to change their behaviours if you want this chart to be useful.
       </div>

data/lib/jirametrics/html/aging_work_in_progress_chart.erb

@@ -6,7 +6,7 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
 {
   type: 'bar',
   data: {
-    labels: [<%= column_headings.collect(&:inspect).join(',') %>],
+    labels: [<%= @board_columns.collect { |c| c.name.inspect }.join(',') %>],
     datasets: <%= JSON.generate(data_sets) %>
   },
   options: {
@@ -22,8 +22,10 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
           labelString: 'Date Completed'
         },
         grid: {
-          color: <%= CssVariable['--grid-line-color'].to_json %>
+          color: <%= CssVariable['--grid-line-color'].to_json %>,
+          z: 1 // draw the grid lines on top of the bars
         },
+        stacked: true
       },
       y: {
         scaleLabel: {
@@ -35,8 +37,11 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
           text: 'Age in days'
         },
         grid: {
-          color: <%= CssVariable['--grid-line-color'].to_json %>
+          color: <%= CssVariable['--grid-line-color'].to_json %>,
+          z: 1 // draw the grid lines on top of the bars
         },
+        stacked: true,
+        max: <%= (@max_age * 1.1).to_i %>
       }
     },
     plugins: {
@@ -44,14 +49,26 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
         callbacks: {
           label: function(context) {
             if( typeof(context.dataset.data[context.dataIndex]) == "number" ) {
-              return "85% of the issues, leave this column in "+context.dataset.data[context.dataIndex]+" days";
+              let full_data = <%= @bar_data.inspect %>;
+              let columnIndex = context.dataIndex;
+              let rowIndex = context.datasetIndex - <%= @row_index_offset %>;
+              return context.dataset.label + " of completed work items left this column in " +full_data[rowIndex][columnIndex] + " days or less";
             }
             else {
-              return context.dataset.data[context.dataIndex].title
+              return context.dataset.data[context.dataIndex].title;
             }
           }
         }
+      },
+      legend: {
+        labels: {
+          filter: function(item, chart) {
+            // Logic to remove a particular legend item goes here
+            return !item.text.includes('%');
+          }
+        }
       }
+
     }
   }
 });

data/lib/jirametrics/html/aging_work_table.erb

@@ -1,11 +1,13 @@
 <table class='standard'>
   <thead>
     <tr>
-      <th>Age (days)</th>
-      <th>E</th>
-      <th>B</th>
+      <th title="Age in days">Age</th>
+      <th title="Expedited">E</th>
+      <th title="Blocked / Stalled">B/S</th>
+      <th title="Priority">P</th>
       <th>Issue</th>
       <th>Status</th>
+      <th>Forecast</th>
       <th>Fix versions</th>
       <% if any_scrum_boards %>
         <th>Sprints</th>
@@ -28,6 +30,7 @@
         <td style="text-align: right;"><%= issue_age || 'Not started' %></td>
         <td><%= expedited_text(issue) %></td>
         <td><%= blocked_text(issue) %></td>
+        <td><%= priority_text(issue) %></td>
         <td>
           <% parent_hierarchy(issue).each_with_index do |parent, index| %>
             <% color = parent != issue ? "var(--hierarchy-table-inactive-item-text-color)" : 'var(--default-text-color)' %>
@@ -41,6 +44,7 @@
           <% end %>
         </td>
         <td><%= format_status issue.status, board: issue.board %></td>
+        <td><%= dates_text(issue) %></td>
         <td><%= fix_versions_text(issue) %></td>
         <% if any_scrum_boards %>
           <td><%= sprints_text(issue) %></td>