defect-density-heatmap 0.0.3 → 0.0.4

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defect-density-heatmap
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-04 00:00:00.000000000Z
+date: 2011-10-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70110389272640 !ruby/object:Gem::Requirement
+  requirement: &70143080302440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70110389272640
+  version_requirements: *70143080302440
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70110389272220 !ruby/object:Gem::Requirement
+  requirement: &70143080302020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,31 +32,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70110389272220
+  version_requirements: *70143080302020
 description: Generates a tag cloud based on project file churn.
 email:
 - bcarlso@gmail.com
-executables:
-- heatmap
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- Guardfile
-- Rakefile
-- bin/heatmap
-- defect-density-heatmap.gemspec
-- lib/command_line_runner.rb
-- lib/defect-density-heatmap.rb
-- 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
+- heatmap
 homepage: http://github.com/bcarlso/defect-density-heatmap
 licenses: []
 post_install_message: 
@@ -81,7 +65,4 @@ rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Generates a 'heatmap' from files changed in the SCM system.
-test_files:
-- spec/example-data.csv
-- spec/heatmap_formatter_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.gitignore

@@ -1,4 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in defect-density-heatmap.gemspec
-gemspec

data/Guardfile

@@ -1,8 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec', :version => 2 do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end

data/Rakefile

@@ -1,7 +0,0 @@
-require "bundler/gem_tasks"
-
-desc "Run all specs"
-Spec::Rake::SpecTask.new(:spec) do |t|
-  t.spec_files = FileList['spec/**/*_spec.rb']
-  t.spec_opts = ['--color']
-end

data/defect-density-heatmap.gemspec

@@ -1,25 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "heatmap/version"
-
-Gem::Specification.new do |s|
-  s.name        = "defect-density-heatmap"
-  s.version     = Heatmap::VERSION
-  s.authors     = ["Brandon Carlson"]
-  s.email       = ["bcarlso@gmail.com"]
-  s.homepage    = "http://github.com/bcarlso/defect-density-heatmap"
-  s.summary     = %q{Generates a 'heatmap' from files changed in the SCM system.}
-  s.description = %q{Generates a tag cloud based on project file churn.}
-
-  s.rubyforge_project = "defect-density-heatmap"
-
-  s.files         = `git ls-files`.split("\n")
-  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"]
-
-  # specify any dependencies here; for example:
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "guard"
-  # s.add_runtime_dependency "rest-client"
-end

data/lib/command_line_runner.rb

@@ -1,34 +0,0 @@
-require 'optparse'
-require 'heatmap_formatter'
-
-class CommandLineRunner
-  def self.run
-    options = {
-      :input_stream => STDIN,
-      :output_stream => STDOUT,
-      :regular_expression => "(?<total>(\\d+)),(?<defects>(\\d+)),(?<filename>(.+))"
-    }
-    
-    OptionParser.new do | opts |
-      opts.banner = "Usage: heatmap [options]"
-
-      opts.on("-r", "--record-format pattern", "Regular expression with named captures describing the record") do | regex |
-        options[:regular_expression] = regex
-      end
-      
-      opts.on("-f", "--file inputfile", "File containing commit data") do | filename, f2 |
-        options[:input_stream] = File.new(filename, 'r')
-      end
-      
-      opts.on("-o", "--outfile outputfile", "File to write output to") do | filename |
-        options[:output_stream] = File.new(filename, 'w')
-      end
-    end.parse!
-    
-    formatter = HeatmapFormatter.new(options[:regular_expression],
-                                     options[:input_stream],
-                                     options[:output_stream])
-                                     
-    formatter.render
-  end
-end

data/lib/defect-density-heatmap.rb

@@ -1,5 +0,0 @@
-require 'heatmap/version'
-
-module Heatmap
-  # Your code goes here...
-end

data/lib/heatmap.rb

@@ -1,5 +0,0 @@
-require "heatmap/version"
-
-module Heatmap
-  # Your code goes here...
-end

data/lib/heatmap/version.rb

@@ -1,3 +0,0 @@
-module Heatmap
-  VERSION = "0.0.3"
-end

data/lib/heatmap_formatter.rb

@@ -1,71 +0,0 @@
-class HeatmapFormatter
-  def initialize(line_format, input_stream, output_stream)
-    @output_stream = output_stream
-    
-    format = Regexp.new(line_format)
-    
-    items_to_render = parse(input_stream, format)
-    @entries = items_to_render.sort do | first, second | 
-      File.basename(first[:filename]) <=> File.basename(second[:filename])
-    end
-
-    @floor, ceiling = (@entries.collect { | e | e[:total].to_i }).minmax
-    @range = (ceiling - @floor)
-  end
-  
-  def render
-    tags = @entries.inject("") do | result, e |
-      result + format_entry(e[:filename], e[:total].to_i, e[:defects]) 
-    end
-
-    html = <<-EOS
-      <html>
-        <head>
-          <title>SCM Heatmap</title>
-          <style type='text/css'>
-              body { font-family: sans-serif; }
-              ol li { display: inline; margin: 2px; }
-          </style>
-        </head>
-        <body>
-          <ol>
-            #{tags}
-          </ol>
-        </body>
-      </html>
-    EOS
-    
-    @output_stream << html
-  end
-  
-  def format_entry(filename, changes, defects)
-    style = compute_style(changes, defects)
-    title = "#{File.dirname(filename)} Changes: #{changes} Defects: #{defects}"
-    "<li style='#{style}' title='#{title}'>#{File.basename(filename)} </li>"
-  end
-  
-  def size_for(number)
-    ((((number - @floor).to_f / @range) * 10).to_i * 3) + 6
-  end
-  
-  private
-
-  def parse(stream, format)
-    stream.collect() do | line |
-      format.match(line)
-    end
-  end
-  
-  def calculate_filename_color(total_changes, total_defects)
-    percent_of_defects = total_defects.to_f / total_changes.to_f
-    (percent_of_defects * 255).to_i
-  end
-  
-  def compute_style(total_changes, total_defects)
-    "font-size: #{size_for(total_changes)}; color: rgb(#{calculate_filename_color(total_changes,total_defects)}, 0, 0);"
-  end
-  
-  def determine_relative_size_for(value)
-    @size_calculator.size_for(value)
-  end
-end

data/readme.markdown

@@ -1,36 +0,0 @@
-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,56 +0,0 @@
-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,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,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,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,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,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,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,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
-8,1,src/main/java/com/example/File43.java
-8,2,src/main/java/com/example/File44.java
-11,7,src/main/java/com/example/File45.java
-21,4,src/main/java/com/example/File46.java
-22,19,src/main/java/com/example/File47.java
-12,8,src/main/java/com/example/File48.java
-5,0,src/main/java/com/example/File49.java
-19,6,src/main/java/com/example/File50.java
-16,12,src/main/java/com/example/File51.java
-3,1,src/main/java/com/example/File52.java
-1,0,src/main/java/com/example/File53.java
-1,1,src/main/java/com/example/File54.java
-16,2,src/main/java/com/example/File55.java
-5,3,src/main/java/com/example/File56.java

data/spec/heatmap_formatter_spec.rb

@@ -1,59 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe HeatmapFormatter do
-  before(:each) do 
-    example_data = <<-EOS
-      3:0 src/main/resources/com/example/SomeFile.java: DE3981,DE4386
-      12:6 src/main/java/com/example/AnotherFile.java: US11743
-      6:6 src/main/java/com/example/YetAnotherFile.java: DE3317,DE4077,US12070
-    EOS
-    
-    @input_stream = StringIO.new(example_data)
-    @output_stream = StringIO.new
-
-    @formatter = HeatmapFormatter.new("(?<total>(\\d+)):(?<defects>(\\d+)) (?<filename>(.+)):.+",
-                                      @input_stream,
-                                      @output_stream)
-  end
-  
-  it "Orders the tag cloud based on filename" do
-    @formatter.render
-    @output_stream.string.should match(".*AnotherFile.*SomeFile.*YetAnotherFile")
-  end
-
-
-  it "Renders each file as a tag" do
-    results = @formatter.format_entry 'path/to/SomeFile.java', 3, 0
-    results.should match("<li style='.+'>SomeFile.java </li>")
-  end 
-  
-  it "Adds file details to the title attribute for display when hovered over" do
-    results = @formatter.format_entry 'src/main/java/com/example/SomeFile.java', 3, 2
-    results.should have_title_containing("src/main/java/com/example Changes: 3 Defects: 2")
-  end
-  
-  it "Adjusts the font size of each tag relative to the number of changes in the file" do
-    file_with( :changes =>  3 ).should have_font_size(6)
-    file_with( :changes =>  6 ).should have_font_size(15)
-    file_with( :changes => 12 ).should have_font_size(36)
-  end
-  
-  it "Adjusts the font color of each tag based on the number of changes that were defects" do
-    file_with( :changes => 3 ).should have_color('0, 0, 0')
-
-    file_with( :changes => 3,
-               :defects => 3 ).should have_color('255, 0, 0')
-  
-    file_with( :changes => 7,
-               :defects => 5 ).should have_color('182, 0, 0')
-  end
-  
-  it "Generates a range of font sizes based on a min/max" do
-    @formatter.size_for(12).should == 36
-    @formatter.size_for(11).should == 30
-    @formatter.size_for(8).should  == 21
-    @formatter.size_for(7).should  == 18
-    @formatter.size_for(4).should  ==  9
-    @formatter.size_for(3).should  ==  6
-  end
-end

data/spec/spec_helper.rb

@@ -1,33 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-
-require 'rspec'
-require 'heatmap_formatter'
-require 'command_line_runner'
-
-RSpec.configure do | config |
-  config.color_enabled = true
-end
-
-RSpec::Matchers.define :have_font_size do | expected |
-  match do | actual |
-    actual =~ Regexp.new(".*font-size: #{expected};.*")
-  end
-end
-
-RSpec::Matchers.define :have_color do | expected |
-  match do | actual |
-    actual =~ Regexp.new(".*color: rgb\\(#{expected}\\);.*")
-  end
-end
-
-RSpec::Matchers.define :have_title_containing do | expected |
-  match do | actual |
-    actual =~ Regexp.new(".*title='.*#{expected}.*'.*")
-  end
-end
-
-def file_with(details)
-  @formatter.format_entry 'SomeFile.java', details[:changes], details[:defects] || 0
-end
-