jirametrics 2.0.1 → 2.1.1

data/lib/jirametrics/html/throughput_chart.erb

@@ -1,5 +1,5 @@
 
-<div>
+<div class="chart">
   <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
 </div>
 <script>
@@ -23,7 +23,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
         scaleLabel: {
           display: true,
           labelString: 'Date Completed'
-        }
+        },
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
       y: {
         scaleLabel: {
@@ -33,7 +36,10 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
           display: true,
           text: 'Count of items'
         },
-        min: 0
+        min: 0,
+        grid: {
+          color: <%= CssVariable['--grid-line-color'].to_json %>
+        },
       },
     },
     plugins: {
@@ -52,8 +58,8 @@ new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
             type: 'box',
             xMin: '<%= range.begin %>T00:00:00',
             xMax: '<%= range.end %>T23:59:59',
-            backgroundColor: '#F0F0F0',
-            borderColor: '#F0F0F0'
+            backgroundColor: <%= CssVariable.new('--non-working-days-color').to_json %>,
+            borderColor: <%= CssVariable.new('--non-working-days-color').to_json %>
           },
           <% end %>
         }

data/lib/jirametrics/html_report_config.rb

@@ -36,11 +36,21 @@ class HtmlReportConfig
 
     File.open @file_config.output_filename, 'w' do |file|
       html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
-      erb = ERB.new File.read("#{html_directory}/index.erb")
+      css = load_css html_directory: html_directory
+      erb = ERB.new File.read(File.join(html_directory, 'index.erb'))
       file.puts erb.result(binding)
     end
   end
 
+  def load_css html_directory:
+    base_css = File.read(File.join(html_directory, 'index.css'))
+    extra_css_filename = settings['include_css']
+    return base_css unless extra_css_filename && File.exist?(extra_css_filename)
+
+    @file_config.project_config.exporter.file_system.log("including css from file: #{extra_css_filename}")
+    base_css << "\n\n" << File.read(extra_css_filename)
+  end
+
   def board_id id = nil
     @board_id = id unless id.nil?
     @board_id
@@ -145,13 +155,18 @@ class HtmlReportConfig
     execute_chart DependencyChart.new block
   end
 
+  # have an explicit method here so that index.erb can call 'settings' just as any other erb can.
+  def settings
+    @file_config.project_config.settings
+  end
+
   def execute_chart chart, &after_init_block
     project_config = @file_config.project_config
 
     chart.issues = issues
     chart.time_range = project_config.time_range
     chart.timezone_offset = timezone_offset
-    chart.settings = project_config.settings
+    chart.settings = settings
 
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id if chart.respond_to? :board_id=

data/lib/jirametrics/issue.rb

@@ -30,7 +30,8 @@ class Issue
       fabricate_change(field_name: 'status'),
       fabricate_change(field_name: 'priority')
     ].compact + @changes
-  rescue => e
+  rescue # rubocop:disable Style/RescueStandardError
+    # All we're doing is adding information to the existing exception and letting it propogate up
     raise "Unable to initialize #{raw['key']}"
   end
 
@@ -252,7 +253,7 @@ class Issue
     end
 
     blocked_link_texts = settings['blocked_link_text']
-    stalled_threshold = settings['stalled_threshold']
+    stalled_threshold = settings['stalled_threshold_days']
 
     blocking_issue_keys = []
 

data/lib/jirametrics/jira_gateway.rb

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

@@ -57,7 +57,7 @@ class SprintBurndown < ChartBase
     result = +''
     result << '<h1>Sprint Burndowns</h1>'
 
-    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 +65,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

@@ -11,7 +11,8 @@ class StoryPointAccuracyChart < ChartBase
         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
+        The completed dots indicate cycletimes. The 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.
       </p>
@@ -56,9 +57,12 @@ class StoryPointAccuracyChart < ChartBase
     end
 
     [
-      [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

@@ -25,7 +25,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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.1
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
+date: 2024-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -74,6 +74,7 @@ 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
@@ -107,6 +108,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 +120,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 +154,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