jirametrics 2.2.1 → 2.4pre1

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

@@ -5,7 +5,7 @@ require 'fileutils'
 class Object
   def deprecated message:, date:
     text = +''
-    text << "Deprecated(#{date}):"
+    text << "Deprecated(#{date}): "
     text << message
     text << "\n-> Called from #{caller(1..1).first}"
     warn text
@@ -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(

data/lib/jirametrics/file_config.rb

@@ -5,10 +5,11 @@ require 'csv'
 class FileConfig
   attr_reader :project_config, :issues
 
-  def initialize project_config:, block:
+  def initialize project_config:, block:, today: Date.today
     @project_config = project_config
     @block = block
     @columns = nil
+    @today = today
   end
 
   def run
@@ -18,11 +19,8 @@ class FileConfig
     if @columns
       all_lines = prepare_grid
 
-      File.open(output_filename, 'w') do |file|
-        all_lines.each do |output_line|
-          file.puts CSV.generate_line(output_line)
-        end
-      end
+      content = all_lines.collect { |line| CSV.generate_line line }.join
+      project_config.exporter.file_system.save_file content: content, filename: output_filename
     elsif @html_report
       @html_report.run
     else
@@ -59,7 +57,7 @@ class FileConfig
     segments = []
     segments << project_config.target_path
     segments << project_config.file_prefix
-    segments << (@file_suffix || "-#{Date.today}.csv")
+    segments << (@file_suffix || "-#{@today}.csv")
     segments.join
   end
 
@@ -68,7 +66,9 @@ class FileConfig
   # is that all empty values in the first column should be at the bottom.
   def sort_output all_lines
     all_lines.sort do |a, b|
-      if a[0].nil?
+      if a[0] == b[0]
+        a[1..] <=> b[1..]
+      elsif a[0].nil?
         1
       elsif b[0].nil?
         -1
@@ -112,6 +112,10 @@ class FileConfig
     object.to_s
   end
 
+  def to_integer object
+    object.to_i
+  end
+
   def file_suffix suffix = nil
     @file_suffix = suffix unless suffix.nil?
     @file_suffix

data/lib/jirametrics/file_system.rb

@@ -5,17 +5,26 @@ require 'json'
 class FileSystem
   attr_accessor :logfile, :logfile_name
 
+  # Effectively the same as File.read except it forces the encoding to UTF-8
+  def load filename
+    File.read filename, encoding: 'UTF-8'
+  end
+
   def load_json filename, fail_on_error: true
     return nil if fail_on_error == false && File.exist?(filename) == false
 
-    JSON.parse File.read(filename)
+    JSON.parse load(filename)
   end
 
   def save_json json:, filename:
+    save_file content: JSON.pretty_generate(compress json), filename: filename
+  end
+
+  def save_file content:, filename:
     file_path = File.dirname(filename)
     FileUtils.mkdir_p file_path unless File.exist?(file_path)
 
-    File.write(filename, JSON.pretty_generate(compress json))
+    File.write(filename, content)
   end
 
   def log message

data/lib/jirametrics/groupable_issue_chart.rb

@@ -5,10 +5,8 @@ require 'jirametrics/grouping_rules'
 
 module GroupableIssueChart
   def init_configuration_block user_provided_block, &default_block
-    if user_provided_block
-      instance_eval(&user_provided_block)
-      return if @group_by_block
-    end
+    instance_eval(&user_provided_block)
+    return if @group_by_block
 
     instance_eval(&default_block)
   end

data/lib/jirametrics/hierarchy_table.rb

@@ -3,15 +3,15 @@
 require 'jirametrics/chart_base'
 
 class HierarchyTable < ChartBase
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text 'Hierarchy Table'
-    description_text <<-HTML
-      <p>content goes here</p>
+    description_text <<~HTML
+      <p>Shows all issues through this time period and the full hierarchy of their parents.</p>
     HTML
 
-    instance_eval(&block) if block
+    instance_eval(&block)
   end
 
   def run

data/lib/jirametrics/html/aging_work_table.erb

@@ -7,7 +7,7 @@
       <th>Issue</th>
       <th>Status</th>
       <th>Fix versions</th>
-      <% if any_scrum_boards? %>
+      <% if any_scrum_boards %>
         <th>Sprints</th>
       <% end %>
       <th><%= aggregated_project? ? 'Board' : 'Who' %></th>
@@ -40,9 +40,9 @@
             </div>
           <% end %>
         </td>
-        <td><%= format_status issue.status.name, board: issue.board %><%= unmapped_status_text(issue) unless current_status_visible? issue %></td>
+        <td><%= format_status issue.status.name, board: issue.board %></td>
         <td><%= fix_versions_text(issue) %></td>
-        <% if any_scrum_boards? %>
+        <% if any_scrum_boards %>
           <td><%= sprints_text(issue) %></td>
         <% end %>
         <td><%= aggregated_project? ? issue.board.name : issue.assigned_to %></td>

data/lib/jirametrics/html/index.erb

@@ -1,6 +1,7 @@
 <html>
   <head>
     <meta charset="UTF-8">
+    <link rel="icon" type="image/png" href="https://github.com/mikebowler/jirametrics/blob/main/favicon.png?raw=true" />
     <script src="https://cdn.jsdelivr.net/npm/moment@2.29.1/moment.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/chart.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/chartjs-adapter-moment@^1"></script>

data/lib/jirametrics/html_report_config.rb

@@ -9,18 +9,45 @@ class HtmlReportConfig
 
   attr_reader :file_config, :sections
 
+  def self.define_chart name:, classname:, deprecated_warning: nil, deprecated_date: nil
+    lines = []
+    lines << "def #{name} &block"
+    lines << '  block = ->(_) {} unless block'
+    if deprecated_warning
+      lines << "  deprecated date: #{deprecated_date.inspect}, message: #{deprecated_warning.inspect}"
+    end
+    lines << "  execute_chart #{classname}.new(block)"
+    lines << 'end'
+    module_eval lines.join("\n"), __FILE__, __LINE__
+  end
+
+  define_chart name: 'aging_work_bar_chart', classname: 'AgingWorkBarChart'
+  define_chart name: 'aging_work_table', classname: 'AgingWorkTable'
+  define_chart name: 'cycletime_scatterplot', classname: 'CycletimeScatterplot'
+  define_chart name: 'daily_wip_chart', classname: 'DailyWipChart'
+  define_chart name: 'daily_wip_by_age_chart', classname: 'DailyWipByAgeChart'
+  define_chart name: 'daily_wip_by_blocked_stalled_chart', classname: 'DailyWipByBlockedStalledChart'
+  define_chart name: 'daily_wip_by_parent_chart', classname: 'DailyWipByParentChart'
+  define_chart name: 'throughput_chart', classname: 'ThroughputChart'
+  define_chart name: 'expedited_chart', classname: 'ExpeditedChart'
+  define_chart name: 'cycletime_histogram', classname: 'CycletimeHistogram'
+  define_chart name: 'estimate_accuracy_chart', classname: 'EstimateAccuracyChart'
+  define_chart name: 'hierarchy_table', classname: 'HierarchyTable'
+
+  define_chart name: 'daily_wip_by_type', classname: 'DailyWipChart',
+    deprecated_warning: 'This is the same as daily_wip_chart. Please use that one', deprecated_date: '2024-05-23'
+  define_chart name: 'story_point_accuracy_chart', classname: 'EstimateAccuracyChart',
+    deprecated_warning: 'Renamed to estimate_accuracy_chart. Please use that one', deprecated_date: '2024-05-23'
+
   def initialize file_config:, block:
     @file_config = file_config
     @block = block
-    # @cycletimes = []
     @sections = []
   end
 
   def cycletime label = nil, &block
-    # TODO: This is about to become deprecated
-
     @file_config.project_config.all_boards.each_value do |board|
-      raise 'Multiple cycletimes not supported yet' if board.cycletime
+      raise 'Multiple cycletimes not supported' if board.cycletime
 
       board.cycletime = CycleTimeConfig.new(parent_config: self, label: label, block: block)
     end
@@ -39,21 +66,36 @@ class HtmlReportConfig
     execute_chart DataQualityReport.new(@original_issue_times || {})
     @sections.rotate!(-1)
 
-    File.open @file_config.output_filename, 'w' do |file|
-      html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
-      css = load_css html_directory: html_directory
-      erb = ERB.new File.read(File.join(html_directory, 'index.erb'))
-      file.puts erb.result(binding)
-    end
+    html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
+    css = load_css html_directory: html_directory
+    erb = ERB.new file_system.load(File.join(html_directory, 'index.erb'))
+    file_system.save_file content: erb.result(binding), filename: @file_config.output_filename
+  end
+
+  def file_system
+    @file_config.project_config.exporter.file_system
+  end
+
+  def log message
+    file_system.log message
   end
 
   def load_css html_directory:
-    base_css = File.read(File.join(html_directory, 'index.css'))
+    base_css_filename = File.join(html_directory, 'index.css')
+    base_css = file_system.load(base_css_filename)
+    log("Loaded CSS:  #{base_css_filename}")
+
     extra_css_filename = settings['include_css']
-    return base_css unless extra_css_filename && File.exist?(extra_css_filename)
+    if extra_css_filename
+      if File.exist?(extra_css_filename)
+        base_css << "\n\n" << file_system.load(extra_css_filename)
+        log("Loaded CSS:  #{extra_css_filename}")
+      else
+        log("Unable to find specified CSS file: #{extra_css_filename}")
+      end
+    end
 
-    @file_config.project_config.exporter.file_system.log("including css from file: #{extra_css_filename}")
-    base_css << "\n\n" << File.read(extra_css_filename)
+    base_css
   end
 
   def board_id id = nil
@@ -66,6 +108,8 @@ class HtmlReportConfig
   end
 
   def aging_work_in_progress_chart board_id: nil, &block
+    block ||= ->(_) {}
+
     if board_id.nil?
       ids = issues.collect { |i| i.board.id }.uniq.sort
     else
@@ -79,50 +123,6 @@ class HtmlReportConfig
     end
   end
 
-  def aging_work_bar_chart &block
-    execute_chart AgingWorkBarChart.new(block)
-  end
-
-  def aging_work_table &block
-    execute_chart AgingWorkTable.new(block)
-  end
-
-  def cycletime_scatterplot &block
-    execute_chart CycletimeScatterplot.new block
-  end
-
-  def daily_wip_chart &block
-    execute_chart DailyWipChart.new(block)
-  end
-
-  def daily_wip_by_age_chart &block
-    execute_chart DailyWipByAgeChart.new block
-  end
-
-  def daily_wip_by_type &block
-    execute_chart DailyWipChart.new block
-  end
-
-  def daily_wip_by_blocked_stalled_chart
-    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
-
-  def expedited_chart
-    execute_chart ExpeditedChart.new
-  end
-
-  def cycletime_histogram &block
-    execute_chart CycletimeHistogram.new block
-  end
-
   def random_color
     "##{Random.bytes(3).unpack1('H*')}"
   end
@@ -140,14 +140,6 @@ class HtmlReportConfig
     end
   end
 
-  def story_point_accuracy_chart &block
-    execute_chart StoryPointAccuracyChart.new block
-  end
-
-  def hierarchy_table &block
-    execute_chart HierarchyTable.new block
-  end
-
   def discard_changes_before_hook issues_cutoff_times
     # raise 'Cycletime must be defined before using discard_changes_before' unless @cycletime
 
@@ -173,6 +165,7 @@ class HtmlReportConfig
   def execute_chart chart, &after_init_block
     project_config = @file_config.project_config
 
+    chart.file_system = file_system
     chart.issues = issues
     chart.time_range = project_config.time_range
     chart.timezone_offset = timezone_offset
@@ -199,19 +192,13 @@ class HtmlReportConfig
     @file_config.issues
   end
 
+  # For use by the user config
   def find_board id
     @file_config.project_config.all_boards[id]
   end
 
-  def project_name
-    @file_config.project_config.name
-  end
-
+  # For use by the user config
   def boards
     @file_config.project_config.board_configs.collect(&:id).collect { |id| find_board id }
   end
-
-  def find_project_by_name name
-    @file_config.project_config.exporter.project_configs.find { |p| p.name == name }
-  end
 end