rubycritic 4.9.0 → 4.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e02409fa512f3a1b9449ee32bcaf96a8a0b8de76761252475774fa190ca2059
-  data.tar.gz: 928090c08aff3e873916412a2b0ebc947e64495ade84fc60503534e0b531dad4
+  metadata.gz: 78f041e961ddd2844538f7fca6622192a8b2a9f64caa540cb8fc4b08f13362e0
+  data.tar.gz: 1bb52128d47548eb1969869552d26e7ef81940c61aa22b85777652f1a53659f1
 SHA512:
-  metadata.gz: de7584c2a57e92752da20be9a561164234347a7e24d0a8ee036cd54ff213a8f096aec0e7f299f0f534bf260a587314488f26bcdbf61639f47456d276aeebd200
-  data.tar.gz: 2988c1a400c24ce70b6468cafb7a70459830d9db42d928e714b552b2cfa6c53baf656d6ed92eea63b89a5a678451bce09e23018481c0992ff9ddbb11b8430e13
+  metadata.gz: 202a4ba45550da029562867c284a941c65666c013fbd75dfa2be0443ce2483149f4c2c751584ff90c10242014a8f630750e6413571304b3927faecb093062b8a
+  data.tar.gz: 9e4af57d0f10840698a488da7ce77951ef693c022fa16888bc1387fa73d9e3067eab3cd2ee7a690e4640880940426627b3b3089576c21671c408b7af77a41467

data/CHANGELOG.md

@@ -1,4 +1,19 @@
-# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.9.0...main)
+# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.9.2...main)
+
+# v4.9.2 / 2025-04-08 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.9.1...v4.9.2)
+
+* [CHANGE] Adds development dependency for gems removed from standard library in Ruby 3.5 -- ostruct, irb, rdoc (by [@faisal][])
+* [CHANGE] Bump aruba, fakefs, minitest, mocha, reek, rubocop dependencies (by [@faisal][])
+* [CHANGE] Loosen Rubocop dependency to pick up any new versions < 2.0 (by [@faisal][])
+* [CHANGE] Add .solargraph.yml config file to enable Solargraph LSP use in editors such as BBedit (by [@faisal][])
+* [CHANGE] Drop support for Ruby 2.7.x, 3.0.x (by [@faisal][])
+* [CHANGE] Cache the reek configuration loading for faster execution (by [@raff-s][])
+
+# v4.9.1 / 2024-04-14 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.9.0...v4.9.1)
+
+* [CHANGE] Bump cucumber, minitest, parser, rake, reek, rubocop, and ruby_parser dependencies (by [@faisal][])
+* [CHANGE] Fix some typos (by [@jbampton][])
+* [FEATURE] Add coverage_path configuration option (by [@exoego][])
 
 # v4.9.0 / 2023-10-18 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.8.1...v4.9.0)
 
@@ -103,7 +118,7 @@
 
 # v4.3.0 / 2019-12-26 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.2.2...v4.3.0)
 
-* [FEATURE] Show which files are uncommited in git (by [@GeoffTidey][])
+* [FEATURE] Show which files are uncommitted in git (by [@GeoffTidey][])
 * [BUGFIX] Fixes TypeError when `.resultset.json` is not found (by [@etagwerker][])
 
 # v4.2.2 / 2019-11-12 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.2.1...v4.2.2)
@@ -341,7 +356,7 @@
 
 * [FEATURE] Add CI mode that only analyses the last commit
 * [FEATURE] Add partial support for Mercurial
-* [FEATURE] Allow using RubyCritic programatically
+* [FEATURE] Allow using RubyCritic programmatically
 * [CHANGE] Update to Reek 1.6.0 (from 1.3.8)
 * [BUGFIX] Fix issue #18 - Prevent encoding issues when using Git
 
@@ -442,3 +457,5 @@
 [@96RadhikaJadhav]: https://github.com/96RadhikaJadhav
 [@Fito]: https://github.com/Fito
 [@fbuys]: https://github.com/fbuys
+[@exoego]: https://github.com/exoego
+[@raff-s]: https://github.com/raff-s

data/README.md

@@ -10,17 +10,19 @@ RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [F
 
 ## Table of Contents
 
-- [Overview](#overview)
-- [Getting Started](#getting-started)
-- [Usage](#usage)
-   + [Analyzer Configuration](#analyzer-configuration)
-   + [Alternative Usage Methods](#alternative-usage-methods)
-   + [Rake Task](#rake-task)
-- [Formatters](#formatters)
-- [Compatibility](#compatibility)
-- [Improving RubyCritic](#improving-rubyCritic)
-- [Contributors](#contributors)
-- [Credits](#credits)
+- [RubyCritic](#rubycritic)
+   - [Table of Contents](#table-of-contents)
+   - [Overview](#overview)
+   - [Getting Started](#getting-started)
+   - [Usage](#usage)
+      - [Analyzer Configuration](#analyzer-configuration)
+      - [Alternative Usage Methods](#alternative-usage-methods)
+      - [Rake Task](#rake-task)
+   - [Formatters](#formatters)
+   - [Compatibility](#compatibility)
+   - [Improving RubyCritic](#improving-rubycritic)
+   - [Contributors](#contributors)
+   - [Credits](#credits)
 
 ## Overview
 
@@ -107,19 +109,20 @@ For a full list of the command-line options run:
 $ rubycritic --help
 ```
 
-| Command flag                        | Description                                                     |
-|-------------------------------------|-----------------------------------------------------------------|
-| `-v` / `--version`                  | Displays the current version and exits                          |
-| `-p` / `--path`                     | Set path where report will be saved (tmp/rubycritic by default) |
-| `-f` / `--format`                   | Report smells in the given format(s)<sup>1</sup>                |
-| `--custom-format path:classname`    | Load and instantiate custom formatter(s)<sup>2</sup>            |
-| `-s` / `--minimum-score`            | Set a minimum score (FLOAT: ex: 96.28), default: 0              |
-| `-m` / `--mode-ci`                  | Use CI mode<sup>3</sup>                                         |
-| `-b` / `--branch`                   | Set branch to compare                                           |
-| `-t` / `--maximum-decrease`         | Threshold for score difference between two branches<sup>4</sup> |
-| `--deduplicate-symlinks`            | De-duplicate symlinks based on their final target               |
-| `--suppress-ratings`                | Suppress letter ratings                                         |
-| `--no-browser`                      | Do not open html report with browser                            |
+| Command flag                     | Description                                                     |
+|----------------------------------|-----------------------------------------------------------------|
+| `-v` / `--version`               | Displays the current version and exits                          |
+| `-p` / `--path`                  | Set path where report will be saved (tmp/rubycritic by default) |
+| `--coverage-path`                | Set path where SimpleCov will be saved (./coverage by default)  |
+| `-f` / `--format`                | Report smells in the given format(s)<sup>1</sup>                |
+| `--custom-format path:classname` | Load and instantiate custom formatter(s)<sup>2</sup>            |
+| `-s` / `--minimum-score`         | Set a minimum score (FLOAT: ex: 96.28), default: 0              |
+| `-m` / `--mode-ci`               | Use CI mode<sup>3</sup>                                         |
+| `-b` / `--branch`                | Set branch to compare                                           |
+| `-t` / `--maximum-decrease`      | Threshold for score difference between two branches<sup>4</sup> |
+| `--deduplicate-symlinks`         | De-duplicate symlinks based on their final target               |
+| `--suppress-ratings`             | Suppress letter ratings                                         |
+| `--no-browser`                   | Do not open html report with browser                            |
 
 1. Available output formats:
 - `html` (default; will open in a browser)
@@ -140,6 +143,7 @@ mode_ci:
   branch: 'production' # default is main
 branch: 'production' # default is main
 path: '/tmp/mycustompath' # Set path where report will be saved (tmp/rubycritic by default)
+coverage_path: '/tmp/coverage' # Set path where SimpleCov coverage will be saved (./coverage by default)
 threshold_score: 10 # default is 0
 deduplicate_symlinks: true # default is false
 suppress_ratings: true # default is false
@@ -239,9 +243,11 @@ RubyCritic is supporting Ruby versions:
 | 2.4 | [v4.7.0](https://github.com/whitesmith/rubycritic/tree/v4.7.0) |
 | 2.5 | [v4.7.0](https://github.com/whitesmith/rubycritic/tree/v4.7.0) |
 | 2.6 | [v4.7.0](https://github.com/whitesmith/rubycritic/tree/v4.7.0) |
-| 2.7 | latest |
+| 2.7 | [v4.9.x](https://github.com/whitesmith/rubycritic/tree/v4.9.1) |
 | 3.0 | latest |
 | 3.1 | latest |
+| 3.2 | latest |
+| 3.3 | latest |
 
 ## Improving RubyCritic
 
@@ -259,7 +265,7 @@ See RubyCritic's [contributing guidelines](https://github.com/whitesmith/rubycri
 
 The current core team consists of:
 
-* [Nuno Silva](https://github.com/Onumis)
+* [Nuno Silva](https://github.com/nunosilva800)
 * [Lucas Mazza](https://github.com/lucasmazza)
 * [Timo Rößner](https://github.com/troessner)
 

data/lib/rubycritic/analysers/coverage.rb

@@ -48,6 +48,9 @@ module RubyCritic
 
       # The path to the cache file
       def resultset_path
+        if (cp = Config.coverage_path)
+          SimpleCov.coverage_dir(cp)
+        end
         File.join(SimpleCov.coverage_path, RESULTSET_FILENAME)
       end
 
@@ -85,13 +88,13 @@ module RubyCritic
 
       # Ensure only one process is reading or writing the resultset at any
       # given time
-      def synchronize_resultset(&proc)
+      def synchronize_resultset(&)
         # make it reentrant
         return yield if defined?(@resultset_locked) && @resultset_locked == true
 
         return yield unless File.exist?(resultset_writelock)
 
-        with_lock(&proc)
+        with_lock(&)
       end
 
       def with_lock
@@ -112,11 +115,7 @@ module RubyCritic
         if Gem.loaded_specs['simplecov'].version >= Gem::Version.new('0.19')
           ::SimpleCov::Result.from_hash(resultset)
         else
-          array = []
-          resultset.each do |command_name, data|
-            array << ::SimpleCov::Result.from_hash(command_name => data)
-          end
-          array
+          resultset.map { |command_name, data| ::SimpleCov::Result.from_hash(command_name => data) }
         end
       end
     end

data/lib/rubycritic/analysers/helpers/reek.rb

@@ -4,8 +4,12 @@ require 'reek'
 
 module RubyCritic
   class Reek < ::Reek::Examiner
+    def self.configuration
+      @configuration ||= ::Reek::Configuration::AppConfiguration.from_default_path
+    end
+
     def initialize(analysed_module)
-      super(analysed_module, configuration: ::Reek::Configuration::AppConfiguration.from_default_path)
+      super(analysed_module, configuration: self.class.configuration)
     end
   end
 end

data/lib/rubycritic/cli/options/argv.rb

@@ -95,6 +95,10 @@ module RubyCritic
               self.no_browser = true
             end
 
+            opts.on('--coverage-path [PATH]', 'SimpleCov coverage will be saved (./coverage by default)') do |path|
+              @coverage_path = path
+            end
+
             opts.on_tail('-v', '--version', "Show gem's version") do
               self.mode = :version
             end
@@ -129,7 +133,7 @@ module RubyCritic
 
         attr_accessor :mode, :root, :formats, :formatters, :deduplicate_symlinks,
                       :suppress_ratings, :minimum_score, :churn_after, :no_browser,
-                      :parser, :base_branch, :feature_branch, :threshold_score
+                      :parser, :base_branch, :feature_branch, :threshold_score, :coverage_path
 
         def paths
           @argv unless @argv.empty?

data/lib/rubycritic/cli/options/file.rb

@@ -22,6 +22,7 @@ module RubyCritic
           {
             mode: mode,
             root: root,
+            coverage_path: coverage_path,
             formats: formats,
             deduplicate_symlinks: deduplicate_symlinks,
             paths: paths,
@@ -59,6 +60,10 @@ module RubyCritic
           options['path']
         end
 
+        def coverage_path
+          options['coverage_path']
+        end
+
         def threshold_score
           options['threshold_score']
         end

data/lib/rubycritic/configuration.rb

@@ -6,7 +6,7 @@ module RubyCritic
   class Configuration
     attr_reader :root
     attr_accessor :source_control_system, :mode, :formats, :formatters, :deduplicate_symlinks,
-                  :suppress_ratings, :open_with, :no_browser, :base_branch,
+                  :suppress_ratings, :open_with, :no_browser, :base_branch, :coverage_path,
                   :feature_branch, :base_branch_score, :feature_branch_score,
                   :base_root_directory, :feature_root_directory,
                   :compare_root_directory, :threshold_score, :base_branch_collection,
@@ -19,6 +19,7 @@ module RubyCritic
       self.suppress_ratings = options[:suppress_ratings]
       self.open_with = options[:open_with]
       self.no_browser = options[:no_browser]
+      self.coverage_path = options[:coverage_path]
       self.threshold_score = options[:threshold_score].to_i
       setup_analysis_targets(options)
       setup_version_control(options)
@@ -69,9 +70,9 @@ module RubyCritic
       !Config.no_browser && %i[compare_branches ci].include?(Config.mode)
     end
 
-    def self.method_missing(method, *args, &block)
+    def self.method_missing(method, ...)
       if configuration.respond_to?(method)
-        configuration.public_send(method, *args, &block)
+        configuration.public_send(method, ...)
       else
         super
       end

data/lib/rubycritic/core/analysed_modules_collection.rb

@@ -28,8 +28,8 @@ module RubyCritic
       end
     end
 
-    def each(&block)
-      @modules.each(&block)
+    def each(&)
+      @modules.each(&)
     end
 
     def where(module_paths)

data/lib/rubycritic/source_control_systems/mercurial.rb

@@ -6,7 +6,8 @@ module RubyCritic
       register_system
 
       def self.supported?
-        `hg verify 2>&1` && $CHILD_STATUS.success?
+        hg_verify = `hg verify 2>&1`
+        hg_verify && $CHILD_STATUS.success?
       end
 
       def self.to_s

data/lib/rubycritic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCritic
-  VERSION = '4.9.0'.freeze
+  VERSION = '4.9.2'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.9.2
 platform: ruby
 authors:
 - Guilherme Simoes
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-18 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -58,14 +57,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2.1
+        version: 3.3.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2.1
+        version: 3.3.0.5
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +85,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.4.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -96,7 +95,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 6.4.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
@@ -120,14 +119,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.20'
+        version: '3.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.20'
+        version: '3.21'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -176,14 +175,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -224,7 +223,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.0.2
+        version: 9.2.1
     - - "!="
       - !ruby/object:Gem::Version
         version: 9.0.0
@@ -234,7 +233,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 9.0.2
+        version: 9.2.1
     - - "!="
       - !ruby/object:Gem::Version
         version: 9.0.0
@@ -258,14 +257,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mdl
   requirement: !ruby/object:Gem::Requirement
@@ -292,7 +305,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.20.0
+        version: 5.25.2
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
@@ -302,7 +315,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.20.0
+        version: 5.25.2
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
@@ -332,21 +345,35 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.2.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
@@ -356,10 +383,24 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.2.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -378,22 +419,22 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.57.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.54.0
+        version: 1.72.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.57.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.54.0
+        version: 1.72.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -564,7 +605,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -572,15 +612,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter
 test_files: []