pjstadig-metric_fu 1.1.4.2 → 1.1.5.1

data/HISTORY

@@ -1,3 +1,7 @@
+=== MetricFu 1.1.5 / 2009-8-13
+
+* Previous Ruby 1.9 fix was not quite fix-y enough
+
 === MetricFu 1.1.4 / 2009-7-13
 
 * Fixed another Ruby 1.9x bug

data/lib/base/configuration.rb

@@ -6,7 +6,7 @@ module MetricFu
   # course, in order to use these metrics, their respective gems must
   # be installed on the system.
   AVAILABLE_METRICS = [:churn, :flog, :flay, :reek, 
-                       :roodi, :saikuro, :rcov]
+                       :roodi, :saikuro, :rcov, :dcov]
 
   AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov]
 
@@ -130,6 +130,8 @@ module MetricFu
                                    "--profile",
                                    "--rails",
                                    "--exclude /gems/,/Library/,/usr/,spec"]}
+      @dcov     = {:test_files => ['app/**/*.rb', 'lib/**/*.rb'],
+                   :dcov_opts => ["-p tmp/metric_fu/scratch/dcov"]}
                                    
       @graph_theme = { :colors => %w(orange purple green white red blue pink yellow),
                        :marker_color => 'blue',

data/lib/generators/dcov.rb

@@ -0,0 +1,105 @@
+require 'enumerator'
+
+module MetricFu 
+  
+  class Dcov < Generator
+    
+    def self.verify_dependencies!
+      `dcov --help`
+      raise 'sudo gem install dcov # if you want the dcov tasks' unless $?.success?
+    end
+    
+    #search through resource path and rub dcov on all .rb files, abstract method override
+    def emit
+        #Clean up file system before we start
+        FileUtils.rm_rf(MetricFu::Dcov.metric_directory, :verbose => false)
+        Dir.mkdir(MetricFu::Dcov.metric_directory)
+        
+        #what files are we going to test
+        test_files =  MetricFu.dcov[:test_files].join(' ')
+        
+        
+        #set Dcov Options (See dcov rdocs)
+        dcov_opts = MetricFu.dcov[:dcov_opts].nil? ? "" : MetricFu.dcov[:dcov_opts].join(' ')
+        
+        #setup place to store output
+        output = "> #{MetricFu::Dcov.metric_directory}/dcov.txt 2>/dev/null"
+        
+        #actually do the test
+        `dcov #{dcov_opts} #{test_files} #{output}`
+    end
+    
+    # Parses the output file into a hash for use by template, abstract method override
+    def analyze
+      #get the logged output
+      output1 = File.open(MetricFu::Dcov.metric_directory + '/dcov.txt').read
+      
+      #turn it into something easier to work with
+      output1 = output1.split("\n")
+      
+      #parse output
+      output_hash = {}        #somewhere to keep our parsed data
+      sub_section_sym = ""    #aid for parsing sub sections
+      item_name = ""          #aid for parsing sub sections
+      output1.map! do |line|  #parse each line for essential data (totals, coverage percentage)
+        next if line.blank?                #skip blank lines
+        next if !line[/Not covered:/].nil? #skip these lines
+        next if line[/Generating report/]  #skip these lines
+        next if line[/Writing report/]     #skip these lines
+        
+        #typically the first line, total files checked
+        if line[/\AFiles:/]  
+          output_hash[:file_count] = line[/\d+/]
+          next
+        end
+        
+        #These are the totals for each section
+        if line[/\ATotal \w+/]
+          output_hash[underscore(line[/\ATotal \w+/]).to_sym] = line[/\d+/]
+          next
+        end
+        
+        #Actual coverages and list of uncovered items, marks start of item list
+        if line[/\A\w+ coverage/]
+          sub_section_sym  = underscore(line[/\A\w+ coverage/]).to_sym
+          #output_hash[sub_section_sym] = line[/\d+%/]
+          output_hash= output_hash.merge(sub_section_sym=>{})
+          output_hash[sub_section_sym] = output_hash[sub_section_sym].merge({:coverage => line[/\d+%/]})
+          next
+        end
+        
+        #if it hasn't been caught by now, it's an item... 
+        if item_name == ""
+          #get Item name
+          item_name = line.strip
+        else
+          #get item data and store pair
+          if output_hash[sub_section_sym][:not_covored].nil?
+            output_hash[sub_section_sym] = output_hash[sub_section_sym].merge(:not_covored=>{})
+          end
+          output_hash[sub_section_sym][:not_covored] = output_hash[sub_section_sym][:not_covored].merge({item_name=>line.strip})
+          item_name = ""
+        end
+      end
+      
+      @dcov = output_hash
+    end
+    
+    #abstract method override
+    def to_h
+      {:dcov=> @dcov}   
+    end
+    
+    def underscore(camel_cased_word)
+      camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      tr(" ", "_").
+      downcase
+    end
+
+    
+  end
+  
+end

data/lib/templates/awesome/dcov.html.erb

@@ -0,0 +1,27 @@
+<h2>Dcov Results</h2>
+<h3>Documentation coverage information.</h3>
+<p>
+Total Files: <%=@dcov[:file_count]%><br />
+<% ["Module","Class","Method"].each do |t| %>
+	Total <%=t.pluralize%>: <%=@dcov["total_#{t.pluralize.downcase}".to_sym]%> with <%=@dcov["#{t.downcase}_coverage".to_sym][:coverage]%> coverage.<br />
+<% end %>
+</P>
+<br/>
+
+<% ["Module","Class","Method"].each do |t| %>
+	<h3>Undocumented <%=t.pluralize%>:</h3>
+	<table>
+		<tr>
+			<th><%= t%></th>
+			<th>Location</th>
+		</tr>
+		<%@dcov["#{t.downcase}_coverage".to_sym][:not_covored].each_pair do |k,v| %>
+		<tr>
+			<td><%= k%></td>
+			<td><%= v%></td>
+		</tr>
+		<% end %>
+	</table>
+<% end %>
+
+<p>Generated on <%= Time.now.localtime %></p>

data/lib/templates/awesome/index.html.erb

@@ -3,6 +3,9 @@
 <% if @churn %>
   <li class='even failure'><a href="churn.html">Churn</a></li>
 <% end %>
+<% if @dcov %>
+  <li class='even failure'><a href="dcov.html">Dcov</a></li>
+<% end %>
 <% if @flay %>
   <li class='even failure'><a href="flay.html">Flay</a></li>
 <% end %>

data/lib/templates/standard/dcov.html.erb

@@ -0,0 +1,38 @@
+<html>
+<head>
+	<title>Dcov Code Coverage Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h2>Dcov Results</h2>
+	<h3>Documentation coverage information.</h3>
+	<p>
+	Total Files: <%=@dcov[:file_count]%><br />
+	<% ["Module","Class","Method"].each do |t| %>
+		Total <%=t.pluralize%>: <%=@dcov["total_#{t.pluralize.downcase}".to_sym]%> with <%=@dcov["#{t.downcase}_coverage".to_sym][:coverage]%> coverage.<br />
+	<% end %>
+	</P>
+	<br/>
+	
+	<% ["Module","Class","Method"].each do |t| %>
+		<h3>Undocumented <%=t.pluralize%>:</h3>
+		<table>
+			<tr>
+				<th><%= t%></th>
+				<th>Location</th>
+			</tr>
+			<%@dcov["#{t.downcase}_coverage".to_sym][:not_covored].each_pair do |k,v| %>
+			<tr>
+				<td><%= k%></td>
+				<td><%= v%></td>
+			</tr>
+			<% end %>
+		</table>
+	<% end %>
+	
+	<p>Generated on <%= Time.now.localtime %></p>
+</body>
+</html>

data/lib/templates/standard/index.html.erb

@@ -1,4 +1,4 @@
-<html>
+<html> 
 <head>
 	<title>Metric Fu Results</title>
 	<style>
@@ -11,6 +11,9 @@
   <% if @churn %>
     <p><a href="churn.html">Churn report</a></p>
   <% end %>
+  <% if @dcov %>
+    <p><a href="dcov.html">Dcov report</a></p>
+  <% end %>
   <% if @flay %>
     <p><a href="flay.html">Flay report</a></p>
   <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pjstadig-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 1.1.4.2
+  version: 1.1.5.1
 platform: ruby
 authors: 
 - Jake Scruggs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-16 00:00:00 -07:00
+date: 2009-12-01 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -124,9 +124,14 @@ files:
 - tasks/metric_fu.rake
 - vendor/_fonts/monaco.ttf
 - vendor/saikuro/saikuro.rb
+- lib/generators/dcov.rb
+- lib/templates/awesome/dcov.html.erb
+- lib/templates/standard/dcov.html.erb
 - Manifest.txt
 has_rdoc: true
 homepage: http://metric-fu.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -148,9 +153,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A fistful of code metrics, with awesome templates and graphs
 test_files: 
 - spec/base/base_template_spec.rb