rails_stats_fb 2.1.0.pre1

data/lib/rails_stats/root_statistics.rb

@@ -0,0 +1,42 @@
+module RailsStats
+  class RootStatistics
+    attr_reader :statistics, :total, :test
+
+    ROOT_FOLDERS = {
+      "lib" => "Libraries",
+      "config" => "Configuration"
+    }
+
+    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
+      Util.calculate_statistics(directories) do |folder|
+        ROOT_FOLDERS[File.basename(folder)]
+      end
+    end
+
+    def directories
+      out = []
+      ROOT_FOLDERS.each do |folder, name|
+        out << File.join(@directory, folder)
+      end
+      out
+    end
+  end
+
+end

data/lib/rails_stats/spec_statistics.rb

@@ -0,0 +1,76 @@
+module RailsStats
+  class SpecStatistics
+    attr_reader :statistics, :total, :test
+
+    SPEC_FOLDERS = ['controllers',
+                    'features',
+                    'helpers',
+                    'models',
+                    'requests',
+                    'routing',
+                    'integrations',
+                    'integration',
+                    'mailers',
+                    'lib',
+                    'acceptance',
+                    'factories']
+
+    def initialize(directory, key_concepts)
+      @test = true
+      @directory    = directory
+      @key_concepts = key_concepts
+      @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|
+        if file_path =~ /.*_spec.rb$/
+          key = categorize_file(file_path)
+        else
+          key = "Spec Support"
+        end
+
+        out[key] ||= []
+        out[key]  << file_path
+      end
+
+      out
+    end
+
+    def categorize_file(file_path)
+      types = (@key_concepts + SPEC_FOLDERS).uniq
+      types.each do |folder|
+        if file_path =~ /\/#{folder}\//
+          folder = Inflector.humanize(folder)
+          folder = Inflector.titleize(folder)
+          folder = Inflector.singularize(folder)
+          return "#{folder} Tests"
+        end
+      end
+
+      # something else
+      return "Other Tests"
+    end
+  end
+
+end

data/lib/rails_stats/stats_calculator.rb

@@ -0,0 +1,169 @@
+module RailsStats
+  class StatsCalculator
+    RAILS_APP_FOLDERS = ['models',
+                         'controllers',
+                         'helpers',
+                         'mailers',
+                         'views',
+                         'assets']
+
+    def initialize(root_directory)
+      @root_directory = root_directory
+      @schema_path    = File.join(@root_directory, "db", "schema.rb")
+      @structure_path = File.join(@root_directory, "db", "structure.sql")
+      @key_concepts   = calculate_key_concepts
+      @projects       = calculate_projects
+      @statistics     = calculate_statistics
+      @code_loc       = calculate_code
+      @test_loc       = calculate_tests
+      @schema         = calculate_create_table_calls
+      @polymorphic    = calculate_polymorphic
+      @files_total, @code_total, @tests_total, @grand_total = calculate_totals
+    end
+
+    attr_reader :code_loc, :code_total, :files_total, :grand_total, :statistics, :test_loc, :tests_total, :schema, :schema_path, :structure_path, :polymorphic
+
+    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_shared_projects("spec", @root_directory, "**", "spec", "**", "*_spec.rb")
+        specs.collect do |root_path|
+          SpecStatistics.new(root_path, @key_concepts)
+        end
+      end
+
+      def calculate_test_projects
+        tests = Util.calculate_shared_projects("test", @root_directory, "**", "test", "**", "*_test.rb")
+        tests.collect do |root_path|
+          TestStatistics.new(root_path, @key_concepts)
+        end
+      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_totals
+        files_total = @statistics.sum do |k,value|
+          value.files_total
+        end
+
+        code_total = @statistics.each_with_object(CodeStatisticsCalculator.new) do |pair, code_total|
+          code_total.add(pair.last) unless pair.last.test
+        end
+
+        tests_total = @statistics.each_with_object(CodeStatisticsCalculator.new) do |pair, tests_total|
+          tests_total.add(pair.last) if pair.last.test
+        end
+
+        grand_total = @statistics.each_with_object(CodeStatisticsCalculator.new) do |pair, total|
+          total.add(pair.last)
+        end
+
+        [files_total, code_total, tests_total, grand_total]
+      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 calculate_create_table_calls
+        if @schema_path && File.exist?(@schema_path)
+          count_create_table_calls(schema_path, "create_table")
+        elsif @structure_path && File.exist?(@structure_path)
+          count_create_table_calls(structure_path, "CREATE TABLE")
+        else
+          0
+        end
+      end
+
+      def count_create_table_calls(file_path, keyword)
+        create_table_count = 0
+        File.foreach(file_path) do |line|
+          create_table_count += 1 if line.strip.start_with?(keyword)
+        end
+        create_table_count
+      end
+
+      def calculate_polymorphic
+        polymorphic_count = 0
+        Dir.glob(File.join(@root_directory, "app", "models", "*.rb")).each do |file|
+          File.foreach(file) do |line|
+            if line =~ /belongs_to\s+:\w+,\s+polymorphic:\s+true/
+              polymorphic_count += 1
+            end
+          end
+        end
+        polymorphic_count
+      end
+  end
+end

data/lib/rails_stats/stats_formatter.rb

@@ -0,0 +1,13 @@
+module RailsStats
+  class StatsFormatter
+    def initialize(calculator, opts = {})
+      @calculator  = calculator
+      @statistics  = calculator.statistics
+      @code_total  = calculator.code_total
+      @tests_total = calculator.tests_total
+      @grand_total = calculator.grand_total
+    end
+
+    attr_reader :calculator
+  end
+end

data/lib/rails_stats/tasks.rb

@@ -0,0 +1,14 @@
+desc "Report code statistics (KLOCs, etc) from the current (or given) application"
+task :stats, [:path, :format] do |t, args|
+  Rake::Task["stats"].clear # clear out normal one if there
+  require 'rails_stats/all'
+
+  path = args[:path]
+  path = Rails.root.to_s if defined?(Rails)
+  fmt = args[:format] || ""
+  raise "no path given for stats" unless path
+
+  root_directory = File.absolute_path(path)
+  puts "\nDirectory: #{root_directory}\n\n" if args[:path]
+  RailsStats::CodeStatistics.new(root_directory, format: fmt).to_s
+end

data/lib/rails_stats/test_statistics.rb

@@ -0,0 +1,74 @@
+module RailsStats
+  class TestStatistics
+    attr_reader :statistics, :total, :test
+
+    SPEC_FOLDERS = ['controllers',
+                    'functional',
+                    'helpers',
+                    'models',
+                    'requests',
+                    'unit',
+                    'integrations',
+                    'integration',
+                    'mailers',
+                    'lib']
+
+    def initialize(directory, key_concepts)
+      @test = true
+      @directory    = directory
+      @key_concepts = key_concepts
+      @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|
+        if file_path =~ /.*_test.rb$/
+          key = categorize_file(file_path)
+        else
+          key = "Test Support"
+        end
+
+        out[key] ||= []
+        out[key]  << file_path
+      end
+
+      out
+    end
+
+    def categorize_file(file_path)
+      types = (@key_concepts + SPEC_FOLDERS).uniq
+      types.each do |folder|
+        if file_path =~ /\/#{folder}\//
+          folder = Inflector.humanize(folder)
+          folder = Inflector.titleize(folder)
+          folder = Inflector.singularize(folder)
+          return "#{folder} Tests"
+        end
+      end
+
+      # something else
+      return "Other Tests"
+    end
+  end
+
+end

data/lib/rails_stats/util.rb

@@ -0,0 +1,111 @@
+module RailsStats
+  module Util
+    extend self
+
+    def calculate_projects(*args)
+      projects = {}
+
+      children = [args.pop].flatten
+      parent   = args.flatten
+      children.each do |dirname|
+        child_folder_pattern = File.join(*(parent.dup + [dirname]))
+        Dir[child_folder_pattern].each do |marker_path|
+          next if marker_path =~ /\/vendor\//
+
+          projects[File.absolute_path(File.dirname(marker_path))] = true
+        end
+      end
+
+      out = projects.keys
+
+      # TODO: make sure none are children of other ones in there
+      out
+    end
+
+    def calculate_shared_projects(shared, *args)
+      projects = {}
+      calculate_projects(*args).each do |path|
+        if path =~ /(^.*\/#{shared}\/).*/
+          projects[$1] = true
+        end
+      end
+
+      out = projects.keys
+
+      # TODO: make sure none are children of other ones in there
+      out
+    end
+
+    def calculate_file_statistics(file, type = :code, &block)
+      stats = CodeStatisticsCalculator.new
+
+      files = [file].flatten
+
+      files.each do |path|
+        stats.add_by_file_path(path)
+      end
+
+      stats
+    end
+
+    def calculate_statistics(directories, type = :code, &block)
+      out = {}
+
+      directories = [directories].flatten
+      is_test = (type.to_s == "test")
+
+      directories.each do |dir_path|
+        next unless File.directory?(dir_path)
+
+        key = nil
+        if block_given?
+          key = yield(dir_path)
+        end
+
+        key = path_to_name(dir_path, is_test) if !key || key.length == 0
+
+        out[key] ||= CodeStatisticsCalculator.new(is_test)
+        out[key].add(calculate_directory_statistics(dir_path))
+      end
+
+      out.keys.each do |key|
+        out.delete(key) if out[key].lines == 0
+      end
+
+      out
+    end
+
+    def calculate_directory_statistics(directory, pattern = /.*\.(rb|js|coffee|feature)$/)
+      stats = CodeStatisticsCalculator.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 path_to_name(path, is_test)
+      folder = File.basename(path)
+      folder = Inflector.humanize(folder)
+      folder = Inflector.titleize(folder)
+
+      if is_test
+        folder = Inflector.singularize(folder)
+        folder = "#{folder} Tests"
+      else
+        folder = Inflector.pluralize(folder)
+      end
+
+      folder
+    end
+  end
+end

data/lib/rails_stats/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RailsStats
+  VERSION = "2.1.0.pre1"
+end

data/lib/rails_stats.rb

@@ -0,0 +1,9 @@
+require "rails_stats/version"
+
+module RailsStats
+
+end
+
+require 'rake'
+require 'rails_stats/tasks'
+

data/pull_request_template.md

@@ -0,0 +1,9 @@
+**IMPORTANT**: Please read the README before submitting pull requests for this project. Additionally, if your PR closes any open GitHub issues, make sure you include _Closes #XXXX_ in your comment or use the option on the PR's sidebar to add related issues to auto-close the issue that your PR fixes.
+
+- [ ] Add an entry to `CHANGELOG.md` that links to this PR under the "main (unreleased)" heading.
+
+**Description:**
+
+Please include a summary of the change and which issue is fixed or which feature is introduced. If changes to the behavior are made, clearly describe what changes.
+
+I will abide by the [code of conduct](CODE_OF_CONDUCT.md).

data/rails_stats.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_stats/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_stats_fb"
+  spec.version       = RailsStats::VERSION
+  spec.authors       = ["Brian Leonard"]
+  spec.email         = ["brian@bleonard.com"]
+  spec.summary       = %q{Analyze a Rails project}
+  spec.description   = %q{Point it to a directory and see stuff about the app}
+  spec.homepage      = "https://github.com/fastruby/rails_stats"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rake"
+  spec.add_dependency "bundler-stats", ">= 2.1"
+end

data/test/dummy/Gemfile

@@ -0,0 +1,43 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.6.8'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '~> 6.0.3', '>= 6.0.3.3'
+# Use Puma as the app server
+gem 'puma', '~> 4.1'
+# Use SCSS for stylesheets
+gem "sass-rails"
+# Transpile app-like JavaScript. Read more: https://github.com/rails/webpacker
+gem 'webpacker', '~> 4.0'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.7'
+# Use Redis adapter to run Action Cable in production
+# gem 'redis', '~> 4.0'
+# Use Active Model has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Active Storage variant
+# gem 'image_processing', '~> 1.2'
+gem 'rails_stats', path: '../../../rails_stats'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', '>= 1.4.2', require: false
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+end
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.2'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  include Pagy::Backend
+
+  def hello
+    p hello
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+module ApplicationHelper
+  include Pagy::Frontend
+end

data/test/dummy/app/javascript/channels/consumer.js

@@ -0,0 +1,6 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+
+import { createConsumer } from "@rails/actioncable"
+
+export default createConsumer()

data/test/dummy/app/javascript/channels/index.js

@@ -0,0 +1,5 @@
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+const channels = require.context('.', true, /_channel\.js$/)
+channels.keys().forEach(channels)