reek 4.7.3 → 4.8.0

data/spec/reek/smell_detectors/nested_iterators_spec.rb

@@ -223,7 +223,7 @@ RSpec.describe Reek::SmellDetectors::NestedIterators do
     expect(src).not_to reek_of(:NestedIterators)
   end
 
-  context 'setting the allowed nesting depth to 3' do
+  context 'when setting the allowed nesting depth to 3' do
     let(:config) do
       { Reek::SmellDetectors::NestedIterators::MAX_ALLOWED_NESTING_KEY => 3 }
     end

data/spec/reek/smell_detectors/uncommunicative_variable_name_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeVariableName do
       and reek_of(:UncommunicativeVariableName, lines: [3], name: 'y')
   end
 
-  context 'instance variables' do
+  context 'when examining instance variables' do
     it 'does not report use of one-letter names' do
       src = 'class Alfa; def bravo; @x; end; end'
       expect(src).not_to reek_of(:UncommunicativeVariableName)
@@ -41,7 +41,7 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeVariableName do
     end
   end
 
-  context 'local variables' do
+  context 'when examining local variables' do
     it 'does not report single underscore as a variable name' do
       src = 'def alfa; _ = bravo(); end'
       expect(src).not_to reek_of(:UncommunicativeVariableName)
@@ -78,7 +78,7 @@ RSpec.describe Reek::SmellDetectors::UncommunicativeVariableName do
     end
   end
 
-  context 'block parameters' do
+  context 'when examining block parameters' do
     it 'reports all relevant block parameters' do
       src = <<-EOS
         def alfa

data/spec/reek/smell_detectors/unused_parameters_spec.rb

@@ -61,7 +61,7 @@ RSpec.describe Reek::SmellDetectors::UnusedParameters do
     expect(src).not_to reek_of(:UnusedParameters)
   end
 
-  context 'using super' do
+  context 'when using super' do
     it 'reports nothing with implicit arguments' do
       src = 'def alfa(*bravo); super; end'
       expect(src).not_to reek_of(:UnusedParameters)
@@ -83,7 +83,7 @@ RSpec.describe Reek::SmellDetectors::UnusedParameters do
     end
   end
 
-  context 'anonymous parameters' do
+  context 'with anonymous parameters' do
     it 'reports nothing for unused anonymous parameter' do
       src = 'def alfa(_); end'
       expect(src).not_to reek_of(:UnusedParameters)
@@ -95,7 +95,7 @@ RSpec.describe Reek::SmellDetectors::UnusedParameters do
     end
   end
 
-  context 'splatted parameters' do
+  context 'with splatted parameters' do
     it 'reports nothing for used splatted parameter' do
       src = 'def alfa(*bravo); bravo; end'
       expect(src).not_to reek_of(:UnusedParameters)

data/spec/reek/smell_detectors/unused_private_method_spec.rb

@@ -38,7 +38,7 @@ RSpec.describe Reek::SmellDetectors::UnusedPrivateMethod do
       and reek_of(:UnusedPrivateMethod, lines: [7], name: 'charlie')
   end
 
-  context 'unused private methods' do
+  context 'when a class has unused private methods' do
     it 'reports instance methods' do
       source = <<-EOF
         class Alfa
@@ -116,7 +116,7 @@ RSpec.describe Reek::SmellDetectors::UnusedPrivateMethod do
     end
   end
 
-  describe 'configuring the detector via source code comment' do
+  context 'when the detector is configured via a source code comment' do
     it 'does not report methods we excluded' do
       source = <<-EOF
         # :reek:UnusedPrivateMethod: { exclude: [ bravo ] }
@@ -133,8 +133,8 @@ RSpec.describe Reek::SmellDetectors::UnusedPrivateMethod do
     end
   end
 
-  context 'used private methods' do
-    it 'are not reported' do
+  context 'when a class has only used private methods' do
+    it 'reports nothing' do
       source = <<-EOF
         class Alfa
           def bravo
@@ -150,8 +150,8 @@ RSpec.describe Reek::SmellDetectors::UnusedPrivateMethod do
     end
   end
 
-  context 'unused protected methods' do
-    it 'are not reported' do
+  context 'when a class has unused protected methods' do
+    it 'reports nothing' do
       source = <<-EOF
         class Alfa
           protected
@@ -163,8 +163,8 @@ RSpec.describe Reek::SmellDetectors::UnusedPrivateMethod do
     end
   end
 
-  context 'unused public methods' do
-    it 'are not reported' do
+  context 'when a class has unused public methods' do
+    it 'reports nothing' do
       source = <<-EOF
         class Alfa
           def bravo; end
@@ -175,7 +175,7 @@ RSpec.describe Reek::SmellDetectors::UnusedPrivateMethod do
     end
   end
 
-  describe 'prevent methods from being reported' do
+  describe 'preventing methods from being reported' do
     let(:source) do
       <<-EOF
         class Alfa

data/spec/reek/smell_detectors/utility_function_spec.rb

@@ -98,7 +98,7 @@ RSpec.describe Reek::SmellDetectors::UtilityFunction do
     expect(src).to reek_of(:UtilityFunction, context: 'simple')
   end
 
-  context 'Singleton methods' do
+  context 'when examining singleton methods' do
     ['class', 'module'].each do |scope|
       it "does not report for #{scope} with `class << self` notation" do
         src = "#{scope} Alfa; class << self; def bravo(charlie) charlie.to_s; end; end; end"
@@ -111,7 +111,7 @@ RSpec.describe Reek::SmellDetectors::UtilityFunction do
       end
     end
 
-    context 'by using `module_function`' do
+    context 'when defined by using `module_function`' do
       it 'does not report UtilityFunction also when using multiple arguments' do
         src = <<-EOS
           class Alfa
@@ -194,7 +194,7 @@ RSpec.describe Reek::SmellDetectors::UtilityFunction do
       { Reek::SmellDetectors::UtilityFunction::PUBLIC_METHODS_ONLY_KEY => true }
     end
 
-    context 'public methods' do
+    context 'when examining public methods' do
       it 'still reports UtilityFunction' do
         src = <<-EOS
           class Alfa
@@ -208,7 +208,7 @@ RSpec.describe Reek::SmellDetectors::UtilityFunction do
       end
     end
 
-    context 'private methods' do
+    context 'when examining private methods' do
       it 'does not report UtilityFunction' do
         src = <<-EOS
           class Alfa
@@ -235,7 +235,7 @@ RSpec.describe Reek::SmellDetectors::UtilityFunction do
       end
     end
 
-    context 'protected methods' do
+    context 'when examining protected methods' do
       it 'does not report UtilityFunction' do
         src = <<-EOS
           class Alfa

data/spec/reek/smell_warning_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe Reek::SmellWarning do
   let(:utility_function_detector) { build(:smell_detector, smell_type: 'UtilityFunction') }
   let(:uncommunicative_name_detector) { build(:smell_detector, smell_type: 'UncommunicativeVariableName') }
 
-  context 'sort order' do
+  describe 'sort order' do
     shared_examples_for 'first sorts ahead of second' do
       it 'hash differently' do
         expect(first.hash).not_to eq(second.hash)
@@ -26,21 +26,21 @@ RSpec.describe Reek::SmellWarning do
       end
     end
 
-    context 'smells differing only by detector' do
+    context 'when smells differ only by detector' do
       let(:first) { build(:smell_warning, smell_detector: duplication_detector) }
       let(:second) { build(:smell_warning, smell_detector: feature_envy_detector) }
 
       it_behaves_like 'first sorts ahead of second'
     end
 
-    context 'smells differing only by lines' do
+    context 'when smells differ only by lines' do
       let(:first) { build(:smell_warning, smell_detector: feature_envy_detector, lines: [2]) }
       let(:second) { build(:smell_warning, smell_detector: feature_envy_detector, lines: [3]) }
 
       it_behaves_like 'first sorts ahead of second'
     end
 
-    context 'smells differing only by context' do
+    context 'when smells differ only by context' do
       let(:first) { build(:smell_warning, smell_detector: duplication_detector, context: 'first') }
       let(:second) do
         build(:smell_warning, smell_detector: duplication_detector, context: 'second')
@@ -49,7 +49,7 @@ RSpec.describe Reek::SmellWarning do
       it_behaves_like 'first sorts ahead of second'
     end
 
-    context 'smells differing only by message' do
+    context 'when smells differ only by message' do
       let(:first) do
         build(:smell_warning, smell_detector: duplication_detector,
                               context: 'ctx', message: 'first message')
@@ -62,7 +62,7 @@ RSpec.describe Reek::SmellWarning do
       it_behaves_like 'first sorts ahead of second'
     end
 
-    context 'smell name takes precedence over message' do
+    context 'when smells differ by name and message' do
       let(:first) do
         build(:smell_warning, smell_detector: feature_envy_detector, message: 'second message')
       end
@@ -73,7 +73,7 @@ RSpec.describe Reek::SmellWarning do
       it_behaves_like 'first sorts ahead of second'
     end
 
-    context 'smells differing everywhere' do
+    context 'when smells differ everywhere' do
       let(:first) do
         build(:smell_warning, smell_detector: duplication_detector,
                               context: 'Dirty#a',
@@ -97,7 +97,7 @@ RSpec.describe Reek::SmellWarning do
     end
   end
 
-  context '#yaml_hash' do
+  describe '#yaml_hash' do
     let(:context_name) { 'Module::Class#method/block' }
     let(:lines) { [24, 513] }
     let(:message) { 'test message' }

data/spec/reek/source/source_code_spec.rb

@@ -39,33 +39,13 @@ RSpec.describe Reek::Source::SourceCode do
     end
   end
 
-  context 'with a source that triggers an encoding error' do
-    let(:source_name) { 'Bad source' }
-    let(:code) do
-      <<-SRC.strip_heredoc
-      # encoding: US-ASCII
-      puts 'こんにちは世界'
-      SRC
-    end
-    let(:src) { described_class.new(code: code, origin: source_name) }
-
-    it 'raises an encoding error' do
-      expect { src.syntax_tree }.to raise_error Reek::Errors::EncodingError
-    end
-
-    it 'explains the origin of the error' do
-      message = "Source '#{source_name}' cannot be processed by Reek due to an encoding error in the source file."
-      expect { src.syntax_tree }.to raise_error.with_message(/#{message}/)
-    end
-  end
-
   context 'when the parser fails' do
     let(:source_name) { 'Test source' }
-    let(:src) { described_class.new(code: code, origin: source_name, **parser) }
+    let(:src) { described_class.new(code: code, origin: source_name, **options) }
 
     context 'with a Parser::SyntaxError' do
       let(:code) { '== Invalid Syntax ==' }
-      let(:parser) { {} }
+      let(:options) { {} }
 
       it 'adds a diagnostic' do
         expect(src.diagnostics.size).to eq 2
@@ -76,8 +56,8 @@ RSpec.describe Reek::Source::SourceCode do
       let(:code) { '' }
       let(:error_class) { RuntimeError }
       let(:error_message) { 'An error' }
-      let(:parser) do
-        parser = instance_double('Parser::Ruby24')
+      let(:options) do
+        parser = instance_double('Parser::Ruby25')
         allow(parser).to receive(:parse_with_comments).and_raise(error_class, error_message)
         {
           parser: parser
@@ -85,7 +65,7 @@ RSpec.describe Reek::Source::SourceCode do
       end
 
       it 'raises the error' do
-        expect { src.valid_syntax? }.to raise_error error_class, error_message
+        expect { src.syntax_tree }.to raise_error error_class, error_message
       end
     end
   end

data/spec/reek/source/source_locator_spec.rb

@@ -5,7 +5,7 @@ require_lib 'reek/source/source_locator'
 
 RSpec.describe Reek::Source::SourceLocator do
   describe '#sources' do
-    context 'applied to hidden directories' do
+    context 'when applied to hidden directories' do
       let(:path) { SAMPLES_PATH.join('source_with_hidden_directories') }
 
       let(:expected_paths) do
@@ -30,7 +30,7 @@ RSpec.describe Reek::Source::SourceLocator do
     end
 
     # rubocop:disable RSpec/NestedGroups
-    context 'exclude paths' do
+    context 'with excluded paths' do
       let(:configuration) do
         test_configuration_for(CONFIG_PATH.join('with_excluded_paths.reek'))
       end
@@ -44,7 +44,7 @@ RSpec.describe Reek::Source::SourceLocator do
                             'uncommunicative_method_name.rb').expand_path
         end
 
-        context 'and options.force_exclusion? is true' do
+        context 'when options.force_exclusion? is true' do
           before do
             allow(options).to receive(:force_exclusion?).and_return(true)
           end
@@ -55,7 +55,7 @@ RSpec.describe Reek::Source::SourceLocator do
           end
         end
 
-        context 'and options.force_exclusion? is false' do
+        context 'when options.force_exclusion? is false' do
           before do
             allow(options).to receive(:force_exclusion?).and_return(false)
           end
@@ -120,7 +120,7 @@ RSpec.describe Reek::Source::SourceLocator do
     end
     # rubocop:enable RSpec/NestedGroups
 
-    context 'non-Ruby paths' do
+    context 'with non-Ruby paths' do
       let(:path) { SAMPLES_PATH.join('source_with_non_ruby_files') }
       let(:expected_sources) do
         [path.join('uncommunicative_parameter_name.rb')]
@@ -145,7 +145,7 @@ RSpec.describe Reek::Source::SourceLocator do
       end
     end
 
-    context 'passing "." or "./" as argument' do
+    context 'when passing "." or "./" as argument' do
       let(:expected_sources) do
         [Pathname.new('spec/spec_helper.rb'), Pathname.new('lib/reek.rb')]
       end

data/spec/reek/spec/should_reek_of_spec.rb

@@ -21,7 +21,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
   end
 
   describe 'different sources of input' do
-    context 'checking code in a string' do
+    context 'when checking code in a string' do
       let(:clean_code) { 'def good() true; end' }
       let(:matcher) { described_class.new(:UncommunicativeVariableName, name: 'y') }
       let(:smelly_code) { 'def x() y = 4; end' }
@@ -40,7 +40,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
       end
     end
 
-    context 'checking code in a File' do
+    context 'when checking code in a File' do
       let(:matcher) { described_class.new(:UncommunicativeMethodName, name: 'x') }
 
       it 'matches a smelly file' do
@@ -54,7 +54,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
   end
 
   describe 'smell types and smell details' do
-    context 'passing in smell_details with unknown parameter name' do
+    context 'when passing in smell_details with unknown parameter name' do
       let(:matcher) { described_class.new(:UncommunicativeVariableName, foo: 'y') }
       let(:smelly_code) { 'def x() y = 4; end' }
 
@@ -63,7 +63,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
       end
     end
 
-    context 'both are matching' do
+    context 'when both are matching' do
       let(:matcher) { described_class.new(:UncommunicativeVariableName, name: 'y') }
       let(:smelly_code) { 'def x() y = 4; end' }
 
@@ -72,7 +72,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
       end
     end
 
-    context 'no smell_type is matching' do
+    context 'when no smell_type is matching' do
       let(:smelly_code) { 'def dummy() y = 4; end' }
 
       let(:falsey_matcher) { described_class.new(:FeatureEnvy, name: 'y') }
@@ -97,7 +97,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
       end
     end
 
-    context 'smell type is matching but smell details are not' do
+    context 'when smell type is matching but smell details are not' do
       let(:smelly_code) { 'def double_thing() @other.thing.foo + @other.thing.foo end' }
       let(:matcher) { described_class.new(:DuplicateMethodCall, name: 'foo', count: 15) }
 
@@ -129,7 +129,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
     end
   end
 
-  context 'for a smell that is disabled by default' do
+  context 'with a smell that is disabled by default' do
     it 'enables the smell detector to match automatically' do
       default_config = Reek::SmellDetectors::UnusedPrivateMethod.default_config
       src = 'class C; private; def foo; end; end'

data/spec/reek/spec/should_reek_spec.rb

@@ -22,7 +22,7 @@ RSpec.describe Reek::Spec::ShouldReek do
   end
 
   describe 'checking code in a File' do
-    context 'matcher without masking' do
+    context 'without masking' do
       let(:matcher) { described_class.new }
 
       it 'matches a smelly File' do
@@ -39,7 +39,7 @@ RSpec.describe Reek::Spec::ShouldReek do
       end
     end
 
-    context 'matcher without masking' do
+    context 'with masking' do
       let(:path) { CONFIG_PATH.join('full_mask.reek') }
       let(:configuration) { test_configuration_for(path) }
       let(:matcher) { described_class.new(configuration: configuration) }

data/spec/reek/spec/smell_matcher_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Reek::Spec::SmellMatcher do
   end
   let(:matcher) { described_class.new(smell_warning) }
 
-  context '#matches?' do
+  describe '#matches?' do
     it 'matches on class symbol' do
       expect(matcher).to be_matches(:UncommunicativeVariableName)
     end
@@ -50,7 +50,7 @@ RSpec.describe Reek::Spec::SmellMatcher do
     end
   end
 
-  context '#matches_smell_type?' do
+  describe '#matches_smell_type?' do
     it 'matches on class symbol' do
       expect(matcher).to be_matches_smell_type(:UncommunicativeVariableName)
     end
@@ -60,7 +60,7 @@ RSpec.describe Reek::Spec::SmellMatcher do
     end
   end
 
-  context '#matches_attributes?' do
+  describe '#matches_attributes?' do
     it 'matches on params' do
       expect(matcher).to be_matches_attributes(test: 'something')
     end

data/spec/reek/tree_dresser_spec.rb

@@ -7,11 +7,13 @@ require_relative '../spec_helper'
 require_lib 'reek/tree_dresser'
 
 RSpec.describe Reek::TreeDresser do
-  let(:dresser) { described_class.new }
-  let(:sexp) do
-    Parser::Ruby22.parse('class Klazz; def meth(argument); argument.call_me; end; end')
-  end
-  let(:dressed_ast) do
+  describe '#dress' do
+    let(:dresser) { described_class.new }
+    let(:sexp) do
+      Parser::Ruby22.parse('class Klazz; def meth(argument); argument.call_me; end; end')
+    end
+    let(:dressed_ast) { dresser.dress(sexp, {}) }
+
     # The dressed AST looks like this:
     #   (class
     #     (const nil :Klazz) nil
@@ -20,14 +22,11 @@ RSpec.describe Reek::TreeDresser do
     #         (arg :argument))
     #       (send
     #         (lvar :argument) :call_me)))
-    dresser.dress(sexp, {})
-  end
-  let(:const_node) { dressed_ast.children.first }
-  let(:def_node) { dressed_ast.children.last }
-  let(:args_node) { def_node.children[1] }
-  let(:send_node) { def_node.children[2] }
+    let(:const_node) { dressed_ast.children.first }
+    let(:def_node) { dressed_ast.children.last }
+    let(:args_node) { def_node.children[1] }
+    let(:send_node) { def_node.children[2] }
 
-  context 'dresses the given sexp' do
     it 'dresses `const` nodes properly' do
       expect(const_node).to be_a Reek::AST::SexpExtensions::ConstNode
     end