jirametrics 1.2.1 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e97ffb4b2217f2b52ad32442b150243308aed066d4d4cedea4e9ab00a54e2f60
-  data.tar.gz: 4d722736c3494db4977ce2504afe69ba5dad00982b25069a5dea70ff2b7141bc
+  metadata.gz: 62643ff6e83e13e0b414c3969d9ff8dbb6e8eb3fa814413cb15914a5796efaff
+  data.tar.gz: 2b4a18c24fb7ed094f501b1474456de62e69197c63fca79351b9562a2f3d5c5d
 SHA512:
-  metadata.gz: bec679ade15523af3929183d52603d200a4dc42ca1cb34debbde314970d2883f93b40f1f05789497d16ba467b812fc9f9df90cfe34cd1dff81ad7f04b7cf9b35
-  data.tar.gz: 578a6ef7ba619bfd63e3ff5c2653fddca52500ad3f03117b043c80eed039c0b437eae7536f6970f9b8bfa1b03a2fd78b706abe015167350a506d0844313200af
+  metadata.gz: 42a7b6181becd0aeff379e375834ad8c1d4df1bda1dfb3141ded7992d3bb8cc2dbcce607a700ab93dc36044eec85d6c9562f84a9ace6c0dcd0f6cbceded1771e
+  data.tar.gz: b0085ac3089e674c8f3e36d13de345fefd39c0fece121542faf9b29338da3cdee092b84f7bbd55427a162ddc56dd9a8c65d419549471cd6ca5d8f359dab313af

data/lib/jirametrics/board.rb

@@ -83,6 +83,10 @@ class Board
     @raw['id'].to_i
   end
 
+  def project_id
+    @raw['location']['id']
+  end
+
   def name
     @raw['name']
   end

data/lib/jirametrics/downloader.rb

@@ -170,7 +170,7 @@ class Downloader
     @issue_keys_pending_download << parent_key if parent_key
 
     # Sub-tasks
-    issue.raw['fields']['subtasks'].each do |raw_subtask|
+    issue.raw['fields']['subtasks']&.each do |raw_subtask|
       @issue_keys_pending_download << raw_subtask['key']
     end
 

data/lib/jirametrics/examples/aggregated_project.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# This file is really intended to give you ideas about how you might configure your own reports, not
+# as a complete setup that will work in every case. 
+#
+# See https://github.com/mikebowler/jirametrics/wiki/Examples-folder for moreclass Exporter
 class Exporter
   def aggregated_project name:, project_names:
     project name: name do

data/lib/jirametrics/examples/standard_project.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
+# This file is really intended to give you ideas about how you might configure your own reports, not
+# as a complete setup that will work in every case. 
+#
+# 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
+  def standard_project name:, file_prefix:, ignore_issues: nil, starting_status: nil, boards: {},
+      default_board: nil, anonymize: false
+
     project name: name do
       puts name
+      self.anonymize if anonymize
 
       settings['blocked_link_text'] = ['is blocked by']
       file_prefix file_prefix
@@ -36,7 +43,7 @@ class Exporter
         html_report do
           board_id default_board if default_board
 
-          html "<H1>#{file_prefix}</H1>", type: :header
+          html "<H1>#{name}</H1>", type: :header
           boards.each_key do |id|
             board = find_board id
             html "<div><a href='#{board.url}'>#{id} #{board.name}</a></div>",
@@ -48,16 +55,7 @@ class Exporter
           cycletime_scatterplot do
             show_trend_lines
           end
-          cycletime_scatterplot do # Epics
-            header_text 'Parents only'
-            filter_issues { |i| i.parent }
-          end
           cycletime_histogram
-          cycletime_histogram do
-            grouping_rules do |issue, rules|
-              rules.label = issue.board.cycletime.stopped_time(issue).to_date.strftime('%b %Y')
-            end
-          end
 
           throughput_chart do
             description_text '<h2>Number of items completed, grouped by issue type</h2>'
@@ -79,14 +77,24 @@ class Exporter
           aging_work_table
           daily_wip_by_age_chart
           daily_wip_by_blocked_stalled_chart
+          daily_wip_chart do
+            header_text 'Daily WIP by Parent'
+            description_text <<-TEXT
+              How much work is in progress, grouped by the parent of the issue. This will give us an
+              indication of how focused we are on higher level objectives. If there are many parent
+              tickets in progress at the same time, either this team has their focus scattered or we
+              aren't doing a good job of 
+              <a href="https://improvingflow.com/2024/02/21/slicing-epics.html">splitting those parent
+              tickets</a>. Neither of those is desirable.
+            TEXT
+            grouping_rules do |issue, rules|
+              rules.label = issue.parent&.key || 'No parent'
+              rules.color = 'white' if rules.label == 'No parent' 
+            end
+          end
           expedited_chart
           sprint_burndown
           story_point_accuracy_chart
-          # story_point_accuracy_chart do
-          #   header_text nil
-          #   description_text nil
-          #   y_axis(sort_order: %w[Story Task Defect], label: 'TShirt Sizes') { |issue, _started_time| issue.type }
-          # end
 
           dependency_chart do
             link_rules do |link, rules|
@@ -98,8 +106,9 @@ class Exporter
                 rules.merge_bidirectional keep: 'outward'
               when 'Sync'
                 rules.use_bidirectional_arrows
-                #   rules.line_color = 'red'
               else
+                # This is a link type that we don't recognized. Dump it to standard out to draw attention
+                # to it.
                 puts "name=#{link.name}, label=#{link.label}"
               end
             end

data/lib/jirametrics/issue.rb

@@ -51,15 +51,7 @@ class Issue
   def summary = @raw['fields']['summary']
 
   def status
-    raw_status = @raw['fields']['status']
-    raw_category = raw_status['statusCategory']
-
-    Status.new(
-      name: raw_status['name'],
-      id: raw_status['id'].to_i,
-      category_name: raw_category['name'],
-      category_id: raw_category['id'].to_i
-    )
+    Status.new raw: @raw['fields']['status']
   end
 
   def status_id
@@ -495,7 +487,7 @@ class Issue
   end
 
   def load_history_into_changes
-    @raw['changelog']['histories'].each do |history|
+    @raw['changelog']['histories']&.each do |history|
       created = parse_time(history['created'])
 
       # It should be impossible to not have an author but we've seen it in production
@@ -507,7 +499,7 @@ class Issue
   end
 
   def load_comments_into_changes
-    @raw['fields']['comment']['comments'].each do |comment|
+    @raw['fields']['comment']['comments']&.each do |comment|
       raw = {
         'field' => 'comment',
         'to' => comment['id'],

data/lib/jirametrics/project_config.rb

@@ -7,8 +7,9 @@ class ProjectConfig
   include DiscardChangesBefore
 
   attr_reader :target_path, :jira_config, :all_boards, :possible_statuses,
-    :download_config, :file_configs, :exporter, :data_version, :name, :board_configs, :settings
-  attr_accessor :time_range, :jira_url
+    :download_config, :file_configs, :exporter, :data_version, :name, :board_configs,
+    :settings
+  attr_accessor :time_range, :jira_url, :project_id
 
   def initialize exporter:, jira_config:, block:, target_path: '.', name: ''
     @exporter = exporter
@@ -39,8 +40,9 @@ class ProjectConfig
 
   def run
     unless aggregated_project?
-      load_status_category_mappings
       load_all_boards
+      @project_id = @all_boards.first.last&.project_id
+      load_status_category_mappings
       load_project_metadata
       load_sprints
     end
@@ -99,7 +101,7 @@ class ProjectConfig
       return
     end
 
-    add_possible_status Status.new(name: status, id: nil, category_name: category, category_id: nil)
+    add_possible_status Status.new(name: status, category_name: category)
   end
 
   def load_all_boards
@@ -170,14 +172,7 @@ class ProjectConfig
     end
 
     status_json_snippets.each do |snippet|
-      category_config = snippet['statusCategory']
-      status_name = snippet['name']
-      add_possible_status Status.new(
-        name: status_name,
-        id: snippet['id'].to_i,
-        category_name: category_config['name'],
-        category_id: category_config['id'].to_i
-      )
+      add_possible_status Status.new(raw: snippet)
     end
   end
 
@@ -198,16 +193,32 @@ class ProjectConfig
   end
 
   def add_possible_status status
+    # If it's project scoped and it's not this project, just ignore it.
+    return if status.project_id && (@project_id.nil? || status.project_id != @project_id)
+
     existing_status = find_status(name: status.name)
 
-    if existing_status
-      if existing_status.category_name != status.category_name
-        raise "Redefining status category #{status} with #{existing_status}. Was one set in the config?"
-      end
+    # If it isn't there, add it and go.
+    return @possible_statuses << status unless existing_status
 
+    # If the existing one has a project id then it's already the most precise. Ignore the new one.
+    # No need to check categories as status_category_mapping can't add a project_id so by definition
+    # this data came from Jira.
+    return if existing_status && existing_status.project_id
+
+    # If the new one has a project_id then it's more precise so replace the old one with this,
+    # regardless of whether the categories match.
+    if status.project_id
+      @possible_statuses.delete(existing_status)
+      @possible_statuses << status
       return
     end
 
+    # This new status may have come from status_category_mapping so verify that categories match.
+    if existing_status.category_name != status.category_name
+      raise "Redefining status category #{status} with #{existing_status}. Was one set in the config?"
+    end
+
     @possible_statuses << status
   end
 

data/lib/jirametrics/status.rb

@@ -1,19 +1,35 @@
 # frozen_string_literal: true
 
 class Status
-  attr_reader :id, :type, :category_name, :category_id
+  attr_reader :id, :type, :category_name, :category_id, :project_id
   attr_accessor :name
 
-  def initialize name:, id:, category_name:, category_id:
+  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
+
+    if raw
+      @raw = raw
+      @name = raw['name']
+      @id = raw['id'].to_i
+
+      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')
+    end
+
   end
 
   def to_s
     "Status(name=#{@name.inspect}, id=#{@id.inspect}," \
-      " category_name=#{@category_name.inspect}, category_id=#{@category_id.inspect})"
+      " category_name=#{@category_name.inspect}, category_id=#{@category_id.inspect}, project_id=#{@project_id})"
   end
 
   def eql?(other)
@@ -21,6 +37,8 @@ class Status
   end
 
   def state
-    instance_variables.map { |variable| instance_variable_get variable }
+    instance_variables
+      .reject {|variable| variable == :@raw}
+      .map { |variable| instance_variable_get variable }
   end
 end

data/lib/jirametrics/status_collection.rb

@@ -64,4 +64,5 @@ class StatusCollection
   def <<(arg) = @list << arg
   def empty? = @list.empty?
   def clear = @list.clear
+  def delete(object) = @list.delete(object)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: '1.4'
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-05 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -163,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: Extract Jira metrics