reek 6.1.4 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75ed5064f626b7d8ae34f869ee17d53960804381fb73db707c866202bb71490a
-  data.tar.gz: 07f819f93d3ac3f84deb0a0a113dfbc3136e70f9b097f72e1c535f4352fb8b7f
+  metadata.gz: a1093258cb1b25a91e16e800eabcee4087d4ae8830d579decc6b11433b6fd9c4
+  data.tar.gz: ea2c3a5e1f51edd9bdfcb1fe973b4d08210491f34bcfb26278bc970cd61325bf
 SHA512:
-  metadata.gz: 71313200963b12c5c2edb8cd84d5ee4ea8fd99241c1fa0f6c6329e332ba41538b5a11990b54f24a136a748bc2492fd87f5ffcd78ef358bdd4f1420970bd2915b
-  data.tar.gz: 2f39a6f2ea9cf9a4d8eb629bc5542883ecccfb8811c1fc062a2c0aa8deb41ceacd47de2a76a2f9cb8f6b0e6b56da63551f403edc14e55cd35ae7bac62822a2b3
+  metadata.gz: 56e29753527fc67429285f7da3537411ac951567d41a59024895fefa4287523e67c8c78332bc46375b4b6b154bf68bb6b5d6665f10cadec4f86654e0f5ea0a00
+  data.tar.gz: e2b1f0f40d67f5ba966f527d9afdd1a18e6c6150ade2658a5316750f1d03ca5aef7580a82f59d59e617c581323dff8ef0b7d71ea070442a45cc924649edf32e7

data/.github/workflows/ruby.yml

@@ -22,10 +22,10 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ["2.6", "2.7", "3.0", "3.1", "3.2", "jruby-9.3", "jruby-9.4"]
+        ruby: ["3.0", "3.1", "3.2", "jruby-9.4", "3.3"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -47,11 +47,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.7
+          ruby-version: "3.3"
           bundler-cache: true
       - name: Run RuboCop
         run: bundle exec rubocop -P

data/.rubocop.yml

@@ -12,7 +12,7 @@ AllCops:
   Exclude:
     - 'samples/**/*'
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0
 
 # Tables are nice
 Layout/HashAlignment:
@@ -80,14 +80,6 @@ RSpec/DescribeClass:
 RSpec/ExampleLength:
   Enabled: false
 
-# rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
-RSpec/FilePath:
-  Exclude:
-    - 'spec/reek/report/code_climate/code_climate_configuration_spec.rb'
-    - 'spec/reek/report/code_climate/code_climate_fingerprint_spec.rb'
-    - 'spec/reek/report/code_climate/code_climate_formatter_spec.rb'
-    - 'spec/reek/report/code_climate/code_climate_report_spec.rb'
-
 # Allow and/or for control flow only
 Style/AndOr:
   EnforcedStyle: conditionals

data/CHANGELOG.md

@@ -1,5 +1,65 @@
+
 # Change log
 
+## 6.3.0 (2024-01-28)
+
+### Features and bugfixes
+
+* Update parser dependency to the 3.3.x series([#1761] by [mvz])
+
+## 6.2.0 (2023-12-31)
+
+### Features and bugfixes
+
+* Code Climate: add config `target_ruby_version` to support different versions
+  of Ruby syntax ([#1694] by [dantevvp])
+* Treat `Data.define` as a class definition ([#1725] by [mvz])
+* Fix Instance Variable Assumption false positive ([#1737] by [JuanVqz])
+* Add `Tempfile.create` to ignored iterators list ([#1747] by [mateusdeap])
+* Improve configuration schema validation. This also replaces the kwalify
+  dependency with dry-schema ([#1749] by [fbuys])
+
+### Dependencies
+
+* Add missing dependency rexml ([#1703] by [tricknotes])
+* Drop support for Ruby 2.6 and 2.7 ([#1716] and [#1755] by [mvz])
+* Add support for Ruby 3.3 ([#1756] and [#1755] by [mvz])
+
+### Documentation
+
+* Fix the badges in our README ([#1711] by [troessner])
+* Remove non working link in CONTRIBUTING.md ([#1738] by [JuanVqz])
+* Add downloads badge ([#1750] by [troessner])
+
+### Internal
+
+* Rename Code Climate related classes ([#1735] by [mvz])
+* Fix `cucumber_opts` warning ([#1736] by [JuanVqz])
+* Fix editor highlighting for fenced code blocks in documentation ([#1745] by [JuanVqz])
+
+[JuanVqz]: https://github.com/JuanVqz
+[dantevvp]: https://github.com/dantevvp
+[fbuys]: https://github.com/fbuys
+[mateusdeap]: https://github.com/mateusdeap
+[mvz]: https://github.com/mvz
+[tricknotes]: https://github.com/tricknotes
+[troessner]: https://github.com/troessner
+
+[#1694]: https://github.com/troessner/reek/pull/1694
+[#1703]: https://github.com/troessner/reek/pull/1703
+[#1711]: https://github.com/troessner/reek/pull/1711
+[#1725]: https://github.com/troessner/reek/pull/1725
+[#1735]: https://github.com/troessner/reek/pull/1735
+[#1736]: https://github.com/troessner/reek/pull/1736
+[#1737]: https://github.com/troessner/reek/pull/1737
+[#1738]: https://github.com/troessner/reek/pull/1738
+[#1745]: https://github.com/troessner/reek/pull/1745
+[#1749]: https://github.com/troessner/reek/pull/1749
+[#1747]: https://github.com/troessner/reek/pull/1747
+[#1750]: https://github.com/troessner/reek/pull/1750
+[#1756]: https://github.com/troessner/reek/pull/1756
+[#1755]: https://github.com/troessner/reek/pull/1755
+
 ## 6.1.4 (2023-01-13)
 
 * (mvz) Update parser dependency to the 3.2.x series

data/CONTRIBUTING.md

@@ -62,11 +62,8 @@ demonstrate that your fix was needed.
 
 Reek uses [Rspec](http://rspec.info/) for unit and functional testing.
 
-We're trying to follow [betterspecs](http://betterspecs.org/). We're not using
-RSpec's
-[shared examples](https://www.relishapp.com/rspec/rspec-core/docs/example-groups/shared-examples)
-because we find them rather harming than helpful. You can find an excellent
-cheat sheet on how to write idiomatic Rspec
+We're trying to follow [betterspecs](http://betterspecs.org/).
+You can find an excellent cheat sheet on how to write idiomatic Rspec
 [here](http://www.rubypigeon.com/posts/rspec-core-cheat-sheet).
 
 We do not use the popular "foo" / "bar" naming when it comes to the question
@@ -74,7 +71,7 @@ We do not use the popular "foo" / "bar" naming when it comes to the question
 [military alphabet](https://en.wikipedia.org/wiki/NATO_phonetic_alphabet) in
 ascending order which means that we would write this
 
-```Ruby
+```ruby
 class Foo
   def bar(baz)
     baz.quux
@@ -84,7 +81,7 @@ end
 
 rather like this:
 
-```Ruby
+```ruby
 class Alfa
   def bravo(charlie)
     charlie.delta
@@ -202,11 +199,11 @@ In this example we assume the current version is 5.3.1 and you want to update to
 * Update the version in `lib/reek/version.rb`
 * List all relevant changes in `CHANGELOG.md`
 * Update the version number in our cucumber features, otherwise the build will fail. You can do this quite easily via
-  ```Bash
+  ```bash
   find features/ -type f -exec sed -i '' 's/v5.3.1/v5.3.2/g' {} +
   ```
 * Push the branch, create a pull request, have it reviewed and merged
 * Pull the latest master and then do a
-  ```Bash
+  ```bash
   bundle exec rake release
   ```

data/Gemfile

@@ -6,16 +6,17 @@ ruby RUBY_VERSION
 
 group :development do
   gem 'aruba',                 '~> 2.1'
+  gem 'bigdecimal',            '>= 2.0.0', '< 4.0'
   gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              '~> 8.0'
+  gem 'cucumber',              '~> 9.0'
   gem 'kramdown',              '~> 2.1'
   gem 'kramdown-parser-gfm',   '~> 1.0'
   gem 'rake',                  '~> 13.0'
   gem 'rspec',                 '~> 3.0'
   gem 'rspec-benchmark',       '~> 0.6.0'
-  gem 'rubocop',               '~> 1.43.0'
-  gem 'rubocop-performance',   '~> 1.15.0'
-  gem 'rubocop-rspec',         '~> 2.17.0'
+  gem 'rubocop',               '~> 1.60.2'
+  gem 'rubocop-performance',   '~> 1.20.0'
+  gem 'rubocop-rspec',         '~> 2.26.0'
   gem 'simplecov',             '>= 0.18.0', '< 0.23.0'
   gem 'yard',                  '~> 0.9.5'
 

data/README.md

@@ -35,15 +35,15 @@
 
 ## Overview
 
-* [![Build Status](https://secure.travis-ci.org/troessner/reek.svg?branch=master)](https://travis-ci.org/troessner/reek?branch=master)
+* ![Downloads](https://img.shields.io/badge/Downloads-%3E24_million-blue)
+* ![Build Status](https://github.com/troessner/reek/actions/workflows/ruby.yml/badge.svg?branch=master)
 * [![Gem Version](https://badge.fury.io/rb/reek.svg)](https://badge.fury.io/rb/reek)
-* ![](http://img.shields.io/github/tag/troessner/reek.svg)
-* ![](http://img.shields.io/badge/license-MIT-brightgreen.svg)
+* ![Git Tag](http://img.shields.io/github/tag/troessner/reek.svg)
+* ![Licence](http://img.shields.io/badge/license-MIT-brightgreen.svg)
 * [![Inline docs](https://inch-ci.org/github/troessner/reek.png)](https://inch-ci.org/github/troessner/reek)
 * [![Code Climate](https://codeclimate.com/github/troessner/reek/badges/gpa.svg)](https://codeclimate.com/github/troessner/reek)
 * [![codebeat](https://codebeat.co/badges/42fed4ff-3e55-4aed-8ecc-409b4aa539b3)](https://codebeat.co/projects/github-com-troessner-reek)
-* ![](http://ruby-gem-downloads-badge.herokuapp.com/reek?type=total)
-* ![](http://ruby-gem-downloads-badge.herokuapp.com/reek?label=downloads-current-version)
+
 
 ## Quickstart
 
@@ -56,13 +56,13 @@ or [that one](https://troessner.svbtle.com/the-latest-and-greatest-additions-to-
 
 Install it via rubygems:
 
-```Bash
+```bash
 gem install reek
 ```
 
 and run it like this:
 
-```Bash
+```bash
 reek [options] [dir_or_source_file]*
 ```
 
@@ -70,7 +70,7 @@ reek [options] [dir_or_source_file]*
 
 Imagine a source file `demo.rb` containing:
 
-```Ruby
+```ruby
 # Smelly class
 class Smelly
   # This will reek of UncommunicativeMethodName
@@ -111,7 +111,7 @@ language and business logic.
 That said, an example might help you get going. Have a look at this sample of a
 Ruby on Rails model (be aware that this is truncated, not working code):
 
-```Ruby
+```ruby
 class ShoppingCart < ActiveRecord::Base
   has_many :items
 
@@ -140,7 +140,7 @@ would report:
 Fixing this is pretty straightforward. Put the gross price calculation for a single item
 where it belongs, which would be the `Item` class:
 
-```Ruby
+```ruby
 class ShoppingCart < ActiveRecord::Base
   has_many :items
 
@@ -165,7 +165,7 @@ those first when you have a warning that you don't know how to deal with.
 
 There are multiple ways you can have Reek work on sources, the most common one just being
 
-```Bash
+```bash
 reek lib/
 ```
 
@@ -173,25 +173,25 @@ If you don't pass any source arguments to Reek it just takes the current working
 
 So
 
-```Bash
+```bash
 reek
 ```
 
 is the exact same thing as being explicit:
 
-```Bash
+```bash
 reek .
 ```
 
 Additionally you can pipe code to Reek like this:
 
-```Bash
+```bash
 echo "class C; def m; end; end" | reek
 ```
 
 This would print out:
 
-```Bash
+```bash
 $stdin -- 3 warnings:
   [1]:C has no descriptive comment (IrresponsibleModule)
   [1]:C has the name 'C' (UncommunicativeModuleName)
@@ -219,7 +219,7 @@ for up to date details of exactly what Reek will check in your code.
 because it is [kind of controversial](https://github.com/troessner/reek/issues/844) which means
 you have to explicitly activate it in your configuration via
 
-```Yaml
+```yaml
 UnusedPrivateMethod:
   enabled: true
 ```
@@ -228,7 +228,7 @@ UnusedPrivateMethod:
 as well that can turn out to be really unforgiving.
 As a consequence, we made it possible to disable it for non-public methods like this:
 
-```Yaml
+```yaml
 ---
 UtilityFunction:
   public_methods_only: true
@@ -240,7 +240,7 @@ UtilityFunction:
 
 For a basic overview, run
 
-```Ruby
+```ruby
 reek --help
 ```
 
@@ -328,7 +328,7 @@ directories:
 exclude_paths:
   - lib/legacy
   - lib/rake/legacy_tasks
-  - lib/smelly.rb  
+  - lib/smelly.rb
 ```
 
 As you see above, Reek's configuration consists of 3 different sections denoted by 3 different keys:
@@ -395,7 +395,7 @@ In case you need to suppress a smell warning and you can't or don't want to
 use configuration files for whatever reasons you can also use special
 source code comments like this:
 
-```Ruby
+```ruby
 # This method smells of :reek:NestedIterators
 def smelly_method foo
   foo.each {|bar| bar.each {|baz| baz.qux}}
@@ -404,7 +404,7 @@ end
 
 You can even pass in smell specific configuration settings:
 
-```Ruby
+```ruby
 # :reek:NestedIterators { max_allowed_nesting: 2 }
 def smelly_method foo
   foo.each {|bar| bar.each {|baz| baz.qux}}
@@ -432,7 +432,7 @@ codebase this might not be an option.
 Fortunately Reek provides a 'todo' flag which you can use to generate a configuration that will
 suppress all smell warnings for the current codebase:
 
-```Bash
+```bash
 reek --todo lib/
 ```
 
@@ -447,7 +447,7 @@ If for whatever reasons you decide to put '.reek.yml' somewhere else where
 Reek won't pick it up automatically you need to tell Reek explicitly to do so
 via:
 
-```Bash
+```bash
 reek -c whatever/.reek.yml lib/
 ```
 
@@ -461,7 +461,7 @@ and instead abort execution. It also will not take **any** other configuration f
 
 This means that when you run
 
-```Bash
+```bash
 reek -c other_configuration.reek --todo lib/
 ```
 
@@ -474,7 +474,7 @@ but keep in mind that this is not the intended use case of this feature.
 
 Besides the obvious
 
-```Bash
+```bash
 reek [options] [dir_or_source_file]*
 ```
 
@@ -523,7 +523,7 @@ bundle exec rake console
 You can also use Pry while running the tests by adding the following at the
 point where you want to start debugging:
 
-```Ruby
+```ruby
 require 'pry'
 binding.pry
 ```
@@ -569,7 +569,7 @@ Reek supports 5 output formats:
 Making Reek "Rails"-friendly is fairly simple since we support directory specific configurations (`directory directives` in Reek talk).
 Just add this to your configuration file:
 
-```Yaml
+```yaml
 directories:
   "app/controllers":
     IrresponsibleModule:

data/bin/code_climate_reek

@@ -6,7 +6,8 @@
 
 require_relative '../lib/reek'
 require_relative '../lib/reek/cli/application'
-require_relative '../lib/reek/report/code_climate'
+require_relative '../lib/reek/code_climate'
+Reek::CLI::Silencer.silently { require 'parser/current' }
 
 # Map input coming from CodeClimate to Reek.
 class CodeClimateToReek
@@ -16,6 +17,8 @@ class CodeClimateToReek
     '--failure-exit-code', '0',
     '--success-exit-code', '0'
   ].freeze
+  CUSTOM_CONFIG_KEY = 'config'
+  CUSTOM_CONFIG_TARGET_RUBY_VERSION_KEY = 'target_ruby_version'
 
   attr_reader :configuration_file_path, :include_paths_key, :include_paths_default
 
@@ -31,6 +34,10 @@ class CodeClimateToReek
     include_paths + ENGINE_CONFIGURATION
   end
 
+  def target_ruby_version
+    config.dig(CUSTOM_CONFIG_KEY, CUSTOM_CONFIG_TARGET_RUBY_VERSION_KEY)
+  end
+
   private
 
   def configuration_file_exists?
@@ -45,11 +52,14 @@ class CodeClimateToReek
   #   ]
   # }
   def include_paths
+    config.fetch include_paths_key, include_paths_default
+  end
+
+  def config
     if configuration_file_exists?
-      config = JSON.parse File.read(configuration_file_path)
-      config.fetch include_paths_key, include_paths_default
+      JSON.parse File.read(configuration_file_path)
     else
-      include_paths_default
+      {}
     end
   end
 end
@@ -57,11 +67,50 @@ end
 # Override for ReportCommand to force the use of CodeClimateReport.
 module ReportClassOverride
   def report_class
-    Reek::Report::CodeClimateReport
+    Reek::CodeClimate::CodeClimateReport
+  end
+end
+
+# Override Reek::Source::SourceCode to use a parser version specified by the user
+module SourceCodeOverride
+  # override self.default_parser method
+  def default_parser
+    parser_class.new(Reek::AST::Builder.new).tap do |parser|
+      diagnostics = parser.diagnostics
+      diagnostics.all_errors_are_fatal = true
+      diagnostics.ignore_warnings      = true
+    end
+  end
+
+  # config.json file will look like this:
+  # {
+  #   "include_paths":[
+  #     "lib",
+  #     "spec"
+  #   ],
+  #   "config": {
+  #     "target_ruby_version": "3.1.0"
+  #   }
+  # }
+  def parser_class
+    # convert an X.Y.Z version number to an XY two digit number
+    requested_version = CodeClimateToReek.new.target_ruby_version
+    return Parser::CurrentRuby if requested_version.nil?
+
+    version_number = Gem::Version.new(requested_version).segments[0..1].join
+
+    begin
+      Reek::CLI::Silencer.silently { require "parser/ruby#{version_number}" }
+      Module.const_get("Parser::Ruby#{version_number}")
+    rescue LoadError, NameError
+      # use Parser::CurrentRuby when an invalid version number is provided
+      Parser::CurrentRuby
+    end
   end
 end
 
 Reek::CLI::Command::ReportCommand.prepend ReportClassOverride
+Reek::Source::SourceCode.singleton_class.prepend SourceCodeOverride
 
 application = Reek::CLI::Application.new(CodeClimateToReek.new.cli_arguments)
 

data/lib/reek/ast/sexp_extensions/send.rb

@@ -24,13 +24,10 @@ module Reek
         end
 
         def module_creation_call?
-          object_creation_call? && module_creation_receiver?
-        end
+          return true if object_creation_call? && module_creation_receiver?
+          return true if data_definition_call? && data_definition_receiver?
 
-        def module_creation_receiver?
-          receiver &&
-            receiver.type == :const &&
-            [:Class, :Struct].include?(receiver.simple_name)
+          false
         end
 
         def object_creation_call?
@@ -47,6 +44,24 @@ module Reek
         def attr_with_writable_flag?
           name == :attr && args.any? && args.last.type == :true
         end
+
+        private
+
+        def module_creation_receiver?
+          const_receiver? && [:Class, :Struct].include?(receiver.simple_name)
+        end
+
+        def data_definition_call?
+          name == :define
+        end
+
+        def data_definition_receiver?
+          const_receiver? && receiver.simple_name == :Data
+        end
+
+        def const_receiver?
+          receiver && receiver.type == :const
+        end
       end
 
       Op_AsgnNode = SendNode

data/lib/reek/cli/command/todo_list_command.rb

@@ -13,7 +13,7 @@ module Reek
       #
       class TodoListCommand < BaseCommand
         HEADER = "# Auto generated by Reeks --todo flag\n"
-        EXISTING_FILE_MESSAGE = "\nExisting '#{DEFAULT_CONFIGURATION_FILE_NAME}' detected - aborting.\n"
+        EXISTING_FILE_MESSAGE = "\nExisting '#{DEFAULT_CONFIGURATION_FILE_NAME}' detected - aborting.\n".freeze
         NO_SMELLS_FOUND_MESSAGE = "\nNo smells found - nothing to do, exiting.\n"
 
         def execute

data/lib/reek/{report/code_climate → code_climate}/code_climate_configuration.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Reek
-  module Report
+  module CodeClimate
     # loads the smell type metadata to present in Code Climate
     module CodeClimateConfiguration
       def self.load