reek 6.0.2 → 6.2.0

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

data/spec/reek/report/xml_report_spec.rb

@@ -1,24 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/examiner'
-require_lib 'reek/report/xml_report'
-
-RSpec.describe Reek::Report::XMLReport do
-  let(:xml_report) { described_class.new }
-
-  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"
-      expect { xml_report.show }.to output(xml).to_stdout
-    end
-  end
-
-  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_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
-  end
-end

data/spec/reek/report/yaml_report_spec.rb

@@ -1,55 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/examiner'
-require_lib 'reek/report/yaml_report'
-
-require 'yaml'
-require 'stringio'
-
-RSpec.describe Reek::Report::YAMLReport 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 yaml' do
-      expect { instance.show }.to output(/^--- \[\]\n.*$/).to_stdout
-    end
-  end
-
-  context 'with smelly source' do
-    let(:source) { 'def simple(a) a[3] end' }
-
-    it 'prints smells as yaml' do
-      out = StringIO.new
-      instance.show(out)
-      out.rewind
-      result = YAML.safe_load(out.read)
-      expected = YAML.safe_load <<~YAML
-        ---
-        - 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"
-      YAML
-
-      expect(result).to eq expected
-    end
-  end
-end

data/spec/reek/report_spec.rb

@@ -1,28 +0,0 @@
-require_relative '../spec_helper'
-require_lib 'reek/report'
-
-RSpec.describe Reek::Report do
-  describe '.report_class' do
-    it 'returns the correct class' do
-      expect(described_class.report_class(:text)).to eq Reek::Report::TextReport
-    end
-  end
-
-  describe '.location_formatter' do
-    it 'returns the correct class' do
-      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::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::SimpleWarningFormatter
-    end
-  end
-end

data/spec/reek/smell_configuration_spec.rb

@@ -1,56 +0,0 @@
-require_relative '../spec_helper'
-require_lib 'reek/smell_configuration'
-
-RSpec.describe Reek::SmellConfiguration do
-  context 'when overriding default configs' do
-    let(:base_config) do
-      {
-        'accept'  => ['_'],
-        'enabled' => true,
-        'exclude' => [],
-        'reject'  => [/^.$/, /[0-9]$/, /[A-Z]/]
-      }
-    end
-
-    let(:smell_config) { described_class.new(base_config) }
-
-    it { expect(smell_config.merge({})).to eq(base_config) }
-    it { expect(smell_config.merge('enabled' => true)).to eq(base_config) }
-    it { expect(smell_config.merge('exclude' => [])).to eq(base_config) }
-    it { expect(smell_config.merge('accept' => ['_'])).to eq(base_config) }
-
-    it do
-      updated = smell_config.merge('reject' => [/^.$/, /[0-9]$/, /[A-Z]/])
-      expect(updated).to eq(base_config)
-    end
-
-    it do
-      updated = smell_config.merge('accept' => ['_'], 'enabled' => true)
-      expect(updated).to eq(base_config)
-    end
-
-    it 'overrides single values' do
-      updated = smell_config.merge('enabled' => false)
-      expect(updated).to eq('accept'  => ['_'],
-                            'enabled' => false,
-                            'exclude' => [],
-                            'reject'  => [/^.$/, /[0-9]$/, /[A-Z]/])
-    end
-
-    it 'overrides arrays of values' do
-      updated = smell_config.merge('reject' => [/^.$/, /[3-9]$/])
-      expect(updated).to eq('accept'  => ['_'],
-                            'enabled' => true,
-                            'exclude' => [],
-                            'reject'  => [/^.$/, /[3-9]$/])
-    end
-
-    it 'overrides multiple values' do
-      updated = smell_config.merge('accept' => [/[A-Z]$/], 'enabled' => false)
-      expect(updated).to eq('accept'  => [/[A-Z]$/],
-                            'enabled' => false,
-                            'exclude' => [],
-                            'reject'  => [/^.$/, /[0-9]$/, /[A-Z]/])
-    end
-  end
-end

data/spec/reek/smell_detectors/attribute_spec.rb

@@ -1,197 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/smell_detectors/attribute'
-
-RSpec.describe Reek::SmellDetectors::Attribute do
-  it 'reports the right values' do
-    src = <<-RUBY
-      class Alfa
-        attr_writer :bravo
-      end
-    RUBY
-
-    expect(src).to reek_of(:Attribute,
-                           lines: [2],
-                           context: 'Alfa#bravo',
-                           message: 'is a writable attribute')
-  end
-
-  it 'does count all occurences' do
-    src = <<-RUBY
-      class Alfa
-        attr_writer :bravo
-        attr_writer :charlie
-      end
-    RUBY
-
-    expect(src).
-      to reek_of(:Attribute, lines: [2], context: 'Alfa#bravo').
-      and reek_of(:Attribute, lines: [3], context: 'Alfa#charlie')
-  end
-
-  it 'records nothing with no attributes' do
-    src = <<-RUBY
-      class Alfa
-      end
-    RUBY
-
-    expect(src).not_to reek_of(:Attribute)
-  end
-
-  context 'with attributes' do
-    it 'records nothing for attribute readers' do
-      src = <<-RUBY
-        class Alfa
-          attr :bravo
-          attr_reader :charlie
-        end
-      RUBY
-
-      expect(src).not_to reek_of(:Attribute)
-    end
-
-    it 'records writer attribute' do
-      src = <<-RUBY
-        class Alfa
-          attr_writer :bravo
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute, context: 'Alfa#bravo')
-    end
-
-    it 'does not record writer attribute if suppressed with a preceding code comment' do
-      src = <<-RUBY
-        class Alfa
-          # :reek:Attribute
-          attr_writer :bravo
-        end
-      RUBY
-
-      expect(src).not_to reek_of(:Attribute)
-    end
-
-    it 'records attr_writer attribute in a module' do
-      src = <<-RUBY
-        module Mod
-          attr_writer :bravo
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute)
-    end
-
-    it 'records accessor attribute' do
-      src = <<-RUBY
-        class Alfa
-          attr_accessor :bravo
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute)
-    end
-
-    it 'records attr defining a writer' do
-      src = <<-RUBY
-        class Alfa
-          attr :bravo, true
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute)
-    end
-
-    it "doesn't record protected attributes" do
-      src = <<-RUBY
-        class Alfa
-          protected
-          attr_writer :alfa
-          attr_accessor :bravo
-          attr :charlie
-          attr :delta, true
-          attr_reader :echo
-        end
-      RUBY
-
-      expect(src).not_to reek_of(:Attribute)
-    end
-
-    it "doesn't record private attributes" do
-      src = <<-RUBY
-        class Alfa
-          private
-          attr_writer :alfa
-          attr_accessor :bravo
-          attr :charlie
-          attr :delta, true
-          attr_reader :echo
-        end
-      RUBY
-
-      expect(src).not_to reek_of(:Attribute)
-    end
-
-    it 'records attr_writer defined in public section' do
-      src = <<-RUBY
-        class Alfa
-          private
-          public
-          attr_writer :bravo
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute)
-    end
-
-    it 'records attr_writer after switching visbility to public' do
-      src = <<-RUBY
-        class Alfa
-          private
-          attr_writer :bravo
-          public :bravo
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute)
-    end
-
-    it 'resets visibility in new contexts' do
-      src = <<-RUBY
-        class Alfa
-          private
-          attr_writer :bravo
-        end
-
-        class Charlie
-          attr_writer :delta
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute, context: 'Charlie#delta')
-    end
-
-    it 'records attr_writer defining a class attribute' do
-      src = <<-RUBY
-        class Alfa
-          class << self
-            attr_writer :bravo
-          end
-        end
-      RUBY
-
-      expect(src).to reek_of(:Attribute)
-    end
-
-    it 'does not record private class attributes' do
-      src = <<-RUBY
-        class Alfa
-          class << self
-            private
-            attr_writer :bravo
-          end
-        end
-      RUBY
-
-      expect(src).not_to reek_of(:Attribute)
-    end
-  end
-end

data/spec/reek/smell_detectors/base_detector_spec.rb

@@ -1,50 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/smell_detectors/base_detector'
-require_lib 'reek/smell_detectors/duplicate_method_call'
-
-RSpec.describe Reek::SmellDetectors::BaseDetector do
-  describe '.todo_configuration_for' do
-    it 'returns exclusion configuration for the given smells' do
-      smell = build_smell_warning(smell_type: 'Foo', context: 'Foo#bar')
-      result = described_class.todo_configuration_for([smell])
-      expect(result).to eq('BaseDetector' => { 'exclude' => ['Foo#bar'] })
-    end
-
-    it 'merges identical contexts' do
-      smell = build_smell_warning(smell_type: 'Foo', context: 'Foo#bar')
-      result = described_class.todo_configuration_for([smell, smell])
-      expect(result).to eq('BaseDetector' => { 'exclude' => ['Foo#bar'] })
-    end
-
-    context 'with default exclusions present' do
-      let(:subclass) { Reek::SmellDetectors::TooManyStatements }
-
-      it 'includes default exclusions' do
-        smell = build_smell_warning(smell_type: 'TooManyStatements', context: 'Foo#bar')
-        result = subclass.todo_configuration_for([smell])
-
-        aggregate_failures do
-          expect(subclass.default_config['exclude']).to eq ['initialize']
-          expect(result).to eq('TooManyStatements' => { 'exclude' => ['initialize', 'Foo#bar'] })
-        end
-      end
-    end
-  end
-
-  describe '.to_detector' do
-    it 'returns the right detector' do
-      expect(described_class.to_detector('DuplicateMethodCall')).to eq(Reek::SmellDetectors::DuplicateMethodCall)
-    end
-
-    it 'raise NameError for an invalid detector name' do
-      expect { described_class.to_detector('Unknown') }.to raise_error(NameError)
-    end
-  end
-
-  describe '.configuration_keys' do
-    it 'returns the right keys' do
-      expected_keys = Reek::SmellDetectors::DuplicateMethodCall.configuration_keys.to_a
-      expect(expected_keys).to eq([:enabled, :exclude, :max_calls, :allow_calls])
-    end
-  end
-end