jirametrics 2.7 → 2.8

data/lib/jirametrics/sprint_burndown.rb

@@ -172,7 +172,7 @@ 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
 

data/lib/jirametrics/status.rb

@@ -4,29 +4,57 @@ 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 new? = (@key == 'new')
+    def indeterminate? = (@key == 'indeterminate')
+    def done? = (@key == 'done')
+  end
 
+  def self.from_raw raw
     category_config = raw['statusCategory']
-    @category_name = category_config['name']
-    @category_id = category_config['id'].to_i
 
-    # 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')
+    legal_keys = %w[new indeterminate done]
+    unless legal_keys.include? category_config['key']
+      puts "Category key #{category_config['key'].inspect} should be one of #{legal_keys.inspect}. Found:\n" \
+        "#{category_config}"
+    end
+
+    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?
+
+    @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,18 +66,26 @@ class Status
   end
 
   def to_s
-    result = "Status(name=#{@name.inspect}," \
-      " id=#{@id.inspect}," \
-      " category_name=#{@category_name.inspect}," \
-      " category_id=#{@category_id.inspect}," \
-      " project_id=#{@project_id}"
-    result << ' artificial' if artificial?
-    result << ')'
-    result
+    "#{name.inspect}:#{id.inspect}"
   end
 
   def artificial?
-    @raw.nil?
+    @artificial
+  end
+
+  def == other
+    @id == other.id && @name == other.name && @category.id == other.category.id && @category.name == other.category.name
+  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

data/lib/jirametrics/status_collection.rb

@@ -13,7 +13,7 @@ class StatusCollection
     excluding = expand_statuses excluding
 
     @list.filter_map do |status|
-      keep = status.category_name == category_name ||
+      keep = status.category.name == category_name ||
         including.any? { |s| s.name == status.name }
       keep = false if excluding.any? { |s| s.name == status.name }
 
@@ -56,12 +56,45 @@ class StatusCollection
     filter_status_names category_name: 'Done', including: including, excluding: excluding
   end
 
-  def find_by_name name
-    find { |status| status.name == name }
+  # Return the status matching this id or nil if it can't be found.
+  def find_by_id id
+    @list.find { |status| status.id == id }
+  end
+
+  def find_all_by_name name
+    @list.select { |status| status.name == name }
+  end
+
+  def find_category_by_name name
+    category = @list.find { |status| status.category.name == name }&.category
+    unless category
+      set = Set.new
+      @list.each do |status|
+        set << status.category.to_s
+      end
+      raise "Unable to find status category #{name.inspect} in [#{set.to_a.sort.join(', ')}]"
+    end
+    category
+  end
+
+  # This is used to create a status that was found in the history but has since been deleted.
+  def fabricate_status_for id:, name:
+    first_in_progress_status = @list.find { |s| s.category.indeterminate? }
+    raise "Can't find even one in-progress status in [#{set.to_a.sort.join(', ')}]" unless first_in_progress_status
+
+    status = Status.new(
+      name: name,
+      id: id,
+      category_name: first_in_progress_status.category.name,
+      category_id: first_in_progress_status.category.id,
+      category_key: first_in_progress_status.category.key
+    )
+    self << status
+    status
   end
 
-  def find(&block)= @list.find(&block)
   def collect(&block) = @list.collect(&block)
+  def find(&block) = @list.find(&block)
   def each(&block) = @list.each(&block)
   def select(&block) = @list.select(&block)
   def <<(arg) = @list << arg
@@ -70,6 +103,6 @@ class StatusCollection
   def delete(object) = @list.delete(object)
 
   def inspect
-    "StatusCollection(#{@list.collect(&:inspect).join(', ')})"
+    "StatusCollection(#{@list.join(', ')})"
   end
 end

data/lib/jirametrics/throughput_chart.rb

@@ -82,7 +82,7 @@ class ThroughputChart < ChartBase
   def throughput_dataset periods:, completed_issues:
     periods.collect do |period|
       closed_issues = completed_issues.filter_map do |issue|
-        stop_date = issue.board.cycletime.started_stopped_times(issue).last&.to_date
+        stop_date = issue.board.cycletime.started_stopped_dates(issue).last
         [stop_date, issue] if stop_date && period.include?(stop_date)
       end
 

data/lib/jirametrics.rb

@@ -7,6 +7,13 @@ class JiraMetrics < Thor
     true
   end
 
+  map %w[--version -v] => :__print_version
+
+  desc '--version, -v', 'print the version'
+  def __print_version
+    puts Gem.loaded_specs['jirametrics'].version
+  end
+
   option :config
   option :name
   desc 'export', "Export data into either reports or CSV's as per the configuration"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.7'
+  version: '2.8'
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -106,7 +106,6 @@ files:
 - lib/jirametrics/html/cycletime_histogram.erb
 - lib/jirametrics/html/cycletime_scatterplot.erb
 - lib/jirametrics/html/daily_wip_chart.erb
-- lib/jirametrics/html/data_quality_report.erb
 - lib/jirametrics/html/estimate_accuracy_chart.erb
 - lib/jirametrics/html/expedited_chart.erb
 - lib/jirametrics/html/flow_efficiency_scatterplot.erb
@@ -132,14 +131,14 @@ files:
 - lib/jirametrics/tree_organizer.rb
 - lib/jirametrics/trend_line_calculator.rb
 - lib/jirametrics/value_equality.rb
-homepage: https://github.com/mikebowler/jirametrics
+homepage: https://jirametrics.org
 licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
   bug_tracker_uri: https://github.com/mikebowler/jirametrics/issues
-  changelog_uri: https://github.com/mikebowler/jirametrics/wiki/Changes
-  documentation_uri: https://github.com/mikebowler/jirametrics/wiki
+  changelog_uri: https://jirametrics.org/changes
+  documentation_uri: https://jirametrics.org
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/jirametrics/html/data_quality_report.erb

@@ -1,138 +0,0 @@
-<% 
-  problems = problems_for :discarded_changes
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> have had information discarded. This configuration is set
-    to "reset the clock" if an item is moved back to the backlog after it's been started. This hides important
-    information and makes the data less accurate. <b>Moving items back to the backlog is strongly discouraged.</b>
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :completed_but_not_started
-  unless problems.empty?
-    percentage_work_included = ((issues.size - problems.size).to_f / issues.size * 100).to_i
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were discarded from all charts using cycletime (scatterplot, histogram, etc) as we couldn't determine when they started. 
-    <% if percentage_work_included < 85 %>
-      Consider whether looking at only <%= percentage_work_included %>% of the total data points is enough to come to any reasonable conclusions. See <a href="https://en.wikipedia.org/wiki/Survivorship_bias">Survivorship Bias</a>.
-    <% end %>
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :status_changes_after_done
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> had a status change after being identified as done. We should question whether they were really done at that point or if we stopped the clock too early.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :backwards_through_status_categories
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> moved backwards across the board, <b>crossing status categories</b>. This will almost certainly have impacted timings as the end times are often taken at status category boundaries. You should assume that any timing measurements for this item are wrong.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :backwords_through_statuses
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> moved backwards across the board. Depending where we have set the start and end points, this may give us incorrect timing data. Note that these items did not cross a status category and may not have affected metrics.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :status_not_on_board
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were not visible on the board for some period of time. This may impact timings as the work was likely to have been forgotten if it wasn't visible.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :created_in_wrong_status
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were created in a status not designated as Backlog. This will impact the measurement of start times and will therefore impact whether it's shown as in progress or not.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :stopped_before_started
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were stopped before they were started and this will play havoc with any cycletime or WIP calculations. The most common case for this is when an item gets closed and then moved back into an in-progress status.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :issue_not_started_but_subtasks_have
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> still showing 'not started' while sub-tasks underneath them have started. This is almost always a mistake; if we're working on subtasks, the top level
-    item should also have started.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :incomplete_subtasks_when_issue_done
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> issues were marked as done while subtasks were still not done.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :issue_on_multiple_boards
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> For <%= label_issues problems.size %>, we have an issue that shows up on more than one board. This could result in more data points showing up on a chart then there really should be.
-    <%= collapsible_issues_panel problems, :hide_board_column %>
-  </p>
-<% 
-  end
-%>