countloc 0.0.1 → 0.1.0

data/README.txt

@@ -1,4 +1,4 @@
-Introduction
+= Introduction
 ------------
 
 Contents:
@@ -6,6 +6,7 @@ Contents:
 1. Overview
 2. Installation
 3. Usage
+4. Release Notes
 
 
 1. Overview
@@ -17,13 +18,15 @@ 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. ...
 
-
 2. Installation
 ---------------
-CountLOC is packaged as a Ruby gem and as a .zip file. 
+CountLOC is packaged as a Ruby gem and as a .zip file. Within each archive, the 
+countloc.rb script is located in the lib directory.
+
+The latest release can be downloaded from: http://rubyforge.org/frs/?group_id=7555&release_id=29931
 
 Gem:
-	ruby gem install countloc.gem
+	gem install countloc.gem
 	
 zip:
 	unzip countloc.zip
@@ -32,8 +35,40 @@ zip:
 3. Usage
 --------
 For full listing of options and usage:
-	countloc --help
+	countloc.rb --help
 	
 To get the LOC metrics for a single Ruby file:
-	countloc some_file.rb
-	
+	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 .
+
+
+4. Release Notes
+----------------
+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

@@ -1,3 +1,5 @@
+#!/usr/bin/ruby
+#
 # = countloc.rb - Ruby line counter.
 #
 # Copyright (C) 2008  Stephen Doyle
@@ -9,93 +11,202 @@
 # * Single line comments - starting from a # until the end of the line.
 # * Multi-line comments - between "=begin" and "=end" tags.
 #
+# == Download
+# The latest countloc release can be downloaded from RubyForge: 
+# http://rubyforge.org/frs/?group_id=7555&release_id=29931
+#
 # == Example
-# countloc.rb --help
-# countloc.rb some_file.rb
+# * countloc.rb --help
+# * countloc.rb some_file.rb
+# * countloc.rb -r .
 #
 
+
 require 'optparse'
 
-class CountLocPatterns
-  attr_reader :single_line_full   # Entire line is a single line comment
-  attr_reader :single_line_mixed  # Mixed code and comment on same line
-  attr_reader :multi_line_begin   # Beginning of a multi-line comment
-  attr_reader :multi_line_end     # End of a multi-line comment
+COUNTLOC_VERSION = '0.1.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
   
-  def initialize
-    @single_line_full = /^\s*#/
-    @single_line_mixed = /#/
-    @multi_line_begin = /=begin/
-    @multi_line_end = /=end/
-  end
-end
+  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*$/
 
-# Get the lines of code (LOC) metrics for the specified filename(s).
-# Returns: Metrics in the form of a hash of name-value pairs.
-def countloc(filename)
-  stats = { 'comments'=>0, 'code'=>0, 'blank'=>0, 'total'=>0 }
-  patterns = CountLocPatterns.new
-  isMultilineOpen = false
+  LINE_FORMAT = '%8s %8s %8s %8s    %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", "FILE"
+  end
   
-  srcFile = File.new(filename, 'r').each do |line|
-    stats['total'] += 1
-    
-    if isMultilineOpen
-      if line =~ patterns.multi_line_end
-        isMultilineOpen = false
-      end
-      stats['comments'] += 1
-      next
-    end
-    
-    if line =~ /^\s*$/  # Blank line
-      stats['blank'] += 1
-      next
-    end
-    
-    if line =~ patterns.multi_line_begin
-      isMultilineOpen = true
-      stats['comments'] += 1
-      next
-    end
-    
-    if line =~ patterns.single_line_full
-      stats['comments'] += 1
-      next
-    end
+  def initialize(name)
+    @name = name
+    @code = 0
+    @comments = 0
+    @blank = 0
+    @lines = 0
+  end
 
-    # Process the line to avoid matching comment characters within quoted
-    # strings or regular expressions.
-    line.gsub!(/\".*?\"/, "X")  # Quoted string
-    line.gsub!(/\/.*?\//, "X")  # Regular expression
-    
-    if line =~ patterns.single_line_mixed
-      stats['comments'] += 1
-      stats['code'] += 1
-    else
-      stats['code'] += 1
-    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
   
-  stats['code:comment'] = stats['code'].to_f / stats['comments']
+  #
+  # Get a formatted string containing all counter numbers and the name of
+  # this instance.
+  #
+  def to_s
+    sprintf LINE_FORMAT, @code, @comments, @blank, @lines, @name
+  end
   
-  return stats
 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
+  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
+    end
+  end
   
+  # Print the total stats
+  puts sum
+  return sum
+end
+
+#
 # When run as a standalone script ...
+#
 if $0 == __FILE__:
-  usage = "Usage: #{$0} [-h --help] <file>"
+  
+  require 'ostruct'
+  
+  class CmdLineOptParser
+    
+    def self.usage 
+      "Usage: #{File.basename($0)} [options] <file>"
+    end
+
+    #
+    # Return a structure describing the options
+    #
+    def self.parse(args)
+      # The options set on the command line will be collected in "options"
+      # Setup the defaults here
+      options = OpenStruct.new
+      options.recurse = false
 
-  options = {}  
-  OptionParser.new do |opts|
-    opts.banner = usage
-  end.parse!
+      OptionParser.new do |opts|
+        opts.banner = usage
 
-  if ARGV.length != 1
-    puts usage
+        opts.on('-r', '--recurse', 'Recurse into subdirectories') do |r|
+          options.recurse = true
+        end
+
+        opts.on('-v', '--version', 'Display version number') do 
+          puts "#{File.basename($0)}, version: #{COUNTLOC_VERSION}"
+          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
 
-  stats = countloc(ARGV[0])
-  stats.each { |k,v| puts "#{k} = #{v}" }
+  countloc(ARGV, options)
+
 end

data/test/tc_ruby.rb

@@ -6,21 +6,101 @@ require 'test/unit'
 require 'countloc'
 
 class RubyTest < Test::Unit::TestCase
+
+  def setup
+    @counter = LineCounter.new('Test')
+  end
+  
+  def test_ruby_single_line_comment
+    @counter.read("# This is a comment")
+    assert_equal(0, @counter.code)
+    assert_equal(1, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_ruby_single_line_comment_with_whitespace
+    @counter.read("  # This is a comment")
+    assert_equal(0, @counter.code)
+    assert_equal(1, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_ruby_multi_line_comment
+    @counter.read("=begin\n# This is a comment\n=end")
+    assert_equal(0, @counter.code)
+    assert_equal(3, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(3, @counter.lines)
+  end
+
+  def test_ruby_multi_line_comment_with_blank_lines
+    @counter.read("=begin\n# This is a comment\n\n=end")
+    assert_equal(0, @counter.code)
+    assert_equal(3, @counter.comments)
+    assert_equal(1, @counter.blank)
+    assert_equal(4, @counter.lines)
+  end
+
+  def test_ruby_mixed
+    @counter.read("puts 'hello' # This is a mixed comment")
+    assert_equal(1, @counter.code)
+    assert_equal(1, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_ruby_comment_char_in_double_quote_string
+    @counter.read('puts "hello #"')
+    assert_equal(1, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_ruby_comment_char_in_single_quote_string
+    @counter.read("puts 'hello #'")
+    assert_equal(1, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_ruby_comment_char_in_regexp
+    @counter.read("puts /#/")
+    assert_equal(1, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_ruby_blank_lines_with_newline
+    @counter.read("\n")
+    assert_equal(0, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(1, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
   
-  def test_ruby_single_line_comments
-    stats = countloc('ruby_single_line_comments.rb')
-    assert_equal(14, stats['code'])
-    assert_equal(6, stats['comments'])
-    assert_equal(5, stats['blank'])
-    assert_equal(23, stats['total'])
-  end
-
-  def test_ruby_multi_line_comments
-    stats = countloc('ruby_multiline_comments.rb')
-    assert_equal(2, stats['code'])
-    assert_equal(4, stats['comments'])
-    assert_equal(1, stats['blank'])
-    assert_equal(7, stats['total'])
+  def test_ruby_blank_lines_with_whitespace
+    @counter.read("    \t")
+    assert_equal(0, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(1, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_ruby_mixed_code_and_comments
+    @counter.read("# This is a comment\n" +
+      "1.upto(5).each {|x| puts x}\n" +
+      "=begin\n" +
+      " multiline comment\n" +
+      "=end")
+    assert_equal(1, @counter.code)
+    assert_equal(4, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(5, @counter.lines)
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: countloc
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Stephen Doyle
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-30 00:00:00 +00:00
+date: 2009-01-01 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
 description: LOC metrics generation script implementation in Ruby.
-email: 
+email: support@stephendoyle.net
 executables: []
 
 extensions: []
@@ -25,8 +25,6 @@ files:
 - README.txt
 - LICENSE.txt
 - lib/countloc.rb
-- test/ruby_multiline_comments.rb
-- test/ruby_single_line_comments.rb
 - test/tc_ruby.rb
 - test/ts_countloc.rb
 has_rdoc: true
@@ -56,6 +54,6 @@ rubyforge_project: countloc
 rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
-summary: Ruby line counter - countLOC.
+summary: Ruby line counter - countLOC
 test_files: 
 - test/ts_countloc.rb

data/test/ruby_multiline_comments.rb

@@ -1,7 +0,0 @@
-=begin
-  This is a ruby file that uses multi-line comments.
-  It is used for testing countloc
-=end
-
-puts "Hello World"
-puts "Blah, blah, blah ..."

data/test/ruby_single_line_comments.rb

@@ -1,23 +0,0 @@
-# This is a sample piece of ruby code to test countloc with single 
-# line comments. 
-puts "Hello World"
-
-# And some more code ...
-1.upto(10) { |x|puts x}
- 
-# And yet more ...
-('a'..'z').each do |alpha|
-  puts alpha  # This is an example of mixed code and comments. 
-end
-
-if "abcdefg".include? "#"
-  puts "We should never get here!"
-end
-
-if "abcdefg" =~ /#/
-  puts "We should never get here!"
-end
-
-if "abcdefg" =~ /#/   # This is mixed also!
-  puts "We should never get here!"
-end