jirametrics 2.19 → 2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ad0f38512d5234cc756b304c844b6a2dfc3facca1270e0e97bed311a03e0ea9
-  data.tar.gz: 60b7e161a82b73af6c37416d31d4fb6acff17c58f07760b1ad784f39096e0e4c
+  metadata.gz: ba3c618918a65132645f5c74d55695694bf54514b60c9a3d42b666592c1d1e39
+  data.tar.gz: 39436664f71ad5814f90bd3549520f76d8a1f9d44270338ef3642b5825ad9c76
 SHA512:
-  metadata.gz: 3fd637c2e612543ffebd408f523a15ecb7337749a1723736ca067aa6dbadc73066d92e78836a65ef248d2a927caa88b38a9a9fc973ac2700cfd9ed233537ac5e
-  data.tar.gz: c4986ca27c75f41867bbc025bc27c355f54f389f39fd4b29d4002a6b374dedd88b91e3b3658de2c1c652d36f538894f511e5aa898d9f09ce9247dfa5421097a8
+  metadata.gz: f777b591e53d721796ef66fd9f107e5853e4f9f5e85178e63b43aa790bc271120596451928b27156694e4d44aee781fa16ac70d80e72e4e0a53f723090e02b70
+  data.tar.gz: d9b4392d5b45bdb94bb15530d52ce6dee6caddc8904570ce3d59dfc4dd2ba624344d7c43ed37c7eff433dbe9445f817ecffd4014164e82e4863ebcafeac64c19

data/lib/jirametrics/board_config.rb

@@ -24,7 +24,8 @@ class BoardConfig
     end
 
     @board.cycletime = CycleTimeConfig.new(
-      parent_config: self, label: label, block: block, file_system: project_config.file_system
+      parent_config: self, label: label, block: block, file_system: project_config.file_system,
+      settings: project_config.settings
     )
   end
 

data/lib/jirametrics/cycletime_config.rb

@@ -6,12 +6,15 @@ require 'date'
 class CycleTimeConfig
   include SelfOrIssueDispatcher
 
-  attr_reader :label, :parent_config
+  attr_reader :label, :parent_config, :settings, :file_system
+
+  def initialize parent_config:, label:, block:, settings:, file_system: nil, today: Date.today
 
-  def initialize parent_config:, label:, block:, file_system: nil, today: Date.today
     @parent_config = parent_config
     @label = label
     @today = today
+    @settings = settings
+    @cache_cycletime_calculations = settings['cache_cycletime_calculations']
 
     # If we hit something deprecated and this is nil then we'll blow up. Although it's ugly, this
     # may make it easier to find problems in the test code ;-)
@@ -63,6 +66,10 @@ class CycleTimeConfig
   end
 
   def started_stopped_changes issue
+    cache_key = "#{issue.key}:#{issue.board.id}"
+    last_result = (@cache ||= {})[cache_key]
+    return *last_result if last_result && @cache_cycletime_calculations
+
     started = @start_at.call(issue)
     stopped = @stop_at.call(issue)
 
@@ -80,7 +87,15 @@ class CycleTimeConfig
     # for the start and not have it conflict.
     started = nil if started&.time == stopped&.time
 
-    [started, stopped]
+    result = [started, stopped]
+    if last_result && result != last_result
+      @file_system.error(
+        "Calculation mismatch; this could break caching. #{issue.inspect} new=#{result.inspect}, " \
+          "previous=#{last_result.inspect}"
+      )
+    end
+    @cache[cache_key] = result
+    result
   end
 
   def started_stopped_times issue
@@ -88,6 +103,10 @@ class CycleTimeConfig
     [started&.time, stopped&.time]
   end
 
+  def flush_cache
+    @cache = nil
+  end
+
   def started_stopped_dates issue
     started_time, stopped_time = started_stopped_times(issue)
     [started_time&.to_date, stopped_time&.to_date]

data/lib/jirametrics/data_quality_report.rb

@@ -410,14 +410,17 @@ class DataQualityReport < ChartBase
   def render_status_not_on_board problems
     <<-HTML
       #{label_issues problems.size} were not visible on the board for some period of time. This may impact
-      timings as the work was likely to have been forgotten if it wasn't visible.
+      timings as the work was likely to have been forgotten if it wasn't visible. What does "not visible"
+      mean in this context? The issue was in a status that is not mapped to any visible column on the board.
+      Look in "unmapped statuses" on your board.
     HTML
   end
 
   def render_created_in_wrong_status problems
     <<-HTML
-      #{label_issues problems.size} were created in a status not designated as Backlog. This will impact
-      the measurement of start times and will therefore impact whether it's shown as in progress or not.
+      #{label_issues problems.size} were created in a status that is not considered to be some varient
+      of To Do. Most likely this means that the issue was created from one of the columns on the board,
+      rather than in the backlog. Why Jira allows this is still a mystery.
     HTML
   end
 

data/lib/jirametrics/examples/standard_project.rb

@@ -15,15 +15,6 @@ class Exporter
       self.anonymize if anonymize
       self.settings.merge! settings
 
-      status_category_mappings.each do |status, category|
-        status_category_mapping status: status, category: category
-      end
-
-      download do
-        self.rolling_date_count(rolling_date_count) if rolling_date_count
-        self.no_earlier_than(no_earlier_than) if no_earlier_than
-      end
-
       boards.each_key do |board_id|
         block = boards[board_id]
         if block == :default
@@ -37,6 +28,15 @@ class Exporter
         end
       end
 
+      status_category_mappings.each do |status, category|
+        status_category_mapping status: status, category: category
+      end
+
+      download do
+        self.rolling_date_count(rolling_date_count) if rolling_date_count
+        self.no_earlier_than(no_earlier_than) if no_earlier_than
+      end
+
       issues.reject! do |issue|
         ignore_types.include? issue.type
       end

data/lib/jirametrics/html/aging_work_in_progress_chart.erb

@@ -40,7 +40,7 @@ new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
           color: <%= CssVariable['--grid-line-color'].to_json %>,
           z: 1 // draw the grid lines on top of the bars
         },
-        stacked: true,
+        stacked: false,
         max: <%= (@max_age * 1.1).to_i %>
       }
     },

data/lib/jirametrics/html/index.erb

@@ -5,7 +5,7 @@
     <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>
-    <script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-annotation/1.2.2/chartjs-plugin-annotation.min.js" integrity="sha512-HycvvBSFvDEVyJ0tjE2rPmymkt6XqsP/Zo96XgLRjXwn6SecQqsn+6V/7KYev66OshZZ9+f9AttCGmYqmzytiw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/chartjs-plugin-annotation/3.1.0/chartjs-plugin-annotation.min.js"></script>
     <script type="text/javascript">
 <%= javascript %>
     </script>

data/lib/jirametrics/html_report_config.rb

@@ -51,7 +51,9 @@ class HtmlReportConfig
     @file_config.project_config.all_boards.each_value do |board|
       raise 'Multiple cycletimes not supported' if board.cycletime
 
-      board.cycletime = CycleTimeConfig.new(parent_config: self, label: label, block: block, file_system: file_system)
+      board.cycletime = CycleTimeConfig.new(
+        parent_config: self, label: label, block: block, file_system: file_system, settings: settings
+      )
     end
   end
 

data/lib/jirametrics/project_config.rb

@@ -549,6 +549,7 @@ class ProjectConfig
   end
 
   def discard_changes_before status_becomes: nil, &block
+    cycletimes_touched = Set.new
     if status_becomes
       status_becomes = [status_becomes] unless status_becomes.is_a? Array
 
@@ -581,6 +582,7 @@ class ProjectConfig
       next if original_start_time.nil?
 
       issue.discard_changes_before cutoff_time
+      cycletimes_touched << issue.board.cycletime
 
       next unless cutoff_time
       next if original_start_time > cutoff_time # ie the cutoff would have made no difference.
@@ -591,5 +593,7 @@ class ProjectConfig
         issue: issue
       }
     end
+
+    cycletimes_touched.each { |c| c.flush_cache }
   end
 end

data/lib/jirametrics/settings.json

@@ -7,5 +7,7 @@
   "flagged_means_blocked": true,
 
   "expedited_priority_names": ["Critical", "Highest"],
-  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"]
+  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"],
+
+  "cache_cycletime_calculations": true
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.19'
+  version: '2.20'
 platform: ruby
 authors:
 - Mike Bowler
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Extract Jira metrics
 test_files: []