jirametrics 1.0.0

data/lib/jirametrics/tree_organizer.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+class TreeOrganizer
+  attr_reader :cyclical_links
+
+  class Node
+    attr_accessor :parent, :issue
+    attr_reader :children
+
+    def initialize issue: nil
+      @issue = issue
+      @children = []
+    end
+
+    def to_s
+      "Node(#{@issue&.key || 'Root'}, parent: #{@parent&.issue&.key || 'Root'}, children: #{@children.inspect})"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def <=> other
+      issue <=> other.issue
+    end
+
+    def children?
+      !@children.empty?
+    end
+  end
+
+  def initialize issues:
+    @issues = issues
+    @root = Node.new
+    @cyclical_links = []
+    @node_hash = {}
+
+    @issues.each do |issue|
+      add issue
+    end
+  end
+
+  def add issue, bread_crumbs = []
+    parent_node = @root
+
+    issue_node = find_node issue.key
+    return issue_node if issue_node
+
+    parent_issue = issue.parent
+    if parent_issue
+      cyclical = bread_crumbs.include? parent_issue.key
+      bread_crumbs << issue.key
+      if cyclical
+        @cyclical_links << bread_crumbs.reverse
+      else
+        parent_node = find_node parent_issue.key
+      end
+      parent_node = add parent_issue, bread_crumbs if parent_node.nil?
+    end
+
+    issue_node = Node.new(issue: issue)
+    if parent_node
+      parent_node.children << issue_node
+      @node_hash[issue_node.issue.key] = issue_node
+    end
+    issue_node
+  end
+
+  def find_node issue_key
+    @node_hash[issue_key]
+    # @root.children.find { |node| node.issue.key == issue_key }
+  end
+
+  def find_issue issue_key
+    @issues.find { |issue| issue.key == issue_key }
+  end
+
+  def flattened_issue_keys
+    flattened_nodes.collect do |node, depth|
+      [node.issue.key, depth]
+    end
+  end
+
+  def flattened_nodes
+    list = []
+    walk_children parent: @root, list: list, depth: 1
+    list
+  end
+
+  def walk_children parent:, list:, depth:
+    parent.children.sort.each do |node|
+      list << [node, depth]
+      walk_children parent: node, list: list, depth: depth + 1
+    end
+  end
+end

data/lib/jirametrics/trend_line_calculator.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+class TrendLineCalculator
+  # Using math from https://math.stackexchange.com/questions/204020/what-is-the-equation-used-to-calculate-a-linear-trendline
+
+  def initialize points
+    # We can't do trend calculations with less than two data points
+    @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
+    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))
+    @offset = (sum_of_y - (@slope * sum_of_x)) / n
+
+    @valid = false if vertical?
+  end
+
+  def valid? = @valid
+  def horizontal? = @slope.zero?
+  def vertical? = @slope.nan? || @slope.infinite?
+
+  def calc_y x: # rubocop:disable Naming/MethodParameterName
+    ((x * @slope) + @offset).to_i
+  end
+
+  def line_crosses_at y: # rubocop:disable Naming/MethodParameterName
+    raise "line will never cross #{y}. Trend is perfectly horizontal" if horizontal?
+
+    ((y.to_f - @offset) / @slope).to_i
+  end
+
+  # If the trend line can't be calculated then return an empty array. Otherwise, return
+  # an array with two (x,y) points, with which you can draw the trend line.
+  def chart_datapoints range:, max_y:, min_y: 0
+    raise 'max_y is nil' if max_y.nil?
+    return [] unless valid?
+
+    data_points = []
+    x_start = range.begin
+    y_start = calc_y(x: range.begin).to_i
+    x_end = range.end
+    y_end = calc_y(x: range.end).to_i
+
+    if y_start < min_y
+      x_start = line_crosses_at y: 0
+      y_start = 0
+    end
+
+    if y_start > max_y
+      x_start = line_crosses_at y: max_y
+      y_start = max_y
+    end
+
+    if y_end < min_y
+      x_end = line_crosses_at y: 0
+      y_end = 0
+    end
+
+    if y_end > max_y
+      x_end = line_crosses_at y: max_y
+      y_end = max_y
+    end
+
+    data_points << { x: x_start, y: y_start }
+    data_points << { x: x_end, y: y_end }
+
+    data_points
+  end
+end

data/lib/jirametrics.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+class JiraMetrics < Thor
+  option :config
+  desc 'export', "Export data into either reports or CSV's as per the configuration"
+  def export
+    load_config options[:config]
+    Exporter.instance.export
+  end
+
+  option :config
+  desc 'download', 'Download data from Jira'
+  def download
+    load_config options[:config]
+    Exporter.instance.download
+  end
+
+  private
+
+  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
+      puts "Cannot find configuration file #{config_file.inspect}"
+      exit 1
+    end
+
+    require 'jirametrics/chart_base'
+    require 'jirametrics/rules'
+    require 'jirametrics/grouping_rules'
+    require 'jirametrics/daily_wip_chart'
+    require 'jirametrics/groupable_issue_chart'
+    require 'jirametrics/discard_changes_before'
+
+    require 'jirametrics/aggregate_config'
+    require 'jirametrics/expedited_chart'
+    require 'jirametrics/board_config'
+    require 'jirametrics/file_config'
+    require 'jirametrics/trend_line_calculator'
+    require 'jirametrics/status'
+    require 'jirametrics/issue_link'
+    require 'jirametrics/story_point_accuracy_chart'
+    require 'jirametrics/status_collection'
+    require 'jirametrics/sprint'
+    require 'jirametrics/issue'
+    require 'jirametrics/daily_wip_by_age_chart'
+    require 'jirametrics/aging_work_in_progress_chart'
+    require 'jirametrics/cycletime_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/json_file_loader'
+    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/board'
+    require config_file
+  end
+
+  # Dir.foreach('lib/jirametrics') {|file| puts "require 'jirametrics/#{$1}'" if file =~ /^(.+)\.rb$/}
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: jirametrics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Bowler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: random-word
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+executables:
+- jirametrics
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/jirametrics
+- lib/jirametrics.rb
+- lib/jirametrics/aggregate_config.rb
+- lib/jirametrics/aging_work_bar_chart.rb
+- lib/jirametrics/aging_work_in_progress_chart.rb
+- lib/jirametrics/aging_work_table.rb
+- lib/jirametrics/anonymizer.rb
+- lib/jirametrics/blocked_stalled_change.rb
+- lib/jirametrics/board.rb
+- lib/jirametrics/board_column.rb
+- lib/jirametrics/board_config.rb
+- lib/jirametrics/change_item.rb
+- lib/jirametrics/chart_base.rb
+- lib/jirametrics/columns_config.rb
+- lib/jirametrics/cycletime_config.rb
+- lib/jirametrics/cycletime_histogram.rb
+- lib/jirametrics/cycletime_scatterplot.rb
+- lib/jirametrics/daily_wip_by_age_chart.rb
+- lib/jirametrics/daily_wip_by_blocked_stalled_chart.rb
+- 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/examples/aggregated_project.rb
+- lib/jirametrics/examples/standard_project.rb
+- lib/jirametrics/expedited_chart.rb
+- lib/jirametrics/experimental/generator.rb
+- lib/jirametrics/experimental/info.rb
+- lib/jirametrics/exporter.rb
+- lib/jirametrics/file_config.rb
+- lib/jirametrics/fix_version.rb
+- lib/jirametrics/groupable_issue_chart.rb
+- lib/jirametrics/grouping_rules.rb
+- lib/jirametrics/hierarchy_table.rb
+- lib/jirametrics/html/aging_work_bar_chart.erb
+- lib/jirametrics/html/aging_work_in_progress_chart.erb
+- lib/jirametrics/html/aging_work_table.erb
+- lib/jirametrics/html/collapsible_issues_panel.erb
+- lib/jirametrics/html/cycletime_histogram.erb
+- lib/jirametrics/html/cycletime_scatterplot.erb
+- lib/jirametrics/html/daily_wip_chart.erb
+- lib/jirametrics/html/data_quality_report.erb
+- lib/jirametrics/html/expedited_chart.erb
+- lib/jirametrics/html/hierarchy_table.erb
+- lib/jirametrics/html/index.erb
+- lib/jirametrics/html/sprint_burndown.erb
+- lib/jirametrics/html/story_point_accuracy_chart.erb
+- lib/jirametrics/html/throughput_chart.erb
+- lib/jirametrics/html_report_config.rb
+- lib/jirametrics/issue.rb
+- lib/jirametrics/issue_link.rb
+- lib/jirametrics/json_file_loader.rb
+- lib/jirametrics/project_config.rb
+- lib/jirametrics/rules.rb
+- lib/jirametrics/self_or_issue_dispatcher.rb
+- lib/jirametrics/sprint.rb
+- lib/jirametrics/sprint_burndown.rb
+- lib/jirametrics/sprint_issue_change_data.rb
+- lib/jirametrics/status.rb
+- lib/jirametrics/status_collection.rb
+- lib/jirametrics/story_point_accuracy_chart.rb
+- lib/jirametrics/throughput_chart.rb
+- lib/jirametrics/tree_organizer.rb
+- lib/jirametrics/trend_line_calculator.rb
+homepage: https://rubygems.org/gems/jirametrics
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Extract Jira metrics
+test_files: []