countloc 0.1.0 → 0.2.0

data/README

@@ -0,0 +1,90 @@
+== Contents
+
+* Overview
+* Download
+* Installation
+* Usage
+* Release Notes
+
+== Overview
+CountLOC is a utility program, implemented in Ruby that provides support for 
+generating LOC metrics for source code.
+
+Initial releases will support counting lines of code in Ruby source code.
+Subsequent releases will add support for other programming languages such as
+Python, C, C++, C#, Java, Perl, etc. ...
+
+== Download
+The latest release can be downloaded from: http://rubyforge.org/frs/?group_id=7555&release_id=29931
+
+== Installation
+CountLOC is packaged as a Ruby gem and as a .zip file. 
+
+.gem:
+	% gem install countloc-x.y.z.gem	
+
+.zip:
+	% unzip countloc-x.y.z.zip
+	% cd countloc-x.y.z
+	% ruby setup.rb install 
+ 
+.tgz:
+	% tar zxf countloc-x.y.z.tgz
+	% cd countloc-x.y.z
+	% ruby setup.rb install 
+
+== Usage
+For full listing of options and usage:
+	% countloc.rb --help
+	
+To get the LOC metrics for a single Ruby file:
+	% countloc.rb some_file.rb
+
+To get the LOC metrics for multiple Ruby files:
+	% countloc.rb some_file.rb some_other_file.rb
+
+To get the LOC metrics for all Ruby files in the current directory:
+	% countloc.rb *.rb
+or	
+	% countloc.rb .
+
+To get the LOC metrics for all Ruby files in a directory tree with recursion
+into subdirectories:
+	% countloc.rb -r .
+	
+To export the results to a html file:
+	% countloc.rb -r --html countloc.html .
+
+To export the results to a csv file:
+	% countloc.rb -r --csv countloc.csv .
+
+
+== Release Notes
+=== Release 0.2.0:
+Features
+* Added support for exporting results in csv and html format.
+* Improved error handling - e.g. incorrect/missing command line options, file errors, etc.
+* Added setup.rb for ease of installation from the .zip/.tgz release formats.
+* Added CountLOC module to encapsulate methods and classes.
+ 
+Bugfixes: 
+* None
+
+=== Release 0.1.0:
+Features
+* Added support for processing multiple files at once.
+* Added support for processing all .rb files in a directory.
+* Added support for recursing into directory trees.
+* Improved formatting of output.
+
+Bugfixes: 
+* #23380 - Not suppressing path information in the program name in the usage string.
+* #23379 - Incorrectly counting a # inside a single quoted string as a comment.
+
+=== Release 0.0.1:
+Features
+* Initial release.
+* Supports generating LOC metrics for Ruby source code for a single 
+  file at a time.
+* Handles multi-line and single line comments.
+* Handles mixed lines of both code and comments.

data/lib/countloc.rb

@@ -23,149 +23,283 @@
 
 
 require 'optparse'
+require 'time'
 
-COUNTLOC_VERSION = '0.1.0'
+#
+# CountLOC module that encapsulates the methods and classes used to gather
+# code metrics.
+#
+module CountLOC
 
-# Class that gathers the metrics. 
-# 
-# This class design & implementation is based heavily on Stefan Lang's 
-# ScriptLines class from the "Ruby Cookbook" - Recipe 19.5 "Gathering 
-# Statistics About Your Code".
-class LineCounter
-  attr_reader :name
-  attr_accessor :code, :comments, :blank, :lines
-  
-  SINGLE_LINE_FULL_PATTERN = /^\s*#/
-  SINGLE_LINE_MIXED_PATTERN = /#/
-  MULTI_LINE_BEGIN_PATTERN = /=begin(\s|$)/
-  MULTI_LINE_END_PATTERN = /=end(\s|$)/
-  BLANK_LINE_PATTERN = /^\s*$/
+  VERSION = '0.2.0'
+
+  # Class that gathers the metrics. 
+  # 
+  # This class design & implementation is based heavily on Stefan Lang's 
+  # ScriptLines class from the "Ruby Cookbook" - Recipe 19.5 "Gathering 
+  # Statistics About Your Code".
+  class LineCounter
+    attr_reader :name
+    attr_accessor :code, :comments, :blank, :lines
+
+    SINGLE_LINE_FULL_PATTERN = /^\s*#/
+    SINGLE_LINE_MIXED_PATTERN = /#/
+    MULTI_LINE_BEGIN_PATTERN = /=begin(\s|$)/
+    MULTI_LINE_END_PATTERN = /=end(\s|$)/
+    BLANK_LINE_PATTERN = /^\s*$/
+
+    LINE_FORMAT = '%8s %8s %8s %8s %12s    %s'
+
+    #
+    # Generate a string that contains the column headers for the metrics
+    # printed with to_s
+    #
+    def self.headline
+      sprintf LINE_FORMAT, "LOC", "COMMENTS", "BLANK", "LINES", "CODE:COMMENT", "FILE"
+    end
+
+    #
+    # Return an array containing the column names for the counters collected.
+    #
+    def self.columnNames
+      self.headline.split(' ', 6)
+    end
+
+    def initialize(name)
+      @name = name
+      @code = 0
+      @comments = 0
+      @blank = 0
+      @lines = 0
+    end
+
+    # 
+    # Iterates over all the lines in io (io might be a file or a string),
+    # analyzes them and appropriately increases the counter attributes.
+    #
+    def read(io)
+      in_multiline_comment = false
+      io.each do |line| 
+        @lines += 1
+
+        # Process the line to avoid matching comment characters within quoted
+        # strings or regular expressions.
+        line.gsub!(/\'.*?\'/, "X")  # Single quoted string
+        line.gsub!(/\".*?\"/, "X")  # Double quoted string
+        line.gsub!(/\/.*?\//, "X")  # Regular expression
+
+        case line
+        when MULTI_LINE_BEGIN_PATTERN
+          in_multiline_comment = true
+          @comments += 1
+        when MULTI_LINE_END_PATTERN
+          in_multiline_comment = false
+          @comments += 1
+        when BLANK_LINE_PATTERN
+          @blank += 1
+        when SINGLE_LINE_FULL_PATTERN
+          @comments += 1
+        when SINGLE_LINE_MIXED_PATTERN
+          @comments += 1
+          @code += 1
+        else
+          if in_multiline_comment
+            @comments += 1
+          else
+            @code += 1
+          end # if
+        end # case
+      end # read
+    end # class LineCounter
+
+    #
+    # Get a new LineCounter instance whose counters hold the sum of self
+    # and other.
+    #
+    def +(other)
+      sum = self.dup
+      sum.code += other.code
+      sum.comments += other.comments
+      sum.blank += other.blank
+      sum.lines += other.lines
+      return sum
+    end
+
+    #
+    # Get a formatted string containing all counter numbers and the name of
+    # this instance.
+    #
+    def to_s
+      codeCommentRatio = (sprintf "%0.2f", @code.to_f/@comments if @comments > 0) || '--'
+      sprintf LINE_FORMAT, @code, @comments, @blank, @lines, codeCommentRatio, @name
+    end
+
+    #
+    # Get a formatted string containing all counter numbers and the name of
+    # this instance.
+    #
+    def to_a
+      self.to_s.split(' ', 6)
+    end
 
-  LINE_FORMAT = '%8s %8s %8s %8s    %s'
+  end
 
   #
-  # Generate a string that contains the column headers for the metrics
-  # printed with to_s
+  # Container class to store results from each file.
   #
-  def self.headline
-    sprintf LINE_FORMAT, "LOC", "COMMENTS", "BLANK", "LINES", "FILE"
-  end
-  
-  def initialize(name)
-    @name = name
-    @code = 0
-    @comments = 0
-    @blank = 0
-    @lines = 0
+  class Results < Array
+
+    # Return a string containing all the results.
+    def to_s
+      str = LineCounter.headline + "\n"
+      self.each { |result| str += result.to_s + "\n"}
+      str
+    end
+
+    # Return a string containing all the results in csv format.
+    # The first row is a header row of the column names.
+    # Each subsequent row corresponds to a result from the results array.
+    def to_csv
+      csvString = LineCounter.columnNames.join(',') + "\n"
+      self.each { |result| csvString += result.to_a.join(',')  + "\n"}
+      csvString
+    end
+
+    # Return a string containing the results formatted as a html table.
+    # The first row is a header row of the column names.
+    # Each subsequent row corresponds to a result from the results array.
+    def to_html
+      htmlString = %{<table border="1" cellspacing="0" cellpadding="2">}
+      htmlString += %{<tr>}
+      LineCounter.columnNames.each { |name| htmlString += %{<th>#{name}</th>} }
+      htmlString += %{</tr>}
+      self.each do |result|
+        htmlString += %{<tr>}
+        result.to_a.each { |cell| htmlString += %{<td>#{cell}</td> } }
+        htmlString += %{</tr>}
+      end
+      htmlString += %{</table>}
+      htmlString += %{<p><em>Generated by } +
+      %{<a href="http://countloc.rubyforge.org">countloc</a> version #{VERSION} } +
+      %{on #{Time.now.asctime}</em></p>}
+    end
+
   end
 
-  # 
-  # Iterates over all the lines in io (io might be a file or a string),
-  # analyzes them and appropriately increases the counter attributes.
-  #
-  def read(io)
-    in_multiline_comment = false
-    io.each do |line| 
-      @lines += 1
-
-      # Process the line to avoid matching comment characters within quoted
-      # strings or regular expressions.
-      line.gsub!(/\'.*?\'/, "X")  # Single quoted string
-      line.gsub!(/\".*?\"/, "X")  # Double quoted string
-      line.gsub!(/\/.*?\//, "X")  # Regular expression
-
-      case line
-      when MULTI_LINE_BEGIN_PATTERN
-        in_multiline_comment = true
-        @comments += 1
-      when MULTI_LINE_END_PATTERN
-        in_multiline_comment = false
-        @comments += 1
-      when BLANK_LINE_PATTERN
-        @blank += 1
-      when SINGLE_LINE_FULL_PATTERN
-        @comments += 1
-      when SINGLE_LINE_MIXED_PATTERN
-        @comments += 1
-        @code += 1
-      else
-        if in_multiline_comment
-          @comments += 1
-        else
-          @code += 1
-        end # if
-      end # case
-    end # read
-  end # class LineCounter
-  
   #
-  # Get a new LineCounter instance whose counters hold the sum of self
-  # and other.
+  # Class that writes to the Console
   #
-  def +(other)
-    sum = self.dup
-    sum.code += other.code
-    sum.comments += other.comments
-    sum.blank += other.blank
-    sum.lines += other.lines
-    return sum
+  class ConsoleWriter
+    # Write the data to the console
+    def write(data)
+      puts data
+    end  
   end
-  
+
   #
-  # Get a formatted string containing all counter numbers and the name of
-  # this instance.
+  # Class that writes to a csv file
   #
-  def to_s
-    sprintf LINE_FORMAT, @code, @comments, @blank, @lines, @name
+  class CsvFileWriter
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    # Write the csv file, including the data contents (via 
+    # the to_csv method on the data)
+    def write(data)
+      begin
+        File.open(@filename, "wb") { |file| file.puts data.to_csv }
+      rescue 
+        puts "Error: " + $!
+      end    
+    end
+
   end
-  
-end
 
-#
-# Generates LOC metrics for the specified files and sends the results to the console.
-#
-def countloc(files, options = nil)
-    
-  # Sum will keep the running total
-  sum = LineCounter.new("TOTAL")
-
-  # Print a banner showing the column headers
-  puts LineCounter.headline
-
-  # Expand directories into the appropriate file lists
-  dirs = files.select { |filename| File.directory?(filename) }
-  if dirs.size > 0
-    recursePattern = ("**" if options.recurse) || ""
-    files -= dirs
-    files += dirs.collect { |dirname| Dir.glob(File.join(dirname, recursePattern, "*.rb"))}.flatten
+  #
+  # Class that writes to a html file
+  #
+  class HtmlFileWriter
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    # Write the html file, including the data contents (via 
+    # the to_html method on the data)
+    def write(data)
+      begin
+        File.open(@filename, "w") { |file| file.puts data.to_html }
+      rescue 
+        puts "Error: " + $!
+      end    
+    end
+
   end
 
-  # Generate metrics for each file
-  files.each do |filename|
-    File.open(filename) do |file|
-      counter = LineCounter.new(filename)
-      counter.read(file)
-      sum += counter
-      puts counter
+  #
+  # Generates LOC metrics for the specified files and sends the results to the console.
+  #
+  def countloc(files, options = nil)
+
+    # Setup the output writers based on the options
+    writers = [ConsoleWriter.new]
+    writers << CsvFileWriter.new(options.csvFilename) if options.csv
+    writers << HtmlFileWriter.new(options.htmlFilename) if options.html
+
+    # Expand directories into the appropriate file lists
+    dirs = files.select { |filename| File.directory?(filename) }
+    if dirs.size > 0
+      recursePattern = ("**" if options.recurse) || ""
+      files -= dirs
+      files += dirs.collect { |dirname| Dir.glob(File.join(dirname, recursePattern, "*.rb"))}.flatten      
+    end
+
+    # Sum will keep the running total
+    sum = LineCounter.new("TOTAL")
+
+    # Container to hold the results
+    results = Results.new
+
+    # Generate metrics for each file
+    files.each do |filename|
+      begin
+        File.open(filename) do |file|
+          counter = LineCounter.new(filename)
+          counter.read(file)
+          sum += counter
+          results << counter
+        end
+      rescue
+        puts "Error: " + $!
+      end
     end
+
+    # Add the totals to the results
+    results << sum
+
+    # Write the metrics to the required files in the appropriate formats
+    writers.each { |writer| writer.write(results) }
+
+    return results
   end
   
-  # Print the total stats
-  puts sum
-  return sum
-end
+  module_function :countloc
+
+end # module
 
 #
 # When run as a standalone script ...
 #
 if $0 == __FILE__:
-  
+
   require 'ostruct'
-  
+
   class CmdLineOptParser
-    
+
     def self.usage 
-      "Usage: #{File.basename($0)} [options] <file>"
+      "Usage: #{File.basename($0)} [-h|--help] [options] <file> ... <file>"
     end
 
     #
@@ -176,37 +310,57 @@ if $0 == __FILE__:
       # Setup the defaults here
       options = OpenStruct.new
       options.recurse = false
+      options.csv = false
+      options.csvFilename = ""
+      options.html = false
+      options.htmlFilename = ""
 
-      OptionParser.new do |opts|
-        opts.banner = usage
+      begin
+        OptionParser.new do |opts|
+          opts.banner = usage
 
-        opts.on('-r', '--recurse', 'Recurse into subdirectories') do |r|
-          options.recurse = true
-        end
+          opts.on('-r', '--recurse', 'Recurse into subdirectories') do
+            options.recurse = true
+          end
 
-        opts.on('-v', '--version', 'Display version number') do 
-          puts "#{File.basename($0)}, version: #{COUNTLOC_VERSION}"
-          exit
-        end
+          opts.on('-v', '--version', 'Display version number') do 
+            puts "#{File.basename($0)}, version: #{VERSION}"
+            exit
+          end
+
+          opts.on('--csv csvFilename', 'Generate csv file') do |csvFilename|
+            options.csvFilename = csvFilename
+            options.csv = true
+          end
+
+          opts.on('--html htmlFilename', 'Generate html file') do |htmlFilename|
+            options.htmlFilename = htmlFilename
+            options.html = true
+          end
+
+          opts.on_tail('-h', '--help', 'Display this help and exit') do
+            puts opts
+            exit
+          end
+
+        end.parse!(args)
+
+      rescue
+        puts "Error: " + $!
+        exit
+      end
 
-        opts.on_tail('-h', '--help', 'display this help and exit') do
-          puts opts
-          exit
-        end
-      
-      end.parse!(args)
-      
       options
     end # parse()
   end # class CmdLineOptParser
-  
+
   options = CmdLineOptParser.parse(ARGV)
-  
+
   if ARGV.length < 1
     puts CmdLineOptParser.usage
     exit
   end
 
-  countloc(ARGV, options)
+  CountLOC.countloc(ARGV, options)
 
 end