rails_stats 2.0.1 → 2.2.0

data/test/fixtures/console-output.txt

@@ -1,22 +1,3 @@
-+-----------------------|------------|----------------+
-|                  Name | Total Deps | 1st Level Deps |
-+-----------------------|------------|----------------+
-|     simplecov-console | 7          | 3              |
-|               codecov | 5          | 2              |
-|           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   8
-        Github Refs   0
-
 +----------------------+---------+---------+---------+---------+---------+-----+-------+
 | Name                 | Files   | Lines   |     LOC | Classes | Methods | M/C | LOC/M |
 +----------------------+---------+---------+---------+---------+---------+-----+-------+
@@ -24,17 +5,20 @@
 | 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 |
+| Javascripts          |       6 |      28 |       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               |       1 |       3 |       3 |       1 |       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                 |      30 |     477 |     145 |       7 |       1 |   0 |   143 |
+| Code                 |      36 |     485 |     152 |      10 |       1 |   0 |   150 |
 | Tests                |       4 |       7 |       6 |       2 |       0 |   0 |     0 |
-| Total                |      34 |     484 |     151 |       9 |       1 |   0 |   149 |
+| Total                |      40 |     492 |     158 |      12 |       1 |   0 |   156 |
 +----------------------+---------+---------+---------+---------+---------+-----+-------+
-  Code LOC: 145     Test LOC: 6     Code to Test Ratio: 1:0.0  Files: 34
+  Code LOC: 152     Test LOC: 6     Code to Test Ratio: 1:0.0  Files: 40
+
+  Polymorphic models count: 1 polymorphic associations
+  Schema Stats: 2 `create_table` calls in schema.rb

data/test/fixtures/packwerk_app/app/controllers/core_controller.rb

@@ -0,0 +1,4 @@
+class CoreController
+  def index
+  end
+end

data/test/fixtures/packwerk_app/app/models/core_model.rb

@@ -0,0 +1,5 @@
+class CoreModel
+  def core_method
+    true
+  end
+end

data/test/fixtures/packwerk_app/components/billing/app/models/billing_model.rb

@@ -0,0 +1,4 @@
+class BillingModel
+  def charge
+  end
+end

data/test/fixtures/packwerk_app/components/billing/lib/billing.rb

@@ -0,0 +1,2 @@
+module Billing
+end

data/test/fixtures/packwerk_app/lib/core_lib.rb

@@ -0,0 +1,3 @@
+module CoreLib
+  CONST = 1
+end

data/test/fixtures/packwerk_app/package.yml

@@ -0,0 +1 @@
+enforce_dependencies: true

data/test/fixtures/packwerk_app/packs/pack1/app/controllers/pack1_controller.rb

@@ -0,0 +1,4 @@
+class Pack1Controller
+  def show
+  end
+end

data/test/fixtures/packwerk_app/packs/pack1/app/models/pack1_model.rb

@@ -0,0 +1,6 @@
+class Pack1Model
+  def m1
+  end
+  def m2
+  end
+end

data/test/fixtures/packwerk_app/packs/pack1/lib/pack1_lib.rb

@@ -0,0 +1,2 @@
+module Pack1Lib
+end

data/test/fixtures/packwerk_app/packs/pack1/package.yml

@@ -0,0 +1,3 @@
+enforce_dependencies: true
+dependencies:
+  - packs/pack2

data/test/fixtures/packwerk_app/packs/pack1/spec/models/pack1_model_spec.rb

@@ -0,0 +1,4 @@
+describe Pack1Model do
+  it "works" do
+  end
+end

data/test/fixtures/packwerk_app/packs/pack2/app/models/pack2_model.rb

@@ -0,0 +1,4 @@
+class Pack2Model
+  def only
+  end
+end

data/test/fixtures/packwerk_app/packs/pack2/test/models/pack2_model_test.rb

@@ -0,0 +1,4 @@
+class Pack2ModelTest
+  def test_it
+  end
+end

data/test/lib/rails_stats/code_statistics_test.rb

@@ -8,13 +8,13 @@ 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__))
+      expected_table = File.read(File.expand_path('../../../fixtures/console-output.txt', __FILE__))
 
-      out, err = capture_io do
-        RailsStats::CodeStatistics.new(root_directory).to_s
-      end
+      expected_bundler_table, _ = capture_io { Bundler::Stats::CLI.start }
 
-      assert_equal table.delete(" \n"), out.delete(" \n")
+      output, _ = capture_io { RailsStats::CodeStatistics.new(root_directory).to_s }
+
+      assert_equal([expected_bundler_table, expected_table].join, output)
     end
   end
 end

data/test/lib/rails_stats/console_formatter_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+describe RailsStats::ConsoleFormatter do
+  describe '#to_s' do
+    it 'invokes Bundler::Stats::CLI with text format' do
+      root_directory = File.absolute_path('./test/dummy')
+      calculator = RailsStats::StatsCalculator.new(root_directory)
+      formatter  = RailsStats::ConsoleFormatter.new(calculator)
+
+      received_args = nil
+      original = Bundler::Stats::CLI.method(:start)
+      Bundler::Stats::CLI.define_singleton_method(:start) { |args = []| received_args = args }
+
+      begin
+        capture_io { formatter.to_s }
+      ensure
+        Bundler::Stats::CLI.singleton_class.remove_method(:start)
+        Bundler::Stats::CLI.define_singleton_method(:start, original)
+      end
+
+      assert_equal ['--format', 'text'], received_args
+    end
+
+    it 'prints a section per pack plus a Core and a grand total for packwerk apps' do
+      root_directory = File.absolute_path('./test/fixtures/packwerk_app')
+      calculator = RailsStats::StatsCalculator.new(root_directory)
+      formatter  = RailsStats::ConsoleFormatter.new(calculator)
+
+      original = Bundler::Stats::CLI.method(:start)
+      Bundler::Stats::CLI.define_singleton_method(:start) { |args = []| nil }
+
+      begin
+        output, _ = capture_io { formatter.to_s }
+      ensure
+        Bundler::Stats::CLI.singleton_class.remove_method(:start)
+        Bundler::Stats::CLI.define_singleton_method(:start, original)
+      end
+
+      assert_includes output, '== Core Application =='
+      assert_includes output, '== Pack: packs/pack1 =='
+      assert_includes output, '== Pack: packs/pack2 =='
+      assert_includes output, '== Pack: components/billing =='
+      assert_includes output, '== Total (all packs) =='
+    end
+  end
+end

data/test/lib/rails_stats/json_formatter_test.rb

@@ -4,141 +4,84 @@ require "test_helper"
 
 describe RailsStats::JSONFormatter do
   describe "#result" do
-    JSON_STRING = <<~EOS
-    [{
-      "name": "Libraries",
-      "files": "1",
-      "lines": "1",
-      "loc": "1",
-      "classes": "0",
-      "methods": "0",
-      "m_over_c": "0",
-      "loc_over_m": "0"
-    }, {
-      "name": "Mailers",
-      "files": "1",
-      "lines": "4",
-      "loc": "4",
-      "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": "Models",
-      "files": "1",
-      "lines": "3",
-      "loc": "3",
-      "classes": "1",
-      "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": "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": "Helpers",
-      "files": "1",
-      "lines": "3",
-      "loc": "3",
-      "classes": "0",
-      "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": "Configuration",
-      "files": "19",
-      "lines": "417",
-      "loc": "111",
-      "classes": "1",
-      "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": "Total",
-      "files": "34",
-      "lines": "484",
-      "loc": "151",
-      "classes": "9",
-      "methods": "1",
-      "m_over_c": "0",
-      "loc_over_m": "149",
-      "code_to_test_ratio": "0.0",
-      "total": true
-    }]
-    EOS
+    def code_stat(name, files:, lines:, loc:, classes:, methods: "0", m_over_c: "0", loc_over_m: "0")
+      {"name"=>name, "files"=>files, "lines"=>lines, "loc"=>loc,
+       "classes"=>classes, "methods"=>methods, "m_over_c"=>m_over_c, "loc_over_m"=>loc_over_m}
+    end
+
+    def total_stat(name, files:, lines:, loc:, classes:, methods: "0", m_over_c: "0", loc_over_m: "0", code_to_test_ratio: "0.0")
+      code_stat(name, files: files, lines: lines, loc: loc, classes: classes,
+                methods: methods, m_over_c: m_over_c, loc_over_m: loc_over_m)
+        .merge("code_to_test_ratio" => code_to_test_ratio, "total" => true)
+    end
+
+    EXPECTED_GEM_NAMES = %w[
+      simplecov-console codecov rails_stats simplecov minitest-around
+      bundler byebug minitest minitest-spec-context
+    ].freeze
 
     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)
+      result = formatter.result
+
+      # Verify bundler-stats structure (without asserting on version-specific values)
+      gems_section = result.find { |h| h["gems"] }
+      assert gems_section, "Expected a gems section in the result"
+      assert gems_section["summary"], "Expected a summary in the gems section"
+      %w[declared unpinned total github].each do |key|
+        assert gems_section["summary"].key?(key), "Expected summary to have '#{key}'"
+      end
 
-      sorted_expectation = JSON.parse(JSON_STRING).sort {|x, y| x["name"] <=> y["name"] }
-      sorted_result      = formatter.result.sort {|x, y| x["name"] <=> y["name"] }
+      gem_names = gems_section["gems"].map { |g| g["name"] }
+      assert_equal EXPECTED_GEM_NAMES.sort, gem_names.sort
 
-      sorted_expectation.each_with_index do |x, i|
-        assert_equal x, sorted_result[i]
+      gems_section["gems"].each do |gem|
+        %w[name total_dependencies first_level_dependencies top_level_dependencies transitive_dependencies].each do |key|
+          assert gem.key?(key), "Expected gem '#{gem["name"]}' to have '#{key}'"
+        end
       end
+
+      # Verify code stats (these are stable across Ruby versions)
+      expected_code_stats = [
+        code_stat("Mailers",       files: "1",  lines: "4",   loc: "4",   classes: "1"),
+        code_stat("Models",        files: "4",  lines: "10",  loc: "10",  classes: "4"),
+        code_stat("Controllers",   files: "1",  lines: "7",   loc: "6",   classes: "1", methods: "1", m_over_c: "1", loc_over_m: "4"),
+        code_stat("Helpers",       files: "1",  lines: "3",   loc: "3",   classes: "0"),
+        code_stat("Jobs",          files: "1",  lines: "7",   loc: "2",   classes: "1"),
+        code_stat("Channels",      files: "2",  lines: "8",   loc: "8",   classes: "2"),
+        code_stat("Javascripts",   files: "6",  lines: "28",  loc: "7",   classes: "0"),
+        code_stat("Libraries",     files: "1",  lines: "1",   loc: "1",   classes: "0"),
+        code_stat("Configuration", files: "19", lines: "417", loc: "111", classes: "1"),
+        code_stat("Model Tests",   files: "2",  lines: "5",   loc: "4",   classes: "2"),
+        code_stat("Spec Support",  files: "1",  lines: "1",   loc: "1",   classes: "0"),
+        code_stat("Test Support",  files: "1",  lines: "1",   loc: "1",   classes: "0"),
+      ]
+
+      code_stats = result.select { |h| h["name"] && !h["total"] }
+      assert_equal expected_code_stats.sort_by { |h| h["name"] }, code_stats.sort_by { |h| h["name"] }
+
+      # Verify totals
+      expected_totals = [
+        total_stat("Code",  files: "36", lines: "485", loc: "152", classes: "10", methods: "1", loc_over_m: "150"),
+        total_stat("Tests", files: "4",  lines: "7",   loc: "6",   classes: "2"),
+        total_stat("Total", files: "40", lines: "492", loc: "158", classes: "12", methods: "1", loc_over_m: "156"),
+      ]
+
+      totals = result.select { |h| h["total"] }
+      assert_equal expected_totals.sort_by { |h| h["name"] }, totals.sort_by { |h| h["name"] }
+
+      # Verify schema and polymorphic stats
+      schema_stats = result.find { |h| h["schema_stats"] }
+      assert schema_stats, "Expected schema_stats in result"
+      assert_equal "#{Dir.pwd}/test/dummy/db/schema.rb", schema_stats["schema_stats"]["schema_path"]
+      assert_equal 2, schema_stats["schema_stats"]["create_table calls count"]
+
+      polymorphic_stats = result.find { |h| h["polymorphic_stats"] }
+      assert polymorphic_stats, "Expected polymorphic_stats in result"
+      assert_equal 1, polymorphic_stats["polymorphic_stats"]["polymorphic_models_count"]
     end
   end
-end
+end

data/test/lib/rails_stats/pack_finder_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe RailsStats::PackFinder do
+  describe ".find" do
+    it "detects packwerk packs and component-based components" do
+      root = File.absolute_path("./test/fixtures/packwerk_app")
+
+      packs = RailsStats::PackFinder.find(root).map { |path| path.sub("#{root}/", "") }
+
+      assert_equal ["components/billing", "packs/pack1", "packs/pack2"], packs.sort
+    end
+
+    it "does not treat the root package.yml as a pack" do
+      root = File.absolute_path("./test/fixtures/packwerk_app")
+
+      packs = RailsStats::PackFinder.find(root)
+
+      refute_includes packs, root
+    end
+
+    it "returns an empty list for a plain Rails app" do
+      root = File.absolute_path("./test/dummy")
+
+      assert_empty RailsStats::PackFinder.find(root)
+    end
+  end
+end

data/test/lib/rails_stats/stats_calculator_test.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+describe RailsStats::StatsCalculator do
+  describe "#statistics_by_group" do
+    before do
+      root = File.absolute_path("./test/fixtures/packwerk_app")
+      @calculator = RailsStats::StatsCalculator.new(root)
+    end
+
+    it "reports that the app is split into packs" do
+      assert @calculator.packs?
+    end
+
+    it "groups statistics per pack/component with Core first" do
+      groups = @calculator.statistics_by_group.keys
+
+      assert_equal "Core", groups.first
+      assert_equal ["Core", "components/billing", "packs/pack1", "packs/pack2"], groups
+    end
+
+    it "attributes each pack's files to its own group" do
+      by_group = @calculator.statistics_by_group
+
+      assert_equal 1, by_group["packs/pack1"]["Models"].files_total
+      assert_equal 1, by_group["packs/pack1"]["Controllers"].files_total
+      assert_equal 1, by_group["packs/pack1"]["Model Tests"].files_total
+      assert_equal 1, by_group["packs/pack2"]["Models"].files_total
+      assert_equal 1, by_group["components/billing"]["Models"].files_total
+    end
+
+    it "keeps core files in the Core group" do
+      core = @calculator.statistics_by_group["Core"]
+
+      assert_equal 1, core["Models"].files_total
+      assert_equal 1, core["Controllers"].files_total
+      assert_equal 1, core["Libraries"].files_total
+    end
+
+    it "includes pack lib directories that are not gems" do
+      assert_equal 1, @calculator.statistics_by_group["packs/pack1"]["Libraries"].files_total
+    end
+
+    it "has a grand total that matches the sum of every group" do
+      _code, _tests, grand = @calculator.totals_for(@calculator.statistics)
+
+      per_group_files = @calculator.statistics_by_group.sum do |_group, stats|
+        _c, _t, group_grand = @calculator.totals_for(stats)
+        group_grand.files_total
+      end
+
+      assert_equal grand.files_total, per_group_files
+    end
+  end
+
+  describe "#packs?" do
+    it "is false for a plain Rails app" do
+      calculator = RailsStats::StatsCalculator.new(File.absolute_path("./test/dummy"))
+
+      refute calculator.packs?
+    end
+  end
+end

data/test/lib/rails_stats/util_test.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "tmpdir"
+require "fileutils"
+
+describe RailsStats::Util do
+  describe ".calculate_directory_statistics" do
+    it "ignores vendored directories and never counts a directory that looks like a source file" do
+      Dir.mktmpdir do |dir|
+        # A real source file that should be counted.
+        File.write(File.join(dir, "real.rb"), "class Real\nend\n")
+
+        # A directory whose name matches the source-file pattern. It must be
+        # walked (its contents counted) but never opened as a file itself,
+        # which previously raised Errno::EISDIR.
+        weird = File.join(dir, "weird.rb")
+        FileUtils.mkdir_p(weird)
+        File.write(File.join(weird, "inner.rb"), "class Inner\nend\n")
+
+        # A vendored tree that must be skipped entirely, including a directory
+        # named like a JS file (e.g. node_modules/popper.js), the exact case
+        # that crashed on a packs app.
+        popper = File.join(dir, "node_modules", "popper.js")
+        FileUtils.mkdir_p(popper)
+        File.write(File.join(popper, "index.js"), "function noop() {}\n")
+
+        stats = RailsStats::Util.calculate_directory_statistics(dir)
+
+        # real.rb + weird.rb/inner.rb, nothing under node_modules.
+        assert_equal 2, stats.files_total
+      end
+    end
+
+    it "skips every ignored directory name" do
+      RailsStats::IGNORED_DIRS.each do |ignored|
+        Dir.mktmpdir do |dir|
+          vendored = File.join(dir, ignored)
+          FileUtils.mkdir_p(vendored)
+          File.write(File.join(vendored, "ignored.rb"), "class Ignored\nend\n")
+
+          stats = RailsStats::Util.calculate_directory_statistics(dir)
+
+          assert_equal 0, stats.files_total, "expected #{ignored}/ to be skipped"
+        end
+      end
+    end
+  end
+end