jirametrics 2.2.1 → 2.4pre1

data/lib/jirametrics/issue.rb

@@ -35,16 +35,6 @@ class Issue
     raise "Unable to initialize #{raw['key']}"
   end
 
-  def sort_changes!
-    @changes.sort! do |a, b|
-      # 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?
-      compare
-    end
-  end
-
   def key = @raw['key']
 
   def type = @raw['fields']['issuetype']['name']
@@ -53,9 +43,7 @@ class Issue
 
   def summary = @raw['fields']['summary']
 
-  def status
-    Status.new raw: @raw['fields']['status']
-  end
+  def status = Status.new(raw: @raw['fields']['status'])
 
   def labels = @raw['fields']['labels'] || []
 
@@ -69,37 +57,13 @@ class Issue
   end
 
   def key_as_i
-    $1.to_i if key =~ /-(\d+)$/
+    key =~ /-(\d+)$/ ? $1.to_i : 0
   end
 
   def component_names
     @raw['fields']['components']&.collect { |component| component['name'] } || []
   end
 
-  def fabricate_change field_name:
-    first_status = nil
-    first_status_id = nil
-
-    created_time = parse_time @raw['fields']['created']
-    first_change = @changes.find { |change| change.field == field_name }
-    if first_change.nil?
-      # There have been no changes of this type yet so we have to look at the current one
-      return nil unless @raw['fields'][field_name]
-
-      first_status = @raw['fields'][field_name]['name']
-      first_status_id = @raw['fields'][field_name]['id'].to_i
-    else
-      # Otherwise, we look at what the first one had changed away from.
-      first_status = first_change.old_value
-      first_status_id = first_change.old_value_id
-    end
-    ChangeItem.new time: created_time, artificial: true, author: author, raw: {
-      'field' => field_name,
-      'to' => first_status_id,
-      'toString' => first_status
-    }
-  end
-
   def first_time_in_status *status_names
     @changes.find { |change| change.current_status_matches(*status_names) }&.time
   end
@@ -195,7 +159,7 @@ class Issue
   end
 
   def created
-    # This shouldn't be necessary and yet we've seen one case where it was.
+    # This nil check shouldn't be necessary and yet we've seen one case where it was.
     parse_time @raw['fields']['created'] if @raw['fields']['created']
   end
 
@@ -222,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)
@@ -258,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
@@ -267,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,
@@ -328,6 +326,7 @@ class Issue
         stalled_days: result[-1].stalled_days
       )
     end
+
     result
   end
 
@@ -337,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 }
@@ -478,6 +480,31 @@ class Issue
     comparison
   end
 
+  def dump
+    result = +''
+    result << "#{key} (#{type}): #{compact_text summary, 200}\n"
+
+    assignee = raw['fields']['assignee']
+    result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
+
+    raw['fields']['issuelinks'].each do |link|
+      result << "  [link] #{link['type']['outward']} #{link['outwardIssue']['key']}\n" if link['outwardIssue']
+      result << "  [link] #{link['type']['inward']} #{link['inwardIssue']['key']}\n" if link['inwardIssue']
+    end
+    changes.each do |change|
+      value = change.value
+      old_value = change.old_value
+
+      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})"
+      message << ' <<artificial entry>>' if change.artificial?
+      result << message << "\n"
+    end
+    result
+  end
+
   private
 
   def assemble_author raw
@@ -508,4 +535,49 @@ class Issue
       @changes << ChangeItem.new(raw: raw, time: created, author: author, artificial: true)
     end
   end
+
+  def compact_text text, max = 60
+    return nil if text.nil?
+
+    text = text.gsub(/\s+/, ' ').strip
+    text = "#{text[0..max]}..." if text.length > max
+    text
+  end
+
+  def sort_changes!
+    @changes.sort! do |a, b|
+      # 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
+      if compare.zero?
+        compare = 1 if a.resolution?
+        compare = -1 if b.resolution?
+      end
+      compare
+    end
+  end
+
+  def fabricate_change field_name:
+    first_status = nil
+    first_status_id = nil
+
+    created_time = parse_time @raw['fields']['created']
+    first_change = @changes.find { |change| change.field == field_name }
+    if first_change.nil?
+      # There have been no changes of this type yet so we have to look at the current one
+      return nil unless @raw['fields'][field_name]
+
+      first_status = @raw['fields'][field_name]['name']
+      first_status_id = @raw['fields'][field_name]['id'].to_i
+    else
+      # Otherwise, we look at what the first one had changed away from.
+      first_status = first_change.old_value
+      first_status_id = first_change.old_value_id
+    end
+    ChangeItem.new time: created_time, artificial: true, author: author, raw: {
+      'field' => field_name,
+      'to' => first_status_id,
+      'toString' => first_status
+    }
+  end
 end

data/lib/jirametrics/project_config.rb

@@ -49,7 +49,7 @@ class ProjectConfig
   end
 
   def load_settings
-    JSON.parse(File.read(File.join(__dir__, 'settings.json')))
+    JSON.parse(file_system.load(File.join(__dir__, 'settings.json')))
   end
 
   def guess_project_id
@@ -89,6 +89,8 @@ class ProjectConfig
     raise 'Not allowed to have both an aggregate and a download section. Pick only one.' if @download_config
 
     @aggregate_config = AggregateConfig.new project_config: self, block: block
+
+    # Processing of aggregates should only happen during the export
     return if @exporter.downloading?
 
     @aggregate_config.evaluate_next_level
@@ -120,7 +122,7 @@ class ProjectConfig
 
   def load_board board_id:, filename:
     board = Board.new(
-      raw: JSON.parse(File.read(filename)), possible_statuses: @possible_statuses
+      raw: JSON.parse(file_system.load(filename)), possible_statuses: @possible_statuses
     )
     board.project_config = self
     @all_boards[board_id] = board
@@ -162,7 +164,7 @@ class ProjectConfig
     # We may not always have this file. Load it if we can.
     return unless File.exist? filename
 
-    statuses = JSON.parse(File.read(filename))
+    statuses = JSON.parse(file_system.load(filename))
       .map { |snippet| Status.new(raw: snippet) }
     statuses
       .find_all { |status| status.global? }
@@ -178,7 +180,7 @@ class ProjectConfig
 
       board_id = $1.to_i
       timezone_offset = exporter.timezone_offset
-      JSON.parse(File.read("#{target_path}#{file}"))['values'].each do |json|
+      JSON.parse(file_system.load("#{target_path}#{file}"))['values'].each do |json|
         @all_boards[board_id].sprints << Sprint.new(raw: json, timezone_offset: timezone_offset)
       end
     end
@@ -231,7 +233,7 @@ class ProjectConfig
 
   def load_project_metadata
     filename = "#{@target_path}/#{file_prefix}_meta.json"
-    json = JSON.parse(File.read(filename))
+    json = JSON.parse(file_system.load(filename))
 
     @data_version = json['version'] || 1
 
@@ -247,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
 
@@ -360,7 +362,7 @@ class ProjectConfig
     default_board = nil
 
     group_filenames_and_board_ids(path: path).each do |filename, board_ids|
-      content = File.read(File.join(path, filename))
+      content = file_system.load(File.join(path, filename))
       if board_ids == :unknown
         boards = [(default_board ||= find_default_board)]
       else
@@ -435,4 +437,8 @@ class ProjectConfig
     end
     exporter.file_system.log "Discarded data from #{issues_cutoff_times.count} issues out of a total #{issues.size}"
   end
+
+  def file_system
+    @exporter.file_system
+  end
 end

data/lib/jirametrics/sprint_burndown.rb

@@ -108,6 +108,17 @@ class SprintBurndown < ChartBase
     result
   end
 
+  def sprints_in_time_range board
+    board.sprints.select do |sprint|
+      sprint_end_time = sprint.completed_time || sprint.end_time
+      sprint_start_time = sprint.start_time
+      next false if sprint_start_time.nil?
+
+      time_range.include?(sprint_start_time) || time_range.include?(sprint_end_time) ||
+        (sprint_start_time < time_range.begin && sprint_end_time > time_range.end)
+    end || []
+  end
+
   # 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

data/lib/jirametrics/status_collection.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+class StatusNotFoundError < StandardError
+end
+
 class StatusCollection
   def initialize
     @list = []
@@ -32,7 +35,7 @@ class StatusCollection
           next
         else
           all_status_names = @list.collect { |s| "#{s.name.inspect}:#{s.id.inspect}" }.uniq.sort.join(', ')
-          raise "Status not found: \"#{name_or_id}\". Possible statuses are: #{all_status_names}"
+          raise StatusNotFoundError, "Status not found: \"#{name_or_id}\". Possible statuses are: #{all_status_names}"
         end
       end
 

data/lib/jirametrics/throughput_chart.rb

@@ -5,7 +5,7 @@ class ThroughputChart < ChartBase
 
   attr_accessor :possible_statuses
 
-  def initialize block = nil
+  def initialize block
     super()
 
     header_text 'Throughput Chart'

data/lib/jirametrics.rb

@@ -61,7 +61,7 @@ class JiraMetrics < Thor
     require 'jirametrics/trend_line_calculator'
     require 'jirametrics/status'
     require 'jirametrics/issue_link'
-    require 'jirametrics/story_point_accuracy_chart'
+    require 'jirametrics/estimate_accuracy_chart'
     require 'jirametrics/status_collection'
     require 'jirametrics/sprint'
     require 'jirametrics/issue'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.4pre1
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -87,11 +87,10 @@ files:
 - lib/jirametrics/discard_changes_before.rb
 - lib/jirametrics/download_config.rb
 - lib/jirametrics/downloader.rb
+- lib/jirametrics/estimate_accuracy_chart.rb
 - lib/jirametrics/examples/aggregated_project.rb
 - lib/jirametrics/examples/standard_project.rb
 - lib/jirametrics/expedited_chart.rb
-- lib/jirametrics/experimental/generator.rb
-- lib/jirametrics/experimental/info.rb
 - lib/jirametrics/exporter.rb
 - lib/jirametrics/file_config.rb
 - lib/jirametrics/file_system.rb
@@ -107,12 +106,12 @@ files:
 - lib/jirametrics/html/cycletime_scatterplot.erb
 - lib/jirametrics/html/daily_wip_chart.erb
 - lib/jirametrics/html/data_quality_report.erb
+- lib/jirametrics/html/estimate_accuracy_chart.erb
 - lib/jirametrics/html/expedited_chart.erb
 - lib/jirametrics/html/hierarchy_table.erb
 - lib/jirametrics/html/index.css
 - lib/jirametrics/html/index.erb
 - lib/jirametrics/html/sprint_burndown.erb
-- lib/jirametrics/html/story_point_accuracy_chart.erb
 - lib/jirametrics/html/throughput_chart.erb
 - lib/jirametrics/html_report_config.rb
 - lib/jirametrics/issue.rb
@@ -127,7 +126,6 @@ files:
 - lib/jirametrics/sprint_issue_change_data.rb
 - lib/jirametrics/status.rb
 - lib/jirametrics/status_collection.rb
-- lib/jirametrics/story_point_accuracy_chart.rb
 - lib/jirametrics/throughput_chart.rb
 - lib/jirametrics/tree_organizer.rb
 - lib/jirametrics/trend_line_calculator.rb
@@ -155,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Extract Jira metrics

data/lib/jirametrics/experimental/generator.rb

@@ -1,210 +0,0 @@
-# frozen_string_literal: true
-
-require 'random-word'
-require 'require_all'
-require_all 'lib'
-
-def to_time date
-  Time.new date.year, date.month, date.day, rand(0..23), rand(0..59), rand(0..59)
-end
-
-class FakeIssue
-  @@issue_number = 1
-  attr_reader :effort, :raw, :worker
-
-  def initialize date:, type:, worker:
-    @raw = {
-      key: "FAKE-#{@@issue_number += 1}",
-      changelog: {
-        histories: []
-      },
-      fields: {
-        created: to_time(date),
-        updated: to_time(date),
-        creator: {
-          displayName: 'George Jetson'
-        },
-        issuetype: {
-          name: type
-        },
-        status: {
-          name: 'To Do',
-          id: 1,
-          statusCategory: {
-            id: 2,
-            name: 'To Do'
-          }
-        },
-        priority: {
-          name: ''
-        },
-        summary: RandomWord.phrases.next.gsub(_, ' '),
-        issuelinks: [],
-        fixVersions: []
-      }
-    }
-
-    @workers = [worker]
-    @effort = case type
-    when 'Story'
-      [1, 2, 3, 3, 3, 3, 4, 4, 4, 5, 6].sample
-    else
-      [1, 2, 3].sample
-    end
-    unblock
-    @done = false
-    @last_status = 'To Do'
-    @last_status_id = 1
-    change_status new_status: 'In Progress', new_status_id: 3, date: date
-  end
-
-  def blocked? = @blocked
-  def block = @blocked = true
-  def unblock = @blocked = false
-
-  def key = @raw[:key]
-
-  def do_work date:, effort:
-    raise 'Already done' if done?
-
-    @effort -= effort
-    return unless done?
-
-    change_status new_status: 'Done', new_status_id: 5, date: date
-    # fix_change_timestamps
-  end
-
-  def fix_change_timestamps
-    # since the timestamps have random hours, it's possible for them to be issued out of order. Sort them now
-    changes = @raw[:changelog][:histories]
-    times = [@raw[:fields][:created]] + changes.collect { |change| change[:created] }
-    times.sort!
-
-    @raw[:fields][:created] = times.shift
-    @raw[:fields][:updated] = times[-1]
-    changes.each do |change|
-      change[:created] = times.shift
-    end
-  end
-
-  def done? = @effort <= 0
-
-  def change_status date:, new_status:, new_status_id:
-    @raw[:changelog][:histories] << {
-      author: {
-        emailAddress: 'george@jetson.com',
-        displayName: 'George Jetson'
-      },
-      created: to_time(date),
-      items: [
-        {
-          field: 'status',
-          fieldtype: 'jira',
-          fieldId: 'status',
-          from: @last_status_id,
-          fromString: @last_status,
-          to: new_status_id,
-          toString: new_status
-        }
-      ]
-    }
-
-    @last_status = new_status
-    @last_status_id = new_status_id
-  end
-end
-
-class Worker
-  attr_accessor :issue
-end
-
-class Generator
-  def initialize
-    @random = Random.new
-    @file_prefix = 'fake'
-    @target_path = 'target/'
-
-    # @probability_work_will_be_pushed = 20
-    @probability_unblocked_work_becomes_blocked = 20
-    @probability_blocked_work_becomes_unblocked = 20
-    @date_range = (Date.today - 500)..Date.today
-    @issues = []
-    @workers = []
-    5.times { @workers << Worker.new }
-  end
-
-  def run
-    remove_old_files
-    @date_range.each_with_index do |date, day|
-      yield date, day if block_given?
-      process_date(date, day) if (1..5).cover? date.wday # Weekday
-    end
-
-    @issues.each do |issue|
-      issue.fix_change_timestamps
-      File.open "target/fake_issues/#{issue.key}.json", 'w' do |file|
-        file.puts JSON.pretty_generate(issue.raw)
-      end
-    end
-
-    File.write 'target/fake_meta.json', JSON.pretty_generate({
-      time_start: (@date_range.end - 90).to_time,
-      time_end: @date_range.end.to_time,
-      'no-download': true
-    })
-    puts "Created #{@issues.size} fake issues"
-  end
-
-  def remove_old_files
-    path = "#{@target_path}#{@file_prefix}_issues"
-    Dir.foreach path do |file|
-      next unless file.match?(/-\d+\.json$/)
-
-      filename = "#{path}/#{file}"
-      File.unlink filename
-    end
-  end
-
-  def lucky? probability
-    @random.rand(1..100) <= probability
-  end
-
-  def next_issue_for worker:, date:, type:
-    # First look for something I already started
-    issue = @issues.find { |i| i.worker == worker && !i.done? && !i.blocked? }
-
-    # Then look for something that someone else started
-    issue = @issues.find { |i| i.worker != worker && !i.done? && !i.blocked? } if issue.nil? && lucky?(40)
-
-    # Then start new work
-    issue = FakeIssue.new(date: date, type: type, worker: worker) if issue.nil?
-
-    issue
-  end
-
-  def process_date date, _simulation_day
-    @issues.each do |issue|
-      if issue.blocked?
-        issue.unblock if lucky? @probability_blocked_work_becomes_unblocked
-      elsif lucky? @probability_unblocked_work_becomes_blocked
-        issue.block
-      end
-    end
-
-    possible_capacities = [0, 1, 1, 1, 2]
-    @workers.each do |worker|
-      worker_capacity = possible_capacities.sample
-      if worker.issue.nil? || worker.issue.done?
-        type = lucky?(89) ? 'Story' : 'Bug'
-        worker.issue = next_issue_for worker: worker, date: date, type: type
-        @issues << worker.issue
-      end
-
-      worker.issue = next_issue_for worker: worker, date: date, type: type if worker.issue.blocked?
-      worker.issue.do_work date: date, effort: worker_capacity
-      worker.issue = nil if worker.issue.done?
-    end
-  end
-end
-
-Generator.new.run if __FILE__ == $PROGRAM_NAME