rails_stats 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 944d0c8334fdcb76cec1a8f46b4df162318e79a8
+  data.tar.gz: 937553b382a844f1eaf2e7aade385ba8440ec1b6
+SHA512:
+  metadata.gz: 8ab477ff73f0e87134f71761397358388fb10947f8afad91da6ddc828c235eaf872116097be0747273a3c40d441808528e507c6e7814a89b5ea9da9702db832d
+  data.tar.gz: 5803869bde15c3d38e2e41b6f1f279dc4993187cfe77e2d4148f67093b6b82fceab9e966e895e2ce0a874b1e80dbeb43b0084c555e34f868808257d97e4d4b81

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_stats.gemspec
+gemspec
+
+gem 'debugger'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,40 @@
+# RailsStats
+
+See stuff about a Rails app.
+
+```bash
+$ bundle exec thor stats:calculate ~/path/to/app/
+
+Directory: ~/path/to/app/
+
++----------------------+-------+-------+---------+---------+-----+-------+
+| Name                 | Lines |   LOC | Classes | Methods | M/C | LOC/M |
++----------------------+-------+-------+---------+---------+-----+-------+
+| Controllers          |  1848 |  1483 |      32 |     174 |   5 |     6 |
+| Helpers              |  2257 |  1892 |      45 |     245 |   5 |     5 |
+| Jobs                 |   399 |   295 |      11 |      33 |   3 |     6 |
+| Models               |  4584 |  3509 |      61 |     526 |   8 |     4 |
+| Observers            |    42 |    22 |       2 |       5 |   2 |     2 |
+| Libraries            |  2987 |  2272 |      30 |     287 |   9 |     5 |
+| Configuration        |  1233 |   669 |       4 |      17 |   4 |    37 |
+| Spec Support         |  1416 |  1152 |       4 |      30 |   7 |    36 |
+| Integration Tests    |    91 |    73 |       0 |       1 |   0 |    71 |
+| Lib Tests            |   101 |    83 |       0 |       1 |   0 |    81 |
+| Model Tests          |  3397 |  2522 |       0 |      18 |   0 |   138 |
+| Cucumber Support     |   739 |   521 |       0 |       1 |   0 |   519 |
+| Cucumber Features    |  2711 |  2487 |      29 |     145 |   5 |    15 |
++----------------------+-------+-------+---------+---------+-----+-------+
+| Total                | 21805 | 16980 |     218 |    1483 |   6 |     9 |
++----------------------+-------+-------+---------+---------+-----+-------+
+  Code LOC: 10142     Test LOC: 6838     Code to Test Ratio: 1:0.7
+
+```
+
+### TODO
+
+* option to print out by app directory (stats per engine)
+* Add views (jbuilder, erb, haml) but don't count towards ratios
+* Support JS for projects that have it in public
+* Add css but don't count towards ratios
+* output other metrics like number of tables and columns
+* test unit support

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/rails_stats/app_statistics.rb

@@ -0,0 +1,61 @@
+module RailsStats
+  class AppStatistics
+    attr_reader :statistics, :total, :test
+
+    def initialize(directory)
+      @test = false
+      @directory  = directory
+      @statistics = calculate_statistics
+      @total      = calculate_total
+    end
+
+    def key_concepts
+      directories.collect{ |path| File.basename(path) }
+    end
+
+    private
+
+    def calculate_total
+      out = CodeStatisticsCalculator.new
+      @statistics.each do |key, stats|
+        out.add(stats)
+      end
+      out
+    end
+
+    def calculate_statistics
+      Util.calculate_statistics(directories)
+    end
+
+    def directories
+      return @directories if @directories
+      out = []
+      Dir.foreach(@directory) do |file_name|
+        path = File.join(@directory, file_name)
+        next unless File.directory?(path)
+        next if (/^\./ =~ file_name)
+        next if file_name == "assets" # doing separately
+        next if file_name == "views"  # TODO
+        out << path
+      end
+
+      assets = File.join(@directory, "assets")
+      if File.directory?(assets)
+        Dir.foreach(assets) do |file_name|
+          path = File.join(assets, file_name)
+          next unless File.directory?(path)
+          next if (/^\./ =~ file_name)
+
+          case file_name
+          when "javascripts"
+            out << path
+          # TODO when "css"
+          end
+        end
+      end
+
+      out
+    end
+  end
+
+end

data/lib/rails_stats/code_statistics.rb

@@ -0,0 +1,160 @@
+# railties/lib/rails/code_statistics.rb
+
+module RailsStats
+  class CodeStatistics
+
+    RAILS_APP_FOLDERS = ['models',
+                         'controllers',
+                         'helpers',
+                         'mailers',
+                         'views',
+                         'assets']
+
+    def initialize(root_directory)
+      @root_directory = root_directory
+      @key_concepts   = calculate_key_concepts
+      @projects       = calculate_projects
+      @statistics     = calculate_statistics
+      @total          = calculate_total
+    end
+
+    def to_s
+      print_header
+      @statistics.each { |key, stats| print_line(key, stats) }
+      print_splitter
+
+      if @total
+        print_line("Total", @total)
+        print_splitter
+      end
+
+      print_code_test_stats
+    end
+
+    private
+      def calculate_key_concepts
+        # returns names of main things like models, controllers, services, etc
+        concepts = {}
+        app_projects.each do |project|
+          project.key_concepts.each do |key|
+            concepts[key] = true
+          end
+        end
+
+        # TODO: maybe gem names?
+
+        concepts.keys
+      end
+
+      def calculate_projects
+        out = []
+        out += app_projects
+        out += calculate_root_projects
+        out += calculate_gem_projects
+        out += calculate_spec_projects
+        out += calculate_test_projects
+        out += calculate_cucumber_projects
+        out
+      end
+
+      def app_projects
+        @app_projects ||= calculate_app_projects
+      end
+
+      def calculate_app_projects
+        apps = Util.calculate_projects(@root_directory, "**", "app", RAILS_APP_FOLDERS)
+        apps.collect do |root_path|
+          AppStatistics.new(root_path)
+        end
+      end
+
+      def calculate_gem_projects
+        gems = Util.calculate_projects(@root_directory, "**", "*.gemspec")
+        gems.collect do |root_path|
+          GemStatistics.new(root_path)
+        end
+      end
+
+      def calculate_spec_projects
+        specs = Util.calculate_projects(@root_directory, "**", "spec", "spec_helper.rb")
+        specs.collect do |root_path|
+          SpecStatistics.new(root_path, @key_concepts)
+        end
+      end
+
+      def calculate_test_projects
+        [] # TODO: test unit
+      end
+
+      def calculate_root_projects
+        [RootStatistics.new(@root_directory)]
+      end
+
+      def calculate_cucumber_projects
+        cukes = Util.calculate_projects(@root_directory, "**", "*.feature")
+        cukes.collect do |root_path|
+          CucumberStatistics.new(root_path)
+        end
+      end
+
+      def calculate_statistics
+        out = {}
+        @projects.each do |project|
+          project.statistics.each do |key, stats|
+            out[key] ||= CodeStatisticsCalculator.new(project.test)
+            out[key].add(stats)
+          end
+        end
+        out
+      end
+
+      def calculate_total
+        @statistics.each_with_object(CodeStatisticsCalculator.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 v.test }
+        code_loc
+      end
+
+      def calculate_tests
+        test_loc = 0
+        @statistics.each { |k, v| test_loc += v.code_lines if v.test }
+        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/rails_stats/code_statistics_calculator.rb

@@ -0,0 +1,89 @@
+# railties/lib/rails/code_statistics_calculator.rb
+
+module RailsStats
+  class CodeStatisticsCalculator #:nodoc:
+    attr_reader :lines, :code_lines, :classes, :methods, :test
+
+    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: /[-=]>/,
+      },
+      feature: {
+        class: /^\s*Feature:/,
+        method: /^\s*Scenario:/,
+      }
+    }
+
+    def initialize(test=false)
+      @test = test
+      @lines = 0
+      @code_lines = 0
+      @classes = 0
+      @methods = 0
+    end
+
+    def add(code_statistics_calculator)
+      @lines += code_statistics_calculator.lines
+      @code_lines += code_statistics_calculator.code_lines
+      @classes += code_statistics_calculator.classes
+      @methods += code_statistics_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/rails_stats/cucumber_statistics.rb

@@ -0,0 +1,46 @@
+module RailsStats
+  class CucumberStatistics
+    attr_reader :statistics, :total, :test
+
+    def initialize(directory)
+      @test = true
+      @directory    = directory
+      @statistics   = calculate_statistics
+      @total        = calculate_total
+    end
+
+    private
+
+    def calculate_total
+      out = CodeStatisticsCalculator.new(true)
+      @statistics.each do |key, stats|
+        out.add(stats)
+      end
+      out
+    end
+
+    def calculate_statistics
+      out = {}
+      categorize_files.each do |key, list|
+        out[key] = Util.calculate_file_statistics(list)
+      end 
+      out
+    end
+
+    def categorize_files
+      out = {}
+      Dir[File.join(@directory, "**", "*.rb")].each do |file_path|
+        out["Cucumber Support"] ||= []
+        out["Cucumber Support"]  << file_path
+      end
+
+      Dir[File.join(@directory, "**", "*.feature")].each do |file_path|
+        out["Cucumber Features"] ||= []
+        out["Cucumber Features"]  << file_path
+      end
+
+      out
+    end
+  end
+
+end

data/lib/rails_stats/gem_statistics.rb

@@ -0,0 +1,31 @@
+module RailsStats
+  class GemStatistics
+    attr_reader :statistics, :total, :test
+
+    def initialize(directory)
+      @test = false
+      @directory  = directory
+      @statistics = calculate_statistics
+      @total      = calculate_total
+    end
+
+    private
+
+    def calculate_total
+      out = CodeStatisticsCalculator.new
+      @statistics.each do |key, stats|
+        out.add(stats)
+      end
+      out
+    end
+
+    def calculate_statistics
+      # ignore gem/app so as to not double-count engines
+      lib = File.join(@directory, "lib")
+      Util.calculate_statistics([lib]) do |path|
+        "Gems"
+      end
+    end
+  end
+
+end