reek 6.0.1 → 6.0.5

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

@@ -1,22 +0,0 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/report/code_climate/code_climate_configuration'
-
-RSpec.describe Reek::Report::CodeClimateConfiguration do
-  yml = described_class.load
-  smell_types = Reek::SmellDetectors::BaseDetector.descendants.map(&:smell_type)
-
-  smell_types.each do |name|
-    config = yml.fetch(name)
-    it "provides remediation_points for #{name}" do
-      expect(config['remediation_points']).to be_a Integer
-    end
-
-    it "provides content for #{name}" do
-      expect(config['content']).to be_a String
-    end
-  end
-
-  it 'does not include extraneous configuration' do
-    expect(smell_types).to match_array(yml.keys)
-  end
-end

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

@@ -1,126 +0,0 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/report/code_climate/code_climate_fingerprint'
-
-RSpec.describe Reek::Report::CodeClimateFingerprint do
-  describe '#compute' do
-    let(:computed) { described_class.new(warning).compute }
-
-    context 'when fingerprinting a warning with no parameters' do
-      let(:expected_fingerprint) { 'e68badd29db51c92363a7c6a2438d722' }
-      let(:warning) do
-        Reek::SmellWarning.new(
-          'UtilityFunction',
-          context:    'alfa',
-          message:    "doesn't depend on instance state (maybe move it to another class?)",
-          lines:      lines,
-          source:     'a/ruby/source/file.rb')
-      end
-
-      context 'with code at a specific location' do
-        let(:lines) { [1] }
-
-        it 'computes the fingerprint' do
-          expect(computed).to eq expected_fingerprint
-        end
-      end
-
-      context 'with code at a different location' do
-        let(:lines) { [5] }
-
-        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
-        Reek::SmellWarning.new(
-          'ManualDispatch',
-          context:    'Alfa#bravo',
-          message:    'manually dispatches method call',
-          lines:      [4],
-          source:     'a/ruby/source/file.rb')
-      end
-
-      it 'returns nil' do
-        expect(computed).to be_nil
-      end
-    end
-
-    context 'when the smell warning has only identifying parameters' do
-      let(:warning) do
-        Reek::SmellWarning.new(
-          'ClassVariable',
-          context:    'Alfa',
-          message:    "declares the class variable '@@#{name}'",
-          lines:      [4],
-          parameters: { name: "@@#{name}" },
-          source:     'a/ruby/source/file.rb')
-      end
-
-      context 'when the name is one thing' do
-        let(:name) { 'bravo' }
-        let(:expected_fingerprint) { '9c3fd378178118a67e9509f87cae24f9' }
-
-        it 'computes the fingerprint' do
-          expect(computed).to eq expected_fingerprint
-        end
-      end
-
-      context 'when the name is another thing' do
-        let(:name) { 'echo' }
-        let(:expected_fingerprint) { 'd2a6d2703ce04cca65e7300b7de4b89f' }
-
-        it 'computes another fingerprint' do
-          expect(computed).to eq expected_fingerprint
-        end
-      end
-    end
-
-    context 'when the smell warning has identifying and non-identifying parameters' do
-      let(:warning) do
-        Reek::SmellWarning.new(
-          'DuplicateMethodCall',
-          context:    "Alfa##{name}",
-          message:    "calls '#{name}' #{count} times",
-          lines:      lines,
-          parameters: { name: "@@#{name}", count: count },
-          source:     'a/ruby/source/file.rb')
-      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' }
-
-        it 'computes the fingerprint' do
-          expect(computed).to eq expected_fingerprint
-        end
-      end
-
-      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 'computes the same fingerprint' do
-          expect(computed).to eq expected_fingerprint
-        end
-      end
-
-      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 '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

@@ -1,51 +0,0 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/report/code_climate/code_climate_formatter'
-
-RSpec.describe Reek::Report::CodeClimateFormatter do
-  describe '#render' do
-    let(:warning) do
-      Reek::SmellWarning.new(
-        'UtilityFunction',
-        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 }
-
-    it "sets the type as 'issue'" do
-      expect(json['type']).to eq 'issue'
-    end
-
-    it 'sets the category' do
-      expect(json['categories']).to eq ['Complexity']
-    end
-
-    it 'constructs a description based on the context and message' do
-      expect(json['description']).to eq 'context foo message bar'
-    end
-
-    it 'sets a check name based on the smell detector' do
-      expect(json['check_name']).to eq 'UtilityFunction'
-    end
-
-    it 'sets the location' do
-      expect(json['location']).to eq('path' => 'a/ruby/source/file.rb',
-                                     'lines' => { 'begin' => 1, 'end' => 2 })
-    end
-
-    it 'sets a content based on the smell detector' do
-      expect(json['content']['body']).
-        to eq "A _Utility Function_ is any instance method that has no dependency on the state of the instance.\n"
-    end
-
-    it 'sets remediation points based on the smell detector' do
-      expect(json['remediation_points']).to eq 250_000
-    end
-
-    it 'sets fingerprint based on warning context' do
-      expect(json['fingerprint']).to eq '70c530e45999af129d520f1f579f967f'
-    end
-  end
-end

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

@@ -1,56 +0,0 @@
-require_relative '../../../spec_helper'
-require_lib 'reek/examiner'
-require_lib 'reek/report/code_climate'
-
-require 'json'
-require 'stringio'
-
-RSpec.describe Reek::Report::CodeClimateReport do
-  let(:options) { {} }
-  let(:instance) { described_class.new(**options) }
-  let(:examiner) { Reek::Examiner.new(source) }
-
-  before do
-    instance.add_examiner examiner
-  end
-
-  context 'with empty source' do
-    let(:source) { '' }
-
-    it 'prints an empty string' do
-      expect { instance.show }.to output('').to_stdout
-    end
-  end
-
-  context 'with smelly source' do
-    let(:source) { 'def simple(a) a[3] end' }
-
-    it 'prints smells as json' do
-      expected = <<~HERE.delete("\n")
-        {"type":"issue",
-        "check_name":"UncommunicativeParameterName",
-        "description":"simple has the parameter name 'a'",
-        "categories":["Complexity"],
-        "location":{"path":"string","lines":{"begin":1,"end":1}},
-        "remediation_points":150000,
-        "content":{"body":"An `Uncommunicative Parameter Name` is a parameter name that
-         doesn't communicate its intent well enough.\\n\\nPoor names make it hard for the reader
-         to build a mental picture of what's going on in the code. They can also be
-         mis-interpreted; and they hurt the flow of reading, because the reader must slow down
-         to interpret the names.\\n"},
-        "fingerprint":"09970037d92b5a628bf682a3e2bb126d"}\u0000
-        {"type":"issue",
-        "check_name":"UtilityFunction",
-        "description":"simple doesn't depend on instance state (maybe move it to another class?)",
-        "categories":["Complexity"],
-        "location":{"path":"string","lines":{"begin":1,"end":1}},
-        "remediation_points":250000,
-        "content":{"body":"A _Utility Function_ is any instance method that has no
-         dependency on the state of the instance.\\n"},
-        "fingerprint":"db456db7cb344bb5a98b8fc54a2f382e"}\u0000
-      HERE
-
-      expect { instance.show }.to output(expected).to_stdout
-    end
-  end
-end

data/spec/reek/report/html_report_spec.rb

@@ -1,19 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/examiner'
-require_lib 'reek/report/html_report'
-
-RSpec.describe Reek::Report::HTMLReport do
-  let(:instance) { described_class.new }
-
-  context 'with an empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
-
-    before do
-      instance.add_examiner examiner
-    end
-
-    it 'has the text 0 total warnings' do
-      expect { instance.show }.to output(/0 total warnings/).to_stdout
-    end
-  end
-end

data/spec/reek/report/json_report_spec.rb

@@ -1,58 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/examiner'
-require_lib 'reek/report/json_report'
-
-require 'json'
-require 'stringio'
-
-RSpec.describe Reek::Report::JSONReport do
-  let(:options) { {} }
-  let(:instance) { described_class.new(**options) }
-  let(:examiner) { Reek::Examiner.new(source) }
-
-  before do
-    instance.add_examiner examiner
-  end
-
-  context 'with empty source' do
-    let(:source) { '' }
-
-    it 'prints empty json' do
-      expect { instance.show }.to output(/^\[\]$/).to_stdout
-    end
-  end
-
-  context 'with smelly source' do
-    let(:source) { 'def simple(a) a[3] end' }
-
-    it 'prints smells as json' do
-      out = StringIO.new
-      instance.show(out)
-      out.rewind
-      result = JSON.parse(out.read)
-      expected = JSON.parse <<-RUBY
-        [
-          {
-            "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",
-            "documentation_link": "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
-          }
-        ]
-      RUBY
-
-      expect(result).to eq expected
-    end
-  end
-end

data/spec/reek/report/location_formatter_spec.rb

@@ -1,32 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/report/location_formatter'
-
-RSpec.describe Reek::Report::BlankLocationFormatter do
-  let(:warning) { build_smell_warning(lines: [11, 9, 250, 100]) }
-
-  describe '.format' do
-    it 'returns a blank String regardless of the warning' do
-      expect(described_class.format(warning)).to eq('')
-    end
-  end
-end
-
-RSpec.describe Reek::Report::DefaultLocationFormatter do
-  let(:warning) { build_smell_warning(lines: [11, 9, 250, 100]) }
-
-  describe '.format' do
-    it 'returns a prefix with sorted line numbers' do
-      expect(described_class.format(warning)).to eq('[9, 11, 100, 250]:')
-    end
-  end
-end
-
-RSpec.describe Reek::Report::SingleLineLocationFormatter do
-  let(:warning) { build_smell_warning(lines: [11, 9, 250, 100]) }
-
-  describe '.format' do
-    it 'returns the first line where the smell was found' do
-      expect(described_class.format(warning)).to eq('dummy_file:9: ')
-    end
-  end
-end

data/spec/reek/report/progress_formatter_spec.rb

@@ -1,68 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/report/progress_formatter'
-
-RSpec.describe Reek::Report::ProgressFormatter::Dots do
-  let(:sources_count) { 23 }
-  let(:formatter) { described_class.new(sources_count) }
-
-  describe '#header' do
-    it 'announces the number of files to be inspected' do
-      expect(formatter.header).to eq "Inspecting 23 file(s):\n"
-    end
-  end
-
-  describe '#progress' do
-    let(:clean_examiner) { instance_double(Reek::Examiner, smelly?: false) }
-    let(:smelly_examiner) { instance_double(Reek::Examiner, smelly?: true) }
-
-    context 'with colors disabled' do
-      before do
-        Rainbow.enabled = false
-      end
-
-      it 'returns a dot for clean files' do
-        expect(formatter.progress(clean_examiner)).to eq '.'
-      end
-
-      it 'returns an S for smelly files' do
-        expect(formatter.progress(smelly_examiner)).to eq 'S'
-      end
-    end
-  end
-
-  describe '#footer' do
-    it 'returns some blank lines to offset the output' do
-      expect(formatter.footer).to eq "\n\n"
-    end
-  end
-end
-
-RSpec.describe Reek::Report::ProgressFormatter::Quiet do
-  let(:sources_count) { 23 }
-  let(:formatter) { described_class.new(sources_count) }
-
-  describe '#header' do
-    it 'is quiet' do
-      expect(formatter.header).to eq ''
-    end
-  end
-
-  describe '#progress' do
-    let(:clean_examiner) { instance_double(Reek::Examiner, smelly?: false) }
-    let(:smelly_examiner) { instance_double(Reek::Examiner, smelly?: true) }
-
-    it 'is quiet for clean files' do
-      expect(formatter.progress(clean_examiner)).to eq ''
-    end
-
-    it 'is quiet for smelly files' do
-      expect(formatter.progress(smelly_examiner)).to eq ''
-    end
-  end
-
-  describe '#footer' do
-    it 'is quiet' do
-      expect(formatter.footer).to eq ''
-    end
-  end
-end

data/spec/reek/report/text_report_spec.rb

@@ -1,89 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/examiner'
-require_lib 'reek/report/text_report'
-require_lib 'reek/report/heading_formatter'
-require_lib 'reek/report/simple_warning_formatter'
-require 'rainbow'
-
-RSpec.describe Reek::Report::TextReport do
-  let(:instance) { described_class.new }
-
-  context 'with a single empty source' do
-    before do
-      instance.add_examiner Reek::Examiner.new('')
-    end
-
-    it 'has an empty quiet_report' do
-      expect { instance.show }.not_to output.to_stdout
-    end
-  end
-
-  context 'with non smelly files' do
-    before do
-      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
-      instance.add_examiner(Reek::Examiner.new('def simple() puts "a" end'))
-    end
-
-    context 'with colors disabled' do
-      before do
-        Rainbow.enabled = false
-      end
-
-      it 'shows total of 0 warnings' do
-        expect { instance.show }.to output(/0 total warnings\n\Z/).to_stdout
-      end
-    end
-
-    context 'with colors enabled' do
-      before do
-        Rainbow.enabled = true
-      end
-
-      it 'has a footer in color' do
-        expect { instance.show }.to output(/\e\[32m0 total warnings\n\e\[0m\Z/).to_stdout
-      end
-    end
-  end
-
-  context 'with a couple of smells' do
-    before do
-      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
-      instance.add_examiner(Reek::Examiner.new('def simple(a) a[3] end'))
-    end
-
-    context 'with colors disabled' do
-      before do
-        Rainbow.enabled = false
-      end
-
-      it 'has a heading' do
-        expect { instance.show }.to output(/string -- 2 warnings/).to_stdout
-      end
-
-      it 'mentions every smell name' do
-        matcher = match(/UncommunicativeParameterName/).and match(/UtilityFunction/)
-        expect { instance.show }.to output(matcher).to_stdout
-      end
-
-      it 'shows total number of warnings' do
-        expect { instance.show }.to output(/4 total warnings\n\Z/).to_stdout
-      end
-    end
-
-    context 'with colors enabled' do
-      before do
-        Rainbow.enabled = true
-      end
-
-      it 'has a header in color' do
-        expect { instance.show }.
-          to output(/\A\e\[36mstring -- \e\[0m\e\[33m2 warning\e\[0m\e\[33ms\e\[0m/).to_stdout
-      end
-
-      it 'shows total number of warnings in color' do
-        expect { instance.show }.
-          to output(/\e\[31m4 total warnings\n\e\[0m\Z/).to_stdout
-      end
-    end
-  end
-end