countloc 0.3.1 → 0.4.0

data/README

@@ -17,6 +17,8 @@ Python, C, C++, C#, Java, Perl, etc. ...
 == Download
 The latest release can be downloaded from: http://rubyforge.org/projects/countloc/
 
+The latest release can also be installed from the Gem Cutter repository at: http://gemcutter.org/gems/countloc
+
 == Installation
 CountLOC is packaged as a Ruby gem and as a .zip file. 
 
@@ -62,10 +64,23 @@ To get LOC metrics for a C file:
 	% countloc.rb hello.c
 	
 To get LOC metrics for all C files in a directory tree:
-	% countloc.rb -r --file-types "*.c *.h"
+	% countloc.rb -r -m c .
 	
 
 == Release Notes
+=== Release 0.4.0:
+Features
+* Added VB support via patch posted on Rubyforge
+* Added mode option to simplify the selection of source code language.
+* By default all known file types will be processed with language selected based on file type.
+* Installers now install an executable - countloc
+
+Bugfixes:
+* [27526] Added workaround for Ruby 1.9.1 bug which caused a stack trace to be dumped during exception processing when a bad filename or directory name was encountered.
+* [27527] Improved help text.
+* [27528] Improved handling of non-ruby source files.
+* [27565] Fixed error where files are duplicated when a directory is specified as an argument.
+
 === Release 0.3.1:
 Features
 * No new features - bugfix release only.

data/bin/countloc

@@ -0,0 +1,123 @@
+#!/usr/bin/ruby
+#
+# = countloc - Ruby line counter.
+#
+# Copyright (C) 2009  Stephen Doyle
+#
+# == Features
+# countloc currently supports generating LOC metrics for source 
+# code of various languages.
+#
+# == Download
+# The latest countloc release can be downloaded from RubyForge: 
+# http://rubyforge.org/frs/?group_id=7555&release_id=29931
+#
+# == Example
+# * countloc --help
+# * countloc some_file.rb
+# * countloc -r .
+#
+
+require 'countloc'
+
+class CmdLineOptParser
+
+  def self.usage 
+    "Usage: #{File.basename($0)} [-h|--help] [options] <file> ... <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 = {}
+    options[:recurse] = false
+    options[:quiet] = false
+    options[:mode] = :ruby
+    options[:defaultMode] = true
+    options[:csv] = false
+    options[:csvFilename] = 'countloc.csv'
+    options[:html] = false
+    options[:htmlFilename] = 'countloc.html'
+    options[:useUserFileTypes] = false
+      
+    begin
+      OptionParser.new do |opts|
+        opts.banner = usage
+
+        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('-q', '--quiet', "Don't write results to stdout") do 
+          options[:quiet] = true
+        end
+
+        opts.on('-m', '--mode mode', 
+          [:ruby, :python, :c, :cpp, :csharp, :java, :vb], 
+          "Set the language mode.", 
+          "All languages are used by default",
+          "if the mode option is omitted.",
+          "Supported modes: ",
+          "  ruby, python,", 
+          "  c, cpp, csharp,", 
+          "  java, vb") do |mode|
+          options[:mode] = mode
+          options[:defaultMode] = false
+        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('--file-types fileTypes', 
+          "File types to be included.",
+          "Default is dependant upon language mode:",
+          "  ruby: *.rb",
+          "  python: *.py",
+          "  c: *.h, *.c",
+          "  cpp: *.h, *.hpp, *.cpp, *.c, *.inl",
+          "  csharp: *.cs",
+          "  java: *.java",
+          "  vb: *.vb",
+          "Defaults are overridden using this option.") do |fileTypes|
+          options[:fileTypes] = fileTypes.split()
+          options[:useUserFileTypes] = true
+        end
+
+        opts.on_tail('-h', '--help', 'Display this help and exit') do
+          puts opts
+          exit
+        end
+
+      end.parse!(args)
+
+    rescue
+      puts "Error: " + $!.to_s
+      exit
+    end
+
+    options
+  end # parse()
+end # class CmdLineOptParser
+
+options = CmdLineOptParser.parse(ARGV)
+if ARGV.length < 1
+  puts CmdLineOptParser.usage
+  exit
+end
+
+CountLOC.countloc(ARGV, options)

data/lib/countloc.rb

@@ -5,23 +5,18 @@
 # Copyright (C) 2008  Stephen Doyle
 #
 # == Features
-# countloc.rb currently supports generating LOC metrics for Ruby source code.
-#
-# The following commenting styles are supported:
-# * Single line comments - starting from a # until the end of the line.
-# * Multi-line comments - between "=begin" and "=end" tags.
+# countloc.rb generates LOC metrics for a variety of programming languages.
 #
 # == 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 -r .
+# * countloc --help
+# * countloc some_file.rb
+# * countloc -r .
 #
 
-
 require 'optparse'
 require 'time'
 
@@ -31,7 +26,36 @@ require 'time'
 #
 module CountLOC
 
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
+
+  DEFAULT_FILE_TYPES = {
+      :ruby   => [".rb"],
+      :python => [".py"],
+      :c      => [".h", ".c"],
+      :cpp    => [".h", ".hpp", ".cpp", ".c", ".cc", ".inl"],
+      :csharp => [".cs"],
+      :java   => [".java"],
+      :vb     => [".vb"]
+  }
+
+  DEFAULT_STYLE = {
+    ".rb"   => :ruby,
+    ".py"   => :python,
+    ".h"    => :cpp,
+    ".c"    => :cpp,
+    ".hpp"  => :cpp,
+    ".cpp"  => :cpp,
+    ".cc"   => :cpp,
+    ".inl"  => :cpp,
+    ".cs"   => :csharp,
+    ".java" => :java,
+    ".vb"   => :vb
+  }
+
+  # Get the supported style for a given filename
+  def getStyle(filename)
+    DEFAULT_FILE_TYPES.invert[File.extname(filename)]
+  end
 
   # Class that gathers the metrics. 
   # 
@@ -42,33 +66,48 @@ module CountLOC
     attr_reader :name
     attr_accessor :code, :comments, :blank, :lines
 
-    COMMENT_PATTERNS = {
-      :ruby => {
-        :single_line_full => /^\s*#/,
-        :single_line_mixed => /#/,
-        :multiline_begin => /=begin(\s|$)/,
-        :multiline_end => /=end(\s|$)/,
-        :blank_line => /^\s*$/
-      },
+    def comment_patterns(style)
+      patterns = {
+        :ruby => {
+          :single_line_full => /^\s*#/,
+          :single_line_mixed => /#/,
+          :multiline_begin => /=begin(\s|$)/,
+          :multiline_end => /=end(\s|$)/,
+          :blank_line => /^\s*$/
+        },
       
-      :python => {
-        :single_line_full => /^\s*#/,
-        :single_line_mixed => /#/,
-        :multiline_begin => /^\s*"""/,
-        :multiline_end => /"""/,
-        :blank_line => /^\s*$/
-      },
-
-      :cplusplus => {
-        :single_line_full => /^\s*\/\//,
-        :single_line_mixed => /\/\//,
-        :multiline_begin => /\/\*/,
-        :multiline_end => /\*\/\s*$/,
-        :multiline_begin_mixed => /^[^\s]+.*\/\*/,
-        :multiline_end_mixed => /\*\/\s*[^\s]+$/,
-        :blank_line => /^\s*$/
+        :vb => {
+          :single_line_full => /^\s*\'/,
+          :single_line_mixed => /\'/,
+          :multiline_begin => /=begin(\s|$)/, # No VB multi-line comment
+          :multiline_end => /=end(\s|$)/,     # No VB multi-line comment
+          :blank_line => /^\s*$/
+        },
+
+        :python => {
+          :single_line_full => /^\s*#/,
+          :single_line_mixed => /#/,
+          :multiline_begin => /^\s*"""/,
+          :multiline_end => /"""/,
+          :blank_line => /^\s*$/
+        },
+
+        :cpp => {                           # C++ 
+          :single_line_full => /^\s*\/\//,
+          :single_line_mixed => /\/\//,
+          :multiline_begin => /\/\*/,
+          :multiline_end => /\*\/\s*$/,
+          :multiline_begin_mixed => /^[^\s]+.*\/\*/,
+          :multiline_end_mixed => /\*\/\s*[^\s]+$/,
+          :blank_line => /^\s*$/
+        }
       }
-    }
+      patterns[:c] = patterns[:cpp]
+      patterns[:csharp] = patterns[:cpp]
+      patterns[:java] = patterns[:cpp]
+      
+      patterns[style]
+    end
 
     LINE_FORMAT = '%8s %8s %8s %8s %12s    %s'
 
@@ -87,23 +126,6 @@ module CountLOC
       self.headline.split(' ', 6)
     end
     
-    #
-    # Retrieve the commenting style that should be used for the given 
-    # file type.
-    #
-    def self.commentStyle(ext)
-      { ".rb"   => :ruby,
-        ".py"   => :python,
-        ".c"    => :cplusplus,
-        ".cpp"  => :cplusplus,
-        ".cc"   => :cplusplus,
-        ".cs"   => :cplusplus,
-        ".h"    => :cplusplus,
-        ".hpp"  => :cplusplus,
-        ".java" => :cplusplus
-      }[ext]
-    end
-    
     def initialize(name)
       @name = name
       @code = 0
@@ -129,7 +151,7 @@ module CountLOC
           line.gsub!(/\/.*?\//, "X")  # Regular expression
         end
 
-        patterns = COMMENT_PATTERNS[style]
+        patterns = comment_patterns(style)
         
         # In the event where the multiline_end pattern is the same as the 
         # multiline_begin pattern, it is necessary to check for the ending
@@ -280,7 +302,7 @@ module CountLOC
       begin
         File.open(@filename, "wb") { |file| file.puts data.to_csv }
       rescue 
-        puts "Error: " + $!
+        puts "Error: " + $!.to_s
       end    
     end
 
@@ -301,7 +323,7 @@ module CountLOC
       begin
         File.open(@filename, "w") { |file| file.puts data.to_html }
       rescue 
-        puts "Error: " + $!
+        puts "Error: " + $!.to_s
       end    
     end
 
@@ -316,15 +338,23 @@ module CountLOC
   # * :html - write the results to a html file. Default = false.
   # * :htmlFilename - name of html file to generate. Used with :html option. Default = countloc.html  
   # * :quiet - do not output results to stdout
-  # * :fileTypes - Types of file to include in the LOC analysis. Used for filtering files
-  #   in recursive analysis and to specify languages other than Ruby. Default = *.rb
+  # * :mode - language mode. Determines parsing rules and default file types. 
+  #   Supported modes: ruby, python, c, cpp, csharp, java, vb.
+  #   If no mode is selected, the default mode is to select the parsing rules based on 
+  #   file extension. A default set of file extensions covering all supported languages
+  #   will be used.
+  # * :fileTypes - Types of file to include in the LOC analysis. By default the file types
+  #   used are based on the language mode selected. This option can be used to override
+  #   the default file types.
   def countloc(files, options = {})
-
+    
     # Setup defaults for filenames
-    options[:fileTypes] = ["*.rb"] if not options.include?(:fileTypes)
-    options[:csvFilename] = "countloc.csv" if not options.include?(:csvFilename)
-    options[:htmlFilename] = "countloc.html" if not options.include?(:htmlFilename)
-
+    if options[:defaultMode]
+      options[:fileTypes] = DEFAULT_FILE_TYPES.values.flatten if not options[:useUserFileTypes]      
+    else
+      options[:fileTypes] = DEFAULT_FILE_TYPES[options[:mode]] if not options[:useUserFileTypes]
+    end
+    
     # Setup the output writers based on the options
     writers = []
     writers << ConsoleWriter.new if not options[:quiet]
@@ -337,8 +367,9 @@ module CountLOC
       recursePattern = ("**" if options[:recurse]) || ""
       files -= dirs
       options[:fileTypes].each do |fileType|
-        files += dirs.collect { |dirname| Dir.glob(File.join(dirname, recursePattern, fileType))}.flatten      
+        files += dirs.collect { |dirname| Dir.glob(File.join(dirname, recursePattern, '*'+fileType))}.flatten      
       end
+      files.uniq!
     end
 
     # Sum will keep the running total
@@ -350,14 +381,18 @@ module CountLOC
     # Generate metrics for each file
     files.each do |filename|
       begin
-        File.open(filename) do |file|
+          File.open(filename) do |file|
           counter = LineCounter.new(filename)
-          counter.read(file, LineCounter.commentStyle(File.extname(filename)))
+          mode = options[:mode]
+          if options[:defaultMode]
+            mode = DEFAULT_STYLE[File.extname(filename)] || options[:mode]
+          end
+          counter.read(file, mode)
           sum += counter
           results << counter
         end
       rescue
-        puts "Error: " + $!
+        puts "Error: " + $!.to_s
       end
     end
 
@@ -392,6 +427,15 @@ if $0 == __FILE__
       # The options set on the command line will be collected in "options"
       # Setup the defaults here
       options = {}
+      options[:recurse] = false
+      options[:quiet] = false
+      options[:mode] = :ruby
+      options[:defaultMode] = true
+      options[:csv] = false
+      options[:csvFilename] = 'countloc.csv'
+      options[:html] = false
+      options[:htmlFilename] = 'countloc.html'
+      options[:useUserFileTypes] = false
       
       begin
         OptionParser.new do |opts|
@@ -402,7 +446,7 @@ if $0 == __FILE__
           end
 
           opts.on('-v', '--version', 'Display version number') do 
-            puts "#{File.basename($0)}, version: #{VERSION}"
+            puts "#{File.basename($0)}, version: #{CountLOC::VERSION}"
             exit
           end
 
@@ -410,6 +454,19 @@ if $0 == __FILE__
             options[:quiet] = true
           end
 
+          opts.on('-m', '--mode mode', 
+            [:ruby, :python, :c, :cpp, :csharp, :java, :vb], 
+            "Set the language mode.", 
+            "All languages are used by default",
+            "if the mode option is omitted.",
+            "Supported modes: ",
+            "  ruby, python,", 
+            "  c, cpp, csharp,", 
+            " java, vb") do |mode|
+            options[:mode] = mode
+            options[:defaultMode] = false
+          end
+
           opts.on('--csv csvFilename', 'Generate csv file') do |csvFilename|
             options[:csvFilename] = csvFilename
             options[:csv] = true
@@ -422,8 +479,17 @@ if $0 == __FILE__
 
           opts.on('--file-types fileTypes', 
             "File types to be included.",
-            "Default = *.rb") do |fileTypes|
+            "Default is dependant upon language mode:",
+            "  ruby: *.rb",
+            "  python: *.py",
+            "  c: *.h, *.c",
+            "  cpp: *.h, *.hpp, *.cpp, *.c, *.inl",
+            "  csharp: *.cs",
+            "  java: *.java",
+            "  vb: *.vb",
+            "Defaults are overridden using this option.") do |fileTypes|
             options[:fileTypes] = fileTypes.split()
+            options[:useUserFileTypes] = true
           end
 
           opts.on_tail('-h', '--help', 'Display this help and exit') do
@@ -434,7 +500,7 @@ if $0 == __FILE__
         end.parse!(args)
 
       rescue
-        puts "Error: " + $!
+        puts "Error: " + $!.to_s
         exit
       end
 

data/setup.rb

@@ -8,6 +8,10 @@
 # the GNU LGPL, Lesser General Public License version 2.1.
 #
 
+require 'rubygems'
+require 'fileutils'
+require 'tmpdir'
+
 unless Enumerable.method_defined?(:map)   # Ruby 1.4.6
   module Enumerable
     alias map collect
@@ -1344,6 +1348,9 @@ class Installer
 
   def install_dir_bin(rel)
     install_files targetfiles(), "#{config('bindir')}/#{rel}", 0755
+    
+    return unless Gem.win_platform?
+    install_bat_files targetfiles(), "#{config('bindir')}/#{rel}", 0755
   end
 
   def install_dir_lib(rel)
@@ -1378,6 +1385,30 @@ class Installer
     end
   end
 
+  def install_bat_files(list, dest, mode)
+    mkdir_p dest, @config.install_prefix
+    list.each do |bin_file|
+      begin
+        bin_cmd_file = File.join Dir.tmpdir, "#{bin_file}.bat"
+
+        File.open bin_cmd_file, 'w' do |file|
+          file.puts <<-TEXT
+@ECHO OFF
+IF NOT "%~f0" == "~f0" GOTO :WinNT
+@"#{Gem.ruby}" "#{bin_file}" %1 %2 %3 %4 %5 %6 %7 %8 %9
+GOTO :EOF
+:WinNT
+"%~d0%~p0ruby.exe" "%~d0%~p0%~n0" %*
+TEXT
+        end
+
+        install bin_cmd_file, dest, mode, @config.install_prefix
+      ensure
+        FileUtils.rm bin_cmd_file
+      end      
+    end
+  end
+
   def libfiles
     glob_reject(%w(*.y *.output), targetfiles())
   end

data/test/tc_cpp.rb

@@ -11,7 +11,7 @@ class CppTest < Test::Unit::TestCase
 
   def setup
     @counter = LineCounter.new('Test')
-    @style = :cplusplus
+    @style = :cpp
   end
   
   def test_single_line_comment

data/test/tc_vb.rb

@@ -0,0 +1,67 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+# Copyright (C) 2008  Stephen Doyle
+
+require 'test/unit'
+require 'countloc'
+
+class VBTest < Test::Unit::TestCase
+
+  include CountLOC
+
+  def setup
+    @counter = LineCounter.new('Test')
+    @style = :vb
+  end
+  
+  def test_single_line_comment
+    @counter.read("' This is a comment", @style)
+    assert_equal(0, @counter.code)
+    assert_equal(1, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_single_line_comment_with_whitespace
+    @counter.read("  ' This is a comment", @style)
+    assert_equal(0, @counter.code)
+    assert_equal(1, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_mixed
+    @counter.read("Label1.Visible = false ' This is a mixed comment", @style)
+    assert_equal(1, @counter.code)
+    assert_equal(1, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_comment_char_in_double_quote_string
+    @counter.read("x = \"hello '\"", @style)
+    assert_equal(1, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(0, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+  def test_blank_lines_with_newline
+    @counter.read("\n", @style)
+    assert_equal(0, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(1, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+  
+  def test_blank_lines_with_whitespace
+    @counter.read("    \t", @style)
+    assert_equal(0, @counter.code)
+    assert_equal(0, @counter.comments)
+    assert_equal(1, @counter.blank)
+    assert_equal(1, @counter.lines)
+  end
+
+end
+
+

data/test/ts_countloc.rb

@@ -6,3 +6,4 @@ require 'test/unit'
 require 'tc_ruby'
 require 'tc_python'
 require 'tc_cpp'
+require 'tc_vb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: countloc
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Stephen Doyle
@@ -9,14 +9,14 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-08 22:34:09.136095 +00:00
+date: 2009-12-17 21:43:16.254209 +00:00
 default_executable: 
 dependencies: []
 
 description: LOC metrics generation script implementation in Ruby.
 email: support@stephendoyle.net
-executables: []
-
+executables: 
+- countloc
 extensions: []
 
 extra_rdoc_files: []
@@ -26,12 +26,16 @@ files:
 - LICENSE
 - setup.rb
 - lib/countloc.rb
+- bin/countloc
 - test/tc_cpp.rb
 - test/tc_python.rb
 - test/tc_ruby.rb
+- test/tc_vb.rb
 - test/ts_countloc.rb
 has_rdoc: true
 homepage: http://countloc.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --title
@@ -54,9 +58,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: countloc
-rubygems_version: 1.0.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ruby line counter - countLOC
 test_files: 
 - test/ts_countloc.rb