defect-density-heatmap 0.0.1 → 0.0.2

data/lib/heatmap/version.rb

@@ -1,3 +1,3 @@
 module Heatmap
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/readme.markdown

@@ -0,0 +1,36 @@
+Defect Density Heatmap - Visualizing Code Churn
+-----------------------------------------------
+
+This is the defect density heatmap and it is used to identify files in your codebase that change often as a result of working on features and fixing defects. Before using the heatmap generator some background information is needed.
+
+In our day to day development efforts we often commit code to our repository and give it a commit message. What if we add an additional piece of information to our commit message, such as a discriminator, identifying whether this change was related to a feature or defect? It can be anything, like starting the commit message with an 'F' or 'D'. If you're in corporate IT, your auditors would love it if you put ticket numbers in your commits (such as FEA-1234, DEF-1234)
+
+Take a simple example:
+
+	# ListController.java, ColumnSorter.js, ListView.jsp, ListRepository.java
+	git commit -m 'f Adding clickable column headings for sorting'
+
+	# ListController.java, ColumnSorter.js
+	git commit -m 'd Prevented NPE when invalid product code filter entered'
+
+	# ListController.java, ListView.jsp
+	git commit -m 'd Fix spelling error'
+	
+This simple practice can give us some interesting insights into our code. Doing a bit of log crunching we can end up with a list of total changes and total defects a given file is associated with:
+
+	# change-data.csv
+	1,0,src/main/java/com/example/ListRepository.java
+	3,2,src/main/java/com/example/ListController.java
+	2,1,src/main/webapp/ListView.jsp
+	2,1,src/main/webapp/js/ColumnSorter.js
+	
+In this example, the first column is the total number of changes and the second column is the number of defects this file was involved with.
+
+Using the heatmap generator, we can create a tag cloud giving us a visualization of our code over time. The heatmap can be invoked in the usual ways:
+
+	cat change-data.csv | heatmap > results.html
+	heatmap -f change-data.csv -o results.html
+
+The command renders a tag cloud formatted as HTML. The larger the text, the more that source file has changed. The text color changes from black to red based on the ratio of defects to changes. The more defects, the more red you see. Big + Red = Bad
+
+![Heatmap Screenshot](./screenshot.png)

data/spec/example-data.csv

@@ -1,42 +1,42 @@
-21,21,src/main/java/com/example/File1.java
+21,15,src/main/java/com/example/File1.java
 8,2,src/main/java/com/example/File2.java
 3,0,src/main/java/com/example/File3.java
 23,10,src/main/java/com/example/File4.java
 22,17,src/main/java/com/example/File5.java
 21,13,src/main/java/com/example/File6.java
 20,12,src/main/java/com/example/File7.java
-16,16,src/main/java/com/example/File8.java
+16,8,src/main/java/com/example/File8.java
 20,12,src/main/java/com/example/File9.java
 15,9,src/main/java/com/example/File10.java
 3,1,src/main/java/com/example/File11.java
 3,3,src/main/java/com/example/File12.java
-11,11,src/main/java/com/example/File13.java
+11,1,src/main/java/com/example/File13.java
 9,7,src/main/java/com/example/File14.java
 9,6,src/main/java/com/example/File15.java
-15,11,src/main/java/com/example/File16.java
+15,1,src/main/java/com/example/File16.java
 4,4,src/main/java/com/example/File17.java
 2,0,src/main/java/com/example/File18.java
 20,20,src/main/java/com/example/File19.java
 4,0,src/main/java/com/example/File20.java
 1,0,src/main/java/com/example/File21.java
 11,0,src/main/java/com/example/File22.java
-21,11,src/main/java/com/example/File23.java
+21,6,src/main/java/com/example/File23.java
 8,5,src/main/java/com/example/File24.java
 20,2,src/main/java/com/example/File25.java
 11,8,src/main/java/com/example/File26.java
 1,0,src/main/java/com/example/File27.java
 22,14,src/main/java/com/example/File28.java
-22,16,src/main/java/com/example/File29.java
-17,10,src/main/java/com/example/File30.java
+22,0,src/main/java/com/example/File29.java
+17,5,src/main/java/com/example/File30.java
 17,8,src/main/java/com/example/File31.java
-24,16,src/main/java/com/example/File32.java
+24,7,src/main/java/com/example/File32.java
 8,4,src/main/java/com/example/File33.java
 9,0,src/main/java/com/example/File34.java
 1,0,src/main/java/com/example/File35.java
-14,8,src/main/java/com/example/File36.java
-12,6,src/main/java/com/example/File37.java
-24,6,src/main/java/com/example/File38.java
-11,10,src/main/java/com/example/File39.java
+14,1,src/main/java/com/example/File36.java
+12,3,src/main/java/com/example/File37.java
+24,5,src/main/java/com/example/File38.java
+11,2,src/main/java/com/example/File39.java
 8,4,src/main/java/com/example/File40.java
 10,10,src/main/java/com/example/File41.java
 19,4,src/main/java/com/example/File42.java

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defect-density-heatmap
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70219516054120 !ruby/object:Gem::Requirement
+  requirement: &70118248598580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70219516054120
+  version_requirements: *70118248598580
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70219516053700 !ruby/object:Gem::Requirement
+  requirement: &70118248598160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70219516053700
+  version_requirements: *70118248598160
 description: Generates a tag cloud based on project file churn.
 email:
 - bcarlso@gmail.com
@@ -52,6 +52,8 @@ files:
 - lib/heatmap.rb
 - lib/heatmap/version.rb
 - lib/heatmap_formatter.rb
+- readme.markdown
+- screenshot.png
 - spec/example-data.csv
 - spec/heatmap_formatter_spec.rb
 - spec/spec_helper.rb