reek 1.6.6 → 2.0.0

data/spec/reek/spec/should_reek_only_of_spec.rb

@@ -8,7 +8,7 @@ describe ShouldReekOnlyOf do
   before :each do
     @expected_smell_type = :NestedIterators
     @expected_context_name = 'SmellyClass#big_method'
-    @matcher = ShouldReekOnlyOf.new(@expected_smell_type, [/#{@expected_context_name}/])
+    @matcher = ShouldReekOnlyOf.new(@expected_smell_type)
     @examiner = double('examiner').as_null_object
     expect(@examiner).to receive(:smells) { smells }
     @match = @matcher.matches_examiner?(@examiner)
@@ -18,14 +18,17 @@ describe ShouldReekOnlyOf do
     it 'does not match' do
       expect(@match).to be_falsey
     end
+
     context 'when a match was expected' do
       before :each do
         @source = 'the_path/to_a/source_file.rb'
         expect(@examiner).to receive(:description).and_return(@source)
       end
+
       it 'reports the source' do
         expect(@matcher.failure_message).to match(@source)
       end
+
       it 'reports the expected smell class' do
         expect(@matcher.failure_message).to match(@expected_smell_type.to_s)
       end
@@ -86,12 +89,15 @@ describe ShouldReekOnlyOf do
       [build(:smell_warning, smell_detector: detector,
                              message: "message mentioning #{@expected_context_name}")]
     end
+
     it 'matches' do
       expect(@match).to be_truthy
     end
+
     it 'reports the expected smell when no match was expected' do
       expect(@matcher.failure_message_when_negated).to match(@expected_smell_type.to_s)
     end
+
     it 'reports the source when no match was expected' do
       source = 'the_path/to_a/source_file.rb'
       expect(@examiner).to receive(:description).and_return(source)

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'reek/spec'
 require 'reek/source/ast_node_class_map'
+require 'reek/configuration/app_configuration'
 
-require 'matchers/smell_of_matcher'
 require 'factory_girl'
 
 begin
@@ -13,22 +13,30 @@ FactoryGirl.find_definitions
 
 SAMPLES_DIR = 'spec/samples'
 
-# :reek:UncommunicativeMethodName
-def s(type, *children)
-  @klass_map ||= Reek::Source::AstNodeClassMap.new
-  @klass_map.klass_for(type).new(type, children)
-end
-
-def ast(*args)
-  s(*args)
-end
-
 # Simple helpers for our specs.
 module Helpers
-  def with_test_config(path)
-    Configuration::AppConfiguration.load_from_file(path)
+  def with_test_config(config)
+    if config.is_a? String
+      Reek::Configuration::AppConfiguration.load_from_file(config)
+    elsif config.is_a? Hash
+      Reek::Configuration::AppConfiguration.class_eval do
+        @configuration = config
+      end
+    else
+      raise "Unknown config given in `with_test_config`: #{config.inspect}"
+    end
     yield if block_given?
-    Configuration::AppConfiguration.reset
+    Reek::Configuration::AppConfiguration.reset
+  end
+
+  # :reek:UncommunicativeMethodName
+  def s(type, *children)
+    @klass_map ||= Reek::Source::AstNodeClassMap.new
+    @klass_map.klass_for(type).new(type, children)
+  end
+
+  def ast(*args)
+    s(*args)
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 1.6.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0.pre.7
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0.pre.7
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
@@ -44,22 +44,16 @@ dependencies:
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.99'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.99'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -208,14 +202,14 @@ files:
 - lib/reek.rb
 - lib/reek/cli/application.rb
 - lib/reek/cli/command.rb
-- lib/reek/cli/help_command.rb
 - lib/reek/cli/input.rb
+- lib/reek/cli/option_interpreter.rb
 - lib/reek/cli/options.rb
 - lib/reek/cli/reek_command.rb
 - lib/reek/cli/report/formatter.rb
+- lib/reek/cli/report/heading_formatter.rb
+- lib/reek/cli/report/location_formatter.rb
 - lib/reek/cli/report/report.rb
-- lib/reek/cli/report/strategy.rb
-- lib/reek/cli/version_command.rb
 - lib/reek/configuration/app_configuration.rb
 - lib/reek/configuration/configuration_file_finder.rb
 - lib/reek/core/code_context.rb
@@ -281,11 +275,11 @@ files:
 - spec/factories/factories.rb
 - spec/gem/updates_spec.rb
 - spec/gem/yard_spec.rb
-- spec/matchers/smell_of_matcher.rb
 - spec/quality/reek_source_spec.rb
-- spec/reek/cli/help_command_spec.rb
-- spec/reek/cli/report_spec.rb
-- spec/reek/cli/version_command_spec.rb
+- spec/reek/cli/html_report_spec.rb
+- spec/reek/cli/option_interperter_spec.rb
+- spec/reek/cli/text_report_spec.rb
+- spec/reek/cli/yaml_report_spec.rb
 - spec/reek/configuration/app_configuration_spec.rb
 - spec/reek/configuration/configuration_file_finder_spec.rb
 - spec/reek/core/code_context_spec.rb
@@ -295,6 +289,7 @@ files:
 - spec/reek/core/object_refs_spec.rb
 - spec/reek/core/singleton_method_context_spec.rb
 - spec/reek/core/smell_configuration_spec.rb
+- spec/reek/core/smell_repository_spec.rb
 - spec/reek/core/stop_context_spec.rb
 - spec/reek/core/warning_collector_spec.rb
 - spec/reek/examiner_spec.rb

data/lib/reek/cli/help_command.rb

@@ -1,15 +0,0 @@
-require 'reek/cli/command'
-
-module Reek
-  module Cli
-    #
-    # A command to display usage information for this application.
-    #
-    class HelpCommand < Command
-      def execute(view)
-        view.output(@options.help_text)
-        view.report_success
-      end
-    end
-  end
-end

data/lib/reek/cli/report/strategy.rb

@@ -1,64 +0,0 @@
-module Reek
-  module Cli
-    module Report
-      module Strategy
-        #
-        # Base class for report startegies.
-        # Each gathers results according to strategy chosen
-        #
-        class Base
-          attr_reader :report_formatter, :warning_formatter, :examiners
-
-          def initialize(report_formatter, warning_formatter, examiners)
-            @report_formatter = report_formatter
-            @warning_formatter = warning_formatter
-            @examiners = examiners
-          end
-
-          def summarize_single_examiner(examiner)
-            result = report_formatter.header examiner
-            if examiner.smelly?
-              formatted_list = report_formatter.format_list(examiner.smells,
-                                                            warning_formatter)
-              result += ":\n#{formatted_list}"
-            end
-            result
-          end
-        end
-
-        #
-        # Lists out each examiner, even if it has no smell
-        #
-        class Verbose < Base
-          def gather_results
-            examiners.each_with_object([]) do |examiner, result|
-              result << summarize_single_examiner(examiner)
-            end
-          end
-        end
-
-        #
-        # Lists only smelly examiners
-        #
-        class Quiet < Base
-          def gather_results
-            examiners.each_with_object([]) do |examiner, result|
-              result << summarize_single_examiner(examiner) if examiner.smelly?
-            end
-          end
-        end
-
-        #
-        # Lists smells without summarization
-        # Used for yaml and html reports
-        #
-        class Normal < Base
-          def gather_results
-            examiners.each_with_object([]) { |examiner, smells| smells << examiner.smells }.
-              flatten
-          end
-        end
-      end
-    end
-  end
-end

data/lib/reek/cli/version_command.rb

@@ -1,16 +0,0 @@
-require 'reek'
-require 'reek/cli/command'
-
-module Reek
-  module Cli
-    #
-    # A command to report the application's current version number.
-    #
-    class VersionCommand < Command
-      def execute(view)
-        view.output("#{@options.program_name} #{Reek::VERSION}\n")
-        view.report_success
-      end
-    end
-  end
-end

data/spec/matchers/smell_of_matcher.rb

@@ -1,95 +0,0 @@
-module SmellOfMatcher
-  class SmellOf
-    def initialize(klass, *expected_smells)
-      @klass = klass
-      @expected_smells = expected_smells
-      @config = {}
-    end
-
-    def failure_message
-      "Expected #{@source.desc} to smell of #{@klass}, but it didn't: #{@reason}"
-    end
-
-    def failure_message_when_negated
-      "Expected #{@source.desc} not to smell of #{@klass}, but it did"
-    end
-
-    def matches?(src)
-      @source = src.to_reek_source
-
-      detect_smells
-
-      return false if no_smells_found?
-      return false if wrong_number_of_smells_found?
-      return false if wrong_smell_details_found?
-
-      true
-    end
-
-    def with_config(options)
-      @config = options
-      self
-    end
-
-    private
-
-    def detect_smells
-      tree = @source.syntax_tree
-      ctx = case tree.type
-            when :def, :defs
-              MethodContext.new(nil, tree)
-            when :module, :class
-              ModuleContext.new(nil, tree)
-            else
-              CodeContext.new(nil, tree)
-            end
-      detector = @klass.new(@source.desc, @klass.default_config.merge(@config))
-      detector.examine(ctx)
-      @actual_smells = detector.smells_found.to_a
-    end
-
-    def no_smells_found?
-      return false if @actual_smells.any?
-      @reason = 'no smells found by detector'
-      true
-    end
-
-    def wrong_number_of_smells_found?
-      return false if @expected_smells.empty?
-      return false if expected_number_of_smells == actual_number_of_smells
-
-      @reason = "expected #{expected_number_of_smells} smell(s), " \
-                "found #{actual_number_of_smells}"
-      true
-    end
-
-    def expected_number_of_smells
-      @expected_number_of_smells ||= @expected_smells.length
-    end
-
-    def actual_number_of_smells
-      @actual_number_of_smells ||= @actual_smells.length
-    end
-
-    def wrong_smell_details_found?
-      @expected_smells.zip(@actual_smells).each do |expected_smell, actual_smell|
-        expected_smell.each do |key, value|
-          actual_value = actual_smell.parameters[key]
-          next if actual_value == value
-
-          @reason = "expected #{key} to be #{value}, was #{actual_value}"
-          return true
-        end
-      end
-      false
-    end
-  end
-
-  def smell_of(klass, *smells)
-    SmellOf.new(klass, *smells)
-  end
-end
-
-RSpec.configure do |config|
-  config.include(SmellOfMatcher)
-end

data/spec/reek/cli/help_command_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-require 'reek/cli/help_command'
-
-include Reek::Cli
-
-describe HelpCommand do
-  before :each do
-    @help_text = 'Piece of interesting text'
-    @parser = double('parser')
-    allow(@parser).to receive(:help_text).and_return @help_text
-    @cmd = HelpCommand.new(@parser)
-    @view = double('view').as_null_object
-  end
-
-  it 'displays the correct text on the view' do
-    expect(@view).to receive(:output).with(@help_text)
-    @cmd.execute(@view)
-  end
-
-  it 'tells the view it succeeded' do
-    expect(@view).not_to receive(:report_smells)
-    expect(@view).to receive(:report_success)
-    @cmd.execute(@view)
-  end
-end

data/spec/reek/cli/report_spec.rb

@@ -1,132 +0,0 @@
-require 'spec_helper'
-require 'reek/examiner'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
-require 'reek/cli/report/strategy'
-require 'rainbow'
-require 'stringio'
-
-include Reek
-include Reek::Cli
-
-def capture_output_stream
-  $stdout = StringIO.new
-  yield
-  $stdout.string
-ensure
-  $stdout = STDOUT
-end
-
-def report_options
-  {
-    warning_formatter: Report::SimpleWarningFormatter,
-    report_formatter: Report::Formatter,
-    strategy: Report::Strategy::Quiet
-  }
-end
-
-describe Report::TextReport, ' when empty' do
-  context 'empty source' do
-    let(:examiner) { Examiner.new('') }
-
-    def report(obj)
-      obj.add_examiner examiner
-    end
-
-    it 'has an empty quiet_report' do
-      tr = Report::TextReport.new
-      tr.add_examiner(examiner)
-      expect { tr.show }.to_not output.to_stdout
-    end
-
-    context 'when output format is html' do
-      it 'has the text 0 total warnings' do
-        html_report = report(Report::HtmlReport.new(report_options))
-        html_report.show
-
-        file = File.expand_path('../../../../reek.html', __FILE__)
-        text = File.read(file)
-        File.delete(file)
-
-        expect(text).to include('0 total warnings')
-      end
-    end
-
-    context 'when output format is yaml' do
-      it 'prints empty yaml' do
-        yaml_report = report(Report::YamlReport.new(report_options))
-        result = capture_output_stream { yaml_report.show }
-        expect(result).to match(/^--- \[\]\n.*$/)
-      end
-    end
-
-    context 'when output format is text' do
-      it 'prints nothing' do
-        text_report = report(Report::TextReport.new)
-        expect { text_report.show }.to_not output.to_stdout
-      end
-    end
-  end
-
-  context 'with a couple of smells' do
-    before :each do
-      @examiner = Examiner.new('def simple(a) a[3] end')
-      @rpt = Report::TextReport.new report_options
-    end
-
-    context 'with colors disabled' do
-      before :each do
-        Rainbow.enabled = false
-        @result = @rpt.add_examiner(@examiner).smells.first
-      end
-
-      it 'has a header' do
-        expect(@result).to match('string -- 2 warnings')
-      end
-
-      it 'should mention every smell name' do
-        expect(@result).to include('UncommunicativeParameterName')
-        expect(@result).to include('FeatureEnvy')
-      end
-    end
-
-    context 'with colors enabled' do
-      before :each do
-        Rainbow.enabled = true
-      end
-
-      context 'with non smelly files' do
-        before :each do
-          Rainbow.enabled = true
-          @rpt.add_examiner(Examiner.new('def simple() puts "a" end'))
-          @rpt.add_examiner(Examiner.new('def simple() puts "a" end'))
-          @result = @rpt.smells
-        end
-
-        it 'has a footer in color' do
-          result = capture_output_stream { @rpt.show }
-          expect(result).to end_with "\e[32m0 total warnings\n\e[0m"
-        end
-      end
-
-      context 'with smelly files' do
-        before :each do
-          Rainbow.enabled = true
-          @rpt.add_examiner(Examiner.new('def simple(a) a[3] end'))
-          @rpt.add_examiner(Examiner.new('def simple(a) a[3] end'))
-          @result = @rpt.smells
-        end
-
-        it 'has a header in color' do
-          expect(@result.first).
-            to start_with "\e[36mstring -- \e[0m\e[33m2 warning\e[0m\e[33ms\e[0m"
-        end
-
-        it 'has a footer in color' do
-          result = capture_output_stream { @rpt.show }
-          expect(result).to end_with "\e[31m4 total warnings\n\e[0m"
-        end
-      end
-    end
-  end
-end