rails_code_stats 0.0.1

data/MIT_LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2010 Nathan Humbert
+
+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

@@ -0,0 +1,6 @@
+Rails Code Stats
+
+Improved rails code statistics.
+
+
+Copyright (c) 2009-2010 Nathan Humbert, released under the MIT license

data/lib/code_statistics.rb

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

data/lib/command_line_metric_output.rb

@@ -0,0 +1,43 @@
+class CommandLineMetricOutput
+	require 'rails_app_source_metrics'
+
+	def initialize
+		metrics = RailsAppSourceMetrics.new()
+		print_header
+		metrics.code_sections.each { |section| print_section(section) }
+		print_splitter
+		print_totals(metrics)
+	end
+
+
+	def print_splitter
+		puts "+----------------------+-------+-------+---------+---------+-----+-------+"
+	end
+
+	def print_header
+		print_splitter
+		puts "| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |"
+		print_splitter
+	end
+
+	def print_section(section)
+		puts "| #{section[:name].ljust(20)} "+ print_stats(section[:stats])
+	end
+
+	def print_totals(metrics)
+		puts "| #{'Totals'.ljust(20)} "+ print_stats(metrics.totals)
+		print_splitter
+		puts "  Code LOC: #{metrics.lines_of_code}     Test LOC: #{metrics.lines_of_test_code}     Code to Test Ratio: 1:#{sprintf("%.1f", metrics.code_to_test_ratio)}"
+		puts ""
+	end
+
+	def print_stats(stats)
+			 "| #{stats[:lines].to_s.rjust(5)} " +
+			 "| #{stats[:lines_of_code].to_s.rjust(5)} " +
+			 "| #{stats[:classes].to_s.rjust(7)} " +
+			 "| #{stats[:methods].to_s.rjust(7)} " +
+			 "| #{stats[:methods_per_class].to_s.rjust(3)} " +
+			 "| #{stats[:lines_of_code_per_method].to_s.rjust(5)} |"
+	end
+
+end

data/lib/directory_source_stats.rb

@@ -0,0 +1,72 @@
+class DirectorySourceStats
+	def initialize(directory)
+		@stats = { :lines => 0, :lines_of_code => 0, :classes => 0, :methods => 0 }
+		if File.exists?(directory)
+			calculate_directory_statistics(directory)
+		end
+	end
+
+	def get_stats
+		return @stats
+	end
+
+private
+
+	def calculate_directory_statistics(directory)
+		Dir.foreach(directory) do |file_name| 
+			path = directory + "/" + file_name
+			if subdirectory?(path) and !hidden?(file_name)
+				calculate_directory_statistics(path)
+			elsif source_file?(file_name)
+				process_source_file(path)
+			end
+		end
+	end
+
+	def source_file?(file_name)
+		file_name =~ /.*\.rb$/
+	end
+
+	def hidden?( file_name )
+		file_name =~ /^\./
+	end
+
+	def subdirectory?(path)
+		File.stat(path).directory?  
+	end
+	
+	def process_source_file(path)
+		file_handle = File.open(path)
+		parse_source_file(file_handle)
+		file_handle.close
+	end
+
+	def parse_source_file(file_handle)
+		while line = file_handle.gets
+			@stats[:lines]     += 1
+			@stats[:classes]   += 1 if class_definition?(line)
+			@stats[:methods]   += 1 if method_call?(line)
+			@stats[:lines_of_code] += 1 unless whitespace_or_comment?(line)
+		end
+	end
+
+	def class_definition?(line)
+		return line =~ /^\s*class [A-Z]/
+	end
+
+	def method_call?(line)
+		return ( line =~ /def [a-z]/ or shoulda_method_call?(line) or test_unit_method_call?(line) )
+	end
+
+	def shoulda_method_call?(line)
+		return line =~ /^\s*should\s+(".*"|'.*')\s+do\s*$/
+	end
+
+	def test_unit_method_call?(line)
+		return line =~ /^\s*test\s+(".*"|'.*')\s+do\s*$/
+	end
+
+	def whitespace_or_comment?(line)
+		return line =~ /^\s*$/ || line =~ /^\s*#/
+	end
+end

data/lib/rails_app_source_metrics.rb

@@ -0,0 +1,74 @@
+class RailsAppSourceMetrics
+	require 'directory_source_stats'
+
+	CODE_SECTIONS = [
+			{ :name => "Controllers", :directory => "app/controllers/" },
+			{ :name => "Helpers", :directory => "app/helpers/" },
+			{ :name => "Models", :directory => "app/models/" },
+			{ :name => "Libraries", :directory => "lib/" },
+			{ :name => "Integration Tests", :directory => "test/integration/" },
+			{ :name => "Functional Tests", :directory => "test/functional/" },
+			{ :name => "Unit Tests", :directory => "test/unit/" }
+		]
+
+	attr_reader :code_sections, :totals, :lines_of_code, :lines_of_test_code, :code_to_test_ratio
+	
+	def initialize
+		@code_sections = CODE_SECTIONS
+		@code_sections.each do |section|
+			source_stats = DirectorySourceStats.new(File.join(Rails.root, section[:directory]))
+			section[:stats] = add_metrics_to_stats(source_stats.get_stats)
+		end
+		calculate_totals
+	end
+
+
+private
+	def add_metrics_to_stats(stats)
+		stats = methods_per_class(stats)
+		stats = lines_of_code_per_method(stats)	
+		return stats
+	end
+
+	def methods_per_class(stats)
+		begin
+			stats[:methods_per_class] = (stats[:methods] / stats[:classes])
+		rescue
+			stats[:methods_per_class] = 0
+		end
+		return stats
+	end
+
+	def lines_of_code_per_method(stats)
+		begin
+			stats[:lines_of_code_per_method] = (stats[:lines_of_code] / stats[:methods])
+		rescue
+			stats[:lines_of_code_per_method] = 0
+		end
+		return stats
+	end
+
+	def calculate_totals
+		@lines_of_code = code_totals[:lines_of_code]
+		@lines_of_test_code = test_totals[:lines_of_code]
+		@code_to_test_ratio = @lines_of_test_code / @lines_of_code.to_f
+		@totals = base_totals(@code_sections)
+	end
+
+	def test_totals
+		test_code_sections = @code_sections.select { |section| section[:directory] =~ /^test/ }
+		return base_totals(test_code_sections)
+	end
+
+	def code_totals
+		test_code_sections = @code_sections.select { |section| section[:directory] !~ /^test/ }
+		return base_totals(test_code_sections)
+	end
+
+	def base_totals(code_sections)
+    total = { :lines => 0, :lines_of_code => 0, :classes => 0, :methods => 0 }
+		code_sections.each { |section| section[:stats].each { |k, v| total[k] += v if total.has_key?(k) } }
+		return add_metrics_to_stats(total)
+	end
+
+end

data/lib/rails_code_stats/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails_code_stats'
+require 'rails'
+module RailsCodeStats
+  class Railtie < Rails::Railtie
+    railtie_name :rails_code_stats
+    
+    rake_tasks do
+      load "tasks/rails_code_stats.rake"
+    end
+
+  end
+end

data/lib/rails_code_stats.rb

@@ -0,0 +1,5 @@
+module RailsCodeStats
+
+  require 'rails_code_stats/railtie' if defined?(Rails)
+
+end

data/lib/tasks/rails_code_stats.rake

@@ -0,0 +1,5 @@
+desc "Rails application code statistics"
+task(:rails_code_stats) do
+  require 'command_line_metric_output'
+  CommandLineMetricOutput.new()
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: rails_code_stats
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathan Humbert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: This gem calculates basic code statistics on a rails app
+email: 
+- nathan.humbert+rcs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- MIT_LICENSE
+- lib/tasks/rails_code_stats.rake
+- lib/rails_code_stats/railtie.rb
+- lib/rails_code_stats.rb
+- lib/code_statistics.rb
+- lib/command_line_metric_output.rb
+- lib/directory_source_stats.rb
+- lib/rails_app_source_metrics.rb
+has_rdoc: true
+homepage: http://github.com/nathanhumbert/rails_code_stats
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rails Code Stats
+test_files: []
+