dcov 0.1.0 → 0.2.1

data/History.txt

@@ -12,4 +12,15 @@
 
 == 0.1.0
 
-No serious enhancements other than a pretty major bug fix and a new version number. :)
+No serious enhancements other than a pretty major bug fix and a new version number. :)
+
+== 0.2.0
+
+* 2 major enhancements
+  * Added new analyzer system
+  * Added quality analysis
+  
+== 0.2.1
+* 2 minor changes
+  * Removed Ruport dependency; too much baggage!
+  * Tweaked a few things

data/bin/dcov

@@ -3,12 +3,6 @@
 #  Created by Jeremy McAnally on 2007-5-28.
 #  Copyright (c) 2007. All rights reserved.
 
-begin
-  require 'rubygems'
-rescue LoadError
-  # no rubygems to load, so we fail silently
-end
-
 require 'optparse'
 require File.dirname(__FILE__) + '/../lib/dcov'
 
@@ -45,9 +39,5 @@ BANNER
   end
 end
 
-if (ARGV != [])
-  OPTIONS[:files] = ARGV
-  @coverage = Dcov::Analyzer.new(OPTIONS)
-else
-  raise "No files to analyze!"
-end
+OPTIONS[:files] = ARGV
+@coverage = Dcov::Analyzer.new(OPTIONS)

data/lib/dcov/analyzer.rb

@@ -1,34 +1,86 @@
 require 'rdoc/rdoc'
-require 'dcov/analyzed_token.rb'
-require 'dcov/stats'
+require File.dirname(__FILE__) + '/analyzed_token.rb'
+require File.dirname(__FILE__) + '/stats'
 
 # Makes +stats+ accessible to us so we can inject our own.
-# We also add a +classifier+ attribtue to the code object classes.
+# We also add a +classifier+ attribute to the code object classes.
 module RDoc
   class RDoc
     attr_accessor :stats
   end
   
+  module DcovHelpers
+    attr_accessor :reporting_data
+    
+    def initialize(*args)
+      super(*args)
+      @reporting_data = {}
+      initialize_reporting_data
+    end
+    
+    def full_name
+      hierarchy = self.name
+      inspect = self
+      while (hier_piece = inspect.parent)
+        hierarchy = hier_piece.name + "::" + hierarchy unless hier_piece.name == 'TopLevel'
+        inspect = hier_piece
+      end
+      
+      hierarchy
+    end
+  end
+  
   class AnyMethod
+    include DcovHelpers
+    
     def classifier
       :method
     end
+    
+    def initialize_reporting_data
+      @reporting_data[:parameters_without_coverage] = []
+      @reporting_data[:default_values_without_coverage] = []
+    end
   end
   
   class NormalClass
+    include DcovHelpers
+    
     def classifier
       :class
     end
+    
+    def initialize_reporting_data
+    end
   end
   
   class NormalModule
+    include DcovHelpers
+    
     def classifier
       :module
     end
+    
+    def initialize_reporting_data
+    end
   end
 end
 
 module Dcov
+  class AnalysisContext
+    attr_accessor :token, :comment, :classifier, :stats
+    
+    def initialize(token, comment, classifier, stats)
+      @token = token
+      @comment = comment || ''
+      @classifier = classifier
+      @stats = stats
+    end
+    
+    def must(description)
+      yield description      
+    end
+  end
   
   # Mocked options object to feed to RDoc
   class RDocOptionsMock
@@ -44,7 +96,7 @@ module Dcov
   end
   
   # Main class
-  class Analyzer
+  class Analyzer    
     attr_accessor :classes, :methods, :modules, :hierarchy, :stats
     
     # Grab the arguments from the DCov init script or
@@ -52,6 +104,7 @@ module Dcov
     # parsing.
     def initialize(options)
       @options = options
+      raise "No files to analyze!" if @options[:files] == [] || @options[:files] == nil
       
       # Setup the analyzed tokens array so we can keep track of which methods we've already
       # taken a look at...
@@ -109,7 +162,7 @@ module Dcov
     def process_token(token)
       analyzed_token = AnalyzedToken.new(token.name, token.parent)
       unless @analyzed_tokens.include?(analyzed_token)
-        expose_to_analyzers(token)
+        token = expose_to_analyzers(token)
         @analyzed_tokens << analyzed_token
                  
         [:method_list, :classes, :modules].each do |meth, type|
@@ -125,7 +178,9 @@ module Dcov
     def generate
       print "Generating report..."
       require File.dirname(__FILE__) + "/generators/#{@options[:output_format]}/generator.rb"
-      report = @stats.as(@options[:output_format].to_sym) 
+
+      generator = Dcov::Generator.new @stats.renderable_data
+      report = generator.to_s
       print "done.\n"
       
       print "Writing report..."
@@ -143,10 +198,7 @@ module Dcov
     def find_analyzers
       Dir::entries(File.dirname(__FILE__) + "/analyzers").each do |analyzer|
         next unless /(\w+)_analyzer.rb$/ =~ analyzer
-        type = $1
-
-        require File.dirname(__FILE__) + "/analyzers/#{analyzer}"
-        @analyzers << "#{type.capitalize}Analyzer".intern
+        @analyzers << File.dirname(__FILE__) + "/analyzers/#{analyzer}"
       end
     end
     
@@ -155,8 +207,82 @@ module Dcov
     def expose_to_analyzers(token)
       @analyzers.each do |analyzer|
         classifier = token.classifier
+        eval(File.read(analyzer))
         
-        Dcov::Analyzers.const_get(analyzer).analyze(token, classifier, @stats)
+        token = analyze_token(token, classifier, @stats)
+        @method_analysis, @module_analysis, @class_analysis, @all_analysis = nil
+      end
+      
+      token
+    end
+    
+    def documentation_for_methods(&block)
+      @method_analysis = block
+    end
+    
+    def documentation_for_classes(&block)
+      @class_analysis = block
+    end
+    
+    def documentation_for_modules(&block)
+      @module_analysis = block
+    end
+    
+    def documentation_for_all(&block)
+      @all_analysis = block
+    end
+    
+    def analyze_token(token, classifier, stats)
+      context = AnalysisContext.new(token, (token.comment || ''), classifier, stats)
+      
+      @all_analysis.call(context) if @all_analysis
+  
+      case classifier
+        when :method
+          @method_analysis.call(context) if @method_analysis
+        when :class
+          @class_analysis.call(context) if @class_analysis
+        when :module
+          @module_analysis.call(context) if @module_analysis
+      end
+      
+      context.token
+    end
+    
+    def param_names_for(token)
+      if token.params
+        params = token.params.dup
+        params.gsub!(/\(/, '')
+        params.gsub!(/\)/, '')
+
+        if params.include?(",")
+          params = params.split(",")
+        else
+          params = [params]
+        end
+
+        processed_params = []
+
+        params.each do |param|
+          param_value = nil
+
+          # We have a default value...
+          if param.include?('=')
+            param_pieces = param.scan(/(.*)=(.*)/)[0]
+            param = param_pieces[0].strip 
+            param_value = param_pieces[1].strip
+          end
+
+          processed_params << [param, param_value]
+        end
+
+        if processed_params == [["", nil]]
+          []
+        else
+          processed_params  
+        end
+      else
+        []
       end
     end
   end

data/lib/dcov/analyzers/coverage_analyzer.rb

@@ -1,9 +1,7 @@
-module Dcov
-  module Analyzers
-    class CoverageAnalyzer
-      def self.analyze(token, classifier, stats)
-        (token.comment.nil? || token.comment == '') ? stats.coverage[classifier][:not_covered] << token : stats.coverage[classifier][:covered] << token
-      end
-    end
+documentation_for_all do |the_documentation|
+  the_documentation.must " have coverage." do
+    the_documentation.stats.coverage[:tokens][the_documentation.token] = []
+    (the_documentation.token.comment.nil? || the_documentation.token.comment == '') ? the_documentation.stats.coverage[the_documentation.classifier][:not_covered] << the_documentation.token : the_documentation.stats.coverage[the_documentation.classifier][:covered] << the_documentation.token
+    (the_documentation.token.comment.nil? || the_documentation.token.comment == '') ? the_documentation.stats.coverage[:tokens][the_documentation.token] << :not_covered : the_documentation.stats.coverage[:tokens][the_documentation.token] << :covered
   end
-end
+end

data/lib/dcov/generators/html/generator.rb

@@ -1,38 +1,69 @@
+
 module Dcov
   # Generates HTML output
-  class Generator < Ruport::Formatter::HTML
-    renders :html, :for => StatsRenderer
+  class Generator # < Ruport::Formatter::HTML
+    # renders :html, :for => StatsRenderer
+
+    include Dcov::StatsRenderer::Helpers
+
+    attr_reader :data
+    def initialize(data)
+      @data = data
+    end
+
+    def to_s
+      build_stats_header +  build_stats_body + build_stats_footer
+    end
           
     def build_stats_header 
-      output << "<html><head><title>dcov results</title>"+
-                "</head><body>\n<h1>dcov results</h1>\n\n"   
+      # Little CSS, a little HTML...
+      output = ""
+      output << """<html><head><title>dcov results</title>
+                <style> 
+                  BODY { font-family: Helvetica, Arial, sans-serif; font-size: 10pt; background: #333; color: white; margin: 16px; }
+                  H1 { text-shadow: 3pt 3pt 5pt black;}
+                  .quality_problem { font-size: 8pt; color: #999; }
+                  LI { margin: 8px; }
+                </style>
+                </head><body>\n<h1>dcov results</h1>\n\n"""
     end
 
     def build_stats_body
+      output = ""
       output << "<p>\n"
       output << "Class coverage: <b>#{class_coverage}%</b><br>\n"
       output << "Module coverage: <b>#{module_coverage}%</b><br>\n"
       output << "Method coverage: <b>#{method_coverage}%</b><br>\n"
       output << "</p>\n\n"
-      output << "<ul>\n" 
+      output << "<ol>\n" 
 
       data[:structured].each do |key,value|
         output << ((value[0].comment.nil? || value[0].comment == '') ? 
-                "\t<li><font color='#f00;'>#{key}</font>\n\t\t<ul>\n" : 
-                "\t<li> #{key}\n\t\t<ul>")
+                "\t<li><font color='#f00;'><tt>#{key.is_a?(String) ? key : key.full_name  }</tt></font>\n\t\t<ol>\n" : 
+                "\t<li><tt>#{key}</tt>\n\t\t<ol>") unless value[0].is_a?(Dcov::TopLevel)
 
         value[1].each do |itm|
           output << ((itm.comment.nil? || itm.comment == '') ? 
-                "\t\t\t<li><font color='#f00;'>#{itm.name}</font></li>\n" : 
-                 "\t\t\t<li> #{itm.name}</li>\n")
+                "\t\t\t<li><font color='#f00;'><tt>#{itm.name}</tt></font>\n" : 
+                 "\t\t\t<li><tt>#{itm.name}</tt>\n")
+          
+          # Quality information
+          output << "#{"<br /><span class='quality_problem'>parameters without documentation: <tt>" + itm.reporting_data[:parameters_without_coverage].join(", ") + "</tt></span>" if itm.reporting_data[:parameters_without_coverage].length > 0}"
+          output << "#{"<br /><span class='quality_problem'>default values without documentation: <tt>" + itm.reporting_data[:default_values_without_coverage].join(", ") + "</tt></span>" if itm.reporting_data[:default_values_without_coverage].length > 0}"
+          output << "#{"<br /><span class='quality_problem'>options are not documented</span>" if itm.reporting_data[:no_options_documentation]}"
+          output << "#{"<br /><span class='quality_problem'>there are no examples</span>" if itm.reporting_data[:no_examples]}"
+                  
+          output << "</li>\n"
         end
 
-        output << "\t\t</ul>\n\t</li>\n\n"
+        output << "\t\t</ol>\n\t</li>\n\n" unless value[0].is_a?(Dcov::TopLevel)
       end  
+      output
     end
 
     def build_stats_footer
-      output << "\n\n</body></html>"   
+      output = ""
+      output << "</ol>\n\n</body></html>"   
     end
 
   end

data/lib/dcov/stats.rb

@@ -1,10 +1,10 @@
 require 'rubygems'
-require 'ruport'
+# require 'ruport'
 
 module Dcov
-  class StatsRenderer < Ruport::Renderer
+  class StatsRenderer # < Ruport::Renderer
   
-    stage :stats_header, :stats_body, :stats_footer
+    # stage :stats_header, :stats_body, :stats_footer
   
     module Helpers
      
@@ -33,8 +33,8 @@ module Dcov
     
     attr_accessor :num_files, :num_classes, :num_modules, :num_methods, :coverage
     
-    include Ruport::Renderer::Hooks
-    renders_with Dcov::StatsRenderer
+    # include Ruport::Renderer::Hooks
+    # renders_with Dcov::StatsRenderer
     
     def initialize
       @num_files = @num_classes = @num_modules = @num_methods = 0
@@ -45,23 +45,52 @@ module Dcov
       [:class, :method, :module].each do |type|
         @coverage[type] = { :covered => [], :not_covered => [] }
       end
+      
+      @coverage[:tokens] = {}
     end
   
     # Print out the coverage rating
     def print
-      puts "\n\nFiles:   #{@num_files}"
+      # TODO: add a flag for textmate, the ugliest format ever:
+      # txmt://open?url=file:///path/to/file.rb&line=86&column=3
+
+      puts "Files:   #{@num_files}"
       puts "Total Classes: #{@num_classes}"
       puts "Total Modules: #{@num_modules}"
       puts "Total Methods: #{@num_methods}"
-      puts "\n\n\n"
-      puts "Class coverage: #{coverage_rating(:class)}%\n"
-      puts "\tNot covered: #{@coverage[:class][:not_covered].map{|itm| itm.name}.join(', ')}\n\n"
-
-      puts "Method coverage: #{coverage_rating(:method)}%\n"
-      puts "\tNot covered: #{@coverage[:method][:not_covered].map{|itm| itm.parent.name + "#" + itm.name}.join(', ')}\n\n"
 
+      puts
       puts "Module coverage: #{coverage_rating(:module)}%"
-      puts "\tNot covered: #{@coverage[:module][:not_covered].map{|itm| itm.name}.join(', ')}\n\n"
+      puts "  Not covered:"
+      @coverage[:module][:not_covered].sort_by {|o| o.name}.each do |itm|
+        location = itm.in_files.first.file_absolute_name || "no known location"
+        puts "    #{itm.name}:"
+        puts "      #{location}"
+      end
+
+      puts
+      
+      puts
+      puts "Class coverage: #{coverage_rating(:class)}%"
+      puts "  Not covered:"
+      @coverage[:class][:not_covered].sort_by {|o| o.name}.each do |itm|
+        location = itm.in_files.first.file_absolute_name
+        puts "    #{itm.name}"
+        puts "      #{location}"
+      end
+
+      puts
+
+      puts
+      puts "Method coverage: #{coverage_rating(:method)}%\n"
+      puts "  Not covered:"
+      @coverage[:method][:not_covered].sort_by {|o| [o.parent.name, o.name]}.each do |itm|
+        location = itm.token_stream.first.text.sub(/^# File /, '').sub(/, line (\d+)$/, ':\1')
+        puts "    #{itm.parent.name}##{itm.name}:"
+        puts "       #{location}"
+      end
+      
+      puts
     end
   
     # Get the coverage rating (e.g., 34%) for the tokens of the type specified
@@ -86,13 +115,13 @@ module Dcov
       
       # Create a properly nested structure
       data[:structured] = {}
-      classes.each {|cls| data[:structured][cls.name] = [cls, []]}
-      modules.each {|mod| data[:structured][mod.name] = [mod, []]}
+      classes.each {|cls| data[:structured][cls.full_name] = [cls, []]}
+      modules.each {|mod| data[:structured][mod.full_name] = [mod, []]}
       data[:structured]['[Toplevel]'] = [TopLevel.new, []]
       
       methods.each do |method|
-        if (data[:structured].has_key?(method.parent.name))
-          data[:structured][method.parent.name][1] << method
+        if (data[:structured].has_key?(method.parent.full_name))
+          data[:structured][method.parent.full_name][1] << method
         else
           data[:structured]['[Toplevel]'][1] << method
         end

data/lib/dcov/version.rb

@@ -1,8 +1,8 @@
 module Dcov #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 1
-    TINY  = 0
+    MINOR = 2
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/dcov.rb

@@ -1,5 +1,5 @@
 module Dcov
 end
 
-require 'dcov/version.rb'
-require 'dcov/analyzer.rb'
+require File.dirname(__FILE__) + '/dcov/version.rb'
+require File.dirname(__FILE__) + '/dcov/analyzer.rb'

data/spec/dcov_spec.rb

@@ -3,7 +3,7 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 require File.dirname(__FILE__) + '/../lib/dcov.rb'
 
-describe "A new Dcov::Coverage object" do
+describe "The Dcov analyzer" do
   before(:each) do
     @myopts = OptionsMock.new
   end
@@ -64,7 +64,7 @@ describe "A new Dcov::Coverage object" do
   end
   
   it "should give an exception if no files are given." do
-    @myopts[:files] = ''
+    @myopts[:files] = []
     lambda { Dcov::Analyzer.new(@myopts) }.should raise_error(RuntimeError)
     
     @myopts[:files] = nil
@@ -94,6 +94,35 @@ describe "A new Dcov::Coverage object" do
     coverage_is_zero.stats.coverage_rating(:method).should == 0
   end
   
+  it "should process the tokens into a proper structure after quality analysis." do
+    @analyzer.stats.renderable_data[:structured].should_not == nil
+  end
+  
+  it "should attach reporting data to each token." do
+    @analyzer.stats.renderable_data[:structured][@analyzer.stats.renderable_data[:structured].keys[0]][0].reporting_data.should == {}
+  end
+  
+  it "should attach extra reporting data to each method." do
+    @analyzer.stats.renderable_data[:structured]['Document::Element'][1][0].reporting_data.should_not == {}
+  end
+  
+  it "should catch tokens without examples." do
+    @analyzer.stats.renderable_data[:structured]['Document::Element'][1][2].reporting_data.keys.include?(:no_examples).should == true
+  end
+  
+  it "should catch methods that have undocumented default values." do
+    @analyzer.stats.renderable_data[:structured]['Document::Element'][1][1].reporting_data.keys.include?(:default_values_without_coverage).should == true
+  end
+  
+  it "should catch methods that have undocumented parameters." do
+    @analyzer.stats.renderable_data[:structured]['Document::Element'][1][1].reporting_data.keys.include?(:parameters_without_coverage).should == true
+  end
+  
+  it "should catch methods that have undocumented options hashes." do
+    @analyzer.stats.renderable_data[:structured]['Document::Element'][1][1].reporting_data.keys.include?(:no_options_documentation).should == true
+  end
+  
+  # Let's kill off the HTML!
   after(:all) do
     `chmod 744 coverage.html; rm coverage.html`
   end

data/spec/mock_code.rb

@@ -19,11 +19,14 @@ module Document
     def initialize
     end
     
-    def parse
+    def parse(document = "Current Document", options = {})
     end
     
     # The main method
-    def elementize
+    # ==== Examples
+    #   elementize
+    #   # => Hello! 
+    def elementize(the_item)
     end
   end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: dcov
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-07-07 00:00:00 -04:00
+  version: 0.2.1
+date: 2007-09-16 00:00:00 -04:00
 summary: A documentation analysis tool for Ruby.
 require_paths: 
 - lib