jirametrics 2.6 → 2.7.1

data/lib/jirametrics/project_config.rb

@@ -24,22 +24,30 @@ class ProjectConfig
     @all_boards = {}
     @settings = load_settings
     @id = id
+    @has_loaded_data = false
   end
 
   def evaluate_next_level
     instance_eval(&@block) if @block
   end
 
-  def run
-    unless aggregated_project?
-      load_all_boards
-      @id = guess_project_id
-      load_status_category_mappings
-      load_project_metadata
-      load_sprints
-    end
+  def load_data
+    return if @has_loaded_data
+
+    @has_loaded_data = true
+    load_all_boards
+    @id = guess_project_id
+    load_status_category_mappings
+    load_project_metadata
+    load_sprints
+  end
+
+  def run load_only: false
+    load_data unless aggregated_project?
     anonymize_data if @anonymizer_needed
 
+    return if load_only
+
     @board_configs.each do |board_config|
       board_config.run
     end
@@ -117,7 +125,7 @@ class ProjectConfig
       board_id = $1.to_i
       load_board board_id: board_id, filename: "#{@target_path}#{file}"
     end
-    raise "No boards found for #{@file_prefix} in #{@target_path.inspect}" if @all_boards.empty?
+    raise "No boards found for #{@file_prefix.inspect} in #{@target_path.inspect}" if @all_boards.empty?
   end
 
   def load_board board_id:, filename:
@@ -232,7 +240,7 @@ class ProjectConfig
   end
 
   def load_project_metadata
-    filename = "#{@target_path}/#{file_prefix}_meta.json"
+    filename = File.join @target_path, "#{file_prefix}_meta.json"
     json = JSON.parse(file_system.load(filename))
 
     @data_version = json['version'] || 1
@@ -243,7 +251,7 @@ class ProjectConfig
 
     @jira_url = json['jira_url']
   rescue Errno::ENOENT
-    puts "== Can't load files from the target directory. Did you forget to download first? =="
+    file_system.log "Can't load #{filename}. Have you done a download?", also_write_to_stderr: true
     raise
   end
 
@@ -259,7 +267,7 @@ class ProjectConfig
     unless all_boards&.size == 1
       message = "If the board_id isn't set then we look for all board configurations in the target" \
         ' directory. '
-      if all_boards.nil? || all_boards.empty?
+      if all_boards.empty?
         message += ' In this case, we couldn\'t find any configuration files in the target directory.'
       else
         message += 'If there is only one, we use that. In this case we found configurations for' \
@@ -291,21 +299,21 @@ class ProjectConfig
   end
 
   def issues
-    raise "issues are being loaded before boards in project #{name.inspect}" if all_boards.nil? && !aggregated_project?
-
     unless @issues
-      if @aggregate_config
+      if aggregated_project?
         raise 'This is an aggregated project and issues should have been included with the include_issues_from ' \
           'declaration but none are here. Check your config.'
       end
+      load_data if all_boards.empty?
 
       timezone_offset = exporter.timezone_offset
 
-      issues_path = "#{@target_path}#{file_prefix}_issues/"
+      issues_path = File.join @target_path, "#{file_prefix}_issues"
       if File.exist?(issues_path) && File.directory?(issues_path)
         issues = load_issues_from_issues_directory path: issues_path, timezone_offset: timezone_offset
       else
-        puts "Can't find issues in #{path}. Has a download been done?"
+        file_system.log "Can't find directory #{issues_path}. Has a download been done?", also_write_to_stderr: true
+        return []
       end
 
       # Attach related issues
@@ -351,8 +359,8 @@ class ProjectConfig
     raise "No boards found for project #{name.inspect}" if all_boards.empty?
 
     if all_boards.size != 1
-      puts "Multiple boards are in use for project #{name.inspect}. " \
-        "Picked #{default_board.name.inspect} to attach issues to."
+      file_system.log "Multiple boards are in use for project #{name.inspect}. " \
+        "Picked #{default_board.name.inspect} to attach issues to.", also_write_to_stderr: true
     end
     default_board
   end

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/sprint_burndown.rb

@@ -18,7 +18,7 @@ class SprintBurndown < ChartBase
   attr_accessor :board_id
 
   def initialize
-    super()
+    super
 
     @summary_stats = {}
     header_text 'Sprint burndown'
@@ -126,7 +126,7 @@ class SprintBurndown < ChartBase
     currently_in_sprint = false
     change_data = []
 
-    issue_completed_time = issue.board.cycletime.stopped_time(issue)
+    issue_completed_time = issue.board.cycletime.started_stopped_times(issue).last
     completed_has_been_tracked = false
 
     issue.changes.each do |change|

data/lib/jirametrics/status.rb

@@ -38,7 +38,7 @@ class Status
   end
 
   def to_s
-    result = +"Status(name=#{@name.inspect}," \
+    result = "Status(name=#{@name.inspect}," \
       " id=#{@id.inspect}," \
       " category_name=#{@category_name.inspect}," \
       " category_id=#{@category_id.inspect}," \

data/lib/jirametrics/status_collection.rb

@@ -68,4 +68,8 @@ class StatusCollection
   def empty? = @list.empty?
   def clear = @list.clear
   def delete(object) = @list.delete(object)
+
+  def inspect
+    "StatusCollection(#{@list.collect(&:inspect).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.stopped_time(issue)&.to_date
+        stop_date = issue.board.cycletime.started_stopped_times(issue).last&.to_date
         [stop_date, issue] if stop_date && period.include?(stop_date)
       end
 

data/lib/jirametrics.rb

@@ -3,9 +3,13 @@
 require 'thor'
 
 class JiraMetrics < Thor
+  def self.exit_on_failure?
+    true
+  end
+
   option :config
   option :name
-  desc 'export only', "Export data into either reports or CSV's as per the configuration"
+  desc 'export', "Export data into either reports or CSV's as per the configuration"
   def export
     load_config options[:config]
     Exporter.instance.export(name_filter: options[:name] || '*')
@@ -13,7 +17,7 @@ class JiraMetrics < Thor
 
   option :config
   option :name
-  desc 'download only', 'Download data from Jira'
+  desc 'download', 'Download data from Jira'
   def download
     load_config options[:config]
     Exporter.instance.download(name_filter: options[:name] || '*')
@@ -21,7 +25,7 @@ class JiraMetrics < Thor
 
   option :config
   option :name
-  desc 'download and export', 'Same as running download, followed by export'
+  desc 'go', 'Same as running download, followed by export'
   def go
     load_config options[:config]
     Exporter.instance.download(name_filter: options[:name] || '*')
@@ -30,6 +34,13 @@ class JiraMetrics < Thor
     Exporter.instance.export(name_filter: options[:name] || '*')
   end
 
+  option :config
+  desc 'info', 'Dump information about one issue'
+  def info keys
+    load_config options[:config]
+    Exporter.instance.info(keys, name_filter: options[:name] || '*')
+  end
+
   private
 
   def load_config config_file
@@ -69,6 +80,7 @@ class JiraMetrics < Thor
     require 'jirametrics/daily_wip_by_parent_chart'
     require 'jirametrics/aging_work_in_progress_chart'
     require 'jirametrics/cycletime_scatterplot'
+    require 'jirametrics/flow_efficiency_scatterplot'
     require 'jirametrics/sprint_issue_change_data'
     require 'jirametrics/cycletime_histogram'
     require 'jirametrics/daily_wip_by_blocked_stalled_chart'
@@ -97,6 +109,4 @@ class JiraMetrics < Thor
     require 'jirametrics/board'
     load config_file
   end
-
-  # Dir.foreach('lib/jirametrics') {|file| puts "require 'jirametrics/#{$1}'" if file =~ /^(.+)\.rb$/}
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.6'
+  version: 2.7.1
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -95,6 +95,7 @@ files:
 - lib/jirametrics/file_config.rb
 - lib/jirametrics/file_system.rb
 - lib/jirametrics/fix_version.rb
+- lib/jirametrics/flow_efficiency_scatterplot.rb
 - lib/jirametrics/groupable_issue_chart.rb
 - lib/jirametrics/grouping_rules.rb
 - lib/jirametrics/hierarchy_table.rb
@@ -105,9 +106,9 @@ 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
 - lib/jirametrics/html/hierarchy_table.erb
 - lib/jirametrics/html/index.css
 - lib/jirametrics/html/index.erb
@@ -130,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:
@@ -153,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.21
 signing_key:
 specification_version: 4
 summary: Extract Jira metrics

data/lib/jirametrics/html/data_quality_report.erb

@@ -1,126 +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 :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
-%>