jirametrics 1.0.0

data/lib/jirametrics/html/aging_work_bar_chart.erb

@@ -0,0 +1,72 @@
+<div>
+  <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
+</div>
+<script>
+new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
+{
+  type: 'bar',
+  data: {
+    datasets: <%= JSON.generate(data_sets) %>
+  },
+  options: {
+    responsive: <%= canvas_responsive? %>, // If responsive is true then it fills the screen
+    indexAxis: 'y', // Make the bars horizontal
+    scales: {
+      x: {
+        type: 'time',
+        min: '<%= @date_range.begin.to_s %>',
+        max: '<%= (@date_range.end ).to_s %>',
+        stacked: false,
+        title: {
+          display: false
+        }
+      },
+      y: {
+        stacked: true,
+        position: 'right',
+        ticks: {
+          display: true
+        }
+      }
+    },
+    plugins: {
+      annotation: {
+        annotations: {
+          <% holidays.each_with_index do |range, index| %>
+          holiday<%= index %>: {
+            drawTime: 'beforeDraw',
+            type: 'box',
+            xMin: '<%= range.begin %>T00:00:00',
+            xMax: '<%= range.end %>T23:59:59',
+            backgroundColor: '#F0F0F0',
+            borderColor: '#F0F0F0'
+          },
+          <% end %>
+
+          <% if percentage_line_x %>
+          line: {
+            type: 'line',
+            xMin: '<%= percentage_line_x %>',
+            xMax: '<%= percentage_line_x %>',
+            borderColor: 'red',
+            borderWidth: 1,
+            drawTime: 'afterDraw'
+          }
+          <% end %>
+        }
+      },
+      legend: {
+        display: false
+      },
+      tooltip: {
+        callbacks: {
+          label: function(context) {
+            return context.dataset.data[context.dataIndex].title
+          }
+        }
+      }
+    }
+  }
+});
+</script>
+

data/lib/jirametrics/html/aging_work_in_progress_chart.erb

@@ -0,0 +1,52 @@
+<div>
+  <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
+</div>
+<script>
+new Chart(document.getElementById(<%= chart_id.inspect %>).getContext('2d'),
+{
+  type: 'bar',
+  data: {
+    labels: [<%= column_headings.collect(&:inspect).join(',') %>],
+    datasets: <%= JSON.generate(data_sets) %>
+  },
+  options: {
+    title: {
+      display: true,
+      text:    "Aging work in progress"
+    },
+    responsive: <%= canvas_responsive? %>, // If responsive is true then it fills the screen
+    scales: {
+      x: {
+        scaleLabel: {
+          display: true,
+          labelString: 'Date Completed'
+        }
+      },
+      y: {
+        scaleLabel: {
+          display: true,
+          labelString: 'Days'
+        },
+        title: {
+          display: true,
+          text: 'Age in days'
+        },
+      }
+    },
+    plugins: {
+      tooltip: {
+        callbacks: {
+          label: function(context) {
+            if( typeof(context.dataset.data[context.dataIndex]) == "number" ) {
+              return "85% of the issues, leave this column in "+context.dataset.data[context.dataIndex]+" days";
+            }
+            else {
+              return context.dataset.data[context.dataIndex].title
+            }
+          }
+        }
+      }
+    }
+  }
+});
+</script>

data/lib/jirametrics/html/aging_work_table.erb

@@ -0,0 +1,60 @@
+<h1>Aging Work Table</h1>
+<p>
+  This chart shows all active (started but not completed) work, ordered from oldest at the top to 
+  newest at the bottom.
+</p>
+<p>
+  If there are expedited items that haven't yet started then they're at the bottom of the table. By the
+  very definition of expedited, if we haven't started them already, we'd better get on that.
+</p>
+<p>
+  <% if age_cutoff > 0 %>
+    Items less than <%= label_days age_cutoff %> old have been excluded from this chart to provide more
+    focus on the older items. The exception are items that are either expedited or blocked - these are
+    shown no matter how old they are.
+  <% end %>
+</p>
+
+<table class='standard'>
+  <thead>
+    <tr>
+      <th>Age (days)</th>
+      <th>E</th>
+      <th>B</th>
+      <th>Issue</th>
+      <th>Status</th>
+      <th>Fix versions</th>
+      <% if any_scrum_boards? %>
+        <th>Sprints</th>
+      <% end %>
+      <th><%= aggregated_project? ? 'Board' : 'Who' %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% aging_issues.each do |issue| %>
+      <tr>
+        <td style="text-align: right;"><%= issue.board.cycletime.age(issue, today: @today) || 'Not started' %></td>
+        <td><%= expedited_text(issue) %></td>
+        <td><%= blocked_text(issue) %></td>
+        <td>
+          <% parent_hierarchy(issue).each_with_index do |parent, index| %>
+            <% color = (parent == issue ? 'black' : 'gray') %>
+            <div style="padding-left: <%= index %>em; color: <%= color %>">
+              <span style="white-space: nowrap;">
+                <img src="<%= parent.type_icon_url %>" title="<%= parent.type %>"/>
+                <%= link_to_issue parent, style: "color: #{color}" %>
+              </span>
+              <i><%= parent.summary.strip.inspect %></i>
+            </div>
+          <% end %>
+        </td>
+        <td><%= format_status issue.status.name, board: issue.board %><%= unmapped_status_text(issue) unless current_status_visible? issue %></td>
+        <td><%= fix_versions_text(issue) %></td>
+        <% if any_scrum_boards? %>
+          <td><%= sprints_text(issue) %></td>
+        <% end %>
+        <td><%= aggregated_project? ? issue.board.name : issue.assigned_to %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/jirametrics/html/collapsible_issues_panel.erb

@@ -0,0 +1,32 @@
+[<a id='<%= link_id %>' href="#" onclick='expand_collapse("<%= link_id %>", "<%= issues_id %>"); return false;'>Show details</a>]
+<table class='standard' id='<%= issues_id %>' style='display: none;'>
+  <thead>
+    <tr>
+      <th>Issue</th>
+      <th>Type</th>
+      <th>Summary</th>
+      <th>Description</th>
+      <% unless args.include? :hide_board_column %>
+        <th>Board</th>
+      <% end %>
+
+    </tr>
+  </thead>
+  <tbody>
+    <% issue_descriptions.each do |issue, description, problem_key| %>
+      <tr>
+        <td><%= link_to_issue issue %>
+          <% if aggregated_project? %>
+            <br /><span style="font-size: 0.8em; font-style: italic;"><%= issue.board.name %></span>
+          <% end %>
+        </td>
+        <td><img src="<%= issue.type_icon_url %>" />&nbsp;<%= issue.type %></td>
+        <td><i><%= issue.summary.inspect %></i></td>
+        <td><%= description %></td>
+        <% unless args.include? :hide_board_column %>
+          <td><%= issue.board.name %></td>
+        <% end %>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/lib/jirametrics/html/cycletime_histogram.erb

@@ -0,0 +1,41 @@
+<div>
+  <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
+</div>
+<script>
+new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
+{
+  type: 'bar',
+  data: {
+    datasets: <%= JSON.generate(data_sets) %>
+  },
+  options: {
+    responsive: <%= canvas_responsive? %>, // If responsive is true then it fills the screen
+    scales: {
+      x: {
+        type: 'linear',
+        stacked: true,
+        title: {
+          display: true,
+          text: 'Cycletime in days'
+        }
+      },
+      y: {
+        stacked: true,
+        title: {
+          display: true,
+          text: 'Number of items that had that cycletime'
+        }
+      }
+    },
+    plugins: {
+      tooltip: {
+        callbacks: {
+          label: function(context) {
+            return context.dataset.data[context.dataIndex].title
+          }
+        }
+      }
+    }
+  }
+});
+</script>

data/lib/jirametrics/html/cycletime_scatterplot.erb

@@ -0,0 +1,103 @@
+<div>
+  <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
+</div>
+<script>
+new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
+  type: 'scatter',
+  data: {
+    datasets: <%= JSON.generate(data_sets) %>
+  },
+  options: {
+    title: {
+      display: true,
+      text: "Cycletime Scatterplot"
+    },
+    responsive: <%= canvas_responsive? %>, // If responsive is true then it fills the screen
+    scales: {
+      x: {
+        type: "time",
+        scaleLabel: {
+          display: true,
+          labelString: 'Date Completed'
+        },
+        min: "<%= date_range.begin.to_s %>",
+        max: "<%= (date_range.end + 1).to_s %>"
+      },
+      y: {
+        scaleLabel: {
+          display: true,
+          labelString: 'Days',
+          min: 0,
+          max: <%= @highest_cycletime %>
+        },
+        title: {
+          display: true,
+          text: 'Cycle time in days'
+        },
+      }
+    },
+    plugins: {
+      tooltip: {
+        callbacks: {
+          label: function(context) {
+            return context.dataset.data[context.dataIndex].title
+          }
+        }
+      },
+      autocolors: false,
+      annotation: {
+        annotations: {
+          <% holidays.each_with_index do |range, index| %>
+          holiday<%= index %>: {
+            drawTime: 'beforeDraw',
+            type: 'box',
+            xMin: '<%= range.begin %>T00:00:00',
+            xMax: '<%= range.end %>T23:59:59',
+            backgroundColor: '#F0F0F0',
+            borderColor: '#F0F0F0'
+          },
+          <% end %>
+
+          <% @percentage_lines.each_with_index do |args, index| %>
+          <%   percent, color = args %>
+          line<%= index %>: {
+            type: 'line',
+            yMin: <%= percent %>,
+            yMax: <%= percent %>,
+            borderColor: '<%= color %>',
+            borderWidth: 1,
+            drawTime: 'beforeDraw'
+          },
+          <% end %>
+        }
+      },
+      legend: {
+        onClick: (evt, legendItem, legend) => {
+          // Find the datasetMeta that corresponds to the item clicked
+          var i = 0
+          while(legendItem.text != legend.chart.getDatasetMeta(i).label) {
+            i++;
+          }
+          nextVisibility = !!legend.chart.getDatasetMeta(i).hidden;
+
+          // Hide/show the 85% line for that dataset
+          legend.chart.options.plugins.annotation.annotations["line"+(i/2)].display = nextVisibility;
+
+          // Hide/show the trendline for this dataset, if they were enabled. The trendline is always
+          // there but not always visible.
+          legend.chart.setDatasetVisibility(i+1, <%= !!@show_trend_lines %> && nextVisibility);
+
+          // Still run the default behaviour
+          Chart.defaults.plugins.legend.onClick(evt, legendItem, legend);
+        },
+        labels: {
+          filter: function(item, chart) {
+            // Logic to remove a particular legend item goes here
+            return !item.text.includes('Trendline');
+          }
+        }
+      }
+    }
+  }
+});
+</script>

data/lib/jirametrics/html/daily_wip_chart.erb

@@ -0,0 +1,63 @@
+<div>
+  <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
+</div>
+<script>
+new Chart(document.getElementById('<%= chart_id %>').getContext('2d'),
+{
+  type: 'bar',
+  data: {
+    datasets: <%= JSON.generate(data_sets) %>
+  },
+  options: {
+    title: {
+      display: true,
+      text:    "Work that is blocked or stalled"
+    },
+    responsive: true, // If responsive is true then it fills the screen
+    scales: {
+      x: {
+        type: 'time',
+        time: {
+          unit: 'day'
+        },
+        stacked: true
+      },
+      y: {
+        stacked: true,
+        scaleLabel: {
+          display: true,
+          labelString: 'WIP'
+        },
+        title: {
+          display: true,
+          text: 'Count of items'
+        },
+
+      }
+    },
+    plugins: {
+      tooltip: {
+        callbacks: {
+          label: function(context) {
+            return context.dataset.data[context.dataIndex].title
+          }
+        }
+      },
+      annotation: {
+        annotations: {
+          <% holidays.each_with_index do |range, index| %>
+          holiday<%= index %>: {
+            drawTime: 'beforeDraw',
+            type: 'box',
+            xMin: '<%= range.begin %>T00:00:00',
+            xMax: '<%= range.end %>T23:59:59',
+            backgroundColor: '#F0F0F0',
+            borderColor: '#F0F0F0'
+          },
+          <% end %>
+        }
+      }
+    }
+  }
+});
+</script>

data/lib/jirametrics/html/data_quality_report.erb

@@ -0,0 +1,126 @@
+<% 
+  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
+%>

data/lib/jirametrics/html/expedited_chart.erb

@@ -0,0 +1,67 @@
+<div>
+  <canvas id="<%= chart_id %>" width="<%= canvas_width %>" height="<%= canvas_height %>"></canvas>
+</div>
+<script>
+const expedited = (ctx, value) => ctx.p0.raw.expedited == 1 ? value : undefined;
+const notExpedited = (ctx, value) => ctx.p0.raw.expedited == 0 ? value : undefined;
+
+new Chart(document.getElementById('<%= chart_id %>').getContext('2d'), {
+  type: 'scatter',
+  data: {
+    datasets: <%= JSON.generate(data_sets) %>
+  },
+  options: {
+    title: {
+      display: true,
+      text: "Cycletime Scatterplot"
+    },
+    responsive: <%= canvas_responsive? %>, // If responsive is true then it fills the screen
+    scales: {
+      x: {
+        type: "time",
+        scaleLabel: {
+          display: true,
+          labelString: 'Date Completed'
+        },
+        min: "<%= date_range.begin.to_s %>",
+        max: "<%= date_range.end.to_s %>"
+      },
+      y: {
+        scaleLabel: {
+          display: true,
+          labelString: 'Days'
+        },
+        title: {
+          display: true,
+          text: 'Age in days'
+        },        
+        min: 0
+      }
+    },
+    plugins: {
+      tooltip: {
+        callbacks: {
+          label: function(context) {
+            return context.dataset.data[context.dataIndex].title
+          }
+        }
+      },
+      autocolors: false,
+      annotation: {
+        annotations: {
+          <% holidays.each_with_index do |range, index| %>
+          holiday<%= index %>: {
+            drawTime: 'beforeDraw',
+            type: 'box',
+            xMin: '<%= range.begin %>T00:00:00',
+            xMax: '<%= range.end %>T23:59:59',
+            backgroundColor: '#F0F0F0',
+            borderColor: '#F0F0F0'
+          },
+          <% end %>
+        }
+      }
+    }
+  }
+});
+</script>

data/lib/jirametrics/html/hierarchy_table.erb

@@ -0,0 +1,29 @@
+
+<table class='standard'>
+  <thead>
+    <tr>
+      <th>Age (days)</th>
+      <th>Issue</th>
+      <th>Summary</th>
+      <th>Status</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% tree_organizer.flattened_nodes.each do |node, depth| %>
+      <% issue = node.issue %>
+      <tr>
+        <td style="text-align: right;"><%= issue.board.cycletime.age(issue, today: @today) || 'Not started' %></td>
+        <td>
+          <% color = (node.children? ? 'gray' : 'black') %>
+          <span style="padding-left: <%= depth - 1 %>em;" />
+          <span style="white-space: nowrap;">
+            <img src="<%= issue.type_icon_url %>" title="<%= issue.type %>"/>
+            <%= link_to_issue issue, style: "color: #{color}" %>
+          </span>
+        </td>
+        <td><span style="color: <%= color %>; font-style: italic;"><%= issue.summary[0..80] %></span></td>
+        <td><%= format_status issue.status.name, board: issue.board %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>