jirametrics 2.13 → 2.20.1

data/lib/jirametrics/html_report_config.rb

@@ -51,7 +51,9 @@ class HtmlReportConfig
     @file_config.project_config.all_boards.each_value do |board|
       raise 'Multiple cycletimes not supported' if board.cycletime
 
-      board.cycletime = CycleTimeConfig.new(parent_config: self, label: label, block: block, file_system: file_system)
+      board.cycletime = CycleTimeConfig.new(
+        parent_config: self, label: label, block: block, file_system: file_system, settings: settings
+      )
     end
   end
 
@@ -72,6 +74,7 @@ class HtmlReportConfig
 
     html_directory = "#{Pathname.new(File.realpath(__FILE__)).dirname}/html"
     css = load_css html_directory: html_directory
+    javascript = file_system.load(File.join(html_directory, 'index.js'))
     erb = ERB.new file_system.load(File.join(html_directory, 'index.erb'))
     file_system.save_file content: erb.result(binding), filename: @file_config.output_filename
   end
@@ -87,7 +90,6 @@ class HtmlReportConfig
   def load_css html_directory:
     base_css_filename = File.join(html_directory, 'index.css')
     base_css = file_system.load(base_css_filename)
-    log("Loaded CSS:  #{base_css_filename}")
 
     extra_css_filename = settings['include_css']
     if extra_css_filename
@@ -160,7 +162,7 @@ class HtmlReportConfig
     chart.time_range = project_config.time_range
     chart.timezone_offset = timezone_offset
     chart.settings = settings
-    chart.users = project_config.users
+    chart.atlassian_document_format = project_config.atlassian_document_format
 
     chart.all_boards = project_config.all_boards
     chart.board_id = find_board_id

data/lib/jirametrics/issue.rb

@@ -19,9 +19,10 @@ class Issue
 
     # There are cases where we create an Issue of fragments like linked issues and those won't have
     # changelogs.
-    return unless @raw['changelog']
+    load_history_into_changes if @raw['changelog']
 
-    load_history_into_changes
+    # As above with fragments, there may not be a fields section
+    return unless @raw['fields']
 
     # If this is an older pull of data then comments may not be there.
     load_comments_into_changes if @raw['fields']['comment']
@@ -152,7 +153,7 @@ class Issue
   # Are we currently in this status? If yes, then return the most recent status change.
   def currently_in_status *status_names
     change = most_recent_status_change
-    return false if change.nil?
+    return nil if change.nil?
 
     change if change.current_status_matches(*status_names)
   end
@@ -162,7 +163,7 @@ class Issue
     category_ids = find_status_category_ids_by_names category_names
 
     change = most_recent_status_change
-    return false if change.nil?
+    return nil if change.nil?
 
     status = find_or_create_status id: change.value_id, name: change.value
     change if status && category_ids.include?(status.category.id)
@@ -212,7 +213,11 @@ class Issue
   end
 
   def parse_time text
-    Time.parse(text).getlocal(@timezone_offset)
+    if text.is_a? String
+      Time.parse(text).getlocal(@timezone_offset)
+    else
+      Time.at(text / 1000).getlocal(@timezone_offset)
+    end
   end
 
   def created
@@ -233,11 +238,11 @@ class Issue
   end
 
   def assigned_to
-    @raw['fields']&.[]('assignee')&.[]('displayName')
+    @raw['fields']['assignee']&.[]('displayName')
   end
 
   def assigned_to_icon_url
-    @raw['fields']&.[]('assignee')&.[]('avatarUrls')&.[]('16x16')
+    @raw['fields']['assignee']&.[]('avatarUrls')&.[]('16x16')
   end
 
   # Many test failures are simply unreadable because the default inspect on this class goes
@@ -608,7 +613,7 @@ class Issue
 
   def dump
     result = +''
-    result << "#{key} (#{type}): #{compact_text summary, 200}\n"
+    result << "#{key} (#{type}): #{compact_text summary, max: 200}\n"
 
     assignee = raw['fields']['assignee']
     result << "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>\n" unless assignee.nil?
@@ -681,9 +686,8 @@ class Issue
   def done?
     if artificial? || board.cycletime.nil?
       # This was probably loaded as a linked issue, which means we don't know what board it really
-      # belonged to. The best we can do is look at the status category. This case should be rare but
-      # it can happen.
-      status.category.name == 'Done'
+      # belonged to. The best we can do is look at the status key
+      status.category.done?
     else
       board.cycletime.done? self
     end
@@ -706,6 +710,19 @@ class Issue
     board.sprints.select { |s| sprint_ids.include? s.id }
   end
 
+  def compact_text text, max: 60
+    return '' if text.nil?
+
+    if text.is_a? Hash
+      # We can't effectively compact it but we can convert it into a string.
+      text = @board.project_config.atlassian_document_format.to_html(text)
+    else
+      text = text.gsub(/\s+/, ' ').strip
+      text = "#{text[0...max]}..." if text.length > max
+    end
+    text
+  end
+
   private
 
   def load_history_into_changes
@@ -730,14 +747,6 @@ class Issue
     end
   end
 
-  def compact_text text, max = 60
-    return nil if text.nil?
-
-    text = text.gsub(/\s+/, ' ').strip
-    text = "#{text[0..max]}..." if text.length > max
-    text
-  end
-
   def sort_changes!
     @changes.sort! do |a, b|
       # It's common that a resolved will happen at the same time as a status change.
@@ -755,6 +764,9 @@ class Issue
     first_status = nil
     first_status_id = nil
 
+    # There won't be a created timestamp in cases where this was a linked issue
+    return unless @raw['fields']['created']
+
     created_time = parse_time @raw['fields']['created']
     first_change = @changes.find { |change| change.field == field_name }
     if first_change.nil?

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

@@ -114,10 +114,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 +134,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
@@ -335,6 +352,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 +549,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 +582,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 +593,7 @@ class ProjectConfig
         issue: issue
       }
     end
+
+    cycletimes_touched.each { |c| c.flush_cache }
   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.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,26 @@ 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
+  no_commands do
+    def load_config config_file, file_system: FileSystem.new
+      config_file = './config.rb' if config_file.nil?
 
-  def load_config config_file
-    config_file = './config.rb' if config_file.nil?
+      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
+        file_system.error "Cannot find configuration file #{config_file.inspect}"
+        exit 1
+      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
+      require_rel 'jirametrics'
+      load config_file
     end
-
-    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'
-
-    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
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.13'
+  version: 2.20.1
 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
@@ -87,6 +87,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,6 +115,7 @@ 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_report_config.rb
@@ -156,7 +159,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: []