rails_stats_fb 2.1.0.pre1

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,33 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# The following keys must be escaped otherwise they will not be retrieved by
+# the default I18n backend:
+#
+# true, false, on, off, yes, no
+#
+# Instead, surround them with single quotes.
+#
+# en:
+#   'true': 'foo'
+#
+# To learn more, please read the Rails Internationalization guide
+# available at https://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/master.key

@@ -0,0 +1 @@
+246a12207cbb2a763152376cbf8ef28c

data/test/dummy/config/puma.rb

@@ -0,0 +1,38 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
+end

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+Spring.watch(
+  ".ruby-version",
+  ".rbenv-vars",
+  "tmp/restart.txt",
+  "tmp/caching-dev.txt"
+)

data/test/dummy/config/storage.yml

@@ -0,0 +1,34 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket
+
+# Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/test/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/test/dummy/db/schema.rb

@@ -0,0 +1,10 @@
+
+ActiveRecord::Schema[7.0].define(version: 2023_04_25_154701) do
+  create_table "users", force: :cascade do |t|
+    t.string "email"
+  end
+  create_table "comments", force: :cascade do |t|
+    t.bigint  :commentable_id
+    t.string  :commentable_type
+  end
+end

data/test/dummy/lib/monkeypatches.rb

@@ -0,0 +1 @@
+puts "Monkeypatches go here"

data/test/dummy/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "dummy",
+  "private": true,
+  "dependencies": {
+    "@rails/ujs": "^6.0.0",
+    "@rails/activestorage": "^6.0.0",
+    "@rails/actioncable": "^6.0.0"
+  },
+  "version": "0.1.0"
+}

data/test/dummy/spec/models/user_spec.rb

@@ -0,0 +1,3 @@
+class FooBar
+
+end

data/test/dummy/spec/support/support_file.rb

@@ -0,0 +1 @@
+puts "This is a spec support file"

data/test/dummy/test/models/user_test.rb

@@ -0,0 +1,2 @@
+class UserTest
+end

data/test/dummy/test/support/test_helper.rb

@@ -0,0 +1 @@
+puts "This is a test support file"

data/test/fixtures/console-output.txt

@@ -0,0 +1,43 @@
++-----------------------|------------|----------------+
+|                  Name | Total Deps | 1st Level Deps |
++-----------------------|------------|----------------+
+|     simplecov-console | 8          | 3              |
+|               codecov | 4          | 1              |
+|           rails_stats | 4          | 2              |
+|             simplecov | 3          | 3              |
+|       minitest-around | 1          | 1              |
+|               bundler | 0          | 0              |
+|                byebug | 0          | 0              |
+|              minitest | 0          | 0              |
+| minitest-spec-context | 0          | 0              |
++-----------------------|------------|----------------+
+
+      Declared Gems   9
+         Total Gems   18
+  Unpinned Versions   6
+        Github Refs   0
+
++----------------------+---------+---------+---------+---------+---------+-----+-------+
+| Name                 | Files   | Lines   |     LOC | Classes | Methods | M/C | LOC/M |
++----------------------+---------+---------+---------+---------+---------+-----+-------+
+| Channels             |       2 |       8 |       8 |       2 |       0 |   0 |     0 |
+| Configuration        |      19 |     417 |     111 |       1 |       0 |   0 |     0 |
+| Controllers          |       1 |       7 |       6 |       1 |       1 |   1 |     4 |
+| Helpers              |       1 |       3 |       3 |       0 |       0 |   0 |     0 |
+| Javascripts          |       3 |      27 |       7 |       0 |       0 |   0 |     0 |
+| Jobs                 |       1 |       7 |       2 |       1 |       0 |   0 |     0 |
+| Libraries            |       1 |       1 |       1 |       0 |       0 |   0 |     0 |
+| Mailers              |       1 |       4 |       4 |       1 |       0 |   0 |     0 |
+| Model Tests          |       2 |       5 |       4 |       2 |       0 |   0 |     0 |
+| Models               |       4 |      10 |      10 |       4 |       0 |   0 |     0 |
+| Spec Support         |       1 |       1 |       1 |       0 |       0 |   0 |     0 |
+| Test Support         |       1 |       1 |       1 |       0 |       0 |   0 |     0 |
++----------------------+---------+---------+---------+---------+---------+-----+-------+
+| Code                 |      33 |     484 |     152 |      10 |       1 |   0 |   150 |
+| Tests                |       4 |       7 |       6 |       2 |       0 |   0 |     0 |
+| Total                |      37 |     491 |     158 |      12 |       1 |   0 |   156 |
++----------------------+---------+---------+---------+---------+---------+-----+-------+
+  Code LOC: 152     Test LOC: 6     Code to Test Ratio: 1:0.0  Files: 37
+
+  Polymorphic models count: 1 polymorphic associations
+  Schema Stats: 2 `create_table` calls in schema.rb

data/test/lib/rails_stats/code_statistics_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+Minitest::Test.make_my_diffs_pretty!
+
+describe RailsStats::CodeStatistics do
+  describe "#to_s" do
+    it "outputs useful stats for a Rails project" do
+      root_directory = File.expand_path('../../../test/dummy', File.dirname(__FILE__))
+      table = File.read(File.expand_path('../../../fixtures/console-output.txt', __FILE__))
+
+      out, err = capture_io do
+        RailsStats::CodeStatistics.new(root_directory).to_s
+      end
+
+      assert_equal(
+        table.lines.map(&:rstrip).join,
+        out.lines.map(&:rstrip).join
+      )
+    end
+  end
+end

data/test/lib/rails_stats/json_formatter_test.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe RailsStats::JSONFormatter do
+  describe "#result" do
+    JSON_STRING = <<~EOS
+      [{
+        "summary": {
+          "declared": 9,
+          "unpinned": 6,
+          "total": 18,
+          "github": 0
+        },
+        "gems": [
+          {
+            "name": "simplecov-console",
+            "total_dependencies": 8,
+            "first_level_dependencies": 3,
+            "top_level_dependencies": {},
+            "transitive_dependencies": [
+              "ansi (>= 0)",
+              "simplecov (>= 0)",
+              "terminal-table (>= 0)",
+              "docile (~> 1.1)",
+              "simplecov-html (~> 0.11)",
+              "simplecov_json_formatter (~> 0.1)",
+              "unicode-display_width (>= 1.1.1, < 4)",
+              "unicode-emoji (~> 4.0, >= 4.0.4)"
+            ]
+          },
+          {
+            "name": "codecov",
+            "total_dependencies": 4,
+            "first_level_dependencies": 1,
+            "top_level_dependencies": {},
+            "transitive_dependencies": [
+              "simplecov (>= 0.15, < 0.22)",
+              "docile (~> 1.1)",
+              "simplecov-html (~> 0.11)",
+              "simplecov_json_formatter (~> 0.1)"
+            ]
+          },
+          {
+            "name": "rails_stats",
+            "total_dependencies": 4,
+            "first_level_dependencies": 2,
+            "top_level_dependencies": {},
+            "transitive_dependencies": [
+              "bundler-stats (>= 2.1)",
+              "rake (>= 0)",
+              "bundler (>= 1.9, < 3)",
+              "thor (>= 0.19.0, < 2.0)"
+            ]
+          },
+          {
+            "name": "simplecov",
+            "total_dependencies": 3,
+            "first_level_dependencies": 3,
+            "top_level_dependencies": {
+              "codecov": "codecov (0.6.0)",
+              "simplecov-console": "simplecov-console (0.9.3)"
+            },
+            "transitive_dependencies": [
+              "docile (~> 1.1)",
+              "simplecov-html (~> 0.11)",
+              "simplecov_json_formatter (~> 0.1)"
+            ]
+          },
+          {
+            "name": "minitest-around",
+            "total_dependencies": 1,
+            "first_level_dependencies": 1,
+            "top_level_dependencies": {},
+            "transitive_dependencies": [
+              "minitest (~> 5.0)"
+            ]
+          },
+          {
+            "name": "bundler",
+            "total_dependencies": 0,
+            "first_level_dependencies": 0,
+            "top_level_dependencies": {
+              "bundler-stats": "bundler-stats (2.4.0)",
+              "rails_stats": "rails_stats (2.0.1)"
+            },
+            "transitive_dependencies": []
+          },
+          {
+            "name": "byebug",
+            "total_dependencies": 0,
+            "first_level_dependencies": 0,
+            "top_level_dependencies": {},
+            "transitive_dependencies": []
+          },
+          {
+            "name": "minitest",
+            "total_dependencies": 0,
+            "first_level_dependencies": 0,
+            "top_level_dependencies": {
+              "minitest-around": "minitest-around (0.5.0)"
+            },
+            "transitive_dependencies": []
+          },
+          {
+            "name": "minitest-spec-context",
+            "total_dependencies": 0,
+            "first_level_dependencies": 0,
+            "top_level_dependencies": {},
+            "transitive_dependencies": []
+          }
+        ]
+        },{
+          "name": "Mailers",
+          "files": "1",
+          "lines": "4",
+          "loc": "4",
+          "classes": "1",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Helpers",
+          "files": "1",
+          "lines": "3",
+          "loc": "3",
+          "classes": "0",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Jobs",
+          "files": "1",
+          "lines": "7",
+          "loc": "2",
+          "classes": "1",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Controllers",
+          "files": "1",
+          "lines": "7",
+          "loc": "6",
+          "classes": "1",
+          "methods": "1",
+          "m_over_c": "1",
+          "loc_over_m": "4"
+        }, {
+          "name": "Models",
+          "files": "4",
+          "lines": "10",
+          "loc": "10",
+          "classes": "4",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Channels",
+          "files": "2",
+          "lines": "8",
+          "loc": "8",
+          "classes": "2",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Javascripts",
+          "files": "3",
+          "lines": "27",
+          "loc": "7",
+          "classes": "0",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Libraries",
+          "files": "1",
+          "lines": "1",
+          "loc": "1",
+          "classes": "0",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Configuration",
+          "files": "19",
+          "lines": "417",
+          "loc": "111",
+          "classes": "1",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Model Tests",
+          "files": "2",
+          "lines": "5",
+          "loc": "4",
+          "classes": "2",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Spec Support",
+          "files": "1",
+          "lines": "1",
+          "loc": "1",
+          "classes": "0",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Test Support",
+          "files": "1",
+          "lines": "1",
+          "loc": "1",
+          "classes": "0",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0"
+        }, {
+          "name": "Code",
+          "files": "33",
+          "lines": "484",
+          "loc": "152",
+          "classes": "10",
+          "methods": "1",
+          "m_over_c": "0",
+          "loc_over_m": "150",
+          "code_to_test_ratio": "0.0",
+          "total": true
+        }, {
+          "name": "Tests",
+          "files": "4",
+          "lines": "7",
+          "loc": "6",
+          "classes": "2",
+          "methods": "0",
+          "m_over_c": "0",
+          "loc_over_m": "0",
+          "code_to_test_ratio": "0.0",
+          "total": true
+        }, {
+          "name": "Total",
+          "files": "37",
+          "lines": "491",
+          "loc": "158",
+          "classes": "12",
+          "methods": "1",
+          "m_over_c": "0",
+          "loc_over_m": "156",
+          "code_to_test_ratio": "0.0",
+          "total": true},
+          {"schema_stats":
+            {"schema_path":
+            "#{Dir.pwd}/test/dummy/db/schema.rb",
+            "create_table calls count": 2}},
+            {"polymorphic_stats": {"polymorphic_models_count": 1}
+          }
+        ]
+    EOS
+
+    it "outputs useful stats for a Rails project" do
+      root_directory = File.absolute_path("./test/dummy")
+
+      calculator = RailsStats::StatsCalculator.new(root_directory)
+      formatter  = RailsStats::JSONFormatter.new(calculator)
+
+      expectation = JSON.parse(JSON_STRING)
+      result = formatter.result
+
+      [expectation, result].each do |data|
+        data.each do |hash|
+          next unless hash["gems"]
+
+          hash["gems"].each do |gem|
+            next unless gem["transitive_dependencies"]
+
+            gem["transitive_dependencies"].map! do |dep|
+              name, constraints = dep.split(/[()]/)
+              next dep unless constraints
+
+              normalized_constraints = constraints.split(/,\s*/).sort.join(', ')
+              "#{name}(#{normalized_constraints})"
+            end.sort!
+          end
+        end
+      end
+
+      assert_equal expectation, result
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+if ENV["COVERAGE"] == "true"
+  require "simplecov"
+  require "simplecov-console"
+  require "codecov"
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console,
+    SimpleCov::Formatter::Codecov,
+  ]
+
+  SimpleCov.start do
+    track_files "lib/**/*.rb"
+  end
+
+  puts "Using SimpleCov v#{SimpleCov::VERSION}"
+end
+
+require "byebug"
+
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/around/spec"
+require "minitest-spec-context"
+require "rails_stats/all"