jirametrics 2.0.1 → 2.2.0

data/lib/jirametrics/daily_wip_chart.rb

@@ -20,13 +20,16 @@ class DailyWipChart < ChartBase
     header_text default_header_text
     description_text default_description_text
 
-    if block
-      instance_eval(&block)
-    else
+    instance_eval(&block) if block
+
+    unless @group_by_block
       grouping_rules do |issue, rules|
         default_grouping_rules issue: issue, rules: rules
       end
     end
+
+    # Because this one will size itself as needed, we start with a smaller default size
+    # @canvas_height = 80
   end
 
   def run
@@ -36,6 +39,13 @@ class DailyWipChart < ChartBase
     data_sets = possible_rules.collect do |grouping_rule|
       make_data_set grouping_rule: grouping_rule, issue_rules_by_active_date: issue_rules_by_active_date
     end
+    if @trend_lines
+      data_sets = @trend_lines.filter_map do |group_labels, line_color|
+        trend_line_data_set(data: data_sets, group_labels: group_labels, color: line_color)
+      end + data_sets
+    end
+
+    # grow_chart_height_if_too_many_data_sets data_sets.size
 
     wrap_and_render(binding, __FILE__)
   end
@@ -102,14 +112,14 @@ class DailyWipChart < ChartBase
       label: grouping_rule.label,
       data: data,
       backgroundColor: grouping_rule.color || random_color,
-      borderColor: 'gray',
-      borderWidth: grouping_rule.color == 'white' ? 1 : 0,
+      borderColor: CssVariable['--wip-chart-border-color'],
+      borderWidth: grouping_rule.color.to_s == 'var(--body-background)' ? 1 : 0,
       borderRadius: positive ? 0 : 5
     }
   end
 
   def configure_rule issue:, date:
-    raise 'grouping_rules must be set' if @group_by_block.nil?
+    raise "#{self.class}: grouping_rules must be set" if @group_by_block.nil?
 
     rules = DailyGroupingRules.new
     rules.current_date = date
@@ -120,4 +130,55 @@ class DailyWipChart < ChartBase
   def grouping_rules &block
     @group_by_block = block
   end
+
+  def add_trend_line group_labels:, line_color:
+    (@trend_lines ||= []) << [group_labels, line_color]
+  end
+
+  def trend_line_data_set data:, group_labels:, color:
+    day_wip_hash = {}
+    data.each do |top_level|
+      next unless group_labels.include? top_level[:label]
+
+      top_level[:data].each do |datapoint|
+        date = datapoint[:x]
+        day_wip_hash[date] = (day_wip_hash[date] || 0) + datapoint[:y]
+      end
+    end
+
+    points = day_wip_hash
+      .collect { |date, wip| [date.jd, wip] }
+      .sort_by(&:first)
+
+    calculator = TrendLineCalculator.new(points)
+    return nil unless calculator.valid?
+
+    data_points = calculator.chart_datapoints(
+      range: date_range.begin.jd..date_range.end.jd,
+      max_y: points.collect { |_date, wip| wip }.max
+    )
+    data_points.each do |point_hash|
+      point_hash[:x] = chart_format Date.jd(point_hash[:x])
+    end
+
+    {
+      type: 'line',
+      label: "Trendline",
+      data: data_points,
+      fill: false,
+      borderWidth: 1,
+      markerType: 'none',
+      borderColor: CssVariable[color],
+      borderDash: [6, 3],
+      pointStyle: 'dash',
+      hidden: false
+    }
+  end
+
+  def grow_chart_height_if_too_many_data_sets count
+    px_per_bar = 8
+    bars_per_issue = 0.5
+    preferred_height = count * px_per_bar * bars_per_issue
+    @canvas_height = preferred_height if @canvas_height.nil? || @canvas_height < preferred_height
+  end
 end

data/lib/jirametrics/data_quality_report.rb

@@ -271,7 +271,7 @@ class DataQualityReport < ChartBase
       board_names = entry_list.collect { |entry| entry.issue.board.name.inspect }
       entry_list.first.report(
         problem_key: :issue_on_multiple_boards,
-        detail: "Found on boards: #{board_names.join(', ')}"
+        detail: "Found on boards: #{board_names.sort.join(', ')}"
       )
     end
   end

data/lib/jirametrics/dependency_chart.rb

@@ -84,7 +84,8 @@ class DependencyChart < ChartBase
     result << issue_link.other_issue.key.inspect
     result << '['
     result << 'label=' << (link_rules.label || issue_link.label).inspect
-    result << ',color=' << (link_rules.line_color || 'black').inspect
+    result << ',color=' << (link_rules.line_color || 'gray').inspect
+    result << ',fontcolor=' << (link_rules.line_color || 'gray').inspect
     result << ',dir=both' if link_rules.bidirectional_arrows?
     result << '];'
     result
@@ -101,12 +102,26 @@ class DependencyChart < ChartBase
     tooltip = "#{issue.key}: #{issue.summary}"
     result << ",tooltip=#{tooltip[0..80].inspect}"
     unless issue_rules.color == :none
-      result << %(,style=filled,fillcolor="#{issue_rules.color || color_for(type: issue.type, shade: :light)}")
+      result << %(,style=filled,fillcolor="#{issue_rules.color || color_for(type: issue.type)}")
     end
     result << ']'
     result
   end
 
+  # This used to pull colours from chart_base but the migration to CSS colours kept breaking
+  # this chart so we moved it here, until we're finished with the rest. TODO: Revisit whether
+  # this can also use customizable CSS colours
+  def color_for type:
+    @chart_colors = {
+      'Story' => '#90EE90',
+      'Task' => '#87CEFA',
+      'Bug' => '#ffdab9',
+      'Defect' => '#ffdab9',
+      'Epic' => '#fafad2',
+      'Spike' => '#DDA0DD' # light purple
+    }[type] ||= random_color
+  end
+
   def build_dot_graph
     issue_links = find_links
 
@@ -148,6 +163,7 @@ class DependencyChart < ChartBase
     dot_graph = []
     dot_graph << 'digraph mygraph {'
     dot_graph << 'rankdir=LR'
+    dot_graph << 'bgcolor="transparent"'
 
     # Sort the keys so they are proccessed in a deterministic order.
     visible_issues.values.sort_by(&:key_as_i).each do |issue|
@@ -177,18 +193,6 @@ class DependencyChart < ChartBase
     message
   end
 
-  def default_color_for_issue issue
-    {
-      'Story' => '#90EE90',
-      'Task' => '#87CEFA',
-      'Bug' => '#f08080',
-      'Defect' => '#f08080',
-      'Epic' => '#fafad2',
-      'Spike' => '#7fffd4',
-      'Sub-task' => '#dcdcdc'
-    }[issue.type]
-  end
-
   def shrink_svg svg
     scale = 0.8
     svg.sub(/width="([\d.]+)pt" height="([\d.]+)pt"/) do

data/lib/jirametrics/downloader.rb

@@ -10,7 +10,7 @@ class Downloader
   attr_reader :file_system
 
   # For testing only
-  attr_reader :start_date_in_query
+  attr_reader :start_date_in_query, :board_id_to_filter_id
 
   def initialize download_config:, file_system:, jira_gateway:
     @metadata = {}
@@ -55,7 +55,7 @@ class Downloader
 
   def log text, both: false
     @file_system.log text
-    puts text if both
+    puts text if both && !@quiet_mode
   end
 
   def find_board_ids
@@ -93,7 +93,7 @@ class Downloader
     intercept_jql = @download_config.project_config.settings['intercept_jql']
     jql = intercept_jql.call jql if intercept_jql
 
-    log "  #{jql}"
+    log "  JQL: #{jql}"
     escaped_jql = CGI.escape jql
 
     max_results = 100
@@ -148,19 +148,19 @@ class Downloader
 
   def exit_if_call_failed json
     # Sometimes Jira returns the singular form of errorMessage and sometimes the plural. Consistency FTW.
-    return unless json['errorMessages'] || json['errorMessage']
+    return unless json['error'] || json['errorMessages'] || json['errorMessage']
 
-    log "Download failed. See #{@logfile_name} for details.", both: true
+    log "Download failed. See #{@file_system.logfile_name} for details.", both: true
     log "  #{JSON.pretty_generate(json)}"
     exit 1
   end
 
   def download_statuses
     log '  Downloading all statuses', both: true
-    json = @jira_gateway.call_url relative_url: "/rest/api/2/status"
+    json = @jira_gateway.call_url relative_url: '/rest/api/2/status'
 
     @file_system.save_json(
-      json: json, 
+      json: json,
       filename: "#{@target_path}#{@download_config.project_config.file_prefix}_statuses.json"
     )
   end
@@ -168,13 +168,16 @@ class Downloader
   def download_board_configuration board_id:
     log "  Downloading board configuration for board #{board_id}", both: true
     json = @jira_gateway.call_url relative_url: "/rest/agile/1.0/board/#{board_id}/configuration"
-    exit_if_call_failed json
 
-    @board_id_to_filter_id[board_id] = json['filter']['id'].to_i
+    exit_if_call_failed json
 
     file_prefix = @download_config.project_config.file_prefix
     @file_system.save_json json: json, filename: "#{@target_path}#{file_prefix}_board_#{board_id}_configuration.json"
 
+    # We have a reported bug that blew up on this line. Moved it after the save so we can
+    # actually look at the returned json.
+    @board_id_to_filter_id[board_id] = json['filter']['id'].to_i
+
     download_sprints board_id: board_id if json['type'] == 'scrum'
   end
 
@@ -282,9 +285,8 @@ class Downloader
 
       # Pick up any issues that had a status change in the range
       start_date_text = @start_date_in_query.strftime '%Y-%m-%d'
-      end_date_text = today.strftime '%Y-%m-%d'
       # find_in_range = %((status changed DURING ("#{start_date_text} 00:00","#{end_date_text} 23:59")))
-      find_in_range = %((updated >= "#{start_date_text} 00:00" AND updated <= "#{end_date_text} 23:59"))
+      find_in_range = %(updated >= "#{start_date_text} 00:00")
 
       segments << "(#{find_in_range} OR #{catch_all})"
     end

data/lib/jirametrics/examples/aggregated_project.rb

@@ -10,9 +10,11 @@
 # single team. For that reason, we look at slightly different things that we would on a single team board.
 
 class Exporter
-  def aggregated_project name:, project_names:
+  def aggregated_project name:, project_names:, settings: {}
     project name: name do
       puts name
+      self.settings.merge! settings
+
       aggregate do
         project_names.each do |project_name|
           include_issues_from project_name
@@ -28,32 +30,27 @@ class Exporter
         end
 
         html_report do
+          html '<h1>Boards included in this report</h1><ul>', type: :header
+          board_lines = []
+          included_projects.each do |project|
+            project.all_boards.values.each do |board|
+              board_lines << "<a href='#{project.file_prefix}.html'>#{board.name}</a> from project #{project.name}"
+            end
+          end
+          board_lines.sort.each { |line| html "<li>#{line}</li>", type: :header }
+          html '</ul>', type: :header
+
           cycletime_scatterplot do
             show_trend_lines
+            # For an aggregated report we group by board rather than by type
             grouping_rules do |issue, rules|
               rules.label = issue.board.name
             end
           end
           # aging_work_in_progress_chart
-          daily_wip_chart do
-            header_text 'Daily WIP by Parent'
-            description_text <<-TEXT
-              <p>How much work is in progress, grouped by the parent of the issue. This will give us an
-              indication of how focused we are on higher level objectives. If there are many parent
-              tickets in progress at the same time, either this team has their focus scattered or we
-              aren't doing a good job of
-              <a href="https://improvingflow.com/2024/02/21/slicing-epics.html">splitting those parent
-              tickets</a>. Neither of those is desirable.</p>
-              <p>If you're expecting all work items to have parents and there are a lot that don't,
-              that's also something to look at. Consider whether there is even value in aggregating
-              these projects if they don't share parent dependencies. Aggregation helps us when we're
-              looking at related work and if there aren't parent dependencies then the work may not
-              be related.</p>
-            TEXT
-            grouping_rules do |issue, rules|
-              rules.label = issue.parent&.key || 'No parent'
-              rules.color = 'white' if rules.label == 'No parent'
-            end
+          daily_wip_by_parent_chart do
+            # When aggregating, the chart tends to need more vertical space
+            canvas height: 400, width: 800
           end
           aging_work_table do
             # In an aggregated report, we likely only care about items that are old so exclude anything

data/lib/jirametrics/examples/standard_project.rb

@@ -6,13 +6,19 @@
 # See https://github.com/mikebowler/jirametrics/wiki/Examples-folder for more
 class Exporter
   def standard_project name:, file_prefix:, ignore_issues: nil, starting_status: nil, boards: {},
-      default_board: nil, anonymize: false
+      default_board: nil, anonymize: false, settings: {}, status_category_mappings: {}
 
     project name: name do
       puts name
       self.anonymize if anonymize
 
       settings['blocked_link_text'] = ['is blocked by']
+      self.settings.merge! settings
+
+      status_category_mappings.each do |status, category|
+        status_category_mapping status: status, category: category
+      end
+
       file_prefix file_prefix
       download do
         rolling_date_count 90
@@ -50,7 +56,7 @@ class Exporter
                  type: :header
           end
 
-          discard_changes_before status_becomes: (starting_status || :backlog)
+          discard_changes_before status_becomes: (starting_status || :backlog) # rubocop:disable Style/RedundantParentheses
 
           cycletime_scatterplot do
             show_trend_lines
@@ -77,21 +83,7 @@ class Exporter
           aging_work_table
           daily_wip_by_age_chart
           daily_wip_by_blocked_stalled_chart
-          daily_wip_chart do
-            header_text 'Daily WIP by Parent'
-            description_text <<-TEXT
-              How much work is in progress, grouped by the parent of the issue. This will give us an
-              indication of how focused we are on higher level objectives. If there are many parent
-              tickets in progress at the same time, either this team has their focus scattered or we
-              aren't doing a good job of
-              <a href="https://improvingflow.com/2024/02/21/slicing-epics.html">splitting those parent
-              tickets</a>. Neither of those is desirable.
-            TEXT
-            grouping_rules do |issue, rules|
-              rules.label = issue.parent&.key || 'No parent'
-              rules.color = 'white' if rules.label == 'No parent'
-            end
-          end
+          daily_wip_by_parent_chart
           expedited_chart
           sprint_burndown
           story_point_accuracy_chart
@@ -107,7 +99,7 @@ class Exporter
               when 'Sync'
                 rules.use_bidirectional_arrows
               else
-                # This is a link type that we don't recognized. Dump it to standard out to draw attention
+                # This is a link type that we don't recognize. Dump it to standard out to draw attention
                 # to it.
                 puts "name=#{link.name}, label=#{link.label}"
               end

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
@@ -22,19 +25,18 @@ class ExpeditedChart < ChartBase
 
     header_text 'Expedited work'
     description_text <<-HTML
-      <p>
+      <div class="p">
         This chart only shows issues that have been expedited at some point. We care about these as
         any form of expedited work will affect the entire system and will slow down non-expedited work.
         Refer to this article on
         <a href="https://improvingflow.com/2021/06/16/classes-of-service.html">classes of service</a>
         for a longer explanation on why we want to avoid expedited work.
-      </p>
-      <p>
-        The lines indicate time that this issue was expedited. When the line is red then the issue was
-        expedited at that time. When it's gray then it wasn't. Orange dots indicate the date the work
-        was started and green dots represent the completion date. Lastly, the vertical height of the
-        lines/dots indicates how long it's been since this issue was created.
-      </p>
+      </div>
+      <div class="p">
+        The colour of the line indicates time that this issue was #{color_block '--expedited-color'} expedited
+        or #{color_block '--expedited-chart-no-longer-expedited'} not expedited.
+      </div>
+      #{describe_non_working_days}
     HTML
   end
 
@@ -124,20 +126,20 @@ class ExpeditedChart < ChartBase
       case action
       when :issue_started
         data << make_point(issue: issue, time: time, label: 'Started', expedited: expedited)
-        dot_colors << 'orange'
+        dot_colors << CssVariable['--expedited-chart-dot-issue-started-color']
         point_styles << 'rect'
       when :issue_stopped
         data << make_point(issue: issue, time: time, label: 'Completed', expedited: expedited)
-        dot_colors << 'green'
+        dot_colors << CssVariable['--expedited-chart-dot-issue-stopped-color']
         point_styles << 'rect'
       when :expedite_start
         data << make_point(issue: issue, time: time, label: 'Expedited', expedited: true)
-        dot_colors << 'red'
+        dot_colors << CssVariable['--expedited-chart-dot-expedite-started-color']
         point_styles << 'circle'
         expedited = true
       when :expedite_stop
         data << make_point(issue: issue, time: time, label: 'Not expedited', expedited: false)
-        dot_colors << 'gray'
+        dot_colors << CssVariable['--expedited-chart-dot-expedite-stopped-color']
         point_styles << 'circle'
         expedited = false
       else
@@ -149,7 +151,7 @@ class ExpeditedChart < ChartBase
       last_change_time = expedite_data[-1][0].to_date
       if last_change_time && last_change_time <= date_range.end && stopped_time.nil?
         data << make_point(issue: issue, time: date_range.end, label: 'Still ongoing', expedited: expedited)
-        dot_colors << 'blue' # It won't be visible so it doesn't matter
+        dot_colors << '' # It won't be visible so it doesn't matter
         point_styles << 'dash'
       end
     end

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: {