reek 4.7.3 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a71c30d4b1f39eee7c330e391cb1e80afa0a2d3b
-  data.tar.gz: fad4cfa8b8d369ff2e5c6ac5a22f3be8abc03891
+  metadata.gz: 03a8001a3b22bcc9d88119e88b42854baec8a7e6
+  data.tar.gz: 51eeaee185f5d97ef76ba341a875aad0202c14ad
 SHA512:
-  metadata.gz: 15725dcd429906aba55b5dd379f01b1bf5e6eb08dd8df814a8403752c1356481137e0804618a449010c1b6dbb90da5543f21cf9401d2faaacbb6254734b01f68
-  data.tar.gz: 4a7a38b3b04059de3f93bb90ee14354fc0052f6c8a23ff3f96b8f456643087aa9f51aca3ff22758ef118f4c3fc05c741892a9658c512c0f0f171ee7cbbbfbd9a
+  metadata.gz: a8302cbf65eb954433fb21243998da37fdc1755a7a82f10a465f7205c9b697f8498b593584d3fbc857c6d8544bbd49441c42f62ea5049916ad2a02bdf7a6ef94
+  data.tar.gz: 3150c68090b560dbdd91e51dc520c63bc6d6367c3efa4772e64205969b22fb0cdf292ed297a3f09ef271f32b9594d9380bc817cc855021e003c641a561606143

data/.codeclimate.yml

@@ -1,16 +1,21 @@
-engines:
+version: "2"
+plugins:
   rubocop:
     enabled: true
   reek:
     enabled: true
-ratings:
-  paths:
-  - lib/**/*
-exclude_paths:
-- coverage/
-- docs/
-- features/
-- logo/
-- pkg/
-- spec/
-- tmp/
+  duplication:
+    enabled: true
+    config:
+      languages:
+        ruby:
+          mass_threshold: 35
+exclude_patterns:
+  - coverage/
+  - docs/
+  - features/
+  - logo/
+  - pkg/
+  - samples/
+  - spec/
+  - tmp/

data/.rubocop.yml

@@ -117,6 +117,7 @@ RSpec/MultipleExpectations:
 # FIXME: Update specs to avoid offenses
 RSpec/NestedGroups:
   Exclude:
+    - 'spec/reek/report/code_climate/code_climate_fingerprint_spec.rb'
     - 'spec/reek/cli/application_spec.rb'
 
 # rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.

data/.travis.yml

@@ -2,6 +2,7 @@ sudo: false
 dist: trusty
 cache: bundler
 language: ruby
+before_install: gem update --system
 bundler_args: --without debugging
 script: bundle exec rake ci
 rvm:
@@ -9,13 +10,14 @@ rvm:
   - 2.2
   - 2.3
   - 2.4
-  - jruby-9.1.7.0
+  - 2.5
+  - jruby-9.1.15.0
   - jruby-head
   - ruby-head
   - rubinius-3
 matrix:
   allow_failures:
-    - rvm: jruby-9.1.7.0
+    - rvm: jruby-9.1.15.0
     - rvm: jruby-head
     - rvm: ruby-head
     - rvm: rubinius-3

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log
 
+## Unreleased
+
+## 4.8.0 (2018-03-05)
+
+* (pocke) Support Ruby 2.5
+* (mvz) Print original exception class in certain error messages
+* (mvz) Only include long exception message in CLI output
+* (chastell) Add official support for Ruby 2.5
+* (mvz) Do not detect ModuleInitialize for nested dynamic classes
+
 ## 4.7.3 (2017-11-05)
 
 * (mvz) Handle UTF-8 files in all locales

data/Gemfile

@@ -9,15 +9,15 @@ group :development do
   gem 'aruba',         '~> 0.14.0'
   gem 'ataru',         '~> 0.2.0'
   gem 'cucumber',      '~> 3.0'
-  gem 'factory_girl',  '~> 4.0'
+  gem 'factory_bot',   '~> 4.0'
   gem 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
   gem 'simplecov',     '~> 0.15.0'
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.51.0'
-    gem 'rubocop-rspec', '~> 1.19.0'
+    gem 'rubocop',       '~> 0.52.0'
+    gem 'rubocop-rspec', '~> 1.20'
   end
 
   platforms :mri do

data/README.md

@@ -7,7 +7,7 @@
 - [Overview](#overview)
 - [Quickstart](#quickstart)
 - [Example](#example)
-- [Supported rubies](#supported-rubies)
+- [Supported Ruby versions](#supported-ruby-versions)
 - [Fixing Smell Warnings](#fixing-smell-warnings)
 - [Sources](#sources)
 - [Code smells](#code-smells)
@@ -93,16 +93,17 @@ demo.rb -- 2 warnings:
   [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
 ```
 
-## Supported rubies
+## Supported Ruby versions
 
-Reek is officially running on the following MRI rubies:
+Reek is officially supported for the following CRuby versions:
 
   - 2.1
   - 2.2
   - 2.3
   - 2.4
+  - 2.5
 
-Other rubies like Rubinius or JRuby are not officially supported but should work as well.
+Other Ruby implementations (like Rubinius or JRuby) are not officially supported but should work as well.
 
 ## Fixing Smell Warnings
 
@@ -528,6 +529,20 @@ If you don't feel like getting your hands dirty with code there are still other
 * Open up an [issue](https://github.com/troessner/reek/issues) and report bugs
 * Suggest other improvements like additional smells for instance
 
+### Running Code Climate locally
+
+If you run into Code Climate issues (e.g., go over code duplication
+threshold) you might want to be able to run Code Climate against
+the Reek codebase locally. To do this, you need to do the following:
+
+* [install Docker CE](https://docs.docker.com/engine/installation/)
+* [install Code Climate CLI](https://github.com/codeclimate/codeclimate#installation)
+* `gem install codeclimate`
+* `codeclimate engines:install`
+
+Now you can run various Code Climate engines,
+e.g., `codeclimate analyze -e duplication`
+
 ## Output formats
 
 Reek supports 5 output formats:

data/lib/reek/ast/node.rb

@@ -33,55 +33,43 @@ module Reek
         loc && loc.line
       end
 
+      def name
+        to_s
+      end
+
       #
-      # Carries out a depth-first traversal of this syntax tree, yielding
-      # every Sexp of type `target_type`. The traversal ignores any node
-      # whose type is listed in the Array `ignoring`.
-      # Takes a block as well.
-      #
-      # target_type - the type to look for, e.g. :send, :block
-      # ignoring - types to ignore, e.g. [:casgn, :class, :module]
-      # blk - block to execute for every hit. Gets passed in the matching element itself.
+      # Carries out a depth-first traversal of this syntax tree, yielding every
+      # Sexp of the searched for type or types. The traversal stops at any node
+      # whose type is listed in `ignoring`.
       #
-      # Examples:
-      #   context.each_node(:send, [:mlhs]) do |call_node| .... end
-      #   context.each_node(:lvar).any? { |it| it.var_name == 'something' }
+      # If a type is searched for *and* listed in ignoring, it will be yielded
+      # but traversal will not continue to its children.
       #
-      # Returns an array with all matching nodes.
-      # TODO: without a block, this doesn't do what one might expect
-      def each_node(target_type, ignoring = [], &blk)
-        if block_given?
-          look_for_type(target_type, ignoring, &blk)
-        else
-          result = []
-          look_for_type(target_type, ignoring) { |exp| result << exp }
-          result
-        end
-      end
-
+      # If the root's type is ignored, traversal does not stop, unless the root
+      # is of a target type.
       #
-      # Carries out a depth-first traversal of this syntax tree, yielding
-      # every Sexp of type `target_type`. The traversal ignores any node
-      # whose type is listed in the Array `ignoring`, including the top node.
       # Takes a block as well.
       #
-      # target_types - the types to look for, e.g. [:send, :block]
-      # ignoring - types to ignore, e.g. [:casgn, :class, :module]
-      # blk - block to execute for every hit
+      # @param target_types [Symbol, Array<Symbol>] the type or types to look
+      #     for
+      # @param ignoring [Array<Symbol>] types to ignore
+      # @param blk block to execute for every hit. Gets passed in the
+      #     matching element itself.
       #
-      # Examples:
-      #   exp.find_nodes([:block]).flat_map do |elem| ... end
+      # @example
+      #   node.each_node(:send, [:mlhs]) do |call_node| .... end
+      #   node.each_node(:lvar).any? { |it| it.var_name == 'something' }
+      #   node.each_node([:block]).flat_map do |elem| ... end
       #
       # Returns an array with all matching nodes.
-      def find_nodes(target_types, ignoring = [])
-        result = []
-        look_for_types(target_types, ignoring) { |exp| result << exp }
-        result
+      def each_node(target_types, ignoring = [], &blk)
+        return enum_for(:each_node, target_types, ignoring) unless block_given?
+
+        look_for(Array(target_types), ignoring, &blk)
       end
 
       def contains_nested_node?(target_type)
-        look_for_type(target_type) { |_elem| return true }
-        false
+        each_node(target_type).any?
       end
 
       # :reek:DuplicateMethodCall { max_calls: 2 } is ok for lines.first
@@ -120,22 +108,22 @@ module Reek
       protected
 
       # See ".each_node" for documentation.
-      def look_for_type(target_type, ignoring = [], &blk)
+      def look_for(target_types, ignoring, &blk)
+        if target_types.include? type
+          yield self
+          return if ignoring.include?(type)
+        end
         each_sexp do |elem|
-          elem.look_for_type(target_type, ignoring, &blk) unless ignoring.include?(elem.type)
+          elem.look_for_recurse(target_types, ignoring, &blk)
         end
-        yield self if type == target_type
       end
 
-      # See ".find_nodes" for documentation.
-      def look_for_types(target_types, ignoring = [], &blk)
-        return if ignoring.include?(type)
-        if target_types.include? type
-          yield self
-        else
-          each_sexp do |elem|
-            elem.look_for_types(target_types, ignoring, &blk)
-          end
+      # See ".each_node" for documentation.
+      def look_for_recurse(target_types, ignoring, &blk)
+        yield self if target_types.include? type
+        return if ignoring.include? type
+        each_sexp do |elem|
+          elem.look_for_recurse(target_types, ignoring, &blk)
         end
       end
 

data/lib/reek/ast/reference_collector.rb

@@ -12,7 +12,7 @@ module Reek
       end
 
       def num_refs_to_self
-        (explicit_self_calls + implicit_self_calls).size
+        (explicit_self_calls.to_a + implicit_self_calls.to_a).size
       end
 
       private
@@ -20,9 +20,7 @@ module Reek
       attr_reader :ast
 
       def explicit_self_calls
-        [:self, :super, :zsuper, :ivar, :ivasgn].flat_map do |node_type|
-          ast.each_node(node_type)
-        end
+        ast.each_node([:self, :super, :zsuper, :ivar, :ivasgn])
       end
 
       def implicit_self_calls

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

@@ -10,7 +10,7 @@ module Reek
         end
 
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
+          children[1..-1].compact.flat_map { |child| child.each_node(type, ignoring).to_a }
         end
 
         def else_body

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

@@ -9,8 +9,15 @@ module Reek
           children.first
         end
 
+        # :reek:FeatureEnvy
         def body_nodes(type, ignoring = [])
-          children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
+          children[1..-1].compact.flat_map do |child|
+            if ignoring.include? child.type
+              []
+            else
+              child.each_node(type, ignoring).to_a
+            end
+          end
         end
       end
     end

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

@@ -10,7 +10,7 @@ module Reek
         end
 
         def body_nodes(type, ignoring = [])
-          children[1].find_nodes type, ignoring
+          children[1].each_node type, ignoring
         end
       end
 

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

@@ -30,11 +30,9 @@ module Reek
         end
 
         def body_nodes(types, ignoring = [])
-          if body
-            body.find_nodes(types, ignoring)
-          else
-            []
-          end
+          return [] unless body
+          return [] if ignoring.include?(body.type)
+          body.each_node(types, ignoring | types)
         end
       end
 

data/lib/reek/configuration/configuration_file_finder.rb

@@ -20,8 +20,8 @@ module Reek
     module ConfigurationFileFinder
       TOO_MANY_CONFIGURATION_FILES_MESSAGE = <<-MESSAGE.freeze
 
-        Error: Found multiple configuration files %s
-        while scanning directory %s.
+        Error: Found multiple configuration files %<files>s
+        while scanning directory %<directory>s.
 
         Reek supports only one configuration file. You have 2 options now:
         1) Remove all offending files.
@@ -111,7 +111,7 @@ module Reek
         #
         def escalate_too_many_configuration_files(found, directory)
           offensive_files = found.map { |file| "'#{file.basename}'" }.join(', ')
-          warn format(TOO_MANY_CONFIGURATION_FILES_MESSAGE, offensive_files, directory)
+          warn format(TOO_MANY_CONFIGURATION_FILES_MESSAGE, files: offensive_files, directory: directory)
           exit 1
         end
       end

data/lib/reek/context/code_context.rb

@@ -19,7 +19,6 @@ module Reek
     class CodeContext
       include Enumerable
       extend Forwardable
-      delegate each_node: :exp
       delegate [:name, :type] => :exp
 
       attr_reader :children, :parent, :exp, :statement_counter
@@ -40,12 +39,12 @@ module Reek
       # @yield block that is executed for every node.
       #
       def local_nodes(type, ignored = [], &blk)
-        ignored += [:casgn, :class, :module]
-        each_node(type, ignored, &blk)
+        ignored |= [:class, :module]
+        exp.each_node(type, ignored, &blk)
       end
 
       # Iterate over `self` and child contexts.
-      # The main difference (among others) to `each_node` is that we are traversing
+      # The main difference (among others) to `local_nodes` is that we are traversing
       # `CodeContexts` here, not AST nodes (see `Reek::AST::Node`).
       #
       # @yield block that is executed for every node.
@@ -119,9 +118,7 @@ module Reek
         line = exp.line
         case type
         when :lvar, :lvasgn
-          unless exp.object_creation_call?
-            refs.record_reference(name: receiver.name, line: line)
-          end
+          refs.record_reference(name: receiver.name, line: line) unless exp.object_creation_call?
         when :self
           refs.record_reference(name: :self, line: line)
         end

data/lib/reek/context/method_context.rb

@@ -23,21 +23,16 @@ module Reek
       end
 
       def uses_param?(param)
-        # local_nodes(:lvasgn) catches:
+        # :lvasgn catches:
+        #
         #   def foo(bar); bar += 1; end
-        # In this example there is no `lvar` node present.
         #
-        # local_nodes(:lvar) catches:
+        # :lvar catches:
+        #
         #   def foo(bar); other(bar); end
         #   def foo(bar); tmp = other(bar); tmp[0]; end
         #
-        # Note that in the last example the `lvar` node for `bar` is part of an `lvasgn` node for `tmp`.
-        # This means that if we would just search for [:lvar, :lvasgn]
-        # (e.g. via Reek::AST::Node#find_nodes) this would fail for this example since we would
-        # stop at the `lvasgn` and not detect the contained `lvar`.
-        # Hence we first get all `lvar` nodes followed by all `lvasgn` nodes.
-        #
-        (local_nodes(:lvar) + local_nodes(:lvasgn)).find { |node| node.var_name == param.name }
+        local_nodes([:lvar, :lvasgn]).find { |node| node.var_name == param.name }
       end
 
       # :reek:FeatureEnvy

data/lib/reek/context/module_context.rb

@@ -43,9 +43,9 @@ module Reek
         AttributeContext
       end
 
-      def defined_instance_methods(visibility: :public)
+      def defined_instance_methods(visibility: :any)
         instance_method_children.select do |context|
-          context.visibility == visibility
+          visibility == :any || context.visibility == visibility
         end
       end
 
@@ -59,7 +59,7 @@ module Reek
       # @deprecated use `defined_instance_methods` instead
       #
       def node_instance_methods
-        local_nodes(:def)
+        local_nodes(:def).to_a
       end
 
       def descriptively_commented?