reek 4.7.1 → 5.0.0

data/lib/reek/spec/should_reek_of.rb

@@ -2,6 +2,7 @@
 
 require_relative '../examiner'
 require_relative 'smell_matcher'
+require_relative '../configuration/app_configuration'
 
 module Reek
   module Spec
@@ -14,12 +15,13 @@ module Reek
 
       attr_reader :failure_message, :failure_message_when_negated
 
-      def initialize(smell_type_or_class,
+      def initialize(smell_type,
                      smell_details = {},
                      configuration = Configuration::AppConfiguration.default)
-        @smell_type = normalize smell_type_or_class
+        @smell_type = smell_type.to_s
         @smell_details = smell_details
-        configuration.load_values(smell_type => { SmellConfiguration::ENABLED_KEY => true })
+        configuration.load_values(Configuration::AppConfiguration::DETECTORS_KEY =>
+                                    { smell_type => { SmellConfiguration::ENABLED_KEY => true } })
         @configuration = configuration
       end
 
@@ -34,7 +36,8 @@ module Reek
 
       def with_config(config_hash)
         new_configuration = Configuration::AppConfiguration.default
-        new_configuration.load_values(smell_type => config_hash)
+        new_configuration.load_values(Configuration::AppConfiguration::DETECTORS_KEY =>
+                                        { smell_type => config_hash })
         self.class.new(smell_type, smell_details, new_configuration)
       end
 
@@ -82,7 +85,7 @@ module Reek
           "#{smell_type} with smell details #{smell_details}, but it did"
       end
 
-      # :reek:FeatureEnvy
+      # @quality :reek:FeatureEnvy
       def all_relevant_smell_details_formatted
         matching_smell_types.each_with_object([]).with_index do |(smell, accumulator), index|
           accumulator << "#{index + 1}.)\n"
@@ -93,17 +96,7 @@ module Reek
       end
 
       def origin
-        examiner.description
-      end
-
-      # :reek:UtilityFunction
-      def normalize(smell_type_or_class)
-        case smell_type_or_class
-        when Class
-          smell_type_or_class.smell_type
-        else
-          smell_type_or_class.to_s
-        end
+        examiner.origin
       end
     end
   end

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../examiner'
-require_relative '../report/formatter'
+require_relative '../report/simple_warning_formatter'
 require_relative 'should_reek_of'
 require_relative 'smell_matcher'
 
@@ -24,12 +24,12 @@ module Reek
       end
 
       def failure_message
-        rpt = Report::Formatter.format_list(warnings)
-        "Expected #{examiner.description} to reek only of #{smell_type}, but got:\n#{rpt}"
+        rpt = Report::SimpleWarningFormatter.new.format_list(warnings)
+        "Expected #{examiner.origin} to reek only of #{smell_type}, but got:\n#{rpt}"
       end
 
       def failure_message_when_negated
-        "Expected #{examiner.description} not to reek only of #{smell_type}, but it did"
+        "Expected #{examiner.origin} not to reek only of #{smell_type}, but it did"
       end
 
       private

data/lib/reek/spec.rb

@@ -65,7 +65,7 @@ module Reek
     # raise an ArgumentError to give you a hint that you passed something that doesn't make
     # much sense.
     #
-    # @param smell_type [Symbol, String, Class] The "smell type" to check for.
+    # @param smell_type [Symbol, String] The "smell type" to check for.
     # @param smell_details [Hash] A hash containing "smell warning" parameters
     #
     # @example Without smell_details
@@ -84,7 +84,7 @@ module Reek
     #
     # @public
     #
-    # :reek:UtilityFunction
+    # @quality :reek:UtilityFunction
     def reek_of(smell_type,
                 smell_details = {},
                 configuration = Configuration::AppConfiguration.default)
@@ -99,11 +99,11 @@ module Reek
     #       "reek_only_of" will fail in that case.
     #   2.) "reek_only_of" doesn't support the additional smell_details hash.
     #
-    # @param smell_type [Symbol, String, Class] The "smell type" to check for.
+    # @param smell_type [Symbol, String] The "smell type" to check for.
     #
     # @public
     #
-    # :reek:UtilityFunction
+    # @quality :reek:UtilityFunction
     def reek_only_of(smell_type, configuration = Configuration::AppConfiguration.default)
       ShouldReekOnlyOf.new(smell_type, configuration)
     end
@@ -113,8 +113,8 @@ module Reek
     #
     # @public
     #
-    # :reek:UtilityFunction
-    def reek(configuration = Configuration::AppConfiguration.default)
+    # @quality :reek:UtilityFunction
+    def reek(configuration = Configuration::AppConfiguration.from_default_path)
       ShouldReek.new(configuration: configuration)
     end
   end

data/lib/reek/tree_dresser.rb

@@ -31,21 +31,21 @@ module Reek
     # time the nodes will contain type-dependent mixins, e.g. this:
     #   (const nil :Klazz)
     #  will be of type Reek::AST::Node with  Reek::AST::SexpExtensions::ConstNode mixed in.
-    # @param sexp [Parser::AST::Node] - the given sexp
-    # @param comment_map [Hash] - see the documentation for SourceCode#syntax_tree
-    # @param parent [Parser::AST::Node] - the parent sexp
+    #
+    # @param sexp [Parser::AST::Node] the given sexp
+    # @param comment_map [Hash] see the documentation for SourceCode#syntax_tree
     #
     # @return an instance of Reek::AST::Node with type-dependent sexp extensions mixed in.
     #
-    # :reek:FeatureEnvy
-    # :reek:TooManyStatements: { max_statements: 6 }
-    def dress(sexp, comment_map, parent: nil)
+    # @quality :reek:FeatureEnvy
+    # @quality :reek:TooManyStatements { max_statements: 6 }
+    def dress(sexp, comment_map)
       return sexp unless sexp.is_a? ::Parser::AST::Node
       type = sexp.type
-      children = sexp.children.map { |child| dress(child, comment_map, parent: sexp) }
+      children = sexp.children.map { |child| dress(child, comment_map) }
       comments = comment_map[sexp]
       klass_map.klass_for(type).new(type, children,
-                                    location: sexp.loc, comments: comments, parent: parent)
+                                    location: sexp.loc, comments: comments)
     end
 
     private

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.7.1'.freeze
+    STRING = '5.0.0'
   end
 end

data/reek.gemspec

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 require File.join(File.dirname(__FILE__), 'lib/reek/version')
 
 Gem::Specification.new do |s|
@@ -7,7 +5,6 @@ Gem::Specification.new do |s|
   s.version = Reek::Version::STRING
 
   s.authors = ['Kevin Rutherford', 'Timo Roessner', 'Matijs van Zuijlen', 'Piotr Szotkowski']
-  s.default_executable = 'reek'
   s.description =
     'Reek is a tool that examines Ruby classes, modules and methods and reports ' \
     'any code smells it finds.'
@@ -17,12 +14,13 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
   s.files = `git ls-files -z`.split("\0")
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
-  s.homepage = 'https://github.com/troessner/reek/wiki'
+  s.homepage = 'https://github.com/troessner/reek'
   s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  s.required_ruby_version = '>= 2.1.0'
+  s.required_ruby_version = '>= 2.3.0'
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
-  s.add_runtime_dependency 'parser',                '< 2.5', '>= 2.4.0.0'
-  s.add_runtime_dependency 'rainbow',               '~> 2.0'
+  s.add_runtime_dependency 'kwalify',               '~> 0.7.0'
+  s.add_runtime_dependency 'parser',                '< 2.6', '>= 2.5.0.0'
+  s.add_runtime_dependency 'rainbow',               '>= 2.0', '< 4.0'
 end

data/samples/checkstyle.xml

@@ -1,6 +1,6 @@
 <?xml version='1.0'?>
 <checkstyle>
-  <file name='samples/smelly.rb'>
+  <file name='samples/smelly_source/smelly.rb'>
     <error column='0' line='4' message='has the name &apos;x&apos;' severity='warning' source='UncommunicativeMethodName'/>
     <error column='0' line='5' message='has the variable name &apos;y&apos;' severity='warning' source='UncommunicativeVariableName'/>
   </file>

data/samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml

@@ -0,0 +1,29 @@
+---
+detectors:
+  UnusedPrivateMethod:
+    exclude:
+      - "/exclude regexp/"
+  UncommunicativeMethodName:
+    reject:
+      - "reject name"
+    accept:
+      - "accept name"
+  UncommunicativeModuleName:
+    reject:
+      - "reject name 1"
+      - "reject name 2"
+    accept:
+      - "accept name 1"
+      - "accept name 2"
+  UncommunicativeParameterName:
+    reject:
+      - "reject name"
+      - "/reject regexp/"
+    accept:
+      - "accept name"
+      - "/accept regexp/"
+  UncommunicativeVariableName:
+    reject:
+      - "/^reject regexp$/"
+    accept:
+      - "/accept(.*)regexp/"

data/samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml

@@ -0,0 +1,30 @@
+---
+directories:
+  "app/controllers":
+    UnusedPrivateMethod:
+      exclude:
+        - "/exclude regexp/"
+    UncommunicativeMethodName:
+      reject:
+        - "reject name"
+      accept:
+        - "accept name"
+    UncommunicativeModuleName:
+      reject:
+        - "reject name 1"
+        - "reject name 2"
+      accept:
+        - "accept name 1"
+        - "accept name 2"
+    UncommunicativeParameterName:
+      reject:
+        - "reject name"
+        - "/reject regexp/"
+      accept:
+        - "accept name"
+        - "/accept regexp/"
+    UncommunicativeVariableName:
+      reject:
+        - "/^reject regexp$/"
+      accept:
+        - "/accept(.*)regexp/"

data/samples/configuration/full_configuration.reek

@@ -1,9 +1,13 @@
 ---
-IrresponsibleModule:
-  enabled: false
-"samples/three_clean_files/":
-  UtilityFunction:
+detectors:
+  IrresponsibleModule:
     enabled: false
+
+directories:
+  "samples/three_clean_files/":
+    UtilityFunction:
+      enabled: false
+
 exclude_paths:
   - "samples/two_smelly_files/"
   - "samples/source_with_non_ruby_files/"

data/samples/configuration/full_mask.reek

@@ -1,5 +1,6 @@
 ---
-UncommunicativeMethodName:
-  enabled: false
-UncommunicativeVariableName:
-  enabled: false
+detectors:
+  UncommunicativeMethodName:
+    enabled: false
+  UncommunicativeVariableName:
+    enabled: false

data/samples/configuration/partial_mask.reek

@@ -1,3 +1,4 @@
 ---
-UncommunicativeMethodName:
-  enabled: false
+detectors:
+  UncommunicativeMethodName:
+    enabled: false

data/samples/configuration/regular_configuration/.reek.yml

@@ -0,0 +1,4 @@
+---
+UncommunicativeVariableName:
+  accept:
+  - md5

data/samples/paths.rb

@@ -1,4 +1,5 @@
-SAMPLES_PATH = Pathname.new(__dir__).relative_path_from(Pathname.pwd)
-CONFIG_PATH = SAMPLES_PATH.join('configuration')
-CLEAN_FILE = SAMPLES_PATH.join('clean.rb')
-SMELLY_FILE = SAMPLES_PATH.join('smelly.rb')
+SAMPLES_DIR = Pathname.new(__dir__).relative_path_from(Pathname.pwd)
+CONFIGURATION_DIR = SAMPLES_DIR.join('configuration')
+CLEAN_FILE = SAMPLES_DIR.join('clean_source').join('clean.rb')
+SMELLY_FILE = SAMPLES_DIR.join('smelly_source').join('smelly.rb')
+

data/samples/source_with_hidden_directories/.hidden/hidden.rb

@@ -0,0 +1 @@
+

data/samples/source_with_hidden_directories/not_hidden.rb

@@ -0,0 +1 @@
+

data/spec/factories/factories.rb

@@ -3,18 +3,7 @@ require_relative '../../lib/reek/smell_detectors/base_detector'
 require_relative '../../lib/reek/smell_warning'
 require_relative '../../lib/reek/cli/options'
 
-FactoryGirl.define do
-  factory :method_context, class: Reek::Context::MethodContext do
-    skip_create
-    transient do
-      source 'def foo; end'
-    end
-
-    initialize_with do
-      new(nil, Reek::Source::SourceCode.from(source).syntax_tree)
-    end
-  end
-
+FactoryBot.define do
   factory :smell_detector, class: Reek::SmellDetectors::BaseDetector do
     skip_create
     transient do
@@ -33,7 +22,7 @@ FactoryGirl.define do
     source 'dummy_file'
     lines [42]
     message 'smell warning message'
-    parameters { {} }
+    parameters({})
 
     initialize_with do
       new(smell_detector,

data/spec/reek/ast/node_spec.rb

@@ -2,6 +2,92 @@ require_relative '../../spec_helper'
 require_lib 'reek/ast/node'
 
 RSpec.describe Reek::AST::Node do
+  describe '#each_node' do
+    context 'with an empty module' do
+      let(:ast) do
+        src = 'module Emptiness; end'
+        Reek::Source::SourceCode.from(src).syntax_tree
+      end
+
+      it 'yields no calls' do
+        ast.each_node(:send, []) { |exp| raise "#{exp} yielded by empty module!" }
+      end
+
+      it 'yields one module' do
+        mods = 0
+        ast.each_node(:module, []) { |_exp| mods += 1 }
+        expect(mods).to eq(1)
+      end
+
+      it "yields the module's full AST" do
+        ast.each_node(:module, []) do |exp|
+          expect(exp).to eq(sexp(:module, sexp(:const, nil, :Emptiness), nil))
+        end
+      end
+
+      it 'returns an enumerator when no block is passed' do
+        expect(ast.each_node(:if)).to be_instance_of Enumerator
+      end
+    end
+
+    context 'with a nested element' do
+      let(:ast) do
+        src = "module Loneliness; def calloo; puts('hello') end; end"
+        Reek::Source::SourceCode.from(src).syntax_tree
+      end
+
+      it 'yields no ifs' do
+        ast.each_node(:if) { |exp| raise "#{exp} yielded by empty module!" }
+      end
+
+      it 'yields one module' do
+        expect(ast.each_node(:module).to_a.length).to eq(1)
+      end
+
+      it "yields the module's full AST" do
+        ast.each_node(:module) do |exp|
+          expect(exp).to eq sexp(:module,
+                                 sexp(:const, nil, :Loneliness),
+                                 sexp(:def, :calloo,
+                                      sexp(:args),
+                                      sexp(:send, nil, :puts, sexp(:str, 'hello'))))
+        end
+      end
+
+      it 'yields one method' do
+        expect(ast.each_node(:def).to_a.length).to eq(1)
+      end
+
+      it "yields the method's full AST" do
+        ast.each_node(:def, []) { |exp| expect(exp.children.first).to eq(:calloo) }
+      end
+
+      it 'ignores the call inside the method if the traversal is pruned' do
+        expect(ast.each_node(:send, [:def]).to_a).to be_empty
+      end
+    end
+
+    it 'finds 3 ifs in a class' do
+      src = <<-EOS
+        class Scrunch
+          def first
+            return @field == :sym ? 0 : 3;
+          end
+          def second
+            if @field == :sym
+              @other += " quarts"
+            end
+          end
+          def third
+            raise 'flu!' unless @field == :sym
+          end
+        end
+      EOS
+      ast = Reek::Source::SourceCode.from(src).syntax_tree
+      expect(ast.each_node(:if).to_a.length).to eq(3)
+    end
+  end
+
   describe '#format_to_ruby' do
     it 'returns #to_s if location is not present' do
       ast = sexp(:self)
@@ -56,7 +142,7 @@ RSpec.describe Reek::AST::Node do
     end
   end
 
-  context 'hash' do
+  describe '#hash' do
     it 'hashes equal for equal sexps' do
       node1 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 4), :+, sexp(:send, nil, :fred)))
       node2 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 4), :+, sexp(:send, nil, :fred)))
@@ -77,8 +163,8 @@ RSpec.describe Reek::AST::Node do
   end
 
   describe '#line' do
-    context 'source from file' do
-      let(:file) { SAMPLES_PATH.join('smelly.rb') }
+    context 'with source from a file' do
+      let(:file) { SMELLY_FILE }
       let(:ast) { Reek::Source::SourceCode.from(file).syntax_tree }
 
       it 'returns the right line number' do
@@ -86,8 +172,8 @@ RSpec.describe Reek::AST::Node do
       end
     end
 
-    context 'source from string' do
-      let(:source) { File.read(SAMPLES_PATH.join('smelly.rb')) }
+    context 'with source from a string' do
+      let(:source) { File.read(SMELLY_FILE) }
       let(:ast) { Reek::Source::SourceCode.from(source).syntax_tree }
 
       it 'returns the right line number' do
@@ -97,17 +183,17 @@ RSpec.describe Reek::AST::Node do
   end
 
   describe '#source' do
-    context 'source from file' do
-      let(:file) { SAMPLES_PATH.join('smelly.rb') }
+    context 'with source from a file' do
+      let(:file) { SMELLY_FILE }
       let(:ast) { Reek::Source::SourceCode.from(file).syntax_tree }
 
       it 'returns the file name' do
-        expect(ast.source).to eq(SAMPLES_PATH.join('smelly.rb').to_s)
+        expect(ast.source).to eq(SMELLY_FILE.to_s)
       end
     end
 
-    context 'source from string' do
-      let(:source) { File.read(SAMPLES_PATH.join('smelly.rb')) }
+    context 'with source from a string' do
+      let(:source) { File.read SMELLY_FILE }
       let(:ast) { Reek::Source::SourceCode.from(source).syntax_tree }
 
       it 'returns "string"' do
@@ -115,4 +201,11 @@ RSpec.describe Reek::AST::Node do
       end
     end
   end
+
+  describe '#name' do
+    it 'returns #to_s if no override is present' do
+      ast = sexp(:foo)
+      expect(ast.name).to eq ast.to_s
+    end
+  end
 end

data/spec/reek/ast/reference_collector_spec.rb

@@ -2,7 +2,7 @@ require_relative '../../spec_helper'
 require_lib 'reek/ast/reference_collector'
 
 RSpec.describe Reek::AST::ReferenceCollector do
-  context 'counting refs to self' do
+  describe '#num_refs_to_self' do
     def refs_to_self(src)
       syntax_tree = Reek::Source::SourceCode.from(src).syntax_tree
       described_class.new(syntax_tree).num_refs_to_self

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -107,7 +107,7 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
     end
 
     it 'finds nodes in the body with #body_nodes' do
-      expect(node.body_nodes([:first])).to eq [sexp(:first)]
+      expect(node.body_nodes([:first]).to_a).to eq [sexp(:first)]
     end
   end
 
@@ -303,12 +303,8 @@ RSpec.describe Reek::AST::SexpExtensions::SendNode do
   context 'with no parameters' do
     let(:node) { sexp(:send, nil, :hello) }
 
-    it 'has no argument names' do
-      expect(node.arg_names).to eq []
-    end
-
     it 'is not considered to be a writable attr' do
-      expect(sexp(:send, nil, :attr).attr_with_writable_flag?).to be_falsey
+      expect(sexp(:send, nil, :attr)).not_to be_attr_with_writable_flag
     end
   end
 
@@ -316,15 +312,15 @@ RSpec.describe Reek::AST::SexpExtensions::SendNode do
     let(:bare_new) { sexp(:send, nil, :new) }
 
     it 'is not considered to be a module creation call' do
-      expect(bare_new.module_creation_call?).to be_falsey
+      expect(bare_new).not_to be_module_creation_call
     end
 
     it 'is not considered to have a module creation receiver' do
-      expect(bare_new.module_creation_receiver?).to be_falsey
+      expect(bare_new).not_to be_module_creation_receiver
     end
 
     it 'is considered to be an object creation call' do
-      expect(bare_new.object_creation_call?).to be_truthy
+      expect(bare_new).to be_object_creation_call
     end
   end
 
@@ -332,31 +328,15 @@ RSpec.describe Reek::AST::SexpExtensions::SendNode do
     let(:node) { Reek::Source::SourceCode.from('(foo ? bar : baz).new').syntax_tree }
 
     it 'is not considered to be a module creation call' do
-      expect(node.module_creation_call?).to be_falsey
+      expect(node).not_to be_module_creation_call
     end
 
     it 'is not considered to have a module creation receiver' do
-      expect(node.module_creation_receiver?).to be_falsey
+      expect(node).not_to be_module_creation_receiver
     end
 
     it 'is considered to be an object creation call' do
-      expect(node.object_creation_call?).to be_truthy
-    end
-  end
-
-  context 'with 1 literal parameter' do
-    let(:node) { sexp(:send, nil, :hello, sexp(:lit, :param)) }
-
-    it 'has 1 argument name' do
-      expect(node.arg_names).to eq [:param]
-    end
-  end
-
-  context 'with 2 literal parameters' do
-    let(:node) { sexp(:send, nil, :hello, sexp(:lit, :x), sexp(:lit, :y)) }
-
-    it 'has 2 argument names' do
-      expect(node.arg_names).to eq [:x, :y]
+      expect(node).to be_object_creation_call
     end
   end
 end
@@ -394,7 +374,7 @@ end
 RSpec.describe Reek::AST::SexpExtensions::LambdaNode do
   let(:node) { sexp(:lambda) }
 
-  context '#name' do
+  describe '#name' do
     it 'returns :lambda' do
       expect(node.name).to eq 'lambda'
     end
@@ -466,14 +446,14 @@ RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
     context 'with single assignment' do
       it 'does not define a module' do
         exp = sexp(:casgn, nil, :Foo)
-        expect(exp.defines_module?).to be_falsey
+        expect(exp).not_to be_defines_module
       end
     end
 
     context 'with implicit receiver to new' do
       it 'does not define a module' do
         exp = sexp(:casgn, nil, :Foo, sexp(:send, nil, :new))
-        expect(exp.defines_module?).to be_falsey
+        expect(exp).not_to be_defines_module
       end
     end
 
@@ -481,7 +461,7 @@ RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
       it 'does not define a module' do
         exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
 
-        expect(exp.defines_module?).to be_truthy
+        expect(exp).to be_defines_module
       end
     end
 
@@ -489,7 +469,7 @@ RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
       it 'does not define a module' do
         exp = Reek::Source::SourceCode.from('C = ->{}').syntax_tree
 
-        expect(exp.defines_module?).to be_falsey
+        expect(exp).not_to be_defines_module
       end
     end
 
@@ -497,7 +477,7 @@ RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
       it 'does not define a module' do
         exp = Reek::Source::SourceCode.from('C = "hello"').syntax_tree
 
-        expect(exp.defines_module?).to be_falsey
+        expect(exp).not_to be_defines_module
       end
     end
   end