countloc 0.0.1

data/LICENSE.txt

@@ -0,0 +1,52 @@
+CountLOC is copyrighted free software by Stephen Doyle <stephendoyle75@gmail.com>.
+You can redistribute it and/or modify it under either the terms of the GPL
+(see COPYING.txt file), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+	  with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.txt

@@ -0,0 +1,39 @@
+Introduction
+------------
+
+Contents:
+~~~~~~~~
+1. Overview
+2. Installation
+3. Usage
+
+
+1. 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. ...
+
+
+2. Installation
+---------------
+CountLOC is packaged as a Ruby gem and as a .zip file. 
+
+Gem:
+	ruby gem install countloc.gem
+	
+zip:
+	unzip countloc.zip
+ 
+
+3. Usage
+--------
+For full listing of options and usage:
+	countloc --help
+	
+To get the LOC metrics for a single Ruby file:
+	countloc some_file.rb
+	

data/lib/countloc.rb

@@ -0,0 +1,101 @@
+# = countloc.rb - Ruby line counter.
+#
+# 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.
+#
+# == Example
+# countloc.rb --help
+# countloc.rb some_file.rb
+#
+
+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
+  
+  def initialize
+    @single_line_full = /^\s*#/
+    @single_line_mixed = /#/
+    @multi_line_begin = /=begin/
+    @multi_line_end = /=end/
+  end
+end
+
+# 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
+  
+  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
+
+    # 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   
+  end
+  
+  stats['code:comment'] = stats['code'].to_f / stats['comments']
+  
+  return stats
+end
+  
+# When run as a standalone script ...
+if $0 == __FILE__:
+  usage = "Usage: #{$0} [-h --help] <file>"
+
+  options = {}  
+  OptionParser.new do |opts|
+    opts.banner = usage
+  end.parse!
+
+  if ARGV.length != 1
+    puts usage
+    exit
+  end
+
+  stats = countloc(ARGV[0])
+  stats.each { |k,v| puts "#{k} = #{v}" }
+end

data/test/ruby_multiline_comments.rb

@@ -0,0 +1,7 @@
+=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

@@ -0,0 +1,23 @@
+# 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

data/test/tc_ruby.rb

@@ -0,0 +1,28 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+# Copyright (C) 2008  Stephen Doyle
+
+require 'test/unit'
+require 'countloc'
+
+class RubyTest < Test::Unit::TestCase
+  
+  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'])
+  end
+
+end
+
+

data/test/ts_countloc.rb

@@ -0,0 +1,6 @@
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+
+# Copyright (C) 2008  Stephen Doyle
+
+require 'test/unit'
+require 'tc_ruby'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: countloc
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stephen Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-30 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: LOC metrics generation script implementation in Ruby.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+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
+homepage: http://countloc.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --title
+- CountLOC Documentation
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: countloc
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Ruby line counter - countLOC.
+test_files: 
+- test/ts_countloc.rb