jirametrics 2.12pre9 → 2.12pre12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2e99113dff452fc39af119d35fe1b480ef991dba7ef3ef8c3335bf471fed9d8
-  data.tar.gz: e05ad4ed94cb690856293244e23f28d1007fdb1b608820bcfee40aa082232722
+  metadata.gz: c113cc459acf750ccafa11aa97aaeaa799f3a23b4867df0e21503af9fdb18038
+  data.tar.gz: 4a204e05b0e5c61d011c8005d5a82011ce280afa45e76cef5cea9844bde71915
 SHA512:
-  metadata.gz: 0ece3dea23ac0f9141342ae2be782dfcbf034b39db6fb6ec7cbe28d8afe85865e41906083e9fbf587ed2de4aba9f6efa586a26f6899faa00a890505f5602e125
-  data.tar.gz: 7fac5a0b4fdbdda9808febf6b6f3043dcdf0965a3613145458cc3fb8c88cb3c0872e370fac12c0b0c50642172caebcb9c1b932252eb78de313c1fbbe14656de8
+  metadata.gz: 2a1d16a963187788e906a6010642a4361e968ab127b12421a31753cf68f6399d99c418152e9ead9d4bd2887b40a6333f2a049fcd4c164734319d275f78d8e5e2
+  data.tar.gz: a376ba351aac4f70383a6401df5b48c8637a6b68cfe26b35a3eca2016abb7b7c3cea813c2b246b59574efc2b44a7da97bc05e7402e9250fe47027bcfd263bf52

data/lib/jirametrics/aging_work_table.rb

@@ -181,4 +181,8 @@ class AgingWorkTable < ChartBase
 
     result.reverse
   end
+
+  def priority_text issue
+    "<img src='#{issue.priority_url}' title='Priority: #{issue.priority_name}' />"
+  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
   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,7 +17,14 @@ class ChangeItem
     @old_value = @raw['fromString']
     @old_value_id = @raw['from']&.to_i
     @artificial = artificial
-    @author = author
+  end
+
+  def author
+    @author_raw&.[]('displayName') || @author_raw&.[]('name') || 'Unknown author'
+  end
+
+  def author_icon_url
+    @author_raw&.[]('avatarUrls')&.[]('16x16')
   end
 
   def status? = (field == 'status')
@@ -35,6 +43,8 @@ class ChangeItem
 
   def labels? = (field == 'labels')
 
+  def comment? = (field == 'comment')
+
   # An alias for time so that logic accepting a Time, Date, or ChangeItem can all respond to :to_time
   def to_time = @time
 

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,190 @@
+# 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)
+    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
+
+    blocked_stalled = issue.blocked_stalled_by_date(
+      date_range: today..today, chart_end_time: time_range.end, settings: settings
+    )[today]
+
+    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_stats_lines issue
+    lines = []
+
+    title_line = +''
+    title_line << color_block('--expedited-color', title: 'Expedited') if issue.expedited?
+    title_line << "<img src='#{issue.type_icon_url}' title='#{issue.type}' class='icon' /> "
+    title_line << "<b><a href='#{issue.url}'>#{issue.key}</a></b> <i>#{issue.summary}</i>"
+    lines << [title_line]
+
+    chunks = []
+
+    chunks << "<img src='#{issue.priority_url}' class='icon' /> <b>#{issue.priority_name}</b>"
+
+    age = issue.board.cycletime.age(issue, today: date_range.end)
+    chunks << "Age: <b>#{label_days age}</b>" if age
+
+    chunks << "Status: <b>#{issue.status.name}</b>"
+
+    column = issue.board.visible_columns.find { |c| c.status_ids.include?(issue.status.id) }
+    chunks << "Column: <b>#{column&.name || '(not visible on board)'}</b>"
+
+    if issue.assigned_to
+      chunks << "Who: <img src='#{issue.assigned_to_icon_url}' class='icon' /> <b>#{issue.assigned_to}</b>"
+    end
+
+    chunks << "Due: <b>#{issue.due_date}</b>" if issue.due_date
+    lines << chunks
+
+    lines
+  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>')
+  end
+
+  def make_comment_lines issue
+    comments = issue.changes.select { |i| i.comment? }.reverse
+    lines = []
+    return lines if comments.empty?
+
+    lines << ['Comments']
+    comments.each do |c|
+      text = jira_rich_text_to_html c.value
+      time = c.time.strftime '%b %d, %I:%M%P'
+
+      lines << [
+        "<div class='comment'>" \
+        "<img src='#{c.author_icon_url}' class='icon' title='#{c.author}' /> " \
+        "<span class='header' title='Timestamp: #{c.time}'>#{time}</span> " \
+        " &rarr; #{text}</div>"
+      ]
+    end
+    lines
+  end
+
+  def assemble_issue_lines issue
+    lines = []
+    lines += make_stats_lines(issue)
+    lines += make_blocked_stalled_lines(issue)
+    lines += make_child_lines(issue)
+    lines += make_comment_lines(issue)
+    lines
+  end
+
+  def render_issue issue, css_class: 'daily_issue'
+    result = +''
+    result << "<div class='#{css_class}'>"
+    assemble_issue_lines(issue).each do |row|
+      if row.is_a? Issue
+        result << render_issue(row, css_class: 'child_issue')
+      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/examples/standard_project.rb

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

data/lib/jirametrics/file_system.rb

@@ -52,8 +52,6 @@ class FileSystem
   # In some Jira instances, a sizeable portion of the JSON is made up of empty fields. I've seen
   # cases where this simple compression will drop the filesize by half.
   def compress node
-    return node
-
     if node.is_a? Hash
       node.reject! { |_key, value| value.nil? || (value.is_a?(Array) && value.empty?) }
       node.each_value { |value| compress value }

data/lib/jirametrics/html/aging_work_table.erb

@@ -4,6 +4,7 @@
       <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>
@@ -29,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)' %>

data/lib/jirametrics/html/index.css

@@ -67,6 +67,9 @@
   --sprint-burndown-sprint-color-4: red;
   --sprint-burndown-sprint-color-5: brown;
 
+  --daily-view-selected-issue-background: lightgray;
+  --daily-view-issue-border: green;
+  --daily-view-selected-issue-border: red;
 
 }
 
@@ -142,6 +145,44 @@ ul.quality_report {
   border-top: 1px solid gray;
 }
 
+div.daily_issue:hover {
+  background: var(--daily-view-selected-issue-background);
+  border-color: var(--daily-view-selected-issue-border);
+}
+
+div.daily_issue {
+  border: 1px solid var(--daily-view-issue-border);
+  padding: 0.5em;
+  .heading {
+    vertical-align: middle;
+    display: flex;
+    gap: 0.5em;
+    align-items: center;
+  }
+  .comment {
+    margin-left: 1em;
+    padding-left: 2em;
+    text-indent: -2em;
+    .time {
+      font-size: 0.8em;
+    }
+  }
+  .icon {
+    width: 1em;
+    height: 1em;
+  }
+  margin-bottom: 0.5em;
+}
+div.child_issue:hover {
+  background: var(--body-background);
+}
+div.child_issue {
+  border: 1px dashed green;
+  margin: 0.2em;
+  margin-left: 1.5em;
+  padding: 0.5em;
+}
+
 @media screen and (prefers-color-scheme: dark) {
   :root {
     --warning-banner: #9F2B00;
@@ -174,6 +215,8 @@ ul.quality_report {
     --wip-chart-duration-two-weeks-or-less-color: #cf9400;
     --wip-chart-duration-four-weeks-or-less-color: #c25e00;
     --wip-chart-duration-more-than-four-weeks-color: #8e0000;
+
+    --daily-view-selected-issue-background: #474747;
   }
 
   h1 {

data/lib/jirametrics/html_report_config.rb

@@ -33,6 +33,7 @@ class HtmlReportConfig
   define_chart name: 'estimate_accuracy_chart', classname: 'EstimateAccuracyChart'
   define_chart name: 'hierarchy_table', classname: 'HierarchyTable'
   define_chart name: 'flow_efficiency_scatterplot', classname: 'FlowEfficiencyScatterplot'
+  define_chart name: 'daily_view', classname: 'DailyView'
 
   define_chart name: 'daily_wip_by_type', classname: 'DailyWipChart',
     deprecated_warning: 'This is the same as daily_wip_chart. Please use that one', deprecated_date: '2024-05-23'

data/lib/jirametrics/issue.rb

@@ -44,9 +44,11 @@ class Issue
   def key = @raw['key']
 
   def type = @raw['fields']['issuetype']['name']
-
   def type_icon_url = @raw['fields']['issuetype']['iconUrl']
 
+  def priority_name = @raw['fields']['priority']['name']
+  def priority_url = @raw['fields']['priority']['iconUrl']
+
   def summary = @raw['fields']['summary']
 
   def labels = @raw['fields']['labels'] || []
@@ -205,6 +207,10 @@ class Issue
     nil
   end
 
+  def first_time_visible_on_board
+    first_time_in_status(*board.visible_columns.collect(&:status_ids).flatten)
+  end
+
   def parse_time text
     Time.parse(text).getlocal(@timezone_offset)
   end
@@ -230,6 +236,10 @@ class Issue
     @raw['fields']&.[]('assignee')&.[]('displayName')
   end
 
+  def assigned_to_icon_url
+    @raw['fields']&.[]('assignee')&.[]('avatarUrls')&.[]('16x16')
+  end
+
   # Many test failures are simply unreadable because the default inspect on this class goes
   # on for pages. Shorten it up.
   def inspect
@@ -315,7 +325,7 @@ class Issue
 
     # This mock change is to force the writing of one last entry at the end of the time range.
     # By doing this, we're able to eliminate a lot of duplicated code in charts.
-    mock_change = ChangeItem.new time: end_time, author: '', artificial: true, raw: { 'field' => '' }
+    mock_change = ChangeItem.new time: end_time, artificial: true, raw: { 'field' => '' }, author_raw: nil
 
     (changes + [mock_change]).each do |change|
       previous_was_active = false if check_for_stalled(
@@ -580,7 +590,7 @@ class Issue
     /(?<project_code1>[^-]+)-(?<id1>.+)/ =~ key
     /(?<project_code2>[^-]+)-(?<id2>.+)/ =~ other.key
     comparison = project_code1 <=> project_code2
-    comparison = id1 <=> id2 if comparison.zero?
+    comparison = id1.to_i <=> id2.to_i if comparison.zero?
     comparison
   end
 
@@ -687,32 +697,25 @@ class Issue
 
   private
 
-  def assemble_author raw
-    raw['author']&.[]('displayName') || raw['author']&.[]('name') || 'Unknown author'
-  end
-
   def load_history_into_changes
     @raw['changelog']['histories']&.each do |history|
       created = parse_time(history['created'])
 
-      # It should be impossible to not have an author but we've seen it in production
-      author = assemble_author history
       history['items']&.each do |item|
-        @changes << ChangeItem.new(raw: item, time: created, author: author)
+        @changes << ChangeItem.new(raw: item, time: created, author_raw: history['author'])
       end
     end
   end
 
   def load_comments_into_changes
     @raw['fields']['comment']['comments']&.each do |comment|
-      raw = {
+      raw = comment.merge({
         'field' => 'comment',
         'to' => comment['id'],
         'toString' =>  comment['body']
-      }
-      author = assemble_author comment
+      })
       created = parse_time(comment['created'])
-      @changes << ChangeItem.new(raw: raw, time: created, author: author, artificial: true)
+      @changes << ChangeItem.new(raw: raw, time: created, artificial: true, author_raw: comment['author'])
     end
   end
 
@@ -754,7 +757,9 @@ class Issue
       first_status = first_change.old_value
       first_status_id = first_change.old_value_id
     end
-    ChangeItem.new time: created_time, artificial: true, author: author, raw: {
+
+    creator = raw['fields']['creator']
+    ChangeItem.new time: created_time, artificial: true, author_raw: creator, raw: {
       'field' => field_name,
       'to' => first_status_id,
       'toString' => first_status

data/lib/jirametrics/jira_gateway.rb

@@ -26,7 +26,10 @@ class JiraGateway
   end
 
   def call_command command
-    @file_system.log "  #{command.gsub(/\s+/, ' ')}"
+    log_entry = "  #{command.gsub(/\s+/, ' ')}"
+    log_entry = log_entry.gsub(@jira_api_token, '[API_TOKEN]') if @jira_api_token
+    @file_system.log log_entry
+
     result = `#{command}`
     @file_system.log result unless $CHILD_STATUS.success?
     return result if $CHILD_STATUS.success?

data/lib/jirametrics/settings.json

@@ -6,5 +6,6 @@
   "blocked_statuses": [],
   "flagged_means_blocked": true,
 
-  "expedited_priority_names": ["Critical", "Highest"]
+  "expedited_priority_names": ["Critical", "Highest"],
+  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"]
 }

data/lib/jirametrics.rb

@@ -114,6 +114,7 @@ class JiraMetrics < Thor
     require 'jirametrics/hierarchy_table'
     require 'jirametrics/estimation_configuration'
     require 'jirametrics/board'
+    require 'jirametrics/daily_view'
     load config_file
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.12pre9
+  version: 2.12pre12
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -77,6 +77,7 @@ files:
 - lib/jirametrics/cycletime_config.rb
 - lib/jirametrics/cycletime_histogram.rb
 - lib/jirametrics/cycletime_scatterplot.rb
+- lib/jirametrics/daily_view.rb
 - lib/jirametrics/daily_wip_by_age_chart.rb
 - lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb
 - lib/jirametrics/daily_wip_by_parent_chart.rb