reek 3.11 → 4.0.0.pre1

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative '../examiner'
 require_relative '../report/formatter'
 require_relative 'should_reek_of'
@@ -10,24 +11,24 @@ module Reek
     # code smell and no others.
     #
     class ShouldReekOnlyOf < ShouldReekOf
-      def matches?(actual)
-        matches_examiner?(Examiner.new(actual, configuration: configuration))
+      def matches?(source)
+        matches_examiner?(Examiner.new(source, configuration: configuration))
       end
 
       def matches_examiner?(examiner)
         self.examiner = examiner
         self.warnings = examiner.smells
         return false if warnings.empty?
-        warnings.all? { |warning| SmellMatcher.new(warning).matches?(smell_category) }
+        warnings.all? { |warning| SmellMatcher.new(warning).matches?(smell_type) }
       end
 
       def failure_message
         rpt = Report::Formatter.format_list(warnings)
-        "Expected #{examiner.description} to reek only of #{smell_category}, but got:\n#{rpt}"
+        "Expected #{examiner.description} to reek only of #{smell_type}, but got:\n#{rpt}"
       end
 
       def failure_message_when_negated
-        "Expected #{examiner.description} not to reek only of #{smell_category}, but it did"
+        "Expected #{examiner.description} not to reek only of #{smell_type}, but it did"
       end
 
       private

data/lib/reek/spec/smell_matcher.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Reek
   module Spec
     #
@@ -17,16 +18,15 @@ module Reek
       end
 
       def matches_smell_type?(klass)
-        smell_classes.include?(klass.to_s)
+        smell_warning.smell_type == klass.to_s
       end
 
       def matches_attributes?(attributes)
         check_attributes_comparability(attributes)
 
-        # FIXME: Use Array#to_h when dropping Ruby 2.0 compatibility.
         fields, params = attributes.
           partition { |key, _| COMPARABLE_ATTRIBUTES.include? key }.
-          map { |arr| Hash[arr] }
+          map(&:to_h)
 
         common_parameters_equal?(params) &&
           common_attributes_equal?(fields)
@@ -34,10 +34,6 @@ module Reek
 
       private
 
-      def smell_classes
-        [smell_warning.smell_category, smell_warning.smell_type]
-      end
-
       def check_attributes_comparability(other_attributes)
         parameter_keys = other_attributes.keys - COMPARABLE_ATTRIBUTES
         extra_keys = parameter_keys - smell_warning.parameters.keys

data/lib/reek/tree_dresser.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'ast/ast_node_class_map'
 
 module Reek

data/lib/reek/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # @public
 module Reek
   #
@@ -6,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.11'.freeze
+    STRING = '4.0.0.pre1'.freeze
   end
 end

data/reek.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
   s.homepage = 'https://github.com/troessner/reek/wiki'
   s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.1.0'
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.3.1'

data/spec/reek/examiner_spec.rb

@@ -20,7 +20,7 @@ RSpec.shared_examples_for 'one smell found' do
   end
 
   it 'reports the correct smell' do
-    expect(examiner.smells[0].smell_category).to eq(expected_first_smell)
+    expect(examiner.smells[0].smell_type).to eq(expected_first_smell)
   end
 end
 
@@ -35,14 +35,18 @@ RSpec.describe Reek::Examiner do
 
   context 'with a smelly String' do
     let(:examiner) { described_class.new('def fine() y = 4; end') }
-    let(:expected_first_smell) { 'UncommunicativeName' }
+    let(:expected_first_smell) { 'UncommunicativeVariableName' }
 
     it_should_behave_like 'one smell found'
   end
 
   context 'with a partially masked smelly File' do
     let(:configuration) { test_configuration_for(path) }
-    let(:examiner) { described_class.new(smelly_file, [], configuration: configuration) }
+    let(:examiner) do
+      described_class.new(smelly_file,
+                          filter_by_smells: [],
+                          configuration: configuration)
+    end
     let(:path) { SAMPLES_PATH.join('all_but_one_masked/masked.reek') }
     let(:smelly_file) { Pathname.glob(SAMPLES_PATH.join('all_but_one_masked/d*.rb')).first }
 
@@ -59,7 +63,7 @@ RSpec.describe Reek::Examiner do
   describe '#smells' do
     it 'returns the detected smell warnings' do
       code     = 'def foo; bar.call_me(); bar.call_me(); end'
-      examiner = described_class.new code, ['DuplicateMethodCall']
+      examiner = described_class.new code, filter_by_smells: ['DuplicateMethodCall']
 
       smell = examiner.smells.first
       expect(smell).to be_a(Reek::Smells::SmellWarning)

data/spec/reek/report/code_climate_formatter_spec.rb

@@ -25,7 +25,7 @@ RSpec.describe Reek::Report::CodeClimateFormatter, '#render' do
   end
 
   it 'sets a check name based on the smell detector' do
-    expect(rendered).to match(%r{\"check_name\":\"LowCohesion\/UtilityFunction\"})
+    expect(rendered).to match(/\"check_name\":\"UtilityFunction\"/)
   end
 
   it 'sets the location' do

data/spec/reek/report/code_climate_report_spec.rb

@@ -29,7 +29,7 @@ RSpec.describe Reek::Report::CodeClimateReport do
     it 'prints smells as json' do
       expected = <<-EOS.delete("\n")
 {\"type\":\"issue\",
-\"check_name\":\"UncommunicativeName/UncommunicativeParameterName\",
+\"check_name\":\"UncommunicativeParameterName\",
 \"description\":\"simple has the parameter name 'a'\",
 \"categories\":[\"Complexity\"],
 \"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
@@ -40,7 +40,7 @@ RSpec.describe Reek::Report::CodeClimateReport do
  mis-interpreted; and they hurt the flow of reading, because the reader must slow down
  to interpret the names.\\n\"}}\u0000
 {\"type\":\"issue\",
-\"check_name\":\"LowCohesion/UtilityFunction\",
+\"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}},

data/spec/reek/report/html_report_spec.rb

@@ -1,4 +1,3 @@
-require 'tempfile'
 require_relative '../../spec_helper'
 require_lib 'reek/examiner'
 require_lib 'reek/report/report'
@@ -14,11 +13,7 @@ RSpec.describe Reek::Report::HTMLReport do
     end
 
     it 'has the text 0 total warnings' do
-      tempfile = Tempfile.new(['Reek::Report::HTMLReport.', '.html'])
-      response = "HTML file saved\n"
-      expect { instance.show(target_path: tempfile.path) }.
-        to output(response).to_stdout
-      expect(tempfile.read).to include('0 total warnings')
+      expect { instance.show }.to output(/0 total warnings/).to_stdout
     end
   end
 end

data/spec/reek/report/json_report_spec.rb

@@ -37,7 +37,6 @@ RSpec.describe Reek::Report::JSONReport do
             "context":        "simple",
             "lines":          [1],
             "message":        "has the parameter name 'a'",
-            "smell_category": "UncommunicativeName",
             "smell_type":     "UncommunicativeParameterName",
             "source":         "string",
             "name":           "a"
@@ -46,7 +45,6 @@ RSpec.describe Reek::Report::JSONReport do
             "context":        "simple",
             "lines":          [1],
             "message":        "doesn't depend on instance state (maybe move it to another class?)",
-            "smell_category": "LowCohesion",
             "smell_type":     "UtilityFunction",
             "source":         "string",
             "name":           "simple"
@@ -71,7 +69,6 @@ RSpec.describe Reek::Report::JSONReport do
               "context":        "simple",
               "lines":          [1],
               "message":        "has the parameter name 'a'",
-              "smell_category": "UncommunicativeName",
               "smell_type":     "UncommunicativeParameterName",
               "source":         "string",
               "name":           "a",
@@ -81,7 +78,6 @@ RSpec.describe Reek::Report::JSONReport do
               "context":        "simple",
               "lines":          [1],
               "message":        "doesn't depend on instance state (maybe move it to another class?)",
-              "smell_category": "LowCohesion",
               "smell_type":     "UtilityFunction",
               "source":         "string",
               "name":           "simple",

data/spec/reek/report/yaml_report_spec.rb

@@ -37,7 +37,6 @@ RSpec.describe Reek::Report::YAMLReport do
   lines:
   - 1
   message:        "has the parameter name 'a'"
-  smell_category: "UncommunicativeName"
   smell_type:     "UncommunicativeParameterName"
   source:         "string"
   name:           "a"
@@ -45,7 +44,6 @@ RSpec.describe Reek::Report::YAMLReport do
   lines:
   - 1
   message:        "doesn't depend on instance state (maybe move it to another class?)"
-  smell_category: "LowCohesion"
   smell_type:     "UtilityFunction"
   source:         "string"
   name:           "simple"
@@ -67,7 +65,6 @@ RSpec.describe Reek::Report::YAMLReport do
   lines:
   - 1
   message:        "has the parameter name 'a'"
-  smell_category: "UncommunicativeName"
   smell_type:     "UncommunicativeParameterName"
   source:         "string"
   name:           "a"
@@ -76,7 +73,6 @@ RSpec.describe Reek::Report::YAMLReport do
   lines:
   - 1
   message:        "doesn't depend on instance state (maybe move it to another class?)"
-  smell_category: "LowCohesion"
   smell_type:     "UtilityFunction"
   source:         "string"
   name:           "simple"

data/spec/reek/smells/data_clump_spec.rb

@@ -49,8 +49,8 @@ RSpec.shared_examples_for 'a data clump detector' do
       expect(smells[0].lines).to eq([2, 3, 4])
     end
 
-    it 'reports the correct smell class' do
-      expect(smells[0].smell_category).to eq(Reek::Smells::DataClump.smell_category)
+    it 'reports the correct smell type' do
+      expect(smells[0].smell_type).to eq(Reek::Smells::DataClump.smell_type)
     end
 
     it 'reports the context fq name' do

data/spec/reek/smells/feature_envy_spec.rb

@@ -113,7 +113,7 @@ RSpec.describe Reek::Smells::FeatureEnvy do
         @cow.feed_to(thing.pig)
         @duck.feed_to(thing.pig)
       end
-    ').to reek_only_of(:Duplication)
+    ').to reek_only_of(:DuplicateMethodCall)
   end
 
   it 'should count local calls' do
@@ -122,7 +122,7 @@ RSpec.describe Reek::Smells::FeatureEnvy do
         cow.feed_to(thing.pig)
         duck.feed_to(thing.pig)
       end
-    ').to reek_only_of(:Duplication)
+    ').to reek_only_of(:DuplicateMethodCall)
   end
 
   it 'should report many calls to lvar' do
@@ -230,7 +230,7 @@ RSpec.describe Reek::Smells::FeatureEnvy do
           #{receiver}.fred
         end
       EOS
-      Reek::Examiner.new(src, ['FeatureEnvy']).smells.first
+      Reek::Examiner.new(src, filter_by_smells: ['FeatureEnvy']).smells.first
     end
 
     it_should_behave_like 'common fields set correctly'

data/spec/reek/smells/nested_iterators_spec.rb

@@ -123,7 +123,6 @@ RSpec.describe Reek::Smells::NestedIterators do
       warnings = detector.inspect(build(:method_context, source: source))
       warning = warnings.first
 
-      expect(warning.smell_category).to eq(Reek::Smells::NestedIterators.smell_category)
       expect(warning.smell_type).to eq(Reek::Smells::NestedIterators.smell_type)
       expect(warning.parameters[:name]).to eq('foo')
       expect(warning.lines).to eq([3])

data/spec/reek/smells/prima_donna_method_spec.rb

@@ -23,7 +23,6 @@ RSpec.describe Reek::Smells::PrimaDonnaMethod do
       smells = detector.inspect(ctx)
       warning = smells[0]
 
-      expect(warning.smell_category).to eq('PrimaDonnaMethod')
       expect(warning.smell_type).to eq('PrimaDonnaMethod')
       expect(warning.lines).to eq([1])
     end

data/spec/reek/smells/smell_detector_shared.rb

@@ -23,11 +23,7 @@ RSpec.shared_examples_for 'common fields set correctly' do
     expect(warning.source).to eq('string')
   end
 
-  it 'reports the smell class' do
-    expect(warning.smell_category).to eq(detector.smell_category)
-  end
-
-  it 'reports the smell sub class' do
+  it 'reports the smell type' do
     expect(warning.smell_type).to eq(detector.smell_type)
   end
 end

data/spec/reek/smells/too_many_methods_spec.rb

@@ -71,7 +71,6 @@ RSpec.describe Reek::Smells::TooManyMethods do
     ctx = Reek::Context::ModuleContext.new(nil, syntax_tree)
     warning = detector.inspect(ctx)[0]
     expect(warning.source).to eq(source_name)
-    expect(warning.smell_category).to eq(described_class.smell_category)
     expect(warning.smell_type).to eq(described_class.smell_type)
     expect(warning.parameters[:count]).to eq(3)
     expect(warning.lines).to eq([1])

data/spec/reek/smells/uncommunicative_module_name_spec.rb

@@ -30,7 +30,6 @@ RSpec.describe Reek::Smells::UncommunicativeModuleName do
       ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
       smells = detector.inspect(ctx)
       expect(smells.length).to eq(1)
-      expect(smells[0].smell_category).to eq(Reek::Smells::UncommunicativeModuleName.smell_category)
       expect(smells[0].smell_type).to eq(Reek::Smells::UncommunicativeModuleName.smell_type)
       expect(smells[0].parameters[:name]).to eq('X')
       expect(smells[0].context).to match(/#{smells[0].parameters[:name]}/)

data/spec/reek/smells/unused_private_method_spec.rb

@@ -37,16 +37,16 @@ RSpec.describe Reek::Smells::UnusedPrivateMethod do
         end
       EOF
 
-      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod', configuration: configuration)
+      examiner = Reek::Examiner.new(source,
+                                    filter_by_smells: 'UnusedPrivateMethod',
+                                    configuration: configuration)
 
       first_warning = examiner.smells.first
-      expect(first_warning.smell_category).to eq(Reek::Smells::UnusedPrivateMethod.smell_category)
       expect(first_warning.smell_type).to eq(Reek::Smells::UnusedPrivateMethod.smell_type)
       expect(first_warning.parameters[:name]).to eq(:drive)
       expect(first_warning.lines).to eq([4])
 
       second_warning = examiner.smells.last
-      expect(second_warning.smell_category).to eq(Reek::Smells::UnusedPrivateMethod.smell_category)
       expect(second_warning.smell_type).to eq(Reek::Smells::UnusedPrivateMethod.smell_type)
       expect(second_warning.parameters[:name]).to eq(:start)
       expect(second_warning.lines).to eq([3])
@@ -64,7 +64,9 @@ RSpec.describe Reek::Smells::UnusedPrivateMethod do
         end
       EOF
 
-      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod', configuration: configuration)
+      examiner = Reek::Examiner.new(source,
+                                    filter_by_smells: 'UnusedPrivateMethod',
+                                    configuration: configuration)
 
       expect(examiner.smells.size).to eq(1)
       warning_for_drive = examiner.smells.first

data/spec/reek/smells/utility_function_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Reek::Smells::UtilityFunction do
             arga.b.c
           end
         EOS
-        Reek::Examiner.new(src, ['UtilityFunction']).smells[0]
+        Reek::Examiner.new(src, filter_by_smells: ['UtilityFunction']).smells[0]
       end
 
       it_should_behave_like 'common fields set correctly'

data/spec/reek/spec/should_reek_of_spec.rb

@@ -3,11 +3,15 @@ require_relative '../../spec_helper'
 require_lib 'reek/spec'
 
 RSpec.describe Reek::Spec::ShouldReekOf do
-  describe 'smell type check' do
+  describe 'smell type selection' do
     let(:ruby) { 'def double_thing() @other.thing.foo + @other.thing.foo end' }
 
-    it 'reports duplicate calls' do
-      expect(ruby).to reek_of(:Duplication)
+    it 'reports duplicate calls by smell type' do
+      expect(ruby).to reek_of(:DuplicateMethodCall)
+    end
+
+    it 'reports duplicate calls by smell detector class' do
+      expect(ruby).to reek_of(Reek::Smells::DuplicateMethodCall)
     end
 
     it 'does not report any feature envy' do

data/spec/reek/spec/smell_matcher_spec.rb

@@ -55,10 +55,6 @@ RSpec.describe Reek::Spec::SmellMatcher do
       expect(matcher.matches_smell_type?(:UncommunicativeVariableName)).to be_truthy
     end
 
-    it 'matches on category symbol' do
-      expect(matcher.matches_smell_type?(:UncommunicativeName)).to be_truthy
-    end
-
     it 'does not match on different class symbol' do
       expect(matcher.matches_smell_type?(:FeatureEnvy)).to be_falsy
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: '3.11'
+  version: 4.0.0.pre1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -393,15 +393,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby