rubycritic 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9223069d4934bf55e41bd199b4610e9b230b4115d36196354d4aa93d87b8ea01
-  data.tar.gz: 7d1b324b4df74ac99bb1103c6f80678a90e872418eac4faa87dd2f687cdb87cc
+  metadata.gz: 025aff87e62b4fde94b8920973574ff4231503b8d1ed614705b223c61ab8cf17
+  data.tar.gz: b3e0521dd5d2859a7535c51a92f5b5bf2666f7cb02ad26a0171e503861ca308c
 SHA512:
-  metadata.gz: 91abe36adad615bf645187214511346e8175f28f913462baaa31b0be4bdf1986fa01e3841ff71866fa80f5de9d2e10d0ed6cd53dded35c30b04d2ad1910a5d6f
-  data.tar.gz: 6764cabd0cac4338072f4eadde37819095a10c3c5d5fd78d76d75ffe0e68d12ee58afe0169c286f3ea32fad9e91df145a9396e42154cbd446e78f8ee64b579ad
+  metadata.gz: 6b8d0d03d8d9332e90899854e2f4e76e6b293dbc83e2bd76f0e6991fcce087294364bc2f6a1aceefa1cf101b20e6d94522464c61c1f18f06e3be2bc2c206e992
+  data.tar.gz: 8103598ab67398b6f5761ff3608e4a60879474f6b9b312700ccc6c48ecc59dc09ec5728d10a654daa11318bdaba316346be0b1360d8193337d68390c7ffa55a8

data/CHANGELOG.md

@@ -1,4 +1,27 @@
-# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.7.0...main)
+# main [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.8.0...main)
+
+# v4.8.0 / 2023-05-12 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.7.0...v4.8.0)
+
+* [CHORE] Fix syntax of contributor references in this file
+* [CHANGE] Updated branch references from master to main (by [@96RadhikaJadhav][] and [@faisal][])
+* [CHORE] Test gem with Ruby 3.2 (by [@etagwerker][])
+* [CHORE] Test gem with Ruby 3.1 (by [@etagwerker][])
+* [CHANGE] Drop support for JRuby 9.3.x (by [@faisal][])
+* [CHANGE] Drop support for Ruby 2.6.x (by [@faisal][])
+* [CHANGE] Drop support for Ruby 2.5.x (by [@cleicar][])
+* [CHANGE] Drop support for Ruby 2.4.x (by [@rishijain][])
+* [FEATURE] Add ruby_extensions configuration option (by [@stufro][])
+* [CHANGE] Include files which have a ruby shebang (by [@stufro][])
+* [CHANGE] Fix some typos (by [@ydah][])
+* [CHANGE] Remove wrong Rubocop reference in contributing file (by [@itsmeurbi][])
+* [BUGFIX] Restore missing smell status label (by [@itsmeurbi][])
+* [BUGFIX] Fix changelog @user links and update README (by [@kcamcam][])
+* [BUGFIX] Fix CI rubocop using ruby-head (by [@juanvqz][])
+* [BUGFIX] Fix CI Update FakeFs to use ruby-head (by [@juanvqz][])
+* [BUGFIX] Fix CI, test didn't include the ruby_extensions (by [@aisayo][] and [@juanvqz][])
+* [FEATURE] Support a branch in 'detached HEAD' state (by [@h-r-k-matsumoto][])
+* [BUGFIX] Fix CI, tests did not work with JRuby (by [@etagwerker][] and [@h-r-k-matsumoto][])
+* [CHANGE] Add continuous integration status badge to README (by [@kcamcam][])
 
 # v4.7.0 / 2022-05-06 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.6.1...v4.7.0)
 
@@ -20,8 +43,7 @@
 * [CHANGE] Make Github Linguist ignore vendored files (by [@sl4vr][])
 * [BUGFIX] Fix directory structure of reports when comparing branches (by [@denny][])
 * [BUGFIX] Restrict simplecov to versions before data format changed (by [@denny][])
-
-* [BUGFIX] Handle missing comparison file in html template (by @lauratpa)
+* [BUGFIX] Handle missing comparison file in html template (by [@lauratpa][])
 
 # v4.5.2 / 2020-08-20 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.5.1...v4.5.2)
 
@@ -30,7 +52,6 @@
 # v4.5.1 / 2020-06-29 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.5.0...v4.5.1)
 
 * [BUGFIX] Handle git --name-status Copied (C) operation (by [@rizalmuthi][])
-
 * [FEATURE] Add --churn-after (only supports git) to limit churn analysis to recent history (by [@jackcasey][])
 
 # v4.5.0 / 2020-05-14 [(commits)](https://github.com/whitesmith/rubycritic/compare/v4.4.1...v4.5.0)
@@ -99,8 +120,8 @@
 
 # 4.0.0 / 2019-02-27 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.5.1...v4.0.0)
 
-* [FEATURE] Allow generating reports in multiple formats in one run (by [@katafrakt])
-* [FEATURE] Allow to accept a config file (by [@mfbmina])
+* [FEATURE] Allow generating reports in multiple formats in one run (by [@katafrakt][])
+* [FEATURE] Allow to accept a config file (by [@mfbmina][])
 * [CHANGE] Update `reek` to 5.3 (by [@taitran19][] and [@onumis][])
 * [CHANGE] Update `parser` to 2.6.0 (by [@onumis][])
 * [CHANGE] Update `tty-which` to 0.4.0 (by [@onumis][])
@@ -377,3 +398,24 @@
 [@sl4vr]: https://github.com/sl4vr
 [@denny]: https://github.com/denny
 [@RyanSnodgrass]: https://github.com/RyanSnodgrass
+[@ydah]: https://github.com/ydah
+[@stufro]: https://github.com/stufro
+[@rishijain]: https://github.com/rishijain
+[@cleicar]: https://github.com/cleicar
+[@anicholson]: https://github.com/anicholson
+[@borisrorsvort]: https://github.com/borisrorsvort
+[@lauratpa]: https://github.com/lauratpa
+[@MZiserman]: https://github.com/MZiserman
+[@rizalmuthi]: https://github.com/rizalmuthi
+[@jsantos]: https://github.com/jsantos
+[@teohm]: https://github.com/teohm
+[@itsmeurbi]: https://github.com/itsmeurbi
+[@kcamcam]: https://github.com/kcamcam
+[@aisayo]: https://github.com/aisayo
+[@h-r-k-matsumoto]: https://github.com/h-r-k-matsumoto
+[@juanvqz]: https://github.com/juanvqz
+[@eitoball]: https://github.com/eitoball
+[@marcgrimme]: https://github.com/marcgrimme
+[@katafrakt]: https://github.com/katafrakt
+[@faisal]: https://github.com/faisal
+[@96RadhikaJadhav]: https://github.com/

data/CONTRIBUTING.md

@@ -32,7 +32,7 @@ Each commit should do one thing and one thing only. For example, all whitespace
 
 9. Push the branch to GitHub (`git push origin my-new-feature`).
 
-10. [Create a Pull Request] and send it to be merged with the master branch.
+10. [Create a Pull Request] and send it to be merged with the main branch.
 
 11. After your code is reviewed, [hide the sausage making]. We follow the "one commit per pull request" [principle](http://ndlib.github.io/practices/one-commit-per-pull-request/) since this allows for a clean git history, easy handling of features and convenient rollbacks when things go wrong. Or in one sentence: You can have as many commits as you want in your pull request, but after the final review and before the merge you need to squash all of those in one single commit.
 For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history] as well.
@@ -85,9 +85,9 @@ Here are a few examples:
 ```
 
 * Mark it up in [Markdown syntax](http://daringfireball.net/projects/markdown/syntax).
-* Add your entry in the `master (unreleased)` section.
+* Add your entry in the `main (unreleased)` section.
 * The entry line should start with `* ` (an asterisk and a space).
 * Start with the change type BUGFIX / CHANGE / FEATURE.
 * Describe the brief of the change.
 * At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
-* If this is your first contribution to RuboCop project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.
+* If this is your first contribution to RubyCritic project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.

data/README.md

@@ -1,6 +1,7 @@
 # RubyCritic
 
 [![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)
 
@@ -16,6 +17,7 @@ RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [F
   + [Analyzer Configuration](#analyzer-configuration)
   + [Alternative Usage Methods](#alternative-usage-methods)
   + [Rake Task](#rake-task)
+- [Formatters](#formatters)
 - [Compatibility](#compatibility)
 - [Improving RubyCritic](#improving-rubyCritic)
 - [Contributors](#contributors)
@@ -26,15 +28,12 @@ RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [F
 This gem provides features such as:
 
 1. An overview of your project:
-
   ![RubyCritic overview screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/overview.png)
 
 2. An index of the project files with their respective number of smells:
-
   ![RubyCritic code index screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/code.png)
 
 3. An index of the smells detected:
-
   ![RubyCritic smells index screenshot](https://github.com/whitesmith/rubycritic/raw/main/images/smells.png)
 
 4. When analysing code like the following:
@@ -61,10 +60,10 @@ This gem provides features such as:
   are currently supported) to compare your currently uncommitted
   changes with your last commit.
 
-  **Warning**: If your code is not as you expect it to be after running
-  RubyCritic, please check your source control system stash.
+    **Warning**: If your code is not as you expect it to be after running
+    RubyCritic, please check your source control system stash.
 
-Checkout the `/docs` if you want to read more about our [core metrics](https://github.com/whitesmith/rubycritic/blob/master/docs/core-metrics.md).
+Checkout the `/docs` if you want to read more about our [core metrics](https://github.com/whitesmith/rubycritic/blob/main/docs/core-metrics.md).
 
 ## Getting Started
 
@@ -128,7 +127,7 @@ $ rubycritic --help
 - `console`
 - `lint`
 2. See [custom formatters docs](/docs/formatters.md)
-3. Faster, analyses diffs w.r.t base_branch (default: master), see `-b`
+3. Faster, analyses diffs w.r.t base_branch (default: main), see `-b`
 4. Works only with `-b`, default: 0
 
 You also can use a config file. Just create a `.rubycritic.yml` on your project root path.
@@ -138,8 +137,8 @@ Here are one example:
 ```yml
 mode_ci:
   enabled: true # default is false
-  branch: 'production' # default is master
-branch: 'production' # default is master
+  branch: 'production' # default is main
+branch: 'production' # default is main
 path: '/tmp/mycustompath' # Set path where report will be saved (tmp/rubycritic by default)
 threshold_score: 10 # default is 0
 deduplicate_symlinks: true # default is false
@@ -159,7 +158,7 @@ paths: # Files to analyse.
   This means that if you have an existing `Reek` configuration file, you can just put this into your
   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/master/lib/rubycritic/analysers/helpers/flog.rb#L5):
+* [`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`.
@@ -235,11 +234,14 @@ See [formatters](docs/formatters.md)
 
 RubyCritic is supporting Ruby versions:
 
-* 2.4
-* 2.5
-* 2.6
-* 2.7
-* 3.0
+| 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 |
+| 3.0 | latest |
+| 3.1 | latest |
 
 ## Improving RubyCritic
 
@@ -249,7 +251,7 @@ Arguably, the [better_errors gem][7] only got popular after receiving a [(pretty
 
 Similarly, Pull Requests that improve the look and feel of the gem, that tweak the calculation of ratings or that fix existing issues will be most welcome. Just commenting on an issue and giving some insight into how something should work will be appreciated. No contribution is too small.
 
-See RubyCritic's [contributing guidelines](https://github.com/whitesmith/rubycritic/blob/master/CONTRIBUTING.md) about how to proceed.
+See RubyCritic's [contributing guidelines](https://github.com/whitesmith/rubycritic/blob/main/CONTRIBUTING.md) about how to proceed.
 
 ## Contributors
 
@@ -272,7 +274,7 @@ RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or
 [3]: https://github.com/seattlerb/flog
 [4]: https://github.com/whitesmith/guard-rubycritic
 [5]: http://jenkins-ci.org/
-[6]: https://github.com/whitesmith/rubycritic/blob/master/docs/building-own-code-climate.md
+[6]: https://github.com/whitesmith/rubycritic/blob/main/docs/building-own-code-climate.md
 [7]: https://github.com/charliesome/better_errors
 [8]: https://github.com/charliesome/better_errors/pull/22
 [9]: http://www.whitesmith.co/

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

@@ -57,7 +57,7 @@ module RubyCritic
               'Instantiate a given class as formatter and call report for reporting.',
               'Two ways are possible to load the formatter.',
               'If the class is not autorequired the REQUIREPATH can be given together',
-              'with the CLASSNAME to be loaded seperated by a :.',
+              'with the CLASSNAME to be loaded separated by a :.',
               'Example: rubycritic/markdown/reporter.rb:RubyCritic::MarkDown::Reporter',
               'or if the file is already required the CLASSNAME is enough',
               'Example: RubyCritic::MarkDown::Reporter',
@@ -77,8 +77,8 @@ module RubyCritic
             end
 
             opts.on('-m', '--mode-ci [BASE_BRANCH]',
-                    'Use CI mode (faster, analyses diffs w.r.t base_branch (default: master))') do |branch|
-              self.base_branch = branch || 'master'
+                    'Use CI mode (faster, analyses diffs w.r.t base_branch (default: main))') do |branch|
+              self.base_branch = branch || 'main'
               set_current_branch
               self.mode = :ci
             end
@@ -130,6 +130,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
+
         def paths
           @argv unless @argv.empty?
         end

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

@@ -38,7 +38,7 @@ module RubyCritic
         private
 
         def base_branch
-          return options.dig('mode_ci', 'branch') || 'master' if options.dig('mode_ci', 'enabled').to_s == 'true'
+          return options.dig('mode_ci', 'branch') || 'main' if options.dig('mode_ci', 'enabled').to_s == 'true'
 
           options['branch']
         end

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
+                  :feature_branch_collection, :churn_after, :ruby_extensions
 
     def set(options)
       self.mode = options[:mode] || :default
@@ -20,6 +20,7 @@ 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_version_control(options)
       setup_formats(options)
     end

data/lib/rubycritic/core/smell.rb

@@ -12,7 +12,7 @@ module RubyCritic
     attribute :locations, Array, default: []
     attribute :message
     attribute :score
-    attribute :status
+    attribute :status, Symbol, default: :new
     attribute :type
     attribute :analyser
 

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

@@ -32,7 +32,7 @@
                 <% if @show_status %>
                   <ul class="nav nav-pills">
                     <li role="presentation">
-                      <td class="centered-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>
+                      <span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span>
                     </li>
                   </ul>
                 <% end %>

data/lib/rubycritic/generators/text/lint.rb

@@ -18,7 +18,7 @@ module RubyCritic
           end
 
           def erb_template
-            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), nil, '-')
+            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), trim_mode: '-')
           end
         end
 

data/lib/rubycritic/generators/text/list.rb

@@ -10,7 +10,7 @@ module RubyCritic
           TEMPLATE_PATH = File.expand_path('templates/list.erb', __dir__)
 
           def erb_template
-            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), nil, '-')
+            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), trim_mode: '-')
           end
         end
 

data/lib/rubycritic/source_control_systems/git.rb

@@ -81,7 +81,9 @@ module RubyCritic
 
       def self.current_branch
         branch_list = `git branch`
-        branch_list.match(/\*.*$/)[0].gsub('* ', '')
+        branch = branch_list.match(/\*.*$/)[0].gsub('* ', '')
+        branch = branch.gsub(/\(HEAD detached at (.*)\)$/, '\1') if branch =~ /\(HEAD detached at (.*)\)$/
+        branch
       end
 
       private

data/lib/rubycritic/source_locator.rb

@@ -7,6 +7,7 @@ module RubyCritic
   class SourceLocator
     RUBY_EXTENSION = '.rb'.freeze
     RUBY_FILES = File.join('**', "*#{RUBY_EXTENSION}")
+    RUBY_SHEBANG = '#!/usr/bin/env ruby'.freeze
 
     def initialize(paths)
       @initial_paths = Array(paths)
@@ -39,7 +40,7 @@ module RubyCritic
       path_list = @initial_paths.flat_map do |path|
         if File.directory?(path)
           Pathname.glob(File.join(path, RUBY_FILES))
-        elsif File.exist?(path) && File.extname(path) == RUBY_EXTENSION
+        elsif File.exist?(path) && ruby_file?(path)
           Pathname.new(path)
         end
       end.compact
@@ -48,5 +49,9 @@ module RubyCritic
 
       path_list.map(&:cleanpath)
     end
+
+    def ruby_file?(path)
+      Config.ruby_extensions.include?(File.extname(path)) || File.open(path, &:gets).to_s.match?(RUBY_SHEBANG)
+    end
   end
 end

data/lib/rubycritic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2023-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -270,7 +270,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -280,7 +280,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.4.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.0.0
@@ -392,14 +392,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: 0.75.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.65.0
+        version: 0.75.0
 description: RubyCritic is a tool that wraps around various static analysis gems to
   provide a quality report of your Ruby code.
 email:
@@ -535,14 +535,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter