jirametrics 2.8 → 2.9.1pre1

data/lib/jirametrics/status_collection.rb

@@ -4,105 +4,106 @@ class StatusNotFoundError < StandardError
 end
 
 class StatusCollection
+  attr_reader :historical_status_mappings
+
   def initialize
     @list = []
+    @historical_status_mappings = {} # 'name:id' => category
   end
 
-  def filter_status_names category_name:, including: nil, excluding: nil
-    including = expand_statuses including
-    excluding = expand_statuses excluding
+  # Return the status matching this id or nil if it can't be found.
+  def find_by_id id
+    @list.find { |status| status.id == id }
+  end
 
-    @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 }
+  def find_all_by_name identifier
+    name, id = parse_name_id identifier
 
-      status.name if keep
-    end
-  end
+    if id
+      status = find_by_id id
+      return [] if status.nil?
 
-  def expand_statuses names_or_ids
-    result = []
-    return result if names_or_ids.nil?
-
-    names_or_ids = [names_or_ids] unless names_or_ids.is_a? Array
-
-    names_or_ids.each do |name_or_id|
-      status = @list.find { |s| s.name == name_or_id || s.id == name_or_id }
-      if status.nil?
-        if block_given?
-          yield name_or_id
-          next
-        else
-          all_status_names = @list.collect { |s| "#{s.name.inspect}:#{s.id.inspect}" }.uniq.sort.join(', ')
-          raise StatusNotFoundError, "Status not found: \"#{name_or_id}\". Possible statuses are: #{all_status_names}"
-        end
+      if name && status.name != name
+        raise "Specified status ID of #{id} does not match specified name #{name.inspect}. " \
+          "You might have meant one of these: #{self}."
       end
-
-      result << status
+      [status]
+    else
+      @list.select { |status| status.name == name }
     end
-    result
   end
 
-  def todo including: nil, excluding: nil
-    filter_status_names category_name: 'To Do', including: including, excluding: excluding
+  def find_all_categories
+    @list
+      .collect(&:category)
+      .uniq
+      .sort_by(&:id)
   end
 
-  def in_progress including: nil, excluding: nil
-    filter_status_names category_name: 'In Progress', including: including, excluding: excluding
+  def parse_name_id name
+    # Names could arrive in one of the following formats: "Done:3", "3", "Done"
+    if name =~ /^(.*):(\d+)$/
+      [$1, $2.to_i]
+    elsif name.match?(/^\d+$/)
+      [nil, name.to_i]
+    else
+      [name, nil]
+    end
   end
 
-  def done including: nil, excluding: nil
-    filter_status_names category_name: 'Done', including: including, excluding: excluding
-  end
+  def find_all_categories_by_name identifier
+    key = nil
+    id = nil
 
-  # Return the status matching this id or nil if it can't be found.
-  def find_by_id id
-    @list.find { |status| status.id == id }
+    if identifier.is_a? Symbol
+      key = identifier.to_s
+    else
+      name, id = parse_name_id identifier
+    end
+
+    find_all_categories.select { |c| c.id == id || c.name == name || c.key == key }
   end
 
-  def find_all_by_name name
-    @list.select { |status| status.name == name }
+  def collect(&block) = @list.collect(&block)
+  def find(&block) = @list.find(&block)
+  def each(&block) = @list.each(&block)
+  def select(&block) = @list.select(&block)
+  def <<(arg) = @list << arg
+  def empty? = @list.empty?
+  def clear = @list.clear
+  def delete(object) = @list.delete(object)
+
+  def to_s
+    "[#{@list.sort.join(', ')}]"
   end
 
-  def find_category_by_name name
-    category = @list.find { |status| status.category.name == name }&.category
-    unless category
-      set = Set.new
-      @list.each do |status|
-        set << status.category.to_s
-      end
-      raise "Unable to find status category #{name.inspect} in [#{set.to_a.sort.join(', ')}]"
-    end
-    category
+  def inspect
+    "StatusCollection#{self}"
   end
 
-  # This is used to create a status that was found in the history but has since been deleted.
   def fabricate_status_for id:, name:
-    first_in_progress_status = @list.find { |s| s.category.indeterminate? }
-    raise "Can't find even one in-progress status in [#{set.to_a.sort.join(', ')}]" unless first_in_progress_status
+    category = @historical_status_mappings["#{name.inspect}:#{id.inspect}"]
+    category = in_progress_category if category.nil?
 
     status = Status.new(
       name: name,
       id: id,
-      category_name: first_in_progress_status.category.name,
-      category_id: first_in_progress_status.category.id,
-      category_key: first_in_progress_status.category.key
+      category_name: category.name,
+      category_id: category.id,
+      category_key: category.key,
+      artificial: true
     )
-    self << status
+    @list << status
     status
   end
 
-  def collect(&block) = @list.collect(&block)
-  def find(&block) = @list.find(&block)
-  def each(&block) = @list.each(&block)
-  def select(&block) = @list.select(&block)
-  def <<(arg) = @list << arg
-  def empty? = @list.empty?
-  def clear = @list.clear
-  def delete(object) = @list.delete(object)
+  private
 
-  def inspect
-    "StatusCollection(#{@list.join(', ')})"
+  # Return the in-progress category or raise an error if we can't find one.
+  def in_progress_category
+    first_in_progress_status = find { |s| s.category.indeterminate? }
+    raise "Can't find even one in-progress status in #{self}" unless first_in_progress_status
+
+    first_in_progress_status.category
   end
 end

data/lib/jirametrics/value_equality.rb

@@ -9,9 +9,9 @@ module ValueEquality
       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 }
+        names.reject! { |n| ignored_variables.include? n.to_sym }
       end
-      names.map { |variable| instance_variable_get variable }
+      names.map { |variable| object.instance_variable_get variable }
     end
 
     code.call(self) == code.call(other)

data/lib/jirametrics.rb

@@ -68,7 +68,6 @@ class JiraMetrics < Thor
     require 'jirametrics/grouping_rules'
     require 'jirametrics/daily_wip_chart'
     require 'jirametrics/groupable_issue_chart'
-    require 'jirametrics/discard_changes_before'
     require 'jirametrics/css_variable'
 
     require 'jirametrics/aggregate_config'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: jirametrics
 version: !ruby/object:Gem::Version
-  version: '2.8'
+  version: 2.9.1pre1
 platform: ruby
 authors:
 - Mike Bowler
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 2025-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-word
@@ -52,8 +51,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.2
-description: Tool to extract metrics from Jira and export to either a report or to
-  CSV files
+description: Extract metrics from Jira and export to either a report or to CSV files
 email: mbowler@gargoylesoftware.com
 executables:
 - jirametrics
@@ -84,7 +82,6 @@ files:
 - lib/jirametrics/daily_wip_chart.rb
 - lib/jirametrics/data_quality_report.rb
 - lib/jirametrics/dependency_chart.rb
-- lib/jirametrics/discard_changes_before.rb
 - lib/jirametrics/download_config.rb
 - lib/jirametrics/downloader.rb
 - lib/jirametrics/estimate_accuracy_chart.rb
@@ -139,7 +136,6 @@ metadata:
   bug_tracker_uri: https://github.com/mikebowler/jirametrics/issues
   changelog_uri: https://jirametrics.org/changes
   documentation_uri: https://jirametrics.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.21
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Extract Jira metrics
 test_files: []

data/lib/jirametrics/discard_changes_before.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module DiscardChangesBefore
-  def discard_changes_before status_becomes: nil, &block
-    if status_becomes
-      status_becomes = [status_becomes] unless status_becomes.is_a? Array
-
-      block = lambda do |issue|
-        trigger_statuses = status_becomes.collect do |status_name|
-          if status_name == :backlog
-            issue.board.backlog_statuses.collect(&:name)
-          else
-            status_name
-          end
-        end.flatten
-
-        time = nil
-        issue.changes.each do |change|
-          time = change.time if change.status? && trigger_statuses.include?(change.value) && change.artificial? == false
-        end
-        time
-      end
-    end
-
-    issues_cutoff_times = []
-    issues.each do |issue|
-      cutoff_time = block.call(issue)
-      issues_cutoff_times << [issue, cutoff_time] if cutoff_time
-    end
-
-    discard_changes_before_hook issues_cutoff_times
-
-    issues_cutoff_times.each do |issue, cutoff_time|
-      issue.discard_changes_before cutoff_time
-    end
-  end
-end