code_statistics 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Devver
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,18 @@
+= code_statistics
+
+This is a port of the rails 'rake stat' so it can be used on none rails projects and have it's features slowly expanded. 
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Devver. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+require 'lib/tasks/code_stats'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "code_statistics"
+    gem.summary = %Q{Making a gem of the normal rails rake stats method, to make it more robust and work on non rails projects}
+    gem.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."}
+    gem.email = "dan@devver.net"
+    gem.homepage = "http://github.com/danmayer/code_statistics"
+    gem.authors = ["Dan Mayer"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "code_statistics #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/code_statistics.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{code_statistics}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Mayer"]
+  s.date = %q{2009-10-23}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "code_statistics.gemspec",
+     "lib/code_statistics.rb",
+     "lib/code_statistics/code_statistics.rb",
+     "lib/tasks/code_stats.rb",
+     "test/code_statistics_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/danmayer/code_statistics}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Making a gem of the normal rails rake stats method, to make it more robust and work on non rails projects}
+  s.test_files = [
+    "test/code_statistics_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/lib/code_statistics.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'tasks', 'code_stats')

data/lib/code_statistics/code_statistics.rb

@@ -0,0 +1,109 @@
+module CodeStatistics
+  class CodeStatistics #:nodoc:
+    
+    TEST_TYPES = %w(Units Functionals Unit\ tests Functional\ tests Integration\ tests)
+    
+    def initialize(*pairs)
+      @pairs = pairs
+      @statistics = calculate_statistics
+      @total = calculate_total if pairs.length > 1
+    end
+    
+    def to_s
+      print_header
+      @pairs.each { |pair| print_line(pair.first, @statistics[pair.first]) }
+      print_splitter
+      
+      if @total
+        print_line("Total", @total)
+        print_splitter
+      end
+      
+      print_code_test_stats
+    end
+    
+    private
+    def calculate_statistics
+      @pairs.inject({}) { |stats, pair| stats[pair.first] = calculate_directory_statistics(pair.last); stats }
+    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)
+          stats.each { |k, v| stats[k] += newstats[k] }
+        end
+        
+        next unless file_name =~ pattern
+        
+        f = File.open(directory + "/" + file_name)
+        
+        while line = f.gets
+          stats["lines"] += 1
+          stats["classes"] += 1 if line =~ /class [A-Z]/
+          stats["methods"] += 1 if line =~ /def [a-z]/
+          stats["codelines"] += 1 unless line =~ /^\s*$/ || line =~ /^\s*#/
+        end
+      end
+      
+      stats
+    end
+    
+    def calculate_total
+      total = { "lines" => 0, "codelines" => 0, "classes" => 0, "methods" => 0 }
+      @statistics.each_value { |pair| pair.each { |k, v| total[k] += v } }
+      total
+    end
+    
+    def calculate_code
+      code_loc = 0
+      @statistics.each { |k, v| code_loc += v['codelines'] unless TEST_TYPES.include? k }
+      code_loc
+    end
+    
+    def calculate_tests
+      test_loc = 0
+      @statistics.each { |k, v| test_loc += v['codelines'] if TEST_TYPES.include? k }
+      test_loc
+    end
+    
+    def print_header
+      print_splitter
+      puts "| Name | Lines | LOC | Classes | Methods | M/C | LOC/M |"
+      print_splitter
+    end
+    
+    def print_splitter
+      puts "+----------------------+-------+-------+---------+---------+-----+-------+"
+    end
+    
+    def print_line(name, statistics)
+      m_over_c = (statistics["methods"] / statistics["classes"]) rescue m_over_c = 0
+      loc_over_m = (statistics["codelines"] / statistics["methods"]) - 2 rescue loc_over_m = 0
+      
+      start = if TEST_TYPES.include? name
+                "| #{name.ljust(20)} "
+              else
+                "| #{name.ljust(20)} "
+              end
+      
+      puts 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)} |"
+    end
+    
+    def print_code_test_stats
+      code = calculate_code
+      tests = calculate_tests
+      
+      puts " Code LOC: #{code}  Test LOC: #{tests}  Code to Test Ratio: 1:#{sprintf("%.1f", tests.to_f/code)}"
+      puts ""
+    end
+  end
+end

data/lib/tasks/code_stats.rb

@@ -0,0 +1,16 @@
+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)
+].collect { |name, dir| [ name, "#{Dir.pwd}/#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+ 
+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
+end

data/test/code_statistics_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+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"
+  end
+end

data/test/test_helper.rb

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: code_statistics
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dan Mayer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "\"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.\""
+email: dan@devver.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- code_statistics.gemspec
+- lib/code_statistics.rb
+- lib/code_statistics/code_statistics.rb
+- lib/tasks/code_stats.rb
+- test/code_statistics_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/danmayer/code_statistics
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- 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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Making a gem of the normal rails rake stats method, to make it more robust and work on non rails projects
+test_files: 
+- test/code_statistics_test.rb
+- test/test_helper.rb