code_statistics 0.1.9 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.9
+0.2.0

data/code_statistics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{code_statistics}
-  s.version = "0.1.9"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Mayer"]
-  s.date = %q{2009-11-09}
+  s.date = %q{2009-11-15}
   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

@@ -1,38 +1,45 @@
 module CodeStatistics
   class CodeStatistics #:nodoc:
-    
-    TEST_TYPES = %w(Units Functionals Unit\ tests Functional\ tests Integration\ tests)
-    
-    
+
+    attr_reader :print_buffer
+
     def initialize(*pairs)
-      @pairs       = pairs
-      @test_types  = []
-      directory    = Dir.pwd
-      @specs_found = false
+      @pairs        = pairs
+      @test_types   = []
+      @print_buffer = "" 
+      directory     = Dir.pwd
 
-      #if tests weren't broken up into test/unit functional etc, add the root test directory
-      if local_file_exists?(directory, 'test') &&
-          (!local_file_exists?(directory, 'test/unit') &&
-           !local_file_exists?(directory, 'test/functional') &&
-           !local_file_exists?(directory, 'test/integration'))
-        @pairs << %w(Tests test)
-      end
+      directories_to_search = ['app','test','spec','merb','features', 'bin']
+      recursively_add_directories(directories_to_search)
 
       @pairs.each do |key, dir_path|
-        add_test_type(key) if dir_path.match(/^test\//) || dir_path.match(/^spec\//)
-      end
-
-      #if spec tests weren't broken up into smaller test directories add the root spec directory
-      if @specs_found==false && local_file_exists?(directory, 'spec')
-        @pairs << %w(Specs spec)
-        add_test_type("Specs")
+        add_test_type(key) if dir_path.match(/^test/) || dir_path.match(/^spec/) || dir_path.match(/^features/)
       end
 
       @statistics  = calculate_statistics
       @total       = calculate_total if pairs.length > 1
     end
+
+    def recursively_add_directories(dirs)
+      dirs.each do |dir|
+        if File.directory?(dir)
+          entries = Dir.entries(dir)
+          entries = entries.reject{ |entry| entry=='.' || entry=='..' }
+          has_directories = false
+          entries.each do |entry|
+            entry_path = File.join(dir,entry)
+            if File.directory?(entry_path) 
+              @pairs << [entry_path.capitalize, entry_path]
+              has_directories = true
+            end
+          end
+          @pairs << [dir.capitalize, dir] unless has_directories
+        end
+      end
+    end
     
     def to_s
+      @print_buffer = ''
       print_header
       @pairs.each { |pair| print_line(pair.first, @statistics[pair.first]) }
       print_splitter
@@ -43,6 +50,7 @@ module CodeStatistics
       end
       
       print_code_test_stats
+      @print_buffer
     end
     
     private
@@ -55,11 +63,10 @@ module CodeStatistics
     end
 
     def test_types
-      (TEST_TYPES + @test_types).uniq
+      @test_types.uniq
     end
 
     def add_test_type(test_type)
-      @specs_found = true if test_type.match(/spec/i)
       @test_types << test_type
     end
     
@@ -107,12 +114,12 @@ module CodeStatistics
     
     def print_header
       print_splitter
-      puts "| Name | Lines | LOC | Classes | Methods | M/C | LOC/M |"
+      @print_buffer << "| Name | Lines | LOC | Classes | Methods | M/C | LOC/M |\n"
       print_splitter
     end
     
     def print_splitter
-      puts "+----------------------+-------+-------+---------+---------+-----+-------+"
+      @print_buffer << "+----------------------+-------+-------+---------+---------+-----+-------+\n"
     end
     
     def print_line(name, statistics)
@@ -125,13 +132,13 @@ module CodeStatistics
                 "| #{name.ljust(20)} "
               end
       
-      puts start +
+      @print_buffer << start +
         "| #{statistics["lines"].to_s.rjust(5)} " +
         "| #{statistics["codelines"].to_s.rjust(5)} " +
         "| #{statistics["classes"].to_s.rjust(7)} " +
         "| #{statistics["methods"].to_s.rjust(7)} " +
         "| #{m_over_c.to_s.rjust(3)} " +
-        "| #{loc_over_m.to_s.rjust(5)} |"
+        "| #{loc_over_m.to_s.rjust(5)} |\n"
     end
     
     def print_code_test_stats
@@ -143,8 +150,8 @@ module CodeStatistics
       else
         "0.0"
       end
-      puts " Code LOC: #{code}  Test LOC: #{tests}  Code to Test Ratio: 1:#{ratio}"
-      puts ""
+      @print_buffer << " Code LOC: #{code}  Test LOC: #{tests}  Code to Test Ratio: 1:#{ratio}\n"
+      @print_buffer << "\n"
     end
   end
 end

data/lib/tasks/code_stats.rb

@@ -1,23 +1,7 @@
-#todo for both spec and test look through top level add any directory seperately
-#get rid of the hard coded test/units / etc in this file and the lib file.
 stats_directories = [
-  %w(Controllers app/controllers),
-  %w(Helpers app/helpers),
-  %w(Models app/models),
   %w(Libraries lib/),
-  %w(APIs app/apis),
-  %w(Integration\ tests test/integration),
-  %w(Functional\ tests test/functional),
-  %w(Unit\ tests test/unit),
-  %w(Model\ specs spec/models), 
-  %w(View\ specs spec/views),
-  %w(Controller\ specs spec/controllers),
-  %w(Helper\ specs spec/helpers),
-  %w(Library\ specs spec/lib),
-  %w(Routing\ specs spec/routing),
-  %w(Integration\ specs spec/integration),
-  %w(Public\ specs spec/public),
-  %w(Semipublic\ specs spec/semipublic)
+  %w(Source source/),
+  %w(Src src/),
 ].collect { |name, dir| [ name, "#{Dir.pwd}/#{dir}" ] }.select { |name, dir| File.directory?(dir) }
 
 if ENV['DIRECTORIES_TO_CALCULATE']
@@ -32,5 +16,12 @@ end
 desc "Report code statistics (KLOCs, etc) from the application"
 task :stats do
   require File.join(File.dirname(__FILE__), '..', 'code_statistics', 'code_statistics')
-  CodeStatistics::CodeStatistics.new(*stats_directories).to_s
+  puts CodeStatistics::CodeStatistics.new(*stats_directories).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
 end

data/test/code_statistics_test.rb

@@ -1,8 +1,110 @@
-#require 'test_helper'
 require File.expand_path("test_helper", File.dirname(__FILE__))
 
 class CodeStatisticsTest < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+
+  include Construct::Helpers
+
+  should "find passed in directory" do
+    within_construct do |construct|
+      dir             = construct.directory("lib")
+      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'])
+      assert code_stats.to_s.match(/Libraries/)
+      assert code_stats.to_s.match(/Code LOC: 6/)
+    end
+  end
+  
+  should "find app controllers directory" do
+    within_construct do |construct|
+      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()
+      assert code_stats.to_s.match(/App\/controllers/)
+      assert code_stats.to_s.match(/Code LOC: 3/)
+    end
+  end
+
+  should "find app non rails directory" do
+    within_construct do |construct|
+      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()
+      assert code_stats.to_s.match(/App\/servers/)
+      assert code_stats.to_s.match(/Code LOC: 3/)
+    end
+  end
+
+  should "add spec sub directories and count as test code" do
+    within_construct do |construct|
+      dir             = construct.directory("spec")
+      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()
+      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/)
+    end
+  end
+
+  should "add spec root directory and count as test code" do
+    within_construct do |construct|
+      dir             = construct.directory("spec")
+      file            = dir.file("fake.rb", "this\nis\n\lame\n")
+      code_stats      = CodeStatistics::CodeStatistics.new()
+      assert code_stats.to_s.match(/Spec/)
+      assert code_stats.to_s.match(/Test LOC: 3/)
+    end
   end
+
+  should "add test sub directories and count as test code" do
+    within_construct do |construct|
+      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()
+      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/)
+    end
+  end
+
+  should "add test root directory and count as test code" do
+    within_construct do |construct|
+      dir             = construct.directory("test")
+      file            = dir.file("fake.rb", "this\nis\n\lame\n")
+      code_stats      = CodeStatistics::CodeStatistics.new()
+      assert code_stats.to_s.match(/Test/)
+      assert code_stats.to_s.match(/Test LOC: 3/)
+    end
+  end
+
+  should "calculate correct test to code ratio" 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()
+      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
+
+
 end

data/test/test_helper.rb

@@ -1,10 +1,11 @@
 require 'rubygems'
 require 'test/unit'
 require 'shoulda'
+require 'construct'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'code_statistics'
+require 'code_statistics/code_statistics'
 
 class Test::Unit::TestCase
 end

metadata

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