jirametrics 2.23 → 2.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2145950e91bf010e3c2790151b32f859fc479a871002f2057e2070ef23a6e1ae
-  data.tar.gz: 00bff5cffee6fc49862ae15fdc78f142982337a03abb4ea33735b07a2f0f3426
+  metadata.gz: 4ab33e299bd374f28754ecfbd750f6afd89861ecf64a323f28d4678d7a22959d
+  data.tar.gz: a0bf98e4d51b86eaa36aef8c6bfb69e8cdba958d3afeaf67da71a37ff6eb3ae5
 SHA512:
-  metadata.gz: d16248d2502890619c3da712ebb7f0b6aa864994013a599d29e6795f687ccbd782d9e7f33f253f7f5db81a3c78f1be0898bf27cd4e8a981137f0a3ca55da8c8f
-  data.tar.gz: ee3e5d4fdd783a025c9666a6080f587f82cd70f0fb6aeeda9a12a862c454baab64fb635bdf2727b821760e75822638378c87b18e59b68fa8903b3bd87a05f9f8
+  metadata.gz: 7c017b109ce143403190db03124148def9be7a92fe20961f6f7c42f459482a4056018601f131d6ca6275889e7231e54df54befbccb4279de0073838d50280ff4
+  data.tar.gz: 07b783818d028d3d95fd1cd861f272fe624c46fe3d4b671f3e2e6fede8fcdc694e5118da888c7c12113838e37711ccd6935a54261d4edf5ceaac4e29c6a08a73

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -15,7 +15,7 @@ class AgingWorkBarChart < ChartBase
         newest at the bottom.
       </p>
       <p>
-        There are three bars for each issue, and hovering over any of the bars will provide more details.
+        There are <%= current_board.scrum? ? 'four' : 'three' %> bars for each issue, and hovering over any of the bars will provide more details.
         <ol>
           <li>Status: The status the issue was in at any time. The colour indicates the
           status category, which will be one of #{color_block '--status-category-todo-color'} To Do,
@@ -25,6 +25,9 @@ class AgingWorkBarChart < ChartBase
           or #{color_block '--stalled-color'} stalled.</li>
           <li>Priority: This shows the priority over time. If one of these priorities is considered expedited
           then it will be drawn with diagonal lines.</li>
+          <% if current_board.scrum? %>
+            <li>Sprints: The sprints that the issue was in.</li>
+          <% end %>
         </ol>
       </p>
       #{describe_non_working_days}

data/lib/jirametrics/board.rb

@@ -4,19 +4,18 @@ class Board
   attr_reader :visible_columns, :raw, :possible_statuses, :sprints
   attr_accessor :cycletime, :project_config
 
-  def initialize raw:, possible_statuses:, features_raw: nil
+  def initialize raw:, possible_statuses:, features: []
     @raw = raw
     @possible_statuses = possible_statuses
     @sprints = []
-    @features_raw = features_raw
+    @features = features
 
     columns = raw['columnConfig']['columns']
     ensure_uniqueness_of_column_names! columns
 
-    # For a Kanban board, the first column here will always be called 'Backlog' and will NOT be
-    # visible on the board. If the board is configured to have a kanban backlog then it will have
-    # statuses matched to it and otherwise, there will be no statuses.
-    columns = columns.drop(1) if kanban?
+    # For a classic Kanban board (type 'kanban'), the first column will always be called 'Backlog'
+    # and will NOT be visible on the board. This does not apply to team-managed boards (type 'simple').
+    columns = columns.drop(1) if board_type == 'kanban'
 
     @backlog_statuses = []
     @visible_columns = columns.filter_map do |column|
@@ -26,7 +25,7 @@ class Board
   end
 
   def backlog_statuses
-    if @backlog_statuses.empty? && kanban?
+    if @backlog_statuses.empty? && board_type == 'kanban'
       status_ids = status_ids_from_column raw['columnConfig']['columns'].first
       @backlog_statuses = status_ids.filter_map do |id|
         @possible_statuses.find_by_id id
@@ -73,8 +72,7 @@ class Board
     return true if board_type == 'scrum'
     return false unless board_type == 'simple'
 
-    @features_raw&.[]('features')
-               &.any? { |f| f['feature'] == 'jsw.agility.sprints' && f['state'] == 'ENABLED' } || false
+    @features.any? { |f| f.name == 'jsw.agility.sprints' && f.enabled? }
   end
 
   def kanban?

data/lib/jirametrics/board_feature.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class BoardFeature
+  def initialize raw:
+    @raw = raw
+  end
+
+  def name = @raw['feature']
+  def enabled? = (@raw['state'] == 'ENABLED')
+
+  def self.from_raw features_json
+    features_json['features']&.map { |f| new(raw: f) } || []
+  end
+end

data/lib/jirametrics/chart_base.rb

@@ -305,6 +305,13 @@ class ChartBase
     "<span title='#{title}' style='font-size: 0.8em;'>#{icon}</span>"
   end
 
+  def not_visible_text issue
+    reasons = issue.reasons_not_visible_on_board
+    return nil if reasons.empty?
+
+    "<span style='background: var(--warning-banner)'>Not visible on board: #{reasons.join(', ')}</span>"
+  end
+
   def status_category_color status
     case status.category.key
     when 'new' then CssVariable['--status-category-todo-color']

data/lib/jirametrics/css_variable.rb

@@ -16,7 +16,7 @@ class CssVariable
   end
 
   def to_json(*_args)
-    "getComputedStyle(document.body).getPropertyValue('#{@name}')"
+    "getComputedStyle(document.documentElement).getPropertyValue('#{@name}').trim()"
   end
 
   def to_s

data/lib/jirametrics/daily_view.rb

@@ -9,7 +9,8 @@ class DailyView < ChartBase
     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
+        This view shows all the items (<%= aging_issues.count %>) 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>
@@ -86,9 +87,14 @@ class DailyView < ChartBase
       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
+        if blocking_issue
+          lines << "<section><div class=\"foldable startFolded\">#{marker} Blocked by issue: #{key}</div>"
+          lines << blocking_issue
+          lines << '</section>'
+        else
+          lines << ["#{marker} Blocked by issue: #{key}"]
+        end
       end
     elsif blocked_stalled.stalled_by_status?
       lines << ["#{color_block '--stalled-color'} Stalled by status: #{blocked_stalled.status}"]
@@ -146,7 +152,18 @@ class DailyView < ChartBase
       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
+    if issue.due_date
+      today = date_range.end
+      days = (issue.due_date - today).to_i
+      relative =
+        if days.zero? then 'today'
+        elsif days.positive? then "in #{label_days days}"
+        else "#{label_days(-days)} ago"
+        end
+      content = "#{issue.due_date} (#{relative})"
+      content = "<span style='background: var(--warning-banner)'>#{content}</span>" if days.negative?
+      line << "Due: <b>#{content}</b>"
+    end
 
     block = lambda do |collection, label|
       unless collection.empty?
@@ -166,7 +183,7 @@ class DailyView < ChartBase
 
     return lines if subtasks.empty?
 
-    lines << '<section><div class="foldable">Child issues</div>'
+    lines << "<section><div class=\"foldable startFolded\">Child issues (#{subtasks.count})</div>"
     lines += subtasks
     lines << '</section>'
 
@@ -237,9 +254,10 @@ class DailyView < ChartBase
 
   def make_description_lines issue
     description = issue.raw['fields']['description']
-    result = []
-    result << [atlassian_document_format.to_html(description)] if description
-    result
+    return [] unless description
+
+    text = "<div class='foldable startFolded'>Description</div><div>#{atlassian_document_format.to_html(description)}</div>"
+    [[text]]
   end
 
   def assemble_issue_lines issue, child:
@@ -247,6 +265,7 @@ class DailyView < ChartBase
 
     lines = []
     lines << [make_title_line(issue: issue, done: done)]
+    lines << make_not_visible_line(issue)
     lines += make_parent_lines(issue) unless child
     lines += make_stats_lines(issue: issue, done: done)
     unless done
@@ -256,7 +275,7 @@ class DailyView < ChartBase
       lines += make_child_lines(issue)
       lines += make_history_lines(issue)
     end
-    lines
+    lines.compact
   end
 
   def render_issue issue, child:
@@ -278,4 +297,8 @@ class DailyView < ChartBase
     end
     result << '</div>'
   end
+
+  def make_not_visible_line issue
+    not_visible_text issue
+  end
 end

data/lib/jirametrics/data_quality_report.rb

@@ -45,6 +45,7 @@ class DataQualityReport < ChartBase
       scan_for_completed_issues_without_a_start_time entry: entry
       scan_for_status_change_after_done entry: entry
       scan_for_backwards_movement entry: entry, backlog_statuses: backlog_statuses
+      scan_for_issue_not_in_active_sprint entry: entry
       scan_for_issues_not_created_in_a_backlog_status entry: entry, backlog_statuses: backlog_statuses
       scan_for_stopped_before_started entry: entry
       scan_for_issues_not_started_with_subtasks_that_have entry: entry
@@ -68,7 +69,7 @@ class DataQualityReport < ChartBase
     result << render_problem_type(:status_changes_after_done)
     result << render_problem_type(:backwards_through_status_categories)
     result << render_problem_type(:backwords_through_statuses)
-    result << render_problem_type(:status_not_on_board)
+    result << render_problem_type(:issue_not_visible_on_board)
     result << render_problem_type(:created_in_wrong_status)
     result << render_problem_type(:stopped_before_started)
     result << render_problem_type(:issue_not_started_but_subtasks_have)
@@ -194,7 +195,7 @@ class DataQualityReport < ChartBase
         # If it's been moved back to backlog then it's on a different report. Ignore it here.
         detail = nil if backlog_statuses.any? { |s| s.name == change.value }
 
-        entry.report(problem_key: :status_not_on_board, detail: detail) unless detail.nil?
+        entry.report(problem_key: :issue_not_visible_on_board, detail: detail) unless detail.nil?
       elsif change.old_value.nil?
         # Do nothing
       elsif index < last_index
@@ -223,6 +224,29 @@ class DataQualityReport < ChartBase
     end
   end
 
+  def scan_for_issue_not_in_active_sprint entry:
+    issue = entry.issue
+    return unless issue.board.scrum?
+    return if issue.sprints.any?(&:active?)
+
+    entry.report(problem_key: :issue_not_visible_on_board, detail: 'Issue is not in an active sprint')
+  end
+
+  def scan_for_issue_never_visible_on_board entry:
+    issue = entry.issue
+    ever_visible = issue.changes.any? do |change|
+      next unless change.status?
+
+      issue.board.visible_columns.any? { |col| col.status_ids.include?(change.value_id) }
+    end
+    return if ever_visible
+
+    entry.report(
+      problem_key: :issue_not_visible_on_board,
+      detail: 'Issue has never been in a status mapped to a visible column on the board'
+    )
+  end
+
   def scan_for_issues_not_created_in_a_backlog_status entry:, backlog_statuses:
     creation_change = entry.issue.changes.find { |issue| issue.status? }
 
@@ -295,7 +319,7 @@ class DataQualityReport < ChartBase
     return "#{delta} hours" if delta < 24
 
     delta /= 24
-    "#{delta} days"
+    label_days delta
   end
 
   def scan_for_incomplete_subtasks_when_issue_done entry:
@@ -409,12 +433,12 @@ class DataQualityReport < ChartBase
     HTML
   end
 
-  def render_status_not_on_board problems
+  def render_issue_not_visible_on_board problems
     <<-HTML
       #{label_issues problems.size} were not visible on the board for some period of time. This may impact
-      timings as the work was likely to have been forgotten if it wasn't visible. What does "not visible"
-      mean in this context? The issue was in a status that is not mapped to any visible column on the board.
-      Look in "unmapped statuses" on your board.
+      timings as the work was likely to have been forgotten if it wasn't visible. An issue can be not visible
+      for two reasons: the issue was in a status that is not mapped to any visible column on the board
+      (look in "unmapped statuses" on your board), or for scrum boards, the issue was not in an active sprint.
     HTML
   end
 

data/lib/jirametrics/downloader.rb

@@ -170,7 +170,7 @@ class Downloader
 
     if json['type'] == 'simple'
       features_json = download_features board_id: board_id
-      if features_json['features']&.any? { |f| f['feature'] == 'jsw.agility.sprints' && f['state'] == 'ENABLED' }
+      if BoardFeature.from_raw(features_json).any? { |f| f.name == 'jsw.agility.sprints' && f.enabled? }
         download_sprints board_id: board_id
       end
     end

data/lib/jirametrics/estimate_accuracy_chart.rb

@@ -30,7 +30,7 @@ class EstimateAccuracyChart < ChartBase
     HTML
 
     @x_axis_title = 'Cycletime (days)'
-    @y_axis_title = 'Count of items'
+    @y_axis_title = 'Estimate'
 
     @y_axis_type = 'linear'
     @y_axis_block = ->(issue, start_time) { estimate_at(issue: issue, start_time: start_time)&.to_f }

data/lib/jirametrics/examples/aggregated_project.rb

@@ -12,7 +12,7 @@ class Exporter
     project name: name do
       puts name
       file_prefix name
-      self.settings.merge! settings
+      self.settings.merge! stringify_keys(settings)
 
       aggregate do
         project_names.each do |project_name|

data/lib/jirametrics/examples/standard_project.rb

@@ -13,7 +13,7 @@ class Exporter
       file_prefix file_prefix
 
       self.anonymize if anonymize
-      self.settings.merge! settings
+      self.settings.merge! stringify_keys(settings)
 
       boards.each_key do |board_id|
         block = boards[board_id]
@@ -73,10 +73,11 @@ class Exporter
             header_text nil
             description_text '<h2>Number of items completed, grouped by completion status and resolution</h2>'
             grouping_rules do |issue, rules|
-              if issue.resolution
-                rules.label = "#{issue.status.name}:#{issue.resolution}"
+              status, resolution = issue.status_resolution_at_done
+              if resolution
+                rules.label = "#{status.name}:#{resolution}"
               else
-                rules.label = issue.status.name
+                rules.label = status.name
               end
             end
           end

data/lib/jirametrics/github_gateway.rb

@@ -92,6 +92,13 @@ class GithubGateway
 
   def run_command args
     stdout, stderr, status = Open3.capture3('gh', *args)
+
+    # This extra check seems to only matter on Windows. On the mac, auth failures don't pass status.success?
+    if stderr.include?('SAML enforcement')
+      raise "GitHub CLI is not authorized to access #{@repo}. " \
+            "Run: gh auth refresh -h github.com -s read:org"
+    end
+
     raise "GitHub CLI command failed for #{@repo}: #{stderr}" unless status.success?
 
     JSON.parse(stdout)

data/lib/jirametrics/grouping_rules.rb

@@ -13,7 +13,25 @@ class GroupingRules < Rules
   end
 
   def color= color
-    color = CssVariable[color] unless color.is_a?(CssVariable)
-    @color = color
+    if color.is_a?(Array)
+      raise ArgumentError, 'Color pair must have exactly two elements: [light_color, dark_color]' unless color.size == 2
+      raise ArgumentError, 'Color pair elements must be strings' unless color.all?(String)
+
+      if color.any? { |c| c.start_with?('--') }
+        raise ArgumentError,
+          'CSS variable references are not supported as color pair elements; use a literal color value instead'
+      end
+
+      light, dark = color
+      @color = RawJavascript.new(
+        "(document.documentElement.dataset.theme === 'dark' || " \
+        '(!document.documentElement.dataset.theme && ' \
+        "window.matchMedia('(prefers-color-scheme: dark)').matches)) " \
+        "? #{dark.to_json} : #{light.to_json}"
+      )
+    else
+      color = CssVariable[color] unless color.is_a?(CssVariable)
+      @color = color
+    end
   end
 end

data/lib/jirametrics/html/aging_work_table.erb

@@ -41,6 +41,9 @@
                 <%= link_to_issue parent, style: "color: #{color}" %>
               </span>
               <i><%= parent.summary.strip.inspect %></i>
+              <% if parent == issue && (text = not_visible_text(issue)) %>
+                <br /><%= text %>
+              <% end %>
             </div>
           <% end %>
         </td>

data/lib/jirametrics/html/index.css

@@ -214,6 +214,120 @@ div.child_issue {
   padding: 0.5em;
 }
 
+/* Dark CSS variables — shared by the media query and the forced dark theme */
+html[data-theme="dark"] {
+  --warning-banner: #9F2B00;
+  --non-working-days-color: #2f2f2f;
+  --type-story-color: #6fb86f;
+  --type-task-color: #0021b3;
+  --type-bug-color: #bb5603;
+  --body-background: #343434;
+  --default-text-color: #aaa;
+  --grid-line-color: #424242;
+  --expedited-color: #b90000;
+  --blocked-color: #c75b02;
+  --stalled-color: #ae7202;
+  --wip-chart-active-color: #2551c1;
+  --status-category-inprogress-color: #1c49bb;
+  --hierarchy-table-inactive-item-text-color: #939393;
+  --wip-chart-completed-color: #03cb03;
+  --wip-chart-duration-less-than-day-color: #d2d988;
+  --wip-chart-duration-week-or-less-color: #dfcd00;
+  --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;
+  --priority-color-highest: #ef4444;
+  --priority-color-high: #f97316;
+  --priority-color-low: #06b6d4;
+  --priority-color-lowest: #94a3b8;
+
+  a[href] { color: #1e8ad6; }
+  a[href]:hover { color: #3ba0e6; }
+  .chart { background: var(--body-background); }
+  table.standard {
+    th { background: var(--body-background); }
+    tr:nth-child(odd) { background-color: #656565; }
+  }
+  div.color_block { border: 1px solid lightgray; }
+  div.daily_issue {
+    .field { color: var(--default-text-color); }
+  }
+}
+
+/* Force light mode — overrides the dark media query when user explicitly picks light */
+html[data-theme="light"] {
+  --warning-banner: yellow;
+  --non-working-days-color: #F0F0F0;
+  --type-story-color: #4bc14b;
+  --type-task-color: blue;
+  --type-bug-color: orange;
+  --body-background: white;
+  --default-text-color: black;
+  --grid-line-color: lightgray;
+  --expedited-color: red;
+  --blocked-color: #FF7400;
+  --stalled-color: orange;
+  --wip-chart-active-color: #326cff;
+  --status-category-inprogress-color: #2663ff;
+  --hierarchy-table-inactive-item-text-color: gray;
+  --wip-chart-completed-color: #00ff00;
+  --wip-chart-duration-less-than-day-color: #ffef41;
+  --wip-chart-duration-week-or-less-color: #dcc900;
+  --wip-chart-duration-two-weeks-or-less-color: #dfa000;
+  --wip-chart-duration-four-weeks-or-less-color: #eb7200;
+  --wip-chart-duration-more-than-four-weeks-color: #e70000;
+  --daily-view-selected-issue-background: lightgray;
+  --priority-color-highest: #dc2626;
+  --priority-color-high: #ea580c;
+  --priority-color-low: #0891b2;
+  --priority-color-lowest: #64748b;
+
+  a[href] { color: revert; }
+  a[href]:hover { color: revert; }
+  .chart { background: white; }
+  table.standard {
+    th { background: white; }
+    tr:nth-child(odd) { background-color: #eee; }
+  }
+  div.color_block { border: 1px solid black; }
+}
+
+/* Theme toggle widget */
+#theme-toggle {
+  position: fixed;
+  top: 0.5rem;
+  right: 0.5rem;
+  display: flex;
+  gap: 2px;
+  background: var(--body-background);
+  border: 1px solid var(--grid-line-color);
+  border-radius: 6px;
+  padding: 3px;
+  z-index: 1000;
+
+  button {
+    background: none;
+    border: none;
+    cursor: pointer;
+    padding: 2px 6px;
+    border-radius: 4px;
+    font-size: 1rem;
+    color: var(--default-text-color);
+    opacity: 0.5;
+  }
+
+  button:hover {
+    opacity: 1;
+    background: var(--grid-line-color);
+  }
+
+  button.active {
+    opacity: 1;
+    background: var(--grid-line-color);
+  }
+}
+
 @media screen and (prefers-color-scheme: dark) {
   :root {
     --warning-banner: #9F2B00;

data/lib/jirametrics/html/index.erb

@@ -17,6 +17,11 @@
     </script>
   </head>
   <body>
+    <div id="theme-toggle">
+      <button id="theme-btn-system" title="Use system preference">⊙</button>
+      <button id="theme-btn-light" title="Light mode">☀</button>
+      <button id="theme-btn-dark" title="Dark mode">☾</button>
+    </div>
     <noscript>
       <div style="padding: 1em; background: red; color: white; font-size: 2em;">
         Javascript is currently disabled and that means that almost all of the charts in this report won't render. If you've loaded this from a folder on SharePoint then save it locally and load it again.

data/lib/jirametrics/html/index.js

@@ -1,3 +1,12 @@
+// Apply saved theme immediately (before Chart.js reads CSS variables) so charts
+// initialize with the correct colour scheme.
+(function () {
+  const saved = localStorage.getItem('jirametrics:theme');
+  if (saved) {
+    document.documentElement.setAttribute('data-theme', saved);
+  }
+}());
+
 function makeFoldable() {
   // Get all elements with the "foldable" class
   const foldableElements = document.querySelectorAll('.foldable');
@@ -77,16 +86,57 @@ function makeFoldable() {
   });
 }
 
+function initThemeToggle() {
+  const html = document.documentElement;
+  const saved = localStorage.getItem('jirametrics:theme');
+  if (saved) {
+    html.setAttribute('data-theme', saved);
+  }
+
+  function updateActiveButton(theme) {
+    ['system', 'light', 'dark'].forEach(t => {
+      const btn = document.getElementById(`theme-btn-${t}`);
+      if (btn) {
+        btn.classList.toggle('active', t === theme);
+      }
+    });
+  }
+
+  function setTheme(theme) {
+    if (theme === 'system') {
+      html.removeAttribute('data-theme');
+      localStorage.removeItem('jirametrics:theme');
+    } else {
+      html.setAttribute('data-theme', theme);
+      localStorage.setItem('jirametrics:theme', theme);
+    }
+    updateActiveButton(theme);
+    location.reload();
+  }
+
+  updateActiveButton(saved || 'system');
+
+  ['system', 'light', 'dark'].forEach(theme => {
+    const btn = document.getElementById(`theme-btn-${theme}`);
+    if (btn) {
+      btn.addEventListener('click', () => setTheme(theme));
+    }
+  });
+}
+
 // Auto-initialize when DOM is loaded
 document.addEventListener('DOMContentLoaded', function() {
   makeFoldable();
+  initThemeToggle();
 });
 
 
 // If we switch between light/dark mode then force a refresh so all charts will redraw correctly
-// in the other colour scheme.
+// in the other colour scheme. Skip reload if a manual theme override is set.
 window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
-  location.reload()
+  if (!document.documentElement.hasAttribute('data-theme')) {
+    location.reload();
+  }
 })
 
 // Draw a diagonal pattern to highlight sections of a bar chart. Based on code found at:

data/lib/jirametrics/html_report_config.rb

@@ -41,6 +41,7 @@ class HtmlReportConfig < HtmlGenerator
     deprecated_warning: 'Renamed to estimate_accuracy_chart. Please use that one', deprecated_date: '2024-05-23'
 
   def initialize file_config:, block:
+    super()
     @file_config = file_config
     @block = block
     @sections = [] # Where we store the chunks of text that will be assembled into the HTML

data/lib/jirametrics/issue.rb

@@ -213,6 +213,19 @@ class Issue
     first_time_in_status(*board.visible_columns.collect(&:status_ids).flatten)
   end
 
+  def reasons_not_visible_on_board
+    reasons = []
+    reasons << 'Not in an active sprint' if board.scrum? && sprints.none?(&:active?)
+    unless board.visible_columns.any? { |c| c.status_ids.include?(status.id) }
+      reasons << 'Status is not configured for any visible column on the board'
+    end
+    reasons
+  end
+
+  def visible_on_board?
+    reasons_not_visible_on_board.empty?
+  end
+
   # If this issue will ever be in an active sprint then return the time that it
   # was first added to that sprint, whether or not the sprint was active at that
   # time. Although it seems like an odd thing to calculate, it's a reasonable proxy
@@ -395,21 +408,11 @@ class Issue
     results
   end
 
-  def blocked_stalled_statuses settings
-    blocked_statuses = settings['blocked_statuses']
-    stalled_statuses = settings['stalled_statuses']
-    unless blocked_statuses.is_a?(Array) && stalled_statuses.is_a?(Array)
-      raise "blocked_statuses(#{blocked_statuses.inspect}) and " \
-        "stalled_statuses(#{stalled_statuses.inspect}) must both be arrays"
-    end
-
-    [blocked_statuses, stalled_statuses]
-  end
-
   def blocked_stalled_changes end_time:, settings: nil
     settings ||= @board.project_config.settings
 
-    blocked_statuses, stalled_statuses = blocked_stalled_statuses(settings)
+    blocked_statuses = settings['blocked_statuses']
+    stalled_statuses = settings['stalled_statuses']
 
     blocked_link_texts = settings['blocked_link_text']
     stalled_threshold = settings['stalled_threshold_days']
@@ -422,6 +425,7 @@ class Issue
     previous_change_time = created
 
     blocking_status = nil
+    blocking_is_blocked = false
     flag = nil
     flag_reason = nil
 
@@ -441,7 +445,11 @@ class Issue
         flag, flag_reason = blocked_stalled_changes_flag_logic change
       elsif change.status?
         blocking_status = nil
-        if blocked_statuses.include?(change.value) || stalled_statuses.include?(change.value)
+        blocking_is_blocked = false
+        if blocked_statuses.find_by_id(change.value_id)
+          blocking_status = change.value
+          blocking_is_blocked = true
+        elsif stalled_statuses.find_by_id(change.value_id)
           blocking_status = change.value
         end
       elsif change.link?
@@ -464,7 +472,7 @@ class Issue
         flagged: flag,
         flag_reason: flag_reason,
         status: blocking_status,
-        status_is_blocking: blocking_status.nil? || blocked_statuses.include?(blocking_status),
+        status_is_blocking: blocking_status.nil? || blocking_is_blocked,
         blocking_issue_keys: (blocking_issue_keys.empty? ? nil : blocking_issue_keys.dup),
         time: change.time
       )
@@ -749,6 +757,24 @@ class Issue
     @changes.select { |change| change.status? }
   end
 
+  def status_resolution_at_done
+    done_time = board.cycletime.started_stopped_times(self).last
+    return [nil, nil] if done_time.nil?
+
+    status_change = nil
+    resolution = nil
+
+    @changes.each do |change|
+      break if change.time > done_time
+
+      status_change = change if change.status?
+      resolution = change.value if change.resolution?
+    end
+
+    status = status_change ? find_or_create_status(id: status_change.value_id, name: status_change.value) : nil
+    [status, resolution]
+  end
+
   def sprints
     sprint_ids = []
 
@@ -769,13 +795,13 @@ class Issue
   def compact_text text, max: 60
     return '' if text.nil?
 
-    if text.is_a? Hash
-      # We can't effectively compact it but we can convert it into a string.
-      text = @board.project_config.atlassian_document_format.to_html(text)
-    else
-      text = text.gsub(/\s+/, ' ').strip
-      text = "#{text[0...max]}..." if text.length > max
-    end
+    text = if text.is_a? Hash
+             @board.project_config.atlassian_document_format.to_text(text)
+           else
+             text
+           end
+    text = text.gsub(/\s+/, ' ').strip
+    text = "#{text[0...max]}..." if text.length > max
     text
   end
 

data/lib/jirametrics/jira_gateway.rb

@@ -28,9 +28,12 @@ class JiraGateway
 
     stdout, stderr, status = capture3(command, stdin_data: stdin_data)
     unless status.success?
-      @file_system.log "Failed call with exit status #{status.exitstatus}!"
-      @file_system.log "Returned (stdout): #{stdout.inspect}"
-      @file_system.log "Returned (stderr): #{stderr.inspect}"
+      @file_system.error "Failed call with exit status #{status.exitstatus}!"
+      @file_system.error "Returned (stdout): #{stdout.inspect}"
+      @file_system.error "Returned (stderr): #{stderr.inspect}"
+      if stderr.include?('401')
+        raise 'The request was not authorized. Verify that your authentication token hasn\'t expired'
+      end
       raise "Failed call with exit status #{status.exitstatus}. " \
         "See #{@file_system.logfile_name} for details"
     end

data/lib/jirametrics/project_config.rb

@@ -43,6 +43,7 @@ class ProjectConfig
     load_sprints
     load_fix_versions
     load_users
+    resolve_blocked_stalled_status_settings
   end
 
   def run load_only: false
@@ -70,7 +71,10 @@ class ProjectConfig
       file_system.deprecated message: 'stalled color should be set via css now', date: '2024-05-03'
     end
 
-    settings
+    settings['blocked_statuses'] = StatusCollection.new
+    settings['stalled_statuses'] = StatusCollection.new
+
+    stringify_keys(settings)
   end
 
   def guess_project_id
@@ -273,9 +277,13 @@ class ProjectConfig
     raw = file_system.load_json(filename)
 
     features_filename = File.join(@target_path, "#{get_file_prefix}_board_#{board_id}_features.json")
-    features_raw = file_system.load_json(features_filename) if file_system.file_exist?(features_filename)
+    features = if file_system.file_exist?(features_filename)
+                 BoardFeature.from_raw(file_system.load_json(features_filename))
+               else
+                 []
+               end
 
-    board = Board.new(raw: raw, possible_statuses: @possible_statuses, features_raw: features_raw)
+    board = Board.new(raw: raw, possible_statuses: @possible_statuses, features: features)
     board.project_config = self
     @all_boards[board_id] = board
   end
@@ -633,4 +641,29 @@ class ProjectConfig
 
     cycletimes_touched.each { |c| c.flush_cache }
   end
+
+  def stringify_keys value
+    case value
+    when Hash then value.transform_keys(&:to_s).transform_values { |v| stringify_keys(v) }
+    when Array then value.map { |v| stringify_keys(v) }
+    else value
+    end
+  end
+
+  def resolve_blocked_stalled_status_settings
+    %w[blocked_statuses stalled_statuses].each do |key|
+      next if @settings[key].is_a?(StatusCollection)
+
+      collection = StatusCollection.new
+      @settings[key].each do |identifier|
+        statuses = @possible_statuses.find_all_by_name(identifier)
+        if statuses.empty?
+          file_system.warning "Status #{identifier.inspect} in #{key} not found. Ignoring."
+        else
+          statuses.each { |status| collection << status }
+        end
+      end
+      @settings[key] = collection
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.23'
+  version: '2.24'
 platform: ruby
 authors:
 - Mike Bowler
@@ -71,6 +71,7 @@ files:
 - lib/jirametrics/board.rb
 - lib/jirametrics/board_column.rb
 - lib/jirametrics/board_config.rb
+- lib/jirametrics/board_feature.rb
 - lib/jirametrics/board_movement_calculator.rb
 - lib/jirametrics/change_item.rb
 - lib/jirametrics/chart_base.rb
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.7
+rubygems_version: 4.0.8
 specification_version: 4
 summary: Extract Jira metrics
 test_files: []