jirametrics 2.20 → 2.22

data/lib/jirametrics/project_config.rb

@@ -58,7 +58,16 @@ class ProjectConfig
 
   def load_settings
     # This is the weird exception that we don't ever want mocked out so we skip FileSystem entirely.
-    JSON.parse(File.read(File.join(__dir__, 'settings.json'), encoding: 'UTF-8'))
+    settings = JSON.parse(File.read(File.join(__dir__, 'settings.json'), encoding: 'UTF-8'))
+
+    if settings['blocked_color']
+      file_system.deprecated message: 'blocked color should be set via css now', date: '2024-05-03'
+    end
+    if settings['stalled_color']
+      file_system.deprecated message: 'stalled color should be set via css now', date: '2024-05-03'
+    end
+
+    settings
   end
 
   def guess_project_id
@@ -295,8 +304,9 @@ class ProjectConfig
     file_system.foreach(@target_path) do |file|
       next unless file =~ /^#{get_file_prefix}_board_(\d+)_sprints_\d+.json$/
 
+      board_id = $1.to_i
       file_path = File.join(@target_path, file)
-      board = @all_boards[$1.to_i]
+      board = @all_boards[board_id]
       unless board
         @exporter.file_system.log(
           'Found sprint data but can\'t find a matching board in config. ' \

data/lib/jirametrics/raw_javascript.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# When strings are serialized into JSON, they're converted to actual strings. The purpose
+# of this class is to allow raw javascript to be passed through.
+class RawJavascript
+  def initialize content
+    @content = content
+  end
+
+  def to_json(*_args)
+    @content
+  end
+end

data/lib/jirametrics/sprint.rb

@@ -13,6 +13,7 @@ class Sprint
   def id = @raw['id']
   def active? = (@raw['state'] == 'active')
   def closed? = (@raw['state'] == 'closed')
+  def future? = (@raw['state'] == 'future')
 
   def completed_at? time
     completed_at = completed_time
@@ -36,6 +37,17 @@ class Sprint
   def goal = @raw['goal']
   def name = @raw['name']
 
+  def day_count
+    return '' if future?
+
+    if closed?
+      days = (completed_time.to_date - start_time.to_date).to_i + 1
+    else
+      days = (end_time.to_date - start_time.to_date).to_i + 1
+    end
+    "#{days} days"
+  end
+
   private
 
   def parse_time time_string

data/lib/jirametrics/sprint_burndown.rb

@@ -48,8 +48,9 @@ class SprintBurndown < ChartBase
   end
 
   def run
-    sprints = sprints_in_time_range all_boards[board_id]
-    return nil if sprints.empty?
+    return nil unless current_board.scrum?
+
+    sprints = sprints_in_time_range current_board
 
     change_data_by_sprint = {}
     sprints.each do |sprint|
@@ -110,6 +111,9 @@ class SprintBurndown < ChartBase
 
   def sprints_in_time_range board
     board.sprints.select do |sprint|
+      # If it's never been started then it's just a holding area. Ignore it.
+      next if sprint.future?
+
       sprint_end_time = sprint.completed_time || sprint.end_time
       sprint_start_time = sprint.start_time
       next false if sprint_start_time.nil?

data/lib/jirametrics/stitcher.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+class Stitcher < HtmlGenerator
+  class StitchContent
+    include ValueEquality
+
+    attr_reader :file, :title, :content, :type
+
+    def initialize file:, title:, type:, content:
+      @file = file
+      @title = title
+      @content = content
+      @type = type
+    end
+  end
+
+  attr_reader :loaded_files, :all_stitches
+
+  def initialize file_system:
+    super()
+    self.file_system = file_system
+    @all_stitches = []
+    @loaded_files = []
+  end
+
+  def run stitch_file:
+    output_filename = make_output_filename stitch_file
+    file_system.log "Creating file #{output_filename.inspect}", also_write_to_stderr: true
+    erb = ERB.new file_system.load(stitch_file)
+    @sections = [[erb.result(binding), :body]]
+    create_html output_filename: output_filename, settings: {}
+  end
+
+  def make_output_filename input_filename
+    if /^(.+)\.erb$/ =~ input_filename
+      "#{$1}.html"
+    else
+      "#{input_filename}.html"
+    end
+  end
+
+  def grab_by_title title, from_file:, type: 'chart'
+    parse_file from_file
+    stitch_content = @all_stitches.find { |s| s.file == from_file && s.title == title && s.type == type }
+    return stitch_content.content if stitch_content
+
+    raise "Unable to find content in file #{from_file.inspect} matching title: #{title.inspect}"
+  end
+
+  def parse_file filename
+    return false if @loaded_files.include? filename
+
+    # To match: <!-- seam-start | chart78 | GithubPrScatterplot | PR Scatterplot | chart -->
+    regex = /^<!-- seam-(?<seam>start|end) \| (?<id>[^|]+) \| (?<clazz>[^|]+) \| (?<title>[^|]+) \| (?<type>[^|]+) -->$/
+    content = nil
+    file_system.load(filename).lines do |line|
+      matches = line.match(regex)
+      if matches
+        if matches[:seam] == 'start'
+          content = +''
+        else
+          @all_stitches << Stitcher::StitchContent.new(
+            file: filename, title: matches[:title], type: matches[:type], content: content
+          )
+          content = nil
+        end
+      elsif content
+        content << line
+      end
+    end
+
+    @loaded_files << filename
+    true
+  end
+end

data/lib/jirametrics.rb

@@ -52,11 +52,18 @@ class JiraMetrics < Thor
     Exporter.instance.info(key, name_filter: options[:name] || '*')
   end
 
+  option :config
+  desc 'stitch', 'Dump information about one issue'
+  def stitch stitch_file = 'stitcher.erb'
+    load_config options[:config]
+    Exporter.instance.stitch stitch_file
+  end
+
   no_commands do
     def load_config config_file, file_system: FileSystem.new
       config_file = './config.rb' if config_file.nil?
 
-      if File.exist? config_file
+      if file_system.file_exist? config_file
         # The fact that File.exist can see the file does not mean that require will be
         # able to load it. Convert this to an absolute pathname now for require.
         config_file = File.absolute_path(config_file).to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.20'
+  version: '2.22'
 platform: ruby
 authors:
 - Mike Bowler
@@ -66,6 +66,7 @@ files:
 - lib/jirametrics/aging_work_table.rb
 - lib/jirametrics/anonymizer.rb
 - lib/jirametrics/atlassian_document_format.rb
+- lib/jirametrics/bar_chart_range.rb
 - lib/jirametrics/blocked_stalled_change.rb
 - lib/jirametrics/board.rb
 - lib/jirametrics/board_column.rb
@@ -118,12 +119,14 @@ files:
 - lib/jirametrics/html/index.js
 - lib/jirametrics/html/sprint_burndown.erb
 - lib/jirametrics/html/throughput_chart.erb
+- lib/jirametrics/html_generator.rb
 - lib/jirametrics/html_report_config.rb
 - lib/jirametrics/issue.rb
 - lib/jirametrics/issue_collection.rb
 - lib/jirametrics/issue_link.rb
 - lib/jirametrics/jira_gateway.rb
 - lib/jirametrics/project_config.rb
+- lib/jirametrics/raw_javascript.rb
 - lib/jirametrics/rules.rb
 - lib/jirametrics/self_or_issue_dispatcher.rb
 - lib/jirametrics/settings.json
@@ -132,6 +135,7 @@ files:
 - lib/jirametrics/sprint_issue_change_data.rb
 - lib/jirametrics/status.rb
 - lib/jirametrics/status_collection.rb
+- lib/jirametrics/stitcher.rb
 - lib/jirametrics/throughput_chart.rb
 - lib/jirametrics/tree_organizer.rb
 - lib/jirametrics/trend_line_calculator.rb