reek 3.5.0 → 3.6.0

data/spec/reek/smells/too_many_instance_variables_spec.rb

@@ -3,10 +3,7 @@ require_lib 'reek/smells/too_many_instance_variables'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::TooManyInstanceVariables do
-  let(:source_name) { 'string' }
-  let(:detector) do
-    build(:smell_detector, smell_type: :TooManyInstanceVariables, source: source_name)
-  end
+  let(:detector) { build(:smell_detector, smell_type: :TooManyInstanceVariables) }
 
   it_should_behave_like 'SmellDetector'
 
@@ -77,21 +74,25 @@ RSpec.describe Reek::Smells::TooManyInstanceVariables do
     end
   end
 
-  it 'reports correctly for excessive instance variables' do
-    src = <<-EOS
-      # Comment
-      class Empty
-        def ivars
-          #{ivar_sequence(count: too_many_ivars)}
+  context 'when a smell is reported' do
+    let(:warning) do
+      src = <<-EOS
+        # Comment
+        class Empty
+          def ivars
+            #{ivar_sequence(count: too_many_ivars)}
+          end
         end
-      end
-    EOS
-    ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
-    warning = detector.examine_context(ctx)[0]
-    expect(warning.source).to eq(source_name)
-    expect(warning.smell_category).to eq(Reek::Smells::TooManyInstanceVariables.smell_category)
-    expect(warning.smell_type).to eq(Reek::Smells::TooManyInstanceVariables.smell_type)
-    expect(warning.parameters[:count]).to eq(too_many_ivars)
-    expect(warning.lines).to eq([2])
+      EOS
+      ctx = Reek::Context::CodeContext.new(nil, Reek::Source::SourceCode.from(src).syntax_tree)
+      detector.examine_context(ctx).first
+    end
+
+    it_should_behave_like 'common fields set correctly'
+
+    it 'reports the correct values' do
+      expect(warning.parameters[:count]).to eq(too_many_ivars)
+      expect(warning.lines).to eq([2])
+    end
   end
 end

data/spec/reek/smells/too_many_statements_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe Reek::Smells::TooManyStatements do
 end
 
 RSpec.describe Reek::Smells::TooManyStatements do
-  let(:detector) { build(:smell_detector, smell_type: :TooManyStatements, source: 'source_name') }
+  let(:detector) { build(:smell_detector, smell_type: :TooManyStatements) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/uncommunicative_method_name_spec.rb

@@ -3,10 +3,7 @@ require_lib 'reek/smells/uncommunicative_method_name'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UncommunicativeMethodName do
-  let(:source_name) { 'string' }
-  let(:detector) do
-    build(:smell_detector, smell_type: :UncommunicativeMethodName, source: source_name)
-  end
+  let(:detector) { build(:smell_detector, smell_type: :UncommunicativeMethodName) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/uncommunicative_module_name_spec.rb

@@ -4,10 +4,7 @@ require_relative 'smell_detector_shared'
 require_lib 'reek/context/code_context'
 
 RSpec.describe Reek::Smells::UncommunicativeModuleName do
-  let(:source_name) { 'string' }
-  let(:detector) do
-    build(:smell_detector, smell_type: :UncommunicativeModuleName, source: source_name)
-  end
+  let(:detector) { build(:smell_detector, smell_type: :UncommunicativeModuleName) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/uncommunicative_parameter_name_spec.rb

@@ -4,10 +4,7 @@ require_relative 'smell_detector_shared'
 require_lib 'reek/context/method_context'
 
 RSpec.describe Reek::Smells::UncommunicativeParameterName do
-  let(:detector) do
-    build(:smell_detector, smell_type: :UncommunicativeParameterName, source: source_name)
-  end
-  let(:source_name) { 'string' }
+  let(:detector) { build(:smell_detector, smell_type: :UncommunicativeParameterName) }
 
   it_should_behave_like 'SmellDetector'
 

data/spec/reek/smells/uncommunicative_variable_name_spec.rb

@@ -3,9 +3,8 @@ require_lib 'reek/smells/uncommunicative_variable_name'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UncommunicativeVariableName do
-  let(:source_name) { 'string' }
   let(:detector) do
-    build(:smell_detector, smell_type: :UncommunicativeVariableName, source: source_name)
+    build(:smell_detector, smell_type: :UncommunicativeVariableName)
   end
 
   it_should_behave_like 'SmellDetector'
@@ -65,7 +64,8 @@ RSpec.describe Reek::Smells::UncommunicativeVariableName do
     end
 
     it 'reports variable name outside any method' do
-      expect('class Simple; x = jim(45); end').to reek_of(:UncommunicativeVariableName, name: 'x')
+      expect('class Simple; x = jim(45); end').to reek_of(:UncommunicativeVariableName,
+                                                          name: 'x')
     end
   end
 

data/spec/reek/smells/utility_function_spec.rb

@@ -3,11 +3,9 @@ require_lib 'reek/smells/utility_function'
 require_lib 'reek/examiner'
 require_relative 'smell_detector_shared'
 
-# TODO: Bring specs in line with specs for other detectors
 RSpec.describe Reek::Smells::UtilityFunction do
   describe 'a detector' do
-    let(:detector) { build(:smell_detector, smell_type: :UtilityFunction, source: source_name) }
-    let(:source_name) { 'string' }
+    let(:detector) { build(:smell_detector, smell_type: :UtilityFunction) }
 
     it_should_behave_like 'SmellDetector'
 

data/spec/reek/spec/should_reek_of_spec.rb

@@ -4,14 +4,14 @@ require_lib 'reek/spec'
 
 RSpec.describe Reek::Spec::ShouldReekOf do
   describe 'smell type check' do
-    let(:src) { 'def double_thing() @other.thing.foo + @other.thing.foo end' }
+    let(:ruby) { 'def double_thing() @other.thing.foo + @other.thing.foo end' }
 
     it 'reports duplicate calls' do
-      expect(src).to reek_of(:Duplication)
+      expect(ruby).to reek_of(:Duplication)
     end
 
-    it 'does not report any other smell types' do
-      expect(src).not_to reek_of(:FeatureEnvy)
+    it 'does not report any feature envy' do
+      expect(ruby).not_to reek_of(:FeatureEnvy)
     end
   end
 
@@ -66,6 +66,7 @@ RSpec.describe Reek::Spec::ShouldReekOf do
 
     context 'no smell_type is matching' do
       let(:smelly_code) { 'def dummy() y = 4; end' }
+
       let(:falsey_matcher) { Reek::Spec::ShouldReekOf.new(:FeatureEnvy, name: 'y') }
       let(:truthy_matcher) { Reek::Spec::ShouldReekOf.new(:UncommunicativeVariableName, name: 'y') }
 
@@ -98,7 +99,6 @@ RSpec.describe Reek::Spec::ShouldReekOf do
 
       it 'sets the proper error message' do
         matcher.matches?(smelly_code)
-
         expect(matcher.failure_message).to\
           match('Expected string to reek of UncommunicativeVariableName (which it did) with '\
                   'smell details {:name=>"x"}, which it didn\'t')

data/spec/reek/spec/smell_matcher_spec.rb

@@ -0,0 +1,92 @@
+require_relative '../../spec_helper'
+require_lib 'reek/spec/smell_matcher'
+
+RSpec.describe Reek::Spec::SmellMatcher do
+  let(:detector) { build(:smell_detector, smell_type: 'UncommunicativeVariableName') }
+  let(:smell_warning) do
+    build(:smell_warning, smell_detector: detector,
+                          message: "has the variable name '@s'",
+                          parameters: { test: 'something' })
+  end
+  let(:matcher) { described_class.new(smell_warning) }
+
+  context '#matches?' do
+    it 'matches on class symbol' do
+      expect(matcher.matches?(:UncommunicativeVariableName)).to be_truthy
+    end
+
+    it 'matches on class symbol and params' do
+      expect(matcher.matches?(:UncommunicativeVariableName,
+                              test: 'something')).to be_truthy
+    end
+
+    it 'matches on class symbol, params and attributes' do
+      expect(matcher.matches?(:UncommunicativeVariableName,
+                              test: 'something',
+                              message: "has the variable name '@s'")).to be_truthy
+    end
+
+    it 'does not match on different class symbol' do
+      expect(matcher.matches?(:FeatureEnvy)).to be_falsy
+    end
+
+    it 'does not match on different params' do
+      expect(matcher.matches?(:UncommunicativeVariableName,
+                              test: 'something else')).to be_falsy
+    end
+
+    it 'does not match on different attributes' do
+      expect(matcher.matches?(:UncommunicativeVariableName,
+                              test: 'something',
+                              message: 'nothing')).to be_falsy
+    end
+
+    it 'raises error on uncomparable attribute' do
+      expect do
+        matcher.matches?(:UncommunicativeVariableName,
+                         test: 'something',
+                         random: 'nothing')
+      end.to raise_error("The attribute 'random' is not available for comparison")
+    end
+  end
+
+  context '#matches_smell_type?' do
+    it 'matches on class symbol' 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
+  end
+
+  context '#matches_attributes?' do
+    it 'matches on params' do
+      expect(matcher.matches_attributes?(test: 'something')).to be_truthy
+    end
+
+    it 'matches on class symbol, params and attributes' do
+      expect(matcher.matches_attributes?(test: 'something',
+                                         message: "has the variable name '@s'")).to be_truthy
+    end
+
+    it 'does not match on different params' do
+      expect(matcher.matches_attributes?(test: 'something else')).to be_falsy
+    end
+
+    it 'does not match on different attributes' do
+      expect(matcher.matches_attributes?(test: 'something',
+                                         message: 'nothing')).to be_falsy
+    end
+
+    it 'raises error on uncomparable attribute' do
+      expect do
+        matcher.matches_attributes? test: 'something', random: 'nothing'
+      end.to raise_error("The attribute 'random' is not available for comparison")
+    end
+  end
+end

data/tasks/configuration.rake

@@ -0,0 +1,15 @@
+require_relative '../lib/reek/smells/smell_repository'
+require 'yaml'
+
+namespace :configuration do
+  desc 'Updates the default configuration file when smell defaults change'
+  task :update_default_configuration do
+    DEFAULT_SMELL_CONFIGURATION = 'defaults.reek'
+    content = Reek::Smells::SmellRepository.smell_types.each_with_object({}) do |klass, hash|
+      hash[klass.smell_type] = klass.default_config
+    end
+    File.open(DEFAULT_SMELL_CONFIGURATION, 'w') { |file| YAML.dump(content, file) }
+  end
+end
+
+task 'test:spec' => 'configuration:update_default_configuration'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,13 +11,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.2.5
   type: :runtime
@@ -25,6 +28,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.2.5
 - !ruby/object:Gem::Dependency
@@ -217,9 +223,9 @@ files:
 - License.txt
 - README.md
 - Rakefile
+- ataru_setup.rb
 - bin/reek
-- config/cucumber.yml
-- config/defaults.reek
+- defaults.reek
 - docs/API.md
 - docs/Attribute.md
 - docs/Basic-Smell-Options.md
@@ -288,6 +294,23 @@ files:
 - lib/reek/ast/object_refs.rb
 - lib/reek/ast/reference_collector.rb
 - lib/reek/ast/sexp_extensions.rb
+- lib/reek/ast/sexp_extensions/arguments.rb
+- lib/reek/ast/sexp_extensions/attribute_assignments.rb
+- lib/reek/ast/sexp_extensions/block.rb
+- lib/reek/ast/sexp_extensions/case.rb
+- lib/reek/ast/sexp_extensions/constant.rb
+- lib/reek/ast/sexp_extensions/if.rb
+- lib/reek/ast/sexp_extensions/literal.rb
+- lib/reek/ast/sexp_extensions/logical_operators.rb
+- lib/reek/ast/sexp_extensions/methods.rb
+- lib/reek/ast/sexp_extensions/module.rb
+- lib/reek/ast/sexp_extensions/nested_assignables.rb
+- lib/reek/ast/sexp_extensions/send.rb
+- lib/reek/ast/sexp_extensions/super.rb
+- lib/reek/ast/sexp_extensions/symbols.rb
+- lib/reek/ast/sexp_extensions/variables.rb
+- lib/reek/ast/sexp_extensions/when.rb
+- lib/reek/ast/sexp_extensions/yield.rb
 - lib/reek/ast/sexp_formatter.rb
 - lib/reek/cli/application.rb
 - lib/reek/cli/command.rb
@@ -304,6 +327,7 @@ files:
 - lib/reek/configuration/default_directive.rb
 - lib/reek/configuration/directory_directives.rb
 - lib/reek/configuration/excluded_paths.rb
+- lib/reek/context/attribute_context.rb
 - lib/reek/context/code_context.rb
 - lib/reek/context/method_context.rb
 - lib/reek/context/module_context.rb
@@ -352,9 +376,16 @@ files:
 - lib/reek/spec/should_reek.rb
 - lib/reek/spec/should_reek_of.rb
 - lib/reek/spec/should_reek_only_of.rb
+- lib/reek/spec/smell_matcher.rb
 - lib/reek/tree_dresser.rb
 - lib/reek/tree_walker.rb
 - lib/reek/version.rb
+- logo/reek.bw.png
+- logo/reek.bw.svg
+- logo/reek.png
+- logo/reek.svg
+- logo/reek.text.png
+- logo/reek.text.svg
 - reek.gemspec
 - spec/factories/factories.rb
 - spec/quality/reek_source_spec.rb
@@ -417,6 +448,7 @@ files:
 - spec/reek/spec/should_reek_of_spec.rb
 - spec/reek/spec/should_reek_only_of_spec.rb
 - spec/reek/spec/should_reek_spec.rb
+- spec/reek/spec/smell_matcher_spec.rb
 - spec/reek/tree_dresser_spec.rb
 - spec/reek/tree_walker_spec.rb
 - spec/samples/all_but_one_masked/clean_one.rb
@@ -453,7 +485,7 @@ files:
 - spec/samples/two_smelly_files/dirty_one.rb
 - spec/samples/two_smelly_files/dirty_two.rb
 - spec/spec_helper.rb
-- tasks/develop.rake
+- tasks/configuration.rake
 - tasks/reek.rake
 - tasks/rubocop.rake
 - tasks/test.rake

data/config/cucumber.yml

@@ -1,3 +0,0 @@
-default: --tags ~@wip -fprogress -r features features
-wip: -fpretty --tags @wip --wip features
-

data/tasks/develop.rake

@@ -1,21 +0,0 @@
-require 'rake/clean'
-require_relative '../lib/reek/smells/smell_repository'
-
-CONFIG_FILE = 'config/defaults.reek'
-
-file CONFIG_FILE do
-  config = {}
-  Reek::Smells::SmellRepository.smell_types.each do |klass|
-    config[klass.name.split(/::/)[-1]] = klass.default_config
-  end
-  $stderr.puts "Creating #{CONFIG_FILE}"
-  require 'yaml'
-  File.open(CONFIG_FILE, 'w') { |f| YAML.dump(config, f) }
-end
-
-task CONFIG_FILE => FileList['lib/reek/smells/*.rb']
-
-task 'test:spec' => CONFIG_FILE
-task 'test:quality' => CONFIG_FILE
-task 'test:features' => CONFIG_FILE
-task 'reek' => CONFIG_FILE