jirametrics 2.11 → 2.14

data/lib/jirametrics/project_config.rb

@@ -6,7 +6,7 @@ require 'jirametrics/status_collection'
 class ProjectConfig
   attr_reader :target_path, :jira_config, :all_boards, :possible_statuses,
     :download_config, :file_configs, :exporter, :data_version, :name, :board_configs,
-    :settings, :aggregate_config, :discarded_changes_data
+    :settings, :aggregate_config, :discarded_changes_data, :users
   attr_accessor :time_range, :jira_url, :id
 
   def initialize exporter:, jira_config:, block:, target_path: '.', name: '', id: nil
@@ -40,6 +40,7 @@ class ProjectConfig
     @id = guess_project_id
     load_project_metadata
     load_sprints
+    load_users
   end
 
   def run load_only: false
@@ -113,10 +114,14 @@ class ProjectConfig
   def file_prefix prefix
     # The file_prefix has to be set before almost everything else. It really should have been an attribute
     # on the project declaration itself. Hindsight is 20/20.
+
+    # There can only be one of these
     if @file_prefix
-      raise "file_prefix should only be set once. Was #{@file_prefix.inspect} and now changed to #{prefix.inspect}."
+      raise "file_prefix can only be set once. Was #{@file_prefix.inspect} and now changed to #{prefix.inspect}."
     end
 
+    raise_if_prefix_already_used(prefix)
+
     @file_prefix = prefix
 
     # Yes, this is a wierd place to be initializing this. Unfortunately, it has to happen after the file_prefix
@@ -129,8 +134,21 @@ class ProjectConfig
     @file_prefix
   end
 
-  def get_file_prefix # rubocop:disable Naming/AccessorMethodName
-    raise 'file_prefix has not been set yet. Move it to the top of the project declaration.' unless @file_prefix
+  def raise_if_prefix_already_used prefix
+    @exporter.project_configs.each do |project|
+      next unless project.get_file_prefix(raise_if_not_set: false) == prefix && project.target_path == target_path
+
+      raise "Project #{name.inspect} specifies file prefix #{prefix.inspect}, " \
+        "but that is already used by project #{project.name.inspect} in the same target path #{target_path.inspect}. " \
+        'This is almost guaranteed to be too much copy and paste in your configuration. ' \
+        'File prefixes must be unique within a directory.'
+    end
+  end
+
+  def get_file_prefix raise_if_not_set: true
+    if @file_prefix.nil? && raise_if_not_set
+      raise 'file_prefix has not been set yet. Move it to the top of the project declaration.'
+    end
 
     @file_prefix
   end
@@ -151,6 +169,8 @@ class ProjectConfig
   end
 
   def status_category_mapping status:, category:
+    return if @exporter.downloading?
+
     status, status_id = possible_statuses.parse_name_id status
     category, category_id = possible_statuses.parse_name_id category
 
@@ -323,6 +343,15 @@ class ProjectConfig
     raise
   end
 
+  def load_users
+    @users = []
+    filename = File.join @target_path, "#{get_file_prefix}_users.json"
+    return unless File.exist? filename
+
+    json = file_system.load_json(filename)
+    json.each { |user_data| @users << User.new(raw: user_data) }
+  end
+
   def to_time string, end_of_day: false
     time = end_of_day ? '23:59:59' : '00:00:00'
     string = "#{string}T#{time}#{exporter.timezone_offset}" if string.match?(/^\d{4}-\d{2}-\d{2}$/)
@@ -356,7 +385,7 @@ class ProjectConfig
 
   # To be used by the aggregate_config only. Not intended to be part of the public API
   def add_issues issues_list
-    @issues = [] if @issues.nil?
+    @issues = IssueCollection.new if @issues.nil?
     @all_boards = {}
 
     issues_list.each do |issue|
@@ -373,7 +402,7 @@ class ProjectConfig
           'declaration but none are here. Check your config.'
       end
 
-      return @issues = [] if @exporter.downloading?
+      return @issues = IssueCollection.new if @exporter.downloading?
       raise 'No data found. Must do a download before an export' unless data_downloaded?
 
       load_data if all_boards.empty?
@@ -385,7 +414,7 @@ class ProjectConfig
         issues = load_issues_from_issues_directory path: issues_path, timezone_offset: timezone_offset
       else
         file_system.log "Can't find directory #{issues_path}. Has a download been done?", also_write_to_stderr: true
-        return []
+        return IssueCollection.new
       end
 
       # Attach related issues
@@ -397,7 +426,8 @@ class ProjectConfig
 
       # We'll have some issues that are in the list that weren't part of the initial query. Once we've
       # attached them in the appropriate places, remove any that aren't part of that initial set.
-      @issues = issues.select { |i| i.in_initial_query? }
+      issues.reject! { |i| !i.in_initial_query? } # rubocop:disable Style/InverseMethods
+      @issues = issues
     end
 
     @issues
@@ -438,7 +468,7 @@ class ProjectConfig
   end
 
   def load_issues_from_issues_directory path:, timezone_offset:
-    issues = []
+    issues = IssueCollection.new
     default_board = nil
 
     group_filenames_and_board_ids(path: path).each do |filename, board_ids|
@@ -450,6 +480,10 @@ class ProjectConfig
       end
 
       boards.each do |board|
+        if board.cycletime.nil?
+          raise "The board declaration for board #{board.id} must come before the " \
+            "first usage of 'issues' in the configuration"
+        end
         issues << Issue.new(raw: content, timezone_offset: timezone_offset, board: board)
       end
     end
@@ -462,7 +496,7 @@ class ProjectConfig
   # board ids appropriately.
   def group_filenames_and_board_ids path:
     hash = {}
-    Dir.foreach(path) do |filename|
+    file_system.foreach(path) do |filename|
       # Matches either FAKE-123.json or FAKE-123-456.json
       if /^(?<key>[^-]+-\d+)(?<_>-(?<board_id>\d+))?\.json$/ =~ filename
         (hash[key] ||= []) << [filename, board_id&.to_i || :unknown]

data/lib/jirametrics/settings.json

@@ -6,5 +6,6 @@
   "blocked_statuses": [],
   "flagged_means_blocked": true,
 
-  "expedited_priority_names": ["Critical", "Highest"]
+  "expedited_priority_names": ["Critical", "Highest"],
+  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"]
 }

data/lib/jirametrics/sprint.rb

@@ -12,6 +12,7 @@ class Sprint
 
   def id = @raw['id']
   def active? = (@raw['state'] == 'active')
+  def closed? = (@raw['state'] == 'closed')
 
   def completed_at? time
     completed_at = completed_time

data/lib/jirametrics/sprint_burndown.rb

@@ -121,11 +121,13 @@ 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 = []
 
+    estimate_display_name = current_board.estimation_configuration.display_name
+
     issue_completed_time = issue.board.cycletime.started_stopped_times(issue).last
     completed_has_been_tracked = false
 
@@ -140,26 +142,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
 
@@ -176,7 +178,7 @@ class SprintBurndown < ChartBase
     summary_stats = SprintSummaryStats.new
     summary_stats.completed = 0.0
 
-    story_points = 0.0
+    estimate = 0.0
     start_data_written = false
     data_set = []
 
@@ -185,11 +187,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 +200,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 +215,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 +243,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_collection.rb

@@ -16,6 +16,13 @@ class StatusCollection
     @list.find { |status| status.id == id }
   end
 
+  def find_by_id! id
+    status = @list.find { |status| status.id == id }
+    raise "Can't find any status for id #{id} in #{self}" unless status
+
+    status
+  end
+
   def find_all_by_name identifier
     name, id = parse_name_id identifier
 

data/lib/jirametrics/user.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class User
+  def initialize raw:
+    @raw = raw
+  end
+
+  def account_id = @raw['accountId']
+  def avatar_url = @raw['avatarUrls']['16x16']
+  def active? = @raw['active']
+  def display_name = @raw['displayName']
+end

data/lib/jirametrics.rb

@@ -69,6 +69,7 @@ class JiraMetrics < Thor
     require 'jirametrics/daily_wip_chart'
     require 'jirametrics/groupable_issue_chart'
     require 'jirametrics/css_variable'
+    require 'jirametrics/issue_collection'
 
     require 'jirametrics/aggregate_config'
     require 'jirametrics/expedited_chart'
@@ -112,7 +113,11 @@ class JiraMetrics < Thor
     require 'jirametrics/download_config'
     require 'jirametrics/columns_config'
     require 'jirametrics/hierarchy_table'
+    require 'jirametrics/estimation_configuration'
     require 'jirametrics/board'
+    require 'jirametrics/daily_view'
+    require 'jirametrics/user'
+    require 'jirametrics/atlassian_document_format'
     load config_file
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.11'
+  version: '2.14'
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-03-11 00:00:00.000000000 Z
+date: 2025-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -65,6 +65,7 @@ files:
 - lib/jirametrics/aging_work_in_progress_chart.rb
 - lib/jirametrics/aging_work_table.rb
 - lib/jirametrics/anonymizer.rb
+- lib/jirametrics/atlassian_document_format.rb
 - lib/jirametrics/blocked_stalled_change.rb
 - lib/jirametrics/board.rb
 - lib/jirametrics/board_column.rb
@@ -77,6 +78,7 @@ files:
 - lib/jirametrics/cycletime_config.rb
 - lib/jirametrics/cycletime_histogram.rb
 - lib/jirametrics/cycletime_scatterplot.rb
+- lib/jirametrics/daily_view.rb
 - lib/jirametrics/daily_wip_by_age_chart.rb
 - lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb
 - lib/jirametrics/daily_wip_by_parent_chart.rb
@@ -86,6 +88,7 @@ files:
 - lib/jirametrics/download_config.rb
 - lib/jirametrics/downloader.rb
 - lib/jirametrics/estimate_accuracy_chart.rb
+- lib/jirametrics/estimation_configuration.rb
 - lib/jirametrics/examples/aggregated_project.rb
 - lib/jirametrics/examples/standard_project.rb
 - lib/jirametrics/expedited_chart.rb
@@ -114,6 +117,7 @@ files:
 - lib/jirametrics/html/throughput_chart.erb
 - lib/jirametrics/html_report_config.rb
 - lib/jirametrics/issue.rb
+- lib/jirametrics/issue_collection.rb
 - lib/jirametrics/issue_link.rb
 - lib/jirametrics/jira_gateway.rb
 - lib/jirametrics/project_config.rb
@@ -128,6 +132,7 @@ files:
 - lib/jirametrics/throughput_chart.rb
 - lib/jirametrics/tree_organizer.rb
 - lib/jirametrics/trend_line_calculator.rb
+- lib/jirametrics/user.rb
 - lib/jirametrics/value_equality.rb
 homepage: https://jirametrics.org
 licenses: