code_metrics 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,3 @@
+= CodeStatistics
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CodeMetrics'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+load File.expand_path('../lib/tasks/statistics.rake', __FILE__)
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/bin/code_metrics

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'code_metrics'
+require 'code_metrics/statistics'
+# TODO, remove this duplicate code
+root = defined?(Rails) ? Rails.root : Dir.pwd
+STATS_DIRECTORIES = [
+  %w(Controllers        app/controllers),
+  %w(Helpers            app/helpers),
+  %w(Models             app/models),
+  %w(Mailers            app/mailers),
+  %w(Javascripts        app/assets/javascripts),
+  %w(Libraries          lib/),
+  %w(APIs               app/apis),
+  %w(Controller\ tests  test/controllers),
+  %w(Helper\ tests      test/helpers),
+  %w(Model\ tests       test/models),
+  %w(Mailer\ tests      test/mailers),
+  %w(Integration\ tests test/integration),
+  %w(Functional\ tests\ (old)  test/functional),
+  %w(Unit\ tests \ (old)       test/unit)
+].collect { |name, dir| [ name, "#{root}/#{dir}" ] }.select { |name, dir| File.directory?(dir) }
+CodeMetrics::Statistics.new(*STATS_DIRECTORIES).to_s

data/bin/code_metrics-profile

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# Example:
+#   code_metrics-profile activesupport/lib/active_support.rb [ruby-prof mode]
+
+require 'code_metrics'
+require 'code_metrics/profiler'
+if (filename = ARGV.shift)
+  path = File.expand_path(filename)
+  mode = ARGV.shift
+  CodeMetrics::Profiler.new(path, mode).profile_requires rescue STDERR.puts(
+   "#{$!.message}\t #{$!.class} on #{$!.backtrace.detect {|line| line =~ /code_metrics/ }}"
+  )
+else
+  STDERR.puts "No file path entered. Usage is code_metrics-profile path/to/file.rb [ruby-prof mode]"
+end

data/lib/code_metrics.rb

@@ -0,0 +1,10 @@
+module CodeMetrics
+  require 'code_metrics/version'
+  require 'code_metrics/statistics'
+  $VERBOSE = nil
+  if defined?(Rails)
+    require 'code_metrics/railtie'
+  else
+    load "tasks/statistics.rake"
+  end
+end

data/lib/code_metrics/profiler.rb

@@ -0,0 +1,96 @@
+module CodeMetrics
+
+  class Profiler
+    Error = Class.new(StandardError)
+
+    attr_reader :path, :mode
+    def initialize(path, mode=nil)
+      assert_ruby_file_exists(path)
+      @path, @mode = path, mode
+      Gem.refresh
+      # H/T https://github.com/pry/pry/blob/b02d0a4863/lib/pry/plugins.rb#L72
+      Gem::Specification.respond_to?(:each) ? Gem::Specification.all : Gem.source_index
+      require 'benchmark'
+    end
+
+    def profile_requires
+      GC.start
+      before_rss = `ps -o rss= -p #{Process.pid}`.to_i
+
+      if mode
+        require 'ruby-prof'
+        RubyProf.measure_mode = RubyProf.const_get(mode.upcase)
+        RubyProf.start
+      else
+        Object.instance_eval { include RequireProfiler }
+      end
+
+      elapsed = Benchmark.realtime { require path }
+      results = RubyProf.stop if mode
+
+      GC.start
+      after_rss = `ps -o rss= -p #{Process.pid}`.to_i
+
+      if mode
+        if printer = ARGV.shift
+          RubyProf.const_get("#{printer.to_s.classify}Printer").new(results).print($stdout)
+        elsif RubyProf.const_defined?(:CallStackPrinter)
+          File.open("#{File.basename(path, '.rb')}.#{mode}.html", 'w') do |out|
+            RubyProf::CallStackPrinter.new(results).print(out)
+          end
+        else
+          File.open("#{File.basename(path, '.rb')}.#{mode}.callgrind", 'w') do |out|
+            RubyProf::CallTreePrinter.new(results).print(out)
+          end
+        end
+      end
+
+      RequireProfiler.stats.each do |file, depth, sec|
+        if sec
+          puts "%8.1f ms  %s%s" % [sec * 1000, ' ' * depth, file]
+        else
+          puts "#{' ' * (13 + depth)}#{file}"
+        end
+      end
+      puts "%8.1f ms  %d KB RSS" % [elapsed * 1000, after_rss - before_rss]
+    end
+
+    private
+
+    def assert_ruby_file_exists(path)
+      raise Error.new("No such file") unless File.exists?(path)
+      ruby_extension = path[/\.rb\Z/]
+      ruby_executable = File.open(path, 'rb').readline[/\A#!.*ruby/]
+      raise Error.new("Not a ruby file") unless ruby_extension or ruby_executable
+    end
+
+  end
+
+  module RequireProfiler
+    private
+    def require(file, *args) RequireProfiler.profile(file) { super } end
+    def load(file, *args) RequireProfiler.profile(file) { super } end
+
+    @depth, @stats = 0, []
+    class << self
+      attr_accessor :depth
+      attr_accessor :stats
+
+      def profile(file)
+        stats << [file, depth]
+        self.depth += 1
+        result = nil
+        elapsed = Benchmark.realtime { result = yield }
+        self.depth -= 1
+        stats.pop if stats.last.first == file
+        stats << [file, depth, elapsed] if result
+        result
+      end
+    end
+  end
+end
+if $0 == __FILE__
+  path = File.expand_path(ARGV.shift)
+  mode = ARGV.shift
+  CodeMetrics::Profiler.new(path, mode).profile_requires
+end

data/lib/code_metrics/railtie.rb

@@ -0,0 +1,11 @@
+require 'code_metrics'
+require 'rails'
+module CodeMetrics
+  class Railtie < Rails::Railtie
+    railtie_name :code_metrics
+
+    rake_tasks do
+      load "tasks/statistics.rake"
+    end
+  end
+end

data/lib/code_metrics/statistics.rb

@@ -0,0 +1,106 @@
+require 'code_metrics/statistics_calculator'
+require 'code_metrics/stats_directories'
+
+module CodeMetrics #:nodoc:
+  class Statistics
+
+    TEST_TYPES = ['Controller tests',
+                  'Helper tests',
+                  'Model tests',
+                  'Mailer tests',
+                  'Integration tests',
+                  'Functional tests (old)',
+                  'Unit tests (old)']
+
+    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
+        Hash[@pairs.map{|pair| [pair.first, calculate_directory_statistics(pair.last)]}]
+      end
+
+      def calculate_directory_statistics(directory, pattern = /.*\.(rb|js|coffee)$/)
+        stats = StatisticsCalculator.new
+
+        Dir.foreach(directory) do |file_name|
+          path = "#{directory}/#{file_name}"
+
+          if File.directory?(path) && (/^\./ !~ file_name)
+            stats.add(calculate_directory_statistics(path, pattern))
+          end
+
+          next unless file_name =~ pattern
+
+          stats.add_by_file_path(path)
+        end
+
+        stats
+      end
+
+      def calculate_total
+        @statistics.each_with_object(StatisticsCalculator.new) do |pair, total|
+          total.add(pair.last)
+        end
+      end
+
+      def calculate_code
+        code_loc = 0
+        @statistics.each { |k, v| code_loc += v.code_lines unless TEST_TYPES.include? k }
+        code_loc
+      end
+
+      def calculate_tests
+        test_loc = 0
+        @statistics.each { |k, v| test_loc += v.code_lines 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.code_lines / statistics.methods) - 2 rescue loc_over_m = 0
+
+        puts "| #{name.ljust(20)} " \
+             "| #{statistics.lines.to_s.rjust(5)} " \
+             "| #{statistics.code_lines.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/code_metrics/statistics_calculator.rb

@@ -0,0 +1,81 @@
+module CodeMetrics
+  class StatisticsCalculator #:nodoc:
+    attr_reader :lines, :code_lines, :classes, :methods
+
+    PATTERNS = {
+      rb: {
+        line_comment: /^\s*#/,
+        begin_block_comment: /^=begin/,
+        end_block_comment: /^=end/,
+        class: /^\s*class\s+[_A-Z]/,
+        method: /^\s*def\s+[_a-z]/,
+      },
+      js: {
+        line_comment: %r{^\s*//},
+        begin_block_comment: %r{^\s*/\*},
+        end_block_comment: %r{\*/},
+        method: /function(\s+[_a-zA-Z][\da-zA-Z]*)?\s*\(/,
+      },
+      coffee: {
+        line_comment: /^\s*#/,
+        begin_block_comment: /^\s*###/,
+        end_block_comment: /^\s*###/,
+        class: /^\s*class\s+[_A-Z]/,
+        method: /[-=]>/,
+      }
+    }
+
+    def initialize(lines = 0, code_lines = 0, classes = 0, methods = 0)
+      @lines = lines
+      @code_lines = code_lines
+      @classes = classes
+      @methods = methods
+    end
+
+    def add(code_metrics_calculator)
+      @lines += code_metrics_calculator.lines
+      @code_lines += code_metrics_calculator.code_lines
+      @classes += code_metrics_calculator.classes
+      @methods += code_metrics_calculator.methods
+    end
+
+    def add_by_file_path(file_path)
+      File.open(file_path) do |f|
+        self.add_by_io(f, file_type(file_path))
+      end
+    end
+
+    def add_by_io(io, file_type)
+      patterns = PATTERNS[file_type] || {}
+
+      comment_started = false
+
+      while line = io.gets
+        @lines += 1
+
+        if comment_started
+          if patterns[:end_block_comment] && line =~ patterns[:end_block_comment]
+            comment_started = false
+          end
+          next
+        else
+          if patterns[:begin_block_comment] && line =~ patterns[:begin_block_comment]
+            comment_started = true
+            next
+          end
+        end
+
+        @classes   += 1 if patterns[:class] && line =~ patterns[:class]
+        @methods   += 1 if patterns[:method] && line =~ patterns[:method]
+        if line !~ /^\s*$/ && (patterns[:line_comment].nil? || line !~ patterns[:line_comment])
+          @code_lines += 1
+        end
+      end
+    end
+
+    private
+      def file_type(file_path)
+        File.extname(file_path).sub(/\A\./, '').downcase.to_sym
+      end
+  end
+end

data/lib/code_metrics/stats_directories.rb

@@ -0,0 +1,28 @@
+# Try to get the root of the current project
+module CodeMetrics
+  class StatsDirectories
+    def initialize
+      @root = (defined?(Rails) &&  Rails.root) || Dir.pwd
+    end
+    def directories
+      [
+      %w(Controllers        app/controllers),
+      %w(Helpers            app/helpers),
+      %w(Models             app/models),
+      %w(Mailers            app/mailers),
+      %w(Javascripts        app/assets/javascripts),
+      %w(Libraries          lib/),
+      %w(APIs               app/apis),
+      %w(Controller\ tests  test/controllers),
+      %w(Helper\ tests      test/helpers),
+      %w(Model\ tests       test/models),
+      %w(Mailer\ tests      test/mailers),
+      %w(Integration\ tests test/integration),
+      %w(Functional\ tests\ (old)  test/functional),
+      %w(Unit\ tests \ (old)       test/unit)
+    ].collect { |name, dir| [ name, "#{@root}/#{dir}" ] }
+     .select { |name, dir| File.directory?(dir) }
+
+    end
+  end
+end

data/lib/code_metrics/version.rb

@@ -0,0 +1,3 @@
+module CodeMetrics
+  VERSION = "0.0.1"
+end

data/lib/tasks/statistics.rake

@@ -0,0 +1,14 @@
+begin
+  require 'rake'
+  namespace :code_metrics do
+
+    desc "Report code statistics (KLOCs, etc) from the application"
+    task :stats do
+      require 'code_metrics/statistics'
+      STATS_DIRECTORIES = CodeMetrics::StatsDirectories.new.directories
+      CodeMetrics::Statistics.new(*STATS_DIRECTORIES).to_s
+    end
+  end
+rescue LoadError
+  STDERR.puts "Cannot load rake code_metrics:stats task, rake not available"
+end