skunk 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 816d1842d51cccffa9e5284adc57ab7650bad54ef646e31bf8ac7941cd9dbb96
-  data.tar.gz: aaa37f4214a723eaacb3ddbae476f084f75e13b2c3fd156ab841ff9d6930739c
+  metadata.gz: 0fc5fca985be539efe139317e8c6e94221f322a85ff1425ecb6111ac37a6b08a
+  data.tar.gz: 5286ff3133b6f9d3d9a17d117d275db45049f2e82470730f4abc224ae47adf96
 SHA512:
-  metadata.gz: ede49233f3739dc19fb14bc2633acc8dbd2fbc87493673ed11eaeb22ecca3e7efa6e53c65b6e41548c8b30e00bb54349372429adc7fe9152fe77b8c12073bde1
-  data.tar.gz: e22e1e0d5e2bb43f1f7188b7eda3d36613baa6c3e68dd2e63d7664f01b9f7f89cc9ff3be6b72d96d75a667ebf5f836d175df4a379162193865084ad4ec4abd31
+  metadata.gz: f4d0ad320ae6ac543bd86dca2beb7deca48a33b3f6ef418492b077460cff45245af9c8f10bb71bb42b5d1962b5e7a6784e2c28fabef83787703b48e2ec296d46
+  data.tar.gz: a469d5f01b8c97e68a8a1ce7e7d906a001d8a21a174afe469795b827aca2dfea06ea7a0179e2da533847969202d35343b6c147a8bd14221ffec8ecfb6e316e5c

data/.github/workflows/main.yml

@@ -4,44 +4,12 @@ name: CI
 on: [push, pull_request]
 
 jobs:
-  test-ruby-2-4-x:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Ruby 2.4
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.4
-      - name: Build and run tests
-        env:
-          BUNDLE_GEMFILE: "Gemfile-Ruby-2-4"
-        run: |
-          gem install bundler -v 2.3
-          bundle install --jobs 4 --retry 3
-          bundle exec rake
-
-  test-ruby-2-5-x:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Setup Ruby 2.5
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 2.5
-      - name: Build and run tests
-        env:
-          BUNDLE_GEMFILE: "Gemfile-Ruby-2-5"
-        run: |
-          gem install bundler -v 2.3.26
-          bundle install --jobs 4 --retry 3
-          bundle exec rake
-
   test-ruby:
     runs-on: ${{ matrix.os }}-latest
     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 }}

data/.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: |

data/.gitignore

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

data/.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'

data/CHANGELOG.md

@@ -5,10 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## main [(unreleased)](https://github.com/fastruby/skunk/compare/v0.5.3...HEAD)
+## main [(unreleased)](https://github.com/fastruby/skunk/compare/v0.5.4...HEAD)
 
 * <INSERT YOUR FEATURE OR BUGFIX HERE>
 
+## v0.5.4 / 2025-05-05 [(commits)](https://github.com/fastruby/skunk/compare/v0.5.3...v0.5.4)
+
+* [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)
+
 ## v0.5.3 / 2023-12-01 [(commits)](https://github.com/fastruby/skunk/compare/v0.5.2...v0.5.3)
 
 * [BUGFIX: Update reek, rubocop, and terminal-table dependencies](https://github.com/fastruby/skunk/pull/111)

data/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.

data/lib/skunk/commands/base.rb

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

data/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 @@ module Skunk
       #
       # @return [Skunk::Command::StatusReporter]
       def execute
-        RubyCritic::Config.formats = []
+        RubyCritic::Config.formats = [:json]
 
         report(critique)
 
@@ -39,6 +38,8 @@ module Skunk
       #
       # @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

data/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

data/lib/skunk/generators/json_report.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rubycritic/generators/json_report"
+
+require "skunk/generators/json/simple"
+
+module Skunk
+  module Generator
+    # Generates a JSON report for the analysed modules.
+    class JsonReport < RubyCritic::Generator::JsonReport
+      def initialize(analysed_modules)
+        super
+        @analysed_modules = analysed_modules
+      end
+
+      private
+
+      def generator
+        Skunk::Generator::Json::Simple.new(@analysed_modules)
+      end
+    end
+  end
+end

data/lib/skunk/reporter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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].freeze
+
+    def self.generate_report(analysed_modules)
+      RubyCritic::Config.formats.uniq.each do |format|
+        report_generator_class(format).new(analysed_modules).generate_report
+      end
+    end
+
+    def self.report_generator_class(config_format)
+      if REPORT_GENERATOR_CLASS_FORMATS.include? config_format
+        require "skunk/generators/#{config_format}_report"
+        Generator.const_get("#{config_format.capitalize}Report")
+      else
+        require "skunk/generators/console_report"
+        Generator::ConsoleReport
+      end
+    end
+  end
+end

data/lib/skunk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skunk
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/skunk.gemspec

@@ -43,7 +43,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "codecov", "~> 0.1.16"
   spec.add_development_dependency "debug"
-  spec.add_development_dependency "minitest", "~> 5.8.4"
+  spec.add_development_dependency "minitest", "< 6"
   spec.add_development_dependency "minitest-around", "~> 0.5.0"
   spec.add_development_dependency "minitest-stub_any_instance", "~> 1.0.2"
   spec.add_development_dependency "minitest-stub-const", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skunk
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Ernesto Tagwerker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-01 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -76,16 +76,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: minitest-around
   requirement: !ruby/object:Gem::Requirement
@@ -232,8 +232,6 @@ files:
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile-Ruby-2-4
-- Gemfile-Ruby-2-5
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -254,6 +252,9 @@ files:
 - lib/skunk/commands/status_reporter.rb
 - lib/skunk/commands/status_sharer.rb
 - lib/skunk/commands/version.rb
+- lib/skunk/generators/json/simple.rb
+- lib/skunk/generators/json_report.rb
+- lib/skunk/reporter.rb
 - lib/skunk/rubycritic/analysed_module.rb
 - lib/skunk/rubycritic/analysed_modules_collection.rb
 - lib/skunk/version.rb
@@ -285,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A library to assess code quality vs. code coverage

data/Gemfile-Ruby-2-4

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in skunk.gemspec
-gemspec
-
-gem "reek", "~> 6.0.0"
-gem "rubocop", "~> 1.0"
-gem "simplecov", "< 0.19.0"
-gem "vcr", "< 6.1.0"

data/Gemfile-Ruby-2-5

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in skunk.gemspec
-gemspec
-
-gem "reek", "~> 6.0.0"
-gem "rubocop", "~> 1.0"
-gem "simplecov", "< 0.19.0"
-gem "vcr", "< 6.1.0"