jirametrics 2.0 → 2.11

data/lib/jirametrics/experimental/generator.rb

@@ -1,210 +0,0 @@
-# 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).cover? 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.match?(/-\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
-
-    possible_capacities = [0, 1, 1, 1, 2]
-    @workers.each do |worker|
-      worker_capacity = possible_capacities.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

@@ -1,77 +0,0 @@
-# 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.match?(/^#{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/html/data_quality_report.erb

@@ -1,126 +0,0 @@
-<% 
-  problems = problems_for :discarded_changes
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> have had information discarded. This configuration is set
-    to "reset the clock" if an item is moved back to the backlog after it's been started. This hides important
-    information and makes the data less accurate. <b>Moving items back to the backlog is strongly discouraged.</b>
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :completed_but_not_started
-  unless problems.empty?
-    percentage_work_included = ((issues.size - problems.size).to_f / issues.size * 100).to_i
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were discarded from all charts using cycletime (scatterplot, histogram, etc) as we couldn't determine when they started. 
-    <% if percentage_work_included < 85 %>
-      Consider whether looking at only <%= percentage_work_included %>% of the total data points is enough to come to any reasonable conclusions. See <a href="https://en.wikipedia.org/wiki/Survivorship_bias">Survivorship Bias</a>.
-    <% end %>
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :status_changes_after_done
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> had a status change after being identified as done. We should question whether they were really done at that point or if we stopped the clock too early.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :backwards_through_status_categories
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> moved backwards across the board, <b>crossing status categories</b>. This will almost certainly have impacted timings as the end times are often taken at status category boundaries. You should assume that any timing measurements for this item are wrong.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :backwords_through_statuses
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> moved backwards across the board. Depending where we have set the start and end points, this may give us incorrect timing data. Note that these items did not cross a status category and may not have affected metrics.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :status_not_on_board
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were not visible on the board for some period of time. This may impact timings as the work was likely to have been forgotten if it wasn't visible.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :created_in_wrong_status
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were created in a status not designated as Backlog. This will impact the measurement of start times and will therefore impact whether it's shown as in progress or not.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :stopped_before_started
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> were stopped before they were started and this will play havoc with any cycletime or WIP calculations. The most common case for this is when an item gets closed and then moved back into an in-progress status.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :issue_not_started_but_subtasks_have
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> <%= label_issues problems.size %> still showing 'not started' while sub-tasks underneath them have started. This is almost always a mistake; if we're working on subtasks, the top level
-    item should also have started.
-    <%= collapsible_issues_panel problems %>
-  </p>
-<% 
-  end
-%>
-
-<% 
-  problems = problems_for :issue_on_multiple_boards
-  unless problems.empty? 
-%>
-  <p>
-    <span class="quality_note_bullet">⮕</span> For <%= label_issues problems.size %>, we have an issue that shows up on more than one board. This could result in more data points showing up on a chart then there really should be.
-    <%= collapsible_issues_panel problems, :hide_board_column %>
-  </p>
-<% 
-  end
-%>