Merge pull request rails#52747 from p8/railties/stats-register-test-dirs

Allow registering test directories for CodeStatistics

Author: rafaelfranca

railties/lib/rails/code_statistics.rb

@@ -43,12 +43,18 @@ class CodeStatistics
     HEADERS = { lines: " Lines", code_lines: "   LOC", classes: "Classes", methods: "Methods" }
 
     class_attribute :directories, default: DIRECTORIES
+    class_attribute :test_types, default: TEST_TYPES
 
     # Add directories to the output of the `bin/rails stats` command.
     #
     #   Rails::CodeStatistics.register_directory("My Directory", "path/to/dir")
-    def self.register_directory(label, path)
+    #
+    # For directories that contain test code, set the `test_directory` argument to true.
+    #
+    #   Rails::CodeStatistics.register_directory("Model specs", "spec/models", test_directory: true)
+    def self.register_directory(label, path, test_directory: false)
       self.directories << [label, path]
+      self.test_types << label
     end
 
     def initialize(*pairs)
@@ -99,13 +105,13 @@ def calculate_total
 
       def calculate_code
         code_loc = 0
-        @statistics.each { |k, v| code_loc += v.code_lines unless TEST_TYPES.include? k }
+        @statistics.each { |k, v| code_loc += v.code_lines unless test_types.include? k }
         code_loc
       end
 
       def calculate_tests
         test_loc = 0
-        @statistics.each { |k, v| test_loc += v.code_lines if TEST_TYPES.include? k }
+        @statistics.each { |k, v| test_loc += v.code_lines if test_types.include? k }
         test_loc
       end
 

railties/test/code_statistics_test.rb

@@ -14,6 +14,20 @@ def teardown
     FileUtils.rm_rf(@tmp_path)
   end
 
+  test "register directories" do
+    Rails::CodeStatistics.register_directory("My Directory", "path/to/dir")
+    assert Rails::CodeStatistics.directories.include?(["My Directory", "path/to/dir"])
+  ensure
+    Rails::CodeStatistics.directories.delete(["My Directory", "path/to/dir"])
+  end
+
+  test "register test directories" do
+    Rails::CodeStatistics.register_directory("Model specs", "spec/models", test_directory: true)
+    assert Rails::CodeStatistics.test_types.include?("Model specs")
+  ensure
+    Rails::CodeStatistics.test_types.delete("Model specs")
+  end
+
   test "ignores directories that happen to have source files extensions" do
     assert_nothing_raised do
       @code_statistics = Rails::CodeStatistics.new(["tmp dir", @tmp_path])