jirametrics 1.0.0

data/lib/jirametrics/experimental/generator.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+require 'random-word'
+require 'require_all'
+require_all 'lib'
+
+def to_time date
+  Time.new date.year, date.month, date.day, rand(0..23), rand(0..59), rand(0..59)
+end
+
+class FakeIssue
+  @@issue_number = 1
+  attr_reader :effort, :raw, :worker
+
+  def initialize date:, type:, worker:
+    @raw = {
+      key: "FAKE-#{@@issue_number += 1}",
+      changelog: {
+        histories: []
+      },
+      fields: {
+        created: to_time(date),
+        updated: to_time(date),
+        creator: {
+          displayName: 'George Jetson'
+        },
+        issuetype: {
+          name: type
+        },
+        status: {
+          name: 'To Do',
+          id: 1,
+          statusCategory: {
+            id: 2,
+            name: 'To Do'
+          }
+        },
+        priority: {
+          name: ''
+        },
+        summary: RandomWord.phrases.next.gsub(/_/, ' '),
+        issuelinks: [],
+        fixVersions: []
+      }
+    }
+
+    @workers = [worker]
+    @effort = case type
+    when 'Story'
+      [1, 2, 3, 3, 3, 3, 4, 4, 4, 5, 6].sample
+    else
+      [1, 2, 3].sample
+    end
+    unblock
+    @done = false
+    @last_status = 'To Do'
+    @last_status_id = 1
+    change_status new_status: 'In Progress', new_status_id: 3, date: date
+  end
+
+  def blocked? = @blocked
+  def block = @blocked = true
+  def unblock = @blocked = false
+
+  def key = @raw[:key]
+
+  def do_work date:, effort:
+    raise 'Already done' if done?
+
+    @effort -= effort
+    return unless done?
+
+    change_status new_status: 'Done', new_status_id: 5, date: date
+    # fix_change_timestamps
+  end
+
+  def fix_change_timestamps
+    # since the timestamps have random hours, it's possible for them to be issued out of order. Sort them now
+    changes = @raw[:changelog][:histories]
+    times = [@raw[:fields][:created]] + changes.collect { |change| change[:created] }
+    times.sort!
+
+    @raw[:fields][:created] = times.shift
+    @raw[:fields][:updated] = times[-1]
+    changes.each do |change|
+      change[:created] = times.shift
+    end
+  end
+
+  def done? = @effort <= 0
+
+  def change_status date:, new_status:, new_status_id:
+    @raw[:changelog][:histories] << {
+      author: {
+        emailAddress: 'george@jetson.com',
+        displayName: 'George Jetson'
+      },
+      created: to_time(date),
+      items: [
+        {
+          field: 'status',
+          fieldtype: 'jira',
+          fieldId: 'status',
+          from: @last_status_id,
+          fromString: @last_status,
+          to: new_status_id,
+          toString: new_status
+        }
+      ]
+    }
+
+    @last_status = new_status
+    @last_status_id = new_status_id
+  end
+end
+
+class Worker
+  attr_accessor :issue
+end
+
+class Generator
+  def initialize
+    @random = Random.new
+    @file_prefix = 'fake'
+    @target_path = 'target/'
+
+    # @probability_work_will_be_pushed = 20
+    @probability_unblocked_work_becomes_blocked = 20
+    @probability_blocked_work_becomes_unblocked = 20
+    @date_range = (Date.today - 500)..Date.today
+    @issues = []
+    @workers = []
+    5.times { @workers << Worker.new }
+  end
+
+  def run
+    remove_old_files
+    @date_range.each_with_index do |date, day|
+      yield date, day if block_given?
+      process_date(date, day) if (1..5).include? date.wday # Weekday
+    end
+
+    @issues.each do |issue|
+      issue.fix_change_timestamps
+      File.open "target/fake_issues/#{issue.key}.json", 'w' do |file|
+        file.puts JSON.pretty_generate(issue.raw)
+      end
+    end
+
+    File.write 'target/fake_meta.json', JSON.pretty_generate({
+      time_start: (@date_range.end - 90).to_time,
+      time_end: @date_range.end.to_time,
+      'no-download': true
+    })
+    puts "Created #{@issues.size} fake issues"
+  end
+
+  def remove_old_files
+    path = "#{@target_path}#{@file_prefix}_issues"
+    Dir.foreach path do |file|
+      next unless file =~ /-\d+\.json$/
+
+      filename = "#{path}/#{file}"
+      File.unlink filename
+    end
+  end
+
+  def lucky? probability
+    @random.rand(1..100) <= probability
+  end
+
+  def next_issue_for worker:, date:, type:
+    # First look for something I already started
+    issue = @issues.find { |i| i.worker == worker && !i.done? && !i.blocked? }
+
+    # Then look for something that someone else started
+    issue = @issues.find { |i| i.worker != worker && !i.done? && !i.blocked? } if issue.nil? && lucky?(40)
+
+    # Then start new work
+    issue = FakeIssue.new(date: date, type: type, worker: worker) if issue.nil?
+
+    issue
+  end
+
+  def process_date date, _simulation_day
+    @issues.each do |issue|
+      if issue.blocked?
+        issue.unblock if lucky? @probability_blocked_work_becomes_unblocked
+      elsif lucky? @probability_unblocked_work_becomes_blocked
+        issue.block
+      end
+    end
+
+    @workers.each do |worker|
+      worker_capacity = [0, 1, 1, 1, 2].sample
+      if worker.issue.nil? || worker.issue.done?
+        type = lucky?(89) ? 'Story' : 'Bug'
+        worker.issue = next_issue_for worker: worker, date: date, type: type
+        @issues << worker.issue
+      end
+
+      worker.issue = next_issue_for worker: worker, date: date, type: type if worker.issue.blocked?
+      worker.issue.do_work date: date, effort: worker_capacity
+      worker.issue = nil if worker.issue.done?
+    end
+  end
+end
+
+Generator.new.run if __FILE__ == $PROGRAM_NAME

data/lib/jirametrics/experimental/info.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'require_all'
+require_all 'lib'
+
+class InfoDumper
+  def initialize
+    @target_dir = 'target/'
+  end
+
+  def run key
+    find_file_prefixes.each do |prefix|
+      path = "#{@target_dir}#{prefix}_issues/#{key}.json"
+      path = "#{@target_dir}#{prefix}_issues"
+      Dir.foreach path do |file|
+        if file =~ /^#{key}.+\.json$/
+          issue = Issue.new raw: JSON.parse(File.read(File.join(path, file))), board: nil
+          dump issue
+        end
+      end
+    end
+  end
+
+  def find_file_prefixes
+    prefixes = []
+    Dir.foreach @target_dir do |file|
+      prefixes << $1 if file =~ /^(.+)_issues$/
+    end
+    prefixes
+  end
+
+  def dump issue
+    puts "#{issue.key} (#{issue.type}): #{compact_text issue.summary, 200}"
+
+    assignee = issue.raw['fields']['assignee']
+    puts "  [assignee] #{assignee['name'].inspect} <#{assignee['emailAddress']}>" unless assignee.nil?
+
+    issue.raw['fields']['issuelinks'].each do |link|
+      puts "  [link] #{link['type']['outward']} #{link['outwardIssue']['key']}" if link['outwardIssue']
+      puts "  [link] #{link['type']['inward']} #{link['inwardIssue']['key']}" if link['inwardIssue']
+    end
+    issue.changes.each do |change|
+      value = change.value
+      old_value = change.old_value
+
+      # Description fields get pretty verbose so reduce the clutter
+      if change.field == 'description' || change.field == 'summary'
+        value = compact_text value
+        old_value = compact_text old_value
+      end
+
+      author = change.author
+      author = "(#{author})" if author
+      message = "  [change] #{change.time} [#{change.field}] "
+      message << "#{compact_text(old_value).inspect} -> " unless old_value.nil? || old_value.empty?
+      message << compact_text(value).inspect
+      message << " #{author}" if author
+      message << ' <<artificial entry>>' if change.artificial?
+      puts message
+    end
+    puts ''
+  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
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ARGV.each do |key|
+    InfoDumper.new.run key
+  end
+end

data/lib/jirametrics/exporter.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+class Object
+  def deprecated message:, date: nil
+    text = String.new
+    text << 'Deprecated'
+    text << "(#{date})"
+    text << ': '
+    text << message
+    text << "\n-> Called from #{caller[0]}"
+    warn text
+  end
+
+  def assert_jira_behaviour_true condition, &block
+    block.call if ENV['RACK_ENV'] == 'test' # Always expand the block if we're running in a test
+    failed_jira_behaviour(block) unless condition
+  end
+
+  def assert_jira_behaviour_false condition, &block
+    block.call if ENV['RACK_ENV'] == 'test' # Always expand the block if we're running in a test
+    failed_jira_behaviour(block) if condition
+  end
+
+  def failed_jira_behaviour block
+    text = String.new
+    text << 'Jira not doing what we expected. Results may be incorrect: '
+    text << block.call
+    text << "\n-> Called from #{caller[1]}"
+    warn text
+  end
+end
+
+class Exporter
+  attr_reader :project_configs
+
+  def self.configure &block
+    exporter = Exporter.new
+    exporter.instance_eval(&block)
+    @@instance = exporter
+  end
+
+  def self.instance = @@instance
+
+  def initialize
+    @project_configs = []
+    @timezone_offset = '+00:00'
+    @target_path = '.'
+    @holiday_dates = []
+    @downloading = false
+  end
+
+  def export
+    @project_configs.each do |project|
+      project.evaluate_next_level
+      project.run
+    end
+  end
+
+  def download
+    @downloading = true
+    logfile_name = 'downloader.log'
+    File.open logfile_name, 'w' do |logfile|
+      @project_configs.each do |project|
+        project.evaluate_next_level
+        next if project.aggregated_project?
+
+        project.download_config.run
+        downloader = Downloader.new(download_config: project.download_config)
+        downloader.logfile = logfile
+        downloader.logfile_name = logfile_name
+        downloader.run
+      end
+    end
+    puts "Full output from downloader in #{logfile_name}"
+  end
+
+  def downloading?
+    @downloading
+  end
+
+  def project name: nil, &block
+    raise 'target_path was never set!' if @target_path.nil?
+    raise 'jira_config not set' if @jira_config.nil?
+
+    @project_configs << ProjectConfig.new(
+      exporter: self, target_path: @target_path, jira_config: @jira_config, block: block, name: name
+    )
+  end
+
+  def xproject *args; end
+
+  def target_path path = nil
+    unless path.nil?
+      @target_path = path
+      @target_path += File::SEPARATOR unless @target_path.end_with? File::SEPARATOR
+      FileUtils.mkdir_p @target_path
+    end
+    @target_path
+  end
+
+  def jira_config filename = nil
+    @jira_config = JsonFileLoader.new.load(filename) unless filename.nil?
+    @jira_config
+  end
+
+  def timezone_offset offset = nil
+    @timezone_offset = offset unless offset.nil?
+    @timezone_offset
+  end
+
+  def holiday_dates *args
+    unless args.empty?
+      dates = []
+      args.each do |arg|
+        if arg =~ /^(\d{4}-\d{2}-\d{2})\.\.(\d{4}-\d{2}-\d{2})$/
+          Date.parse($1).upto(Date.parse($2)).each { |date| dates << date }
+        else
+          dates << Date.parse(arg)
+        end
+      end
+      @holiday_dates = dates
+    end
+    @holiday_dates
+  end
+end

data/lib/jirametrics/file_config.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+class FileConfig
+  attr_reader :project_config, :issues
+
+  def initialize project_config:, block:
+    @project_config = project_config
+    @block = block
+    @columns = nil
+  end
+
+  def run
+    @issues = project_config.issues.dup
+    instance_eval(&@block)
+
+    if @columns
+      all_lines = prepare_grid
+
+      File.open(output_filename, 'w') do |file|
+        all_lines.each do |output_line|
+          file.puts CSV.generate_line(output_line)
+        end
+      end
+    elsif @html_report
+      @html_report.run
+    else
+      raise 'Must specify one of "columns" or "html_report"'
+    end
+  end
+
+  def prepare_grid
+    @columns.run
+
+    all_lines = issues.collect do |issue|
+      line = []
+      @columns.columns.each do |type, _name, block|
+        # Invoke the block that will retrieve the result from Issue
+        result = instance_exec(issue, &block)
+        # Convert that result to the appropriate type
+        line << __send__(:"to_#{type}", result)
+      end
+      line
+    end
+
+    all_lines = all_lines.select(&@only_use_row_if) if @only_use_row_if
+    all_lines = sort_output(all_lines)
+
+    if @columns.write_headers
+      line = @columns.columns.collect { |_type, label, _proc| label }
+      all_lines.insert 0, line
+    end
+
+    all_lines
+  end
+
+  def output_filename
+    segments = []
+    segments << project_config.target_path
+    segments << project_config.file_prefix
+    segments << (@file_suffix || "-#{Date.today}.csv")
+    segments.join
+  end
+
+  # We'll probably make sorting configurable at some point but for now it's hard coded for our
+  # most common usecase - the Team Dashboard from FocusedObjective.com. The rule for that one
+  # is that all empty values in the first column should be at the bottom.
+  def sort_output all_lines
+    all_lines.sort do |a, b|
+      if a[0].nil?
+        1
+      elsif b[0].nil?
+        -1
+      else
+        a[0] <=> b[0]
+      end
+    end
+  end
+
+  def columns &block
+    assert_only_one_filetype_config_set
+    @columns = ColumnsConfig.new file_config: self, block: block
+  end
+
+  def html_report &block
+    assert_only_one_filetype_config_set
+    @html_report = HtmlReportConfig.new file_config: self, block: block
+  end
+
+  def assert_only_one_filetype_config_set
+    raise 'Can only have one columns or html_report declaration inside a file' if @columns || @html_report
+  end
+
+  def only_use_row_if &block
+    @only_use_row_if = block
+  end
+
+  def to_date object
+    to_datetime(object)&.to_date
+  end
+
+  def to_datetime object
+    return nil if object.nil?
+
+    object = object.to_datetime
+    object = object.new_offset(@timezone_offset) if @timezone_offset
+    object
+  end
+
+  def to_string object
+    object.to_s
+  end
+
+  def file_suffix suffix = nil
+    @file_suffix = suffix unless suffix.nil?
+    @file_suffix
+  end
+end

data/lib/jirametrics/fix_version.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class FixVersion
+  attr_reader :raw
+
+  def initialize raw
+    @raw = raw
+  end
+
+  def name
+    @raw['name']
+  end
+
+  def id
+    @raw['id'].to_i
+  end
+
+  def released?
+    @raw['released']
+  end
+end

data/lib/jirametrics/groupable_issue_chart.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'jirametrics/rules'
+require 'jirametrics/grouping_rules'
+
+module GroupableIssueChart
+  def init_configuration_block user_provided_block, &default_block
+    # The user provided a block but it's using the old deprecated style
+    if user_provided_block && user_provided_block.arity == 1
+      deprecated date: '2022-10-02', message: "#{self.class}: Use the new grouping_rules syntax"
+      grouping_rules do |issue, rules|
+        rules.label, rules.color = user_provided_block.call(issue)
+      end
+      return
+    end
+
+    if user_provided_block
+      instance_eval(&user_provided_block)
+      return if @group_by_block
+    end
+
+    instance_eval(&default_block)
+  end
+
+  def grouping_rules &block
+    @group_by_block = block
+  end
+
+  def group_issues completed_issues
+    result = {}
+    completed_issues.each do |issue|
+      rules = GroupingRules.new
+      @group_by_block.call(issue, rules)
+      next if rules.ignored?
+
+      (result[rules] ||= []) << issue
+    end
+
+    result.each_key do |rules|
+      rules.color = random_color if rules.color.nil?
+    end
+    result
+  end
+end

data/lib/jirametrics/grouping_rules.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class GroupingRules < Rules
+  attr_accessor :label, :color
+
+  def eql? other
+    other.label == @label && other.color == @color
+  end
+
+  def group
+    [@label, @color]
+  end
+end

data/lib/jirametrics/hierarchy_table.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'jirametrics/chart_base'
+
+class HierarchyTable < ChartBase
+  def initialize block = nil
+    super()
+
+    header_text 'Hierarchy Table'
+    description_text <<-HTML
+      <p>content goes here</p>
+    HTML
+
+    instance_eval(&block) if block
+  end
+
+  def run
+    tree_organizer = TreeOrganizer.new issues: @issues
+    unless tree_organizer.cyclical_links.empty?
+      message = String.new
+      message << '<p>Found cyclical links in the parent hierarchy. This is an error and should be '
+      message << 'fixed.</p><ul>'
+      tree_organizer.cyclical_links.each do |link|
+        message << '<li>' << link.join(' > ') << '</ul>'
+      end
+      message << '</ul>'
+      @description_text += message
+    end
+    wrap_and_render(binding, __FILE__)
+  end
+end