jirametrics 2.0.1 → 2.2.0

data/lib/jirametrics/jira_gateway.rb

@@ -13,7 +13,10 @@ class JiraGateway
 
   def call_url relative_url:
     command = make_curl_command url: "#{@jira_url}#{relative_url}"
-    JSON.parse call_command command
+    result = call_command command
+    JSON.parse result
+  rescue => e # rubocop:disable Style/RescueStandardError
+    puts "Error #{e.inspect} when parsing result: #{result.inspect}"
   end
 
   def call_command command
@@ -29,7 +32,7 @@ class JiraGateway
 
   def load_jira_config jira_config
     @jira_url = jira_config['url']
-    raise "Must specify URL in config" if @jira_url.nil?
+    raise 'Must specify URL in config' if @jira_url.nil?
 
     @jira_email = jira_config['email']
     @jira_api_token = jira_config['api_token']

data/lib/jirametrics/project_config.rb

@@ -8,7 +8,7 @@ class ProjectConfig
 
   attr_reader :target_path, :jira_config, :all_boards, :possible_statuses,
     :download_config, :file_configs, :exporter, :data_version, :name, :board_configs,
-    :settings, :id
+    :settings, :aggregate_config
   attr_accessor :time_range, :jira_url, :id
 
   def initialize exporter:, jira_config:, block:, target_path: '.', name: '', id: nil
@@ -22,22 +22,12 @@ class ProjectConfig
     @name = name
     @board_configs = []
     @all_boards = {}
-    @settings = {
-      'stalled_threshold' => 5,
-      'blocked_statuses' => [],
-      'stalled_statuses' => [],
-      'blocked_link_text' => [],
-
-      'colors' => {
-        'stalled' => 'orange',
-        'blocked' => '#FF7400'
-      }
-    }
+    @settings = load_settings
     @id = id
   end
 
   def evaluate_next_level
-    instance_eval(&@block)
+    instance_eval(&@block) if @block
   end
 
   def run
@@ -58,6 +48,10 @@ class ProjectConfig
     end
   end
 
+  def load_settings
+    JSON.parse(File.read(File.join(__dir__, 'settings.json')))
+  end
+
   def guess_project_id
     return @id if @id
 
@@ -121,7 +115,7 @@ class ProjectConfig
       board_id = $1.to_i
       load_board board_id: board_id, filename: "#{@target_path}#{file}"
     end
-    raise "No boards found in #{@target_path.inspect}" if @all_boards.empty?
+    raise "No boards found for #{@file_prefix} in #{@target_path.inspect}" if @all_boards.empty?
   end
 
   def load_board board_id:, filename:
@@ -243,7 +237,7 @@ class ProjectConfig
 
     start = json['date_start'] || json['time_start'] # date_start is the current format. Time is the old.
     stop  = json['date_end'] || json['time_end']
-    @time_range = to_time(start)..to_time(stop)
+    @time_range = to_time(start)..to_time(stop, end_of_day: true)
 
     @jira_url = json['jira_url']
   rescue Errno::ENOENT
@@ -251,8 +245,9 @@ class ProjectConfig
     raise
   end
 
-  def to_time string
-    string = "#{string}T00:00:00#{@timezone_offset}" if string.match?(/^\d{4}-\d{2}\d{2}$/)
+  def to_time string, end_of_day: false
+    time = end_of_day ? '23:59:59' : '00:00:00'
+    string = "#{string}T#{time}#{@timezone_offset}" if string.match?(/^\d{4}-\d{2}-\d{2}$/)
     Time.parse string
   end
 
@@ -436,8 +431,8 @@ class ProjectConfig
       else
         message << "days of data from #{issue.changes.first.time.to_date} to #{cutoff_time.to_date}"
       end
-      puts message
+      exporter.file_system.log message
     end
-    puts "Discarded data from #{issues_cutoff_times.count} issues out of a total #{issues.size}"
+    exporter.file_system.log "Discarded data from #{issues_cutoff_times.count} issues out of a total #{issues.size}"
   end
 end

data/lib/jirametrics/settings.json

@@ -0,0 +1,7 @@
+{
+  "stalled_threshold_days": 5,
+  "stalled_statuses": [],
+
+  "blocked_link_text": [],
+  "blocked_statuses": []
+}

data/lib/jirametrics/sprint_burndown.rb

@@ -22,7 +22,13 @@ class SprintBurndown < ChartBase
 
     @summary_stats = {}
     header_text 'Sprint burndown'
-    description_text ''
+    description_text <<-TEXT
+      <div class="p">
+        Burndowns for all sprints in this time period. The different colours are only to
+        differentiate one sprint from another as they may overlap time periods.
+      </div>
+      #{describe_non_working_days}
+    TEXT
   end
 
   def options= arg
@@ -55,9 +61,9 @@ class SprintBurndown < ChartBase
     end
 
     result = +''
-    result << '<h1>Sprint Burndowns</h1>'
+    result << render_top_text(binding)
 
-    possible_colours = %w[blue orange green red brown]
+    possible_colours = (1..5).collect { |i| CssVariable["--sprint-burndown-sprint-color-#{i}"] }
     charts_to_generate = []
     charts_to_generate << [:data_set_by_story_points, 'Story Points'] if @use_story_points
     charts_to_generate << [:data_set_by_story_counts, 'Story Count'] if @use_story_counts
@@ -65,7 +71,7 @@ class SprintBurndown < ChartBase
       @summary_stats.clear
       data_sets = []
       sprints.each_with_index do |sprint, index|
-        color = possible_colours[index % 5]
+        color = possible_colours[index % possible_colours.size]
         label = sprint.name
         data = send(data_method, sprint: sprint, change_data_for_sprint: change_data_by_sprint[sprint])
         data_sets << {

data/lib/jirametrics/status_collection.rb

@@ -32,7 +32,7 @@ class StatusCollection
           next
         else
           all_status_names = @list.collect { |s| "#{s.name.inspect}:#{s.id.inspect}" }.uniq.sort.join(', ')
-          raise "Status not found: #{name_or_id}. Possible statuses are: #{all_status_names}"
+          raise "Status not found: \"#{name_or_id}\". Possible statuses are: #{all_status_names}"
         end
       end
 

data/lib/jirametrics/story_point_accuracy_chart.rb

@@ -6,15 +6,20 @@ class StoryPointAccuracyChart < ChartBase
 
     header_text 'Estimate Accuracy'
     description_text <<-HTML
-      <p>
+      <div class="p">
         This chart graphs estimates against actual recorded cycle times. Since
         estimates can change over time, we're graphing the estimate at the time that the story started.
-      </p>
-      <p>
-        The completed dots indicate cycletimes. The aging dots (if you turn them on) show the current
-        age of items, which will give you a hint as to where they might end up. If they're already
-        far to the right then you know you have a problem.
-      </p>
+      </div>
+      <div class="p">
+        The #{color_block '--estimate-accuracy-chart-completed-fill-color'} completed dots indicate
+        cycletimes. 
+        <% if @has_aging_data %>
+          The #{color_block '--estimate-accuracy-chart-active-fill-color'} aging dots
+          (click on the legend to turn them on) show the current
+          age of items, which will give you a hint as to where they might end up. If they're already
+          far to the right then you know you have a problem.
+        <% end %>
+      </div>
     HTML
 
     @y_axis_label = 'Story Point Estimates'
@@ -55,10 +60,15 @@ class StoryPointAccuracyChart < ChartBase
       (hash[key] ||= []) << issue
     end
 
+    @has_aging_data = !aging_hash.empty?
+
     [
-      [completed_hash, 'Completed', '#66FF99', 'green', false],
-      [aging_hash, 'Still in progress', '#FFCCCB', 'red', true]
-    ].filter_map do |hash, label, fill_color, border_color, starts_hidden|
+      [completed_hash, 'Completed', 'completed', false],
+      [aging_hash, 'Still in progress', 'active', true]
+    ].filter_map do |hash, label, completed_or_active, starts_hidden|
+      fill_color = CssVariable["--estimate-accuracy-chart-#{completed_or_active}-fill-color"]
+      border_color = CssVariable["--estimate-accuracy-chart-#{completed_or_active}-border-color"]
+
       # We sort so that the smaller circles are in front of the bigger circles.
       data = hash.sort(&hash_sorter).collect do |key, values|
         estimate, cycle_time = *key

data/lib/jirametrics/throughput_chart.rb

@@ -9,7 +9,12 @@ class ThroughputChart < ChartBase
     super()
 
     header_text 'Throughput Chart'
-    description_text 'This chart shows how many items we completed per unit of time'
+    description_text <<-TEXT
+      <div class="p">
+        This chart shows how many items we completed per week
+      </div>
+      #{describe_non_working_days}
+    TEXT
 
     init_configuration_block(block) do
       grouping_rules do |issue, rule|
@@ -25,7 +30,10 @@ class ThroughputChart < ChartBase
     data_sets = []
     if rules_to_issues.size > 1
       data_sets << weekly_throughput_dataset(
-        completed_issues: completed_issues, label: 'Totals', color: 'gray', dashed: true
+        completed_issues: completed_issues,
+        label: 'Totals',
+        color: CssVariable['--throughput_chart_total_line_color'],
+        dashed: true
       )
     end
 

data/lib/jirametrics.rb

@@ -51,6 +51,7 @@ class JiraMetrics < Thor
     require 'jirametrics/daily_wip_chart'
     require 'jirametrics/groupable_issue_chart'
     require 'jirametrics/discard_changes_before'
+    require 'jirametrics/css_variable'
 
     require 'jirametrics/aggregate_config'
     require 'jirametrics/expedited_chart'
@@ -65,6 +66,7 @@ class JiraMetrics < Thor
     require 'jirametrics/sprint'
     require 'jirametrics/issue'
     require 'jirametrics/daily_wip_by_age_chart'
+    require 'jirametrics/daily_wip_by_parent_chart'
     require 'jirametrics/aging_work_in_progress_chart'
     require 'jirametrics/cycletime_scatterplot'
     require 'jirametrics/sprint_issue_change_data'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -74,11 +74,13 @@ files:
 - lib/jirametrics/change_item.rb
 - lib/jirametrics/chart_base.rb
 - lib/jirametrics/columns_config.rb
+- lib/jirametrics/css_variable.rb
 - lib/jirametrics/cycletime_config.rb
 - lib/jirametrics/cycletime_histogram.rb
 - lib/jirametrics/cycletime_scatterplot.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
 - lib/jirametrics/daily_wip_chart.rb
 - lib/jirametrics/data_quality_report.rb
 - lib/jirametrics/dependency_chart.rb
@@ -107,6 +109,7 @@ files:
 - lib/jirametrics/html/data_quality_report.erb
 - lib/jirametrics/html/expedited_chart.erb
 - lib/jirametrics/html/hierarchy_table.erb
+- lib/jirametrics/html/index.css
 - lib/jirametrics/html/index.erb
 - lib/jirametrics/html/sprint_burndown.erb
 - lib/jirametrics/html/story_point_accuracy_chart.erb
@@ -118,6 +121,7 @@ files:
 - lib/jirametrics/project_config.rb
 - lib/jirametrics/rules.rb
 - lib/jirametrics/self_or_issue_dispatcher.rb
+- lib/jirametrics/settings.json
 - lib/jirametrics/sprint.rb
 - lib/jirametrics/sprint_burndown.rb
 - lib/jirametrics/sprint_issue_change_data.rb
@@ -151,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.7
+rubygems_version: 3.5.10
 signing_key:
 specification_version: 4
 summary: Extract Jira metrics