kanban_metrics 0.1.0

data/bin/kanban_metrics

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib' , __FILE__)
+require 'kanban_metrics'
+
+def optional_date_arg(argv)
+	argv ? Date.parse(argv) : nil
+end
+
+
+work_items = KanbanMetrics::CsvLoader.new.load(ARGV[1])
+
+if ARGV[0] == "cfd"
+	command = KanbanMetrics::Commands::Cfd.new
+	view = KanbanMetrics::Commands::CfdView.new
+elsif ARGV[0] == "io"
+	command = KanbanMetrics::Commands::Io.new
+	view = KanbanMetrics::Commands::IoView.new
+elsif ARGV[0] == "leadtime"
+	command = KanbanMetrics::Commands::Leadtime.new
+	view = KanbanMetrics::Commands::LeadtimeView.new
+end
+
+chart_data = command.execute(work_items, optional_date_arg(ARGV[2]), optional_date_arg(ARGV[3]))
+view.render(chart_data)

data/kanban_metrics.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'kanban_metrics/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'kanban_metrics'
+  s.version     = KanbanMetrics::VERSION
+  s.date        = '2013-09-09'
+  s.summary     = "kanban_metrics-#{s.version}"
+  s.description = "A simple tool for processing data from the Kanban board (in csv) and providing metrics"
+  s.authors     = ["Zsolt Fabok"]
+  s.email       = 'me@zsoltfabok.com'
+  s.homepage    = 'https://github.com/ZsoltFabok/kanban_metrics'
+  s.license     = 'GPLv3'
+
+  s.files         = `git ls-files`.split("\n").reject {|path| path =~ /\.gitignore$/ || path =~ /file$/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rspec', '~> 2.12')
+  s.add_development_dependency('turnip', '~> 1.1.0')
+  s.add_development_dependency('rake', '>= 10.0.3')
+  s.add_development_dependency('simplecov', '>= 0.7.1')
+end

data/lib/kanban_metrics.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+require 'csv'
+require 'kanban_metrics/work_item'
+require 'kanban_metrics/date_helper'
+require 'kanban_metrics/chart_data_helper'
+require 'kanban_metrics/csv_loader'
+require 'kanban_metrics/commands/cfd'
+require 'kanban_metrics/commands/cfd_view'
+require 'kanban_metrics/commands/io'
+require 'kanban_metrics/commands/io_view'
+require 'kanban_metrics/commands/leadtime'
+require 'kanban_metrics/commands/leadtime_view'

data/lib/kanban_metrics/chart_data_helper.rb

@@ -0,0 +1,11 @@
+module KanbanMetrics
+  class ChartDataHelper
+    def self.sort(chart_data)
+      ordered_chart_data = {}
+      chart_data.keys.sort.each do |key|
+        ordered_chart_data[key] = chart_data[key]
+      end
+      ordered_chart_data
+    end
+  end
+end

data/lib/kanban_metrics/commands/cfd.rb

@@ -0,0 +1,56 @@
+module KanbanMetrics
+	module Commands
+		class Cfd
+		  USED_ATTRIBUTES = [:committed, :started, :finished, :delivered]
+			def execute(work_items, start = nil, end_ = nil)
+				chart_data = create_empty_chart_data_with_all_the_dates(work_items)
+
+				work_items.each do |work_item|
+					USED_ATTRIBUTES.each_with_index do |attribute, index|
+						chart_data.keys.select {|date| attribute_lg_date?(work_item, attribute, date)}.each do |entry|
+							chart_data[entry][index] += 1
+						end
+					end
+				end
+
+				start = earliest_date(work_items) if start.nil?
+				end_ = latest_date(work_items) if end_.nil?
+				chart_data.select! do |date, values|
+						start <= date && date <= end_
+				end
+
+				ChartDataHelper.sort(chart_data)
+			end
+
+			private
+			def create_empty_chart_data_with_all_the_dates(work_items)
+				chart_data = {}
+				work_items.each do |work_item|
+					USED_ATTRIBUTES.each do |attribute|
+						date = work_item.send(attribute)
+						if date != nil && chart_data[date] == nil
+							chart_data[date] = [0, 0, 0, 0]
+						end
+					end
+				end
+				chart_data
+			end
+
+			def attribute_lg_date?(work_item, attribute, date)
+				work_item.send(attribute) && date >= work_item.send(attribute)
+			end
+
+			def earliest_date(work_items)
+				work_items.map {|work_item| work_item_dates(work_item)}.flatten.min
+			end
+
+			def latest_date(work_items)
+				work_items.map {|work_item| work_item_dates(work_item)}.flatten.max
+			end
+
+			def work_item_dates(work_item)
+				USED_ATTRIBUTES.map {|attribute| work_item.send(attribute)}.compact
+			end
+		end
+	end
+end

data/lib/kanban_metrics/commands/cfd_view.rb

@@ -0,0 +1,11 @@
+module KanbanMetrics
+	module Commands
+		class CfdView
+			def render(chart_data)
+				chart_data.each do |date, values|
+					puts "#{date},#{values.join(',')}"
+				end
+			end
+		end
+	end
+end

data/lib/kanban_metrics/commands/io.rb

@@ -0,0 +1,43 @@
+module KanbanMetrics
+	module Commands
+		class Io
+			def execute(work_items, start = nil, end_ = nil)
+				chart_data = {}
+				work_items.each do |work_item|
+					in_ = "#{work_item.started.year}-#{work_item.started.cweek}"
+					out = "#{work_item.delivered.year}-#{work_item.delivered.cweek}"
+					if chart_data[in_].nil?
+						chart_data[in_] = [0, 0]
+					end
+
+					if chart_data[out].nil?
+						chart_data[out] = [0, 0]
+					end
+
+					chart_data[in_][0] += 1
+					chart_data[out][1] += 1
+				end
+
+				start = earliest_started(work_items) if start.nil?
+				end_ = latest_delivered(work_items) if end_.nil?
+				start_cweek = "#{start.year}-#{start.cweek}"
+				end_cweek =  "#{end_.year}-#{end_.cweek}"
+
+				chart_data.select! do |date, values|
+						start_cweek <= date && date <= end_cweek
+				end
+
+				ChartDataHelper.sort(chart_data)
+			end
+
+			private
+			def earliest_started(work_items)
+				work_items.map {|work_item| work_item.started}.min
+			end
+
+			def latest_delivered(work_items)
+				work_items.map {|work_item| work_item.delivered}.max
+			end
+		end
+	end
+end

data/lib/kanban_metrics/commands/io_view.rb

@@ -0,0 +1,12 @@
+module KanbanMetrics
+	module Commands
+		class IoView
+			def render(chart_data)
+				puts "week, in, out"
+				chart_data.keys.each do |cweek|
+					puts "#{cweek},#{chart_data[cweek].join(',')}"
+				end
+			end
+		end
+	end
+end

data/lib/kanban_metrics/commands/leadtime.rb

@@ -0,0 +1,41 @@
+module KanbanMetrics
+	module Commands
+		class Leadtime
+			def execute(work_items, start = nil, end_ = nil)
+				chart_data = {}
+				start = earliest_committed(work_items) if start.nil?
+				end_ = latest_delivered(work_items) if end_.nil?
+				work_items.each do |work_item|
+					if work_item_finished?(work_item) && work_item_delivered_in_time_frame?(work_item, start, end_)
+						work_item_life_period = work_item.committed..work_item.delivered
+						lead_time = DateHelper.weekdays_in_date_range(work_item_life_period)
+
+						if chart_data[lead_time] == nil
+							chart_data[lead_time] = 0
+						end
+
+						chart_data[lead_time] += 1
+					end
+				end
+				ChartDataHelper.sort(chart_data)
+			end
+
+			private
+			def work_item_finished?(work_item)
+				work_item.committed && work_item.delivered
+			end
+
+			def work_item_delivered_in_time_frame?(work_item, start, end_)
+				start <= work_item.delivered && work_item.delivered <= end_
+			end
+
+			def earliest_committed(work_items)
+				work_items.map {|work_item| work_item.committed}.compact.min
+			end
+
+			def latest_delivered(work_items)
+				work_items.map {|work_item| work_item.delivered}.compact.max
+			end
+		end
+	end
+end

data/lib/kanban_metrics/commands/leadtime_view.rb

@@ -0,0 +1,11 @@
+module KanbanMetrics
+	module Commands
+		class LeadtimeView
+			def render(chart_data)
+				chart_data.keys.each do |lead_time|
+					puts "#{lead_time},#{chart_data[lead_time]}"
+				end
+			end
+		end
+	end
+end

data/lib/kanban_metrics/csv_loader.rb

@@ -0,0 +1,19 @@
+module KanbanMetrics
+  class CsvLoader
+  	def load(csv_file)
+  		work_items = []
+  		CSV.foreach(csv_file, {:force_quotes => true, :headers => true}) do |row|
+  			unless row.header_row?
+          data = {}
+          row.headers.each do |header|
+            if (row[header] && !row[header].empty?)
+              data[header.sub(" ", "_").to_sym] = row[header]
+            end
+          end
+  				work_items << WorkItem.new(data)
+        end
+  		end
+  		work_items
+  	end
+  end
+end

data/lib/kanban_metrics/date_helper.rb

@@ -0,0 +1,12 @@
+module KanbanMetrics
+  class DateHelper
+    def self.weekdays_in_date_range(range)
+      weekdays_only(range).size
+    end
+
+    private
+    def self.weekdays_only(range)
+      range.select { |d| (1..5).include?(d.wday) }
+    end
+  end
+end

data/lib/kanban_metrics/version.rb

@@ -0,0 +1,3 @@
+module KanbanMetrics
+  VERSION = '0.1.0'
+end

data/lib/kanban_metrics/work_item.rb

@@ -0,0 +1,23 @@
+require 'date'
+
+module KanbanMetrics
+  class WorkItem
+    attr_accessor :id, :committed, :started, :finished, :delivered, :type, :back_count, :estimated_time, :spent_time
+
+    def initialize(map)
+      map.each do |key, value|
+      	eval("@#{key}=\"#{value}\"")
+    		# this didn't work: eval("@#{key}=\"#{Date.parse(value)}\"")
+    		if key == :committed && @committed
+    			@committed = Date.parse(@committed)
+    		elsif key == :started && @started
+    			@started = Date.parse(@started)
+    		elsif key == :finished && @finished
+    			@finished = Date.parse(@finished)
+    		elsif key == :delivered && @delivered
+    			@delivered = Date.parse(@delivered)
+    		end
+      end
+    end
+  end
+end

data/spec/acceptance/command_line.feature

@@ -0,0 +1,119 @@
+Feature: command line
+  Background:
+    Given I delete "test.csv"
+
+  Scenario: generate cfd csv
+    Given the line in "test.csv" "id,committed,started,finished,delivered,type,back count,estimated time,spent time"
+      And the line in "test.csv" ",2011-05-26,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-24,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-30,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-25,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-23,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-31,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+     When I run the command "bin/kanban_metrics cfd test.csv"
+     Then I see "2011-05-23,1,0,0,0\n2011-05-24,7,0,0,0\n2011-05-25,8,0,0,0\n2011-05-26,9,4,4,4\n2011-05-27,9,6,6,6\n2011-05-30,10,8,8,8\n2011-05-31,11,11,11,11"
+
+  Scenario: generate cfd csv in a time window
+    Given the line in "test.csv" "id,committed,started,finished,delivered,type,back count,estimated time,spent time"
+      And the line in "test.csv" ",2011-05-26,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-24,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-30,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-25,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-23,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-31,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+     When I run the command "bin/kanban_metrics cfd test.csv 2011-05-26 2011-05-29"
+     Then I see "2011-05-26,9,4,4,4\n2011-05-27,9,6,6,6"
+
+  Scenario: generate cfd with partial data
+    Given the line in "test.csv" "id,committed,started,finished,delivered,type,back count,estimated time,spent time"
+      And the line in "test.csv" ",2011-05-26,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-24,2011-05-30,2011-05-30,"
+      And the line in "test.csv" ",2011-05-24,2011-05-31,2011-05-31,"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,,"
+      And the line in "test.csv" ",2011-05-30,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-24,,,"
+     When I run the command "bin/kanban_metrics cfd test.csv"
+     Then I see "2011-05-24,5,0,0,0\n2011-05-26,6,2,1,1\n2011-05-27,6,3,2,2\n2011-05-30,7,5,4,3\n2011-05-31,7,6,5,3"
+
+  Scenario: generate input output
+    Given the line in "test.csv" "id,committed,started,finished,delivered,type,back count,estimated time,spent time"
+      And the line in "test.csv" ",2011-05-26,2011-05-27,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-30,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-25,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-23,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-31,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+     When I run the command "bin/kanban_metrics io test.csv"
+     Then I see "week, in, out\n2011-21,6,5\n2011-22,5,6"
+
+  Scenario: generate input output in a time window
+    Given the line in "test.csv" "id,committed,started,finished,delivered,type,back count,estimated time,spent time"
+      And the line in "test.csv" ",2011-05-26,2011-05-27,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-30,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-25,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-23,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-31,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+     When I run the command "bin/kanban_metrics io test.csv 2011-05-07 2011-05-29"
+     Then I see "week, in, out\n2011-21,6,5"
+
+   Scenario: lead time histogram
+    Given the line in "test.csv" "id,committed,started,finished,delivered,type,back count,estimated time,spent time"
+      And the line in "test.csv" ",2011-05-26,2011-05-27,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-30,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-25,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-23,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-31,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+     When I run the command "bin/kanban_metrics leadtime test.csv"
+     Then I see "1,2\n3,4\n4,1\n5,3\n6,1"
+
+  Scenario: lead time histogram in a time window
+    Given the line in "test.csv" "id,committed,started,finished,delivered,type,back count,estimated time,spent time"
+      And the line in "test.csv" ",2011-05-26,2011-05-27,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-30,2011-05-30,2011-05-30,2011-05-30"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+      And the line in "test.csv" ",2011-05-25,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-23,2011-05-27,2011-05-27,2011-05-27"
+      And the line in "test.csv" ",2011-05-31,2011-05-31,2011-05-31,2011-05-31"
+      And the line in "test.csv" ",2011-05-24,2011-05-26,2011-05-26,2011-05-26"
+     When I run the command "bin/kanban_metrics leadtime test.csv 2011-05-07 2011-05-28"
+     Then I see "3,4\n5,1"
+
+   # Scenario: Little, stability, ageing
+
+   # Scenario: phase based cycle time distribution
+
+   # Scenario: flow efficiency
+
+   # Scenario: deadline (behind?)