jirametrics 2.4 → 2.30

data/lib/jirametrics/pull_request.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'jirametrics/pull_request_review'
+
+class PullRequest
+  attr_reader :raw
+
+  def initialize raw:
+    @raw = raw
+  end
+
+  def number     = @raw['number']
+  def repo       = @raw['repo']
+  def url        = @raw['url']
+  def title      = @raw['title']
+  def branch     = @raw['branch']
+  def state      = @raw['state']
+  def issue_keys = @raw['issue_keys']
+
+  def opened_at = Time.parse(@raw['opened_at'])
+  def closed_at = @raw['closed_at'] ? Time.parse(@raw['closed_at']) : nil
+  def merged_at = @raw['merged_at'] ? Time.parse(@raw['merged_at']) : nil
+
+  def reviews       = (@raw['reviews'] || []).map { |r| PullRequestReview.new(raw: r) }
+  def additions     = @raw['additions']
+  def deletions     = @raw['deletions']
+  def changed_files = @raw['changed_files']
+  def lines_changed = (additions || 0) + (deletions || 0)
+end

data/lib/jirametrics/pull_request_cycle_time_histogram.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'jirametrics/groupable_issue_chart'
+
+class PullRequestCycleTimeHistogram < TimeBasedHistogram
+  def initialize block
+    super()
+
+    @cycletime_unit = :days
+    @x_axis_title = 'Cycle time in days'
+
+    header_text 'PR Histogram'
+    description_text <<-HTML
+      <div class="p">
+        This cycletime Histogram shows how many pull requests completed in a certain timeframe. This can be
+        useful for determining how many different types of work are flowing through, based on the
+        lengths of time they take.
+      </div>
+    HTML
+
+    init_configuration_block(block) do
+      grouping_rules do |pull_request, rule|
+        rule.label = pull_request.repo
+      end
+    end
+  end
+
+  def cycletime_unit unit
+    unless %i[minutes hours days].include?(unit)
+      raise ArgumentError, "cycletime_unit must be :minutes, :hours, or :days, got #{unit.inspect}"
+    end
+
+    @cycletime_unit = unit
+    @x_axis_title = "Cycle time in #{unit}"
+  end
+
+  def all_items
+    result = []
+    issues.each do |issue|
+      next unless issue.github_prs
+
+      issue.github_prs.each do |pr|
+        next unless pr.closed_at
+
+        result << pr
+      end
+    end
+    result.uniq
+  end
+
+  def value_for_item item
+    divisor = { minutes: 60.0, hours: 3600.0, days: 86_400.0 }[@cycletime_unit]
+    ((item.closed_at - item.opened_at) / divisor).ceil
+  end
+
+  def label_cycletime value
+    case @cycletime_unit
+    when :minutes then label_minutes(value)
+    when :hours then label_hours(value)
+    when :days then label_days(value)
+    end
+  end
+
+  def title_for_item count:, value:
+    "#{count} PR#{'s' unless count == 1} closed in #{label_cycletime value}"
+  end
+
+  def sort_items items
+    items.sort_by(&:opened_at)
+  end
+
+  def label_for_item item, hint:
+    label = "#{item.number} #{item.title}"
+    label << hint if hint
+    label
+  end
+end

data/lib/jirametrics/pull_request_cycle_time_scatterplot.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'jirametrics/groupable_issue_chart'
+
+class PullRequestCycleTimeScatterplot < TimeBasedScatterplot
+  def initialize block
+    super()
+
+    @cycletime_unit = :days
+    @y_axis_title = 'Cycle time in days'
+
+    header_text 'Pull Request (PR) Scatterplot'
+    description_text <<-HTML
+      <div class="p">
+        This graph shows the cycle time for all closed pull requests (time from opened to closed).
+      </div>
+      #{describe_non_working_days}
+    HTML
+
+    init_configuration_block(block) do
+      grouping_rules do |pull_request, rule|
+        rule.label = pull_request.repo
+      end
+    end
+  end
+
+  def cycletime_unit unit
+    unless %i[minutes hours days].include?(unit)
+      raise ArgumentError, "cycletime_unit must be :minutes, :hours, or :days, got #{unit.inspect}"
+    end
+
+    @cycletime_unit = unit
+    @y_axis_title = "Cycle time in #{unit}"
+  end
+
+  def all_items
+    result = []
+    issues.each do |issue|
+      issue.github_prs&.each do |pr|
+        result << pr if pr.closed_at
+      end
+    end
+    result
+  end
+
+  def x_value pull_request
+    pull_request.closed_at
+  end
+
+  def y_value pull_request
+    if @cycletime_unit == :days
+      tz = timezone_offset || '+00:00'
+      opened = pull_request.opened_at.getlocal(tz).to_date
+      closed = pull_request.closed_at.getlocal(tz).to_date
+      (closed - opened).to_i + 1
+    else
+      divisor = { minutes: 60, hours: 3600 }[@cycletime_unit]
+      ((pull_request.closed_at - pull_request.opened_at) / divisor).round
+    end
+  end
+
+  def label_cycletime value
+    case @cycletime_unit
+    when :minutes then label_minutes(value)
+    when :hours then label_hours(value)
+    when :days then label_days(value)
+    end
+  end
+
+  def title_value pull_request, rules: nil
+    age_label = label_cycletime y_value(pull_request)
+    keys = pull_request.issue_keys.join(', ')
+    "#{keys} | #{pull_request.title} | #{rules.label} | Age:#{age_label}#{lines_changed_text(pull_request)}"
+  end
+
+  def lines_changed_text pull_request
+    return '' unless pull_request.changed_files
+
+    additions = pull_request.additions || 0
+    deletions = pull_request.deletions || 0
+    text = +' | Lines changed: ['
+    text << "+#{to_human_readable additions}" unless additions.zero?
+    text << ' ' if additions != 0 && deletions != 0
+    text << "-#{to_human_readable deletions}" unless deletions.zero?
+    text << "], Files changed: #{to_human_readable pull_request.changed_files}"
+    text
+  end
+end

data/lib/jirametrics/pull_request_review.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'time'
+
+class PullRequestReview
+  def initialize raw:
+    @raw = raw
+  end
+
+  def author = @raw['author']
+  def state = @raw['state']
+  def submitted_at = Time.parse(@raw['submitted_at'])
+end

data/lib/jirametrics/raw_javascript.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# When strings are serialized into JSON, they're converted to actual strings. The purpose
+# of this class is to allow raw javascript to be passed through.
+class RawJavascript
+  def initialize content
+    @content = content
+  end
+
+  def to_json(*_args)
+    @content
+  end
+
+  def == other
+    other.is_a?(RawJavascript) && to_json == other.to_json
+  end
+end

data/lib/jirametrics/rules.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 class Rules
-  def ignore
-    @ignore = true
+  def ignore value = true # rubocop:disable Style/OptionalBooleanParameter
+    @ignore = value
   end
 
   def ignored?

data/lib/jirametrics/self_or_issue_dispatcher.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module SelfOrIssueDispatcher
+  # rubocop:disable Style/ArgumentsForwarding
   def method_missing method_name, *args, &block
     raise "#{method_name} isn't a method on Issue or #{self.class}" unless ::Issue.method_defined? method_name.to_sym
 
@@ -8,6 +9,7 @@ module SelfOrIssueDispatcher
       issue.__send__ method_name, *args, &block
     end
   end
+  # rubocop:enable Style/ArgumentsForwarding
 
   def respond_to_missing?(method_name, include_all = false)
     ::Issue.method_defined?(method_name.to_sym) || super

data/lib/jirametrics/settings.json

@@ -2,6 +2,14 @@
   "stalled_threshold_days": 5,
   "stalled_statuses": [],
 
-  "blocked_link_text": [],
-  "blocked_statuses": []
+  "blocked_link_text": ["is blocked by"],
+  "blocked_statuses": [],
+  "flagged_means_blocked": true,
+
+  "expedited_priority_names": ["Critical", "Highest"],
+  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"],
+
+  "cache_cycletime_calculations": true,
+
+  "date_annotations": []
 }

data/lib/jirametrics/sprint.rb

@@ -12,6 +12,8 @@ class Sprint
 
   def id = @raw['id']
   def active? = (@raw['state'] == 'active')
+  def closed? = (@raw['state'] == 'closed')
+  def future? = (@raw['state'] == 'future')
 
   def completed_at? time
     completed_at = completed_time
@@ -35,6 +37,17 @@ class Sprint
   def goal = @raw['goal']
   def name = @raw['name']
 
+  def day_count
+    return '' if future?
+
+    if closed?
+      days = (completed_time.to_date - start_time.to_date).to_i + 1
+    else
+      days = (end_time.to_date - start_time.to_date).to_i + 1
+    end
+    "#{days} days"
+  end
+
   private
 
   def parse_time time_string

data/lib/jirametrics/sprint_burndown.rb

@@ -18,7 +18,7 @@ class SprintBurndown < ChartBase
   attr_accessor :board_id
 
   def initialize
-    super()
+    super
 
     @summary_stats = {}
     header_text 'Sprint burndown'
@@ -29,6 +29,8 @@ class SprintBurndown < ChartBase
       </div>
       #{describe_non_working_days}
     TEXT
+    @x_axis_title = 'Date'
+    @y_axis_title = 'Items remaining'
   end
 
   def options= arg
@@ -48,8 +50,9 @@ class SprintBurndown < ChartBase
   end
 
   def run
-    sprints = sprints_in_time_range all_boards[board_id]
-    return nil if sprints.empty?
+    return nil unless current_board.scrum?
+
+    sprints = sprints_in_time_range current_board
 
     change_data_by_sprint = {}
     sprints.each do |sprint|
@@ -63,7 +66,7 @@ class SprintBurndown < ChartBase
     result = +''
     result << render_top_text(binding)
 
-    possible_colours = (1..5).collect { |i| CssVariable["--sprint-burndown-sprint-color-#{i}"] }
+    possible_colours = (1..ChartBase::OKABE_ITO_PALETTE.size).collect { |i| CssVariable["--sprint-burndown-sprint-color-#{i}"] }
     charts_to_generate = []
     charts_to_generate << [:data_set_by_story_points, 'Story Points'] if @use_story_points
     charts_to_generate << [:data_set_by_story_counts, 'Story Count'] if @use_story_counts
@@ -110,6 +113,9 @@ class SprintBurndown < ChartBase
 
   def sprints_in_time_range board
     board.sprints.select do |sprint|
+      # If it's never been started then it's just a holding area. Ignore it.
+      next if sprint.future?
+
       sprint_end_time = sprint.completed_time || sprint.end_time
       sprint_start_time = sprint.start_time
       next false if sprint_start_time.nil?
@@ -121,12 +127,14 @@ class SprintBurndown < ChartBase
 
   # 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
+    estimate = 0.0
     ever_in_sprint = false
     currently_in_sprint = false
     change_data = []
 
-    issue_completed_time = issue.board.cycletime.stopped_time(issue)
+    estimate_display_name = current_board.estimation_configuration.display_name
+
+    issue_completed_time = issue.started_stopped_times.last
     completed_has_been_tracked = false
 
     issue.changes.each do |change|
@@ -140,26 +148,26 @@ class SprintBurndown < ChartBase
         if currently_in_sprint == false && in_change_item
           action = :enter_sprint
           ever_in_sprint = true
-          value = story_points
+          value = estimate
         elsif currently_in_sprint && in_change_item == false
           action = :leave_sprint
-          value = -story_points
+          value = -estimate
         end
         currently_in_sprint = in_change_item
-      elsif change.story_points? && (issue_completed_time.nil? || change.time < issue_completed_time)
+      elsif change.field == estimate_display_name && (issue_completed_time.nil? || change.time < issue_completed_time)
         action = :story_points
-        story_points = change.value.to_f
-        value = story_points - change.old_value.to_f
+        estimate = change.value.to_f
+        value = estimate - change.old_value.to_f
       elsif completed_has_been_tracked == false && change.time == issue_completed_time
         completed_has_been_tracked = true
         action = :issue_stopped
-        value = -story_points
+        value = -estimate
       end
 
       next unless action
 
       change_data << SprintIssueChangeData.new(
-        time: change.time, issue: issue, action: action, value: value, story_points: story_points
+        time: change.time, issue: issue, action: action, value: value, estimate: estimate
       )
     end
 
@@ -172,11 +180,11 @@ class SprintBurndown < ChartBase
     change_item.raw['to'].split(/\s*,\s*/).any? { |id| id.to_i == sprint.id }
   end
 
-  def data_set_by_story_points sprint:, change_data_for_sprint:
+  def data_set_by_story_points sprint:, change_data_for_sprint: # rubocop:disable Metrics/CyclomaticComplexity
     summary_stats = SprintSummaryStats.new
     summary_stats.completed = 0.0
 
-    story_points = 0.0
+    estimate = 0.0
     start_data_written = false
     data_set = []
 
@@ -185,11 +193,11 @@ class SprintBurndown < ChartBase
     change_data_for_sprint.each do |change_data|
       if start_data_written == false && change_data.time >= sprint.start_time
         data_set << {
-          y: story_points,
+          y: estimate,
           x: chart_format(sprint.start_time),
-          title: "Sprint started with #{story_points} points"
+          title: "Sprint started with #{estimate} points"
         }
-        summary_stats.started = story_points
+        summary_stats.started = estimate
         start_data_written = true
       end
 
@@ -198,12 +206,12 @@ class SprintBurndown < ChartBase
       case change_data.action
       when :enter_sprint
         issues_currently_in_sprint << change_data.issue.key
-        story_points += change_data.story_points
+        estimate += change_data.estimate
       when :leave_sprint
         issues_currently_in_sprint.delete change_data.issue.key
-        story_points -= change_data.story_points
+        estimate -= change_data.estimate
       when :story_points
-        story_points += change_data.value if issues_currently_in_sprint.include? change_data.issue.key
+        estimate += change_data.value if issues_currently_in_sprint.include? change_data.issue.key
       end
 
       next unless change_data.time >= sprint.start_time
@@ -213,26 +221,26 @@ class SprintBurndown < ChartBase
       when :story_points
         next unless issues_currently_in_sprint.include? change_data.issue.key
 
-        old_story_points = change_data.story_points - change_data.value
-        message = "Story points changed from #{old_story_points} points to #{change_data.story_points} points"
+        old_estimate = change_data.estimate - change_data.value
+        message = "Story points changed from #{old_estimate} points to #{change_data.estimate} points"
         summary_stats.points_values_changed = true
       when :enter_sprint
-        message = "Added to sprint with #{change_data.story_points || 'no'} points"
-        summary_stats.added += change_data.story_points
+        message = "Added to sprint with #{change_data.estimate || 'no'} points"
+        summary_stats.added += change_data.estimate
       when :issue_stopped
-        story_points -= change_data.story_points
-        message = "Completed with #{change_data.story_points || 'no'} points"
+        estimate -= change_data.estimate
+        message = "Completed with #{change_data.estimate || 'no'} points"
         issues_currently_in_sprint.delete change_data.issue.key
-        summary_stats.completed += change_data.story_points
+        summary_stats.completed += change_data.estimate
       when :leave_sprint
-        message = "Removed from sprint with #{change_data.story_points || 'no'} points"
-        summary_stats.removed += change_data.story_points
+        message = "Removed from sprint with #{change_data.estimate || 'no'} points"
+        summary_stats.removed += change_data.estimate
       else
         raise "Unexpected action: #{change_data.action}"
       end
 
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(change_data.time),
         title: "#{change_data.issue.key} #{message}"
       }
@@ -241,27 +249,27 @@ class SprintBurndown < ChartBase
     unless start_data_written
       # There was nothing that triggered us to write the sprint started block so do it now.
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(sprint.start_time),
-        title: "Sprint started with #{story_points} points"
+        title: "Sprint started with #{estimate} points"
       }
-      summary_stats.started = story_points
+      summary_stats.started = estimate
     end
 
     if sprint.completed_time
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(sprint.completed_time),
-        title: "Sprint ended with #{story_points} points unfinished"
+        title: "Sprint ended with #{estimate} points unfinished"
       }
-      summary_stats.remaining = story_points
+      summary_stats.remaining = estimate
     end
 
     unless sprint.completed_at?(time_range.end)
       data_set << {
-        y: story_points,
+        y: estimate,
         x: chart_format(time_range.end),
-        title: "Sprint still active. #{story_points} points still in progress."
+        title: "Sprint still active. #{estimate} points still in progress."
       }
     end
 

data/lib/jirametrics/sprint_issue_change_data.rb

@@ -4,14 +4,14 @@ require 'jirametrics/value_equality'
 
 class SprintIssueChangeData
   include ValueEquality
-  attr_reader :time, :action, :value, :issue, :story_points
+  attr_reader :time, :action, :value, :issue, :estimate
 
-  def initialize time:, action:, value:, issue:, story_points:
+  def initialize time:, action:, value:, issue:, estimate:
     @time = time
     @action = action
     @value = value
     @issue = issue
-    @story_points = story_points
+    @estimate = estimate
   end
 
   def inspect

data/lib/jirametrics/status.rb

@@ -3,30 +3,65 @@
 require 'jirametrics/value_equality'
 
 class Status
-  include ValueEquality
-  attr_reader :id, :category_name, :category_id, :project_id
+  attr_reader :id, :project_id, :category
   attr_accessor :name
 
-  def initialize name: nil, id: nil, category_name: nil, category_id: nil, project_id: nil, raw: nil
-    @name = name
-    @id = id
-    @category_name = category_name
-    @category_id = category_id
-    @project_id = project_id
+  class Category
+    attr_reader :id, :name, :key
+
+    def initialize id:, name:, key:
+      @id = id
+      @name = name
+      @key = key
+    end
 
-    return unless raw
+    def to_s
+      "#{name.inspect}:#{id.inspect}"
+    end
 
-    @raw = raw
-    @name = raw['name']
-    @id = raw['id'].to_i
+    def <=> other
+      id <=> other.id
+    end
+
+    def == other
+      id == other.id
+    end
+
+    def eql?(other) = id.eql?(other.id)
+    def hash = id.hash
+
+    def new? = (@key == 'new')
+    def indeterminate? = (@key == 'indeterminate')
+    def done? = (@key == 'done')
+  end
+
+  def self.from_raw raw
+    raise 'raw cannot be nil' if raw.nil?
 
     category_config = raw['statusCategory']
-    @category_name = category_config['name']
-    @category_id = category_config['id'].to_i
+    raise "statusCategory can't be nil in #{category_config.inspect}" if category_config.nil?
+
+    Status.new(
+      name: raw['name'],
+      id: raw['id'].to_i,
+      category_name: category_config['name'],
+      category_id: category_config['id'].to_i,
+      category_key: category_config['key'],
+      project_id: raw['scope']&.[]('project')&.[]('id'),
+      artificial: false
+    )
+  end
+
+  def initialize name:, id:, category_name:, category_id:, category_key:, project_id: nil, artificial: true
+    # These checks are needed because nils used to be possible and now they aren't.
+    raise 'id cannot be nil' if id.nil?
+    raise 'category_id cannot be nil' if category_id.nil?
 
-    # If this is a NextGen project then this status may be project specific. When this field is
-    # nil then the status is global.
-    @project_id = raw['scope']&.[]('project')&.[]('id')
+    @name = name
+    @id = id
+    @category = Category.new id: category_id, name: category_name, key: category_key
+    @project_id = project_id
+    @artificial = artificial
   end
 
   def project_scoped?
@@ -38,8 +73,38 @@ class Status
   end
 
   def to_s
-    "Status(name=#{@name.inspect}, id=#{@id.inspect}," \
-      " category_name=#{@category_name.inspect}, category_id=#{@category_id.inspect}, project_id=#{@project_id})"
+    "#{name.inspect}:#{id.inspect}"
+  end
+
+  def artificial?
+    @artificial
+  end
+
+  def == other
+    return false unless other.is_a? Status
+
+    @id == other.id && @name == other.name && @category.id == other.category.id && @category.name == other.category.name
+  end
+
+  def eql?(other)
+    self == other
+  end
+
+  def <=> other
+    result = @name.casecmp(other.name)
+    result = @id <=> other.id if result.zero?
+    result
+  end
+
+  def inspect
+    result = []
+    result << "Status(name: #{@name.inspect}"
+    result << "id: #{@id.inspect}"
+    result << "project_id: #{@project_id}" if @project_id
+    category = self.category
+    result << "category: {name:#{category.name.inspect}, id: #{category.id.inspect}, key: #{category.key.inspect}}"
+    result << 'artificial' if artificial?
+    result.join(', ') << ')'
   end
 
   def value_equality_ignored_variables