Add JSON Report (#119)

* Update rubocop todo file

Improve bin/console experience

* Bump GitHub setup

* Add JSON generator

* Add Changelog entry

Author: JuanVqz

.github/workflows/main.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu]
-        ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2"]
+        ruby-version: ["2.6", "2.7", "3.0", "3.1", "3.2", "3.3"]
     steps:
       - uses: actions/checkout@v2
       - name: Setup Ruby ${{ matrix.ruby-version }}

.github/workflows/skunk.yml

@@ -6,11 +6,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: 3.3
           bundler-cache: true
       - name: Run test suite with COVERAGE=true
         run: |

.gitignore

@@ -11,3 +11,4 @@
 .byebug_history
 
 .ruby-version
+.tool-versions

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-07-22 00:31:00 UTC using RuboCop version 1.54.2.
+# on 2025-05-02 20:16:50 UTC using RuboCop version 1.75.4.
 # 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
@@ -25,12 +25,11 @@ Layout/HeredocIndentation:
   Exclude:
     - 'lib/skunk/commands/status_reporter.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: AllowedParentClasses.
 Lint/MissingSuper:
   Exclude:
     - 'lib/skunk/cli/application.rb'
-    - 'lib/skunk/commands/base.rb'
 
 # Offense count: 1
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
@@ -51,7 +50,16 @@ Metrics/MethodLength:
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
 # SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
+# AllowedIdentifiers: TLS1_1, TLS1_2, capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
 Naming/VariableNumber:
   Exclude:
     - 'lib/skunk/commands/status_sharer.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - '**/*.arb'
+    - 'bin/console'

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * <INSERT YOUR FEATURE OR BUGFIX HERE>
 
+* [FEATURE: Generate JSON report in background](https://github.com/fastruby/skunk/pull/119)
 * [ENHANCEMENT: Better test suite with more relaxed console output expectation](https://github.com/fastruby/skunk/pull/117)
 * [ENHANCEMENT: Use minitest 5.22.x (also, stop testing with Ruby 2.4 and 2.5)](https://github.com/fastruby/skunk/pull/115)
 

README.md

@@ -123,6 +123,10 @@ To only run skunk on specific folders, pass a list of directories in the command
 
 `skunk app lib`
 
+### Generate JSON report in background
+
+When the Skunk command is run, it will generate a JSON report file in the `RubyCritic::Config.root` location.
+
 ### Comparing feature branches
 
 When working on new features, run skunk against your feature branch to check if the changes are improving or decreasing the code quality of the project.

bin/console

@@ -1,16 +1,14 @@
-# frozen_string_literal: true
-
 #!/usr/bin/env ruby
 
 require "bundler/setup"
 require "skunk"
 
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
+# use `debugger` to set a breakpoint
+require "debug"
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
+puts "Welcome to the Skunk console!"
+puts ARGV.inspect
 
-require "irb"
-IRB.start(__FILE__)
+# Run skunk CLI application with the provided arguments
+require "skunk/cli/application"
+Skunk::Cli::Application.new(ARGV).execute

lib/skunk/commands/base.rb

@@ -10,6 +10,7 @@ module Command
     # reporter object.
     class Base < RubyCritic::Command::Base
       def initialize(options)
+        super
         @options = options
         @status_reporter = Skunk::Command::StatusReporter.new(@options)
       end

lib/skunk/commands/default.rb

@@ -3,11 +3,10 @@
 require "rubycritic/commands/default"
 require "rubycritic/analysers_runner"
 require "rubycritic/revision_comparator"
-require "rubycritic/reporter"
 
-require "skunk/commands/base"
 require "skunk/commands/shareable"
 require "skunk/commands/status_reporter"
+require "skunk/reporter"
 
 module Skunk
   module Command
@@ -27,7 +26,7 @@ def initialize(options)
       #
       # @return [Skunk::Command::StatusReporter]
       def execute
-        RubyCritic::Config.formats = []
+        RubyCritic::Config.formats = [:json]
 
         report(critique)
 
@@ -39,6 +38,8 @@ def execute
       #
       # @param [RubyCritic::AnalysedModulesCollection] A collection of analysed modules
       def report(analysed_modules)
+        Reporter.generate_report(analysed_modules)
+
         status_reporter.analysed_modules = analysed_modules
         status_reporter.score = analysed_modules.score
       end

lib/skunk/generators/json/simple.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "rubycritic/generators/json/simple"
+
+module Skunk
+  module Generator
+    module Json
+      # Generates a JSON report for the analysed modules.
+      class Simple < RubyCritic::Generator::Json::Simple
+        def data
+          {
+            analysed_modules_count: analysed_modules_count,
+            skunk_score_average: skunk_score_average,
+            skunk_score_total: skunk_score_total,
+            worst_pathname: worst&.pathname,
+            worst_score: worst&.skunk_score,
+            files: files
+          }
+        end
+
+        private
+
+        def analysed_modules_count
+          @analysed_modules_count ||= non_test_modules.count
+        end
+
+        def skunk_score_average
+          return 0 if analysed_modules_count.zero?
+
+          (skunk_score_total.to_d / analysed_modules_count).to_f.round(2)
+        end
+
+        def skunk_score_total
+          @skunk_score_total ||= non_test_modules.sum(&:skunk_score)
+        end
+
+        def non_test_modules
+          @non_test_modules ||= @analysed_modules.reject do |a_module|
+            module_path = a_module.pathname.dirname.to_s
+            module_path.start_with?("test", "spec") || module_path.end_with?("test", "spec")
+          end
+        end
+
+        def worst
+          @worst ||= sorted_modules.first
+        end
+
+        def sorted_modules
+          @sorted_modules ||= non_test_modules.sort_by(&:skunk_score).reverse!
+        end
+
+        def files
+          @files ||= sorted_modules.map(&:to_hash)
+        end
+      end
+    end
+  end
+end