reek 6.0.1 → 6.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 107593e309020bb2745d630599f8bf33bde2c9f708877895465cd12360267f82
-  data.tar.gz: 61290a2608c069e4c5977720e5a1d99fe8d4e716dfaa8503c0491b226790a8a7
+  metadata.gz: 23929fdfa24a401c782d5390e43941b9a3829ed51083e2f1b7d6bcfe1280cd4e
+  data.tar.gz: 24ce8ccc73f1db8f7f2571d80d14ae95ba52060efd37f2d76af39a8bdaf0f177
 SHA512:
-  metadata.gz: '09025ee922070bcb0c415f82fd5591e6658610a661ae4fc24abb472f16df6c3ed222fcfd84f81500a1951cadfabfb33b5c9414e26164f67cc140699774a9d2e7'
-  data.tar.gz: 7b9af8e1a09c5722fbedd946389411dee5aa7a5b98f03f48330a9d7f76d4c126bf170fff94955af6abe7a3a6c2e4b1b046c1fd1b8e304ee678a0fbecb52919f1
+  metadata.gz: 147a1013216674c7ead0cea2299ccaa37ccd89d2f409f11f65cf64706f747b96bbe06364059391a8f252c05fba3c2a9f7b4f314f424e92af5673ecc8eae20b74
+  data.tar.gz: 2255554dbf2f7c1b3bb11daa8da1b7956c2ce1bb4a9c02da420f0db24fd285c8857dbbdf4b04616029ff1b0ed30bdd857012435d8557e6e1a7237d9c38887710

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.yml

@@ -9,6 +9,7 @@ AllCops:
     - 'samples/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
+  NewCops: enable
   TargetRubyVersion: 2.4
 
 # Tables are nice
@@ -57,6 +58,7 @@ Lint/BooleanSymbol:
 # Spec blocks can be any size
 Metrics/BlockLength:
   Exclude:
+    - '**/*.gemspec'
     - 'spec/**/*'
 
 # Keyword arguments make long parameter lists readable
@@ -130,23 +132,3 @@ Style/WordArray:
 Metrics/ClassLength:
   Exclude:
     - 'lib/reek/cli/options.rb'
-
-# Activate new cops from RuboCop 0.80 - 0.83
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true

data/.rubocop_todo.yml

@@ -1,22 +1,36 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-12-22 13:19:30 +0100 using RuboCop version 0.78.0.
+# 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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
+# Offense count: 2
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/reek/rake/task.rb'
+    - '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, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 21
 
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 161
+  Max: 170
 
-# Offense count: 14
-# Configuration parameters: CountComments, ExcludedMethods.
+# Offense count: 13
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 16
 
@@ -25,17 +39,6 @@ RSpec/AnyInstance:
   Exclude:
     - 'spec/reek/cli/application_spec.rb'
 
-# Offense count: 1
-# Configuration parameters: CustomIncludeMethods.
-RSpec/EmptyExampleGroup:
-  Exclude:
-    - 'spec/factories/factories.rb'
-
-# Offense count: 1
-RSpec/MissingExampleGroupArgument:
-  Exclude:
-    - 'spec/factories/factories.rb'
-
 # Offense count: 4
 RSpec/MultipleDescribes:
   Exclude:
@@ -44,12 +47,16 @@ RSpec/MultipleDescribes:
     - 'spec/reek/report/location_formatter_spec.rb'
     - 'spec/reek/report/progress_formatter_spec.rb'
 
-# Offense count: 32
-# Configuration parameters: AggregateFailuresByDefault.
+# Offense count: 30
 RSpec/MultipleExpectations:
   Max: 5
 
-# Offense count: 25
+# Offense count: 16
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 9
+
+# Offense count: 27
 RSpec/NestedGroups:
   Max: 5
 

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Change log
 
+## 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
+  mingw32
+* (Cesario Uy) Fix typo in docs for "Boolean Parameter" smell
+* (mvz) Set link metadata in gemspec
+
 ## 6.0.1 (2020-05-26)
 
 * (Maxim Pertsov) Handle absolute paths for directories correctly

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

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

@@ -7,16 +7,16 @@ ruby RUBY_VERSION
 group :development do
   gem 'aruba',                 '~> 1.0'
   gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              '~> 3.0'
+  gem 'cucumber',              ['>= 4.0', '< 7.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.83.0'
-  gem 'rubocop-performance',   '~> 1.5.0'
-  gem 'rubocop-rspec',         '~> 1.39.0'
-  gem 'simplecov',             '~> 0.18.1'
+  gem 'rubocop',               '~> 1.12.0'
+  gem 'rubocop-performance',   '~> 1.10.1'
+  gem 'rubocop-rspec',         '~> 2.2.0'
+  gem 'simplecov',             ['>= 0.18.0', '< 0.22.0']
   gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do
@@ -25,5 +25,5 @@ group :development do
 end
 
 group :debugging do
-  gem 'pry', '~> 0.13.0'
+  gem 'pry', '~> 0.14.0'
 end

data/README.md

@@ -373,7 +373,7 @@ are documented in the corresponding smell type /docs page (if you want to get a
 configurations you can also check out [the `defaults.reek.yml` file in this repository](docs/defaults.reek.yml).
 
 Note that you do not need a configuration file at all.
-If you're fine with all the [defaults.reek.yml](docs/defaults.reek.yml) we set you can skip this completely.
+If you're fine with all the [defaults](docs/defaults.reek.yml) we set you can skip this completely.
 
 Don't worry about introducing a mistake in your configuration file that might go unnoticed - Reek uses a
 schema to validate your configuration against on start up and will faily loudly in case you

data/bin/code_climate_reek

@@ -14,15 +14,14 @@ class CodeClimateToReek
   # we have to exit with a zero for both failure and success.
   ENGINE_CONFIGURATION = [
     '--failure-exit-code', '0',
-    '--success-exit-code', '0',
-    '.'
+    '--success-exit-code', '0'
   ].freeze
 
   attr_reader :configuration_file_path, :include_paths_key, :include_paths_default
 
   def initialize(configuration_file_path: '/config.json',
                  include_paths_key: 'include_paths',
-                 include_paths_default: [])
+                 include_paths_default: ['.'])
     @configuration_file_path = configuration_file_path
     @include_paths_key       = include_paths_key
     @include_paths_default   = include_paths_default

data/lib/reek.rb

@@ -8,6 +8,7 @@ require_relative 'reek/examiner'
 require_relative 'reek/report'
 
 module Reek
+  DEFAULT_SMELL_CONFIGURATION = File.join(__dir__, '../docs/defaults.reek.yml').freeze
   DEFAULT_CONFIGURATION_FILE_NAME = '.reek.yml'
   DETECTORS_KEY = 'detectors'
   EXCLUDE_PATHS_KEY = 'exclude_paths'

data/lib/reek/ast/ast_node_class_map.rb

@@ -30,7 +30,7 @@ module Reek
                 SexpExtensions.const_get(const)
               ]
             end
-            Hash[assoc]
+            assoc.to_h
           end
       end
 

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/cli/options.rb

@@ -87,7 +87,7 @@ module Reek
 
       def set_banner
         program_name = parser.program_name
-        parser.banner = <<-BANNER.gsub(/^[ ]+/, '')
+        parser.banner = <<-BANNER.gsub(/^ +/, '')
           Usage: #{program_name} [options] [files]
 
           Examples:

data/lib/reek/configuration/app_configuration.rb

@@ -72,11 +72,12 @@ module Reek
 
       def load_values(values)
         values.each do |key, value|
-          if key == EXCLUDE_PATHS_KEY
+          case key
+          when EXCLUDE_PATHS_KEY
             excluded_paths.add value
-          elsif key == DIRECTORIES_KEY
+          when DIRECTORIES_KEY
             directory_directives.add value
-          elsif key == DETECTORS_KEY
+          when DETECTORS_KEY
             default_directive.add value
           end
         end

data/lib/reek/configuration/directory_directives.rb

@@ -84,7 +84,7 @@ module Reek
                      gsub('<<to_eol_wildcards>>', '.*').
                      gsub('<<to_wildcards>>', '.*')
                  else
-                   glob + '.*'
+                   "#{glob}.*"
                  end
 
         Regexp.new("^#{regexp}$", Regexp::IGNORECASE)
@@ -92,7 +92,7 @@ module Reek
 
       def error_message_for_invalid_smell_type(klass)
         "You are trying to configure smell type #{klass} but we can't find one with that name.\n" \
-          "Please make sure you spelled it right. (See 'docs/defaults.reek' in the Reek\n" \
+          "Please make sure you spelled it right. (See 'docs/defaults.reek.yml' in the Reek\n" \
           'repository for a list of all available smell types.)'
       end
     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/module_context.rb

@@ -66,6 +66,8 @@ module Reek
         CodeComment.new(comment: exp.leading_comment).descriptive?
       end
 
+      CONSTANT_SEXP_TYPES = [:casgn, :class, :module].freeze
+
       # A namespace module is a module (or class) that is only there for namespacing
       # purposes, and thus contains only nested constants, modules or classes.
       #
@@ -78,7 +80,7 @@ module Reek
         return false if exp.type == :casgn
 
         children = exp.direct_children
-        children.any? && children.all? { |child| [:casgn, :class, :module].include? child.type }
+        children.any? && children.all? { |child| CONSTANT_SEXP_TYPES.include? child.type }
       end
 
       def track_visibility(visibility, names)

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)