reek 3.3.1 → 3.4.0

data/lib/reek/spec.rb

@@ -39,6 +39,7 @@ module Reek
   #   ruby.should reek_of(:Duplication, /@other.thing.foo/)
   #   ruby.should_not reek_of(:FeatureEnvy)
   #
+  # @public
   module Spec
     #
     # Checks the target source code for instances of "smell category"
@@ -85,6 +86,9 @@ module Reek
     #
     #   expect(src).to reek_of(Reek::Smells::DuplicateMethodCall, name: '@other.thing')
     #
+    # @public
+    #
+    # :reek:UtilityFunction
     def reek_of(smell_category,
                 smell_details = {},
                 configuration = Configuration::AppConfiguration.default)
@@ -98,6 +102,10 @@ module Reek
     #   1.) "reek_of" doesn't mind if there are other smells of a different category.
     #       "reek_only_of" will fail in that case.
     #   2.) "reek_only_of" doesn't support the additional smell_details hash.
+    #
+    # @public
+    #
+    # :reek:UtilityFunction
     def reek_only_of(smell_category, configuration = Configuration::AppConfiguration.default)
       ShouldReekOnlyOf.new(smell_category, configuration)
     end
@@ -105,6 +113,9 @@ module Reek
     #
     # Returns +true+ if and only if the target source code contains smells.
     #
+    # @public
+    #
+    # :reek:UtilityFunction
     def reek(configuration = Configuration::AppConfiguration.default)
       ShouldReek.new(configuration: configuration)
     end

data/lib/reek/spec/should_reek.rb

@@ -6,7 +6,6 @@ module Reek
     #
     # An rspec matcher that matches when the +actual+ has code smells.
     #
-    # @api private
     class ShouldReek
       def initialize(configuration: Configuration::AppConfiguration.default)
         @configuration = configuration
@@ -26,8 +25,6 @@ module Reek
         "Expected no smells, but got:\n#{rpt}"
       end
 
-      private
-
       private_attr_reader :configuration
       private_attr_accessor :examiner
     end

data/lib/reek/spec/should_reek_of.rb

@@ -6,7 +6,6 @@ module Reek
     # An rspec matcher that matches when the +actual+ has the specified
     # code smell.
     #
-    # @api private
     class ShouldReekOf
       def initialize(smell_category,
                      smell_details = {},
@@ -35,6 +34,7 @@ module Reek
       private_attr_reader :configuration, :smell_category, :smell_details
       private_attr_accessor :all_smells, :examiner
 
+      # :reek:UtilityFunction
       def normalize(smell_category_or_type)
         # In theory, users can give us many different types of input (see the documentation for
         # reek_of below), however we're basically ignoring all of those subleties and just

data/lib/reek/spec/should_reek_only_of.rb

@@ -8,7 +8,6 @@ module Reek
     # An rspec matcher that matches when the +actual+ has the specified
     # code smell and no others.
     #
-    # @api private
     class ShouldReekOnlyOf < ShouldReekOf
       def matches?(actual)
         matches_examiner?(Examiner.new(actual, configuration: configuration))

data/lib/reek/tree_dresser.rb

@@ -5,7 +5,6 @@ module Reek
   # Adorns an abstract syntax tree with mix-in modules to make accessing
   # the tree more understandable and less implementation-dependent.
   #
-  # @api private
   class TreeDresser
     def initialize(klass_map: AST::ASTNodeClassMap.new)
       @klass_map = klass_map
@@ -35,6 +34,9 @@ module Reek
     # @param parent [Parser::AST::Node] - the parent sexp
     #
     # @return an instance of Reek::AST::Node with type-dependent sexp extensions mixed in.
+    #
+    # :reek:FeatureEnvy
+    # :reek:TooManyStatements: { max_statements: 6 }
     def dress(sexp, comment_map, parent: nil)
       return sexp unless sexp.is_a? ::Parser::AST::Node
       type = sexp.type

data/lib/reek/tree_walker.rb

@@ -15,7 +15,7 @@ module Reek
   # TODO: Make TreeWalker responsible only for creating Context objects, and
   # loop over the created set of contexts elsewhere.
   #
-  # @api private
+  # :reek:TooManyMethods: { max_methods: 29 }
   class TreeWalker
     def initialize(smell_repository, exp)
       @smell_repository = smell_repository
@@ -86,10 +86,8 @@ module Reek
 
     def process_args(_) end
 
-    #
-    # Recording of calls to methods and self
-    #
-
+    # :reek:TooManyStatements: { max_statements: 6 }
+    # :reek:FeatureEnvy
     def process_send(exp)
       if exp.visibility_modifier?
         element.track_visibility(exp.method_name, exp.arg_names)
@@ -188,6 +186,7 @@ module Reek
       self.class.private_method_defined?(name)
     end
 
+    # :reek:ControlParameter
     def count_clause(sexp)
       element.count_statements(1) if sexp
     end

data/lib/reek/version.rb

@@ -1,8 +1,11 @@
+# @public
 module Reek
   #
   # This module holds the Reek version informations
   #
+  # @public
   module Version
-    STRING = '3.3.1'
+    # @public
+    STRING = '3.4.0'
   end
 end

data/reek.gemspec

@@ -35,5 +35,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'factory_girl',  '~> 4.0'
   s.add_development_dependency 'rake',          '~> 10.0'
   s.add_development_dependency 'rspec',         '~> 3.0'
-  s.add_development_dependency 'rubocop',       '~> 0.32.1'
+  s.add_development_dependency 'rubocop',       '~> 0.33.0'
 end

data/spec/factories/factories.rb

@@ -3,15 +3,23 @@ require_relative '../../lib/reek/smells/smell_detector'
 require_relative '../../lib/reek/smells/smell_warning'
 
 FactoryGirl.define do
+  factory :context, class: Reek::Context::CodeContext do
+    skip_create
+
+    initialize_with do
+      new(nil, nil)
+    end
+  end
+
   factory :smell_detector, class: Reek::Smells::SmellDetector do
     skip_create
     transient do
       smell_type 'FeatureEnvy'
+      source 'foo'
     end
-    source 'dummy_file'
 
     initialize_with do
-      ::Reek::Smells.const_get(smell_type).new(source)
+      ::Reek::Smells.const_get(smell_type).new
     end
   end
 
@@ -19,15 +27,18 @@ FactoryGirl.define do
     skip_create
     smell_detector
     context 'self'
+    source 'dummy_file'
     lines [42]
     message 'smell warning message'
     parameters { {} }
 
     initialize_with do
-      new(smell_detector, context: context,
-                          lines: lines,
-                          message: message,
-                          parameters: parameters)
+      new(smell_detector,
+          source: source,
+          context: context,
+          lines: lines,
+          message: message,
+          parameters: parameters)
     end
   end
 end

data/spec/quality/reek_source_spec.rb

@@ -2,6 +2,8 @@ require_relative '../spec_helper'
 
 RSpec.describe 'Reek source code' do
   it 'has no smells' do
-    expect(Dir['lib/**/*.rb']).to_not reek
+    Pathname.glob('lib/**/*.rb').each do |pathname|
+      expect(pathname).to_not reek
+    end
   end
 end

data/spec/reek/cli/warning_collector_spec.rb

@@ -13,8 +13,9 @@ RSpec.describe Reek::CLI::WarningCollector do
 
   context 'with one warning' do
     it 'reports that warning' do
-      warning = Reek::Smells::SmellWarning.new(Reek::Smells::FeatureEnvy.new(''),
-                                               context: 'fred',
+      warning = Reek::Smells::SmellWarning.new(Reek::Smells::FeatureEnvy.new,
+                                               source:  'string',
+                                               context: 'foo',
                                                lines:   [1, 2, 3],
                                                message: 'hello')
       collector.found_smell(warning)

data/spec/reek/code_comment_spec.rb

@@ -36,17 +36,11 @@ RSpec.describe Reek::CodeComment do
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
     end
-    it 'parses hashed options with Ruby names' do
-      comment = '# :reek:nested_iterators: { enabled: true }'
-      config = described_class.new(comment).config
-      expect(config).to include('NestedIterators')
-      expect(config['NestedIterators']).to include('enabled')
-      expect(config['NestedIterators']['enabled']).to be_truthy
-    end
+
     it 'parses multiple hashed options' do
       config = described_class.new('
         # :reek:Duplication: { enabled: false }
-        :reek:nested_iterators: { enabled: true }
+        # :reek:NestedIterators: { enabled: true }
       ').config
       expect(config).to include('Duplication', 'NestedIterators')
       expect(config['Duplication']).to include('enabled')
@@ -54,9 +48,10 @@ RSpec.describe Reek::CodeComment do
       expect(config['NestedIterators']).to include('enabled')
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
+
     it 'parses multiple hashed options on the same line' do
       config = described_class.new('
-        #:reek:Duplication: { enabled: false } and :reek:nested_iterators: { enabled: true }
+        #:reek:Duplication: { enabled: false } and :reek:NestedIterators: { enabled: true }
       ').config
       expect(config).to include('Duplication', 'NestedIterators')
       expect(config['Duplication']).to include('enabled')
@@ -64,8 +59,9 @@ RSpec.describe Reek::CodeComment do
       expect(config['NestedIterators']).to include('enabled')
       expect(config['NestedIterators']['enabled']).to be_truthy
     end
+
     it 'parses multiple unhashed options on the same line' do
-      comment = '# :reek:Duplication and :reek:nested_iterators'
+      comment = '# :reek:Duplication and :reek:NestedIterators'
       config = described_class.new(comment).config
       expect(config).to include('Duplication', 'NestedIterators')
       expect(config['Duplication']).to include('enabled')
@@ -73,12 +69,14 @@ RSpec.describe Reek::CodeComment do
       expect(config['NestedIterators']).to include('enabled')
       expect(config['NestedIterators']['enabled']).to be_falsey
     end
+
     it 'disables the smell if no options are specifed' do
       config = described_class.new('# :reek:Duplication').config
       expect(config).to include('Duplication')
       expect(config['Duplication']).to include('enabled')
       expect(config['Duplication']['enabled']).to be_falsey
     end
+
     it 'ignores smells after a space' do
       config = described_class.new('# :reek: Duplication').config
       expect(config).not_to include('Duplication')

data/spec/reek/configuration/directory_directives_spec.rb

@@ -36,7 +36,7 @@ RSpec.describe Reek::Configuration::DirectoryDirectives do
       let(:bogus_path) { Pathname('does/not/exist') }
 
       it 'raises an error' do
-        Reek::CLI::Silencer.silently(stderr: true) do
+        Reek::CLI::Silencer.silently do
           expect { subject.add(bogus_path, {}) }.to raise_error(SystemExit)
         end
       end
@@ -46,7 +46,7 @@ RSpec.describe Reek::Configuration::DirectoryDirectives do
       let(:file_as_path) { SAMPLES_PATH.join('inline.rb') }
 
       it 'raises an error' do
-        Reek::CLI::Silencer.silently(stderr: true) do
+        Reek::CLI::Silencer.silently do
           expect { subject.add(file_as_path, {}) }.to raise_error(SystemExit)
         end
       end

data/spec/reek/configuration/excluded_paths_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Reek::Configuration::ExcludedPaths do
       let(:paths) { [SAMPLES_PATH, bogus_path] }
 
       it 'raises an error' do
-        Reek::CLI::Silencer.silently(stderr: true) do
+        Reek::CLI::Silencer.silently do
           expect { subject.add(paths) }.to raise_error(SystemExit)
         end
       end
@@ -21,7 +21,7 @@ RSpec.describe Reek::Configuration::ExcludedPaths do
       let(:paths) { [SAMPLES_PATH, file_as_path] }
 
       it 'raises an error if one of the given paths is a file' do
-        Reek::CLI::Silencer.silently(stderr: true) do
+        Reek::CLI::Silencer.silently do
           expect { subject.add(paths) }.to raise_error(SystemExit)
         end
       end

data/spec/reek/context/method_context_spec.rb

@@ -22,32 +22,6 @@ RSpec.describe Reek::Context::MethodContext do
     end
   end
 
-  describe '#envious_receivers' do
-    let(:exp) { sexp(:def, :foo, sexp(:args, sexp(:arg, :bar)), nil) }
-
-    it 'should ignore ivars as refs to self' do
-      method_context.record_call_to sexp(:send, sexp(:ivar, :@cow), :feed_to)
-      expect(method_context.envious_receivers).to be_empty
-    end
-
-    it 'should ignore explicit calls to self' do
-      method_context.refs.record_reference_to :other
-      method_context.record_call_to sexp(:send, sexp(:self), :thing)
-      expect(method_context.envious_receivers).to be_empty
-    end
-
-    it 'should ignore implicit calls to self' do
-      method_context.record_call_to sexp(:send, sexp(:lvar, :text), :each, sexp(:arglist))
-      method_context.record_call_to sexp(:send, nil, :shelve, sexp(:arglist))
-      expect(method_context.envious_receivers).to be_empty
-    end
-
-    it 'should record envious calls' do
-      method_context.record_call_to sexp(:send, sexp(:lvar, :bar), :baz)
-      expect(method_context.envious_receivers).to include(:bar)
-    end
-  end
-
   describe '#default_assignments' do
     def assignments_from(src)
       exp = Reek::Source::SourceCode.from(src).syntax_tree

data/spec/reek/report/json_report_spec.rb

@@ -3,18 +3,95 @@ require_relative '../../../lib/reek/examiner'
 require_relative '../../../lib/reek/report/report'
 require_relative '../../../lib/reek/report/formatter'
 
+require 'json'
+require 'stringio'
+
 RSpec.describe Reek::Report::JSONReport do
-  let(:instance) { Reek::Report::JSONReport.new }
+  let(:options) { {} }
+  let(:instance) { Reek::Report::JSONReport.new(options) }
+  let(:examiner) { Reek::Examiner.new(source) }
 
-  context 'empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
+  before do
+    instance.add_examiner examiner
+  end
 
-    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 <<-EOS
+        [
+          {
+            "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"
+          },
+          {
+            "context":        "simple",
+            "lines":          [1],
+            "message":        "has the parameter name 'a'",
+            "smell_category": "UncommunicativeName",
+            "smell_type":     "UncommunicativeParameterName",
+            "source":         "string",
+            "name":           "a"
+          }
+        ]
+      EOS
+
+      expect(result).to eq expected
+    end
+
+    context 'with link formatter' do
+      let(:options) { { warning_formatter: Reek::Report::WikiLinkWarningFormatter.new } }
+
+      it 'prints documentation links' do
+        out = StringIO.new
+        instance.show(out)
+        out.rewind
+        result = JSON.parse(out.read)
+        expected = JSON.parse <<-EOS
+          [
+            {
+              "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",
+              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
+            },
+            {
+              "context":        "simple",
+              "lines":          [1],
+              "message":        "has the parameter name 'a'",
+              "smell_category": "UncommunicativeName",
+              "smell_type":     "UncommunicativeParameterName",
+              "source":         "string",
+              "name":           "a",
+              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
+            }
+          ]
+        EOS
+
+        expect(result).to eq expected
+      end
+    end
+  end
 end