reek 4.5.4 → 4.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 779579909e4877e391f86f92756b1ce1b45a3202
-  data.tar.gz: a7f30fb8db30c839c335c47be2eb00ce0f321bac
+  metadata.gz: f744d82cb65c9d8b3d9f360ed948e1bf7944299a
+  data.tar.gz: e74921da8bed3e617aeb1a80d9085f0876c80f38
 SHA512:
-  metadata.gz: 5e10d6f4cf3e8f9bc0cf499261647cd167eb5bed0296c97d79263408b4f82b371904da23927e6853ddf2d5643137a513b9f947ce2c3593f3b7b89d602baae21e
-  data.tar.gz: 8b3e07023d3001002650fd4489aa130d1350093f4e604ba3ee5a33fa71c916618f2fc14d037c5e4eb737823e64ebc054166db2b6643b0e832c906210e85fd6c6
+  metadata.gz: 04bc673256d4145a067b4cbe45d9d0d7a2bfd5170779a6ee2520dedc73ec09abbbad073e17d40dd2cbbd70dbab2f5ea297608a244b448fd71020c4525dc76cc9
+  data.tar.gz: d43b2c46f59d642e127edc26813058937e90ee10811ca5484f6487f2a2908c3bd313a53317a7c00c166b4553d54dbb35b894cc7d8dc9d068fcd3f34c0fe98052

data/.rubocop.yml

@@ -12,6 +12,11 @@ Lint/HandleExceptions:
   Exclude:
     - 'spec/reek/configuration/configuration_file_finder_spec.rb'
 
+# Spec blocks can be any size
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
 # FIXME: Make the class shorter
 Metrics/ClassLength:
   Exclude:
@@ -44,6 +49,12 @@ RSpec/DescribeClass:
 RSpec/ExampleLength:
   Enabled: false
 
+# FIXME: Find a better way to block output during specs, and fix relevant examples.
+RSpec/ExpectOutput:
+  Exclude:
+    - 'spec/reek/cli/command/todo_list_command_spec.rb'
+    - 'spec/reek/source/source_code_spec.rb'
+
 # FIXME: Split up files to avoid offenses
 RSpec/MultipleDescribes:
   Exclude:
@@ -65,7 +76,6 @@ RSpec/MultipleExpectations:
 
 # FIXME: Update specs to avoid offenses
 RSpec/NestedGroups:
-  MaxNesting: 3
   Exclude:
     - 'spec/reek/cli/application_spec.rb'
 

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change log
 
+## 4.5.5 (2017-02-05)
+
+* (mvz) Load YAML in code comments safely
+* (mvz) Combine lines for manual dispatch smells
+* (mvz) Respect exclude_paths when passing sources on the command line
+* (mvz) Ensure explicit arguments of super() are processed
+
 ## 4.5.4 (2017-01-17)
 
 * (troessner) Improve documentation and fix PrimaDonnaMethod detector configuration via comment.

data/Gemfile

@@ -17,8 +17,8 @@ group :development do
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.46.0'
-    gem 'rubocop-rspec', '~> 1.9.0'
+    gem 'rubocop',       '~> 0.47.1'
+    gem 'rubocop-rspec', '~> 1.10.0'
   end
 
   platforms :mri do

data/features/configuration_files/exclude_paths_directives.feature

@@ -0,0 +1,24 @@
+Feature: Exclude paths directives
+  In order to avoid Reek wasting time on files that cannot be fixed
+  As a user
+  I want to be able to exclude specific paths from being checked
+
+  Scenario: Exclude some paths
+    Given a file named "bad_files_live_here/smelly.rb" with:
+      """
+      # A smelly example class
+      class Smelly
+        def alfa(bravo); end
+      end
+      """
+    When I run `reek .`
+    Then the exit status indicates smells
+    Given a file named "config.reek" with:
+      """
+      ---
+      exclude_paths:
+        - bad_files_live_here
+      """
+    When I run `reek -c config.reek .`
+    Then it succeeds
+    And it reports nothing

data/features/samples.feature

@@ -63,7 +63,7 @@ Feature: Basic smell detection
       UncommunicativeVariableName: Inline::C#module_name has the variable name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       UncommunicativeVariableName: Inline::C#parse_signature has the variable name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       UtilityFunction: Inline::C#strip_comments doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    optparse.rb -- 130 warnings:
+    optparse.rb -- 126 warnings:
       Attribute: OptionParser#banner is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: OptionParser#default_argv is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: OptionParser#program_name is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -127,10 +127,6 @@ Feature: Basic smell detection
       LongParameterList: OptionParser::Switch#initialize has 7 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       LongParameterList: OptionParser::Switch#summarize has 5 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       ManualDispatch: OptionParser#make_switch manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
-      ManualDispatch: OptionParser#make_switch manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
-      ManualDispatch: OptionParser#make_switch manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
-      ManualDispatch: OptionParser::List#accept manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
-      ManualDispatch: OptionParser::List#accept manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
       ManualDispatch: OptionParser::List#accept manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
       ManualDispatch: OptionParser::List#add_banner manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
       ManualDispatch: OptionParser::List#summarize manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
@@ -194,7 +190,7 @@ Feature: Basic smell detection
       UnusedParameters: OptionParser::Completion#convert has unused parameter 'opt' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::NoArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
-    redcloth.rb -- 111 warnings:
+    redcloth.rb -- 110 warnings:
       Attribute: RedCloth#filter_html is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#filter_styles is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#hard_breaks is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -238,7 +234,6 @@ Feature: Basic smell detection
       LongParameterList: RedCloth#textile_fn_ has 5 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       LongParameterList: RedCloth#textile_p has 4 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       ManualDispatch: RedCloth#block_textile_prefix manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
-      ManualDispatch: RedCloth#block_textile_prefix manually dispatches method call [https://github.com/troessner/reek/blob/master/docs/Manual-Dispatch.md]
       NestedIterators: RedCloth#block_textile_lists contains iterators nested 3 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NestedIterators: RedCloth#block_textile_table contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NestedIterators: RedCloth#block_textile_table contains iterators nested 3 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
@@ -306,5 +301,5 @@ Feature: Basic smell detection
       UtilityFunction: RedCloth#lT doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#no_textile doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#v_align doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    292 total warnings
+    287 total warnings
     """

data/features/step_definitions/reek_steps.rb

@@ -46,8 +46,8 @@ Then /^it reports:$/ do |report|
 end
 
 Then /^it reports this yaml:$/ do |expected_yaml|
-  expected_warnings = YAML.load(expected_yaml.chomp)
-  actual_warnings = YAML.load(last_command_started.stdout)
+  expected_warnings = YAML.safe_load(expected_yaml.chomp)
+  actual_warnings = YAML.safe_load(last_command_started.stdout)
   expect(actual_warnings).to eq expected_warnings
 end
 

data/lib/reek/cli/application.rb

@@ -85,7 +85,7 @@ module Reek
       end
 
       def sources_from_argv
-        Source::SourceLocator.new(argv).sources
+        Source::SourceLocator.new(argv, configuration: configuration).sources
       end
 
       def source_from_pipe

data/lib/reek/code_comment.rb

@@ -46,7 +46,8 @@ module Reek
                                  line:             line,
                                  source:           source,
                                  options:          options).validate
-        @config.merge! detector_name => YAML.load(options || DISABLE_DETECTOR_CONFIGURATION)
+        @config.merge! detector_name => YAML.safe_load(options || DISABLE_DETECTOR_CONFIGURATION,
+                                                       [Regexp])
       end
     end
 
@@ -130,7 +131,8 @@ module Reek
       end
 
       def escalate_bad_detector_configuration
-        @parsed_options = YAML.load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION)
+        @parsed_options = YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
+                                         [Regexp])
       rescue Psych::SyntaxError
         raise Errors::GarbageDetectorConfigurationInCommentError, detector_name: detector_name,
                                                                   original_comment: original_comment,

data/lib/reek/context_builder.rb

@@ -248,8 +248,9 @@ module Reek
     #
     # We record one reference to `self`.
     #
-    def process_super(_)
+    def process_super(exp)
       current_context.record_use_of_self
+      process(exp)
     end
 
     # Handles `block` nodes.

data/lib/reek/smell_detectors/manual_dispatch.rb

@@ -20,11 +20,10 @@ module Reek
       #
       # :reek:FeatureEnvy
       def sniff(ctx)
-        ctx.each_node(:send).flat_map do |node|
-          next unless node.name.equal?(:respond_to?)
-
-          smell_warning(context: ctx, lines: [node.line], message: MESSAGE)
-        end.compact
+        smelly_nodes = ctx.each_node(:send).select { |node| node.name == :respond_to? }
+        return [] if smelly_nodes.empty?
+        lines = smelly_nodes.map(&:line)
+        [smell_warning(context: ctx, lines: lines, message: MESSAGE)]
       end
     end
   end

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.5.4'.freeze
+    STRING = '4.5.5'.freeze
   end
 end

data/spec/quality/reek_source_spec.rb

@@ -1,9 +1,11 @@
 require_relative '../spec_helper'
 
 RSpec.describe 'Reek source code' do
-  it 'has no smells' do
-    Pathname.glob('lib/**/*.rb').each do |pathname|
-      expect(pathname).not_to reek
+  Pathname.glob('lib/**/*.rb').each do |pathname|
+    describe pathname do
+      it 'has no smells' do
+        expect(pathname).not_to reek
+      end
     end
   end
 end

data/spec/reek/cli/application_spec.rb

@@ -100,6 +100,30 @@ RSpec.describe Reek::CLI::Application do
                configuration: Reek::Configuration::AppConfiguration,
                options: Reek::CLI::Options)
       end
+
+      context 'when source files are excluded through configuration' do
+        let(:app) { described_class.new ['--config', 'some_file.reek', '.'] }
+
+        before do
+          allow(Reek::Configuration::AppConfiguration).
+            to receive(:from_path).
+            with(Pathname.new('some_file.reek')).
+            and_return configuration
+        end
+
+        it 'uses configuration for excluded paths' do
+          expected_sources = Reek::Source::SourceLocator.
+            new(['.'], configuration: configuration).sources
+          expect(expected_sources).not_to include(path_excluded_in_configuration)
+
+          app.execute
+
+          expect(Reek::CLI::Command::ReportCommand).to have_received(:new).
+            with(sources: expected_sources,
+                 configuration: configuration,
+                 options: Reek::CLI::Options)
+        end
+      end
     end
   end
 end

data/spec/reek/code_comment_spec.rb

@@ -161,6 +161,13 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
           FactoryGirl.build(:code_comment, comment: comment)
         end.not_to raise_error
       end
+
+      it 'does not raise on regexps' do
+        expect do
+          comment = '# :reek:UncommunicativeMethodName { exclude: !ruby/regexp /alfa/ }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.not_to raise_error
+      end
     end
 
     context 'unknown custom options' do

data/spec/reek/report/yaml_report_spec.rb

@@ -30,8 +30,8 @@ RSpec.describe Reek::Report::YAMLReport do
       out = StringIO.new
       instance.show(out)
       out.rewind
-      result = YAML.load(out.read)
-      expected = YAML.load <<-EOS
+      result = YAML.safe_load(out.read)
+      expected = YAML.safe_load <<-EOS
 ---
 - context:        "simple"
   lines:
@@ -57,8 +57,8 @@ RSpec.describe Reek::Report::YAMLReport do
         out = StringIO.new
         instance.show(out)
         out.rewind
-        result = YAML.load(out.read)
-        expected = YAML.load <<-EOS
+        result = YAML.safe_load(out.read)
+        expected = YAML.safe_load <<-EOS
 ---
 - context:        "simple"
   lines:

data/spec/reek/smell_detectors/feature_envy_spec.rb

@@ -97,11 +97,16 @@ RSpec.describe Reek::SmellDetectors::FeatureEnvy do
     expect(src).not_to reek_of(:FeatureEnvy)
   end
 
-  it 'does not report parameter method called with super ' do
+  it 'does not report parameter method called with super' do
     src = 'def alfa(bravo) super(bravo.to_s); end'
     expect(src).not_to reek_of(:FeatureEnvy)
   end
 
+  it 'reports parameter method called with super and elsewhere' do
+    src = 'def alfa(bravo) bravo.charley; super(bravo.to_s); end'
+    expect(src).to reek_of(:FeatureEnvy)
+  end
+
   it 'ignores multiple ivars' do
     src = <<-EOS
       def func
@@ -147,7 +152,7 @@ RSpec.describe Reek::SmellDetectors::FeatureEnvy do
       and reek_of(:FeatureEnvy, name: 'bravo')
   end
 
-  it 'is not be fooled by duplication' do
+  it 'is not fooled by duplication' do
     src = <<-EOS
       def alfa(bravo)
         @charlie.delta(bravo.echo)
@@ -155,18 +160,18 @@ RSpec.describe Reek::SmellDetectors::FeatureEnvy do
       end
     EOS
 
-    expect(src).to reek_only_of(:DuplicateMethodCall)
+    expect(src).to reek_only_of(:DuplicateMethodCall, name: 'bravo.echo')
   end
 
-  it 'does not count local calls' do
+  it 'counts local calls' do
     src = <<-EOS
       def alfa(bravo)
-        @charlie.delta(bravo.echo)
-        @foxtrot.delta(bravo.echo)
+        charlie.delta(bravo.echo)
+        foxtrot.delta(bravo.echo)
       end
     EOS
 
-    expect(src).to reek_only_of(:DuplicateMethodCall)
+    expect(src).to reek_only_of(:DuplicateMethodCall, name: 'bravo.echo')
   end
 
   it 'reports many calls to lvar' do

data/spec/reek/smell_detectors/manual_dispatch_spec.rb

@@ -59,4 +59,17 @@ RSpec.describe Reek::SmellDetectors::ManualDispatch do
 
     expect(src).to reek_of(:ManualDispatch)
   end
+
+  it 'reports occurences in a single method as one smell warning' do
+    src = <<-EOS
+      class Alfa
+        def bravo(charlie, delta)
+          return true if charlie.respond_to?(:to_a)
+          true if delta.respond_to?(:to_a)
+        end
+      end
+    EOS
+
+    expect(src).to reek_of(:ManualDispatch, lines: [3, 4], context: 'Alfa#bravo')
+  end
 end

data/spec/reek/smell_detectors/nested_iterators_spec.rb

@@ -155,7 +155,7 @@ RSpec.describe Reek::SmellDetectors::NestedIterators do
   it 'handles the case where super receives a block and arguments' do
     src = <<-EOS
       def alfa
-        super do |bravo|
+        super(delta) do |bravo|
           bravo.each { |charlie| charlie }
         end
       end

data/spec/reek/smell_detectors/subclassed_from_core_class_spec.rb

@@ -45,11 +45,6 @@ RSpec.describe Reek::SmellDetectors::SubclassedFromCoreClass do
     expect(src).not_to reek_of(:SubclassedFromCoreClass)
   end
 
-  it 'reports if we inherit from a core class using Class#new' do
-    src = 'Alfa = Class.new(Array)'
-    expect(src).to reek_of(:SubclassedFromCoreClass)
-  end
-
   it 'reports if inner class inherit from a core class' do
     src = <<-EOS
       class Alfa

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.5.4
+  version: 4.5.5
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -151,6 +151,7 @@ files:
 - features/configuration_files/accept_setting.feature
 - features/configuration_files/directory_specific_directives.feature
 - features/configuration_files/exclude_directives.feature
+- features/configuration_files/exclude_paths_directives.feature
 - features/configuration_files/masking_smells.feature
 - features/configuration_files/mix_accept_reject_setting.feature
 - features/configuration_files/reject_setting.feature
@@ -434,7 +435,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby