reek 6.0.2 → 6.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83760bf0344db6b8f65cd5bbb6e57f90ee4e1b54c10edb3920821a517e6649cd
-  data.tar.gz: 258214d9022fda0ecbe287c4313719472c30f056c1ff6ffd4f7ff023b255b199
+  metadata.gz: 3cd53c902c108773156429c3aacbb8aaa12f7e0c8f22966f833e4ade893ad5ce
+  data.tar.gz: 765ece4c34e29251afb173e37616b3be740e8f8035394958d7df5d3d6b4f1473
 SHA512:
-  metadata.gz: 56c12a16cc200dd475d84a543fd9edf2ce888f550a5d4d22cbe813c3439ed0915263340d7c02654417666bcd728ee5e9ba976670cae46098293b58595589f36c
-  data.tar.gz: 0f012f16ec237bdece4f797ea2977c0db5fa083df32ac86ce57b14911777eec0d832aff8e861df67c5cc80b847b0c3caf801a157b759724cc9f858ae4236ace9
+  metadata.gz: db05cf1c8d8186cd2c1a36e68afe5a628458332e275ef87b0681903f05dbaad1f0d6228aaaa6257cf706d3d07e3efbfaab0f2c9f1c37ebc9284312be942ff182
+  data.tar.gz: 4826674e1ac0dffa73f6856403b7254f52f3a066ba75cb4968e5a836d58995229fa3a31d66beece59afa80648506ef310fa15476a97e5283a84303ba710ffa53

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,58 @@
+# 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 * *'
+  workflow_dispatch:
+
+env:
+  CUCUMBER_PUBLISH_QUIET: true
+  RUBYOPTS: "--disable-did-you-mean"
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: ["3.1", "3.2", "jruby-9.4", "3.3", "3.4"]
+
+    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/.gitignore

@@ -11,7 +11,6 @@ coverage
 Gemfile.lock
 *.swp
 tags
-.pryrc
 .tags*
 .DS_Store
 .idea/

data/.rubocop.yml

@@ -1,16 +1,18 @@
 inherit_from: .rubocop_todo.yml
 
-require:
+inherit_mode:
+  merge:
+    - Exclude
+
+plugins:
   - rubocop-rspec
   - rubocop-performance
 
 AllCops:
   Exclude:
     - 'samples/**/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
   NewCops: enable
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.1
 
 # 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,25 +80,10 @@ 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
 
-# Require comment for files in lib and bin
-Style/FrozenStringLiteralComment:
-  Include:
-    - 'bin/*'
-    - 'lib/**/*'
-  EnforcedStyle: always
-
 # Allow multiline block chains
 Style/MultilineBlockChain:
   Enabled: false

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/.simplecov

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 SimpleCov.start do
   track_files 'lib/**/*.rb'
   add_filter 'lib/reek/version.rb' # version.rb is loaded too early to test

data/CHANGELOG.md

@@ -1,5 +1,119 @@
+
 # Change log
 
+## 6.5.0 (2025-03-24)
+
+### Features and bugfixes
+
+* Loosen up Gemfile dependencies by [mvz])
+
+## 6.4.0 (2025-01-12)
+
+### Features and bugfixes
+
+* Fix DataClump smell in Reek::AST::Node class ([#1799] by [le-santos])
+
+## 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
+
+## 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

@@ -1,29 +1,22 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-ruby RUBY_VERSION
-
-group :development do
-  gem 'aruba',                 '~> 1.0'
-  gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              ['>= 4.0', '< 6.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 'yard',                  '~> 0.9.5'
-
-  platforms :mri do
-    gem 'redcarpet', '~> 3.4'
-  end
-end
+gem 'aruba',                 '~> 2.1'
+gem 'codeclimate-engine-rb', '~> 0.4.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.72.2'
+gem 'rubocop-performance',   '~> 1.24.0'
+gem 'rubocop-rspec',         '~> 3.5.0'
+gem 'simplecov',             '~> 0.22.0'
+gem 'yard',                  '~> 0.9.5'
 
-group :debugging do
-  gem 'pry', '~> 0.13.0'
-end
+# Needed for YARD to properly parse GFM code blocks in the documentation
+gem 'redcarpet', '~> 3.4', platform: :mri