jirametrics 2.0.1 → 2.1.1

data/lib/jirametrics/expedited_chart.rb

@@ -3,11 +3,14 @@
 require 'jirametrics/chart_base'
 
 class ExpeditedChart < ChartBase
-  EXPEDITED_SEGMENT = Object.new.tap do |segment|
+  EXPEDITED_SEGMENT = ChartBase.new.tap do |segment|
     def segment.to_json *_args
+      expedited = CssVariable.new('--expedited-color').to_json
+      not_expedited = CssVariable.new('--expedited-chart-no-longer-expedited').to_json
+
       <<~SNIPPET
         {
-          borderColor: ctx => expedited(ctx, 'red') || notExpedited(ctx, 'gray'),
+          borderColor: ctx => expedited(ctx, #{expedited}) || notExpedited(ctx, #{not_expedited}),
           borderDash: ctx => notExpedited(ctx, [6, 6])
         }
       SNIPPET

data/lib/jirametrics/exporter.rb

@@ -3,9 +3,9 @@
 require 'fileutils'
 
 class Object
-  def deprecated message:
+  def deprecated message:, date:
     text = +''
-    text << 'Deprecated:'
+    text << "Deprecated(#{date}):"
     text << message
     text << "\n-> Called from #{caller(1..1).first}"
     warn text
@@ -16,7 +16,14 @@ class Exporter
   attr_reader :project_configs, :file_system
 
   def self.configure &block
-    exporter = Exporter.new
+    logfile_name = 'jirametrics.log'
+    logfile = File.open logfile_name, 'w'
+    file_system = FileSystem.new
+    file_system.logfile = logfile
+    file_system.logfile_name = logfile_name
+
+    exporter = Exporter.new file_system: file_system
+
     exporter.instance_eval(&block)
     @@instance = exporter
   end
@@ -41,25 +48,24 @@ class Exporter
 
   def download name_filter:
     @downloading = true
-    logfile_name = 'downloader.log'
-    File.open logfile_name, 'w' do |logfile|
-      file_system.logfile = logfile
-      file_system.logfile_name = logfile_name
-
-      each_project_config(name_filter: name_filter) do |project|
-        project.evaluate_next_level
-        next if project.aggregated_project?
-
-        project.download_config.run
-        downloader = Downloader.new(
-          download_config: project.download_config,
-          file_system: file_system,
-          jira_gateway: JiraGateway.new(file_system: file_system)
-        )
-        downloader.run
+    each_project_config(name_filter: name_filter) do |project|
+      project.evaluate_next_level
+      next if project.aggregated_project?
+
+      unless project.download_config
+        raise "Project #{project.name.inspect} is missing a download section in the config. " \
+          'That is required in order to download'
       end
+
+      project.download_config.run
+      downloader = Downloader.new(
+        download_config: project.download_config,
+        file_system: file_system,
+        jira_gateway: JiraGateway.new(file_system: file_system)
+      )
+      downloader.run
     end
-    puts "Full output from downloader in #{logfile_name}"
+    puts "Full output from downloader in #{file_system.logfile_name}"
   end
 
   def each_project_config name_filter:

data/lib/jirametrics/grouping_rules.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 class GroupingRules < Rules
-  attr_accessor :label, :color
+  attr_accessor :label
+  attr_reader :color
 
   def eql? other
     other.label == @label && other.color == @color
@@ -10,4 +11,9 @@ class GroupingRules < Rules
   def group
     [@label, @color]
   end
+
+  def color= color
+    color = CssVariable[color] unless color.is_a?(CssVariable)
+    @color = color
+  end
 end

data/lib/jirametrics/html/aging_work_bar_chart.erb

@@ -1,4 +1,4 @@
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -19,14 +19,20 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
         stacked: false,
         title: {
           display: false
-        }
+        },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         stacked: true,
         position: 'right',
         ticks: {
           display: true
-        }
+        },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {
@@ -38,8 +44,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 %>
 
@@ -48,7 +54,7 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
             type: 'line',
             xMin: '<%= percentage_line_x %>',
             xMax: '<%= percentage_line_x %>',
-            borderColor: 'red',
+            borderColor: <%= CssVariable.new('--aging-work-bar-chart-percentage-line-color').to_json %>,
             borderWidth: 1,
             drawTime: 'afterDraw'
           }

data/lib/jirametrics/html/aging_work_in_progress_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.inspect %>).getContext('2d'),
         scaleLabel: {
           display: true,
           labelString: 'Date Completed'
-        }
+        },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         scaleLabel: {
@@ -31,6 +34,9 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
           display: true,
           text: 'Age in days'
         },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       }
     },
     plugins: {

data/lib/jirametrics/html/aging_work_table.erb

@@ -38,7 +38,7 @@
         <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,8 +56,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/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,174 @@
+: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;
+  
+  --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;
+
+  --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.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: {