jirametrics 2.4 → 2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 142ac2bba90f603ef9b6d2243b688e91259c5b0437cd7e4458f1a9fd9a4bcc69
-  data.tar.gz: b9111ee6827f383b5db257da17ec284a333d98183f4a47f1b8c86b388e7b37f3
+  metadata.gz: 22daa10ce05dd421522069d3b5d73868f8f7bc1a6a53128acab515ca98644892
+  data.tar.gz: 8d797de1b80fe8f35fde593bc578012af92080e32000a905ea90ed286754bccd
 SHA512:
-  metadata.gz: ead0cc6937f2b0ce3e060dee4771bb8e585bb26962113c7589fb13222966e13ae76de18e68e148e17ebccfe8c9e2c9f51f9b5b1adb3ef2b4f94fac0a0e848613
-  data.tar.gz: 55add3d6887f9e16800f5ce665c3ada6bb9b3c2a980241ab2adbf0afb517ff5d2da3b4875f1c4caf161e5e493ece57e40687d672be012c06945588da8fc2f22e
+  metadata.gz: b00a94c9c676625ff698ecf61211dea8b8bbc6d3fde400e23f349a888147b0245616f8944646eac4435106d1156dca08327fe596dcc0402e92169c67cc72cdb1
+  data.tar.gz: c85706281f71b2b0adf5dae8f99bcab478dadeb86b014ce88874879051ac0e4288d3d7cda1e0fd949e03b70878969f918248649423704ae5d757f63c83b12733

data/lib/jirametrics/board.rb

@@ -2,14 +2,13 @@
 
 class Board
   attr_reader :visible_columns, :raw, :possible_statuses, :sprints, :backlog_statuses
-  attr_accessor :cycletime, :project_config, :expedited_priority_names
+  attr_accessor :cycletime, :project_config
 
   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']
 

data/lib/jirametrics/board_config.rb

@@ -11,7 +11,6 @@ class BoardConfig
 
   def run
     @board = @project_config.all_boards[id]
-    @board.expedited_priority_names = []
 
     instance_eval(&@block)
   end
@@ -26,6 +25,7 @@ class BoardConfig
   end
 
   def expedited_priority_names *priority_names
-    @board.expedited_priority_names = priority_names
+    deprecated date: '2024-09-15', message: 'Expedited priority names are now specified in settings'
+    @project_config.settings['expedited_priority_names'] = priority_names
   end
 end

data/lib/jirametrics/dependency_chart.rb

@@ -42,17 +42,13 @@ class DependencyChart < ChartBase
     HTML
 
     @rules_block = rules_block
-    @link_rules_block = ->(link_name, link_rules) {}
 
-    issue_rules do |issue, rules|
-      key = issue.key
-      key = "<S>#{key} </S> " if issue.status.category_name == 'Done'
-      rules.label = "<#{key} [#{issue.type}]<BR/>#{word_wrap issue.summary}>"
-    end
+    issue_rules(&default_issue_rules)
+    link_rules(&default_link_rules)
   end
 
   def run
-    instance_eval(&@rules_block)
+    instance_eval(&@rules_block) if @rules_block
 
     dot_graph = build_dot_graph
     return "<h1>#{@header_text}</h1>No data matched the selected criteria. Nothing to show." if dot_graph.nil?
@@ -219,4 +215,36 @@ class DependencyChart < ChartBase
       end
     end.join(separator)
   end
+
+  def default_issue_rules
+    chart = self
+    lambda do |issue, rules|
+      is_done = issue.done?
+
+      key = issue.key
+      key = "<S>#{key} </S> " if is_done
+      line2 = +'<BR/>'
+      if issue.artificial?
+        line2 << '(unknown state)' # Shouldn't happen if we've done a full download but is still possible.
+      elsif is_done
+        line2 << 'Done'
+      else
+        started_at = issue.board.cycletime.started_time(issue)
+        if started_at.nil?
+          line2 << 'Not started'
+        else
+          line2 << "Age: #{issue.board.cycletime.age(issue, today: chart.date_range.end)} days"
+        end
+      end
+      rules.label = "<#{key} [#{issue.type}]#{line2}<BR/>#{word_wrap issue.summary}>"
+    end
+  end
+
+  def default_link_rules
+    lambda do |link, rules|
+      rules.ignore if link.origin.done? && link.other_issue.done?
+      rules.ignore if link.name == 'Cloners'
+      rules.merge_bidirectional keep: 'outward'
+    end
+  end
 end

data/lib/jirametrics/download_config.rb

@@ -19,4 +19,16 @@ class DownloadConfig
     @rolling_date_count = count unless count.nil?
     @rolling_date_count
   end
+
+  def no_earlier_than date = nil
+    @no_earlier_than = Date.parse(date) unless date.nil?
+    @no_earlier_than
+  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
 end

data/lib/jirametrics/downloader.rb

@@ -199,7 +199,11 @@ class Downloader
       )
       is_last = json['isLast']
       max_results = json['maxResults']
-      start_at += json['values'].size
+      if json['values']
+        start_at += json['values'].size
+      else
+        log "  No sprints found for board #{board_id}"
+      end
     end
   end
 
@@ -271,8 +275,10 @@ class Downloader
     segments = []
     segments << "filter=#{filter_id}"
 
-    unless @download_config.rolling_date_count.nil?
-      @download_date_range = (today.to_date - @download_config.rolling_date_count)..today.to_date
+    start_date = @download_config.start_date today: today
+
+    if start_date
+      @download_date_range = start_date..today.to_date
 
       # For an incremental download, we want to query from the end of the previous one, not from the
       # beginning of the full range.

data/lib/jirametrics/examples/aggregated_project.rb

@@ -64,25 +64,14 @@ class Exporter
 
             # By default, the issue doesn't show what board it's on and this is important for an
             # aggregated view
+            chart = self
             issue_rules do |issue, rules|
-              key = issue.key
-              key = "<S>#{key} </S> " if issue.status.category_name == 'Done'
-              rules.label = "<#{key} [#{issue.type}]<BR/>#{issue.board.name}<BR/>#{word_wrap issue.summary}>"
+              chart.default_issue_rules.call(issue, rules)
+              rules.label = rules.label.split('<BR/>').insert(1, "Board: #{issue.board.name}").join('<BR/>')
             end
 
             link_rules do |link, rules|
-              # By default, the dependency chart shows everything. Clean it up a bit.
-              case link.name
-              when 'Cloners'
-                # We don't want to see any clone links at all.
-                rules.ignore
-              when 'Blocks'
-                # For blocks, by default Jira will have links going both
-                # ways and we want them only going one way. Also make the
-                # link red.
-                rules.merge_bidirectional keep: 'outward'
-                rules.line_color = 'red'
-              end
+              chart.default_link_rules.call(link, rules)
 
               # Because this is the aggregated view, let's hide any link that doesn't cross boards.
               rules.ignore if link.origin.board == link.other_issue.board

data/lib/jirametrics/examples/standard_project.rb

@@ -6,13 +6,13 @@
 # See https://github.com/mikebowler/jirametrics/wiki/Examples-folder for more
 class Exporter
   def standard_project name:, file_prefix:, ignore_issues: nil, starting_status: nil, boards: {},
-      default_board: nil, anonymize: false, settings: {}, status_category_mappings: {}
+      default_board: nil, anonymize: false, settings: {}, status_category_mappings: {},
+      rolling_date_count: 90, no_earlier_than: nil
 
     project name: name do
       puts name
       self.anonymize if anonymize
 
-      settings['blocked_link_text'] = ['is blocked by']
       self.settings.merge! settings
 
       status_category_mappings.each do |status, category|
@@ -21,7 +21,8 @@ class Exporter
 
       file_prefix file_prefix
       download do
-        rolling_date_count 90
+        self.rolling_date_count(rolling_date_count) if rolling_date_count
+        self.no_earlier_than(no_earlier_than) if no_earlier_than
       end
 
       boards.each_key do |board_id|
@@ -34,7 +35,6 @@ class Exporter
         end
         board id: board_id do
           cycletime(&block)
-          expedited_priority_names 'Critical', 'Highest', 'Immediate Gating'
         end
       end
 
@@ -87,24 +87,7 @@ class Exporter
           expedited_chart
           sprint_burndown
           estimate_accuracy_chart
-
-          dependency_chart do
-            link_rules do |link, rules|
-              case link.name
-              when 'Cloners'
-                rules.ignore
-              when 'Dependency', 'Blocks', 'Parent/Child', 'Cause', 'Satisfy Requirement', 'Relates'
-                rules.merge_bidirectional keep: 'outward'
-                rules.merge_bidirectional keep: 'outward'
-              when 'Sync'
-                rules.use_bidirectional_arrows
-              else
-                # This is a link type that we don't recognize. Dump it to standard out to draw attention
-                # to it.
-                puts "name=#{link.name}, label=#{link.label}"
-              end
-            end
-          end
+          dependency_chart
         end
       end
     end

data/lib/jirametrics/expedited_chart.rb

@@ -57,7 +57,7 @@ class ExpeditedChart < ChartBase
   def prepare_expedite_data issue
     expedite_start = nil
     result = []
-    expedited_priority_names = issue.board.expedited_priority_names
+    expedited_priority_names = issue.board.project_config.settings['expedited_priority_names']
 
     issue.changes.each do |change|
       next unless change.priority?

data/lib/jirametrics/exporter.rb

@@ -7,7 +7,9 @@ class Object
     text = +''
     text << "Deprecated(#{date}): "
     text << message
-    text << "\n-> Called from #{caller(1..1).first}"
+    caller(1..2).each do |line|
+      text << "\n-> Called from #{line}"
+    end
     warn text
   end
 end

data/lib/jirametrics/issue.rb

@@ -371,7 +371,9 @@ class Issue
   end
 
   def expedited?
-    names = @board&.expedited_priority_names
+    return false unless @board&.project_config
+
+    names = @board.project_config.settings['expedited_priority_names']
     return false unless names
 
     current_priority = raw['fields']['priority']&.[]('name')
@@ -380,7 +382,9 @@ class Issue
 
   def expedited_on_date? date
     expedited_start = nil
-    expedited_names = @board&.expedited_priority_names
+    return false unless @board&.project_config
+
+    expedited_names = @board.project_config.settings['expedited_priority_names']
 
     changes.each do |change|
       next unless change.priority?
@@ -433,6 +437,10 @@ class Issue
     @fix_versions
   end
 
+  def looks_like_issue_key? key
+    !!(key.is_a?(String) && key =~ /^[^-]+-\d+$/)
+  end
+
   def parent_key project_config: @board.project_config
     # Although Atlassian is trying to standardize on one way to determine the parent, today it's a mess.
     # We try a variety of ways to get the parent and hopefully one of them will work. See this link:
@@ -454,8 +462,13 @@ class Issue
 
       custom_field_names&.each do |field_name|
         parent = fields[field_name]
-        # A break would be more appropriate than a return but the runtime caused an error when we do that
-        return parent if parent
+        next if parent.nil?
+        break if looks_like_issue_key? parent
+
+        project_config.file_system.log(
+          "Custom field #{field_name.inspect} should point to a parent id but found #{parent.inspect}"
+        )
+        parent = nil
       end
     end
 
@@ -505,6 +518,17 @@ class Issue
     result
   end
 
+  def done?
+    if artificial? || board.cycletime.nil?
+      # This was probably loaded as a linked issue, which means we don't know what board it really
+      # belonged to. The best we can do is look at the status category. This case should be rare but
+      # it can happen.
+      status.category_name == 'Done'
+    else
+      board.cycletime.done? self
+    end
+  end
+
   private
 
   def assemble_author raw

data/lib/jirametrics/project_config.rb

@@ -180,7 +180,7 @@ class ProjectConfig
 
       board_id = $1.to_i
       timezone_offset = exporter.timezone_offset
-      JSON.parse(file_system.load("#{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

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/settings.json

@@ -2,6 +2,8 @@
   "stalled_threshold_days": 5,
   "stalled_statuses": [],
 
-  "blocked_link_text": [],
-  "blocked_statuses": []
+  "blocked_link_text": ["is blocked by"],
+  "blocked_statuses": [],
+
+  "expedited_priority_names": ["Critical", "Highest"]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.4'
+  version: '2.5'
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-17 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Extract Jira metrics