jirametrics 1.0.0

data/lib/jirametrics/anonymizer.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require 'random-word'
+
+class Anonymizer
+  # needed for testing
+  attr_reader :project_config, :issues
+
+  def initialize project_config:, date_adjustment: -200
+    @project_config = project_config
+    @issues = @project_config.issues
+    @all_boards = @project_config.all_boards
+    @possible_statuses = @project_config.possible_statuses
+    @date_adjustment = date_adjustment
+  end
+
+  def run
+    anonymize_issue_keys_and_titles
+    anonymize_column_names
+    # anonymize_issue_statuses
+    anonymize_board_names
+    shift_all_dates unless @date_adjustment.zero?
+    puts 'Anonymize done'
+  end
+
+  def random_phrase
+    # RandomWord periodically blows up for no reason we can determine. If it throws an exception then
+    # just try again. In every case we've seen, it's worked on the second attempt, but we'll be
+    # cautious and try five times.
+    5.times do |i|
+      return RandomWord.phrases.next.gsub(/_/, ' ')
+    rescue # rubocop:disable Style/RescueStandardError We don't care what exception was thrown.
+      puts "Random word blew up on attempt #{i + 1}"
+    end
+  end
+
+  def anonymize_issue_keys_and_titles issues: @issues
+    counter = 0
+    issues.each do |issue|
+      new_key = "ANON-#{counter += 1}"
+
+      issue.raw['key'] = new_key
+      issue.raw['fields']['summary'] = random_phrase
+      issue.raw['fields']['assignee']['displayName'] = random_name unless issue.raw['fields']['assignee'].nil?
+
+      issue.issue_links.each do |link|
+        other_issue = link.other_issue
+        next if other_issue.key =~ /^ANON-\d+$/ # Already anonymized?
+
+        other_issue.raw['key'] = "ANON-#{counter += 1}"
+        other_issue.raw['fields']['summary'] = random_phrase
+      end
+    end
+  end
+
+  def anonymize_column_names
+    @all_boards.each_key do |board_id|
+      puts "Anonymizing column names for board #{board_id}"
+
+      column_name = 'Column-A'
+      @all_boards[board_id].visible_columns.each do |column|
+        column.name = column_name
+        column_name = column_name.next
+      end
+    end
+  end
+
+  def build_status_name_hash
+    next_status = 'a'
+    status_name_hash = {}
+    @issues.each do |issue|
+      issue.changes.each do |change|
+        next unless change.status?
+
+        # TODO: Do old value too
+        status_key = change.value
+        if status_name_hash[status_key].nil?
+          status_name_hash[status_key] = "status-#{next_status}"
+          next_status = next_status.next
+        end
+      end
+    end
+
+    @possible_statuses.each do |status|
+      status_key = status.name
+      if status_name_hash[status_key].nil?
+        status_name_hash[status_key] = "status-#{next_status}"
+        next_status = next_status.next
+      end
+    end
+
+    status_name_hash
+  end
+
+  def anonymize_issue_statuses
+    puts 'Anonymizing issue statuses and status categories'
+    status_name_hash = build_status_name_hash
+
+    @issues.each do |issue|
+      # This is where we create URL's from
+      issue.raw['self'] = nil
+
+      issue.changes.each do |change|
+        next unless change.status?
+
+        status_key = change.value
+        anonymized_value = status_name_hash[status_key]
+        raise "status_name_hash[#{status_key.inspect} is nil" if anonymized_value.nil?
+
+        change.value = anonymized_value
+
+        next if change.old_value.nil?
+
+        status_key = change.old_value
+        anonymized_value = status_name_hash[status_key]
+        raise "status_name_hash[#{status_key.inspect} is nil" if anonymized_value.nil?
+
+        change.old_value = anonymized_value
+      end
+    end
+
+    @possible_statuses.each do |status|
+      status_key = status.name
+      if status_name_hash[status_key].nil?
+        raise "Can't find status_key #{status_key.inspect} in #{status_name_hash.inspect}"
+      end
+
+      status.name = status_name_hash[status_key] unless status_name_hash[status_key].nil?
+    end
+  end
+
+  def shift_all_dates
+    puts "Shifting all dates by #{@date_adjustment} days"
+    @issues.each do |issue|
+      issue.changes.each do |change|
+        change.time = change.time + @date_adjustment
+      end
+
+      issue.raw['fields']['updated'] = (issue.updated + @date_adjustment).to_s
+    end
+
+    range = @project_config.time_range
+    @project_config.time_range = (range.begin + @date_adjustment)..(range.end + @date_adjustment)
+  end
+
+  def random_name
+    # Names generated from https://www.random-name-generator.com
+    [
+      'Benjamin Pelletier',
+      'Levi Scott',
+      'Emilia Leblanc',
+      'Victoria Singh',
+      'Theodore King',
+      'Amelia Kelly',
+      'Samuel Jones',
+      'Lucy Kelly',
+      'Oliver Fortin',
+      'Riley Murphy',
+      'Elijah Stewart',
+      'Elizabeth Murphy',
+      'Declan Simard',
+      'Myles Singh',
+      'Jayden Smith',
+      'Sophie Richard',
+      'Levi Mitchell',
+      'Alexander Davis',
+      'Sebastian Thompson',
+      'Logan Robinson',
+      'Madison Girard',
+      'Ellie King',
+      'Aiden Miller',
+      'Ethan Anderson',
+      'Scarlett Murray',
+      'Audrey Moore',
+      'Emmett Reid',
+      'Jacob Poirier',
+      'Violet MacDonald'
+    ].sample
+  end
+
+  def anonymize_board_names
+    @all_boards.values.each do |board|
+      board.raw['name'] = "#{random_phrase} board"
+    end
+  end
+end

data/lib/jirametrics/blocked_stalled_change.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class BlockedStalledChange
+  attr_reader :time, :blocking_issue_keys, :flag, :status, :stalled_days, :status_is_blocking
+
+  def initialize time:, flagged: nil, status: nil, status_is_blocking: true, blocking_issue_keys: nil, stalled_days: nil
+    @flag = flagged
+    @status = status
+    @status_is_blocking = status_is_blocking
+    @blocking_issue_keys = blocking_issue_keys
+    @stalled_days = stalled_days
+    @time = time
+  end
+
+  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 ==(other)
+    (other.class == self.class) && (other.state == state)
+  end
+
+  def state
+    instance_variables.map { |variable| instance_variable_get variable }
+  end
+
+  def reasons
+    result = []
+    if blocked?
+      result << '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?
+      result << "Stalled by status: #{@status}"
+    elsif @stalled_days
+      result << "Stalled by inactivity: #{@stalled_days} days"
+    end
+    result.join(', ')
+  end
+end

data/lib/jirametrics/board.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+class Board
+  attr_reader :visible_columns, :raw, :possible_statuses, :sprints, :backlog_statuses
+  attr_accessor :cycletime, :project_config, :expedited_priority_names
+
+  def initialize raw:, possible_statuses: StatusCollection.new
+    @raw = raw
+    @board_type = raw['type']
+    @possible_statuses = possible_statuses
+    @sprints = []
+    @expedited_priority_names = []
+
+    columns = raw['columnConfig']['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.
+    if kanban?
+      assert_jira_behaviour_true(columns[0]['name'] == 'Backlog') do
+        "Expected first column to be called Backlog: #{raw}"
+      end
+
+      @backlog_statuses = @possible_statuses.expand_statuses(status_ids_from_column columns[0]) do |unknown_status|
+        # Yet another "theoretically impossible and yet we've seen it in production" moment
+        puts "Status #{unknown_status.inspect} is defined as being in the backlog for board #{name.inspect}:#{id} " \
+          'and yet it\'s not defined in the list of possible statuses available to the project. Check your Jira ' \
+          'configuration'
+      end
+      columns = columns[1..]
+    else
+      # We currently don't know how to get the backlog status for a Scrum board
+      @backlog_statuses = []
+    end
+
+    @visible_columns = columns.collect do |column|
+      # It's possible for a column to be defined without any statuses and in this case, it won't be visible.
+      BoardColumn.new column unless status_ids_from_column(column).empty?
+    end.compact
+  end
+
+  def url
+    # Strangely, the URL isn't anywhere in the returned data so we have to fabricate it.
+    raise "Cannot parse self: #{@raw['self']}" unless @raw['self'] =~ /^(https?:\/\/[^\/]+)\//
+
+    "#{$1}/secure/RapidBoard.jspa?rapidView=#{id}"
+  end
+
+  def status_ids_from_column column
+    column['statuses'].collect { |status| status['id'].to_i }
+  end
+
+  def status_ids_in_or_right_of_column column_name
+    status_ids = []
+    found_it = false
+
+    @visible_columns.each do |column|
+      # Check both the current name and also the original raw name in case anonymization has happened.
+      found_it = true if column.name == column_name || column.raw['name'] == column_name
+      status_ids += column.status_ids if found_it
+    end
+
+    unless found_it
+      column_names = @visible_columns.collect(&:name).collect(&:inspect).join(', ')
+      raise "No visible column with name: #{column_name.inspect} Possible options are: #{column_names}"
+    end
+    status_ids
+  end
+
+  def kanban?
+    @board_type == 'kanban'
+  end
+
+  def scrum?
+    @board_type == 'scrum'
+  end
+
+  def id
+    @raw['id'].to_i
+  end
+
+  def name
+    @raw['name']
+  end
+end

data/lib/jirametrics/board_column.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class BoardColumn
+  attr_reader :status_ids, :min, :max, :raw
+  attr_accessor :name
+
+  def initialize raw
+    @raw = raw
+    @name = raw['name']
+    @status_ids = raw['statuses'].collect { |status| status['id'].to_i }
+    @min = raw['min']&.to_i
+    @max = raw['max']&.to_i
+  end
+end

data/lib/jirametrics/board_config.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class BoardConfig
+  attr_reader :id, :project_config
+
+  def initialize id:, block:, project_config:
+    @id = id
+    @block = block
+    @project_config = project_config
+  end
+
+  def run
+    @board = @project_config.all_boards[id]
+    @board.expedited_priority_names = []
+
+    instance_eval(&@block)
+  end
+
+  def cycletime label = nil, &block
+    if @board.cycletime
+      raise "Cycletime has already been set for board #{id}. Did you also set it inside the html_report? " \
+        'If so, remove it from there.'
+    end
+
+    @board.cycletime = CycleTimeConfig.new(parent_config: self, label: label, block: block)
+  end
+
+  def expedited_priority_names *priority_names
+    @board.expedited_priority_names = priority_names unless priority_names.empty?
+  end
+end

data/lib/jirametrics/change_item.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+class ChangeItem
+  attr_reader :field, :value_id, :old_value_id, :raw, :author
+  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
+
+    @field = field || @raw['field']
+    @value = value || @raw['toString']
+    @value_id = @raw['to'].to_i
+    @old_value = @raw['fromString']
+    @old_value_id = @raw['from']&.to_i
+    @artificial = artificial
+    @author = author
+  end
+
+  def status? = (field == 'status')
+
+  def flagged? = (field == 'Flagged')
+
+  def priority? = (field == 'priority')
+
+  def resolution? = (field == 'resolution')
+
+  def artificial? = @artificial
+
+  def sprint? = (field == 'Sprint')
+
+  def story_points? = (field == 'Story Points')
+
+  def link? = (field == 'Link')
+
+  def to_s
+    message = "ChangeItem(field: #{field.inspect}, value: #{value.inspect}, time: \"#{@time}\""
+    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)
+  end
+
+  def current_status_matches *status_names_or_ids
+    return false unless status?
+
+    status_names_or_ids.any? do |name_or_id|
+      case name_or_id
+      when Status
+        name_or_id.id == @value_id
+      when String
+        name_or_id == @value
+      else
+        name_or_id == @value_id
+      end
+    end
+  end
+
+  def old_status_matches *status_names_or_ids
+    return false unless status?
+
+    status_names_or_ids.any? do |name_or_id|
+      case name_or_id
+      when Status
+        name_or_id.id == @old_value_id
+      when String
+        name_or_id == @old_value
+      else
+        name_or_id == @old_value_id
+      end
+    end
+  end
+end

data/lib/jirametrics/chart_base.rb

@@ -0,0 +1,239 @@
+# frozen_string_literal: true
+
+class ChartBase
+  attr_accessor :timezone_offset, :board_id, :all_boards, :date_range,
+    :time_range, :data_quality, :holiday_dates, :settings
+  attr_writer :aggregated_project
+  attr_reader :issues, :canvas_width, :canvas_height
+
+  @@chart_counter = 0
+
+  def initialize
+    @chart_colors = {
+      'dark:Story' => 'green',
+      'dark:Task' => 'blue',
+      'dark:Bug' => 'orange',
+      'dark:Defect' => 'orange',
+      'dark:Spike' => '#9400D3', # dark purple
+      'light:Story' => '#90EE90',
+      'light:Task' => '#87CEFA',
+      'light:Bug' => '#ffdab9',
+      'light:Defect' => 'orange',
+      'light:Epic' => '#fafad2',
+      'light:Spike' => '#DDA0DD' # light purple
+    }
+    @canvas_width = 800
+    @canvas_height = 200
+    @canvas_responsive = true
+  end
+
+  def aggregated_project?
+    @aggregated_project
+  end
+
+  def render caller_binding, file
+    pathname = Pathname.new(File.realpath(file))
+    basename = pathname.basename.to_s
+    raise "Unexpected filename #{basename.inspect}" unless basename =~ /^(.+)\.rb$/
+
+    # Insert a incrementing chart_id so that all the chart names on the page are unique
+    caller_binding.eval "chart_id='chart#{next_id}'" # chart_id=chart3
+
+    @html_directory = "#{pathname.dirname}/html"
+    erb = ERB.new File.read "#{@html_directory}/#{$1}.erb"
+    erb.result(caller_binding)
+  end
+
+  # Render the file and then wrap it with standard headers and quality checks.
+  def wrap_and_render caller_binding, file
+    result = String.new
+    result << "<h1>#{@header_text}</h1>" if @header_text
+    result << ERB.new(@description_text).result(caller_binding) if @description_text
+    result << render(caller_binding, file)
+    result
+  end
+
+  def next_id
+    @@chart_counter += 1
+  end
+
+  def color_for type:, shade: :dark
+    @chart_colors["#{shade}:#{type}"] ||= random_color
+  end
+
+  def label_days days
+    "#{days} day#{'s' unless days == 1}"
+  end
+
+  def label_issues count
+    "#{count} issue#{'s' unless count == 1}"
+  end
+
+  def daily_chart_dataset date_issues_list:, color:, label:, positive: true
+    {
+      type: 'bar',
+      label: label,
+      data: date_issues_list.collect do |date, issues|
+        issues.sort! { |a, b| a.key_as_i <=> b.key_as_i }
+        title = "#{label} (#{label_issues issues.size})"
+        {
+          x: date,
+          y: positive ? issues.size : -issues.size,
+          title: [title] + issues.collect { |i| "#{i.key} : #{i.summary.strip}#{" #{yield date, i}" if block_given?}" }
+        }
+      end,
+      backgroundColor: color,
+      borderRadius: positive ? 0 : 5
+    }
+  end
+
+  def link_to_issue issue, args = {}
+    attributes = { class: 'issue_key' }
+      .merge(args)
+      .collect { |key, value| "#{key}='#{value}'" }
+      .join(' ')
+    "<a href='#{issue.url}' #{attributes}>#{issue.key}</a>"
+  end
+
+  def collapsible_issues_panel issue_descriptions, *args
+    link_id = next_id
+    issues_id = next_id
+
+    issue_descriptions.sort! { |a, b| a[0].key_as_i <=> b[0].key_as_i }
+    erb = ERB.new File.read "#{@html_directory}/collapsible_issues_panel.erb"
+    erb.result(binding)
+  end
+
+  def holidays date_range: @date_range
+    result = []
+    start_date = nil
+    end_date = nil
+
+    date_range.each do |date|
+      if date.saturday? || date.sunday? || holiday_dates.include?(date)
+        if start_date.nil?
+          start_date = date
+        else
+          end_date = date
+        end
+      elsif start_date
+        result << (start_date..(end_date || start_date))
+        start_date = nil
+        end_date = nil
+      end
+    end
+    result
+  end
+
+  # Return only the board columns for the current board.
+  def current_board
+    if @board_id.nil?
+      case @all_boards.size
+      when 0
+        raise 'Couldn\'t find any board configurations. Ensure one is set'
+      when 1
+        return @all_boards.values[0]
+      else
+        raise "Must set board_id so we know which to use. Multiple boards found: #{@all_boards.keys.inspect}"
+      end
+    end
+
+    @all_boards[@board_id]
+  end
+
+  def completed_issues_in_range include_unstarted: false
+    issues.select do |issue|
+      cycletime = issue.board.cycletime
+      stopped_time = cycletime.stopped_time(issue)
+      started_time = cycletime.started_time(issue)
+
+      stopped_time &&
+        date_range.include?(stopped_time.to_date) && # Remove outside range
+        (include_unstarted || (started_time && (stopped_time >= started_time)))
+    end
+  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
+
+  def chart_format object
+    if object.is_a? Time
+      # "2022-04-09T11:38:30-07:00"
+      object.strftime '%Y-%m-%dT%H:%M:%S%z'
+    else
+      object.to_s
+    end
+  end
+
+  def header_text text
+    @header_text = text
+  end
+
+  def description_text text
+    @description_text = text
+  end
+
+  def format_integer number
+    number.to_s.reverse.scan(/.{1,3}/).join(',').reverse
+  end
+
+  def format_status name_or_id, board:, is_category: false
+    begin
+      statuses = board.possible_statuses.expand_statuses([name_or_id])
+    rescue RuntimeError => e
+      return "<span style='color: red'>#{name_or_id}</span>" if e.message =~ /^Status not found:/
+
+      throw e
+    end
+    raise "Expected exactly one match and got #{statuses.inspect} for #{name_or_id.inspect}" if statuses.size > 1
+
+    status = statuses.first
+    color = status_category_color status
+
+    text = is_category ? status.category_name : status.name
+    "<span style='color: #{color}'>#{text}</span>"
+  end
+
+  def status_category_color status
+    case status.category_name
+    when nil then 'black'
+    when 'To Do' then 'gray'
+    when 'In Progress' then 'blue'
+    when 'Done' then 'green'
+    end
+  end
+
+  def random_color
+    "\##{Random.bytes(3).unpack1('H*')}"
+  end
+
+  def canvas width:, height:, responsive: true
+    @canvas_width = width
+    @canvas_height = height
+    @canvas_responsive = responsive
+  end
+
+  def canvas_responsive?
+    @canvas_responsive
+  end
+
+  def filter_issues &block
+    @filter_issues_block = block
+  end
+
+  def issues= issues
+    @issues = issues
+    return unless @filter_issues_block
+
+    @issues = issues.collect { |i| @filter_issues_block.call(i) }.compact.uniq
+    puts @issues.collect(&:key).join(', ')
+  end
+end