rubycritic 4.8.1 → 4.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3947b3bda3c1df0be0e1dd53c54c12444dbb783cf1af0943f1eba708a17a810f
-  data.tar.gz: 93e1f9a59ffa8418c73fe731984d784af87327d8c371497a89af243eb47c5c87
+  metadata.gz: 9bea0ead82dce8ce7d27a1421044b70841199150f37e2293c41046ed4f96e50a
+  data.tar.gz: ef72c2062593c9c8cccea0c01e3f06904051c48de42ee55b3f0a2b672bf1186e
 SHA512:
-  metadata.gz: f33ccecd5a6333af4542fc5f2e5b946d83953b1c8833493523f9f3c6a05fcac6c7547eafda74b5e9d8d3cd6926a86c3350add816076520c35ae781b83160e70e
-  data.tar.gz: '0589b2472473c73982aa9742738c25ddfb9de3692a43ba200ed0a973a59e87ebead86f07d771562f4d8d8ee729efd0c56421dee62879fa4904830f5c335b492e'
+  metadata.gz: 57279fe99d97710ee3e5371adf8b001f8d4f272a69b9e1cb4ef06083404d8e3d5ce4c10671f59a8e2a3f5728d46b3f12fa7a77a41510a9d9618caee2745b338e
+  data.tar.gz: b1e216cf37893fcc573ece5d68e137f47797b490da322efed18e8ef060ef9935ba38be5a68fd293f516840ee942b25426f97487d4c97155f962f23f138498469

data/CHANGELOG.md

@@ -1,4 +1,22 @@
-# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.8.1...main)
+# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.9.1...main)
+
+# 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)
+
+* [CHANGE] Bump aruba, cucumber, fakefs, flog, mdl, minitest, and rubocop dependencies (by [@faisal][])
+* [CHANGE] Fix test warning related to `cucumber_opts` declaration (by [@faisal][])
+* [BUGFIX] Stop using long-deprecated MiniTest module name, removed in 5.19.0 (by [@faisal][])
+* [CHANGE] Disable VERBOSE warnings in test stubs (by [@fbuys][])
+* [CHANGE] Add rexml dependency for Ruby 3.0.0+ support (by [@fbuys][])
+* [BUGFIX] Raise error when the same branches are compared (by [@rishijain][])
+* [BUGFIX] Churn score was always 0 when rubycritic was executed from a sub-directory (by [@rishijain][])
+* [BUGFIX] Use overview.html as the fallback path when files does not exist during compare option (by [@rishijain][])
+* [BUGFIX] Use name from the file path instead of fetching name from the parser (by [@rishijain][])
 
 # v4.8.1 / 2023-05-17 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.8.0...v4.8.1)
 
@@ -91,7 +109,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)
@@ -329,7 +347,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
 
@@ -429,3 +447,5 @@
 [@faisal]: https://github.com/faisal
 [@96RadhikaJadhav]: https://github.com/96RadhikaJadhav
 [@Fito]: https://github.com/Fito
+[@fbuys]: https://github.com/fbuys
+[@exoego]: https://github.com/exoego

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/rubycritic.svg)](http://badge.fury.io/rb/rubycritic)
 [![Continuous Integration](https://github.com/whitesmith/rubycritic/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/whitesmith/rubycritic/actions/workflows/main.yml)
-[![Build Status](https://travis-ci.org/whitesmith/rubycritic.svg?branch=master)](https://travis-ci.org/whitesmith/rubycritic)
 [![Code Climate](https://codeclimate.com/github/whitesmith/rubycritic/badges/gpa.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
 
 <img src="https://github.com/whitesmith/rubycritic/raw/main/images/logo.png" alt="RubyCritic Icon" align="right">
@@ -11,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
 
@@ -108,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)
@@ -141,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
@@ -236,11 +239,11 @@ See [formatters](docs/formatters.md)
 RubyCritic is supporting Ruby versions:
 
 | Ruby version | Latest RubyCritic version |
-| - | - |
+| --- | --- |
 | 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 |
 

data/Rakefile

@@ -14,7 +14,7 @@ Rake::TestTask.new do |task|
 end
 
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = 'features --format progress --color'
+  t.cucumber_opts = %w[features --format progress --color]
 end
 
 RuboCop::RakeTask.new

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
 
@@ -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/modules_locator.rb

@@ -9,7 +9,7 @@ module RubyCritic
     end
 
     def first_name
-      names.first
+      name_from_path.first
     end
 
     def names

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/commands/compare.rb

@@ -18,6 +18,10 @@ module RubyCritic
       end
 
       def execute
+        if Config.send(:base_branch) == Config.send(:feature_branch)
+          raise('The branch you are on and are comparing with are the same.
+          Please switch to a different branch or choose a different branch to compare.')
+        end
         compare_branches
         status_reporter.score = Config.feature_branch_score
         status_reporter

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)

data/lib/rubycritic/generators/html/view_helpers.rb

@@ -24,7 +24,10 @@ module RubyCritic
     end
 
     def code_index_path(root_directory, file_name)
-      file_path("#{File.expand_path(root_directory)}/#{file_name}")
+      root_directory_path = File.expand_path(root_directory)
+      index_path = "#{root_directory_path}/#{file_name}"
+      index_path = "#{root_directory_path}/overview.html" unless File.exist?(index_path)
+      file_path(index_path)
     end
 
     private

data/lib/rubycritic/source_control_systems/git/churn.rb

@@ -73,6 +73,7 @@ module RubyCritic
           when /^[RC]/
             process_rename(*rest)
           else
+            rest = filename_for_subdirectory(rest[0])
             process_file(*rest)
           end
         end
@@ -86,6 +87,15 @@ module RubyCritic
           process_file(to)
         end
 
+        def filename_for_subdirectory(filename)
+          git_path = Git.git('rev-parse --show-toplevel')
+          cd_path = Dir.pwd
+          if cd_path.length > git_path.length
+            filename = filename.sub(/^#{Regexp.escape("#{File.basename(cd_path)}/")}/, '')
+          end
+          [filename]
+        end
+
         def process_file(filename)
           record_commit(renames.current(filename), @date)
         end

data/lib/rubycritic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 4.9.1
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-17 00:00:00.000000000 Z
+date: 2024-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2.1
+        version: 3.2.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2.1
+        version: 3.2.2.4
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -89,7 +89,7 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -99,21 +99,35 @@ dependencies:
         version: '6.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     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
@@ -162,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -210,14 +224,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: 9.2.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: 9.2.0
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -238,19 +258,22 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
   type: :development
@@ -258,12 +281,18 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.22.2
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
@@ -271,6 +300,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.22.2
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
@@ -300,21 +332,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.2.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
@@ -324,7 +356,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.2.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
@@ -348,14 +380,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: 1.59.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.54.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.51.0
+        version: 1.59.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.54.0
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -541,7 +579,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter