Move Console Report out of Status Reporter

The status reporter has a different purpuse in the RubyCritic gem, they also have the specific usage of the Console Report and now we are following the same patters that gem created.

- Added support for a new console output format in the FormatValidator module.
- Refactored the StatusReporter to provide a simplified status message upon completion of analysis.
- Introduced ConsoleReport and Simple classes for generating detailed console reports of analysed modules.
- Updated tests to validate new console reporting functionality and ensure expected outputs.
- Adjusted existing tests to reflect changes in the status reporting method.

Author: JuanVqz

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-10-17 16:20:40 UTC using RuboCop version 1.81.1.
+# on 2025-10-17 22:53:06 UTC using RuboCop version 1.81.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,16 +13,9 @@ Gemspec/RequiredRubyVersion:
     - 'skunk.gemspec'
 
 # Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/ClosingHeredocIndentation:
-  Exclude:
-    - 'lib/skunk/commands/status_reporter.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Layout/HeredocIndentation:
+Lint/IneffectiveAccessModifier:
   Exclude:
-    - 'lib/skunk/commands/status_reporter.rb'
+    - 'lib/skunk/generators/console/simple.rb'
 
 # Offense count: 2
 # Configuration parameters: AllowedParentClasses.
@@ -31,21 +24,21 @@ Lint/MissingSuper:
     - 'lib/skunk/cli/application.rb'
     - 'lib/skunk/generators/html/overview.rb'
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 18
+  Max: 24
 
-# Offense count: 12
+# Offense count: 14
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 233
+  Max: 208
 
-# Offense count: 2
+# Offense count: 5
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 13
+  Max: 18
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
@@ -55,6 +48,16 @@ Naming/VariableNumber:
   Exclude:
     - 'lib/skunk/commands/status_sharer.rb'
 
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, EnforcedStyleForClasses, EnforcedStyleForModules.
+# SupportedStyles: nested, compact
+# SupportedStylesForClasses: ~, nested, compact
+# SupportedStylesForModules: ~, nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'test/test_helper.rb'
+
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
@@ -63,3 +66,10 @@ Style/FrozenStringLiteralComment:
   Exclude:
     - '**/*.arb'
     - 'bin/console'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, IgnoreCopDirectives, AllowedPatterns, SplitStrings.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 124

lib/skunk/cli/application.rb

@@ -5,6 +5,7 @@
 
 require "skunk"
 require "skunk/rubycritic/analysed_module"
+require "skunk/rubycritic/analysed_modules_collection"
 require "skunk/cli/options"
 require "skunk/command_factory"
 require "skunk/commands/status_sharer"

lib/skunk/cli/options/argv.rb

@@ -12,7 +12,7 @@ class Argv < RubyCritic::Cli::Options::Argv
         # :reek:Attribute
         attr_accessor :output_filename
 
-        def parse # rubocop:disable Metrics/MethodLength
+        def parse
           parser.new do |opts|
             opts.banner = "Usage: skunk [options] [paths]\n"
 

lib/skunk/commands/status_reporter.rb

@@ -12,6 +12,7 @@ def initialize(options = {})
         super(options)
       end
 
+      # Returns a simple status message indicating the analysis is complete
       def update_status_message
         @status_message = "Skunk Report Completed"
       end

lib/skunk/config.rb

@@ -4,7 +4,7 @@ module Skunk
   # Utility module for format validation
   module FormatValidator
     # Supported output formats
-    SUPPORTED_FORMATS = %i[json html].freeze
+    SUPPORTED_FORMATS = %i[json html console].freeze
 
     # Check if a format is supported
     # @param format [Symbol] Format to check

lib/skunk/generators/console/simple.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "erb"
+require "terminal-table"
+
+module Skunk
+  module Generator
+    module Console
+      # Generates a console report for the analysed modules.
+      class Simple
+        def initialize(analysed_modules)
+          @analysed_modules = analysed_modules
+        end
+
+        HEADINGS = %w[file skunk_score churn_times_cost churn cost coverage].freeze
+        HEADINGS_WITHOUT_FILE = HEADINGS - %w[file]
+        HEADINGS_WITHOUT_FILE_WIDTH = HEADINGS_WITHOUT_FILE.size * 17 # padding
+
+        TEMPLATE = ERB.new(<<~TEMPL
+          <%= _ttable %>
+
+          SkunkScore Total: <%= total_skunk_score %>
+          Modules Analysed: <%= analysed_modules_count %>
+          SkunkScore Average: <%= skunk_score_average %>
+          <% if worst %>Worst SkunkScore: <%= worst.skunk_score %> (<%= worst.pathname %>)<% end %>
+
+          Generated with Skunk v<%= Skunk::VERSION %>
+        TEMPL
+                          )
+
+        def render
+          opts = table_options.merge(headings: HEADINGS, rows: table)
+          _ttable = Terminal::Table.new(opts)
+          TEMPLATE.result(binding)
+        end
+
+        private
+
+        def analysed_modules_count
+          @analysed_modules.analysed_modules_count
+        end
+
+        def worst
+          @analysed_modules.worst_module
+        end
+
+        def sorted_modules
+          @analysed_modules.sorted_modules
+        end
+
+        def total_skunk_score
+          @analysed_modules.skunk_score_total
+        end
+
+        def total_churn_times_cost
+          @analysed_modules.total_churn_times_cost
+        end
+
+        def skunk_score_average
+          @analysed_modules.skunk_score_average
+        end
+
+        def table_options
+          return { style: { width: 100 } } if sorted_modules.empty?
+
+          max = sorted_modules.max_by { |a_mod| a_mod.pathname.to_s.length }
+          width = max.pathname.to_s.length + HEADINGS_WITHOUT_FILE_WIDTH
+          {
+            style: {
+              width: width
+            }
+          }
+        end
+
+        def table
+          @analysed_modules.files_as_hash.map { |file_hash| self.class.format_hash_row(file_hash) }
+        end
+
+        def self.format_hash_row(file_hash)
+          [
+            file_hash[:file],
+            file_hash[:skunk_score],
+            file_hash[:churn_times_cost],
+            file_hash[:churn],
+            file_hash[:cost],
+            file_hash[:coverage]
+          ]
+        end
+      end
+    end
+  end
+end

lib/skunk/generators/console_report.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "erb"
+require "terminal-table"
+
+require "skunk/generators/console/simple"
+
+module Skunk
+  module Generator
+    # Generates a console report for the analysed modules.
+    class ConsoleReport
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def generate_report
+        puts generator.render
+      end
+
+      private
+
+      def generator
+        @generator ||= Skunk::Generator::Console::Simple.new(@analysed_modules)
+      end
+    end
+  end
+end

lib/skunk/rubycritic/analysed_modules_collection.rb

@@ -65,14 +65,14 @@ def to_hash
       }
     end
 
-    private
-
     # Returns files as an array of hashes (for JSON serialization)
     # @return [Array<Hash>]
     def files_as_hash
       @files_as_hash ||= sorted_modules.map(&:to_hash)
     end
 
+    private
+
     # Determines if a module is a test module based on its path
     # @param a_module [RubyCritic::AnalysedModule] The module to check
     # @return [Boolean]

test/lib/skunk/application_test.rb

@@ -35,28 +35,6 @@
       end
     end
 
-    context "when passing --out option with a file" do
-      require "fileutils"
-
-      let(:argv) { ["--out=tmp/generated_report.txt", "samples/rubycritic"] }
-      let(:success_code) { 0 }
-
-      it "writes output to the file" do
-        FileUtils.rm("tmp/generated_report.txt", force: true)
-        FileUtils.mkdir_p("tmp")
-
-        RubyCritic::AnalysedModule.stub_any_instance(:churn, 1) do
-          RubyCritic::AnalysedModule.stub_any_instance(:coverage, 100.0) do
-            result = application.execute
-            _(result).must_equal success_code
-          end
-        end
-
-        _(File.read("tmp/generated_report.txt"))
-          .must_include File.read("test/samples/console_output.txt")
-      end
-    end
-
     context "when comparing two branches" do
       let(:argv) { ["-b main", "samples/rubycritic"] }
       let(:success_code) { 0 }

test/lib/skunk/commands/status_reporter_test.rb

@@ -32,16 +32,14 @@ def analysed_module.churn
       example.call
     end
 
-    it "reports the SkunkScore" do
-      _(reporter.update_status_message).must_include output
-      _(reporter.update_status_message).must_include "Generated with Skunk v#{Skunk::VERSION}"
+    it "reports a simple status message" do
+      _(reporter.update_status_message).must_equal "Skunk analysis complete. Use --format console to see detailed output."
     end
 
     context "When there's nested spec files" do
       let(:paths) { "samples" }
-      it "reports the SkunkScore" do
-        _(reporter.update_status_message).must_include output
-        _(reporter.update_status_message).must_include "Generated with Skunk v#{Skunk::VERSION}"
+      it "reports a simple status message" do
+        _(reporter.update_status_message).must_equal "Skunk analysis complete. Use --format console to see detailed output."
       end
     end
   end