reek 4.7.3 → 5.0.0

data/spec/reek/report/code_climate/code_climate_fingerprint_spec.rb

@@ -5,42 +5,42 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
   describe '#compute' do
     let(:computed) { described_class.new(warning).compute }
 
-    shared_examples_for 'computes a fingerprint with no parameters' do
+    context 'when fingerprinting a warning with no parameters' do
       let(:expected_fingerprint) { 'e68badd29db51c92363a7c6a2438d722' }
       let(:warning) do
-        FactoryGirl.build(:smell_warning,
-                          smell_detector: Reek::SmellDetectors::UtilityFunction.new,
-                          context:        'alfa',
-                          message:        "doesn't depend on instance state (maybe move it to another class?)",
-                          lines:          lines,
-                          source:         'a/ruby/source/file.rb')
+        build(:smell_warning,
+              smell_detector: Reek::SmellDetectors::UtilityFunction.new,
+              context:        'alfa',
+              message:        "doesn't depend on instance state (maybe move it to another class?)",
+              lines:          lines,
+              source:         'a/ruby/source/file.rb')
       end
 
-      it 'computes the fingerprint' do
-        expect(computed).to eq expected_fingerprint
-      end
-    end
-
-    context 'with code at a specific location' do
-      let(:lines) { [1] }
+      context 'with code at a specific location' do
+        let(:lines) { [1] }
 
-      it_behaves_like 'computes a fingerprint with no parameters'
-    end
+        it 'computes the fingerprint' do
+          expect(computed).to eq expected_fingerprint
+        end
+      end
 
-    context 'with code at a different location' do
-      let(:lines) { [5] }
+      context 'with code at a different location' do
+        let(:lines) { [5] }
 
-      it_behaves_like 'computes a fingerprint with no parameters'
+        it 'computes the same fingerprint' do
+          expect(computed).to eq expected_fingerprint
+        end
+      end
     end
 
     context 'when the fingerprint should not be computed' do
       let(:warning) do
-        FactoryGirl.build(:smell_warning,
-                          smell_detector: Reek::SmellDetectors::ManualDispatch.new,
-                          context:        'Alfa#bravo',
-                          message:        'manually dispatches method call',
-                          lines:          [4],
-                          source:         'a/ruby/source/file.rb')
+        build(:smell_warning,
+              smell_detector: Reek::SmellDetectors::ManualDispatch.new,
+              context:        'Alfa#bravo',
+              message:        'manually dispatches method call',
+              lines:          [4],
+              source:         'a/ruby/source/file.rb')
       end
 
       it 'returns nil' do
@@ -48,77 +48,79 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
       end
     end
 
-    shared_examples_for 'computes a fingerprint with identifying parameters' do
+    context 'when the smell warning has only identifying parameters' do
       let(:warning) do
-        FactoryGirl.build(:smell_warning,
-                          smell_detector: Reek::SmellDetectors::ClassVariable.new,
-                          context:        'Alfa',
-                          message:        "declares the class variable '@@#{name}'",
-                          lines:          [4],
-                          parameters:     { name: "@@#{name}" },
-                          source:         'a/ruby/source/file.rb')
+        build(:smell_warning,
+              smell_detector: Reek::SmellDetectors::ClassVariable.new,
+              context:        'Alfa',
+              message:        "declares the class variable '@@#{name}'",
+              lines:          [4],
+              parameters:     { name: "@@#{name}" },
+              source:         'a/ruby/source/file.rb')
       end
 
-      it 'computes the fingerprint' do
-        expect(computed).to eq expected_fingerprint
-      end
-    end
+      context 'when the name is one thing' do
+        let(:name) { 'bravo' }
+        let(:expected_fingerprint) { '9c3fd378178118a67e9509f87cae24f9' }
 
-    context 'when the name is one thing it has one fingerprint' do
-      let(:name) { 'bravo' }
-      let(:expected_fingerprint) { '9c3fd378178118a67e9509f87cae24f9' }
-
-      it_behaves_like 'computes a fingerprint with identifying parameters'
-    end
+        it 'computes the fingerprint' do
+          expect(computed).to eq expected_fingerprint
+        end
+      end
 
-    context 'when the name is another thing it has another fingerprint' do
-      let(:name) { 'echo' }
-      let(:expected_fingerprint) { 'd2a6d2703ce04cca65e7300b7de4b89f' }
+      context 'when the name is another thing' do
+        let(:name) { 'echo' }
+        let(:expected_fingerprint) { 'd2a6d2703ce04cca65e7300b7de4b89f' }
 
-      it_behaves_like 'computes a fingerprint with identifying parameters'
+        it 'computes another fingerprint' do
+          expect(computed).to eq expected_fingerprint
+        end
+      end
     end
 
-    shared_examples_for 'computes a fingerprint with identifying and non-identifying parameters' do
+    context 'when the smell warning has identifying and non-identifying parameters' do
       let(:warning) do
-        FactoryGirl.build(:smell_warning,
-                          smell_detector: Reek::SmellDetectors::DuplicateMethodCall.new,
-                          context:        "Alfa##{name}",
-                          message:        "calls '#{name}' #{count} times",
-                          lines:          lines,
-                          parameters:     { name: "@@#{name}", count: count },
-                          source:         'a/ruby/source/file.rb')
+        build(:smell_warning,
+              smell_detector: Reek::SmellDetectors::DuplicateMethodCall.new,
+              context:        "Alfa##{name}",
+              message:        "calls '#{name}' #{count} times",
+              lines:          lines,
+              parameters:     { name: "@@#{name}", count: count },
+              source:         'a/ruby/source/file.rb')
       end
 
-      it 'computes the fingerprint' do
-        expect(computed).to eq expected_fingerprint
-      end
-    end
-
-    context 'when the parameters are provided' do
-      let(:name) { 'bravo' }
-      let(:count) { 5 }
-      let(:lines) { [1, 7, 10, 13, 15] }
-      let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
+      context 'when the parameters are provided' do
+        let(:name) { 'bravo' }
+        let(:count) { 5 }
+        let(:lines) { [1, 7, 10, 13, 15] }
+        let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
 
-      it_behaves_like 'computes a fingerprint with identifying and non-identifying parameters'
-    end
+        it 'computes the fingerprint' do
+          expect(computed).to eq expected_fingerprint
+        end
+      end
 
-    context 'when the non-identifying parameters change, it computes the same fingerprint' do
-      let(:name) { 'bravo' }
-      let(:count) { 9 }
-      let(:lines) { [1, 7, 10, 13, 15, 17, 19, 20, 25] }
-      let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
+      context 'when the non-identifying parameters change' do
+        let(:name) { 'bravo' }
+        let(:count) { 9 }
+        let(:lines) { [1, 7, 10, 13, 15, 17, 19, 20, 25] }
+        let(:expected_fingerprint) { '238733f4f51ba5473dcbe94a43ec5400' }
 
-      it_behaves_like 'computes a fingerprint with identifying and non-identifying parameters'
-    end
+        it 'computes the same fingerprint' do
+          expect(computed).to eq expected_fingerprint
+        end
+      end
 
-    context 'but when the identifying parameters change, it computes a different fingerprint' do
-      let(:name) { 'echo' }
-      let(:count) { 5 }
-      let(:lines) { [1, 7, 10, 13, 15] }
-      let(:expected_fingerprint) { 'e0c35e9223cc19bdb9a04fb3e60573e1' }
+      context 'when the identifying parameters change' do
+        let(:name) { 'echo' }
+        let(:count) { 5 }
+        let(:lines) { [1, 7, 10, 13, 15] }
+        let(:expected_fingerprint) { 'e0c35e9223cc19bdb9a04fb3e60573e1' }
 
-      it_behaves_like 'computes a fingerprint with identifying and non-identifying parameters'
+        it 'computes a different fingerprint' do
+          expect(computed).to eq expected_fingerprint
+        end
+      end
     end
   end
 end

data/spec/reek/report/code_climate/code_climate_formatter_spec.rb

@@ -4,12 +4,12 @@ require_lib 'reek/report/code_climate/code_climate_formatter'
 RSpec.describe Reek::Report::CodeClimateFormatter do
   describe '#render' do
     let(:warning) do
-      FactoryGirl.build(:smell_warning,
-                        smell_detector: Reek::SmellDetectors::UtilityFunction.new,
-                        context:        'context foo',
-                        message:        'message bar',
-                        lines:          [1, 2],
-                        source:         'a/ruby/source/file.rb')
+      build(:smell_warning,
+            smell_detector: Reek::SmellDetectors::UtilityFunction.new,
+            context:        'context foo',
+            message:        'message bar',
+            lines:          [1, 2],
+            source:         'a/ruby/source/file.rb')
     end
     let(:rendered) { described_class.new(warning).render }
     let(:json) { JSON.parse rendered.chop }

data/spec/reek/report/json_report_spec.rb

@@ -1,7 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/json_report'
-require_lib 'reek/report/formatter'
 
 require 'json'
 require 'stringio'
@@ -34,58 +33,26 @@ RSpec.describe Reek::Report::JSONReport do
       expected = JSON.parse <<-EOS
         [
           {
-            "context":        "simple",
-            "lines":          [1],
-            "message":        "has the parameter name 'a'",
-            "smell_type":     "UncommunicativeParameterName",
-            "source":         "string",
-            "name":           "a"
+            "context":            "simple",
+            "lines":              [1],
+            "message":            "has the parameter name 'a'",
+            "smell_type":         "UncommunicativeParameterName",
+            "source":             "string",
+            "name":               "a",
+            "documentation_link": "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Uncommunicative-Parameter-Name.md"
           },
           {
-            "context":        "simple",
-            "lines":          [1],
-            "message":        "doesn't depend on instance state (maybe move it to another class?)",
-            "smell_type":     "UtilityFunction",
-            "source":         "string"
+            "context":            "simple",
+            "lines":              [1],
+            "message":            "doesn't depend on instance state (maybe move it to another class?)",
+            "smell_type":         "UtilityFunction",
+            "source":             "string",
+            "documentation_link": "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
           }
         ]
       EOS
 
       expect(result).to eq expected
     end
-
-    context 'with link formatter' do
-      let(:options) { { warning_formatter: Reek::Report::Formatter::WikiLinkWarningFormatter.new } }
-
-      it 'prints documentation links' do
-        out = StringIO.new
-        instance.show(out)
-        out.rewind
-        result = JSON.parse(out.read)
-        expected = JSON.parse <<-EOS
-          [
-            {
-              "context":        "simple",
-              "lines":          [1],
-              "message":        "has the parameter name 'a'",
-              "smell_type":     "UncommunicativeParameterName",
-              "source":         "string",
-              "name":           "a",
-              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
-            },
-            {
-              "context":        "simple",
-              "lines":          [1],
-              "message":        "doesn't depend on instance state (maybe move it to another class?)",
-              "smell_type":     "UtilityFunction",
-              "source":         "string",
-              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
-            }
-          ]
-        EOS
-
-        expect(result).to eq expected
-      end
-    end
   end
 end

data/spec/reek/report/{formatter/location_formatter_spec.rb → location_formatter_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/report/formatter'
+require_relative '../../spec_helper'
+require_lib 'reek/report/location_formatter'
 
-RSpec.describe Reek::Report::Formatter::BlankLocationFormatter do
+RSpec.describe Reek::Report::BlankLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do
@@ -11,7 +11,7 @@ RSpec.describe Reek::Report::Formatter::BlankLocationFormatter do
   end
 end
 
-RSpec.describe Reek::Report::Formatter::DefaultLocationFormatter do
+RSpec.describe Reek::Report::DefaultLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do
@@ -21,7 +21,7 @@ RSpec.describe Reek::Report::Formatter::DefaultLocationFormatter do
   end
 end
 
-RSpec.describe Reek::Report::Formatter::SingleLineLocationFormatter do
+RSpec.describe Reek::Report::SingleLineLocationFormatter do
   let(:warning) { build(:smell_warning, lines: [11, 9, 250, 100]) }
 
   describe '.format' do

data/spec/reek/report/{formatter/progress_formatter_spec.rb → progress_formatter_spec.rb}

@@ -1,7 +1,7 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/report/formatter/progress_formatter'
+require_relative '../../spec_helper'
+require_lib 'reek/report/progress_formatter'
 
-RSpec.describe Reek::Report::Formatter::ProgressFormatter::Dots do
+RSpec.describe Reek::Report::ProgressFormatter::Dots do
   let(:sources_count) { 23 }
   let(:formatter) { described_class.new(sources_count) }
 
@@ -37,7 +37,7 @@ RSpec.describe Reek::Report::Formatter::ProgressFormatter::Dots do
   end
 end
 
-RSpec.describe Reek::Report::Formatter::ProgressFormatter::Quiet do
+RSpec.describe Reek::Report::ProgressFormatter::Quiet do
   let(:sources_count) { 23 }
   let(:formatter) { described_class.new(sources_count) }
 

data/spec/reek/report/text_report_spec.rb

@@ -1,15 +1,15 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/text_report'
-require_lib 'reek/report/formatter'
+require_lib 'reek/report/heading_formatter'
+require_lib 'reek/report/simple_warning_formatter'
 require 'rainbow'
 
 RSpec.describe Reek::Report::TextReport do
   let(:report_options) do
     {
-      warning_formatter: Reek::Report::Formatter::SimpleWarningFormatter.new,
-      report_formatter: Reek::Report::Formatter,
-      heading_formatter: Reek::Report::Formatter::QuietHeadingFormatter
+      warning_formatter: Reek::Report::SimpleWarningFormatter.new,
+      heading_formatter: Reek::Report::QuietHeadingFormatter
     }
   end
   let(:instance) { described_class.new report_options }

data/spec/reek/report/xml_report_spec.rb

@@ -5,7 +5,7 @@ require_lib 'reek/report/xml_report'
 RSpec.describe Reek::Report::XMLReport do
   let(:xml_report) { described_class.new }
 
-  context 'empty source' do
+  context 'with an empty source' do
     it 'prints empty checkstyle XML' do
       xml_report.add_examiner Reek::Examiner.new('')
       xml = "<?xml version='1.0'?>\n<checkstyle/>\n"
@@ -13,10 +13,10 @@ RSpec.describe Reek::Report::XMLReport do
     end
   end
 
-  context 'source with voliations' do
+  context 'with a source with violations' do
     it 'prints non-empty checkstyle XML' do
       xml_report.add_examiner Reek::Examiner.new(SMELLY_FILE)
-      xml = SAMPLES_PATH.join('checkstyle.xml').read
+      xml = SAMPLES_DIR.join('checkstyle.xml').read
       xml = xml.gsub(SMELLY_FILE.to_s, SMELLY_FILE.expand_path.to_s)
       expect { xml_report.show }.to output(xml).to_stdout
     end

data/spec/reek/report/yaml_report_spec.rb

@@ -1,7 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/yaml_report'
-require_lib 'reek/report/formatter'
 
 require 'yaml'
 require 'stringio'
@@ -36,49 +35,21 @@ RSpec.describe Reek::Report::YAMLReport do
         - context:        "simple"
           lines:
           - 1
-          message:        "has the parameter name 'a'"
-          smell_type:     "UncommunicativeParameterName"
-          source:         "string"
-          name:           "a"
+          message:            "has the parameter name 'a'"
+          smell_type:         "UncommunicativeParameterName"
+          source:             "string"
+          name:               "a"
+          documentation_link: "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Uncommunicative-Parameter-Name.md"
         - context:        "simple"
           lines:
           - 1
-          message:        "doesn't depend on instance state (maybe move it to another class?)"
-          smell_type:     "UtilityFunction"
-          source:         "string"
+          message:            "doesn't depend on instance state (maybe move it to another class?)"
+          smell_type:         "UtilityFunction"
+          source:             "string"
+          documentation_link: "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
       EOS
 
       expect(result).to eq expected
     end
-    context 'with link formatter' do
-      let(:options) { { warning_formatter: Reek::Report::Formatter::WikiLinkWarningFormatter.new } }
-
-      it 'prints documentation links' do
-        out = StringIO.new
-        instance.show(out)
-        out.rewind
-        result = YAML.safe_load(out.read)
-        expected = YAML.safe_load <<-EOS.strip_heredoc
-          ---
-          - context:        "simple"
-            lines:
-            - 1
-            message:        "has the parameter name 'a'"
-            smell_type:     "UncommunicativeParameterName"
-            source:         "string"
-            name:           "a"
-            wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
-          - context:        "simple"
-            lines:
-            - 1
-            message:        "doesn't depend on instance state (maybe move it to another class?)"
-            smell_type:     "UtilityFunction"
-            source:         "string"
-            wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
-        EOS
-
-        expect(result).to eq expected
-      end
-    end
   end
 end

data/spec/reek/report_spec.rb

@@ -10,19 +10,19 @@ RSpec.describe Reek::Report do
 
   describe '.location_formatter' do
     it 'returns the correct class' do
-      expect(described_class.location_formatter(:plain)).to eq Reek::Report::Formatter::BlankLocationFormatter
+      expect(described_class.location_formatter(:plain)).to eq Reek::Report::BlankLocationFormatter
     end
   end
 
   describe '.heading_formatter' do
     it 'returns the correct class' do
-      expect(described_class.heading_formatter(:quiet)).to eq Reek::Report::Formatter::QuietHeadingFormatter
+      expect(described_class.heading_formatter(:quiet)).to eq Reek::Report::QuietHeadingFormatter
     end
   end
 
   describe '.warning_formatter_class' do
     it 'returns the correct class' do
-      expect(described_class.warning_formatter_class(:simple)).to eq Reek::Report::Formatter::SimpleWarningFormatter
+      expect(described_class.warning_formatter_class(:simple)).to eq Reek::Report::SimpleWarningFormatter
     end
   end
 end

data/spec/reek/smell_detectors/boolean_parameter_spec.rb

@@ -27,7 +27,7 @@ RSpec.describe Reek::SmellDetectors::BooleanParameter do
       and reek_of(:BooleanParameter, lines: [1], context: 'alfa', parameter: 'charlie')
   end
 
-  context 'in a method' do
+  context 'when examining an instance method' do
     it 'reports a parameter defaulted to false' do
       src = 'def alfa(bravo = false) end'
       expect(src).to reek_of(:BooleanParameter)
@@ -70,7 +70,7 @@ RSpec.describe Reek::SmellDetectors::BooleanParameter do
     end
   end
 
-  context 'in a singleton method' do
+  context 'when examining a singleton method' do
     it 'reports a parameter defaulted to true' do
       src = 'def self.alfa(bravo = true) end'
       expect(src).to reek_of(:BooleanParameter)

data/spec/reek/smell_detectors/class_variable_spec.rb

@@ -63,49 +63,43 @@ RSpec.describe Reek::SmellDetectors::ClassVariable do
   end
 
   ['class', 'module'].each do |scope|
-    context "Scoped to #{scope}" do
-      context 'set in a method' do
-        it 'reports correctly' do
-          src = <<-EOS
-            #{scope} Alfa
-              def bravo
-                @@charlie = {}
-              end
+    context "when examining a #{scope}" do
+      it 'reports a class variable set in a method' do
+        src = <<-EOS
+          #{scope} Alfa
+            def bravo
+              @@charlie = {}
             end
-          EOS
+          end
+        EOS
 
-          expect(src).to reek_of(:ClassVariable)
-        end
+        expect(src).to reek_of(:ClassVariable, name: '@@charlie')
       end
 
-      context 'used in a method' do
-        it 'reports correctly' do
-          src = <<-EOS
-            #{scope} Alfa
-              def bravo
-                puts @@charlie
-              end
+      it 'reports a class variable used in a method' do
+        src = <<-EOS
+          #{scope} Alfa
+            def bravo
+              puts @@charlie
             end
-          EOS
+          end
+        EOS
 
-          expect(src).to reek_of(:ClassVariable)
-        end
+        expect(src).to reek_of(:ClassVariable, name: '@@charlie')
       end
 
-      context "set in #{scope} and used in a method" do
-        it 'reports correctly' do
-          src = <<-EOS
-            #{scope} Alfa
-              @@bravo = 42
+      it "reports a class variable set in the #{scope} body and used in a method" do
+        src = <<-EOS
+          #{scope} Alfa
+            @@bravo = 42
 
-              def charlie
-                puts @@bravo
-              end
+            def charlie
+              puts @@bravo
             end
-          EOS
+          end
+        EOS
 
-          expect(src).to reek_of(:ClassVariable)
-        end
+        expect(src).to reek_of(:ClassVariable, name: '@@bravo')
       end
     end
   end

data/spec/reek/smell_detectors/control_parameter_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe Reek::SmellDetectors::ControlParameter do
       and reek_of(:ControlParameter, lines: [3], argument: 'charlie')
   end
 
-  context 'parameter not used to determine code path' do
+  context 'when a parameter is not used to determine code path' do
     it 'does not report a ternary check on an ivar' do
       src = 'def alfa(bravo) @charlie ? bravo : false end'
       expect(src).not_to reek_of(:ControlParameter)
@@ -52,7 +52,7 @@ RSpec.describe Reek::SmellDetectors::ControlParameter do
     end
   end
 
-  context 'parameter only used to determine code path' do
+  context 'when a parameter is only used to determine code path' do
     it 'reports a ternary check on a parameter' do
       src = 'def alfa(bravo); bravo ? true : false; end'
       expect(src).to reek_of(:ControlParameter)
@@ -144,7 +144,7 @@ RSpec.describe Reek::SmellDetectors::ControlParameter do
       expect(src).to reek_of(:ControlParameter)
     end
 
-    it 'reports on nested if statements where the inner if is a control parameter' do
+    it 'reports on nested suffix if statements where the inner if is a control parameter' do
       src = <<-EOS
         def nested(bravo)
           if true
@@ -157,6 +157,36 @@ RSpec.describe Reek::SmellDetectors::ControlParameter do
       expect(src).to reek_of(:ControlParameter)
     end
 
+    it 'reports on nested full if statements where the inner if is a control parameter' do
+      src = <<-EOS
+        def alfa(bravo)
+          if true
+            charlie
+          else
+            if bravo
+              delta
+            end
+          end
+        end
+      EOS
+
+      expect(src).to reek_of(:ControlParameter)
+    end
+
+    it 'reports on elsif statements' do
+      src = <<-EOS
+        def alfa(bravo)
+          if true
+            charlie
+          elsif bravo
+            delta
+          end
+        end
+      EOS
+
+      expect(src).to reek_of(:ControlParameter)
+    end
+
     it 'reports on explicit comparison in the condition' do
       src = 'def alfa(bravo); if bravo == charlie then charlie end; end'
       expect(src).to reek_of(:ControlParameter)
@@ -188,7 +218,7 @@ RSpec.describe Reek::SmellDetectors::ControlParameter do
     end
   end
 
-  context 'parameter used besides determining code path' do
+  context 'when a parameter is used besides determining code path' do
     it 'does not report on if conditional expression' do
       src = 'def alfa(bravo); if bravo then charlie(bravo); end end'
       expect(src).not_to reek_of(:ControlParameter)