reek 6.0.2 → 6.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83760bf0344db6b8f65cd5bbb6e57f90ee4e1b54c10edb3920821a517e6649cd
-  data.tar.gz: 258214d9022fda0ecbe287c4313719472c30f056c1ff6ffd4f7ff023b255b199
+  metadata.gz: 967e95555fe823e1924a78ff2a8c94c40bdb4d16d031bacd51b885d1475bce30
+  data.tar.gz: c9760389b64b3bb9f96f1896192a540a4de8b7f395808299b9a67e47238e8c42
 SHA512:
-  metadata.gz: 56c12a16cc200dd475d84a543fd9edf2ce888f550a5d4d22cbe813c3439ed0915263340d7c02654417666bcd728ee5e9ba976670cae46098293b58595589f36c
-  data.tar.gz: 0f012f16ec237bdece4f797ea2977c0db5fa083df32ac86ce57b14911777eec0d832aff8e861df67c5cc80b847b0c3caf801a157b759724cc9f858ae4236ace9
+  metadata.gz: ea4c588166903c10bed44c2a459e43e4db479943f8f489ca1eaefbb6db375605e06ff678f5411def292e19ef8c2754245bca78eb24373532474091b0ab8eadbe
+  data.tar.gz: 9e0804841d54d4278149422d66c7e379597e3f99275ba8b9ab4aef6e7041bde6c928db5f3c62a3b5c3d1d6fc4da0216ba5d13aa5562f9e0b565ec31bb115d0fe

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+# 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"

data/.github/workflows/ruby.yml

@@ -0,0 +1,52 @@
+# 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: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7, jruby-9.2]
+
+    steps:
+    - uses: actions/checkout@v2
+    - 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@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - name: Run RuboCop
+      run: bundle exec rubocop -P

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,6 +1,11 @@
 # Change log
 
-## 6.0.2 (2020-10-17)
+## 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.3 (2020-10-17)
 
 * (mvz) Loosen dependency on psych. This should resolve installation problems on
   mingw32

data/Gemfile

@@ -13,10 +13,10 @@ group :development do
   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.7.0'
+  gem 'rubocop-performance',   '~> 1.9.1'
+  gem 'rubocop-rspec',         '~> 2.1.0'
+  gem 'simplecov',             ['>= 0.18.0', '< 0.21.0']
   gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do

data/docs/Boolean-Parameter.md

@@ -42,7 +42,7 @@ This is highly dependent on your exact architecture, but looking at the example
 
 * Move everything in the `if` branch into a separate method
 * Move everything in the `else` branch into a separate method
-* Get rid of the `hit_the_switch` method alltogether
+* Get rid of the `hit_the_switch` method altogether
 * Make the decision what method to call in the initial caller of `hit_the_switch`
 
 ## Current support in Reek

data/docs/templates/default/docstring/setup.rb

@@ -27,9 +27,7 @@ def show_api_marker_section?
   return false if object.type == :root
 
   case api_text
-  when 'public'
-    false
-  when 'private'
+  when 'public', 'private'
     false
   else
     true

data/features/command_line_interface/options.feature

@@ -43,7 +43,7 @@ Feature: Reek can be controlled using command-line options
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Only look for a specific smell.
                                            Call it like this: reek --smell MissingSafeMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v6.0.2/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v6.0.3/docs/Code-Smells.md for a list of smells
               --stdin-filename FILE        When passing code in via pipe, assume this filename when checking file or directory rules in the config.
 
       Generate a todo list:
@@ -119,5 +119,5 @@ Feature: Reek can be controlled using command-line options
       UnusedPrivateMethod
       UtilityFunction
 
-      Check out https://github.com/troessner/reek/blob/v6.0.2/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v6.0.3/docs/Code-Smells.md for a details on each detector
       """

data/features/reports/json.feature

@@ -24,7 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -33,7 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -53,7 +53,7 @@ Feature: Report smells using simple JSON layout
                   1
               ],
               "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.2/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v6.0.3/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -182,8 +182,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
@@ -209,8 +209,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:

data/features/reports/yaml.feature

@@ -25,7 +25,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeMethodName
         source: smelly.rb
         name: x
-        documentation_link: https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -33,7 +33,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeVariableName
         source: smelly.rb
         name: y
-        documentation_link: https://github.com/troessner/reek/blob/v6.0.2/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.3/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -48,5 +48,5 @@ Feature: Report smells using simple YAML layout
         lines:
         - 1
         message: has no descriptive comment
-        documentation_link: https://github.com/troessner/reek/blob/v6.0.2/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v6.0.3/docs/Irresponsible-Module.md
       """

data/lib/reek/ast/node.rb

@@ -60,7 +60,7 @@ module Reek
       #
       # Returns an array with all matching nodes.
       def each_node(target_types, ignoring = [], &blk)
-        return enum_for(:each_node, target_types, ignoring) unless block_given?
+        return enum_for(:each_node, target_types, ignoring) unless blk
 
         look_for(Array(target_types), ignoring, &blk)
       end

data/lib/reek/configuration/excluded_paths.rb

@@ -14,7 +14,8 @@ module Reek
       # @param paths [String]
       # @return [undefined]
       def add(paths)
-        paths.each { |path| self << Pathname(path) }
+        paths.flat_map { |path| Dir[path] }.
+          each { |path| self << Pathname(path) }
       end
     end
   end

data/lib/reek/context/code_context.rb

@@ -51,7 +51,7 @@ module Reek
       # @return [Enumerator]
       #
       def each(&block)
-        return enum_for(:each) unless block_given?
+        return enum_for(:each) unless block
 
         yield self
         children.each do |child|

data/lib/reek/context/refinement_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'module_context'
+
+module Reek
+  module Context
+    #
+    # A context wrapper for any refinement blocks found in a syntax tree.
+    #
+    class RefinementContext < ModuleContext
+      def full_name
+        exp.call.args.first.name
+      end
+    end
+  end
+end

data/lib/reek/context_builder.rb

@@ -5,6 +5,7 @@ require_relative 'context/class_context'
 require_relative 'context/ghost_context'
 require_relative 'context/method_context'
 require_relative 'context/module_context'
+require_relative 'context/refinement_context'
 require_relative 'context/root_context'
 require_relative 'context/send_context'
 require_relative 'context/singleton_attribute_context'
@@ -20,7 +21,7 @@ module Reek
   # counting. Ideally `ContextBuilder` would only build up the context tree and leave the
   # statement and reference counting to the contexts.
   #
-  # @quality :reek:TooManyMethods { max_methods: 31 }
+  # @quality :reek:TooManyMethods { max_methods: 32 }
   # @quality :reek:UnusedPrivateMethod { exclude: [ !ruby/regexp /process_/ ] }
   # @quality :reek:DataClump
   class ContextBuilder
@@ -263,9 +264,16 @@ module Reek
     #
     # Counts non-empty blocks as one statement.
     #
+    # A refinement block is handled differently and causes a RefinementContext
+    # to be opened.
+    #
     def process_block(exp, _parent)
       increase_statement_count_by(exp.block)
-      process(exp)
+      if exp.call.name == :refine
+        handle_refinement_block(exp)
+      else
+        process(exp)
+      end
     end
 
     # Handles `begin` and `kwbegin` nodes. `begin` nodes are created implicitly
@@ -508,6 +516,12 @@ module Reek
       end
     end
 
+    def handle_refinement_block(exp)
+      inside_new_context(Context::RefinementContext, exp) do
+        process(exp)
+      end
+    end
+
     def handle_send_for_modules(exp)
       arg_names = exp.args.map { |arg| arg.children.first }
       current_context.track_visibility(exp.name, arg_names)

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '6.0.2'
+    STRING = '6.0.3'
   end
 end

data/reek.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   }
 
   s.add_runtime_dependency 'kwalify', '~> 0.7.0'
-  s.add_runtime_dependency 'parser',  '< 2.8', '>= 2.5.0.0', '!= 2.5.1.1'
+  s.add_runtime_dependency 'parser',  '~> 3.0.0'
   s.add_runtime_dependency 'psych',   '~> 3.1'
   s.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
 end

data/spec/reek/configuration/excluded_paths_spec.rb

@@ -5,12 +5,21 @@ require_lib 'reek/configuration/excluded_paths'
 RSpec.describe Reek::Configuration::ExcludedPaths do
   describe '#add' do
     let(:exclusions) { [].extend(described_class) }
-    let(:paths) { ['smelly/sources'] }
-    let(:expected_exclude_paths) { [Pathname('smelly/sources')] }
+    let(:paths) do
+      %w(samples/directory_does_not_exist/
+         samples/source_with_non_ruby_files/
+         samples/**/ignore_me*)
+    end
+
+    let(:expected_exclude_paths) do
+      [Pathname('samples/source_with_non_ruby_files/'),
+       Pathname('samples/source_with_exclude_paths/ignore_me'),
+       Pathname('samples/source_with_exclude_paths/nested/ignore_me_as_well')]
+    end
 
     it 'adds the given paths as Pathname' do
       exclusions.add(paths)
-      expect(exclusions).to eq expected_exclude_paths
+      expect(exclusions).to match_array expected_exclude_paths
     end
   end
 end

data/spec/reek/smell_detectors/utility_function_spec.rb

@@ -161,6 +161,22 @@ RSpec.describe Reek::SmellDetectors::UtilityFunction do
     end
   end
 
+  context 'when examining refinements' do
+    it 'reports on the refined class' do
+      src = <<-RUBY
+        module Alfa
+          refine Bravo do
+            def bravo(charlie)
+              charlie.delta.echo
+            end
+          end
+        end
+      RUBY
+
+      expect(src).to reek_of(:UtilityFunction, context: 'Bravo#bravo')
+    end
+  end
+
   describe 'method visibility' do
     it 'reports private methods' do
       src = <<-RUBY

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.0.3
 platform: ruby
 authors:
 - Kevin Rutherford
 - Timo Roessner
 - Matijs van Zuijlen
 - Piotr Szotkowski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kwalify
@@ -31,28 +31,16 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0.0
-    - - "!="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1.1
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0.0
-    - - "!="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1.1
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -100,12 +88,13 @@ extra_rdoc_files:
 - License.txt
 files:
 - ".dockerignore"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".simplecov"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -251,6 +240,7 @@ files:
 - lib/reek/context/ghost_context.rb
 - lib/reek/context/method_context.rb
 - lib/reek/context/module_context.rb
+- lib/reek/context/refinement_context.rb
 - lib/reek/context/root_context.rb
 - lib/reek/context/send_context.rb
 - lib/reek/context/singleton_attribute_context.rb
@@ -471,7 +461,7 @@ metadata:
   bug_tracker_uri: https://github.com/troessner/reek/issues
   changelog_uri: https://github.com/troessner/reek/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/reek
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -490,8 +480,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.7
+signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []

data/.travis.yml

@@ -1,40 +0,0 @@
-language: ruby
-
-dist: xenial
-
-cache:
-  bundler: true
-
-bundler_args: --without debugging
-
-script: bundle exec rake ci
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby-9.2
-  - jruby-head
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: ruby-head
-  fast_finish: true
-
-notifications:
-  email:
-    - timo.roessner@googlemail.com
-    - matijs@matijs.net
-    - chastell@chastell.net
-  irc: irc.freenode.org#reek
-
-branches:
-  only:
-    - master
-
-env:
-  global:
-    - JRUBY_OPTS="--dev"