jirametrics 2.3 → 2.4pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e7264aee468cd14d42fa1c7ba8f737177ba99a78b3f7250d46771f687d4d619
-  data.tar.gz: da813f37b2a6047d6ab844f483008ecdb8c579786bd7bba7f2c01f038a259949
+  metadata.gz: dd626d730d591c7cc7ec2a9245fa395bc1d8d7fc22d658b6663dce28aa40f351
+  data.tar.gz: b0437b25f7def75b2bd2f0fd889aead1104b65ec53e339f48b8f2e535dc84d96
 SHA512:
-  metadata.gz: c234046627a2c92729c346f44cf78471e74545e01ce3a9810c6c22ed659f6479a0146303ac7fb0652512feafcf8077025577d2a4c039dddf2fd70d6899360adb
-  data.tar.gz: 81f24c30b8d56f8811ed298ca17cebcee6cb32afdbea5cfd12332587aabaa2701b023dc620b651e111226bf66bac9285f84a893549c00c45bd0eb992694a2c64
+  metadata.gz: 3c8c7f1ce346a98f989641fe4cb962d4f3fd04eab690b861e296154564f2d145cfa705fbf8d590ec004a4b02f707799fb2c21eef5cddc7e4e00bcc090730bca7
+  data.tar.gz: 596c0b5559ae4a64d46e95f38fb13e0fdec5bc8c315195ea9a45d69abd26841d4d4aa28cee1fe46b769b596810129aaf79e9fb1052ec3827aaa89c092a5687e4

data/lib/jirametrics/blocked_stalled_change.rb

@@ -15,12 +15,12 @@ class BlockedStalledChange
     @time = time
   end
 
-  def blocked? = @flag || blocked_by_status? || @blocking_issue_keys
-  def stalled? = @stalled_days || stalled_by_status?
+  def blocked? = !!(@flag || blocked_by_status? || @blocking_issue_keys)
+  def stalled? = !!(@stalled_days || stalled_by_status?)
   def active? = !blocked? && !stalled?
 
-  def blocked_by_status? = @status && @status_is_blocking
-  def stalled_by_status? = @status && !@status_is_blocking
+  def blocked_by_status? = !!(@status && @status_is_blocking)
+  def stalled_by_status? = !!(@status && !@status_is_blocking)
 
   def reasons
     result = []
@@ -35,4 +35,24 @@ class BlockedStalledChange
     end
     result.join(', ')
   end
+
+  def as_symbol
+    if blocked?
+      :blocked
+    elsif stalled?
+      :stalled
+    else
+      :active
+    end
+  end
+
+  def inspect
+    text = +"BlockedStalledChange(time: '#{@time}', "
+    if active?
+      text << 'Active'
+    else
+      text << reasons
+    end
+    text << ')'
+  end
 end

data/lib/jirametrics/change_item.rb

@@ -5,7 +5,6 @@ class ChangeItem
   attr_accessor :value, :old_value, :time
 
   def initialize raw:, time:, author:, artificial: false
-    # raw will only ever be nil in a test and in that case field and value should be passed in
     @raw = raw
     @time = time
     raise "Time must be an object of type Time in the correct timezone: #{@time}" if @time.is_a? String
@@ -36,16 +35,17 @@ class ChangeItem
   def link? = (field == 'Link')
 
   def to_s
-    message = "ChangeItem(field: #{field.inspect}, value: #{value.inspect}, time: \"#{@time}\""
-    message += ', artificial' if artificial?
-    message += ')'
+    message = +''
+    message << "ChangeItem(field: #{field.inspect}, value: #{value.inspect}, time: #{time_to_s(@time).inspect}"
+    message << ', artificial' if artificial?
+    message << ')'
     message
   end
 
   def inspect = to_s
 
   def == other
-    field.eql?(other.field) && value.eql?(other.value) && time.to_s.eql?(other.time.to_s)
+    field.eql?(other.field) && value.eql?(other.value) && time_to_s(time).eql?(time_to_s(other.time))
   end
 
   def current_status_matches *status_names_or_ids
@@ -77,4 +77,12 @@ class ChangeItem
       end
     end
   end
+
+  private
+
+  def time_to_s time
+    # MRI and JRuby return different strings for to_s() so we have to explicitly provide a full
+    # format so that tests work under both environments.
+    time.strftime '%Y-%m-%d %H:%M:%S %z'
+  end
 end

data/lib/jirametrics/columns_config.rb

@@ -34,6 +34,10 @@ class ColumnsConfig
     @columns << [:string, label, proc]
   end
 
+  def integer label, proc
+    @columns << [:integer, label, proc]
+  end
+
   def column_entry_times board_id: nil
     @file_config.project_config.find_board_by_id(board_id).visible_columns.each do |column|
       date column.name, first_time_in_status(*column.status_ids)

data/lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb

@@ -38,25 +38,12 @@ class DailyWipByBlockedStalledChart < DailyWipChart
     HTML
   end
 
-  def key_blocked_stalled_change issue:, date:, end_time:
-    stalled_change = nil
-    blocked_change = nil
-
-    issue.blocked_stalled_changes_on_date(date: date, end_time: end_time) do |change|
-      blocked_change = change if change.blocked?
-      stalled_change = change if change.stalled?
-    end
-
-    return blocked_change if blocked_change
-    return stalled_change if stalled_change
-
-    nil
-  end
-
   def default_grouping_rules issue:, rules:
     started = issue.board.cycletime.started_time(issue)
     stopped_date = issue.board.cycletime.stopped_time(issue)&.to_date
-    change = key_blocked_stalled_change issue: issue, date: rules.current_date, end_time: time_range.end
+
+    date = rules.current_date
+    change = issue.blocked_stalled_by_date(date_range: date..date, chart_end_time: time_range.end)[date]
 
     stopped_today = stopped_date == rules.current_date
 

data/lib/jirametrics/data_quality_report.rb

@@ -71,7 +71,10 @@ class DataQualityReport < ChartBase
 
   # Return a format that's easier to assert against
   def testable_entries
-    @entries.collect { |entry| [entry.started.to_s, entry.stopped.to_s, entry.issue] }
+    format = '%Y-%m-%d %H:%M:%S %z'
+    @entries.collect do |entry|
+      [entry.started&.strftime(format) || '', entry.stopped&.strftime(format) || '', entry.issue]
+    end
   end
 
   def entries_with_problems

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
@@ -13,7 +13,8 @@ class Object
 end
 
 class Exporter
-  attr_reader :project_configs, :file_system
+  attr_reader :project_configs
+  attr_accessor :file_system
 
   def self.configure &block
     logfile_name = 'jirametrics.log'
@@ -99,7 +100,10 @@ class Exporter
   end
 
   def jira_config filename = nil
-    @jira_config = file_system.load_json(filename) unless filename.nil?
+    if filename
+      @jira_config = file_system.load_json(filename)
+      @jira_config['url'] = $1 if @jira_config['url'] =~ /^(.+)\/+$/
+    end
     @jira_config
   end
 

data/lib/jirametrics/file_config.rb

@@ -66,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
@@ -110,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/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/issue.rb

@@ -186,29 +186,62 @@ class Issue
   end
 
   def blocked_on_date? date, end_time:
-    blocked_stalled_changes_on_date(date: date, end_time: end_time) do |change|
-      return true if change.blocked?
-    end
-    false
-  end
+    (blocked_stalled_by_date date_range: date..date, chart_end_time: end_time)[date].blocked?
+  end
+
+  # For any day in the day range...
+  # If the issue was blocked at any point in this day, the whole day is blocked.
+  # If the issue was active at any point in this day, the whole day is active
+  # If the day was stalled for the entire day then it's stalled
+  # If there was no activity at all on this day then the last change from the previous day carries over
+  def blocked_stalled_by_date date_range:, chart_end_time:, settings: nil
+    results = {}
+    current_date = nil
+    blocked_stalled_changes = blocked_stalled_changes(end_time: chart_end_time, settings: settings)
+    blocked_stalled_changes.each do |change|
+      current_date = change.time.to_date
+
+      winning_change, _last_change = results[current_date]
+      if winning_change.nil? ||
+        change.blocked? ||
+        (change.active? && (winning_change.active? || winning_change.stalled?)) ||
+        (change.stalled? && winning_change.stalled?)
+
+        winning_change = change
+      end
 
-  def blocked_stalled_changes_on_date date:, end_time:
-    next_day_start_time = (date + 1).to_time
-    this_day_start_time = date.to_time
+      results[current_date] = [winning_change, change]
+    end
 
-    # changes_affecting_date = []
-    previous_change_time = nil
-    blocked_stalled_changes(end_time: end_time).each do |change|
-      if previous_change_time.nil?
-        previous_change_time = change.time
-        next
+    last_populated_date = nil
+    (results.keys.min..results.keys.max).each do |date|
+      if results.key? date
+        last_populated_date = date
+      else
+        _winner, last = results[last_populated_date]
+        results[date] = [last, last]
       end
-
-      yield change if previous_change_time < next_day_start_time && change.time >= this_day_start_time
     end
+    results = results.transform_values(&:first)
+
+    # The requested date range may span outside the actual changes we find in the changelog
+    date_of_first_change = blocked_stalled_changes[0].time.to_date
+    date_of_last_change = blocked_stalled_changes[-1].time.to_date
+    date_range.each do |date|
+      results[date] = blocked_stalled_changes[0] if date < date_of_first_change
+      results[date] = blocked_stalled_changes[-1] if date > date_of_last_change
+    end
+
+    # To make the code simpler, we've been accumulating data for every date. Now remove anything
+    # that isn't in the requested date_range
+    results.select! { |date, _value| date_range.include? date }
+
+    results
   end
 
-  def blocked_stalled_changes end_time:, settings: @board.project_config.settings
+  def blocked_stalled_changes end_time:, settings: nil
+    settings ||= @board.project_config.settings
+
     blocked_statuses = settings['blocked_statuses']
     stalled_statuses = settings['stalled_statuses']
     unless blocked_statuses.is_a?(Array) && stalled_statuses.is_a?(Array)
@@ -222,7 +255,7 @@ class Issue
     blocking_issue_keys = []
 
     result = []
-    previous_was_active = true
+    previous_was_active = false # Must start as false so that the creation will insert an :active
     previous_change_time = created
 
     blocking_status = nil
@@ -231,6 +264,7 @@ class Issue
     # This mock change is to force the writing of one last entry at the end of the time range.
     # By doing this, we're able to eliminate a lot of duplicated code in charts.
     mock_change = ChangeItem.new time: end_time, author: '', artificial: true, raw: { 'field' => '' }
+
     (changes + [mock_change]).each do |change|
       previous_was_active = false if check_for_stalled(
         change_time: change.time,
@@ -292,6 +326,7 @@ class Issue
         stalled_days: result[-1].stalled_days
       )
     end
+
     result
   end
 
@@ -301,6 +336,9 @@ class Issue
     # The most common case will be nothing to split so quick escape.
     return false if (change_time - previous_change_time).to_i < stalled_threshold_seconds
 
+    # If the last identified change was blocked then it doesn't matter now long we've waited, we're still blocked.
+    return false if blocking_stalled_changes[-1]&.blocked?
+
     list = [previous_change_time..change_time]
     all_subtask_activity_times.each do |time|
       matching_range = list.find { |range| time >= range.begin && time <= range.end }
@@ -457,7 +495,7 @@ class Issue
       value = change.value
       old_value = change.old_value
 
-      message = "  [change] #{change.time} [#{change.field}] "
+      message = "  [change] #{change.time.strftime '%Y-%m-%d %H:%M:%S %z'} [#{change.field}] "
       message << "#{compact_text(old_value).inspect} -> " unless old_value.nil? || old_value.empty?
       message << compact_text(value).inspect
       message << " (#{change.author})"
@@ -511,7 +549,10 @@ class Issue
       # It's common that a resolved will happen at the same time as a status change.
       # Put them in a defined order so tests can be deterministic.
       compare = a.time <=> b.time
-      compare = 1 if compare.zero? && a.resolution?
+      if compare.zero?
+        compare = 1 if a.resolution?
+        compare = -1 if b.resolution?
+      end
       compare
     end
   end

data/lib/jirametrics/jira_gateway.rb

@@ -48,15 +48,17 @@ class JiraGateway
   end
 
   def make_curl_command url:
-    command = 'curl'
-    command += ' -s'
-    command += ' -k' if @ignore_ssl_errors
-    command += " --cookie #{@cookies.inspect}" unless @cookies.empty?
-    command += " --user #{@jira_email}:#{@jira_api_token}" if @jira_api_token
-    command += " -H \"Authorization: Bearer #{@jira_personal_access_token}\"" if @jira_personal_access_token
-    command += ' --request GET'
-    command += ' --header "Accept: application/json"'
-    command += " --url \"#{url}\""
+    command = +''
+    command << 'curl'
+    command << ' -L' # follow redirects
+    command << ' -s' # silent
+    command << ' -k' if @ignore_ssl_errors # insecure
+    command << " --cookie #{@cookies.inspect}" unless @cookies.empty?
+    command << " --user #{@jira_email}:#{@jira_api_token}" if @jira_api_token
+    command << " -H \"Authorization: Bearer #{@jira_personal_access_token}\"" if @jira_personal_access_token
+    command << ' --request GET'
+    command << ' --header "Accept: application/json"'
+    command << " --url \"#{url}\""
     command
   end
 end

data/lib/jirametrics/project_config.rb

@@ -249,7 +249,7 @@ class ProjectConfig
 
   def to_time string, end_of_day: false
     time = end_of_day ? '23:59:59' : '00:00:00'
-    string = "#{string}T#{time}#{@timezone_offset}" if string.match?(/^\d{4}-\d{2}-\d{2}$/)
+    string = "#{string}T#{time}#{exporter.timezone_offset}" if string.match?(/^\d{4}-\d{2}-\d{2}$/)
     Time.parse string
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.3'
+  version: 2.4pre2
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Extract Jira metrics