jirametrics 2.11 → 2.12pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 670df42835c7d41e30dcde01ead744a132f81313165297d434334e272de795c7
-  data.tar.gz: 12822842210b4aeddb7f59e6681a9f1bd25060bae0ff98e8490d14e895dea657
+  metadata.gz: 499b5a712159d628f0c19b54d826bcfff4ed52a7a74563f171505df6f9bb9059
+  data.tar.gz: 694f1973f07bbd88f062a2d1250690df2d43dc326d4368492ac58d89af5184c7
 SHA512:
-  metadata.gz: a4f36b8921c94a457710dc68251a9a2ddb38be2f0f7027991cf381fdf1cff28d2e549e508314733a3c753f583fd3c695b7e4979e1bb7be43c45de90ec001cbab
-  data.tar.gz: 28a2553b31cd4de5fce0c943da38643ad13dbfad3a8bddc77f4764e179394968966bb676e70daa75a4faeb42a67027fb7efb63895b56c01a3db563a029df66aa
+  metadata.gz: 1b349c33e08ca97f135fb0d1a2625a238b35948ca16aa2e421887a79cc18c6f2537790e8093ce47b9e1cdc5b1e694f533efa2663b8739e00e5518b61908bb08e
+  data.tar.gz: f0da1809b457e37e473e7893c86dfc3009738ba98e5a9eba913f9a61f7ccd533a9b09deb1f3fa0126bfadbe3909cd811d3f590293c9fd9128d811ba3bf8aa56a

data/lib/jirametrics/board.rb

@@ -117,4 +117,8 @@ class Board
       all_names << name
     end
   end
+
+  def estimation_configuration
+    EstimationConfiguration.new raw: raw['estimation']
+  end
 end

data/lib/jirametrics/board_movement_calculator.rb

@@ -124,6 +124,12 @@ class BoardMovementCalculator
     column_name, entry_time = find_current_column_and_entry_time_in_column issue
     return [nil, 'This issue is not visible on the board. No way to predict when it will be done.'] if column_name.nil?
 
+    if entry_time.nil?
+      message = "Couldn't find the time issue #{issue.key} entered column #{column_name.inspect}"
+      puts message, issue.dump
+      return [nil, message]
+    end
+
     age_in_column = (today - entry_time.to_date).to_i + 1
 
     message = nil

data/lib/jirametrics/change_item.rb

@@ -31,8 +31,6 @@ class ChangeItem
 
   def sprint? = (field == 'Sprint')
 
-  def story_points? = (field == 'Story Points')
-
   def link? = (field == 'Link')
 
   def labels? = (field == 'labels')

data/lib/jirametrics/estimate_accuracy_chart.rb

@@ -22,15 +22,18 @@ class EstimateAccuracyChart < ChartBase
       </div>
     HTML
 
-    @y_axis_label = 'Story Point Estimates'
     @y_axis_type = 'linear'
-    @y_axis_block = ->(issue, start_time) { story_points_at(issue: issue, start_time: start_time)&.to_f }
+    @y_axis_block = ->(issue, start_time) { estimate_at(issue: issue, start_time: start_time)&.to_f }
     @y_axis_sort_order = nil
 
     instance_eval(&configuration_block)
   end
 
   def run
+    if @y_axis_label.nil?
+      text = current_board.estimation_configuration.units == :story_points ? 'Story Points' : 'Days'
+      @y_axis_label = "Estimated #{text}"
+    end
     data_sets = scan_issues
 
     return '' if data_sets.empty?
@@ -41,6 +44,7 @@ class EstimateAccuracyChart < ChartBase
   def scan_issues
     completed_hash, aging_hash = split_into_completed_and_aging issues: issues
 
+    estimation_units = current_board.estimation_configuration.units
     @has_aging_data = !aging_hash.empty?
 
     [
@@ -53,9 +57,13 @@ class EstimateAccuracyChart < ChartBase
       # We sort so that the smaller circles are in front of the bigger circles.
       data = hash.sort(&hash_sorter).collect do |key, values|
         estimate, cycle_time = *key
-        estimate_label = "#{estimate}#{'pts' if @y_axis_type == 'linear'}"
-        title = ["Estimate: #{estimate_label}, Cycletime: #{label_days(cycle_time)}, #{values.size} issues"] +
-          values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
+        title = [
+          "Estimate: #{estimate_label(estimate: estimate, estimation_units: estimation_units)}, " \
+            "Cycletime: #{label_days(cycle_time)}, " \
+            "#{values.size} issues"
+        ] + values.collect { |issue| "#{issue.key}: #{issue.summary}" }
+
         {
           'x' => cycle_time,
           'y' => estimate,
@@ -77,6 +85,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
+  def estimate_label estimate:, estimation_units:
+    if @y_axis_type == 'linear'
+      if estimation_units == :story_points
+        estimate_label = "#{estimate}pts"
+      elsif estimation_units == :seconds
+        estimate_label = label_days estimate
+      end
+    end
+    estimate_label = estimate.to_s if estimate_label.nil?
+    estimate_label
+  end
+
   def split_into_completed_and_aging issues:
     aging_hash = {}
     completed_hash = {}
@@ -126,14 +146,18 @@ class EstimateAccuracyChart < ChartBase
     end
   end
 
-  def story_points_at issue:, start_time:
-    story_points = nil
+  def estimate_at issue:, start_time:, estimation_configuration: current_board.estimation_configuration
+    estimate = nil
+
     issue.changes.each do |change|
-      return story_points if change.time >= start_time
+      return estimate if change.time >= start_time
 
-      story_points = change.value if change.story_points?
+      if change.field == estimation_configuration.display_name || change.field == estimation_configuration.field_id
+        estimate = change.value
+        estimate = estimate.to_f / (24 * 60 * 60) if estimation_configuration.units == :seconds
+      end
     end
-    story_points
+    estimate
   end
 
   def y_axis label:, sort_order: nil, &block

data/lib/jirametrics/estimation_configuration.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class EstimationConfiguration
+  attr_reader :units, :display_name, :field_id
+
+  def initialize raw:
+    @units = :story_points
+    @display_name = 'Story Points'
+
+    # If there wasn't an estimation section they rely on all defaults
+    return if raw.nil?
+
+    if raw['type'] == 'field'
+      @field_id = raw['field']['fieldId']
+      @display_name = raw['field']['displayName']
+      if @field_id == 'timeoriginalestimate'
+        @units = :seconds
+        @display_name = 'Original estimate'
+      end
+    elsif raw['type'] == 'issueCount'
+      @display_name = 'Issue Count'
+      @units = :issue_count
+    end
+  end
+end

data/lib/jirametrics/examples/standard_project.rb

@@ -72,8 +72,12 @@ class Exporter
             grouping_rules do |issue, rules|
               if issue.resolution
                 rules.label = "#{issue.status.name}:#{issue.resolution}"
-              else
-                rules.label = issue.status.name
+                if rules.label.start_with? 'Completed'
+                  rules.label = 'Cancelled'
+                elsif rules.label.start_with? 'Closed'
+                rules.label = 'Done'
+                # rules.label = issue.status.name
+                end 
               end
             end
           end

data/lib/jirametrics/project_config.rb

@@ -151,6 +151,8 @@ class ProjectConfig
   end
 
   def status_category_mapping status:, category:
+    return if @exporter.downloading?
+
     status, status_id = possible_statuses.parse_name_id status
     category, category_id = possible_statuses.parse_name_id category
 

data/lib/jirametrics/sprint_burndown.rb

@@ -121,11 +121,13 @@ class SprintBurndown < ChartBase
 
   # select all the changes that are relevant for the sprint. If this issue never appears in this sprint then return [].
   def changes_for_one_issue issue:, sprint:
-    story_points = 0.0
+    estimate = 0.0
     ever_in_sprint = false
     currently_in_sprint = false
     change_data = []
 
+    estimate_display_name = current_board.estimation_configuration.display_name
+
     issue_completed_time = issue.board.cycletime.started_stopped_times(issue).last
     completed_has_been_tracked = false
 
@@ -140,26 +142,26 @@ class SprintBurndown < ChartBase
         if currently_in_sprint == false && in_change_item
           action = :enter_sprint
           ever_in_sprint = true
-          value = story_points
+          value = estimate
         elsif currently_in_sprint && in_change_item == false
           action = :leave_sprint
-          value = -story_points
+          value = -estimate
         end
         currently_in_sprint = in_change_item
-      elsif change.story_points? && (issue_completed_time.nil? || change.time < issue_completed_time)
+      elsif change.field == estimate_display_name && (issue_completed_time.nil? || change.time < issue_completed_time)
         action = :story_points
-        story_points = change.value.to_f
-        value = story_points - change.old_value.to_f
+        estimate = change.value.to_f
+        value = estimate - change.old_value.to_f
       elsif completed_has_been_tracked == false && change.time == issue_completed_time
         completed_has_been_tracked = true
         action = :issue_stopped
-        value = -story_points
+        value = -estimate
       end
 
       next unless action
 
       change_data << SprintIssueChangeData.new(
-        time: change.time, issue: issue, action: action, value: value, story_points: story_points
+        time: change.time, issue: issue, action: action, value: value, estimate: estimate
       )
     end
 
@@ -176,7 +178,7 @@ class SprintBurndown < ChartBase
     summary_stats = SprintSummaryStats.new
     summary_stats.completed = 0.0
 
-    story_points = 0.0
+    estimate = 0.0
     start_data_written = false
     data_set = []
 
@@ -185,11 +187,11 @@ class SprintBurndown < ChartBase
     change_data_for_sprint.each do |change_data|
       if start_data_written == false && change_data.time >= sprint.start_time
         data_set << {
-          y: story_points,
+          y: estimate,
           x: chart_format(sprint.start_time),
-          title: "Sprint started with #{story_points} points"
+          title: "Sprint started with #{estimate} points"
         }
-        summary_stats.started = story_points
+        summary_stats.started = estimate
         start_data_written = true
       end
 
@@ -198,12 +200,12 @@ class SprintBurndown < ChartBase
       case change_data.action
       when :enter_sprint
         issues_currently_in_sprint << change_data.issue.key
-        story_points += change_data.story_points
+        estimate += change_data.estimate
       when :leave_sprint
         issues_currently_in_sprint.delete change_data.issue.key
-        story_points -= change_data.story_points
+        estimate -= change_data.estimate
       when :story_points
-        story_points += change_data.value if issues_currently_in_sprint.include? change_data.issue.key
+        estimate += change_data.value if issues_currently_in_sprint.include? change_data.issue.key
       end
 
       next unless change_data.time >= sprint.start_time
@@ -213,26 +215,26 @@ class SprintBurndown < ChartBase
       when :story_points
         next unless issues_currently_in_sprint.include? change_data.issue.key
 
-        old_story_points = change_data.story_points - change_data.value
-        message = "Story points changed from #{old_story_points} points to #{change_data.story_points} points"
+        old_estimate = change_data.estimate - change_data.value
+        message = "Story points changed from #{old_estimate} points to #{change_data.estimate} points"
         summary_stats.points_values_changed = true
       when :enter_sprint
-        message = "Added to sprint with #{change_data.story_points || 'no'} points"
-        summary_stats.added += change_data.story_points
+        message = "Added to sprint with #{change_data.estimate || 'no'} points"
+        summary_stats.added += change_data.estimate
       when :issue_stopped
-        story_points -= change_data.story_points
-        message = "Completed with #{change_data.story_points || 'no'} points"
+        estimate -= change_data.estimate
+        message = "Completed with #{change_data.estimate || 'no'} points"
         issues_currently_in_sprint.delete change_data.issue.key
-        summary_stats.completed += change_data.story_points
+        summary_stats.completed += change_data.estimate
       when :leave_sprint
-        message = "Removed from sprint with #{change_data.story_points || 'no'} points"
-        summary_stats.removed += change_data.story_points
+        message = "Removed from sprint with #{change_data.estimate || 'no'} points"
+        summary_stats.removed += change_data.estimate
       else
         raise "Unexpected action: #{change_data.action}"
       end
 
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(change_data.time),
         title: "#{change_data.issue.key} #{message}"
       }
@@ -241,27 +243,27 @@ class SprintBurndown < ChartBase
     unless start_data_written
       # There was nothing that triggered us to write the sprint started block so do it now.
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(sprint.start_time),
-        title: "Sprint started with #{story_points} points"
+        title: "Sprint started with #{estimate} points"
       }
-      summary_stats.started = story_points
+      summary_stats.started = estimate
     end
 
     if sprint.completed_time
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(sprint.completed_time),
-        title: "Sprint ended with #{story_points} points unfinished"
+        title: "Sprint ended with #{estimate} points unfinished"
       }
-      summary_stats.remaining = story_points
+      summary_stats.remaining = estimate
     end
 
     unless sprint.completed_at?(time_range.end)
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(time_range.end),
-        title: "Sprint still active. #{story_points} points still in progress."
+        title: "Sprint still active. #{estimate} points still in progress."
       }
     end
 

data/lib/jirametrics/sprint_issue_change_data.rb

@@ -4,14 +4,14 @@ require 'jirametrics/value_equality'
 
 class SprintIssueChangeData
   include ValueEquality
-  attr_reader :time, :action, :value, :issue, :story_points
+  attr_reader :time, :action, :value, :issue, :estimate
 
-  def initialize time:, action:, value:, issue:, story_points:
+  def initialize time:, action:, value:, issue:, estimate:
     @time = time
     @action = action
     @value = value
     @issue = issue
-    @story_points = story_points
+    @estimate = estimate
   end
 
   def inspect

data/lib/jirametrics.rb

@@ -112,6 +112,7 @@ class JiraMetrics < Thor
     require 'jirametrics/download_config'
     require 'jirametrics/columns_config'
     require 'jirametrics/hierarchy_table'
+    require 'jirametrics/estimation_configuration'
     require 'jirametrics/board'
     load config_file
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.11'
+  version: 2.12pre2
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -86,6 +86,7 @@ files:
 - lib/jirametrics/download_config.rb
 - lib/jirametrics/downloader.rb
 - lib/jirametrics/estimate_accuracy_chart.rb
+- lib/jirametrics/estimation_configuration.rb
 - lib/jirametrics/examples/aggregated_project.rb
 - lib/jirametrics/examples/standard_project.rb
 - lib/jirametrics/expedited_chart.rb