jirametrics 2.0.1 → 2.2.0

data/lib/jirametrics/html/aging_work_table.erb

@@ -1,20 +1,3 @@
-<h1>Aging Work Table</h1>
-<p>
-  This chart shows all active (started but not completed) work, ordered from oldest at the top to 
-  newest at the bottom.
-</p>
-<p>
-  If there are expedited items that haven't yet started then they're at the bottom of the table. By the
-  very definition of expedited, if we haven't started them already, we'd better get on that.
-</p>
-<p>
-  <% if age_cutoff > 0 %>
-    Items less than <%= label_days age_cutoff %> old have been excluded from this chart to provide more
-    focus on the older items. The exception are items that are either expedited or blocked - these are
-    shown no matter how old they are.
-  <% end %>
-</p>
-
 <table class='standard'>
   <thead>
     <tr>
@@ -31,14 +14,23 @@
     </tr>
   </thead>
   <tbody>
+    <% show_age_cutoff_bar_at = age_cutoff %>
     <% aging_issues.each do |issue| %>
+      <% issue_age = issue.board.cycletime.age(issue, today: @today) %>
+      <% if show_age_cutoff_bar_at && issue_age&.<(show_age_cutoff_bar_at) %>
+        <tr><th colspan=100 style="text-align: left; padding-top: 1em;">
+          The items below are less than <%= label_days age_cutoff %> old, and are only on this report
+          because they're either expedited or blocked.
+        </th></tr>
+        <% show_age_cutoff_bar_at = nil %>
+      <% end %>
       <tr>
-        <td style="text-align: right;"><%= issue.board.cycletime.age(issue, today: @today) || 'Not started' %></td>
+        <td style="text-align: right;"><%= issue_age || 'Not started' %></td>
         <td><%= expedited_text(issue) %></td>
         <td><%= blocked_text(issue) %></td>
         <td>
           <% parent_hierarchy(issue).each_with_index do |parent, index| %>
-            <% color = (parent == issue ? 'black' : 'gray') %>
+            <% color = parent != issue ? "var(--hierarchy-table-inactive-item-text-color)" : 'var(--default-text-color)' %>
             <div style="padding-left: <%= index %>em; color: <%= color %>">
               <span style="white-space: nowrap;">
                 <img src="<%= parent.type_icon_url %>" title="<%= parent.type %>"/>

data/lib/jirametrics/html/cycletime_histogram.erb

@@ -1,4 +1,4 @@
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -17,14 +17,20 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
         title: {
           display: true,
           text: 'Cycletime in days'
-        }
+        },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         stacked: true,
         title: {
           display: true,
           text: 'Number of items that had that cycletime'
-        }
+        },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {

data/lib/jirametrics/html/cycletime_scatterplot.erb

@@ -1,4 +1,4 @@
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -20,6 +20,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           labelString: 'Date Completed'
         },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
         min: "<%= date_range.begin.to_s %>",
         max: "<%= (date_range.end + 1).to_s %>"
       },
@@ -34,6 +37,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           text: 'Cycle time in days'
         },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {
@@ -53,8 +59,8 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
             type: 'box',
             xMin: '<%= range.begin %>T00:00:00',
             xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: '#F0F0F0',
-            borderColor: '#F0F0F0'
+            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
+            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
           },
           <% end %>
 
@@ -64,7 +70,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
             type: 'line',
             yMin: <%= percent %>,
             yMax: <%= percent %>,
-            borderColor: '<%= color %>',
+            borderColor: <%= color.to_json %>,
             borderWidth: 1,
             drawTime: 'beforeDraw'
           },

data/lib/jirametrics/html/daily_wip_chart.erb

@@ -1,4 +1,4 @@
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -20,7 +20,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
         time: {
           unit: 'day'
         },
-        stacked: true
+        stacked: true,
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         stacked: true,
@@ -32,7 +35,9 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
           display: true,
           text: 'Count of items'
         },
-
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {
@@ -51,11 +56,19 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
             type: 'box',
             xMin: '<%= range.begin %>T00:00:00',
             xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: '#F0F0F0',
-            borderColor: '#F0F0F0'
+            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
+            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
           },
           <% end %>
         }
+      },
+      legend: {
+        labels: {
+          filter: function(item, chart) {
+            // Logic to remove a particular legend item goes here
+            return !item.text.includes('Trendline');
+          }
+        }
       }
     }
   }

data/lib/jirametrics/html/expedited_chart.erb

@@ -1,4 +1,4 @@
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -24,7 +24,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           labelString: 'Date Completed'
         },
         min: "<%= date_range.begin.to_s %>",
-        max: "<%= date_range.end.to_s %>"
+        max: "<%= date_range.end.to_s %>",
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         scaleLabel: {
@@ -35,7 +38,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           text: 'Age in days'
         },        
-        min: 0
+        min: 0,
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {
@@ -55,8 +61,8 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
             type: 'box',
             xMin: '<%= range.begin %>T00:00:00',
             xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: '#F0F0F0',
-            borderColor: '#F0F0F0'
+            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
+            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
           },
           <% end %>
         }

data/lib/jirametrics/html/hierarchy_table.erb

@@ -14,7 +14,7 @@
       <tr>
         <td style="text-align: right;"><%= issue.board.cycletime.age(issue, today: @today) || 'Not started' %></td>
         <td>
-          <% color = (node.children? ? 'gray' : 'black') %>
+          <% color = "var(--hierarchy-table-#{ 'in' if node.children? }active-item-text-color)" %>
           <span style="padding-left: <%= depth - 1 %>em;" />
           <span style="white-space: nowrap;">
             <img src="<%= issue.type_icon_url %>" title="<%= issue.type %>"/>

data/lib/jirametrics/html/index.css

@@ -0,0 +1,186 @@
+:root {
+  --body-background: white;
+  --default-text-color: black;
+  --grid-line-color: lightgray;
+
+  --cycletime-scatterplot-overall-trendline-color: gray;
+
+  --non-working-days-color: #F0F0F0;
+  --expedited-color: red;
+  --blocked-color: #FF7400;
+  --stalled-color: orange;
+  --dead-color: black;
+
+  --type-story-color: #4bc14b;
+  --type-task-color: blue;
+  --type-bug-color: orange;
+  --type-spike-color: #9400D3;
+
+  --status-category-todo-color: gray;
+  --status-category-inprogress-color: #2663ff;
+  --status-category-done-color: #00ff00;
+
+  --aging-work-bar-chart-percentage-line-color: red;
+  --aging-work-bar-chart-separator-color: white;
+
+  --throughput_chart_total_line_color: gray;
+  
+  --aging-work-in-progress-chart-shading-color: lightgray;
+  --aging-work-in-progress-by-age-trend-line-color: gray;
+  
+  --hierarchy-table-inactive-item-text-color: gray;
+
+  --wip-chart-completed-color: #00ff00;
+  --wip-chart-completed-but-not-started-color: #99FF99;
+  --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;
+  --wip-chart-active-color: #326cff;
+  --wip-chart-border-color: gray;
+
+  --estimate-accuracy-chart-completed-fill-color: #00ff00;
+  --estimate-accuracy-chart-completed-border-color: green;
+  --estimate-accuracy-chart-active-fill-color: #FFCCCB;
+  --estimate-accuracy-chart-active-border-color: red;
+
+  --expedited-chart-no-longer-expedited: gray;
+  --expedited-chart-dot-issue-started-color: orange;
+  --expedited-chart-dot-issue-stopped-color: green;
+  --expedited-chart-dot-expedite-started-color: red;
+  --expedited-chart-dot-expedite-stopped-color: green;
+
+  --sprint-burndown-sprint-color-1: blue;
+  --sprint-burndown-sprint-color-2: orange;
+  --sprint-burndown-sprint-color-3: green;
+  --sprint-burndown-sprint-color-4: red;
+  --sprint-burndown-sprint-color-5: brown;
+
+
+}
+
+body {
+  background-color: var(--body-background);
+  color: var(--default-text-color);
+}
+
+h1 {
+  border: 1px solid black;
+  background: lightgray;
+  padding-left: 0.2em;
+}
+dl, dd, dt {
+  padding: 0;
+  margin: 0;
+}
+dd {
+  margin-bottom:  0.4em;
+}
+span.highlight {
+  background: #FDD5B1;
+}
+a.issue_key {
+  white-space: nowrap;
+}
+table.standard {
+  th {
+    border-bottom: 1px solid gray;
+    position: sticky;
+    top: 0;
+    background: white;
+  }
+  td {
+    padding-left: 0.5em;
+    padding-right: 0.5em;
+    vertical-align: top;
+  }
+  tr:nth-child(odd){
+    background-color: #eee;
+  }
+}
+.quality_note_bullet {
+  color: red;
+}
+
+.chart {
+  background-color: white;
+}
+
+div.p {
+  margin: 0.5em 0;
+  padding: 0;
+}
+
+div.color_block {
+  display: inline-block;
+  width: 0.9em;
+  height: 0.9em;
+  border: 1px solid black;
+}
+
+@media screen and (prefers-color-scheme: dark) {
+  :root {
+    --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;
+    --dead-color: black;
+    --wip-chart-active-color: #2551c1;
+
+    --aging-work-in-progress-chart-shading-color: #b4b4b4;
+
+    --status-category-inprogress-color: #1c49bb;
+
+    --cycletime-scatterplot-overall-trendline-color: gray;
+
+    --hierarchy-table-inactive-item-text-color: #939393;
+
+    --wip-chart-completed-color: #03cb03;
+    --wip-chart-completed-but-not-started-color: #99FF99;
+    --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;
+  }
+
+  h1 {
+    color: #e0e0e0;
+    background-color: #656565;
+  }
+
+  a[href] {
+    color: #1e8ad6;
+  }
+
+  a[href]:hover {
+    color: #3ba0e6;
+  }
+
+  .chart {
+    background: var(--body-background);
+  }
+
+  table.standard {
+    th {
+      border-bottom: 1px solid gray;
+      background: var(--body-background);
+    }
+    tr:nth-child(odd){
+      background-color: #656565;
+    }
+  }
+
+  div.color_block {
+    border: 1px solid lightgray;
+  }
+}

data/lib/jirametrics/html/index.erb

@@ -17,44 +17,16 @@
           document.getElementById(issues_id).style.display = 'none'
         }
       }
+      // If we switch between light/dark mode then force a refresh so all charts will redraw correctly
+      // in the other colour scheme.
+      window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
+        location.reload()
+      })
+
     </script>
     <style>
-      h1 {
-        border: 1px solid black;
-        background: lightgray;
-        padding-left: 0.2em;
-      }
-      dl, dd, dt {
-        padding: 0;
-        margin: 0;
-      }
-      dd {
-        margin-bottom:  0.4em;
-      }
-      span.highlight {
-        background: #FDD5B1;
-      }
-      a.issue_key {
-        white-space: nowrap;
-      }
-      table.standard thead tr th {
-        border-bottom: 1px solid gray;
-        position: sticky;
-        top: 0;
-        background: white;
-      }
-      table.standard tbody tr td {
-        padding-left: 0.5em;
-        padding-right: 0.5em;
-        vertical-align: top;
-      }
-      table.standard tbody tr:nth-child(odd){
-        background-color: #eee;
-      }
-      .quality_note_bullet {
-        color: red;
-      }
-      </style>
+<%= css %>
+    </style>
   </head>
   <body>
     <div>

data/lib/jirametrics/html/sprint_burndown.erb

@@ -1,6 +1,6 @@
 <h2>Burndown by <%= y_axis_title %></h2>
 
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -26,8 +26,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           labelString: 'Date'
         },
         min: "<%= date_range.begin.to_s %>",
-        max: "<%= (date_range.end + 1).to_s %>"
-
+        max: "<%= (date_range.end + 1).to_s %>",
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         scaleLabel: {
@@ -38,7 +40,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           text: "<%= y_axis_title %>"
         },
-        min: 0.0
+        min: 0.0,
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {
@@ -57,8 +62,8 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
             type: 'box',
             xMin: '<%= range.begin %>T00:00:00',
             xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: '#F0F0F0',
-            borderColor: '#F0F0F0'
+            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
+            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
           },
           <% end %>
         }

data/lib/jirametrics/html/story_point_accuracy_chart.erb

@@ -1,4 +1,4 @@
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -24,8 +24,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           text: "Cycletime (days)"
         },
-        min: 0
-
+        min: 0,
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         type: "<%= @y_axis_type %>",
@@ -40,7 +42,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           text: "<%= @y_axis_label %>"
         },
-        min: 0.0
+        min: 0.0,
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {

data/lib/jirametrics/html/throughput_chart.erb

@@ -1,5 +1,5 @@
 
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -23,7 +23,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
         scaleLabel: {
           display: true,
           labelString: 'Date Completed'
-        }
+        },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         scaleLabel: {
@@ -33,7 +36,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           text: 'Count of items'
         },
-        min: 0
+        min: 0,
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
     },
     plugins: {
@@ -52,8 +58,8 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
             type: 'box',
             xMin: '<%= range.begin %>T00:00:00',
             xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: '#F0F0F0',
-            borderColor: '#F0F0F0'
+            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
+            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
           },
           <% end %>
         }

data/lib/jirametrics/html_report_config.rb

@@ -26,6 +26,11 @@ class HtmlReportConfig
     end
   end
 
+  # Mostly this is its own method so it can be called from the config
+  def included_projects
+    @file_config.project_config.aggregate_config.included_projects
+  end
+
   def run
     instance_eval(&@block)
 
@@ -36,11 +41,21 @@ class HtmlReportConfig
 
     File.open @file_config.output_filename, 'w' do |file|
       html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
-      erb = ERB.new File.read("#{html_directory}/index.erb")
+      css = load_css html_directory: html_directory
+      erb = ERB.new File.read(File.join(html_directory, 'index.erb'))
       file.puts erb.result(binding)
     end
   end
 
+  def load_css html_directory:
+    base_css = File.read(File.join(html_directory, 'index.css'))
+    extra_css_filename = settings['include_css']
+    return base_css unless extra_css_filename && File.exist?(extra_css_filename)
+
+    @file_config.project_config.exporter.file_system.log("including css from file: #{extra_css_filename}")
+    base_css << "\n\n" << File.read(extra_css_filename)
+  end
+
   def board_id id = nil
     @board_id = id unless id.nil?
     @board_id
@@ -92,6 +107,10 @@ class HtmlReportConfig
     execute_chart DailyWipByBlockedStalledChart.new
   end
 
+  def daily_wip_by_parent_chart &block
+    execute_chart DailyWipByParentChart.new block
+  end
+
   def throughput_chart &block
     execute_chart ThroughputChart.new(block)
   end
@@ -109,7 +128,8 @@ class HtmlReportConfig
   end
 
   def html string, type: :body
-    raise "Unexpected type: #{type}" unless %i[body header].include? type
+    allowed_types = %i[body header]
+    raise "Unexpected type: #{type} allowed_types: #{allowed_types.inspect}" unless allowed_types.include? type
 
     @sections << [string, type]
   end
@@ -145,13 +165,18 @@ class HtmlReportConfig
     execute_chart DependencyChart.new block
   end
 
+  # have an explicit method here so that index.erb can call 'settings' just as any other erb can.
+  def settings
+    @file_config.project_config.settings
+  end
+
   def execute_chart chart, &after_init_block
     project_config = @file_config.project_config
 
     chart.issues = issues
     chart.time_range = project_config.time_range
     chart.timezone_offset = timezone_offset
-    chart.settings = project_config.settings
+    chart.settings = settings
 
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id if chart.respond_to? :board_id=

data/lib/jirametrics/issue.rb

@@ -30,7 +30,8 @@ class Issue
       fabricate_change(field_name: 'status'),
       fabricate_change(field_name: 'priority')
     ].compact + @changes
-  rescue => e
+  rescue # rubocop:disable Style/RescueStandardError
+    # All we're doing is adding information to the existing exception and letting it propogate up
     raise "Unable to initialize #{raw['key']}"
   end
 
@@ -252,7 +253,7 @@ class Issue
     end
 
     blocked_link_texts = settings['blocked_link_text']
-    stalled_threshold = settings['stalled_threshold']
+    stalled_threshold = settings['stalled_threshold_days']
 
     blocking_issue_keys = []
 
@@ -283,8 +284,9 @@ class Issue
           blocking_status = change.value
         end
       elsif change.link?
+        # Example: "This issue is satisfied by ANON-30465"
         unless /^This issue (?<link_text>.+) (?<issue_key>.+)$/ =~ (change.value || change.old_value)
-          puts "Can't parse link text: #{change.value || change.old_value}"
+          puts "Issue(#{key}) Can't parse link text: #{change.value || change.old_value}"
           next
         end