gravitext-devtools 1.0.1 → 1.1.0

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 1.1.0 (2011-2-13)
+* Add support for header inclusion files.
+* Add new gt-count utility.
+
 === 1.0.1 (2010-8-1)
 * Include missing rainbow dependency.
 

data/Manifest.txt

@@ -3,11 +3,13 @@ Manifest.txt
 README.rdoc
 Rakefile
 bin/gt-cleanws
+bin/gt-count
 bin/gt-header
 bin/gt-manifest
 lib/gravitext-devtools/base.rb
 lib/gravitext-devtools.rb
 lib/gravitext-devtools/header_writer.rb
+lib/gravitext-devtools/line_counter.rb
 lib/gravitext-devtools/manifest_writer.rb
 templates/format/format.java
 templates/format/format.rb

data/README.rdoc

@@ -9,14 +9,11 @@ A collection of development support tools.
 gt-manifest:: Maintain manifest from git ls-files minus exclusions.
 gt-cleanws::  Cleanup whitespace in files.
 gt-header::   Add and maintain file license headers.
-
-== Synopsis
-
-[TBD]
+gt-count::    Count lines of code by type.
 
 == License
 
-Copyright (c) 2008-2010 David Kellum
+Copyright (c) 2008-2011 David Kellum
 
 Licensed under the Apache License, Version 2.0 (the "License"); you
 may not use this file except in compliance with the License.  You

data/Rakefile

@@ -4,7 +4,7 @@ $LOAD_PATH << './lib'
 require 'gravitext-devtools/base'
 
 require 'rubygems'
-gem     'rjack-tarpit', '~> 1.2.1'
+gem     'rjack-tarpit', '~> 1.3.0'
 require 'rjack-tarpit'
 
 t = RJack::TarPit.new( 'gravitext-devtools', Gravitext::DevTools::VERSION )

data/bin/gt-cleanws

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 #--
-# Copyright (c) 2008-2010 David Kellum
+# Copyright (c) 2008-2011 David Kellum
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you
 # may not use this file except in compliance with the License.  You may

data/bin/gt-count

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby
+#--
+# Copyright (c) 2008-2011 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+$LOAD_PATH.unshift File.join( File.dirname( __FILE__ ), "..", "lib" )
+
+require 'gravitext-devtools/line_counter'
+
+Gravitext::DevTools::LineCounter.new.run

data/bin/gt-header

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 #--
-# Copyright (c) 2008-2010 David Kellum
+# Copyright (c) 2008-2011 David Kellum
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you
 # may not use this file except in compliance with the License.  You may

data/bin/gt-manifest

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 #--
-# Copyright (c) 2008-2010 David Kellum
+# Copyright (c) 2008-2011 David Kellum
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you
 # may not use this file except in compliance with the License.  You may

data/lib/gravitext-devtools/base.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2010 David Kellum
+# Copyright (c) 2008-2011 David Kellum
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you
 # may not use this file except in compliance with the License.  You may
@@ -16,6 +16,6 @@
 
 module Gravitext
   module DevTools
-    VERSION = "1.0.1"
+    VERSION = "1.1.0"
   end
 end

data/lib/gravitext-devtools/header_writer.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2010 David Kellum
+# Copyright (c) 2008-2011 David Kellum
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you
 # may not use this file except in compliance with the License.  You may
@@ -39,6 +39,7 @@ module Gravitext
       attr_accessor :inception
       attr_accessor :license
       attr_accessor :exclusions
+      attr_accessor :inclusions
 
       class << self
         attr_accessor :instance
@@ -52,6 +53,7 @@ module Gravitext
 
         @git_lister = GitFileLister.new
 
+        @inclusions = []
         @exclusions = [ '**/.gitignore',
                         '**/.gt-config',
                         '**/History.rdoc',
@@ -90,14 +92,11 @@ module Gravitext
 
         Gravitext::DevTools.load_config_from_pwd
 
+        @git_lister.inclusions = @inclusions
         @git_lister.exclusions = @exclusions
-        # puts @exclusions.inspect
 
         files = @git_lister.files
 
-        # puts cached_header( :rb )
-        # exit
-
         files.each do |fname|
           HeaderProcessor.new( fname, @do_write ).process
         end
@@ -159,9 +158,9 @@ module Gravitext
         @do_write = do_write
         @fname = fname
         @format = case fname
-                  when /\.java$/
+                  when /\.(java|c|h)$/
                     :java
-                  when /\.xml$/
+                  when /\.(xml|htm(l?))$/
                     :xml
                   when /\.rb$/
                     :rb

data/lib/gravitext-devtools/line_counter.rb

@@ -0,0 +1,100 @@
+#--
+# Copyright (c) 2008-2011 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You may
+# obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'gravitext-devtools'
+require 'fileutils'
+
+module Gravitext
+  module DevTools
+
+    class LineCounter
+      include FileUtils
+      include Gravitext::DevTools
+
+      def initialize
+        @verbose = false
+        @git_lister = GitFileLister.new
+      end
+
+      def parse_options( args = ARGV )
+
+        @git_lister.parse_options( args ) do |opts|
+          opts.banner = "Usage:  gt-count [dir|file] ..."
+          opts.on( "-v", "--verbose",
+                   "Output per file counts" ) do
+            @verbose = true
+          end
+        end
+      end
+
+      def run( args = ARGV )
+
+        parse_options( args )
+
+        @git_lister.exclusions = []
+        git_files = @git_lister.files
+
+        show_count_line( "LANG/FILE", "LINES", "CODE" )
+        total_lines = total_code = 0
+
+        map = [ [ 'JAVA', [ '**/*.java' ] ],
+                [ 'RUBY', [ '**/*.rb', '**/bin/*', '**/init/*'] ] ]
+
+        map.each do | lang, fpats |
+          files = git_files.select { |f| @git_lister.match?( fpats, f ) }
+          lines, codelines = count_files( files )
+          show_count_line( lang, lines, codelines )
+          total_lines += lines
+          total_code  += codelines
+        end
+        show_count_line( "TOTAL", total_lines, total_code)
+
+      end
+
+      def count_lines( filename )
+        lines = codelines = 0
+        is_java = ( filename =~ /\.java$/ )
+
+        open( filename, 'r' ) { |f|
+          f.each do |line|
+            lines += 1
+            next if line =~ /^\s*$/
+            next if line =~ ( is_java ? %r{\s*[/*]} : /^\s*#/ )
+            codelines += 1
+          end
+        }
+        [ lines, codelines ]
+      end
+
+      def show_count_line(msg, lines, code)
+        printf( "%6s %6s %s\n", lines.to_s, code.to_s, msg )
+      end
+
+      def count_files( files )
+        total_lines = total_code = 0
+        files.each do |fn|
+          lines, codelines = count_lines( fn )
+          show_count_line( fn, lines, codelines ) if @verbose
+          total_lines += lines
+          total_code  += codelines
+        end
+        [ total_lines, total_code ]
+      end
+
+    end
+
+  end
+end

data/lib/gravitext-devtools/manifest_writer.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2010 David Kellum
+# Copyright (c) 2008-2011 David Kellum
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you
 # may not use this file except in compliance with the License.  You may

data/lib/gravitext-devtools.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2010 David Kellum
+# Copyright (c) 2008-2011 David Kellum
 #
 # Licensed under the Apache License, Version 2.0 (the "License"); you
 # may not use this file except in compliance with the License.  You may
@@ -55,6 +55,10 @@ module Gravitext
 
     class GitFileLister
 
+      # Inclusions to the list expressed in various ways
+      # Array<Regexp|Proc|String>
+      attr_accessor :inclusions
+
       # Exclusions to the list expressed in various ways
       # Array<Regexp|Proc|String>
       attr_accessor :exclusions
@@ -75,6 +79,7 @@ module Gravitext
                         %r{(^|/)src(/|$)},     # gt-manifest
                         'lib/**/*.jar',        # all
                         'Manifest.static' ]    # gt-manifest, gt-header
+        @inclusions = []
         @git_flags = []
         @extra_files = []
       end
@@ -107,11 +112,14 @@ module Gravitext
 
         files.map! { |f| f.strip }
         files.uniq!
-        files.reject { |f| exclude?( f ) }
+        unless @inclusions.empty?
+          files = files.select { |f| match?( @inclusions, f ) }
+        end
+        files.reject { |f| match?( @exclusions, f ) }
       end
 
-      def exclude?( fname )
-        @exclusions.any? do |ex|
+      def match?( list, fname )
+        list.any? do |ex|
           case ex
           when Proc
             ex.call( fname )

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gravitext-devtools
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - David Kellum
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-01 00:00:00 -07:00
+date: 2011-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,9 +44,9 @@ dependencies:
         hash: 27
         segments: 
         - 1
-        - 2
-        - 2
-        version: 1.2.2
+        - 3
+        - 0
+        version: 1.3.0
   type: :development
   version_requirements: *id002
 description: |-
@@ -55,10 +55,12 @@ description: |-
   gt-manifest:: Maintain manifest from git ls-files minus exclusions.
   gt-cleanws::  Cleanup whitespace in files.
   gt-header::   Add and maintain file license headers.
+  gt-count::    Count lines of code by type.
 email: 
 - dek-oss@gravitext.com
 executables: 
 - gt-cleanws
+- gt-count
 - gt-header
 - gt-manifest
 extensions: []
@@ -74,11 +76,13 @@ files:
 - README.rdoc
 - Rakefile
 - bin/gt-cleanws
+- bin/gt-count
 - bin/gt-header
 - bin/gt-manifest
 - lib/gravitext-devtools/base.rb
 - lib/gravitext-devtools.rb
 - lib/gravitext-devtools/header_writer.rb
+- lib/gravitext-devtools/line_counter.rb
 - lib/gravitext-devtools/manifest_writer.rb
 - templates/format/format.java
 - templates/format/format.rb