jirametrics 1.4 → 2.0

data/lib/jirametrics/project_config.rb

@@ -8,10 +8,10 @@ class ProjectConfig
 
   attr_reader :target_path, :jira_config, :all_boards, :possible_statuses,
     :download_config, :file_configs, :exporter, :data_version, :name, :board_configs,
-    :settings
-  attr_accessor :time_range, :jira_url, :project_id
+    :settings, :id
+  attr_accessor :time_range, :jira_url, :id
 
-  def initialize exporter:, jira_config:, block:, target_path: '.', name: ''
+  def initialize exporter:, jira_config:, block:, target_path: '.', name: '', id: nil
     @exporter = exporter
     @block = block
     @file_configs = []
@@ -21,6 +21,7 @@ class ProjectConfig
     @possible_statuses = StatusCollection.new
     @name = name
     @board_configs = []
+    @all_boards = {}
     @settings = {
       'stalled_threshold' => 5,
       'blocked_statuses' => [],
@@ -32,6 +33,7 @@ class ProjectConfig
         'blocked' => '#FF7400'
       }
     }
+    @id = id
   end
 
   def evaluate_next_level
@@ -41,7 +43,7 @@ class ProjectConfig
   def run
     unless aggregated_project?
       load_all_boards
-      @project_id = @all_boards.first.last&.project_id
+      @id = guess_project_id
       load_status_category_mappings
       load_project_metadata
       load_sprints
@@ -54,7 +56,23 @@ class ProjectConfig
     @file_configs.each do |file_config|
       file_config.run
     end
+  end
+
+  def guess_project_id
+    return @id if @id
+
+    previous_id = nil
+    @all_boards.each_value do |board|
+      project_id = board.project_id
+
+      # If the id is ambiguous then return nil for now. The user will get an error later
+      # in the case where we need it to be unambiguous. Sometimes we don't care and there's
+      # no point forcing the user to enter a project id if we don't need it.
+      return nil if previous_id && project_id && previous_id != project_id
 
+      previous_id = project_id if project_id
+    end
+    previous_id
   end
 
   def aggregated_project?
@@ -92,15 +110,7 @@ class ProjectConfig
     @file_prefix
   end
 
-  def status_category_mapping status:, category:, type: nil
-    puts "Deprecated: ProjectConfig.status_category_mapping no longer needs a type: #{type.inspect}" if type
-
-    status_object = find_status(name: status)
-    if status_object
-      puts "Status/Category mapping was already present. Ignoring redefinition: #{status_object}"
-      return
-    end
-
+  def status_category_mapping status:, category:
     add_possible_status Status.new(name: status, category_name: category)
   end
 
@@ -111,7 +121,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.nil?
+    raise "No boards found in #{@target_path.inspect}" if @all_boards.empty?
   end
 
   def load_board board_id:, filename:
@@ -119,38 +129,38 @@ class ProjectConfig
       raw: JSON.parse(File.read(filename)), possible_statuses: @possible_statuses
     )
     board.project_config = self
-    (@all_boards ||= {})[board_id] = board
+    @all_boards[board_id] = board
   end
 
-  def raise_with_message_about_missing_category_information
-    message = String.new
-    message << 'Could not determine categories for some of the statuses used in this data set.\n\n' \
-      'If you specify a project: then we\'ll ask Jira for those mappings. If you\'ve done that' \
-      ' and we still don\'t have the right mapping, which is possible, then use the' \
-      " 'status_category_mapping' declaration in your config to manually add one.\n\n" \
-      ' The mappings we do know about are below:'
+  def raise_with_message_about_missing_category_information all_issues = @issues
+    message = +''
+    message << "Could not determine categories for some of the statuses used in this data set.\n" \
+      "Use the 'status_category_mapping' declaration in your config to manually add one.\n" \
+      'The mappings we do know about are below:'
 
     @possible_statuses.each do |status|
-      message << "\n  type: #{status.type.inspect}, status: #{status.name.inspect}, " \
-        "category: #{status.category_name.inspect}'"
+      message << "\n  status: #{status.name.inspect}, category: #{status.category_name.inspect}"
     end
 
     message << "\n\nThe ones we're missing are the following:"
 
+    find_statuses_with_no_category_information(all_issues).each do |status_name|
+      message << "\n  status: #{status_name.inspect}, category: <unknown>"
+    end
+
+    raise message
+  end
+
+  def find_statuses_with_no_category_information all_issues
     missing_statuses = []
-    issues.each do |issue|
+    all_issues.each do |issue|
       issue.changes.each do |change|
         next unless change.status?
 
         missing_statuses << change.value unless find_status(name: change.value)
       end
     end
-
-    missing_statuses.uniq.each do |status_name|
-      message << "\n  status: #{status_name.inspect}, category: <unknown>"
-    end
-
-    raise message
+    missing_statuses.uniq
   end
 
   def load_status_category_mappings
@@ -158,22 +168,14 @@ class ProjectConfig
     # We may not always have this file. Load it if we can.
     return unless File.exist? filename
 
-    status_json_snippets = []
-
-    json = JSON.parse(File.read(filename))
-    if json[0]['statuses']
-      # Response from /api/2/{project_code}/status
-      json.each do |type_config|
-        status_json_snippets += type_config['statuses']
-      end
-    else
-      # Response from /api/2/status
-      status_json_snippets = json
-    end
-
-    status_json_snippets.each do |snippet|
-      add_possible_status Status.new(raw: snippet)
-    end
+    statuses = JSON.parse(File.read(filename))
+      .map { |snippet| Status.new(raw: snippet) }
+    statuses
+      .find_all { |status| status.global? }
+      .each { |status| add_possible_status status }
+    statuses
+      .find_all { |status| status.project_scoped? }
+      .each { |status| add_possible_status status }
   end
 
   def load_sprints
@@ -193,33 +195,40 @@ class ProjectConfig
   end
 
   def add_possible_status status
-    # If it's project scoped and it's not this project, just ignore it.
-    return if status.project_id && (@project_id.nil? || status.project_id != @project_id)
-
     existing_status = find_status(name: status.name)
 
-    # If it isn't there, add it and go.
-    return @possible_statuses << status unless existing_status
+    if status.project_scoped?
+      # If the project specific status doesn't change anything then we don't care whether it's
+      # our project or not.
+      return if existing_status && existing_status.category_name == status.category_name
 
-    # If the existing one has a project id then it's already the most precise. Ignore the new one.
-    # No need to check categories as status_category_mapping can't add a project_id so by definition
-    # this data came from Jira.
-    return if existing_status && existing_status.project_id
+      raise_ambiguous_project_id if @id.nil?
 
-    # If the new one has a project_id then it's more precise so replace the old one with this,
-    # regardless of whether the categories match.
-    if status.project_id
+      # Not our project, ignore it.
+      return unless status.project_id == @id
+
+      # Replace the old one with this
       @possible_statuses.delete(existing_status)
       @possible_statuses << status
       return
     end
 
-    # This new status may have come from status_category_mapping so verify that categories match.
-    if existing_status.category_name != status.category_name
-      raise "Redefining status category #{status} with #{existing_status}. Was one set in the config?"
-    end
+    # If it isn't there, add it and go.
+    return @possible_statuses << status unless existing_status
+
+    # We're registering the same one twice. Shouldn't be possible with the new status API but it
+    # did happen with the project specific one.
+    return if status.category_name == existing_status.category_name
 
-    @possible_statuses << status
+    # If we got this far then someone has called status_category_mapping and is attempting to
+    # change the category.
+    raise "Redefining status category #{status} with #{existing_status}. Was one set in the config?"
+  end
+
+  def raise_ambiguous_project_id
+    raise 'Ambiguous project id: There is a project specific status that could affect out calculations. ' \
+      'We are unable to automatically detect the id of the project so you will have to set it manually ' \
+      'in the configuration like: "project id: 5"'
   end
 
   def find_status name:
@@ -243,7 +252,7 @@ class ProjectConfig
   end
 
   def to_time string
-    string = "#{string}T00:00:00#{@timezone_offset}" if string =~ /^\d{4}-\d{2}\d{2}$/
+    string = "#{string}T00:00:00#{@timezone_offset}" if string.match?(/^\d{4}-\d{2}\d{2}$/)
     Time.parse string
   end
 
@@ -275,7 +284,7 @@ class ProjectConfig
   # To be used by the aggregate_config only. Not intended to be part of the public API
   def add_issues issues_list
     @issues = [] if @issues.nil?
-    @all_boards = {} if @all_boards.nil?
+    @all_boards = {}
 
     issues_list.each do |issue|
       @issues << issue
@@ -298,10 +307,8 @@ class ProjectConfig
       issues_path = "#{@target_path}#{file_prefix}_issues/"
       if File.exist?(issues_path) && File.directory?(issues_path)
         issues = load_issues_from_issues_directory path: issues_path, timezone_offset: timezone_offset
-      elsif File.exist?(@target_path) && File.directory?(@target_path)
-        issues = load_issues_from_target_directory path: @target_path, timezone_offset: timezone_offset
       else
-        puts "Can't find issues in either #{path} or #{@target_path}"
+        puts "Can't find issues in #{path}. Has a download been done?"
       end
 
       # Attach related issues
@@ -347,29 +354,12 @@ class ProjectConfig
     raise "No boards found for project #{name.inspect}" if all_boards.empty?
 
     if all_boards.size != 1
-      puts "Multiple boards are in use for project #{name.inspect}. Picked #{(default_board.name).inspect} to attach issues to."
+      puts "Multiple boards are in use for project #{name.inspect}. " \
+        "Picked #{default_board.name.inspect} to attach issues to."
     end
     default_board
   end
 
-  def load_issues_from_target_directory path:, timezone_offset:
-    puts "Deprecated: issues in the target directory for project #{@name}. " \
-      'Download again and this should fix itself.'
-
-    default_board = find_default_board
-
-    issues = []
-    Dir.foreach(path) do |filename|
-      if filename =~ /#{file_prefix}_\d+\.json/
-        content = JSON.parse File.read("#{path}#{filename}")
-        content['issues'].each do |issue|
-          issues << Issue.new(raw: issue, timezone_offset: timezone_offset, board: default_board)
-        end
-      end
-    end
-    issues
-  end
-
   def load_issues_from_issues_directory path:, timezone_offset:
     issues = []
     default_board = nil

data/lib/jirametrics/rules.rb

@@ -9,26 +9,7 @@ class Rules
     @ignore == true
   end
 
-  def eql?(other)
-    (other.class == self.class) && (other.state == state)
-  end
-
-  def state
-    instance_variables.map { |variable| instance_variable_get variable }
-  end
-
   def hash
-    2 # TODO: While this work, it's not performant
+    2 # TODO: While this works, it's not performant
   end
-
-  def inspect
-    result = String.new
-    result << "#{self.class}("
-    result << instance_variables.collect do |variable|
-      "#{variable}=#{instance_variable_get(variable).inspect}"
-    end.join(', ')
-    result << ')'
-    result
-  end
-
 end

data/lib/jirametrics/sprint_burndown.rb

@@ -54,19 +54,20 @@ class SprintBurndown < ChartBase
       change_data_by_sprint[sprint] = change_data.sort_by(&:time)
     end
 
-    result = String.new
+    result = +''
     result << '<h1>Sprint Burndowns</h1>'
 
+    possible_colours = %w[blue orange green red brown]
     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
-    charts_to_generate.each do |data_method, y_axis_title|
+    charts_to_generate.each do |data_method, y_axis_title| # rubocop:disable Style/HashEachMethods
       @summary_stats.clear
       data_sets = []
       sprints.each_with_index do |sprint, index|
-        color = %w[blue orange green red brown][index % 5]
+        color = possible_colours[index % 5]
         label = sprint.name
-        data = send(data_method, **{ sprint: sprint, change_data_for_sprint: change_data_by_sprint[sprint] })
+        data = send(data_method, sprint: sprint, change_data_for_sprint: change_data_by_sprint[sprint])
         data_sets << {
           label: label,
           data: data,
@@ -130,8 +131,8 @@ class SprintBurndown < ChartBase
         currently_in_sprint = in_change_item
       elsif change.story_points? && (issue_completed_time.nil? || change.time < issue_completed_time)
         action = :story_points
-        story_points = change.value&.to_f || 0.0
-        value = story_points - (change.old_value&.to_f || 0.0)
+        story_points = change.value.to_f
+        value = story_points - change.old_value.to_f
       elsif completed_has_been_tracked == false && change.time == issue_completed_time
         completed_has_been_tracked = true
         action = :issue_stopped

data/lib/jirametrics/sprint_issue_change_data.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+require 'jirametrics/value_equality'
+
 class SprintIssueChangeData
+  include ValueEquality
   attr_reader :time, :action, :value, :issue, :story_points
 
   def initialize time:, action:, value:, issue:, story_points:
@@ -11,16 +14,8 @@ class SprintIssueChangeData
     @story_points = story_points
   end
 
-  def eql?(other)
-    (other.class == self.class) && (other.state == state)
-  end
-
-  def state
-    instance_variables.map { |variable| instance_variable_get variable }
-  end
-
   def inspect
-    result = String.new
+    result = +''
     result << 'SprintIssueChangeData('
     result << instance_variables.collect do |variable|
       "#{variable}=#{instance_variable_get(variable).inspect}"

data/lib/jirametrics/status.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require 'jirametrics/value_equality'
+
 class Status
-  attr_reader :id, :type, :category_name, :category_id, :project_id
+  include ValueEquality
+  attr_reader :id, :category_name, :category_id, :project_id
   attr_accessor :name
 
   def initialize name: nil, id: nil, category_name: nil, category_id: nil, project_id: nil, raw: nil
@@ -11,20 +14,27 @@ class Status
     @category_id = category_id
     @project_id = project_id
 
-    if raw
-      @raw = raw
-      @name = raw['name']
-      @id = raw['id'].to_i
+    return unless raw
+
+    @raw = raw
+    @name = raw['name']
+    @id = raw['id'].to_i
 
-      category_config = raw['statusCategory']
-      @category_name = category_config['name']
-      @category_id = category_config['id'].to_i
+    category_config = raw['statusCategory']
+    @category_name = category_config['name']
+    @category_id = category_config['id'].to_i
 
-      # If this is a NextGen project then this status may be project specific. When this field is
-      # nil then the status is global.
-      @project_id = raw['scope']&.[]('project')&.[]('id')
-    end
+    # If this is a NextGen project then this status may be project specific. When this field is
+    # nil then the status is global.
+    @project_id = raw['scope']&.[]('project')&.[]('id')
+  end
 
+  def project_scoped?
+    !!@project_id
+  end
+
+  def global?
+    !project_scoped?
   end
 
   def to_s
@@ -32,13 +42,7 @@ class Status
       " category_name=#{@category_name.inspect}, category_id=#{@category_id.inspect}, project_id=#{@project_id})"
   end
 
-  def eql?(other)
-    (other.class == self.class) && (other.state == state)
-  end
-
-  def state
-    instance_variables
-      .reject {|variable| variable == :@raw}
-      .map { |variable| instance_variable_get variable }
+  def value_equality_ignored_variables
+    [:@raw]
   end
 end

data/lib/jirametrics/status_collection.rb

@@ -9,13 +9,13 @@ class StatusCollection
     including = expand_statuses including
     excluding = expand_statuses excluding
 
-    @list.collect do |status|
+    @list.filter_map do |status|
       keep = status.category_name == category_name ||
         including.any? { |s| s.name == status.name }
       keep = false if excluding.any? { |s| s.name == status.name }
 
       status.name if keep
-    end.compact
+    end
   end
 
   def expand_statuses names_or_ids

data/lib/jirametrics/story_point_accuracy_chart.rb

@@ -58,7 +58,7 @@ class StoryPointAccuracyChart < ChartBase
     [
       [completed_hash, 'Completed', '#66FF99', 'green', false],
       [aging_hash, 'Still in progress', '#FFCCCB', 'red', true]
-    ].collect do |hash, label, fill_color, border_color, starts_hidden|
+    ].filter_map do |hash, label, fill_color, border_color, starts_hidden|
       # 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
@@ -71,7 +71,7 @@ class StoryPointAccuracyChart < ChartBase
           'r' => values.size * 2,
           'title' => title
         }
-      end.compact
+      end
       next if data.empty?
 
       {
@@ -121,11 +121,6 @@ class StoryPointAccuracyChart < ChartBase
     story_points
   end
 
-  def grouping range:, color: # rubocop:disable Lint/UnusedMethodArgument
-    deprecated message: 'The grouping declaration is no longer supported on the StoryPointEstimateChart ' \
-      'as we now use a bubble chart rather than colors'
-  end
-
   def y_axis label:, sort_order: nil, &block
     @y_axis_sort_order = sort_order
     @y_axis_label = label

data/lib/jirametrics/throughput_chart.rb

@@ -73,10 +73,10 @@ class ThroughputChart < ChartBase
 
   def throughput_dataset periods:, completed_issues:
     periods.collect do |period|
-      closed_issues = completed_issues.collect do |issue|
+      closed_issues = completed_issues.filter_map do |issue|
         stop_date = issue.board.cycletime.stopped_time(issue)&.to_date
         [stop_date, issue] if stop_date && period.include?(stop_date)
-      end.compact
+      end
 
       date_label = "on #{period.end}"
       date_label = "between #{period.begin} and #{period.end}" unless period.begin == period.end

data/lib/jirametrics/trend_line_calculator.rb

@@ -8,10 +8,10 @@ class TrendLineCalculator
     @valid = points.size >= 2
     return unless valid?
 
-    sum_of_x = points.collect { |x, _y| x }.sum
-    sum_of_y = points.collect { |_x, y| y }.sum
-    sum_of_xy = points.collect { |x, y| x * y }.sum
-    sum_of_x2 = points.collect { |x, _y| x * x }.sum
+    sum_of_x = points.sum { |x, _y| x }
+    sum_of_y = points.sum { |_x, y| y }
+    sum_of_xy = points.sum { |x, y| x * y }
+    sum_of_x2 = points.sum { |x, _y| x * x }
     n = points.size.to_f
 
     @slope = ((n * sum_of_xy) - (sum_of_x * sum_of_y)) / ((n * sum_of_x2) - (sum_of_x * sum_of_x))

data/lib/jirametrics/value_equality.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Perform an equality check based on whether the two objects have the same values
+module ValueEquality
+  def ==(other)
+    return false unless other.class == self.class
+
+    code = lambda do |object|
+      names = object.instance_variables
+      if object.respond_to? :value_equality_ignored_variables
+        ignored_variables = object.value_equality_ignored_variables
+        names.reject! { |n| ignored_variables.include? n }
+      end
+      names.map { |variable| instance_variable_get variable }
+    end
+
+    code.call(self) == code.call(other)
+  end
+
+  def eql?(other)
+    self == other
+  end
+end

data/lib/jirametrics.rb

@@ -44,6 +44,7 @@ class JiraMetrics < Thor
       exit 1
     end
 
+    require 'jirametrics/value_equality'
     require 'jirametrics/chart_base'
     require 'jirametrics/rules'
     require 'jirametrics/grouping_rules'
@@ -55,6 +56,7 @@ class JiraMetrics < Thor
     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'
@@ -81,7 +83,7 @@ class JiraMetrics < Thor
     require 'jirametrics/self_or_issue_dispatcher'
     require 'jirametrics/throughput_chart'
     require 'jirametrics/exporter'
-    require 'jirametrics/json_file_loader'
+    require 'jirametrics/file_system'
     require 'jirametrics/blocked_stalled_change'
     require 'jirametrics/board_column'
     require 'jirametrics/anonymizer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '2.0'
 platform: ruby
 authors:
 - Mike Bowler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.2
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.4'
 description: Tool to extract metrics from Jira and export to either a report or to
   CSV files
 email: mbowler@gargoylesoftware.com
@@ -106,6 +92,7 @@ files:
 - lib/jirametrics/experimental/info.rb
 - lib/jirametrics/exporter.rb
 - lib/jirametrics/file_config.rb
+- lib/jirametrics/file_system.rb
 - lib/jirametrics/fix_version.rb
 - lib/jirametrics/groupable_issue_chart.rb
 - lib/jirametrics/grouping_rules.rb
@@ -127,7 +114,7 @@ files:
 - lib/jirametrics/html_report_config.rb
 - lib/jirametrics/issue.rb
 - lib/jirametrics/issue_link.rb
-- lib/jirametrics/json_file_loader.rb
+- lib/jirametrics/jira_gateway.rb
 - lib/jirametrics/project_config.rb
 - lib/jirametrics/rules.rb
 - lib/jirametrics/self_or_issue_dispatcher.rb
@@ -140,6 +127,7 @@ files:
 - lib/jirametrics/throughput_chart.rb
 - lib/jirametrics/tree_organizer.rb
 - lib/jirametrics/trend_line_calculator.rb
+- lib/jirametrics/value_equality.rb
 homepage: https://github.com/mikebowler/jirametrics
 licenses:
 - Apache-2.0

data/lib/jirametrics/json_file_loader.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-class JsonFileLoader
-  def load filename
-    JSON.parse File.read(filename)
-  end
-end