reek 6.0.2 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83760bf0344db6b8f65cd5bbb6e57f90ee4e1b54c10edb3920821a517e6649cd
-  data.tar.gz: 258214d9022fda0ecbe287c4313719472c30f056c1ff6ffd4f7ff023b255b199
+  metadata.gz: 6c025e0e50af37b8dc3c118f97752c18155f59d48c08332961527d24b2e8f50c
+  data.tar.gz: e681b629a371e90fcfeb0f8f62669e3d26ba7a4c8ba34322cda546424be9c71a
 SHA512:
-  metadata.gz: 56c12a16cc200dd475d84a543fd9edf2ce888f550a5d4d22cbe813c3439ed0915263340d7c02654417666bcd728ee5e9ba976670cae46098293b58595589f36c
-  data.tar.gz: 0f012f16ec237bdece4f797ea2977c0db5fa083df32ac86ce57b14911777eec0d832aff8e861df67c5cc80b847b0c3caf801a157b759724cc9f858ae4236ace9
+  metadata.gz: 304af91b9ff40fc9385991e130ae3cd28b928d4ac8bd896693edbd802c0b414a261c9ecf4bf3a5290590516ae97596a7fe39ed0cc0a388916f443201ff99c604
+  data.tar.gz: 4e7267ff76b9c9d99f996245245b9157bbae85927bf22f146883715254c7bc013821e9b7786500daf410344b1ef0a81fb61165979e5d2a74059bd06deeb656d4

data/.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

data/.github/workflows/ruby.yml

@@ -0,0 +1,57 @@
+# This workflow will download a prebuilt Ruby version, install dependencies and
+# run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+
+"on":
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  schedule:
+    - cron: '16 4 12 * *'
+
+env:
+  CUCUMBER_PUBLISH_QUIET: true
+  RUBYOPTS: "--disable-did-you-mean"
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ["3.0", "3.1", "3.2", "jruby-9.4", "3.3"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run specs
+        run: bundle exec rake test:spec
+      - name: Run performance tests
+        run: bundle exec rake test:performance
+      - name: Update default configuration
+        run: bundle exec rake configuration:update_default_configuration
+      - name: Run cucumber features
+        run: bundle exec rake test:features
+      - name: Run code quality specs
+        run: bundle exec rake test:quality
+
+  rubocop:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+      - name: Run RuboCop
+        run: bundle exec rubocop -P

data/.rubocop.yml

@@ -1,5 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+inherit_mode:
+  merge:
+    - Exclude
+
 require:
   - rubocop-rspec
   - rubocop-performance
@@ -7,10 +11,8 @@ require:
 AllCops:
   Exclude:
     - 'samples/**/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
 
 # Tables are nice
 Layout/HashAlignment:
@@ -46,7 +48,7 @@ Layout/MultilineOperationIndentation:
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
-# Some of our source examples include interpolation explicitely.
+# Some of our source examples include interpolation explicitly.
 Lint/InterpolationCheck:
   Exclude:
     - 'spec/**/*'
@@ -78,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/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-08-19 19:02:50 UTC using RuboCop version 0.89.1.
+# on 2021-01-03 18:17:11 UTC using RuboCop version 1.7.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,22 +13,24 @@ Lint/MissingSuper:
     - 'lib/reek/smell_detectors/base_detector.rb'
 
 # Offense count: 2
+# Configuration parameters: IgnoredPatterns.
+# IgnoredPatterns: (?-mix:(exactly|at_least|at_most)\(\d+\)\.times)
 Lint/UnreachableLoop:
   Exclude:
     - 'spec/reek/ast/node_spec.rb'
 
 # Offense count: 2
-# Configuration parameters: IgnoredMethods.
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 21
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 161
+  Max: 170
 
 # Offense count: 13
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 16
 

data/CHANGELOG.md

@@ -1,5 +1,100 @@
 # Change log
 
+## 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
+
+## 6.1.3 (2022-12-29)
+
+* (gonubana) Allow failing safely when trying to recursively find a configuration
+
+## 6.1.2 (2022-11-21)
+
+* (mvz) Add support for keyword nil arguments
+
+## 6.1.1 (2022-04-20)
+
+* (ydah) UnusedPrivateMethod to be detect use of methods via `Method#to_proc`
+
+## 6.1.0 (2022-01-14)
+
+* (mvz) Drop support for Ruby 2.4 and 2.5
+* (mvz) Support Ruby 3.0 and 3.1
+* (mvz) Support argument forwarding after regular arguments
+
+## 6.0.6 (2021-08-12)
+
+* (mvz) Remove explicit dependency on psych. This fixes an issue where
+  installing Reek would unintentionally pull in psych 4.0
+
+## 6.0.5 (2021-08-01)
+
+* (dependabot) Loosen dependency on psych
+* (Nicolás Ferrari) Fix bugs when used by codeclimate 
+
+## 6.0.4 (2021-04-27)
+
+* (Nicolás Ferrari) Add build-base to Dockerfile
+* (Masataka Pocke Kuwabara and Daniel Santos Dantas) Reduce gem package size
+
+## 6.0.3 (2021-01-11)
+
+* (mvz) Require parser 3.0
+* (mvz) In a refinement, assign smells to the refined module or class
+
 ## 6.0.2 (2020-10-17)
 
 * (mvz) Loosen dependency on psych. This should resolve installation problems on

data/CONTRIBUTING.md

@@ -27,6 +27,9 @@ version, Ruby platform (MRI, JRuby, etc.), operating system.
 Try to provide a minimal example that reproduces the issue.
 Extra kudos if you can write it as a failing test. :)
 
+Make sure any code examples and output are properly formatted
+using [code blocks](https://github.github.com/gfm/#fenced-code-blocks).
+
 ## Contributing features, bugfixes, documentation
 
 ### Getting started
@@ -59,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
@@ -71,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
@@ -81,7 +81,7 @@ end
 
 rather like this:
 
-```Ruby
+```ruby
 class Alfa
   def bravo(charlie)
     charlie.delta
@@ -139,7 +139,7 @@ Once you’re happy with your feature / fix – or want to
 share it as a work-in-progress and request comments – once
 again make sure all of the tests pass. This will also run
 [RuboCop](https://github.com/bbatsov/rubocop) – fix any
-offences RuboCop finds (or discuss them in the pull request):
+offenses RuboCop finds (or discuss them in the pull request):
 
 ```
 bundle exec rake
@@ -199,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/Dockerfile

@@ -11,7 +11,7 @@ ENV code_dir /code
 ENV app_dir /usr/src/app
 ENV user app
 
-RUN apk --update add git
+RUN apk --update add git build-base
 ADD . ${app_dir}
 
 RUN adduser -u 9000 -D ${user}

data/Gemfile

@@ -5,18 +5,19 @@ gemspec
 ruby RUBY_VERSION
 
 group :development do
-  gem 'aruba',                 '~> 1.0'
+  gem 'aruba',                 '~> 2.1'
+  gem 'bigdecimal',            '>= 2.0.0', '< 4.0'
   gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              ['>= 4.0', '< 6.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',               '~> 0.93.0'
-  gem 'rubocop-performance',   '~> 1.8.0'
-  gem 'rubocop-rspec',         '~> 1.43.1'
-  gem 'simplecov',             ['>= 0.18.0', '< 0.20.0']
+  gem 'rubocop',               '~> 1.59.0'
+  gem 'rubocop-performance',   '~> 1.20.0'
+  gem 'rubocop-rspec',         '~> 2.25.0'
+  gem 'simplecov',             '>= 0.18.0', '< 0.23.0'
   gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do
@@ -25,5 +26,5 @@ group :development do
 end
 
 group :debugging do
-  gem 'pry', '~> 0.13.0'
+  gem 'pry', '~> 0.14.0'
 end

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
@@ -94,7 +94,7 @@ demo.rb -- 2 warnings:
 
 ## Supported Ruby versions
 
-Reek is officially supported for CRuby 2.4 to 2.7 and for JRuby 9.2.
+Reek is officially supported for CRuby 2.6 through 3.1 and for JRuby 9.3.
 Other Ruby implementations (like Rubinius) are not officially supported but
 should work as well.
 
@@ -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,14 +404,14 @@ 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}}
 end
 ```
 
-This is an incredibly powerful feature and further explained under [Smell Suppresion](docs/Smell-Suppression.md).
+This is an incredibly powerful feature and further explained under [Smell Suppression](docs/Smell-Suppression.md).
 
 #### Debugging trouble with the configuration
 
@@ -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: