Set :json format as default

Author: JuanVqz

.reek.yml

@@ -33,3 +33,12 @@ detectors:
     - Skunk::Command::Compare#analyse_modified_files
     - Skunk::Command::Compare#build_details_path
     - Skunk::Command::Shareable#sharing?
+    - Skunk::Configuration#supported_format?
+    - Skunk::Configuration#supported_formats
+  ManualDispatch:
+    exclude:
+    - Skunk::Config#self.method_missing
+    - Skunk::Config#self.respond_to_missing?
+  BooleanParameter:
+    exclude:
+    - Skunk::Config#self.respond_to_missing?

README.md

@@ -14,6 +14,8 @@ Skunk is a RubyCritic extension to calculate a SkunkScore for a file or project.
     * [Help commands](#help-commands)
     * [Generate the SkunkCore for your project](#generate-the-skunkcore-for-your-project)
     * [Comparing Feature Branches](#comparing-feature-branches)
+* [Configuration](#configuration)
+    * [Setting Output Formats](#setting-output-formats)
 * [Sharing your SkunkScore](#sharing-your-skunkscore)
 * [Contributing](#contributing)
 * [Sponsorship](#sponsorship)
@@ -152,6 +154,36 @@ Score: 340.3
 
 This should give you an idea if you're moving in the direction of maintaining the code quality or not. In this case, the feature branch is decreasing the code quality because it has a higher SkunkScore than the main branch.
 
+## Configuration
+
+### Setting Output Formats
+
+Skunk provides a simple configuration class to control output formats programmatically. You can use `Skunk::Config` to set which formats should be generated when running Skunk.
+
+**Supported formats:**
+- `:json` - JSON report (default)
+- `:html` - HTML report with visual charts and tables
+
+```ruby
+require 'skunk/config'
+
+# Set multiple formats
+Skunk::Config.formats = [:json, :html]
+
+# Add a format to the existing list
+Skunk::Config.add_format(:html)
+
+# Remove a format
+Skunk::Config.remove_format(:json)
+
+# Check supported formats
+Skunk::Config.supported_formats # => [:json, :html]
+Skunk::Config.supported_format?(:json) # => true
+
+# Reset to defaults
+Skunk::Config.reset
+```
+
 ## Sharing your SkunkScore
 
 If you want to share the results of your Skunk report with the Ruby community, run:

lib/skunk/config.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Skunk
+  # Utility module for format validation
+  module FormatValidator
+    # Supported output formats
+    SUPPORTED_FORMATS = %i[json html].freeze
+
+    # Check if a format is supported
+    # @param format [Symbol] Format to check
+    # @return [Boolean] True if format is supported
+    def self.supported_format?(format)
+      SUPPORTED_FORMATS.include?(format)
+    end
+
+    # Get all supported formats
+    # @return [Array<Symbol>] All supported formats
+    def self.supported_formats
+      SUPPORTED_FORMATS.dup
+    end
+  end
+
+  # Configuration class for Skunk that supports formats
+  # Similar to RubyCritic::Configuration but focused only on Skunk's needs
+  class Configuration
+    # Default format
+    DEFAULT_FORMAT = :json
+
+    def initialize
+      @formats = [DEFAULT_FORMAT]
+    end
+
+    def set(options = {})
+      self.formats = options[:formats] if options.key?(:formats)
+    end
+
+    # Get the configured formats
+    # @return [Array<Symbol>] Array of format symbols
+    def formats
+      @formats
+    end
+
+    # Set the formats with validation
+    # @param format_list [Array<Symbol>, Symbol] Format(s) to set
+    def formats=(format_list)
+      format_array = Array(format_list)
+      @formats = format_array.select { |format| FormatValidator.supported_format?(format) }
+      @formats = [DEFAULT_FORMAT] if @formats.empty?
+    end
+
+    # Add a format to the existing list
+    # @param format [Symbol] Format to add
+    def add_format(format)
+      return unless FormatValidator.supported_format?(format)
+
+      @formats << format unless @formats.include?(format)
+    end
+
+    # Remove a format from the list
+    # @param format [Symbol] Format to remove
+    def remove_format(format)
+      @formats.delete(format)
+      @formats = [DEFAULT_FORMAT] if @formats.empty?
+    end
+
+    # Check if a format is supported
+    # @param format [Symbol] Format to check
+    # @return [Boolean] True if format is supported
+    def supported_format?(format)
+      FormatValidator.supported_format?(format)
+    end
+
+    # Get all supported formats
+    # @return [Array<Symbol>] All supported formats
+    def supported_formats
+      FormatValidator.supported_formats
+    end
+
+    # Reset to default configuration
+    def reset
+      @formats = [DEFAULT_FORMAT]
+    end
+  end
+
+  # Config module that delegates to Configuration instance
+  # Similar to RubyCritic::Config pattern
+  module Config
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.set(options = {})
+      configuration.set(options)
+    end
+
+    def self.method_missing(method, *args, &block)
+      if configuration.respond_to?(method)
+        configuration.public_send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def self.respond_to_missing?(symbol, include_private = false)
+      configuration.respond_to?(symbol, include_private) || super
+    end
+  end
+end

lib/skunk/reporter.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
+require "skunk/config"
+
 module Skunk
   # Pick the right report generator based on the format specified in the
   # configuration. If the format is not supported, it will default to ConsoleReport.
   module Reporter
-    REPORT_GENERATOR_CLASS_FORMATS = %i[json html].freeze
-
     def self.generate_report(analysed_modules)
-      RubyCritic::Config.formats.uniq.each do |format|
+      Config.formats.uniq.each do |format|
         report_generator_class(format).new(analysed_modules).generate_report
       end
     end
 
     def self.report_generator_class(config_format)
-      return if REPORT_GENERATOR_CLASS_FORMATS.none? { |format| format == config_format }
+      return unless Config.supported_format?(config_format)
 
       require "skunk/generators/#{config_format}_report"
       Generator.const_get("#{config_format.capitalize}Report")

test/lib/skunk/config_test.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+require_relative "../../../lib/skunk/config"
+
+module Skunk
+  class ConfigTest < Minitest::Test
+    def setup
+      Config.reset
+    end
+
+    def test_default_format
+      assert_equal [:json], Config.formats
+    end
+
+    def test_set_formats_with_array
+      Config.formats = [:html, :json]
+      assert_equal [:html, :json], Config.formats
+    end
+
+    def test_set_formats_with_single_format
+      Config.formats = :html
+      assert_equal [:html], Config.formats
+    end
+
+    def test_set_formats_filters_unsupported_formats
+      Config.formats = [:html, :json, :unsupported, :xml]
+      assert_equal [:html, :json], Config.formats
+    end
+
+    def test_set_formats_with_empty_array_defaults_to_json
+      Config.formats = []
+      assert_equal [:json], Config.formats
+    end
+
+    def test_add_format
+      Config.add_format(:html)
+      assert_equal [:json, :html], Config.formats
+    end
+
+    def test_add_format_ignores_duplicates
+      Config.add_format(:html)
+      Config.add_format(:html)
+      assert_equal [:json, :html], Config.formats
+    end
+
+    def test_add_format_ignores_unsupported_formats
+      Config.add_format(:unsupported)
+      assert_equal [:json], Config.formats
+    end
+
+    def test_remove_format
+      Config.formats = [:json, :html]
+      Config.remove_format(:html)
+      assert_equal [:json], Config.formats
+    end
+
+    def test_remove_format_defaults_to_json_when_empty
+      Config.remove_format(:json)
+      assert_equal [:json], Config.formats
+    end
+
+    def test_supported_format
+      assert Config.supported_format?(:json)
+      assert Config.supported_format?(:html)
+      refute Config.supported_format?(:xml)
+      refute Config.supported_format?(:unsupported)
+    end
+
+    def test_supported_formats
+      expected = [:json, :html]
+      assert_equal expected, Config.supported_formats
+    end
+
+    def test_reset
+      Config.formats = [:html]
+      Config.reset
+      assert_equal [:json], Config.formats
+    end
+  end
+end