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

lib/skunk/commands/status_reporter.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require "erb"
 require "rubycritic/commands/status_reporter"
-require "terminal-table"
 
 module Skunk
   module Command
@@ -14,78 +12,9 @@ def initialize(options = {})
         super(options)
       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 %>\n
-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
-                        )
-
-      # Returns a status message with a table of all analysed_modules and
-      # a skunk score average
+      # Returns a simple status message indicating the analysis is complete
       def update_status_message
-        opts = table_options.merge(headings: HEADINGS, rows: table)
-
-        _ttable = Terminal::Table.new(opts)
-
-        @status_message = 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
-        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
-        sorted_modules.map do |a_mod|
-          [
-            a_mod.pathname,
-            a_mod.skunk_score,
-            a_mod.churn_times_cost,
-            a_mod.churn,
-            a_mod.cost.round(2),
-            a_mod.coverage.round(2)
-          ]
-        end
+        @status_message = "Skunk analysis complete. Use --format console to see detailed output."
       end
     end
   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,90 @@
+# 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
+          sorted_modules.map do |a_mod|
+            [
+              a_mod.pathname,
+              a_mod.skunk_score,
+              a_mod.churn_times_cost,
+              a_mod.churn,
+              a_mod.cost.round(2),
+              a_mod.coverage.round(2)
+            ]
+          end
+        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

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

test/lib/skunk/config_test.rb

@@ -70,7 +70,7 @@ def test_supported_format
     end
 
     def test_supported_formats
-      expected = %i[json html]
+      expected = %i[json html console]
       assert_equal expected, Config.supported_formats
     end
 

test/lib/skunk/generators/console/simple_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+require "skunk/generators/console/simple"
+
+module Skunk
+  module Generator
+    module Console
+      class SimpleTest < Minitest::Test
+        def setup
+          @analysed_modules = create_simple_mock_collection
+          @simple = Simple.new(@analysed_modules)
+        end
+
+        def test_initializes_with_analysed_modules
+          assert_equal @analysed_modules, @simple.instance_variable_get(:@analysed_modules)
+        end
+
+        def test_render_includes_expected_content
+          output = @simple.render
+
+          assert_includes output, "SkunkScore Total:"
+          assert_includes output, "Modules Analysed:"
+          assert_includes output, "SkunkScore Average:"
+          assert_includes output, "Generated with Skunk"
+        end
+
+        def test_render_includes_table_headers
+          output = @simple.render
+
+          assert_includes output, "file"
+          assert_includes output, "skunk_score"
+          assert_includes output, "churn_times_cost"
+          assert_includes output, "churn"
+          assert_includes output, "cost"
+          assert_includes output, "coverage"
+        end
+
+        def test_headings_constant
+          expected_headings = %w[file skunk_score churn_times_cost churn cost coverage]
+          assert_equal expected_headings, Simple::HEADINGS
+        end
+
+      end
+    end
+  end
+end

test/lib/skunk/generators/console_report_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+require "skunk/generators/console_report"
+
+module Skunk
+  module Generator
+    class ConsoleReportTest < Minitest::Test
+      def setup
+        @analysed_modules = create_simple_mock_collection
+        @console_report = ConsoleReport.new(@analysed_modules)
+      end
+
+      def test_initializes_with_analysed_modules
+        # Test that the console report was initialized with the analysed modules
+        assert_equal @analysed_modules, @console_report.instance_variable_get(:@analysed_modules)
+      end
+
+      def test_generator_returns_console_simple_instance
+        generator = @console_report.send(:generator)
+        assert_instance_of Skunk::Generator::Console::Simple, generator
+      end
+
+      def test_generate_report_calls_generator_render
+        # Test that generate_report calls the generator's render method
+        generator = @console_report.send(:generator)
+
+        # Mock the generator to verify it's called
+        mock_generator = Minitest::Mock.new
+        mock_generator.expect :render, "test output"
+
+        @console_report.instance_variable_set(:@generator, mock_generator)
+
+        # Capture stdout to test the output
+        output = capture_stdout do
+          @console_report.generate_report
+        end
+
+        assert_equal "test output\n", output
+        mock_generator.verify
+      end
+
+    end
+  end
+end