jirametrics 2.2.1 → 2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f08f0ccb466afa1cba17db109091ab8333b52ed1ec8c1d0b0920c400052f43e7
-  data.tar.gz: f127c794e8fc4c447cab24cd7d2dc149c17dfec6742c6238ed8c5a3f7faeabcb
+  metadata.gz: 2e7264aee468cd14d42fa1c7ba8f737177ba99a78b3f7250d46771f687d4d619
+  data.tar.gz: da813f37b2a6047d6ab844f483008ecdb8c579786bd7bba7f2c01f038a259949
 SHA512:
-  metadata.gz: 6e07a75c020a54dc077d25b2db1742fc143a4174d5b453813d0d2f3969984f1fc8eb6af18cfa092ecf8ef9d07a4754f9b6013e39c170ee2c3b34122aebf0a387
-  data.tar.gz: abddaf6fa818847dc6427df90c919c6ade29cf79735c0a2fd64a31b7815d730e146a695fa0696b8896c60f66828dc16c207852a8c116db7fdabc21c90e429964
+  metadata.gz: c234046627a2c92729c346f44cf78471e74545e01ce3a9810c6c22ed659f6479a0146303ac7fb0652512feafcf8077025577d2a4c039dddf2fd70d6899360adb
+  data.tar.gz: 81f24c30b8d56f8811ed298ca17cebcee6cb32afdbea5cfd12332587aabaa2701b023dc620b651e111226bf66bac9285f84a893549c00c45bd0eb992694a2c64

data/lib/jirametrics/aggregate_config.rb

@@ -19,14 +19,15 @@ class AggregateConfig
       raise "#{@project_config.name}: When aggregating, you must include at least one other project"
     end
 
-    # If the date range wasn't set then calculate it now
+    # If the time range wasn't set then calculate it now
     @project_config.time_range = find_time_range projects: @included_projects if @project_config.time_range.nil?
 
-    adjust_issue_links
+    adjust_issue_links issues: @project_config.issues
   end
 
-  def adjust_issue_links
-    issues = @project_config.issues
+  # IssueLinks just have a reference to the key. Walk through all of them to see if we have a full
+  # issue that we'd already loaded. If we do, then replace it.
+  def adjust_issue_links issues:
     issues.each do |issue|
       issue.issue_links.each do |link|
         other_issue_key = link.other_issue.key
@@ -40,7 +41,7 @@ class AggregateConfig
   def include_issues_from project_name
     project = @project_config.exporter.project_configs.find { |p| p.name == project_name }
     if project.nil?
-      puts "Warning: Aggregated project #{@project_config.name.inspect} is attempting to load " \
+      log "Warning: Aggregated project #{@project_config.name.inspect} is attempting to load " \
         "project #{project_name.inspect} but it can't be found. Is it disabled?"
       return
     end
@@ -57,30 +58,13 @@ class AggregateConfig
     else
       issues = project.file_configs.first.issues
       if project.file_configs.size > 1
-        puts 'More than one file section is defined. For the aggregated view, we always use ' \
+        log 'More than one file section is defined. For the aggregated view, we always use ' \
           'the first file section'
       end
     end
     @project_config.add_issues issues
   end
 
-  def date_range range
-    @project_config.time_range = date_range_to_time_range(
-      date_range: range, timezone_offset: project_config.exporter.timezone_offset
-    )
-  end
-
-  def date_range_to_time_range date_range:, timezone_offset:
-    start_of_first_day = Time.new(
-      date_range.begin.year, date_range.begin.month, date_range.begin.day, 0, 0, 0, timezone_offset
-    )
-    end_of_last_day = Time.new(
-      date_range.end.year, date_range.end.month, date_range.end.day, 23, 59, 59, timezone_offset
-    )
-
-    start_of_first_day..end_of_last_day
-  end
-
   def find_time_range projects:
     raise "Can't calculate aggregated range as no projects were included." if projects.empty?
 
@@ -92,8 +76,12 @@ class AggregateConfig
       latest = range.end if latest.nil? || range.end > latest
     end
 
-    raise "Can't calculate range" if earliest.nil? || latest.nil?
-
     earliest..latest
   end
+
+  private
+
+  def log message
+    @project_config.exporter.file_system.log message
+  end
 end

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -5,7 +5,7 @@ require 'jirametrics/chart_base'
 class AgingWorkBarChart < ChartBase
   @@next_id = 0
 
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text 'Aging Work Bar Chart'
@@ -27,61 +27,77 @@ class AgingWorkBarChart < ChartBase
           <li>The bottom bar indicated #{color_block '--expedited-color'} expedited.</li>
         </ol>
       </p>
-      #{ describe_non_working_days }
+      #{describe_non_working_days}
     HTML
 
     # Because this one will size itself as needed, we start with a smaller default size
     @canvas_height = 80
 
-    instance_eval(&block) if block
+    instance_eval(&block)
   end
 
   def run
-    aging_issues = @issues.select do |issue|
-      cycletime = issue.board.cycletime
-      cycletime.started_time(issue) && cycletime.stopped_time(issue).nil?
-    end
-
-    grow_chart_height_if_too_many_issues aging_issues.size
+    aging_issues = select_aging_issues issues: @issues
 
     today = date_range.end
-    aging_issues.sort! do |a, b|
-      a.board.cycletime.age(b, today: today) <=> b.board.cycletime.age(a, today: today)
-    end
-    data_sets = []
-    aging_issues.each do |issue|
-      cycletime = issue.board.cycletime
-      issue_start_time = cycletime.started_time(issue)
-      issue_start_date = issue_start_time.to_date
-      issue_label = "[#{label_days cycletime.age(issue, today: today)}] #{issue.key}: #{issue.summary}"[0..60]
-      [
-        status_data_sets(issue: issue, label: issue_label, today: today),
-        blocked_data_sets(
-          issue: issue,
-          issue_label: issue_label,
-          stack: 'blocked',
-          issue_start_time: issue_start_time
-        ),
-        data_set_by_block(
-          issue: issue,
-          issue_label: issue_label,
-          title_label: 'Expedited',
-          stack: 'expedited',
-          color: CssVariable['--expedited-color'],
-          start_date: issue_start_date
-        ) { |day| issue.expedited_on_date?(day) }
-      ].compact.flatten.each do |data|
-        data_sets << data
-      end
-    end
+    sort_by_age! issues: aging_issues, today: today
+
+    grow_chart_height_if_too_many_issues aging_issue_count: aging_issues.size
+
+    data_sets = aging_issues
+      .collect { |issue| data_sets_for_one_issue issue: issue, today: today }
+      .flatten
+      .compact
 
     percentage = calculate_percent_line
     percentage_line_x = date_range.end - calculate_percent_line if percentage
 
+    if aging_issues.empty?
+      @description_text = "<p>There is no aging work</p>"
+      return render_top_text(binding) #if aging_issues.empty?
+    end
+
     wrap_and_render(binding, __FILE__)
   end
 
-  def grow_chart_height_if_too_many_issues aging_issue_count
+  def data_sets_for_one_issue issue:, today:
+    cycletime = issue.board.cycletime
+    issue_start_time = cycletime.started_time(issue)
+    issue_start_date = issue_start_time.to_date
+    issue_label = "[#{label_days cycletime.age(issue, today: today)}] #{issue.key}: #{issue.summary}"[0..60]
+    [
+      status_data_sets(issue: issue, label: issue_label, today: today),
+      blocked_data_sets(
+        issue: issue,
+        issue_label: issue_label,
+        stack: 'blocked',
+        issue_start_time: issue_start_time
+      ),
+      data_set_by_block(
+        issue: issue,
+        issue_label: issue_label,
+        title_label: 'Expedited',
+        stack: 'expedited',
+        color: CssVariable['--expedited-color'],
+        start_date: issue_start_date
+      ) { |day| issue.expedited_on_date?(day) }
+    ]
+  end
+
+  def sort_by_age! issues:, today:
+    issues.sort! do |a, b|
+      a.board.cycletime.age(b, today: today) <=> b.board.cycletime.age(a, today: today)
+    end
+  end
+
+  def select_aging_issues issues:
+    issues.select do |issue|
+      cycletime = issue.board.cycletime
+      cycletime.started_time(issue) && cycletime.stopped_time(issue).nil?
+    end
+  end
+
+  def grow_chart_height_if_too_many_issues aging_issue_count:
     px_per_bar = 8
     bars_per_issue = 3
     preferred_height = aging_issue_count * px_per_bar * bars_per_issue
@@ -220,6 +236,8 @@ class AgingWorkBarChart < ChartBase
       }
     end
 
+    return [] if data.empty?
+
     {
       type: 'bar',
       data: data,

data/lib/jirametrics/aging_work_in_progress_chart.rb

@@ -8,7 +8,7 @@ class AgingWorkInProgressChart < ChartBase
   attr_accessor :possible_statuses, :board_id
   attr_reader :board_columns
 
-  def initialize block = nil
+  def initialize block
     super()
     header_text 'Aging Work in Progress'
     description_text <<-HTML

data/lib/jirametrics/aging_work_table.rb

@@ -4,6 +4,7 @@ require 'jirametrics/chart_base'
 
 class AgingWorkTable < ChartBase
   attr_accessor :today, :board_id
+  attr_reader :any_scrum_boards
 
   def initialize block
     super()
@@ -23,20 +24,21 @@ class AgingWorkTable < ChartBase
       </p>
     TEXT
 
-    instance_eval(&block) if block
+    instance_eval(&block)
   end
 
   def run
     @today = date_range.end
-    aging_issues = select_aging_issues
+    aging_issues = select_aging_issues + expedited_but_not_started
 
-    expedited_but_not_started = @issues.select do |issue|
+    wrap_and_render(binding, __FILE__)
+  end
+
+  def expedited_but_not_started
+    @issues.select do |issue|
       cycletime = issue.board.cycletime
       cycletime.started_time(issue).nil? && cycletime.stopped_time(issue).nil? && issue.expedited?
-    end
-    aging_issues += expedited_but_not_started.sort_by(&:created)
-
-    wrap_and_render(binding, __FILE__)
+    end.sort_by(&:created)
   end
 
   def select_aging_issues
@@ -54,10 +56,6 @@ class AgingWorkTable < ChartBase
     aging_issues.sort { |a, b| b.board.cycletime.age(b, today: @today) <=> a.board.cycletime.age(a, today: @today) }
   end
 
-  def icon_span title:, icon:
-    "<span title='#{title}' style='font-size: 0.8em;'>#{icon}</span>"
-  end
-
   def expedited_text issue
     return unless issue.expedited?
 
@@ -85,13 +83,6 @@ class AgingWorkTable < ChartBase
     end
   end
 
-  def unmapped_status_text issue
-    icon_span(
-      title: "Not visible: The status #{issue.status.name.inspect} is not mapped to any column and will not be visible",
-      icon: ' 👀'
-    )
-  end
-
   def fix_versions_text issue
     issue.fix_versions.collect do |fix|
       if fix.released?
@@ -124,19 +115,11 @@ class AgingWorkTable < ChartBase
     end.join('<br />')
   end
 
-  def current_status_visible? issue
-    issue.board.visible_columns.any? { |column| column.status_ids.include? issue.status.id }
-  end
-
   def age_cutoff age = nil
     @age_cutoff = age.to_i if age
     @age_cutoff
   end
 
-  def any_scrum_boards?
-    @any_scrum_boards
-  end
-
   def parent_hierarchy issue
     result = []
 

data/lib/jirametrics/board_config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class BoardConfig
-  attr_reader :id, :project_config
+  attr_reader :id, :project_config, :board
 
   def initialize id:, block:, project_config:
     @id = id
@@ -26,6 +26,6 @@ class BoardConfig
   end
 
   def expedited_priority_names *priority_names
-    @board.expedited_priority_names = priority_names unless priority_names.empty?
+    @board.expedited_priority_names = priority_names
   end
 end

data/lib/jirametrics/chart_base.rb

@@ -2,9 +2,9 @@
 
 class ChartBase
   attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
-    :time_range, :data_quality, :holiday_dates, :settings
+    :time_range, :data_quality, :holiday_dates, :settings, :issues, :file_system
   attr_writer :aggregated_project
-  attr_reader :issues, :canvas_width, :canvas_height
+  attr_reader :canvas_width, :canvas_height
 
   @@chart_counter = 0
 
@@ -34,7 +34,7 @@ class ChartBase
     caller_binding.eval "chart_id='chart#{next_id}'" # chart_id=chart3
 
     @html_directory = "#{pathname.dirname}/html"
-    erb = ERB.new File.read "#{@html_directory}/#{$1}.erb"
+    erb = ERB.new file_system.load "#{@html_directory}/#{$1}.erb"
     erb.result(caller_binding)
   end
 
@@ -100,7 +100,7 @@ class ChartBase
     issues_id = next_id
 
     issue_descriptions.sort! { |a, b| a[0].key_as_i <=> b[0].key_as_i }
-    erb = ERB.new File.read "#{@html_directory}/collapsible_issues_panel.erb"
+    erb = ERB.new file_system.load "#{@html_directory}/collapsible_issues_panel.erb"
     erb.result(binding)
   end
 
@@ -153,17 +153,6 @@ class ChartBase
     end
   end
 
-  def sprints_in_time_range board
-    board.sprints.select do |sprint|
-      sprint_end_time = sprint.completed_time || sprint.end_time
-      sprint_start_time = sprint.start_time
-      next false if sprint_start_time.nil?
-
-      time_range.include?(sprint_start_time) || time_range.include?(sprint_end_time) ||
-        (sprint_start_time < time_range.begin && sprint_end_time > time_range.end)
-    end || []
-  end
-
   def chart_format object
     if object.is_a? Time
       # "2022-04-09T11:38:30-07:00"
@@ -173,12 +162,14 @@ class ChartBase
     end
   end
 
-  def header_text text
-    @header_text = text
+  def header_text text = nil
+    @header_text = text if text
+    @header_text
   end
 
-  def description_text text
-    @description_text = text
+  def description_text text = nil
+    @description_text = text if text
+    @description_text
   end
 
   def format_integer number
@@ -188,26 +179,35 @@ class ChartBase
   def format_status name_or_id, board:, is_category: false
     begin
       statuses = board.possible_statuses.expand_statuses([name_or_id])
-    rescue RuntimeError => e
-      return "<span style='color: red'>#{name_or_id}</span>" if e.message.match?(/^Status not found:/)
-
-      throw e
+    rescue StatusNotFoundError => e
+      return "<span style='color: red'>#{name_or_id}</span>"
     end
-    raise "Expected exactly one match and got #{statuses.inspect} for #{name_or_id.inspect}" if statuses.size > 1
 
     status = statuses.first
     color = status_category_color status
 
+    visibility = ''
+    if is_category == false && board.visible_columns.none? { |column| column.status_ids.include? status.id }
+      visibility = icon_span(
+      title: "Not visible: The status #{status.name.inspect} is not mapped to any column and will not be visible",
+      icon: ' 👀'
+    )
+
+    end
     text = is_category ? status.category_name : status.name
-    "<span title='Category: #{status.category_name}'>#{color_block color.name} #{text}</span>"
+    "<span title='Category: #{status.category_name}'>#{color_block color.name} #{text}</span>#{visibility}"
+  end
+
+  def icon_span title:, icon:
+    "<span title='#{title}' style='font-size: 0.8em;'>#{icon}</span>"
   end
 
   def status_category_color status
     case status.category_name
-    when nil then 'black'
     when 'To Do' then CssVariable['--status-category-todo-color']
     when 'In Progress' then CssVariable['--status-category-inprogress-color']
     when 'Done' then CssVariable['--status-category-done-color']
+    else 'black' # Theoretically impossible but seen in prod.
     end
   end
 
@@ -225,18 +225,6 @@ class ChartBase
     @canvas_responsive
   end
 
-  def filter_issues &block
-    @filter_issues_block = block
-  end
-
-  def issues= issues
-    @issues = issues
-    return unless @filter_issues_block
-
-    @issues = issues.filter_map { |i| @filter_issues_block.call(i) }.uniq
-    puts @issues.collect(&:key).join(', ')
-  end
-
   def color_block color, title: nil
     result = +''
     result << "<div class='color_block' style='background: var(#{color});'"
@@ -252,5 +240,5 @@ class ChartBase
         and any other holidays mentioned in the configuration.
       </div>
     TEXT
-  end  
+  end
 end

data/lib/jirametrics/cycletime_histogram.rb

@@ -6,7 +6,7 @@ class CycletimeHistogram < ChartBase
   include GroupableIssueChart
   attr_accessor :possible_statuses
 
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text 'Cycletime Histogram'

data/lib/jirametrics/cycletime_scatterplot.rb

@@ -7,7 +7,7 @@ class CycletimeScatterplot < ChartBase
 
   attr_accessor :possible_statuses
 
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text 'Cycletime Scatterplot'

data/lib/jirametrics/daily_wip_by_age_chart.rb

@@ -3,7 +3,7 @@
 require 'jirametrics/daily_wip_chart'
 
 class DailyWipByAgeChart < DailyWipChart
-  def initialize block = nil
+  def initialize block
     super(block)
 
     add_trend_line line_color: '--aging-work-in-progress-by-age-trend-line-color', group_labels: [

data/lib/jirametrics/daily_wip_chart.rb

@@ -14,7 +14,7 @@ end
 class DailyWipChart < ChartBase
   attr_accessor :possible_statuses
 
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text default_header_text
@@ -27,9 +27,6 @@ class DailyWipChart < ChartBase
         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
@@ -45,8 +42,6 @@ class DailyWipChart < ChartBase
       end + data_sets
     end
 
-    # grow_chart_height_if_too_many_data_sets data_sets.size
-
     wrap_and_render(binding, __FILE__)
   end
 
@@ -174,11 +169,4 @@ class DailyWipChart < ChartBase
       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/dependency_chart.rb

@@ -52,7 +52,7 @@ class DependencyChart < ChartBase
   end
 
   def run
-    instance_eval(&@rules_block) if @rules_block
+    instance_eval(&@rules_block)
 
     dot_graph = build_dot_graph
     return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if dot_graph.nil?

data/lib/jirametrics/{story_point_accuracy_chart.rb → estimate_accuracy_chart.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-class StoryPointAccuracyChart < ChartBase
-  def initialize configuration_block = nil
+class EstimateAccuracyChart < ChartBase
+  def initialize configuration_block
     super()
 
     header_text 'Estimate Accuracy'
@@ -12,7 +12,7 @@ class StoryPointAccuracyChart < ChartBase
       </div>
       <div class="p">
         The #{color_block '--estimate-accuracy-chart-completed-fill-color'} completed dots indicate
-        cycletimes. 
+        cycletimes.
         <% if @has_aging_data %>
           The #{color_block '--estimate-accuracy-chart-active-fill-color'} aging dots
           (click on the legend to turn them on) show the current
@@ -27,7 +27,7 @@ class StoryPointAccuracyChart < ChartBase
     @y_axis_block = ->(issue, start_time) { story_points_at(issue: issue, start_time: start_time)&.to_f }
     @y_axis_sort_order = nil
 
-    instance_eval(&configuration_block) if configuration_block
+    instance_eval(&configuration_block)
   end
 
   def run
@@ -39,26 +39,7 @@ class StoryPointAccuracyChart < ChartBase
   end
 
   def scan_issues
-    aging_hash = {}
-    completed_hash = {}
-
-    issues.each do |issue|
-      cycletime = issue.board.cycletime
-      start_time = cycletime.started_time(issue)
-      stop_time = cycletime.stopped_time(issue)
-
-      next unless start_time
-
-      hash = stop_time ? completed_hash : aging_hash
-
-      estimate = @y_axis_block.call issue, start_time
-      cycle_time = ((stop_time&.to_date || date_range.end) - start_time.to_date).to_i + 1
-
-      next if estimate.nil?
-
-      key = [estimate, cycle_time]
-      (hash[key] ||= []) << issue
-    end
+    completed_hash, aging_hash = split_into_completed_and_aging issues: issues
 
     @has_aging_data = !aging_hash.empty?
 
@@ -93,7 +74,32 @@ class StoryPointAccuracyChart < ChartBase
         'borderColor' => border_color,
         'hidden' => starts_hidden
       }
-    end.compact
+    end
+  end
+
+  def split_into_completed_and_aging issues:
+    aging_hash = {}
+    completed_hash = {}
+
+    issues.each do |issue|
+      cycletime = issue.board.cycletime
+      start_time = cycletime.started_time(issue)
+      stop_time = cycletime.stopped_time(issue)
+
+      next unless start_time
+
+      hash = stop_time ? completed_hash : aging_hash
+
+      estimate = @y_axis_block.call issue, start_time
+      cycle_time = ((stop_time&.to_date || date_range.end) - start_time.to_date).to_i + 1
+
+      next if estimate.nil?
+
+      key = [estimate, cycle_time]
+      (hash[key] ||= []) << issue
+    end
+
+    [completed_hash, aging_hash]
   end
 
   def hash_sorter

data/lib/jirametrics/examples/standard_project.rb

@@ -86,7 +86,7 @@ class Exporter
           daily_wip_by_parent_chart
           expedited_chart
           sprint_burndown
-          story_point_accuracy_chart
+          estimate_accuracy_chart
 
           dependency_chart do
             link_rules do |link, rules|

data/lib/jirametrics/expedited_chart.rb

@@ -20,7 +20,7 @@ class ExpeditedChart < ChartBase
   attr_accessor :issues, :cycletime, :possible_statuses, :date_range
   attr_reader :expedited_label
 
-  def initialize
+  def initialize block
     super()
 
     header_text 'Expedited work'
@@ -38,6 +38,8 @@ class ExpeditedChart < ChartBase
       </div>
       #{describe_non_working_days}
     HTML
+
+    instance_eval(&block)
   end
 
   def run

data/lib/jirametrics/exporter.rb

@@ -32,11 +32,12 @@ class Exporter
 
   def initialize file_system: FileSystem.new
     @project_configs = []
-    @timezone_offset = '+00:00'
     @target_path = '.'
     @holiday_dates = []
     @downloading = false
     @file_system = file_system
+
+    timezone_offset '+00:00'
   end
 
   def export name_filter:
@@ -79,7 +80,6 @@ class Exporter
   end
 
   def project name: nil, &block
-    raise 'target_path was never set!' if @target_path.nil?
     raise 'jira_config not set' if @jira_config.nil?
 
     @project_configs << ProjectConfig.new(