jirametrics 2.20.1 → 2.25

data/lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb

@@ -39,23 +39,32 @@ class DailyWipByBlockedStalledChart < DailyWipChart
   end
 
   def default_grouping_rules issue:, rules:
-    started, stopped = issue.board.cycletime.started_stopped_times(issue)
+    started, stopped = issue.started_stopped_times
     stopped_date = stopped&.to_date
+    started_date = started&.to_date
 
     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
 
+    days = nil
+    if started_date && stopped_date
+      days = (stopped_date - started_date).to_i + 1 # cycletime
+    elsif started_date
+      days = (time_range.end.to_date - started_date).to_i + 1 # age
+    end
+
     if stopped_today && started.nil?
       @has_completed_but_not_started = true
       rules.label = 'Completed but not started'
       rules.color = '--wip-chart-completed-but-not-started-color'
       rules.group_priority = -1
+      rules.issue_hint = '(Cycle time: Unknown)'
     elsif stopped_today
       rules.label = 'Completed'
       rules.color = '--wip-chart-completed-color'
       rules.group_priority = -2
+      rules.issue_hint = "(Cycle time: #{label_days days})"
     elsif started.nil?
       rules.label = 'Start date unknown'
       rules.color = '--body-background'
@@ -64,16 +73,17 @@ class DailyWipByBlockedStalledChart < DailyWipChart
       rules.label = 'Blocked'
       rules.color = '--blocked-color'
       rules.group_priority = 1
-      rules.issue_hint = "(#{change.reasons})"
+      rules.issue_hint = "(Age: #{label_days days}, #{change.reasons})"
     elsif change&.stalled?
       rules.label = 'Stalled'
       rules.color = '--stalled-color'
       rules.group_priority = 2
-      rules.issue_hint = "(#{change.reasons})"
+      rules.issue_hint = "(Age: #{label_days days}, #{change.reasons})"
     else
       rules.label = 'Active'
       rules.color = '--wip-chart-active-color'
       rules.group_priority = 3
+      rules.issue_hint = "(Age: #{label_days days})"
     end
   end
 end

data/lib/jirametrics/daily_wip_by_parent_chart.rb

@@ -26,11 +26,13 @@ class DailyWipByParentChart < DailyWipChart
   end
 
   def default_grouping_rules issue:, rules:
-    parent = issue.parent&.key
+    parent = issue.parent
     if parent
-      rules.label = parent
+      rules.label = parent.key
+      rules.label_hint = "#{parent.key} : #{parent.summary}"
     else
       rules.label = 'No parent'
+      rules.label_hint = 'No parent'
       rules.group_priority = 1000
       rules.color = '--body-background'
     end

data/lib/jirametrics/daily_wip_chart.rb

@@ -3,12 +3,16 @@
 require 'jirametrics/chart_base'
 
 class DailyGroupingRules < GroupingRules
-  attr_accessor :current_date, :group_priority, :issue_hint
+  attr_accessor :current_date, :group_priority, :issue_hint, :highlight
 
   def initialize
     super
     @group_priority = 0
   end
+
+  def group
+    [@label, @color, @highlight ? true : false]
+  end
 end
 
 class DailyWipChart < ChartBase
@@ -19,6 +23,8 @@ class DailyWipChart < ChartBase
 
     header_text default_header_text
     description_text default_description_text
+    @x_axis_title = nil
+    @y_axis_title = 'Count of items'
 
     instance_eval(&block) if block
 
@@ -33,8 +39,15 @@ class DailyWipChart < ChartBase
     issue_rules_by_active_date = group_issues_by_active_dates
     possible_rules = select_possible_rules issue_rules_by_active_date
 
+    conflicting_labels = possible_rules
+      .group_by(&:label)
+      .select { |_label, rules| rules.any?(&:highlight) && rules.any? { |r| !r.highlight } }
+      .keys
+
     data_sets = possible_rules.collect do |grouping_rule|
-      make_data_set grouping_rule: grouping_rule, issue_rules_by_active_date: issue_rules_by_active_date
+      suffix = conflicting_labels.include?(grouping_rule.label) && grouping_rule.highlight ? '*' : ''
+      make_data_set grouping_rule: grouping_rule, issue_rules_by_active_date: issue_rules_by_active_date,
+                    label_suffix: suffix
     end
     if @trend_lines
       data_sets = @trend_lines.filter_map do |group_labels, line_color|
@@ -66,7 +79,7 @@ class DailyWipChart < ChartBase
     hash = {}
 
     @issues.each do |issue|
-      start, stop = issue.board.cycletime.started_stopped_dates(issue)
+      start, stop = cycletime_for_issue(issue).started_stopped_dates(issue)
       next if start.nil? && stop.nil?
 
       # If it stopped but never started then assume it started at creation so the data points
@@ -82,16 +95,17 @@ class DailyWipChart < ChartBase
     hash
   end
 
-  def make_data_set grouping_rule:, issue_rules_by_active_date:
+  def make_data_set grouping_rule:, issue_rules_by_active_date:, label_suffix: ''
     positive = grouping_rule.group_priority >= 0
+    display_label = "#{grouping_rule.label}#{label_suffix}"
 
     data = issue_rules_by_active_date.collect do |date, issue_rules|
-      # issues = []
       issue_strings = issue_rules
         .select { |_issue, rules| rules.group == grouping_rule.group }
         .sort_by { |issue, _rules| issue.key_as_i }
         .collect { |issue, rules| "#{issue.key} : #{issue.summary.strip} #{rules.issue_hint}" }
-      title = ["#{grouping_rule.label} (#{label_issues issue_strings.size})"] + issue_strings
+      title_label = grouping_rule.label_hint || display_label
+      title = ["#{title_label} (#{label_issues issue_strings.size})"] + issue_strings
 
       {
         x: date,
@@ -100,11 +114,19 @@ class DailyWipChart < ChartBase
       }
     end
 
+    color = grouping_rule.color || random_color
+    background_color = if grouping_rule.highlight
+                         RawJavascript.new("createDiagonalPattern(#{color.to_json})")
+                       else
+                         color
+                       end
+
     {
       type: 'bar',
-      label: grouping_rule.label,
+      label: display_label,
+      label_hint: grouping_rule.label_hint,
       data: data,
-      backgroundColor: grouping_rule.color || random_color,
+      backgroundColor: background_color,
       borderColor: CssVariable['--wip-chart-border-color'],
       borderWidth: grouping_rule.color.to_s == 'var(--body-background)' ? 1 : 0,
       borderRadius: positive ? 0 : 5

data/lib/jirametrics/data_quality_report.rb

@@ -45,6 +45,7 @@ class DataQualityReport < ChartBase
       scan_for_completed_issues_without_a_start_time entry: entry
       scan_for_status_change_after_done entry: entry
       scan_for_backwards_movement entry: entry, backlog_statuses: backlog_statuses
+      scan_for_issue_not_in_active_sprint entry: entry
       scan_for_issues_not_created_in_a_backlog_status entry: entry, backlog_statuses: backlog_statuses
       scan_for_stopped_before_started entry: entry
       scan_for_issues_not_started_with_subtasks_that_have entry: entry
@@ -68,7 +69,7 @@ class DataQualityReport < ChartBase
     result << render_problem_type(:status_changes_after_done)
     result << render_problem_type(:backwards_through_status_categories)
     result << render_problem_type(:backwords_through_statuses)
-    result << render_problem_type(:status_not_on_board)
+    result << render_problem_type(:issue_not_visible_on_board)
     result << render_problem_type(:created_in_wrong_status)
     result << render_problem_type(:stopped_before_started)
     result << render_problem_type(:issue_not_started_but_subtasks_have)
@@ -120,7 +121,7 @@ class DataQualityReport < ChartBase
 
   def initialize_entries
     @entries = @issues.filter_map do |issue|
-      started, stopped = issue.board.cycletime.started_stopped_times(issue)
+      started, stopped = issue.started_stopped_times
       next if stopped && stopped < time_range.begin
       next if started && started > time_range.end
 
@@ -194,7 +195,7 @@ class DataQualityReport < ChartBase
         # If it's been moved back to backlog then it's on a different report. Ignore it here.
         detail = nil if backlog_statuses.any? { |s| s.name == change.value }
 
-        entry.report(problem_key: :status_not_on_board, detail: detail) unless detail.nil?
+        entry.report(problem_key: :issue_not_visible_on_board, detail: detail) unless detail.nil?
       elsif change.old_value.nil?
         # Do nothing
       elsif index < last_index
@@ -223,6 +224,29 @@ class DataQualityReport < ChartBase
     end
   end
 
+  def scan_for_issue_not_in_active_sprint entry:
+    issue = entry.issue
+    return unless issue.board.scrum?
+    return if issue.sprints.any?(&:active?)
+
+    entry.report(problem_key: :issue_not_visible_on_board, detail: 'Issue is not in an active sprint')
+  end
+
+  def scan_for_issue_never_visible_on_board entry:
+    issue = entry.issue
+    ever_visible = issue.changes.any? do |change|
+      next unless change.status?
+
+      issue.board.visible_columns.any? { |col| col.status_ids.include?(change.value_id) }
+    end
+    return if ever_visible
+
+    entry.report(
+      problem_key: :issue_not_visible_on_board,
+      detail: 'Issue has never been in a status mapped to a visible column on the board'
+    )
+  end
+
   def scan_for_issues_not_created_in_a_backlog_status entry:, backlog_statuses:
     creation_change = entry.issue.changes.find { |issue| issue.status? }
 
@@ -250,7 +274,7 @@ class DataQualityReport < ChartBase
 
     started_subtasks = []
     entry.issue.subtasks.each do |subtask|
-      started_subtasks << subtask if subtask.board.cycletime.started_stopped_times(subtask).first
+      started_subtasks << subtask if subtask.started_stopped_times.first
     end
 
     return if started_subtasks.empty?
@@ -266,8 +290,10 @@ class DataQualityReport < ChartBase
 
   def scan_for_items_blocked_on_closed_tickets entry:
     entry.issue.issue_links.each do |link|
+      next unless settings['blocked_link_text'].include?(link.label)
+
       this_active = !entry.stopped
-      other_active = !link.other_issue.board.cycletime.started_stopped_times(link.other_issue).last
+      other_active = !link.other_issue.started_stopped_times.last
       next unless this_active && !other_active
 
       entry.report(
@@ -293,14 +319,14 @@ class DataQualityReport < ChartBase
     return "#{delta} hours" if delta < 24
 
     delta /= 24
-    "#{delta} days"
+    label_days delta
   end
 
   def scan_for_incomplete_subtasks_when_issue_done entry:
     return unless entry.stopped
 
     subtask_labels = entry.issue.subtasks.filter_map do |subtask|
-      subtask_started, subtask_stopped = subtask.board.cycletime.started_stopped_times(subtask)
+      subtask_started, subtask_stopped = subtask.started_stopped_times
 
       if !subtask_started && !subtask_stopped
         "#{subtask_label subtask} (Not even started)"
@@ -407,12 +433,12 @@ class DataQualityReport < ChartBase
     HTML
   end
 
-  def render_status_not_on_board problems
+  def render_issue_not_visible_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. 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.
+      timings as the work was likely to have been forgotten if it wasn't visible. An issue can be not visible
+      for two reasons: the issue was in a status that is not mapped to any visible column on the board
+      (look in "unmapped statuses" on your board), or for scrum boards, the issue was not in an active sprint.
     HTML
   end
 

data/lib/jirametrics/dependency_chart.rb

@@ -231,7 +231,7 @@ class DependencyChart < ChartBase
       elsif is_done
         line2 << 'Done'
       else
-        started_at = issue.board.cycletime.started_stopped_times(issue).first
+        started_at = issue.started_stopped_times.first
         if started_at.nil?
           line2 << 'Not started'
         else

data/lib/jirametrics/download_config.rb

@@ -25,10 +25,25 @@ class DownloadConfig
     @no_earlier_than
   end
 
+  def github_repos
+    @github_repos ||= []
+  end
+
+  def github_repo *repos
+    github_repos.concat(repos.map { |r| normalize_github_repo(r) })
+  end
+
   def start_date today:
     date = today.to_date - @rolling_date_count if @rolling_date_count
     date = [date, @no_earlier_than].max if date && @no_earlier_than
     date = @no_earlier_than if date.nil? && @no_earlier_than
     date
   end
+
+  private
+
+  def normalize_github_repo repo
+    match = repo.match(%r{github\.com/([^/]+/[^/]+?)/?$})
+    match ? match[1] : repo
+  end
 end

data/lib/jirametrics/downloader.rb

@@ -33,21 +33,23 @@ class Downloader
   # For testing only
   attr_reader :start_date_in_query, :board_id_to_filter_id
 
-  def self.create download_config:, file_system:, jira_gateway:
+  def self.create download_config:, file_system:, jira_gateway:, github_pr_cache: {}
     is_cloud = jira_gateway.settings['jira_cloud'] || jira_gateway.cloud?
     (is_cloud ? DownloaderForCloud : DownloaderForDataCenter).new(
       download_config: download_config,
       file_system: file_system,
-      jira_gateway: jira_gateway
+      jira_gateway: jira_gateway,
+      github_pr_cache: github_pr_cache
     )
   end
 
-  def initialize download_config:, file_system:, jira_gateway:
+  def initialize download_config:, file_system:, jira_gateway:, github_pr_cache: {}
     @metadata = {}
     @download_config = download_config
     @target_path = @download_config.project_config.target_path
     @file_system = file_system
     @jira_gateway = jira_gateway
+    @github_pr_cache = github_pr_cache
     @board_id_to_filter_id = {}
 
     @issue_keys_downloaded_in_current_run = []
@@ -77,6 +79,7 @@ class Downloader
     download_users
 
     save_metadata
+    download_github_prs if @download_config.github_repos.any?
   end
 
   def log text, both: false
@@ -165,11 +168,28 @@ class Downloader
     # actually look at the returned json.
     @board_id_to_filter_id[board_id] = json['filter']['id'].to_i
 
+    if json['type'] == 'simple'
+      features_json = download_features board_id: board_id
+      if BoardFeature.from_raw(features_json).any? { |f| f.name == 'jsw.agility.sprints' && f.enabled? }
+        download_sprints board_id: board_id
+      end
+    end
     download_sprints board_id: board_id if json['type'] == 'scrum'
     # TODO: Should be passing actual statuses, not empty list
     Board.new raw: json, possible_statuses: StatusCollection.new
   end
 
+  def download_features board_id:
+    log "  Downloading features for board #{board_id}", both: true
+    json = @jira_gateway.call_url relative_url: "/rest/agile/1.0/board/#{board_id}/features"
+
+    @file_system.save_json(
+      json: json,
+      filename: File.join(@target_path, "#{file_prefix}_board_#{board_id}_features.json")
+    )
+    json
+  end
+
   def download_sprints board_id:
     log "  Downloading sprints for board #{board_id}", both: true
     max_results = 100
@@ -211,19 +231,36 @@ class Downloader
         value = Date.parse(value) if value.is_a?(String) && value =~ /^\d{4}-\d{2}-\d{2}$/
         @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
     @metadata['no-download'] = hash['no-download'] if hash['no-download']
   end
 
+  def timezone_offset
+    @download_config.project_config.exporter.timezone_offset
+  end
+
+  def today_in_project_timezone
+    Time.now.getlocal(timezone_offset).to_date
+  end
+
   def save_metadata
     @metadata['version'] = CURRENT_METADATA_VERSION
+    @metadata['rolling_date_count'] = @download_config.rolling_date_count
     @metadata['date_start_from_last_query'] = @start_date_in_query if @start_date_in_query
 
     if @download_date_range.nil?
       log "Making up a date range in meta since one wasn't specified. You'll want to change that.", both: true
-      today = Date.today
+      today = today_in_project_timezone
       @download_date_range = (today - 7)..today
     end
 
@@ -258,7 +295,8 @@ class Downloader
     end
   end
 
-  def make_jql filter_id:, today: Date.today
+  def make_jql filter_id:, today: nil
+    today ||= today_in_project_timezone
     segments = []
     segments << "filter=#{filter_id}"
 
@@ -283,6 +321,39 @@ class Downloader
     segments.join ' AND '
   end
 
+  def download_github_prs
+    project_keys = extract_project_keys_from_downloaded_issues
+    if project_keys.empty?
+      log '  No project keys found in downloaded issues, skipping GitHub PR download', both: true
+      return
+    end
+
+    prs = @download_config.github_repos.flat_map do |repo|
+      GithubGateway.new(
+        repo: repo,
+        project_keys: project_keys,
+        file_system: @file_system,
+        raw_pr_cache: @github_pr_cache
+      ).fetch_pull_requests(since: @download_date_range&.begin)
+    end
+
+    @file_system.save_json(
+      json: prs.map(&:raw),
+      filename: File.join(@target_path, "#{file_prefix}_github_prs.json")
+    )
+  end
+
+  def extract_project_keys_from_downloaded_issues
+    path = File.join(@target_path, "#{file_prefix}_issues")
+    return [] unless @file_system.dir_exist?(path)
+
+    keys = []
+    @file_system.foreach(path) do |filename|
+      keys << filename.split('-').first if filename.match?(/^[A-Z][A-Z_0-9]+-\d+-\d+\.json$/)
+    end
+    keys.uniq
+  end
+
   def file_prefix
     @download_config.project_config.get_file_prefix
   end

data/lib/jirametrics/downloader_for_cloud.rb

@@ -5,6 +5,45 @@ class DownloaderForCloud < Downloader
     'Jira Cloud'
   end
 
+  def run
+    super
+    download_fix_versions
+  end
+
+  def download_board_configuration board_id:
+    board = super
+    location = board.raw['location']
+    @project_key ||= location['key'] if location&.[]('type') == 'project'
+    board
+  end
+
+  def download_fix_versions
+    return unless @project_key
+
+    log "  Downloading fix versions for project #{@project_key}", both: true
+    max_results = 50
+    start_at = 0
+    all_versions = []
+
+    loop do
+      json = @jira_gateway.call_url(
+        relative_url: "/rest/api/3/project/#{@project_key}/version?" \
+          "startAt=#{start_at}&maxResults=#{max_results}"
+      )
+
+      values = json['values'] || []
+      all_versions.concat(values)
+      break if json['isLast'] || values.empty?
+
+      start_at += values.size
+    end
+
+    @file_system.save_json(
+      json: all_versions,
+      filename: File.join(@target_path, "#{file_prefix}_fix_versions.json")
+    )
+  end
+
   def search_for_issues jql:, board_id:, path:
     log "  JQL: #{jql}"
     escaped_jql = CGI.escape jql

data/lib/jirametrics/downloader_for_data_center.rb

@@ -63,7 +63,8 @@ class DownloaderForDataCenter < Downloader
     end
   end
 
-  def make_jql filter_id:, today: Date.today
+  def make_jql filter_id:, today: nil
+    today ||= today_in_project_timezone
     segments = []
     segments << "filter=#{filter_id}"
 

data/lib/jirametrics/estimate_accuracy_chart.rb

@@ -5,7 +5,7 @@ class EstimateAccuracyChart < ChartBase
     super()
 
     header_text 'Estimate Accuracy'
-    description_text <<-HTML
+    description_text <<~HTML
       <div class="p">
         This chart graphs estimates against actual recorded cycle times. Since
         estimates can change over time, we're graphing the estimate at the time that the story started.
@@ -20,8 +20,18 @@ class EstimateAccuracyChart < ChartBase
           far to the right then you know you have a problem.
         <% end %>
       </div>
+      <% if @correlation_coefficient %>
+        <div class="p">
+          The completed items here have a correlation coefficient of <b><%= @correlation_coefficient.round(3) %></b>.
+          The closer it is to +1, the stronger the positive correlation. The closer it is to -1,
+          the stronger the negative collalation. Zero would mean no correlation at all.
+        </div>
+      <% end %>
     HTML
 
+    @x_axis_title = 'Cycletime (days)'
+    @y_axis_title = 'Estimate'
+
     @y_axis_type = 'linear'
     @y_axis_block = ->(issue, start_time) { estimate_at(issue: issue, start_time: start_time)&.to_f }
     @y_axis_sort_order = nil
@@ -30,9 +40,9 @@ class EstimateAccuracyChart < ChartBase
   end
 
   def run
-    if @y_axis_label.nil?
+    if @y_axis_title.nil?
       text = current_board.estimation_configuration.units == :story_points ? 'Story Points' : 'Days'
-      @y_axis_label = "Estimated #{text}"
+      @y_axis_title = "Estimated #{text}"
     end
     data_sets = scan_issues
 
@@ -43,7 +53,7 @@ class EstimateAccuracyChart < ChartBase
 
   def scan_issues
     completed_hash, aging_hash = split_into_completed_and_aging issues: issues
-
+    @correlation_coefficient = correlation_coefficient(completed_hash) unless completed_hash.empty?
     estimation_units = current_board.estimation_configuration.units
     @has_aging_data = !aging_hash.empty?
 
@@ -170,4 +180,32 @@ class EstimateAccuracyChart < ChartBase
     end
     @y_axis_block = block
   end
+
+  # Correlation coefficient is calculated using the Pearson Correlation Coefficient
+  # r = Σ((xi - x̄)(yi - ȳ)) / sqrt(Σ(xi - x̄)² · Σ(yi - ȳ)²)
+  def correlation_coefficient completed_hash
+    list1 = []
+    list2 = []
+    completed_hash.each do |(estimate, cycle_time), issues|
+      issues.size.times do
+        list1 << estimate
+        list2 << cycle_time
+      end
+    end
+
+    n = list1.size
+    return nil if n < 2
+
+    mean1 = list1.sum.to_f / n
+    mean2 = list2.sum.to_f / n
+
+    numerator = list1.zip(list2).sum { |x, y| (x - mean1) * (y - mean2) }
+    sum_sq1 = list1.sum { |x| (x - mean1)**2 }
+    sum_sq2 = list2.sum { |y| (y - mean2)**2 }
+
+    denominator = Math.sqrt(sum_sq1 * sum_sq2)
+    return nil if denominator.zero?
+
+    numerator / denominator
+  end
 end

data/lib/jirametrics/examples/aggregated_project.rb

@@ -12,7 +12,7 @@ class Exporter
     project name: name do
       puts name
       file_prefix name
-      self.settings.merge! settings
+      self.settings.merge! stringify_keys(settings)
 
       aggregate do
         project_names.each do |project_name|