bvm 0.3.2 → 0.3.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Guy Royse & Alyssa Diaz
+Copyright (c) 2012 Guy Royse & Alyssa Diaz
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,24 +1,46 @@
 BVM (Big Visible Metrics)
 =========================
 
-BVM helps you generate Big Visible Charts of Sonar Code Metrics for your team room.  It is a simple command line
-utility that parses the data exposed as XML via the Sonar API.  It converts this XML into CSV data that is consumable
-using Microsoft Tree Mapper or a tool of your choice.  
+BVM helps you generate Big Visible Charts of Sonar Code Metrics for your teamspace.  It is a simple command line utility that parses the data exposed as XML via the Sonar API.  It converts this XML into CSV data that is consumable using [Microsoft Treemapper](http://research.microsoft.com/en-us/downloads/3f3ed95e-26d8-4616-a06c-b609df29756f/default.aspx) or a tool of your choice.  
 
 Installing
 ----------
 
 Installation is super easy.  Just enter:
 
-gem install bvm
+    gem install bvm
+
+Once it is installed, you may also want to install Microsoft Treemapper.  Download it from Microsoft's [site](http://research.microsoft.com/en-us/downloads/3f3ed95e-26d8-4616-a06c-b609df29756f/default.aspx) and follow the installation instructions.
 
 Typical Usage
 -------------
 
-How to Use
-----------
+This sample generates a CSV file ready for Microsoft Treemapper to use against the Apache's Maven source.  The size of the box represents the numbers of lines of code (the ncloc metric) in the class and the color reflects the cyclomatic complextiy.  In this case, a complexity of 50 is the threshhold between red and green on the chart. 
+
+    curl -X GET "http://nemo.sonarsource.org/api/resources?resource=99176&metrics=ncloc,complexity&depth=-1&qualifiers=CLA&format=xml" | bvm --jar maven --color complexity --invert-color --color-adjust 50 > maven-complexity.csv
+
+This generates a similar data set for code coverage.  In this case, the coverage threshhold is set to 80%.
+
+    curl -X GET "http://nemo.sonarsource.org/api/resources?resource=99176&metrics=ncloc,coverage&depth=-1&qualifiers=CLA&format=xml" | bvm --jar maven --color coverage --color-adjust 80 > maven-coverage.csv
+
+The Details
+-----------
+
+The CSV content that BVM generates consists of the following format:
+
+    <size_metric>,<color_metric>,<jar_name>,<package_name>,<class_name>
+
+The size metric is self-explanitory.  It's the size of the box to be generated.  By default is it set to ncloc and this is probably what you will always want.  I can be changed using the --size switch and specifing a different Sonar metric.
+
+The color metric defaults to coverage.  You will probably want this to be several different values, depending on the charts you want to generate.  It can be specified using the --color switch.
+
+Microsoft Treemapper expects that negative numbers are red and positive numbers are green but our metrics aren't quite so compliant.  The --invert-color switch will multiply the specified color metric by -1 to accomodate the charts you are trying to create.  Furthermore, the --color-adjust switch can be given a number that will be added to the specified metric before being outputed.  This allows us to set threshholds of tolerance for our charts.
+
+The JAR name is really just the project name.  If you have multiple JARs in your project (and who doesn't) then the --jar switch will allow you to group them all into one file and generate one enormous view of your entire codebase.  It defaults to "jar" and you probably always want to override it.
+
+If you are command line savvy you probably noticed that BVM does not actually operate on files.  It reads STDIN and writes STDOUT.
 
 Copyright
 ---------
 
-Copyright (c) 2011 Guy Royse & Alyssa Diaz. See LICENSE for further details.
+Copyright (c) 2012 Guy Royse & Alyssa Diaz & Jacob Dingus. See LICENSE for further details.

data/lib/bvm/converter.rb

@@ -18,8 +18,10 @@ class Converter
   def convert(input)
     output = ""
     metrics = parse_xml input
-    metrics[:resource].each do |resource|
-      output << build_output(resource, @jar, @size_metric, @color_metric, @color_adjustment)
+    unless metrics[:resource].nil?
+      metrics[:resource].each do |resource|
+        output << build_output(resource, @jar, @size_metric, @color_metric, @color_adjustment)
+      end
     end
     output
   end
@@ -29,13 +31,19 @@ class Converter
   end
   
   def build_output(resource, jar, size, color, adjust)
-    name = resource[:name][0]
-    size_metric = find_metric resource[:msr], size
-    color_metric = find_metric resource[:msr], color
-    color_metric *= -1 unless not @invert_color_metric
-    color_metric += adjust
     package = parse_package resource[:key][0]  
-    %Q/#{size_metric},#{color_metric},"#{jar}","#{package}","#{name}"\n/  
+    name = resource[:name][0]
+
+    unless resource[:msr].nil?
+      size_metric = find_metric resource[:msr], size
+      color_metric = find_metric resource[:msr], color
+      color_metric *= -1 unless not @invert_color_metric
+      color_metric += adjust
+      %Q/#{size_metric},#{color_metric},"#{jar}","#{package}","#{name}"\n/  
+    else
+      %Q/1.0,#{adjust},"NotFound","#{package}","#{name}"\n/  
+    end
+
   end
   
   def find_metric(metrics, key)

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: bvm
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
 - Guy Royse
 - Alyssa Diaz
+- Jacob Dingus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-03-26 00:00:00.000000000 -04:00
-default_executable: 
+date: 2012-03-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &8796740 !ruby/object:Gem::Requirement
+  requirement: &8392128 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.12
   type: :runtime
   prerelease: false
-  version_requirements: *8796740
+  version_requirements: *8392128
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &8796280 !ruby/object:Gem::Requirement
+  requirement: &8391504 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *8796280
+  version_requirements: *8391504
 - !ruby/object:Gem::Dependency
   name: rspec-core
-  requirement: &8795820 !ruby/object:Gem::Requirement
+  requirement: &8390868 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: 2.3.1
   type: :development
   prerelease: false
-  version_requirements: *8795820
+  version_requirements: *8390868
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
-  requirement: &8795360 !ruby/object:Gem::Requirement
+  requirement: &8390256 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,9 +56,9 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *8795360
+  version_requirements: *8390256
 description: Generates CSV files that can be consumed by Microsoft Treemapper from
-  the Sonar API.  Reads stin and stdout.
+  the Sonar API.  Reads stdin and stdout.
 email:
 - guy@guyroyse.com
 executables:
@@ -66,14 +66,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/bvm/converter.rb
 - lib/bvm/bvm_runner.rb
+- lib/bvm/converter.rb
 - lib/bvm.rb
 - lib/bvm_runner.rb
 - bin/bvm
 - LICENSE
 - README.md
-has_rdoc: true
 homepage: http://github.com/guyroyse/big-visible-metrics
 licenses:
 - MIT
@@ -95,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Generates CSV files from SONAR metrics