jirametrics 2.25.1 → 2.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a93af46dd816e8ff88d28bcff6f3576854a3d20f15ea23496797bec53b4f615d
-  data.tar.gz: a1ffd32cad9ff93ad61b2e72451cd8aa48e7e73785ac98ea4e6018d533b203ee
+  metadata.gz: b7ae2f8704310fc2fcea52150053a46c0b42cfa70f1a70c3852ec1ed70f7a2ae
+  data.tar.gz: 60401ec8596603ee4ba7d6491286a577ea51a3a888d8cc9ea1de5ee7c281dbe7
 SHA512:
-  metadata.gz: 50468c878959ce6508d8470195c2c4d6f8e98bc0a9bebafaaceceb9e296d8f3bdbf194e36a00459c0c34f9174371ccb53ac1dc02b8cf1a8fccb3d6a3ee143c45
-  data.tar.gz: 9c4c6ef0c5c70d417d5c305a311d25d292bbcea1bcd5777fdf004922178a255aa65180fb0b4455eda8f9d9a72f5f1c23ac650c2e83368c8fc5926ba6aefc0a1f
+  metadata.gz: 4b4cd517bb7be4fc1e660b7d3950dfc1ed48125c5fa7334b5d19c115c85a29915fbbf0c02f142a79f68a401a86913058b84e3dfb00dd5ae9d7c39986c3ff6bb3
+  data.tar.gz: 6200ef8b7ab73aaad69986fb1f38c1bc7df2ca280c3c8559fc83093276b2b7c628bb91b3d7850464003c01ced5eea839cde155688e1f1cf1e0a42b533bc09244

data/lib/jirametrics/aging_work_bar_chart.rb

@@ -15,7 +15,7 @@ class AgingWorkBarChart < ChartBase
         newest at the bottom.
       </p>
       <p>
-        There are <%= current_board.scrum? ? 'four' : 'three' %> bars for each issue, and hovering over any of the bars will provide more details.
+        There are <%= (current_board.scrum? || aggregated_project?) ? 'four' : 'three' %> bars for each issue, and hovering over any of the bars will provide more details.
         <ol>
           <li>Status: The status the issue was in at any time. The colour indicates the
           status category, which will be one of #{color_block '--status-category-todo-color'} To Do,
@@ -25,7 +25,7 @@ class AgingWorkBarChart < ChartBase
           or #{color_block '--stalled-color'} stalled.</li>
           <li>Priority: This shows the priority over time. If one of these priorities is considered expedited
           then it will be drawn with diagonal lines.</li>
-          <% if current_board.scrum? %>
+          <% if current_board.scrum? || aggregated_project? %>
             <li>Sprints: The sprints that the issue was in.</li>
           <% end %>
         </ol>
@@ -84,7 +84,7 @@ class AgingWorkBarChart < ChartBase
       ['blocked', collect_blocked_stalled_ranges(issue: issue, issue_start_time: issue_start_time)],
       ['priority', collect_priority_ranges(issue: issue)]
     ]
-    bar_data << ['sprints', collect_sprint_ranges(issue: issue)] if current_board.scrum?
+    bar_data << ['sprints', collect_sprint_ranges(issue: issue)] if current_board.scrum? || aggregated_project?
 
     bar_data.each { |entry| clip_ranges_to_start_time(ranges: entry.last, issue_start_time: issue_start_time) }
 
@@ -113,7 +113,7 @@ class AgingWorkBarChart < ChartBase
   def grow_chart_height_if_too_many_issues aging_issue_count:
     px_per_bar = 10
     bars_per_issue = 3
-    bars_per_issue += 1 if current_board.scrum?
+    bars_per_issue += 1 if current_board.scrum? || aggregated_project?
 
     preferred_height = aging_issue_count * px_per_bar * bars_per_issue
     @canvas_height = preferred_height if @canvas_height.nil? || @canvas_height < preferred_height

data/lib/jirametrics/cfd_data_builder.rb

@@ -31,12 +31,17 @@ class CfdDataBuilder
 
   # Returns { hwm_timeline: [[date, hwm_value], ...], correction_windows: [...] }
   def process_issue issue, column_map
+    start_time = issue.started_stopped_times.first
+    return { hwm_timeline: [], correction_windows: [] } if start_time.nil?
+
     high_water_mark = nil
     correction_open_since = nil
     correction_windows = []
     hwm_timeline = [] # sorted chronologically by date
 
     issue.status_changes.each do |change|
+      next if change.time < start_time
+
       col_index = column_map[change.value_id]
       next if col_index.nil?
 

data/lib/jirametrics/cycletime_scatterplot.rb

@@ -35,6 +35,10 @@ class CycletimeScatterplot < TimeBasedScatterplot
     end
   end
 
+  def minimum_y_value
+    1 # Values under 1 day are data quality problems; they're flagged in the quality report instead
+  end
+
   def all_items
     completed_issues_in_range include_unstarted: false
   end

data/lib/jirametrics/downloader.rb

@@ -87,6 +87,23 @@ class Downloader
     @file_system.log text, also_write_to_stderr: both
   end
 
+  def log_start text
+    @file_system.log_start text
+  end
+
+  def start_progress
+    @file_system.start_progress
+  end
+
+  def progress_dot message = nil
+    @file_system.log message if message
+    @file_system.progress_dot
+  end
+
+  def end_progress
+    @file_system.end_progress
+  end
+
   def find_board_ids
     ids = @download_config.project_config.board_configs.collect(&:id)
     raise 'Board ids must be specified' if ids.empty?
@@ -233,13 +250,6 @@ class Downloader
         @metadata[key] = value
       end
 
-      # If rolling_date_count has changed, we may be missing data outside the previous range,
-      # so force a full re-download.
-      if @metadata['rolling_date_count'] != @download_config.rolling_date_count
-        log '  rolling_date_count has changed. Forcing a full download.', both: true
-        @cached_data_format_is_current = false
-        @metadata = {}
-      end
     end
 
     # Even if this is the old format, we want to obey this one tag

data/lib/jirametrics/downloader_for_cloud.rb

@@ -53,6 +53,7 @@ class DownloaderForCloud < Downloader
     next_page_token = nil
     issue_count = 0
 
+    start_progress
     loop do
       relative_url = +''
       relative_url << '/rest/api/3/search/jql'
@@ -75,11 +76,12 @@ class DownloaderForCloud < Downloader
         issue_count += 1
       end
 
-      message = "    Found #{issue_count} issues"
-      log message, both: true
+      progress_dot "    Found #{issue_count} issues"
 
       break unless next_page_token
     end
+    end_progress
+
     hash
   end
 
@@ -88,7 +90,7 @@ class DownloaderForCloud < Downloader
     # that only returns the "recent" changes, not all of them. So now we get the issue
     # without changes and then make a second call for that changes. Then we insert it
     # into the raw issue as if it had been there all along.
-    log "  Downloading #{issue_datas.size} issues", both: true
+    log "  Downloading #{issue_datas.size} issues"
     payload = {
       'fields' => ['*all'],
       'issueIdsOrKeys' => issue_datas.collect(&:key)
@@ -168,13 +170,12 @@ class DownloaderForCloud < Downloader
 
     loop do
       related_issue_keys = Set.new
-      issue_data_hash
-        .values
-        .reject { |data| data.up_to_date }
-        .each_slice(100) do |slice|
-          slice = bulk_fetch_issues(
-            issue_datas: slice, board: board, in_initial_query: true
-          )
+      stale = issue_data_hash.values.reject { |data| data.up_to_date }
+      unless stale.empty?
+        log_start '  Downloading more issues '
+        stale.each_slice(100) do |slice|
+          slice = bulk_fetch_issues(issue_datas: slice, board: board, in_initial_query: true)
+          progress_dot
           slice.each do |data|
             @file_system.save_json(
               json: data.issue.raw, filename: data.cache_path
@@ -195,6 +196,8 @@ class DownloaderForCloud < Downloader
             end
           end
         end
+        end_progress
+      end
 
       # Remove all the ones we already downloaded
       related_issue_keys.reject! { |key| issue_data_hash[key] }

data/lib/jirametrics/file_system.rb

@@ -68,6 +68,28 @@ class FileSystem
     $stderr.puts message # rubocop:disable Style/StderrPuts
   end
 
+  def log_start message
+    logfile.puts message
+    return if logfile == $stdout
+
+    $stderr.print message
+    $stderr.flush
+  end
+
+  def start_progress
+    $stderr.print '  '
+    $stderr.flush
+  end
+
+  def progress_dot
+    $stderr.print '.'
+    $stderr.flush
+  end
+
+  def end_progress
+    $stderr.puts '' # rubocop:disable Style/StderrPuts
+  end
+
   # In some Jira instances, a sizeable portion of the JSON is made up of empty fields. I've seen
   # cases where this simple compression will drop the filesize by half.
   def compress node

data/lib/jirametrics/groupable_issue_chart.rb

@@ -17,6 +17,7 @@ module GroupableIssueChart
     result = {}
     ignored_issues = []
     @issue_hints = {}
+    @issue_periods = {}
     completed_issues.each do |issue|
       rules = GroupingRules.new
       @group_by_block.call(issue, rules)
@@ -26,6 +27,7 @@ module GroupableIssueChart
       end
 
       @issue_hints[issue] = rules.issue_hint
+      @issue_periods[issue] = rules.last_day_of_period
       (result[rules] ||= []) << issue
     end
 

data/lib/jirametrics/grouping_rules.rb

@@ -2,7 +2,11 @@
 
 class GroupingRules < Rules
   attr_accessor :label, :issue_hint, :label_hint
-  attr_reader :color
+  attr_reader :color, :last_day_of_period
+
+  def last_day_of_period= value
+    @last_day_of_period = value.is_a?(String) ? Date.parse(value) : value
+  end
 
   def eql? other
     other.label == @label && other.color == @color

data/lib/jirametrics/html_generator.rb

@@ -5,6 +5,7 @@ class HtmlGenerator
 
   def create_html output_filename:, settings:, project_name: ''
     @settings = settings
+    project_name = project_name.to_s
     html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
     css = load_css html_directory: html_directory
     javascript = file_system.load(File.join(html_directory, 'index.js'))

data/lib/jirametrics/project_config.rb

@@ -598,6 +598,16 @@ class ProjectConfig
     if status_becomes
       status_becomes = [status_becomes] unless status_becomes.is_a? Array
 
+      status_becomes.each do |status_name|
+        next if status_name == :backlog
+
+        found = possible_statuses.find_all_by_name status_name
+        if found.empty?
+          raise "discard_changes_before: Status #{status_name.inspect} not found. " \
+            "Possible statuses are: #{possible_statuses}"
+        end
+      end
+
       block = lambda do |issue|
         trigger_statuses = status_becomes.collect do |status_name|
           if status_name == :backlog

data/lib/jirametrics/throughput_chart.rb

@@ -79,12 +79,21 @@ class ThroughputChart < ChartBase
     end
   end
 
+  def calculate_custom_periods
+    last_days = @issue_periods.values.compact.uniq.sort
+    last_days.each_with_index.map do |last_day, i|
+      first_day = i.zero? ? @date_range.begin : last_days[i - 1] + 1
+      first_day..last_day
+    end
+  end
+
   def weekly_throughput_dataset completed_issues:, label:, color:, dashed: false, label_hint: nil
+    periods = @issue_periods&.values&.any? ? calculate_custom_periods : calculate_time_periods
     result = {
       label: label,
       label_hint: label_hint,
       data: throughput_dataset(
-        periods: calculate_time_periods, completed_issues: completed_issues, label_hint: label_hint
+        periods: periods, completed_issues: completed_issues, label_hint: label_hint
       ),
       fill: false,
       showLine: true,
@@ -109,10 +118,17 @@ class ThroughputChart < ChartBase
   end
 
   def throughput_dataset periods:, completed_issues:, label_hint: nil
+    custom_mode = @issue_periods&.values&.any?
     periods.collect do |period|
       closed_issues = completed_issues.filter_map do |issue|
         stop_date = issue.started_stopped_dates.last
-        [stop_date, issue] if stop_date && period.include?(stop_date)
+        next unless stop_date
+
+        if custom_mode
+          [stop_date, issue] if @issue_periods[issue] == period.end
+        elsif period.include?(stop_date)
+          [stop_date, issue]
+        end
       end
 
       date_label = "on #{period.end}"

data/lib/jirametrics/time_based_scatterplot.rb

@@ -79,9 +79,14 @@ class TimeBasedScatterplot < ChartBase
     }
   end
 
+  def minimum_y_value
+    nil
+  end
+
   def data_for_item item, rules: nil
     y = y_value(item)
-    return nil if y < 1 # These will get called out on the quality report
+    min = minimum_y_value
+    return nil if min && y < min
 
     @highest_y_value = y if @highest_y_value < y
 
@@ -93,7 +98,9 @@ class TimeBasedScatterplot < ChartBase
   end
 
   def calculate_percent_line items
+    min = minimum_y_value
     times = items.collect { |item| y_value(item) }
+    times.reject! { |y| min && y < min }
     index = times.size * 85 / 100
     times.sort[index]
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.25.1
+  version: '2.26'
 platform: ruby
 authors:
 - Mike Bowler