jirametrics 2.13 → 2.22

data/lib/jirametrics/jira_gateway.rb

@@ -3,21 +3,61 @@
 require 'cgi'
 require 'json'
 require 'English'
+require 'open3'
 
 class JiraGateway
-  attr_accessor :ignore_ssl_errors, :jira_url
+  attr_accessor :ignore_ssl_errors
+  attr_reader :jira_url, :settings, :file_system
 
-  def initialize file_system:
+  def initialize file_system:, jira_config:, settings:
     @file_system = file_system
+    load_jira_config(jira_config)
+    @settings = settings
+    @ignore_ssl_errors = settings['ignore_ssl_errors']
+  end
+
+  def post_request relative_url:, payload:
+    command = make_curl_command url: "#{@jira_url}#{relative_url}", method: 'POST'
+    exec_and_parse_response command: command, stdin_data: payload
+  end
+
+  def exec_and_parse_response command:, stdin_data:
+    log_entry = "  #{command.gsub(/\s+/, ' ')}"
+    log_entry = sanitize_message log_entry
+    @file_system.log log_entry
+
+    stdout, stderr, status = capture3(command, stdin_data: stdin_data)
+    unless status.success?
+      @file_system.log "Failed call with exit status #{status.exitstatus}!"
+      @file_system.log "Returned (stdout): #{stdout.inspect}"
+      @file_system.log "Returned (stderr): #{stderr.inspect}"
+      raise "Failed call with exit status #{status.exitstatus}. " \
+        "See #{@file_system.logfile_name} for details"
+    end
+
+    @file_system.log "Returned (stderr): #{stderr.inspect}" unless stderr == ''
+    raise 'no response from curl on stdout' if stdout == ''
+
+    parse_response(command: command, result: stdout)
+  end
+
+  def capture3 command, stdin_data:
+    # In it's own method so we can mock it out in tests
+    Open3.capture3(command, stdin_data: stdin_data)
   end
 
   def call_url relative_url:
     command = make_curl_command url: "#{@jira_url}#{relative_url}"
-    result = call_command command
+    exec_and_parse_response command: command, stdin_data: nil
+  end
+
+  def parse_response command:, result:
     begin
       json = JSON.parse(result)
     rescue # rubocop:disable Style/RescueStandardError
-      raise "Error when parsing result: #{result.inspect}"
+      message = "Unable to parse results from #{sanitize_message(command)}"
+      @file_system.error message, more: result
+      raise message
     end
 
     raise "Download failed with: #{JSON.pretty_generate(json)}" unless json_successful?(json)
@@ -25,18 +65,11 @@ class JiraGateway
     json
   end
 
-  def call_command command
-    log_entry = "  #{command.gsub(/\s+/, ' ')}"
-    log_entry = log_entry.gsub(@jira_api_token, '[API_TOKEN]') if @jira_api_token
-    @file_system.log log_entry
+  def sanitize_message message
+    token = @jira_api_token || @jira_personal_access_token
+    return message unless token # cookie based authentication
 
-    result = `#{command}`
-    @file_system.log result unless $CHILD_STATUS.success?
-    return result if $CHILD_STATUS.success?
-
-    @file_system.log "Failed call with exit status #{$CHILD_STATUS.exitstatus}."
-    raise "Failed call with exit status #{$CHILD_STATUS.exitstatus}. " \
-      "See #{@file_system.logfile_name} for details"
+    message.gsub(token, '[API_TOKEN]')
   end
 
   def load_jira_config jira_config
@@ -56,7 +89,7 @@ class JiraGateway
     @cookies = (jira_config['cookies'] || []).collect { |key, value| "#{key}=#{value}" }.join(';')
   end
 
-  def make_curl_command url:
+  def make_curl_command url:, method: 'GET'
     command = +''
     command << 'curl'
     command << ' -L' # follow redirects
@@ -65,8 +98,13 @@ class JiraGateway
     command << " --cookie #{@cookies.inspect}" unless @cookies.empty?
     command << " --user #{@jira_email}:#{@jira_api_token}" if @jira_api_token
     command << " -H \"Authorization: Bearer #{@jira_personal_access_token}\"" if @jira_personal_access_token
-    command << ' --request GET'
+    command << " --request #{method}"
+    if method == 'POST'
+      command << ' --data @-'
+      command << ' --header "Content-Type: application/json"'
+    end
     command << ' --header "Accept: application/json"'
+    command << ' --show-error --fail' # Better diagnostics when the server returns an error
     command << " --url \"#{url}\""
     command
   end

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
@@ -114,10 +123,14 @@ class ProjectConfig
   def file_prefix prefix
     # The file_prefix has to be set before almost everything else. It really should have been an attribute
     # on the project declaration itself. Hindsight is 20/20.
+
+    # There can only be one of these
     if @file_prefix
-      raise "file_prefix should only be set once. Was #{@file_prefix.inspect} and now changed to #{prefix.inspect}."
+      raise "file_prefix can only be set once. Was #{@file_prefix.inspect} and now changed to #{prefix.inspect}."
     end
 
+    raise_if_prefix_already_used(prefix)
+
     @file_prefix = prefix
 
     # Yes, this is a wierd place to be initializing this. Unfortunately, it has to happen after the file_prefix
@@ -130,8 +143,21 @@ class ProjectConfig
     @file_prefix
   end
 
-  def get_file_prefix # rubocop:disable Naming/AccessorMethodName
-    raise 'file_prefix has not been set yet. Move it to the top of the project declaration.' unless @file_prefix
+  def raise_if_prefix_already_used prefix
+    @exporter.project_configs.each do |project|
+      next unless project.get_file_prefix(raise_if_not_set: false) == prefix && project.target_path == target_path
+
+      raise "Project #{name.inspect} specifies file prefix #{prefix.inspect}, " \
+        "but that is already used by project #{project.name.inspect} in the same target path #{target_path.inspect}. " \
+        'This is almost guaranteed to be too much copy and paste in your configuration. ' \
+        'File prefixes must be unique within a directory.'
+    end
+  end
+
+  def get_file_prefix raise_if_not_set: true
+    if @file_prefix.nil? && raise_if_not_set
+      raise 'file_prefix has not been set yet. Move it to the top of the project declaration.'
+    end
 
     @file_prefix
   end
@@ -278,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. ' \
@@ -335,6 +362,12 @@ class ProjectConfig
     json.each { |user_data| @users << User.new(raw: user_data) }
   end
 
+  def atlassian_document_format
+    @atlassian_document_format ||= AtlassianDocumentFormat.new(
+      users: @users, timezone_offset: exporter.timezone_offset
+    )
+  end
+
   def to_time string, end_of_day: false
     time = end_of_day ? '23:59:59' : '00:00:00'
     string = "#{string}T#{time}#{exporter.timezone_offset}" if string.match?(/^\d{4}-\d{2}-\d{2}$/)
@@ -526,6 +559,7 @@ class ProjectConfig
   end
 
   def discard_changes_before status_becomes: nil, &block
+    cycletimes_touched = Set.new
     if status_becomes
       status_becomes = [status_becomes] unless status_becomes.is_a? Array
 
@@ -558,6 +592,7 @@ class ProjectConfig
       next if original_start_time.nil?
 
       issue.discard_changes_before cutoff_time
+      cycletimes_touched << issue.board.cycletime
 
       next unless cutoff_time
       next if original_start_time > cutoff_time # ie the cutoff would have made no difference.
@@ -568,5 +603,7 @@ class ProjectConfig
         issue: issue
       }
     end
+
+    cycletimes_touched.each { |c| c.flush_cache }
   end
 end

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/settings.json

@@ -7,5 +7,7 @@
   "flagged_means_blocked": true,
 
   "expedited_priority_names": ["Critical", "Highest"],
-  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"]
+  "priority_order": ["Lowest", "Low", "Medium", "High", "Highest"],
+
+  "cache_cycletime_calculations": true
 }

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

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'require_all'
+
+# This one does need to be loaded early. The rest will be loaded later.
+require 'jirametrics/file_system'
 
 class JiraMetrics < Thor
   def self.exit_on_failure?
@@ -43,81 +47,33 @@ class JiraMetrics < Thor
 
   option :config
   desc 'info', 'Dump information about one issue'
-  def info keys
+  def info key
     load_config options[:config]
-    Exporter.instance.info(keys, name_filter: options[:name] || '*')
+    Exporter.instance.info(key, name_filter: options[:name] || '*')
   end
 
-  private
-
-  def load_config config_file
-    config_file = './config.rb' if config_file.nil?
+  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
 
-    if 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
-    else
-      puts "Cannot find configuration file #{config_file.inspect}"
-      exit 1
-    end
+  no_commands do
+    def load_config config_file, file_system: FileSystem.new
+      config_file = './config.rb' if config_file.nil?
 
-    require 'jirametrics/value_equality'
-    require 'jirametrics/chart_base'
-    require 'jirametrics/rules'
-    require 'jirametrics/grouping_rules'
-    require 'jirametrics/daily_wip_chart'
-    require 'jirametrics/groupable_issue_chart'
-    require 'jirametrics/css_variable'
-    require 'jirametrics/issue_collection'
+      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
+      else
+        file_system.error "Cannot find configuration file #{config_file.inspect}"
+        exit 1
+      end
 
-    require 'jirametrics/aggregate_config'
-    require 'jirametrics/expedited_chart'
-    require 'jirametrics/board_config'
-    require 'jirametrics/file_config'
-    require 'jirametrics/jira_gateway'
-    require 'jirametrics/trend_line_calculator'
-    require 'jirametrics/status'
-    require 'jirametrics/issue_link'
-    require 'jirametrics/estimate_accuracy_chart'
-    require 'jirametrics/status_collection'
-    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/flow_efficiency_scatterplot'
-    require 'jirametrics/sprint_issue_change_data'
-    require 'jirametrics/cycletime_histogram'
-    require 'jirametrics/daily_wip_by_blocked_stalled_chart'
-    require 'jirametrics/html_report_config'
-    require 'jirametrics/data_quality_report'
-    require 'jirametrics/aging_work_bar_chart'
-    require 'jirametrics/change_item'
-    require 'jirametrics/project_config'
-    require 'jirametrics/dependency_chart'
-    require 'jirametrics/cycletime_config'
-    require 'jirametrics/tree_organizer'
-    require 'jirametrics/aging_work_table'
-    require 'jirametrics/sprint_burndown'
-    require 'jirametrics/self_or_issue_dispatcher'
-    require 'jirametrics/throughput_chart'
-    require 'jirametrics/exporter'
-    require 'jirametrics/file_system'
-    require 'jirametrics/blocked_stalled_change'
-    require 'jirametrics/board_column'
-    require 'jirametrics/anonymizer'
-    require 'jirametrics/downloader'
-    require 'jirametrics/fix_version'
-    require 'jirametrics/download_config'
-    require 'jirametrics/columns_config'
-    require 'jirametrics/hierarchy_table'
-    require 'jirametrics/estimation_configuration'
-    require 'jirametrics/board'
-    require 'jirametrics/daily_view'
-    require 'jirametrics/user'
-    require 'jirametrics/atlassian_document_format'
-    load config_file
+      require_rel 'jirametrics'
+      load config_file
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.13'
+  version: '2.22'
 platform: ruby
 authors:
 - Mike Bowler
 bindir: bin
 cert_chain: []
-date: 2025-07-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -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
@@ -87,6 +88,8 @@ files:
 - lib/jirametrics/dependency_chart.rb
 - lib/jirametrics/download_config.rb
 - lib/jirametrics/downloader.rb
+- lib/jirametrics/downloader_for_cloud.rb
+- lib/jirametrics/downloader_for_data_center.rb
 - lib/jirametrics/estimate_accuracy_chart.rb
 - lib/jirametrics/estimation_configuration.rb
 - lib/jirametrics/examples/aggregated_project.rb
@@ -113,14 +116,17 @@ files:
 - lib/jirametrics/html/hierarchy_table.erb
 - lib/jirametrics/html/index.css
 - lib/jirametrics/html/index.erb
+- 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
@@ -129,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
@@ -156,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Extract Jira metrics
 test_files: []