Add analysis class

Author: JuanVqz

lib/skunk.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "skunk/version"
+require "skunk/analysis"
 
 # Knows how to calculate the `SkunkScore` for each file analyzed by `RubyCritic`
 # and `SimpleCov`

lib/skunk/analysis.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Skunk
+  # Centralized service for analyzing Skunk metrics from analysed modules.
+  # This class encapsulates all the core business logic for calculating
+  # Skunk scores, filtering test modules, and providing aggregated statistics.
+  #
+  # @example
+  #   analysis = Skunk::Analysis.new(analysed_modules)
+  #   puts "Total Skunk Score: #{analysis.skunk_score_total}"
+  #   puts "Average: #{analysis.skunk_score_average}"
+  #   puts "Worst module: #{analysis.worst_module.pathname}"
+  class Analysis
+    attr_reader :analysed_modules
+
+    # @param analysed_modules [RubyCritic::AnalysedModulesCollection] Collection of analysed modules
+    def initialize(analysed_modules)
+      @analysed_modules = analysed_modules
+    end
+
+    # Returns the count of non-test modules
+    # @return [Integer]
+    def analysed_modules_count
+      @analysed_modules_count ||= non_test_modules.count
+    end
+
+    # Returns the total Skunk score across all non-test modules
+    # @return [Float]
+    def skunk_score_total
+      @skunk_score_total ||= non_test_modules.sum(&:skunk_score)
+    end
+
+    # Returns the average Skunk score across all non-test modules
+    # @return [Float]
+    def skunk_score_average
+      return 0.0 if analysed_modules_count.zero?
+
+      (skunk_score_total.to_d / analysed_modules_count).to_f.round(2)
+    end
+
+    # Returns the total churn times cost across all non-test modules
+    # @return [Float]
+    def total_churn_times_cost
+      @total_churn_times_cost ||= non_test_modules.sum(&:churn_times_cost)
+    end
+
+    # Returns the module with the highest Skunk score (worst performing)
+    # @return [RubyCritic::AnalysedModule, nil]
+    def worst_module
+      @worst_module ||= sorted_modules.first
+    end
+
+    # Returns modules sorted by Skunk score in descending order (worst first)
+    # @return [Array<RubyCritic::AnalysedModule>]
+    def sorted_modules
+      @sorted_modules ||= non_test_modules.sort_by(&:skunk_score).reverse!
+    end
+
+    # Returns only non-test modules (excludes test and spec directories)
+    # @return [Array<RubyCritic::AnalysedModule>]
+    def non_test_modules
+      @non_test_modules ||= analysed_modules.reject do |a_module|
+        test_module?(a_module)
+      end
+    end
+
+    # Returns a hash representation of the analysis results
+    # @return [Hash]
+    def to_hash
+      {
+        analysed_modules_count: analysed_modules_count,
+        skunk_score_total: skunk_score_total,
+        skunk_score_average: skunk_score_average,
+        total_churn_times_cost: total_churn_times_cost,
+        worst_pathname: worst_module&.pathname,
+        worst_score: worst_module&.skunk_score,
+        files: files_as_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
+
+    # Determines if a module is a test module based on its path
+    # @param a_module [RubyCritic::AnalysedModule] The module to check
+    # @return [Boolean]
+    def test_module?(a_module)
+      pathname = a_module.pathname
+      module_path = pathname.dirname.to_s
+      filename = pathname.basename.to_s
+
+      # Check if directory starts or ends with test/spec
+      directory_is_test = module_path.start_with?("test", "spec") || module_path.end_with?("test", "spec")
+
+      # Check if filename ends with _test.rb or _spec.rb
+      filename_is_test = filename.end_with?("_test.rb", "_spec.rb")
+
+      directory_is_test || filename_is_test
+    end
+  end
+end

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,8 @@ 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
       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 Report Completed"
       end
     end
   end