jirametrics 2.13 → 2.30

data/lib/jirametrics/anonymizer.rb

@@ -2,11 +2,12 @@
 
 require 'random-word'
 
-class Anonymizer
+class Anonymizer < ChartBase
   # needed for testing
   attr_reader :project_config, :issues
 
   def initialize project_config:, date_adjustment: -200
+    super()
     @project_config = project_config
     @issues = @project_config.issues
     @all_boards = @project_config.all_boards
@@ -20,6 +21,10 @@ class Anonymizer
     anonymize_column_names
     # anonymize_issue_statuses
     anonymize_board_names
+    anonymize_labels_and_components
+    anonymize_sprints
+    anonymize_fix_versions
+    anonymize_server_url
     shift_all_dates unless @date_adjustment.zero?
     @file_system.log 'Anonymize done'
   end
@@ -37,13 +42,25 @@ class Anonymizer
 
   def anonymize_issue_keys_and_titles issues: @issues
     counter = 0
+    seen_author_raws = {}
     issues.each do |issue|
       new_key = "ANON-#{counter += 1}"
 
       issue.raw['key'] = new_key
       issue.raw['fields']['summary'] = random_phrase
+      issue.raw['fields']['description'] = nil
       issue.raw['fields']['assignee']['displayName'] = random_name unless issue.raw['fields']['assignee'].nil?
 
+      anonymize_author_raw(issue.raw['fields']['creator'], seen_author_raws)
+
+      issue.changes.each do |change|
+        anonymize_author_raw(change.author_raw, seen_author_raws)
+        if change.comment? || change.description?
+          change.value = nil
+          change.old_value = nil
+        end
+      end
+
       issue.issue_links.each do |link|
         other_issue = link.other_issue
         next if other_issue.key.match?(/^ANON-\d+$/) # Already anonymized?
@@ -54,6 +71,49 @@ class Anonymizer
     end
   end
 
+  def anonymize_labels_and_components
+    @issues.each do |issue|
+      issue.raw['fields']['labels'] = []
+      issue.raw['fields']['components'] = []
+    end
+  end
+
+  def anonymize_sprints
+    sprint_counter = 0
+    sprint_name_map = {}
+    @all_boards.each_value do |board|
+      board.sprints.each do |sprint|
+        name = sprint.raw['name']
+        unless sprint_name_map[name]
+          sprint_counter += 1
+          sprint_name_map[name] = "Sprint-#{sprint_counter}"
+        end
+        sprint.raw['name'] = sprint_name_map[name]
+      end
+    end
+  end
+
+  def anonymize_fix_versions
+    version_counter = 0
+    version_name_map = {}
+    @issues.each do |issue|
+      issue.raw['fields']['fixVersions']&.each do |fix_version|
+        name = fix_version['name']
+        unless version_name_map[name]
+          version_counter += 1
+          version_name_map[name] = "Version-#{version_counter}"
+        end
+        fix_version['name'] = version_name_map[name]
+      end
+    end
+  end
+
+  def anonymize_server_url
+    @all_boards.each_value do |board|
+      board.raw['self'] = board.raw['self']&.sub(/^https?:\/\/[^\/]+/, 'https://anon.example.com')
+    end
+  end
+
   def anonymize_column_names
     @all_boards.each_key do |board_id|
       @file_system.log "Anonymizing column names for board #{board_id}"
@@ -130,18 +190,19 @@ class Anonymizer
     end
   end
 
-  def shift_all_dates
-    @file_system.log "Shifting all dates by #{@date_adjustment} days"
+  def shift_all_dates date_adjustment: @date_adjustment
+    adjustment_in_seconds = 60 * 60 * 24 * date_adjustment
+    @file_system.log "Shifting all dates by #{label_days date_adjustment}"
     @issues.each do |issue|
       issue.changes.each do |change|
-        change.time = change.time + @date_adjustment
+        change.time = change.time + adjustment_in_seconds
       end
 
-      issue.raw['fields']['updated'] = (issue.updated + @date_adjustment).to_s
+      issue.raw['fields']['updated'] = (issue.updated + adjustment_in_seconds).to_s
     end
 
     range = @project_config.time_range
-    @project_config.time_range = (range.begin + @date_adjustment)..(range.end + @date_adjustment)
+    @project_config.time_range = (range.begin + adjustment_in_seconds)..(range.end + adjustment_in_seconds)
   end
 
   def random_name
@@ -184,4 +245,18 @@ class Anonymizer
       board.raw['name'] = "#{random_phrase} board"
     end
   end
+
+  private
+
+  def anonymize_author_raw author_raw, seen
+    return unless author_raw
+    return if seen[author_raw.object_id]
+
+    seen[author_raw.object_id] = true
+    name = random_name
+    author_raw['displayName'] = name
+    author_raw['name'] = name
+    author_raw.delete('emailAddress')
+    author_raw.delete('avatarUrls')
+  end
 end

data/lib/jirametrics/atlassian_document_format.rb

@@ -5,6 +5,7 @@ class AtlassianDocumentFormat
 
   def initialize users:, timezone_offset:
     @users = users
+    @timezone_offset = timezone_offset
   end
 
   def to_html input
@@ -12,112 +13,105 @@ class AtlassianDocumentFormat
       input
         .gsub(/{color:(#\w{6})}([^{]+){color}/, '<span style="color: \1">\2</span>') # Colours
         .gsub(/\[~accountid:([^\]]+)\]/) { expand_account_id $1 } # Tagged people
-        .gsub(/\[([^\|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
+        .gsub(/\[([^|]+)\|(https?[^\]]+)\]/, '<a href="\2">\1</a>') # URLs
         .gsub("\n", '<br />')
-    else
+    elsif input&.[]('content')
       input['content'].collect { |element| adf_node_to_html element }.join("\n")
+    else
+      # We have an actual ADF document with no content.
+      ''
     end
   end
 
-  # ADF is Atlassian Document Format
-  # https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/
-  def adf_node_to_html node
-    closing_tag = nil
-    node_attrs = node['attrs']
-
-    result = +''
-    case node['type']
-    when 'blockquote'
-      result << '<blockquote>'
-      closing_tag = '</blockquote>'
-    when 'bulletList'
-      result << '<ul>'
-      closing_tag = '</ul>'
-    when 'codeBlock'
-      result << '<code>'
-      closing_tag = '</code>'
-    when 'date'
-      result << Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s
-    when 'decisionItem'
-      result << '<li>'
-      closing_tag = '</li>'
-    when 'decisionList'
-      result << '<div>Decisions<ul>'
-      closing_tag = '</ul></div>'
-    when 'emoji'
-      result << node_attrs['text']
-    when 'expand'
-      # TODO: Maybe, someday, make this actually expandable. For now it's always open
-      result << "<div>#{node_attrs['title']}</div>"
-    when 'hardBreak'
-      result << '<br />'
-    when 'heading'
-      level = node_attrs['level']
-      result << "<h#{level}>"
-      closing_tag = "</h#{level}>"
-    when 'inlineCard'
-      url = node_attrs['url']
-      result << "[Inline card]: <a href='#{url}'>#{url}</a>"
-    when 'listItem'
-      result << '<li>'
-      closing_tag = '</li>'
-    when 'media'
-      text = node_attrs['alt'] || node_attrs['id']
-      result << "Media: #{text}"
-    when 'mediaSingle', 'mediaGroup'
-      result << '<div>'
-      closing_tag = '</div>'
-    when 'mention'
-      user = node_attrs['text']
-      result << "<b>#{user}</b>"
-    when 'orderedList'
-      result << '<ol>'
-      closing_tag = '</ol>'
-    when 'panel'
-      type = node_attrs['panelType']
-      result << "<div>#{type.upcase}</div>"
-    when 'paragraph'
-      result << '<p>'
-      closing_tag = '</p>'
-    when 'rule'
-      result << '<hr />'
-    when 'status'
-      text = node_attrs['text']
-      result << text
-    when 'table'
-      result << '<table>'
-      closing_tag = '</table>'
-    when 'tableCell'
-      result << '<td>'
-      closing_tag = '</td>'
-    when 'tableHeader'
-      result << '<th>'
-      closing_tag = '</th>'
-    when 'tableRow'
-      result << '<tr>'
-      closing_tag = '</tr>'
-    when 'text'
-      marks = adf_marks_to_html node['marks']
-      result << marks.collect(&:first).join
-      result << node['text']
-      result << marks.collect(&:last).join
-    when 'taskItem'
-      state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
-      result << "<li>#{state} "
-      closing_tag = '</li>'
-    when 'taskList'
-      result << "<ul class='taskList'>"
-      closing_tag = '</ul>'
+  def to_text input
+    if input.is_a? String
+      input
+    elsif input&.[]('content')
+      input['content'].collect { |element| adf_node_to_text element }.join
     else
-      result << "<p>Unparseable section: #{node['type']}</p>"
+      ''
     end
+  end
 
-    node['content']&.each do |child|
-      result << adf_node_to_html(child)
+  # ADF is Atlassian Document Format
+  # https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/
+  def adf_node_to_html node # rubocop:disable Metrics/CyclomaticComplexity
+    adf_node_render(node) do |n|
+      node_attrs = n['attrs']
+      case n['type']
+      when 'blockquote'                then ['<blockquote>', '</blockquote>']
+      when 'bulletList'                then ['<ul>', '</ul>']
+      when 'codeBlock'                 then ['<code>', '</code>']
+      when 'date'
+        [Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s, nil]
+      when 'decisionItem', 'listItem'  then ['<li>', '</li>']
+      when 'decisionList'              then ['<div>Decisions<ul>', '</ul></div>']
+      when 'emoji', 'status'           then [node_attrs['text'], nil]
+      when 'expand'                    then ["<div>#{node_attrs['title']}</div>", nil]
+      when 'hardBreak'                 then ['<br />', nil]
+      when 'heading'
+        level = node_attrs['level']
+        ["<h#{level}>", "</h#{level}>"]
+      when 'inlineCard'
+        url = node_attrs['url']
+        ["[Inline card]: <a href='#{url}'>#{url}</a>", nil]
+      when 'media'
+        text = node_attrs['alt'] || node_attrs['id']
+        ["Media: #{text}", nil]
+      when 'mediaSingle', 'mediaGroup' then ['<div>', '</div>']
+      when 'mention'                   then ["<b>#{node_attrs['text']}</b>", nil]
+      when 'orderedList'               then ['<ol>', '</ol>']
+      when 'panel'                     then ["<div>#{node_attrs['panelType'].upcase}</div>", nil]
+      when 'paragraph'                 then ['<p>', '</p>']
+      when 'rule'                      then ['<hr />', nil]
+      when 'table'                     then ['<table>', '</table>']
+      when 'tableCell'                 then ['<td>', '</td>']
+      when 'tableHeader'               then ['<th>', '</th>']
+      when 'tableRow'                  then ['<tr>', '</tr>']
+      when 'text'
+        marks = adf_marks_to_html(n['marks'])
+        [marks.collect(&:first).join + n['text'], marks.collect(&:last).join]
+      when 'taskItem'
+        state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
+        ["<li>#{state} ", '</li>']
+      when 'taskList'                  then ["<ul class='taskList'>", '</ul>']
+      else
+        ["<p>Unparseable section: #{n['type']}</p>", nil]
+      end
     end
+  end
 
-    result << closing_tag if closing_tag
-    result
+  def adf_node_to_text node # rubocop:disable Metrics/CyclomaticComplexity
+    adf_node_render(node) do |n|
+      node_attrs = n['attrs']
+      case n['type']
+      when 'blockquote', 'bulletList', 'codeBlock',
+           'mediaSingle', 'mediaGroup',
+           'orderedList', 'table', 'taskList'  then ['', nil]
+      when 'date'
+        [Time.at(node_attrs['timestamp'].to_i / 1000, in: @timezone_offset).to_date.to_s, nil]
+      when 'decisionItem'              then ['- ', "\n"]
+      when 'decisionList'              then ["Decisions:\n", nil]
+      when 'emoji', 'mention', 'status' then [node_attrs['text'], nil]
+      when 'expand'                    then ["#{node_attrs['title']}\n", nil]
+      when 'hardBreak'                 then ["\n", nil]
+      when 'heading', 'paragraph', 'tableRow' then ['', "\n"]
+      when 'inlineCard'                then [node_attrs['url'], nil]
+      when 'listItem'                  then ['- ', nil]
+      when 'media'
+        text = node_attrs['alt'] || node_attrs['id']
+        ["Media: #{text}", nil]
+      when 'panel'                     then ["#{node_attrs['panelType'].upcase}\n", nil]
+      when 'rule'                      then ["---\n", nil]
+      when 'tableCell', 'tableHeader'  then ['', "\t"]
+      when 'text'                      then [n['text'], nil]
+      when 'taskItem'
+        state = node_attrs['state'] == 'TODO' ? '☐' : '☑'
+        ["#{state} ", "\n"]
+      else
+        ["[Unparseable: #{n['type']}]\n", nil]
+      end
+    end
   end
 
   def adf_marks_to_html list
@@ -153,4 +147,14 @@ class AtlassianDocumentFormat
     text = "@#{user.display_name}" if user
     "<span class='account_id'>#{text}</span>"
   end
-end
+
+  private
+
+  def adf_node_render node, &render_node
+    prefix, suffix = render_node.call(node)
+    result = +(prefix || '')
+    node['content']&.each { |child| result << adf_node_render(child, &render_node) }
+    result << suffix if suffix
+    result
+  end
+end

data/lib/jirametrics/bar_chart_range.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jirametrics/value_equality'
+
+class BarChartRange
+  include ValueEquality
+
+  attr_accessor :start, :stop, :color, :title, :highlight
+
+  def initialize start:, stop:, color:, title:, highlight: false
+    @start = start
+    @stop = stop
+    @color = color
+    @title = title
+    @highlight = highlight
+  end
+end

data/lib/jirametrics/blocked_stalled_change.rb

@@ -4,10 +4,12 @@ require 'jirametrics/value_equality'
 
 class BlockedStalledChange
   include ValueEquality
-  attr_reader :time, :blocking_issue_keys, :flag, :status, :stalled_days, :status_is_blocking
+  attr_reader :time, :blocking_issue_keys, :flag, :flag_reason, :status, :stalled_days, :status_is_blocking
 
-  def initialize time:, flagged: nil, status: nil, status_is_blocking: true, blocking_issue_keys: nil, stalled_days: nil
+  def initialize time:, flagged: nil, flag_reason: nil, status: nil, status_is_blocking: true,
+    blocking_issue_keys: nil, stalled_days: nil
     @flag = flagged
+    @flag_reason = flag_reason
     @status = status
     @status_is_blocking = status_is_blocking
     @blocking_issue_keys = blocking_issue_keys
@@ -25,7 +27,7 @@ class BlockedStalledChange
   def reasons
     result = []
     if blocked?
-      result << 'Blocked by flag' if @flag
+      result << (@flag_reason ? "Blocked by flag: #{@flag_reason}" : 'Blocked by flag') if @flag
       result << "Blocked by status: #{@status}" if blocked_by_status?
       result << "Blocked by issues: #{@blocking_issue_keys.join(', ')}" if @blocking_issue_keys
     elsif stalled_by_status?

data/lib/jirametrics/board.rb

@@ -4,18 +4,18 @@ class Board
   attr_reader :visible_columns, :raw, :possible_statuses, :sprints
   attr_accessor :cycletime, :project_config
 
-  def initialize raw:, possible_statuses:
+  def initialize raw:, possible_statuses:, features: []
     @raw = raw
     @possible_statuses = possible_statuses
     @sprints = []
+    @features = features
 
     columns = raw['columnConfig']['columns']
     ensure_uniqueness_of_column_names! columns
 
-    # For a Kanban board, the first column here will always be called 'Backlog' and will NOT be
-    # visible on the board. If the board is configured to have a kanban backlog then it will have
-    # statuses matched to it and otherwise, there will be no statuses.
-    columns = columns.drop(1) if kanban?
+    # For a classic Kanban board (type 'kanban'), the first column will always be called 'Backlog'
+    # and will NOT be visible on the board. This does not apply to team-managed boards (type 'simple').
+    columns = columns.drop(1) if board_type == 'kanban'
 
     @backlog_statuses = []
     @visible_columns = columns.filter_map do |column|
@@ -25,7 +25,7 @@ class Board
   end
 
   def backlog_statuses
-    if @backlog_statuses.empty? && kanban?
+    if @backlog_statuses.empty? && board_type == 'kanban'
       status_ids = status_ids_from_column raw['columnConfig']['columns'].first
       @backlog_statuses = status_ids.filter_map do |id|
         @possible_statuses.find_by_id id
@@ -67,8 +67,28 @@ class Board
   end
 
   def board_type = raw['type']
-  def kanban? = (board_type == 'kanban')
-  def scrum? = (board_type == 'scrum')
+
+  def scrum?
+    return true if board_type == 'scrum'
+    return false unless board_type == 'simple'
+
+    has_sprints_feature?
+  end
+
+  def kanban?
+    return true if board_type == 'kanban'
+    return false unless board_type == 'simple'
+
+    !scrum?
+  end
+
+  def team_managed_kanban?
+    board_type == 'simple' && !has_sprints_feature?
+  end
+
+  def has_sprints_feature?
+    @features.any? { |f| f.name == 'jsw.agility.sprints' && f.enabled? }
+  end
 
   def id
     @raw['id'].to_i
@@ -116,4 +136,8 @@ class Board
   def estimation_configuration
     EstimationConfiguration.new raw: raw['estimation']
   end
+
+  def inspect
+    "Board(id: #{id}, name: #{name.inspect}, board_type: #{board_type.inspect})"
+  end
 end

data/lib/jirametrics/board_config.rb

@@ -11,6 +11,7 @@ class BoardConfig
 
   def run
     @board = @project_config.all_boards[id]
+    raise "Can't find board #{id.inspect} in #{@project_config.all_boards.keys.inspect}" unless @board
 
     instance_eval(&@block)
     raise "Must specify a cycletime for board #{@id}" if @board.cycletime.nil?
@@ -23,7 +24,9 @@ class BoardConfig
     end
 
     @board.cycletime = CycleTimeConfig.new(
-      parent_config: self, label: label, block: block, file_system: project_config.file_system
+      possible_statuses: project_config.possible_statuses,
+      label: label, block: block, file_system: project_config.file_system,
+      settings: project_config.settings
     )
   end
 

data/lib/jirametrics/board_feature.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class BoardFeature
+  def initialize raw:
+    @raw = raw
+  end
+
+  def name = @raw['feature']
+  def enabled? = (@raw['state'] == 'ENABLED')
+
+  def self.from_raw features_json
+    features_json['features']&.map { |f| new(raw: f) } || []
+  end
+end

data/lib/jirametrics/board_movement_calculator.rb

@@ -10,7 +10,7 @@ class BoardMovementCalculator
   end
 
   def moves_backwards? issue
-    started, stopped = issue.board.cycletime.started_stopped_times(issue)
+    started, stopped = issue.started_stopped_times
     return false unless started
 
     previous_column = nil
@@ -70,7 +70,7 @@ class BoardMovementCalculator
     @issues.filter_map do |issue|
       this_column_start = issue.first_time_in_or_right_of_column(this_column.name)&.time
       next_column_start = next_column.nil? ? nil : issue.first_time_in_or_right_of_column(next_column.name)&.time
-      issue_start, issue_done = issue.board.cycletime.started_stopped_times(issue)
+      issue_start, issue_done = issue.started_stopped_times
 
       # Skip if we can't tell when it started.
       next if issue_start.nil?

data/lib/jirametrics/cfd_data_builder.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class CfdDataBuilder
+  def initialize board:, issues:, date_range:, columns: nil
+    @board = board
+    @issues = issues
+    @date_range = date_range
+    @columns = columns || board.visible_columns
+  end
+
+  def run
+    column_map = build_column_map
+    issue_states = @issues.map { |issue| process_issue(issue, column_map) }
+
+    {
+      columns: @columns.map(&:name),
+      daily_counts: build_daily_counts(issue_states),
+      correction_windows: issue_states.flat_map { |s| s[:correction_windows] }
+    }
+  end
+
+  private
+
+  def build_column_map
+    map = {}
+    @columns.each_with_index do |column, index|
+      column.status_ids.each { |id| map[id] = index }
+    end
+    map
+  end
+
+  # 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?
+
+      if high_water_mark.nil? || col_index > high_water_mark
+        # Forward movement: advance hwm, close any open correction window, record timeline entry
+        if correction_open_since
+          correction_windows << {
+            start_date: correction_open_since,
+            end_date: change.time.to_date,
+            column_index: high_water_mark
+          }
+          correction_open_since = nil
+        end
+        high_water_mark = col_index
+        hwm_timeline << [change.time.to_date, high_water_mark]
+      elsif col_index == high_water_mark && correction_open_since
+        # Same-column recovery: close the correction window without changing hwm or adding timeline entry
+        correction_windows << {
+          start_date: correction_open_since,
+          end_date: change.time.to_date,
+          column_index: high_water_mark
+        }
+        correction_open_since = nil
+      elsif col_index < high_water_mark
+        # Backwards movement: open correction window if not already open
+        correction_open_since ||= change.time.to_date
+      end
+    end
+
+    if correction_open_since
+      correction_windows << {
+        start_date: correction_open_since,
+        end_date: @date_range.end,
+        column_index: high_water_mark
+      }
+    end
+
+    { hwm_timeline: hwm_timeline, correction_windows: correction_windows }
+  end
+
+  def hwm_at hwm_timeline, date
+    result = nil
+    hwm_timeline.each do |timeline_date, hwm|
+      break if timeline_date > date
+
+      result = hwm
+    end
+    result
+  end
+
+  def build_daily_counts issue_states
+    column_count = @columns.size
+    @date_range.each_with_object({}) do |date, result|
+      counts = Array.new(column_count, 0)
+      issue_states.each do |state|
+        hwm = hwm_at(state[:hwm_timeline], date)
+        next if hwm.nil?
+
+        (0..hwm).each { |i| counts[i] += 1 }
+      end
+      result[date] = counts
+    end
+  end
+end