code_statistics 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/code_statistics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{code_statistics}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Mayer"]
-  s.date = %q{2009-11-15}
+  s.date = %q{2009-11-18}
   s.description = %q{"This is a port of the rails 'rake stats' method so it can be made more robust and work for non rails projects. New features may eventually be added as well."}
   s.email = %q{dan@devver.net}
   s.extra_rdoc_files = [

data/lib/code_statistics/code_statistics.rb

@@ -3,11 +3,12 @@ module CodeStatistics
 
     attr_reader :print_buffer
 
-    def initialize(*pairs)
+    def initialize(pairs, ignore_file_globs = [])
       @pairs        = pairs
       @test_types   = []
       @print_buffer = "" 
       directory     = Dir.pwd
+      @ignore_files = collect_files_to_ignore(ignore_file_globs)
 
       directories_to_search = ['app','test','spec','merb','features', 'bin']
       recursively_add_directories(directories_to_search)
@@ -37,6 +38,14 @@ module CodeStatistics
         end
       end
     end
+
+    def collect_files_to_ignore(ignore_file_globs)
+      files_to_remove = []
+      ignore_file_globs.each do |glob|
+        files_to_remove.concat(Dir[glob])
+      end
+      files_to_remove.map{ |filepath| File.expand_path(filepath)}
+    end
     
     def to_s
       @print_buffer = ''
@@ -70,18 +79,24 @@ module CodeStatistics
       @test_types << test_type
     end
     
+    def ignore_file?(file_path)
+      @ignore_files.include?(File.expand_path(file_path))
+    end
+
     def calculate_directory_statistics(directory, pattern = /.*\.rb$/)
       stats = { "lines" => 0, "codelines" => 0, "classes" => 0, "methods" => 0 }
 
       Dir.foreach(directory) do |file_name|
         if File.stat(directory + "/" + file_name).directory? and (/^\./ !~ file_name)
-          newstats = calculate_directory_statistics(directory + "/" + file_name, pattern)
+          newstats = calculate_directory_statistics(File.join(directory,file_name), pattern)
           stats.each { |k, v| stats[k] += newstats[k] }
         end
         
         next unless file_name =~ pattern
+        file_path = File.join(directory, file_name)
+        next if ignore_file?(file_path)
         
-        f = File.open(directory + "/" + file_name)
+        f = File.open(file_path)
         
         while line = f.gets
           stats["lines"] += 1

data/lib/tasks/code_stats.rb

@@ -13,15 +13,21 @@ if ENV['DIRECTORIES_TO_CALCULATE']
   end
 end
 
+if ENV['IGNORE_FILE_GLOBS']
+  user_ignored_dirs = ENV['IGNORE_FILE_GLOBS'].split(',')
+else
+  user_ignored_dirs = []
+end
+
 desc "Report code statistics (KLOCs, etc) from the application"
 task :stats do
   require File.join(File.dirname(__FILE__), '..', 'code_statistics', 'code_statistics')
-  puts CodeStatistics::CodeStatistics.new(*stats_directories).to_s
+  puts CodeStatistics::CodeStatistics.new(stats_directories, user_ignored_dirs).to_s
 end
 
 #this is for apps that already had a stats task, but want to use the newer features of this gem
 desc "Report code statistics (KLOCs, etc) from the application"
 task :code_stats do
   require File.join(File.dirname(__FILE__), '..', 'code_statistics', 'code_statistics')
-  puts CodeStatistics::CodeStatistics.new(*stats_directories).to_s
+  puts CodeStatistics::CodeStatistics.new(stats_directories, user_ignored_dirs).to_s
 end

data/test/code_statistics_test.rb

@@ -10,7 +10,7 @@ class CodeStatisticsTest < Test::Unit::TestCase
       file            = dir.file("real.rb", "this\nis\n\lame\n")
       controllers_dir = dir.directory("controllers")
       file            = controllers_dir.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new(["Libraries", 'lib'])
+      code_stats      = CodeStatistics::CodeStatistics.new([["Libraries", 'lib']])
       assert code_stats.to_s.match(/Libraries/)
       assert code_stats.to_s.match(/Code LOC: 6/)
     end
@@ -21,7 +21,7 @@ class CodeStatisticsTest < Test::Unit::TestCase
       dir             = construct.directory("app")
       controllers_dir = dir.directory("controllers")
       file            = controllers_dir.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new()
+      code_stats      = CodeStatistics::CodeStatistics.new([])
       assert code_stats.to_s.match(/App\/controllers/)
       assert code_stats.to_s.match(/Code LOC: 3/)
     end
@@ -32,7 +32,7 @@ class CodeStatisticsTest < Test::Unit::TestCase
       dir             = construct.directory("app")
       sub_dir         = dir.directory("servers")
       file            = sub_dir.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new()
+      code_stats      = CodeStatistics::CodeStatistics.new([])
       assert code_stats.to_s.match(/App\/servers/)
       assert code_stats.to_s.match(/Code LOC: 3/)
     end
@@ -45,7 +45,7 @@ class CodeStatisticsTest < Test::Unit::TestCase
       file            = sub_dir.file("fake.rb", "this\nis\n\lame\n")
       sub_dir2        = dir.directory("controllers")
       file            = sub_dir2.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new()
+      code_stats      = CodeStatistics::CodeStatistics.new([])
       assert code_stats.to_s.match(/Spec\/models/)
       assert code_stats.to_s.match(/Spec\/controllers/)
       assert code_stats.to_s.match(/Test LOC: 6/)
@@ -56,7 +56,7 @@ class CodeStatisticsTest < Test::Unit::TestCase
     within_construct do |construct|
       dir             = construct.directory("spec")
       file            = dir.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new()
+      code_stats      = CodeStatistics::CodeStatistics.new([])
       assert code_stats.to_s.match(/Spec/)
       assert code_stats.to_s.match(/Test LOC: 3/)
     end
@@ -69,7 +69,7 @@ class CodeStatisticsTest < Test::Unit::TestCase
       file            = sub_dir.file("fake.rb", "this\nis\n\lame\n")
       sub_dir2        = dir.directory("controllers")
       file            = sub_dir2.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new()
+      code_stats      = CodeStatistics::CodeStatistics.new([])
       assert code_stats.to_s.match(/Test\/models/)
       assert code_stats.to_s.match(/Test\/controllers/)
       assert code_stats.to_s.match(/Test LOC: 6/)
@@ -80,7 +80,7 @@ class CodeStatisticsTest < Test::Unit::TestCase
     within_construct do |construct|
       dir             = construct.directory("test")
       file            = dir.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new()
+      code_stats      = CodeStatistics::CodeStatistics.new([])
       assert code_stats.to_s.match(/Test/)
       assert code_stats.to_s.match(/Test LOC: 3/)
     end
@@ -99,12 +99,32 @@ class CodeStatisticsTest < Test::Unit::TestCase
       file            = sub_dir.file("fake.rb", "this\nis\n\lame\n")
       sub_dir2        = dir.directory("controllers")
       file            = sub_dir2.file("fake.rb", "this\nis\n\lame\n")
-      code_stats      = CodeStatistics::CodeStatistics.new()
+      code_stats      = CodeStatistics::CodeStatistics.new([])
       assert code_stats.to_s.match(/Code LOC: 12/)
       assert code_stats.to_s.match(/Test LOC: 6/)
       assert code_stats.to_s.match(/Code to Test Ratio: 1:0.5/)
     end
   end
 
+  should "ignore the expected file globs" do
+    within_construct do |construct|
+      dir             = construct.directory("app")
+      sub_dir         = dir.directory("models")
+      file            = sub_dir.file("fake.rb", "this\n"*9)
+      sub_dir2        = dir.directory("controllers")
+      file            = sub_dir2.file("fake.rb", "this\nis\n\lame\n")
+
+      dir             = construct.directory("test")
+      sub_dir         = dir.directory("models")
+      file            = sub_dir.file("fake.rb", "this\nis\n\lame\n")
+      sub_dir2        = dir.directory("controllers")
+      file            = sub_dir2.file("fake.rb", "this\nis\n\lame\n")
+      code_stats      = CodeStatistics::CodeStatistics.new([],['app/controllers/**/*'])
+      assert code_stats.to_s.match(/Code LOC: 9/)
+      assert code_stats.to_s.match(/Test LOC: 6/)
+      assert code_stats.to_s.match(/Code to Test Ratio: 1:0.7/)
+    end
+  end
+
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: code_statistics
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Dan Mayer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-15 00:00:00 -05:00
+date: 2009-11-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency