rubycritic 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 025aff87e62b4fde94b8920973574ff4231503b8d1ed614705b223c61ab8cf17
-  data.tar.gz: b3e0521dd5d2859a7535c51a92f5b5bf2666f7cb02ad26a0171e503861ca308c
+  metadata.gz: 5e02409fa512f3a1b9449ee32bcaf96a8a0b8de76761252475774fa190ca2059
+  data.tar.gz: 928090c08aff3e873916412a2b0ebc947e64495ade84fc60503534e0b531dad4
 SHA512:
-  metadata.gz: 6b8d0d03d8d9332e90899854e2f4e76e6b293dbc83e2bd76f0e6991fcce087294364bc2f6a1aceefa1cf101b20e6d94522464c61c1f18f06e3be2bc2c206e992
-  data.tar.gz: 8103598ab67398b6f5761ff3608e4a60879474f6b9b312700ccc6c48ecc59dc09ec5728d10a654daa11318bdaba316346be0b1360d8193337d68390c7ffa55a8
+  metadata.gz: de7584c2a57e92752da20be9a561164234347a7e24d0a8ee036cd54ff213a8f096aec0e7f299f0f534bf260a587314488f26bcdbf61639f47456d276aeebd200
+  data.tar.gz: 2988c1a400c24ce70b6468cafb7a70459830d9db42d928e714b552b2cfa6c53baf656d6ed92eea63b89a5a678451bce09e23018481c0992ff9ddbb11b8430e13

data/CHANGELOG.md

@@ -1,4 +1,25 @@
-# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.8.0...main)
+# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.9.0...main)
+
+# 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)
+
+* [CHANGE] Update runtime dependencies to current versions of analysis gems (by [@faisal][])
+* [CHANGE] Update the mdl development_dependency from 0.5 to 0.12 (by [@faisal][])
+* [CHANGE] Update rubocop to use current version (~1.51.0) and relevant plugins (by [@faisal][]])
+* [CHANGE] Update testing gems to current versions (by [@faisal][])
+* [BUGFIX] Fix sort and filters on the coverage page (by [@kcamcam][])
+* [CHANGE] Scope churn calculation to provided paths (by [@Fito][])
 
 # v4.8.0 / 2023-05-12 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.7.0...v4.8.0)
 
@@ -418,4 +439,6 @@
 [@marcgrimme]: https://github.com/marcgrimme
 [@katafrakt]: https://github.com/katafrakt
 [@faisal]: https://github.com/faisal
-[@96RadhikaJadhav]: https://github.com/
+[@96RadhikaJadhav]: https://github.com/96RadhikaJadhav
+[@Fito]: https://github.com/Fito
+[@fbuys]: https://github.com/fbuys

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">
@@ -14,9 +13,9 @@ RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [F
 - [Overview](#overview)
 - [Getting Started](#getting-started)
 - [Usage](#usage)
-  + [Analyzer Configuration](#analyzer-configuration)
-  + [Alternative Usage Methods](#alternative-usage-methods)
-  + [Rake Task](#rake-task)
+   + [Analyzer Configuration](#analyzer-configuration)
+   + [Alternative Usage Methods](#alternative-usage-methods)
+   + [Rake Task](#rake-task)
 - [Formatters](#formatters)
 - [Compatibility](#compatibility)
 - [Improving RubyCritic](#improving-rubyCritic)
@@ -95,7 +94,8 @@ current directory:
 $ rubycritic
 ```
 
-Alternatively you can pass `rubycritic` a list of files and directories to check:
+Alternatively you can pass `rubycritic` a list of files and directories.
+The analysis will be scoped to the provided files and directories:
 
 ```bash
 $ rubycritic app lib/foo.rb
@@ -147,7 +147,7 @@ no_browser: true # default is false
 formats: # Available values are: html, json, console, lint. Default value is html.
   - console
 minimum_score: 95 # default is 0
-paths: # Files to analyse.
+paths: # Files to analyse. Churn calculation is scoped to these files when using Git SCM.
   - 'app/controllers/'
   - 'app/models/'
 ```
@@ -159,9 +159,9 @@ paths: # Files to analyse.
   project root and `RubyCritic` will respect this configuration.
 * [`flay`](https://github.com/seattlerb/flay): We use `flay`'s default configuration.
 * [`flog`](https://github.com/seattlerb/flog): We use `flog`'s default configuration with a couple of [smaller tweaks](https://github.com/whitesmith/rubycritic/blob/main/lib/rubycritic/analysers/helpers/flog.rb#L5):
-  * `all`: Forces `flog` to report scores on all classes and methods. Without this option `flog` will only give results up to a certain threshold.
-  * `continue`: Makes it so that `flog` does not abort when a ruby file cannot be parsed.
-  * `methods`: Configures `flog` to skip code outside of methods. It prevents `flog` from reporting on the "methods" `private` and `protected`. It also prevents `flog` from reporting on Rails methods like `before_action` and `has_many`.
+   * `all`: Forces `flog` to report scores on all classes and methods. Without this option `flog` will only give results up to a certain threshold.
+   * `continue`: Makes it so that `flog` does not abort when a ruby file cannot be parsed.
+   * `methods`: Configures `flog` to skip code outside of methods. It prevents `flog` from reporting on the "methods" `private` and `protected`. It also prevents `flog` from reporting on Rails methods like `before_action` and `has_many`.
 
 ### Alternative Usage Methods
 
@@ -235,7 +235,7 @@ 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) |

data/ROADMAP.md

@@ -6,9 +6,9 @@ These are more nice-to-haves than promises. We can always dream. But this is wha
 
 - [ ] Improve how modules are graded. Each module is awarded a score, depending on:
 
-  * Its complexity, based off of this [post by Jake Scruggs](http://jakescruggs.blogspot.pt/2008/08/whats-good-flog-score.html), creator of the MetricFu gem. For every 25 points of complexity (as calculated by Flog), the score increases by 1.
+   * Its complexity, based off of this [post by Jake Scruggs](http://jakescruggs.blogspot.pt/2008/08/whats-good-flog-score.html), creator of the MetricFu gem. For every 25 points of complexity (as calculated by Flog), the score increases by 1.
 
-  * Its duplication mass, based off of observations of a few Code Climate repos. For every 25 points of mass (as calculated by Flay), the score increases by 1.
+   * Its duplication mass, based off of observations of a few Code Climate repos. For every 25 points of mass (as calculated by Flay), the score increases by 1.
 
   Finally, this score is translated to a grade like [this](https://github.com/whitesmith/rubycritic/blob/43005e7b76dd0c648c7715133e42afdd6ea9a065/lib/rubycritic/core/rating.rb), based off of a [Code Climate blog post](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/#value-objects).
 
@@ -21,36 +21,36 @@ These are more nice-to-haves than promises. We can always dream. But this is wha
 - [ ] Make the gem configurable using a dotfile like .rubycritic.yml. #30
       Here are some possible settings:
 
-  - [ ] Quiet mode. As of right now, any Ruby code that is unparsable will be reported three times (one time by Flog, another by Flay and another by Reek). Only Flog implements a quiet option, which means we have to implement that quiet option on Flay and on Reek before we can add it to RubyCritic. Or we could just do `$stderr = StringIO.new`... I wonder if that's really really smart or really really stupid.
+   - [ ] Quiet mode. As of right now, any Ruby code that is unparsable will be reported three times (one time by Flog, another by Flay and another by Reek). Only Flog implements a quiet option, which means we have to implement that quiet option on Flay and on Reek before we can add it to RubyCritic. Or we could just do `$stderr = StringIO.new`... I wonder if that's really really smart or really really stupid.
 
-  - [ ] Verbose mode. #61
+   - [ ] Verbose mode. #61
 
-  - [ ] Ignoring/excluding files. #11
+   - [ ] Ignoring/excluding files. #11
 
-  - [ ] Allow configuring date range of Churn calculation. #37 Right now, they are limited to the last year. #39
+   - [ ] Allow configuring date range of Churn calculation. #37 Right now, they are limited to the last year. #39
 
 - [ ] Highlight blocks of duplicated code instead of just the start of the block. This will probably require rewriting Flay with [parser](https://github.com/whitequark/parser) instead of ruby_parser.
 
 - [ ] Integrate other gems, like:
 
-  - [x] [Simplecov](https://github.com/colszowka/simplecov) to provide code coverage. #319
+   - [x] [Simplecov](https://github.com/colszowka/simplecov) to provide code coverage. #319
 
-  - [ ] [Rubocop](https://github.com/bbatsov/rubocop/) to provide style issues
+   - [ ] [Rubocop](https://github.com/bbatsov/rubocop/) to provide style issues
 
-  - [ ] [Brakeman](https://github.com/presidentbeef/brakeman) to provide security issues (Rails-only feature)
+   - [ ] [Brakeman](https://github.com/presidentbeef/brakeman) to provide security issues (Rails-only feature)
 
-  - [ ] [Rails Best Practices](https://github.com/railsbp/rails_best_practices) to provide Rails smells (Rails-only feature) #14
+   - [ ] [Rails Best Practices](https://github.com/railsbp/rails_best_practices) to provide Rails smells (Rails-only feature) #14
 
-  - [ ] [SandiMeter](https://github.com/makaroni4/sandi_meter) #15
+   - [ ] [SandiMeter](https://github.com/makaroni4/sandi_meter) #15
 
 - [ ] Improve UI.
 
-  - [ ] Make it beautiful.
+   - [ ] Make it beautiful.
 
-  - [ ] Figure out where the "suggestions to fix code smells" should be presented.
+   - [ ] Figure out where the "suggestions to fix code smells" should be presented.
 
-  - [ ] Create some kind of toggle option between various types of issues. Just like we can toggle between "Smells" and "Coverage" in Code Climate:
+   - [ ] Create some kind of toggle option between various types of issues. Just like we can toggle between "Smells" and "Coverage" in Code Climate:
 
-    ![Code Climate Toggle Option](https://camo.githubusercontent.com/d97fc62dae6ebef1f35bda91942d4a6bacc445b2/687474703a2f2f626c6f672e636f6465636c696d6174652e636f6d2f696d616765732f706f7374732f74657374696e672e676966)
+     ![Code Climate Toggle Option](https://camo.githubusercontent.com/d97fc62dae6ebef1f35bda91942d4a6bacc445b2/687474703a2f2f626c6f672e636f6465636c696d6174652e636f6d2f696d616765732f706f7374732f74657374696e672e676966)
 
-    Having an option to toggle between "Smells", "Security" (Brakeman) and "Style" (Rubocop) would be great. But that's already assuming we can integrate those gems into RubyCritic.
+     Having an option to toggle between "Smells", "Security" (Brakeman) and "Style" (Rubocop) would be great. But that's already assuming we can integrate those gems into RubyCritic.

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/helpers/ast_node.rb

@@ -13,12 +13,12 @@ module Parser
         count
       end
 
-      def recursive_children
+      def recursive_children(&block)
         children.each do |child|
           next unless child.is_a?(Parser::AST::Node)
 
           yield child
-          child.recursive_children { |grand_child| yield grand_child }
+          child.recursive_children(&block)
         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/file.rb

@@ -77,8 +77,9 @@ module RubyCritic
 
         def formats
           formats = Array(options['formats'])
+          formats_to_check = %w[html json console lint]
           formats.select do |format|
-            %w[html json console lint].include?(format)
+            formats_to_check.include?(format)
           end.map(&:to_sym)
         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
@@ -91,9 +95,9 @@ module RubyCritic
 
       # create a txt file with the branch score details
       def build_details
-        details = "Base branch (#{Config.base_branch}) score: #{Config.base_branch_score} \n"\
+        details = "Base branch (#{Config.base_branch}) score: #{Config.base_branch_score} \n" \
                   "Feature branch (#{Config.feature_branch}) score: #{Config.feature_branch_score} \n"
-        File.open("#{Config.compare_root_directory}/build_details.txt", 'w') { |file| file.write(details) }
+        File.write("#{Config.compare_root_directory}/build_details.txt", details)
       end
 
       # store the analysed moduled collection based on the branch

data/lib/rubycritic/commands/status_reporter.rb

@@ -4,6 +4,7 @@ module RubyCritic
   module Command
     class StatusReporter
       attr_reader :status, :status_message, :score
+
       SUCCESS = 0
       SCORE_BELOW_MINIMUM = 1
 

data/lib/rubycritic/commands/version.rb

@@ -7,6 +7,7 @@ module RubyCritic
   module Command
     class Version < Base
       attr_reader :status_reporter
+
       def execute
         puts "RubyCritic #{VERSION}"
         status_reporter

data/lib/rubycritic/configuration.rb

@@ -10,7 +10,7 @@ module RubyCritic
                   :feature_branch, :base_branch_score, :feature_branch_score,
                   :base_root_directory, :feature_root_directory,
                   :compare_root_directory, :threshold_score, :base_branch_collection,
-                  :feature_branch_collection, :churn_after, :ruby_extensions
+                  :feature_branch_collection, :churn_after, :ruby_extensions, :paths
 
     def set(options)
       self.mode = options[:mode] || :default
@@ -20,11 +20,16 @@ module RubyCritic
       self.open_with = options[:open_with]
       self.no_browser = options[:no_browser]
       self.threshold_score = options[:threshold_score].to_i
-      self.ruby_extensions = options[:ruby_extensions] || %w[.rb .rake .thor]
+      setup_analysis_targets(options)
       setup_version_control(options)
       setup_formats(options)
     end
 
+    def setup_analysis_targets(options)
+      self.paths = options[:paths] || ['.']
+      self.ruby_extensions = options[:ruby_extensions] || %w[.rb .rake .thor]
+    end
+
     def setup_version_control(options)
       self.base_branch = options[:base_branch]
       self.feature_branch = options[:feature_branch]

data/lib/rubycritic/core/analysed_module.rb

@@ -41,7 +41,7 @@ module RubyCritic
     end
 
     def cost
-      @cost ||= smells.map(&:cost).inject(0.0, :+) +
+      @cost ||= smells.sum(0.0, &:cost) +
                 (complexity / COMPLEXITY_FACTOR)
     end
 

data/lib/rubycritic/core/analysed_modules_collection.rb

@@ -46,7 +46,7 @@ module RubyCritic
 
     def score
       if @modules.any?
-        (MAX_SCORE - average_limited_cost * COST_MULTIPLIER).round(2)
+        (MAX_SCORE - (average_limited_cost * COST_MULTIPLIER)).round(2)
       else
         0.0
       end
@@ -69,7 +69,7 @@ module RubyCritic
     def average_cost
       num_modules = @modules.size
       if num_modules.positive?
-        map { |mod| limited_cost_for(mod) }.reduce(:+) / num_modules.to_f
+        sum { |mod| limited_cost_for(mod) } / num_modules.to_f
       else
         0.0
       end

data/lib/rubycritic/core/rating.rb

@@ -7,7 +7,8 @@ module RubyCritic
       elsif cost <= 4  then new('B')
       elsif cost <= 8  then new('C')
       elsif cost <= 16 then new('D')
-      else new('F')
+      else
+        new('F')
       end
     end
 

data/lib/rubycritic/core/smell.rb

@@ -20,7 +20,7 @@ module RubyCritic
     FLOG_DOCS_URL = 'http://docs.seattlerb.org/flog/'.freeze
 
     def at_location?(other_location)
-      locations.any? { |location| location == other_location }
+      locations.any?(other_location)
     end
 
     def multiple_locations?

data/lib/rubycritic/generators/html/assets/javascripts/application.js

@@ -239,11 +239,16 @@ $("#codeTable")
     sortList: [[0,1]]
   });
 
-$("#js-index-table")
+$("#smellsTable")
   .tablesorter({          // Sort the table
     sortList: [[0,0]]
   });
 
+$("#coverageTable")
+  .tablesorter({          // Sort the table
+    sortList: [[0,1]]
+  });
+
 $(".js-timeago").timeago();
 
 $(function(){
@@ -277,5 +282,6 @@ $(document).ready(function(){
 
 var initTableFilters = function() {
   $("#codeTable").filterTable({ignoreColumns: [2], placeholder: 'Filter by Name'});
-  $("#js-index-table").filterTable({ignoreColumns: [2, 3, 4, 5], placeholder: 'Filter by Smell or Location', inputSelector: 'form-control'});
+  $("#smellsTable").filterTable({ignoreColumns: [2, 3, 4, 5], placeholder: 'Filter by Smell or Location', inputSelector: 'form-control'});
+  $("#coverageTable").filterTable({ignoreColumns: [0], placeholder: 'Filter by Smell or Location', inputSelector: 'form-control'});
 }

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

@@ -19,7 +19,7 @@ module RubyCritic
         end
 
         def render
-          template.result(binding).delete("\n") + "\n"
+          "#{template.result(binding).delete("\n")}\n"
         end
 
         private

data/lib/rubycritic/generators/html/templates/simple_cov_index.html.erb

@@ -8,7 +8,7 @@
       </div>
       <!--End Page Title -->
       <div class="Content_Wrapper">
-        <table id="js-index-table" class="table coverage-index-table index-table sortable-table">
+        <table id="coverageTable" class="table index-table sortable-table tablesorter">
           <thead>
             <tr>
               <% unless Config.suppress_ratings %>
@@ -20,20 +20,23 @@
           </thead>
           <% @analysed_modules.each do |analysed_module| %>
             <tr>
-              <tr>
-                <% unless Config.suppress_ratings %>
-                  <td>
-                    <div class="rating <%= analysed_module.coverage_rating.to_s.downcase %>"><%= analysed_module.coverage_rating %></div>
-                  </td>
-                <% end %>
+              <% unless Config.suppress_ratings %>
                 <td>
-                  <ul class="nav nav-pills">
-                    <li role="presentation" >
-                      <a href="<%= file_path(analysed_module.pathname.sub_ext('.html')) %>"><%= analysed_module.name %></a>
-                    </li>
-                  </ul>
+                  <div class="rating <%= analysed_module.coverage_rating.to_s.downcase %>">
+                    <%= analysed_module.coverage_rating %>
+                  </div>
                 </td>
-                <td><%= '%g' % analysed_module.coverage %>%</td>
+              <% end %>
+              <td>
+                <ul class="nav nav-pills">
+                  <li role="presentation" >
+                    <a href="<%= file_path(analysed_module.pathname.sub_ext('.html')) %>">
+                      <%= analysed_module.name %>
+                    </a>
+                  </li>
+                </ul>
+              </td>
+              <td><%= '%.2f' % analysed_module.coverage %>%</td>
             </tr>
           <% end %>
         </table>

data/lib/rubycritic/generators/html/templates/smells_index.html.erb

@@ -8,7 +8,7 @@
       </div>
       <!--End Page Title -->
       <div class="Content_Wrapper">
-        <table id="js-index-table" class="table smells-index-table index-table sortable-table">
+        <table id="smellsTable" class="table smells-index-table index-table sortable-table">
           <thead>
             <tr>
               <th width="30%" class="table-header">Smell<span class="sort-type"></span></th>

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/generators/html_report.rb

@@ -33,9 +33,7 @@ module RubyCritic
       def create_directories_and_files
         Array(generators).each do |generator|
           FileUtils.mkdir_p(generator.file_directory)
-          File.open(generator.file_pathname, 'w+') do |file|
-            file.write(generator.render)
-          end
+          File.write(generator.file_pathname, generator.render)
         end
       end
 

data/lib/rubycritic/generators/json_report.rb

@@ -11,9 +11,7 @@ module RubyCritic
 
       def generate_report
         FileUtils.mkdir_p(generator.file_directory)
-        File.open(generator.file_pathname, 'w+') do |file|
-          file.write(generator.render)
-        end
+        File.write(generator.file_pathname, generator.render)
       end
 
       private

data/lib/rubycritic/generators/lint_report.rb

@@ -11,9 +11,7 @@ module RubyCritic
 
       def generate_report
         FileUtils.mkdir_p(generator.file_directory)
-        File.open(generator.file_pathname, 'w+') do |file|
-          file.write(reports.join("\n"))
-        end
+        File.write(generator.file_pathname, reports.join("\n"))
       end
 
       def generator

data/lib/rubycritic/source_control_systems/base.rb

@@ -21,9 +21,9 @@ module RubyCritic
         if supported_system
           supported_system.new
         else
-          puts 'RubyCritic can provide more feedback if you use '\
-                "a #{connected_system_names} repository. "\
-                'Churn will not be calculated.'
+          puts 'RubyCritic can provide more feedback if you use ' \
+               "a #{connected_system_names} repository. " \
+               'Churn will not be calculated.'
           Double.new
         end
       end

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

@@ -21,11 +21,11 @@ module RubyCritic
       end
 
       class Churn
-        def initialize(churn_after: nil)
-          @renames = Renames.new
+        def initialize(churn_after: nil, paths: ['.'])
+          @churn_after = churn_after
+          @paths = Array(paths)
           @date = nil
           @stats = {}
-          @churn_after = churn_after
 
           call
         end
@@ -41,16 +41,27 @@ module RubyCritic
         private
 
         def call
+          git_log_commands.each { |log_command| exec_git_command(log_command) }
+        end
+
+        def exec_git_command(command)
           Git
-            .git(git_log_command)
+            .git(command)
             .split("\n")
             .reject(&:empty?)
             .each { |line| process_line(line) }
         end
 
-        def git_log_command
-          after_clause = @churn_after ? "--after='#{@churn_after}' " : ''
-          "log --all --date=iso --follow --format='format:date:%x09%ad' --name-status #{after_clause}."
+        def git_log_commands
+          @paths.map { |path| git_log_command(path) }
+        end
+
+        def git_log_command(path)
+          "log --all --date=iso --follow --format='format:date:%x09%ad' --name-status #{after_clause}#{path}"
+        end
+
+        def after_clause
+          @churn_after ? "--after='#{@churn_after}' " : ''
         end
 
         def process_line(line)
@@ -62,6 +73,7 @@ module RubyCritic
           when /^[RC]/
             process_rename(*rest)
           else
+            rest = filename_for_subdirectory(rest[0])
             process_file(*rest)
           end
         end
@@ -71,12 +83,21 @@ module RubyCritic
         end
 
         def process_rename(from, to)
-          @renames.renamed(from, to)
+          renames.renamed(from, to)
           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)
+          record_commit(renames.current(filename), @date)
         end
 
         def record_commit(filename, date)
@@ -84,6 +105,10 @@ module RubyCritic
           stats.count += 1
         end
 
+        def renames
+          @renames ||= Renames.new
+        end
+
         def stats(path)
           @stats.fetch(path, Stats.new(0))
         end

data/lib/rubycritic/source_control_systems/git.rb

@@ -30,7 +30,7 @@ module RubyCritic
       end
 
       def churn
-        @churn ||= Churn.new(churn_after: Config.churn_after)
+        @churn ||= Churn.new(churn_after: Config.churn_after, paths: Config.paths)
       end
 
       def revisions_count(path)
@@ -71,18 +71,18 @@ module RubyCritic
 
       def self.modified_files
         modified_files = `git diff --name-status #{Config.base_branch} #{Config.feature_branch}`
-        modified_files.split("\n").map do |line|
+        modified_files.split("\n").filter_map do |line|
           next if line.start_with?('D')
 
           file_name = line.split("\t")[1]
           file_name
-        end.compact
+        end
       end
 
       def self.current_branch
         branch_list = `git branch`
         branch = branch_list.match(/\*.*$/)[0].gsub('* ', '')
-        branch = branch.gsub(/\(HEAD detached at (.*)\)$/, '\1') if branch =~ /\(HEAD detached at (.*)\)$/
+        branch = branch.gsub(/\(HEAD detached at (.*)\)$/, '\1') if /\(HEAD detached at (.*)\)$/.match?(branch)
         branch
       end
 

data/lib/rubycritic/source_control_systems/perforce.rb

@@ -88,7 +88,7 @@ module RubyCritic
       end
 
       def self.compute_cache_lines(lines)
-        perforce_lines = Hash[*lines.map { |line| line.split[1..-1] }.flatten]
+        perforce_lines = Hash[*lines.map { |line| line.split[1..] }.flatten]
         PerforceStats.new(
           Perforce.normalized_file_path(perforce_lines['clientFile']),
           perforce_lines['headRev'],

data/lib/rubycritic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: launchy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.5.2
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 3.2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 3.2.2.1
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
@@ -100,103 +100,94 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.0'
+- !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.8'
+        version: '3.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.20'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.17.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: tty-which
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -204,9 +195,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -236,20 +224,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
+        version: 9.0.2
+    - - "!="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 9.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
+        version: 9.0.2
+    - - "!="
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 9.0.0
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -270,38 +258,41 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: mdl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.13.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        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.20.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
@@ -309,6 +300,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.20.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
@@ -338,27 +332,21 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 13.0.6
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
@@ -368,7 +356,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: 13.0.6
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
@@ -392,14 +380,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.57.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.54.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 1.57.1
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.54.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  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: rubocop-performance
+  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: rubocop-rake
+  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'
 description: RubyCritic is a tool that wraps around various static analysis gems to
   provide a quality report of your Ruby code.
 email:
@@ -526,7 +562,8 @@ files:
 homepage: https://github.com/whitesmith/rubycritic
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -542,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.3.7
 signing_key:
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter