rails_stats 1.0.1 → 2.0.0

data/lib/rails_stats/stats_calculator.rb

@@ -0,0 +1,137 @@
+module RailsStats
+  class StatsCalculator
+    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
+      @code_loc       = calculate_code
+      @test_loc       = calculate_tests
+      @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
+
+    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
+  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

@@ -1,13 +1,14 @@
 desc "Report code statistics (KLOCs, etc) from the current (or given) application"
-task :stats, [:path] do |t, args|
+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).to_s
-end
+  RailsStats::CodeStatistics.new(root_directory, format: fmt).to_s
+end

data/lib/rails_stats/test_statistics.rb

@@ -35,7 +35,7 @@ module RailsStats
       out = {}
       categorize_files.each do |key, list|
         out[key] = Util.calculate_file_statistics(list)
-      end 
+      end
       out
     end
 

data/lib/rails_stats/util.rb

@@ -29,7 +29,7 @@ module RailsStats
           projects[$1] = true
         end
       end
-      
+
       out = projects.keys
 
       # TODO: make sure none are children of other ones in there
@@ -56,14 +56,14 @@ module RailsStats
 
       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

data/lib/rails_stats/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RailsStats
-  VERSION = "1.0.1"
+  VERSION = "2.0.0"
 end

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

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   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/bleonard/rails_stats"
+  spec.homepage      = "https://github.com/fastruby/rails_stats"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rake"
-  spec.add_development_dependency "bundler", "~> 1.6"
+  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)

data/test/dummy/app/javascript/packs/application.js

@@ -0,0 +1,16 @@
+// This file is automatically compiled by Webpack, along with any other files
+// present in this directory. You're encouraged to place your actual application logic in
+// a relevant structure within app/javascript and only use these pack files to reference
+// that code so it'll be compiled.
+
+require("@rails/ujs").start()
+require("@rails/activestorage").start()
+require("channels")
+
+
+// Uncomment to copy all static images under ../images to the output folder and reference
+// them with the image_pack_tag helper in views (e.g <%= image_pack_tag 'rails.png' %>)
+// or the `imagePath` JavaScript helper below.
+//
+// const images = require.context('../images', true)
+// const imagePath = (name) => images(name, true)

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,7 @@
+class ApplicationJob < ActiveJob::Base
+  # Automatically retry jobs that encountered a deadlock
+  # retry_on ActiveRecord::Deadlocked
+
+  # Most jobs are safe to ignore if the underlying records are no longer available
+  # discard_on ActiveJob::DeserializationError
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+    <%= javascript_pack_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/test/dummy/bin/yarn

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  begin
+    exec "yarnpkg", *ARGV
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,35 @@
+require_relative 'boot'
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+require "active_record/railtie"
+require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_mailbox/engine"
+require "action_text/engine"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 6.0
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+
+    # Don't generate system test files.
+    config.generators.system_tests = nil
+  end
+end

data/test/dummy/config/boot.rb

@@ -0,0 +1,4 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.
+require 'bootsnap/setup' # Speed up boot time by caching expensive operations.

data/test/dummy/config/cable.yml

@@ -0,0 +1,10 @@
+development:
+  adapter: async
+
+test:
+  adapter: test
+
+production:
+  adapter: redis
+  url: <%= ENV.fetch("REDIS_URL") { "redis://localhost:6379/1" } %>
+  channel_prefix: dummy_production

data/test/dummy/config/credentials.yml.enc

@@ -0,0 +1 @@
+kVQyiT2sFnPIwIVdzuBHvP1JZmyvV+vtZJ0KzfELfTDZln4s6lDaBbczomzzpgspU6/H3T0eGQk7vret3yy9Aghr9zD/moDfSvbUcniOKX/orcGlUo8cr04C5+POsIjETLI3IpE0uSvuZRiWs6bGH92AYAH+kQJar7pGyoMJLStb0WZgqFhXUGhv4d5C7ko7oXu5JojXtFpybvTUSu5SUxUsRgwobgHxVwItFzkLdxuBHgS5crUszCLnLJtjzzQw+svFUAYyRpSGgKO4v6ikHgf1coBZXCnSVmAy/7KiXD+pYj/cQG7mprblx6eryuTRN7M41lFe+54sCKLqVsosnON+cMAWY4OgXnsK4cQ9YZtSP2P6kLGWgK89dttkzPyzkICBBAihtUTDNtzE4dFoSLKtBL/0+XfW/Kja--IZq8NitCVQ3OGILn--phUrzOOviX2c97WDp14Htg==

data/test/dummy/config/database.yml

@@ -0,0 +1,85 @@
+# PostgreSQL. Versions 9.3 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On macOS with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On macOS with MacPorts:
+#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem 'pg'
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see Rails configuration guide
+  # https://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+
+development:
+  <<: *default
+  database: dummy_development
+
+  # The specified database role being used to connect to postgres.
+  # To create additional roles in postgres see `$ createuser --help`.
+  # When left blank, postgres will use the default role. This is
+  # the same name as the operating system user that initialized the database.
+  #username: dummy
+
+  # The password associated with the postgres role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: dummy_test
+
+# As with config/credentials.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password as a unix environment variable when you boot
+# the app. Read https://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full rundown on how to provide these environment variables in a
+# production deployment.
+#
+# On Heroku and other platform providers, you may have a full connection URL
+# available as an environment variable. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# You can use this database configuration with:
+#
+#   production:
+#     url: <%= ENV['DATABASE_URL'] %>
+#
+production:
+  <<: *default
+  database: dummy_production
+  username: dummy
+  password: <%= ENV['DUMMY_DATABASE_PASSWORD'] %>

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!