reek 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71c1d52a08d1ce16364812f297d6a072109b406b
-  data.tar.gz: f0ea4129036dde1687ad6656c603d63e8a6ddaf2
+  metadata.gz: 7c09dc83cbd7c49a57a5e0568479ccf87a8c284d
+  data.tar.gz: 7a9643ce33812488821abaabaf157eee3ba1f886
 SHA512:
-  metadata.gz: 1228e4b9dc1f5673e7f474af1c6f5eb16d30eac8df72d4aecb4684b2ff2aa7796e62defe53a903ff9853444fe112187e3d7de7f40bd8c619c75d459d11273d7d
-  data.tar.gz: fb720491aa22c267bdccdfdb7296f9f89a216ab7da89d8e66f903c63bf401ee8beff14256a0b052bf284df93f81d27f9c050f1db1af3b15714f6b7a23565c425
+  metadata.gz: e85233445ea0535f360876d6f45398ff364aa895883b0175a60097839fbb5182b399496010c675253a9b79efdd15b1ca759db9253ea7febfc916efe2a3e3013f
+  data.tar.gz: cdc14223fc488191e56d3642c1bff7affeb9f4e97fc9f6030d1bd7988f7c75f133ad824724da58785c44556ab0a2483f7893f35c219eb666f22dfcb21f8b6082

data/.travis.yml

@@ -2,10 +2,7 @@ sudo: false
 cache: bundler
 language: ruby
 bundler_args: --without debugging
-script:
-- bundle exec rake
-- bundle exec ataru check
-- bundle exec mutant --include lib --require reek --use rspec --since master --jobs 4 "Reek*"
+script: bundle exec rake ci
 rvm:
   - 2.1
   - 2.2
@@ -30,3 +27,6 @@ notifications:
     - matijs@matijs.net
     - chastell@chastell.net
   irc: irc.freenode.org#reek
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.0.4 (2016-06-11)
+
+* (troessner) Bump parser
+
 ## 4.0.3 (2016-05-23)
 
 * (mvz) Include default exclusions in generated TODO file

data/Gemfile

@@ -7,12 +7,12 @@ group :development do
   gem 'ataru',         '~> 0.2.0'
   gem 'cucumber',      '~> 2.0'
   gem 'factory_girl',  '~> 4.0'
+  gem 'mutant-rspec',  '~> 0.8.8'
   gem 'rake',          '~> 11.1'
   gem 'rspec',         '~> 3.0'
   gem 'rubocop',       '~> 0.39.0'
-  gem 'yard',          '~> 0.8.7'
   gem 'simplecov',     '~> 0.11.1'
-  gem 'mutant-rspec',  '~> 0.8.8'
+  gem 'yard',          '~> 0.8.7'
 
   platforms :mri do
     gem 'redcarpet', '~> 3.3.1'
@@ -21,8 +21,8 @@ end
 
 group :debugging do
   # Fixing https://github.com/guard/guard/wiki/Add-Readline-support-to-Ruby-on-Mac-OS-X#option-4-using-a-pure-ruby-readline-implementation
-  gem 'rb-readline', '~> 0.5.3'
   gem 'pry'
+  gem 'rb-readline', '~> 0.5.3'
   platforms :mri do
     gem 'pry-byebug'
     gem 'pry-stack_explorer'

data/Rakefile

@@ -3,6 +3,6 @@ require 'rake/clean'
 
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-task default: :test
-task default: :rubocop unless RUBY_ENGINE == 'rbx'
-task default: 'test:quality'
+task local_test_run: [:test, :rubocop, 'test:quality']
+task ci: [:test, :rubocop, 'test:quality', :ataru, :mutant]
+task default: :local_test_run

data/docs/Class-Variable.md

@@ -4,7 +4,7 @@
 
 Class variables form part of the global runtime state, and as such make it easy for one part of the system to accidentally or inadvertently depend on another part of the system. So the system becomes more prone to problems where changing something over here breaks something over there. In particular, class variables can make it hard to set up tests (because the context of the test includes all global state).
 
-For a detailed explanation, check out [this article](http://4thmouse.com/index.php/2011/03/20/why-class-variables-in-ruby-are-a-bad-idea/)
+For a detailed explanation, check out [this article](http://4thmouse.com/index.php/2011/03/20/why-class-variables-in-ruby-are-a-bad-idea/).
 
 ## Example
 

data/docs/Control-Parameter.md

@@ -2,7 +2,7 @@
 
 ## Introduction
 
-_Control Parameter_ is a case of [Control Couple](Control-Couple.md)
+_Control Parameter_ is a case of [Control Couple](Control-Couple.md).
 
 ## Example
 

data/docs/Duplicate-Method-Call.md

@@ -10,7 +10,7 @@ Reek implements a check for _Duplicate Method Call_.
 Here's a very much simplified and contrived example. The following method will report a warning:
 
 ```Ruby
-def double_thing()
+def double_thing
   @other.thing + @other.thing
 end
 ```
@@ -18,19 +18,23 @@ end
 One quick approach to silence Reek would be to refactor the code thus:
 
 ```Ruby
-def double_thing()
+def double_thing
   thing = @other.thing
   thing + thing
 end
 ```
 
-A slightly different approach would be to replace all calls of `double_thing` by calls to `@other.double_thing`:
+A slightly different approach would be to replace all calls in `double_thing` by calls to `thing`:
 
 ```Ruby
 class Other
-  def double_thing()
+  def double_thing
     thing + thing
   end
+
+  def thing
+    @other.thing
+  end
 end
 ```
 

data/features/samples.feature

@@ -177,7 +177,7 @@ Feature: Basic smell detection
       UnusedParameters: OptionParser::Completion#convert has unused parameter 'opt' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::NoArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
-    redcloth.rb -- 101 warnings:
+    redcloth.rb -- 102 warnings:
       Attribute: RedCloth#filter_html is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#filter_styles is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#hard_breaks is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -216,6 +216,7 @@ Feature: Basic smell detection
       LongParameterList: RedCloth#textile_fn_ has 5 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       LongParameterList: RedCloth#textile_p has 4 parameters [https://github.com/troessner/reek/blob/master/docs/Long-Parameter-List.md]
       NestedIterators: RedCloth#block_textile_lists contains iterators nested 3 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
+      NestedIterators: RedCloth#block_textile_table contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NestedIterators: RedCloth#block_textile_table contains iterators nested 3 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NestedIterators: RedCloth#blocks contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
       NestedIterators: RedCloth#clean_html contains iterators nested 2 deep [https://github.com/troessner/reek/blob/master/docs/Nested-Iterators.md]
@@ -279,5 +280,5 @@ Feature: Basic smell detection
       UtilityFunction: RedCloth#lT doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#no_textile doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#v_align doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    265 total warnings
+    266 total warnings
     """

data/lib/reek/smells/data_clump.rb

@@ -53,8 +53,8 @@ module Reek
       #
       # :reek:FeatureEnvy
       def inspect(ctx)
-        max_copies = value(MAX_COPIES_KEY, ctx, DEFAULT_MAX_COPIES)
-        min_clump_size = value(MIN_CLUMP_SIZE_KEY, ctx, DEFAULT_MIN_CLUMP_SIZE)
+        max_copies = value(MAX_COPIES_KEY, ctx)
+        min_clump_size = value(MIN_CLUMP_SIZE_KEY, ctx)
         MethodGroup.new(ctx, min_clump_size, max_copies).clumps.map do |clump, methods|
           methods_length = methods.length
           smell_warning(

data/lib/reek/smells/duplicate_method_call.rb

@@ -45,8 +45,8 @@ module Reek
       # :reek:FeatureEnvy
       # :reek:DuplicateMethodCall: { max_calls: 2 }
       def inspect(ctx)
-        max_allowed_calls = value(MAX_ALLOWED_CALLS_KEY, ctx, DEFAULT_MAX_CALLS)
-        allow_calls = value(ALLOW_CALLS_KEY, ctx, DEFAULT_ALLOW_CALLS)
+        max_allowed_calls = value(MAX_ALLOWED_CALLS_KEY, ctx)
+        allow_calls = value(ALLOW_CALLS_KEY, ctx)
 
         collector = CallCollector.new(ctx, max_allowed_calls, allow_calls)
         collector.smelly_calls.map do |found_call|

data/lib/reek/smells/long_parameter_list.rb

@@ -35,7 +35,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def inspect(ctx)
-        max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY, ctx, DEFAULT_MAX_ALLOWED_PARAMS)
+        max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY, ctx)
         exp = ctx.exp
         count = exp.arg_names.length
         return [] if count <= max_allowed_params

data/lib/reek/smells/long_yield_list.rb

@@ -27,9 +27,7 @@ module Reek
       # :reek:FeatureEnvy
       # :reek:DuplicateMethodCall: { max_calls: 2 }
       def inspect(ctx)
-        max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY,
-                                   ctx,
-                                   DEFAULT_MAX_ALLOWED_PARAMS)
+        max_allowed_params = value(MAX_ALLOWED_PARAMS_KEY, ctx)
         ctx.local_nodes(:yield).select do |yield_node|
           yield_node.args.length > max_allowed_params
         end.map do |yield_node|

data/lib/reek/smells/nested_iterators.rb

@@ -13,9 +13,8 @@ module Reek
     class NestedIterators < SmellDetector
       # Struct for conveniently associating iterators with their depth (that is, their nesting).
       Iterator = Struct.new :exp, :depth do
-        include Comparable
-        def <=>(other)
-          depth <=> other.depth
+        def line
+          exp.line
         end
       end
 
@@ -36,41 +35,55 @@ module Reek
         )
       end
 
-      #
-      # Attempts to find the deepest nested iterator and warns if it's depth
-      # is bigger than our allowed maximum.
+      # Generates a smell warning for each independent deepest nesting depth
+      # that is greater than our allowed maximum. This means if two iterators
+      # with the same depth were found, we combine them into one warning and
+      # merge the line information.
       #
       # @return [Array<SmellWarning>]
       #
-      # :reek:TooManyStatements: { max_statements: 6 }
       def inspect(ctx)
-        configure_ignore_iterators(ctx)
-        deepest_iterator = find_deepest_iterator ctx
-        return [] unless deepest_iterator
-        depth = deepest_iterator.depth
-        return [] unless depth > max_nesting(ctx)
+        configure_ignore_iterators ctx
+        violations = find_violations ctx
 
-        [smell_warning(
-          context: ctx,
-          lines: [deepest_iterator.exp.line],
-          message: "contains iterators nested #{depth} deep",
-          parameters: { name: ctx.full_name, count: depth })]
+        violations.group_by(&:depth).map do |depth, group|
+          lines = group.map(&:line)
+          smell_warning(
+            context: ctx,
+            lines: lines,
+            message: "contains iterators nested #{depth} deep",
+            parameters: { name: ctx.full_name, count: depth })
+        end
       end
 
       private
 
       attr_accessor :ignore_iterators
 
+      # Finds the set of independent most deeply nested iterators that are
+      # nested more deeply than allowed.
+      #
+      # Here, independent means that if iterator A is contained within iterator
+      # B, we only include A. But if iterators A and B are both contained in
+      # iterator C, but A is not contained in B, nor B in A, both A and B are
+      # included.
+      #
+      # @return [Array<Iterator>]
+      #
+      def find_violations(ctx)
+        candidates = find_candidates ctx
+        max_allowed_nesting = max_nesting(ctx)
+        candidates.select { |it| it.depth > max_allowed_nesting }
+      end
+
+      # Finds the set of independent most deeply nested iterators regardless of
+      # nesting depth.
       #
-      # @return [Iterator|nil]
+      # @return [Array<Iterator>]
       #
-      def find_deepest_iterator(ctx)
+      def find_candidates(ctx)
         exp = ctx.exp
-        return nil unless exp.find_nodes([:block])
-        scout(parent: exp, exp: exp, depth: 0).
-          flatten.
-          sort.
-          last
+        scout(exp: exp, depth: 0)
       end
 
       # A little digression into parser's sexp is necessary here:
@@ -79,36 +92,38 @@ module Reek
       #   foo.each() do ... end
       # this will end up as:
       #
-      # "foo.each() do ... end" -> the iterator below
-      # "each()"                -> the "call" below
-      # "do ... end"            -> the "block" below
-      #
-      # @param parent [AST::Node] The parent iterator
+      # "foo.each() do ... end" -> one of the :block nodes
+      # "each()"                -> the node's "call"
+      # "do ... end"            -> the node's "block"
       #
       # @param exp [AST::Node]
       #   The given expression to analyze.
-      #   Will be nil on empty blocks so we'll return just the parent iterator
       #
       # @param depth [Integer]
       #
       # @return [Array<Iterator>]
       #
-      def scout(parent:, exp:, depth:)
-        return [Iterator.new(parent, depth)] unless exp
-        iterators = exp.find_nodes([:block])
-        return [Iterator.new(parent, depth)] if iterators.empty?
-        iterators.map do |iterator|
+      # :reek:TooManyStatements: { max_statements: 6 }
+      def scout(exp:, depth:)
+        return [] unless exp
+        exp.find_nodes([:block]).flat_map do |iterator|
+          new_depth = increment_depth(iterator, depth)
           # 1st case: we recurse down the given block of the iterator. In this case
           # we need to check if we should increment the depth.
           # 2nd case: we recurse down the associated call of the iterator. In this case
           # the depth stays the same.
-          scout(parent: iterator, exp: iterator.block, depth: increment_depth(iterator, depth)) +
-            scout(parent: iterator, exp: iterator.call, depth: depth)
+          nested_iterators = scout(exp: iterator.block, depth: new_depth) +
+            scout(exp: iterator.call, depth: depth)
+          if nested_iterators.empty?
+            Iterator.new(iterator, new_depth)
+          else
+            nested_iterators
+          end
         end
       end
 
       def configure_ignore_iterators(ctx)
-        self.ignore_iterators = value(IGNORE_ITERATORS_KEY, ctx, DEFAULT_IGNORE_ITERATORS)
+        self.ignore_iterators = value(IGNORE_ITERATORS_KEY, ctx)
       end
 
       def increment_depth(iterator, depth)
@@ -116,7 +131,7 @@ module Reek
       end
 
       def max_nesting(ctx)
-        value(MAX_ALLOWED_NESTING_KEY, ctx, DEFAULT_MAX_ALLOWED_NESTING)
+        value(MAX_ALLOWED_NESTING_KEY, ctx)
       end
 
       # :reek:FeatureEnvy

data/lib/reek/smells/repeated_conditional.rb

@@ -49,7 +49,7 @@ module Reek
       # :reek:TooManyStatements: { max_statements: 6 }
       # :reek:DuplicateMethodCall: { max_calls: 2 }
       def inspect(ctx)
-        max_identical_ifs = value(MAX_IDENTICAL_IFS_KEY, ctx, DEFAULT_MAX_IFS)
+        max_identical_ifs = value(MAX_IDENTICAL_IFS_KEY, ctx)
         conditional_counts(ctx).select do |_key, lines|
           lines.length > max_identical_ifs
         end.map do |key, lines|

data/lib/reek/smells/smell_configuration.rb

@@ -29,13 +29,14 @@ module Reek
         Overrides.new(options.fetch(OVERRIDES_KEY, {})).for_context(context)
       end
 
-      # Retrieves the value, if any, for the given +key+.
+      # Retrieves the value, if any, for the given +key+ in the given +context+.
       #
-      # Returns +fall_back+ if this config has no value for the key.
+      # Raises an error if neither the context nor this config have a value for
+      # the key.
       #
-      def value(key, context, fall_back)
+      def value(key, context)
         overrides_for(context).each { |conf| return conf[key] if conf.key?(key) }
-        options.fetch(key, fall_back)
+        options.fetch(key)
       end
 
       private

data/lib/reek/smells/smell_detector.rb

@@ -52,7 +52,7 @@ module Reek
       end
 
       def exception?(context)
-        context.matches?(value(EXCLUDE_KEY, context, DEFAULT_EXCLUDE_SET))
+        context.matches?(value(EXCLUDE_KEY, context))
       end
 
       def self.todo_configuration_for(smells)
@@ -69,8 +69,8 @@ module Reek
         config.enabled? && config_for(context)[SmellConfiguration::ENABLED_KEY] != false
       end
 
-      def value(key, ctx, fall_back)
-        config_for(ctx)[key] || config.value(key, ctx, fall_back)
+      def value(key, ctx)
+        config_for(ctx)[key] || config.value(key, ctx)
       end
 
       def config_for(ctx)

data/lib/reek/smells/too_many_instance_variables.rb

@@ -35,7 +35,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def inspect(ctx)
-        max_allowed_ivars = value(MAX_ALLOWED_IVARS_KEY, ctx, DEFAULT_MAX_IVARS)
+        max_allowed_ivars = value(MAX_ALLOWED_IVARS_KEY, ctx)
         count = ctx.local_nodes(:ivasgn).map { |ivasgn| ivasgn.children.first }.uniq.length
         return [] if count <= max_allowed_ivars
         [smell_warning(

data/lib/reek/smells/too_many_methods.rb

@@ -37,7 +37,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def inspect(ctx)
-        max_allowed_methods = value(MAX_ALLOWED_METHODS_KEY, ctx, DEFAULT_MAX_METHODS)
+        max_allowed_methods = value(MAX_ALLOWED_METHODS_KEY, ctx)
         # TODO: Only checks instance methods!
         actual = ctx.node_instance_methods.length
         return [] if actual <= max_allowed_methods

data/lib/reek/smells/too_many_statements.rb

@@ -29,9 +29,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def inspect(ctx)
-        max_allowed_statements = value(MAX_ALLOWED_STATEMENTS_KEY,
-                                       ctx,
-                                       DEFAULT_MAX_STATEMENTS)
+        max_allowed_statements = value(MAX_ALLOWED_STATEMENTS_KEY, ctx)
         count = ctx.number_of_statements
         return [] if count <= max_allowed_statements
         [smell_warning(

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -56,11 +56,11 @@ module Reek
       end
 
       def reject_patterns(context)
-        Array value(REJECT_KEY, context, DEFAULT_REJECT_PATTERNS)
+        Array value(REJECT_KEY, context)
       end
 
       def accept_patterns(context)
-        Array value(ACCEPT_KEY, context, DEFAULT_ACCEPT_PATTERNS)
+        Array value(ACCEPT_KEY, context)
       end
     end
   end

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -71,11 +71,11 @@ module Reek
       end
 
       def reject_patterns(context)
-        Array value(REJECT_KEY, context, DEFAULT_REJECT_PATTERNS)
+        Array value(REJECT_KEY, context)
       end
 
       def accept_patterns(context)
-        Array value(ACCEPT_KEY, context, DEFAULT_ACCEPT_PATTERNS)
+        Array value(ACCEPT_KEY, context)
       end
     end
   end

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -65,11 +65,11 @@ module Reek
       end
 
       def reject_patterns(context)
-        Array value(REJECT_KEY, context, DEFAULT_REJECT_PATTERNS)
+        Array value(REJECT_KEY, context)
       end
 
       def accept_patterns(context)
-        Array value(ACCEPT_KEY, context, DEFAULT_ACCEPT_PATTERNS)
+        Array value(ACCEPT_KEY, context)
       end
 
       # :reek:UtilityFunction

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -49,8 +49,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def inspect(ctx)
-        self.reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
-        self.accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
+        self.reject_names = value(REJECT_KEY, ctx)
+        self.accept_names = value(ACCEPT_KEY, ctx)
         variable_names(ctx.exp).select do |name, _lines|
           bad_name?(name, ctx)
         end.map do |name, lines|

data/lib/reek/smells/unused_private_method.rb

@@ -81,7 +81,7 @@ module Reek
       # :reek:FeatureEnvy
       def ignore_method?(ctx, method)
         # ignore_contexts will be e.g. ["Foo::Smelly#my_method", "..."]
-        ignore_contexts = value(EXCLUDE_KEY, ctx, DEFAULT_EXCLUDE_SET)
+        ignore_contexts = value(EXCLUDE_KEY, ctx)
         ignore_contexts.any? do |ignore_context|
           full_name = "#{method.parent.full_name}##{method.name}"
           full_name[ignore_context]

data/lib/reek/smells/utility_function.rb

@@ -41,6 +41,10 @@ module Reek
       PUBLIC_METHODS_ONLY_KEY     = 'public_methods_only'.freeze
       PUBLIC_METHODS_ONLY_DEFAULT = false
 
+      def self.default_config
+        super.merge(PUBLIC_METHODS_ONLY_KEY => PUBLIC_METHODS_ONLY_DEFAULT)
+      end
+
       class << self
         def contexts # :nodoc:
           [:def]
@@ -76,7 +80,7 @@ module Reek
 
       def ignore_method?(method_ctx)
         method_ctx.non_public_visibility? &&
-          value(PUBLIC_METHODS_ONLY_KEY, method_ctx, PUBLIC_METHODS_ONLY_DEFAULT)
+          value(PUBLIC_METHODS_ONLY_KEY, method_ctx)
       end
     end
   end

data/lib/reek/source/source_code.rb

@@ -6,6 +6,9 @@ end
 require_relative '../tree_dresser'
 require_relative '../ast/node'
 
+# Opt in to new way of representing lambdas
+Parser::Builders::Default.emit_lambda = true
+
 module Reek
   module Source
     #

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.0.3'.freeze
+    STRING = '4.0.4'.freeze
   end
 end

data/reek.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |s|
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.3.1'
-  s.add_runtime_dependency 'parser',                '~> 2.3', '>= 2.3.0.6'
+  s.add_runtime_dependency 'parser',                '~> 2.3.1', '>= 2.3.1.2'
   s.add_runtime_dependency 'rainbow',               '~> 2.0'
 end

data/spec/reek/smells/nested_iterators_spec.rb

@@ -82,6 +82,7 @@ RSpec.describe Reek::Smells::NestedIterators do
         }
       end
     EOS
+    expect(src).not_to reek_of(:NestedIterators, count: 2)
     expect(src).to reek_of(:NestedIterators, count: 3)
   end
 
@@ -112,7 +113,7 @@ RSpec.describe Reek::Smells::NestedIterators do
   describe 'inspect / warnings' do
     let(:detector) { build(:smell_detector, smell_type: :NestedIterators) }
 
-    it 'reports correctly' do
+    it 'reports a sensible warning message' do
       source = <<-EOS
         def foo
           bar do |bar|
@@ -120,41 +121,40 @@ RSpec.describe Reek::Smells::NestedIterators do
           end
         end
       EOS
-      warnings = detector.inspect(build(:method_context, source: source))
-      warning = warnings.first
+      expect(source).to reek_of(:NestedIterators, message: 'contains iterators nested 2 deep')
+    end
 
-      expect(warning.smell_type).to eq(Reek::Smells::NestedIterators.smell_type)
-      expect(warning.parameters[:name]).to eq('foo')
-      expect(warning.lines).to eq([3])
+    it 'reports the name of the method and line of the deepest iterator' do
+      source = <<-EOS
+        def foo
+          bar do |bar|
+            baz {|baz| }
+          end
+        end
+      EOS
+      expect(source).to reek_of(:NestedIterators, name: 'foo', lines: [3])
     end
 
-    it 'should report nested iterators only once per method' do
+    it 'reports all lines on which nested iterators occur' do
       source = <<-EOS
-        def bad(fred)
+        def bad
           @fred.each {|item| item.each {|part| @joe.send} }
           @jim.each {|ting| ting.each {|piece| @hal.send} }
         end
       EOS
 
-      warnings = detector.inspect(build(:method_context, source: source))
-      expect(warnings.size).to eq(1)
-      warning = warnings.first
-      expect(warning.parameters[:name]).to eq('bad')
+      expect(source).to reek_of(:NestedIterators, name: 'bad', lines: [2, 3])
     end
 
-    it 'reports nested iterators only once per method even if levels are different' do
+    it 'reports separete cases of nested iterators if levels are different' do
       source = <<-EOS
-        def bad(fred)
+        def bad
           @fred.each {|item| item.each {|part| part.foo} }
           @jim.each {|ting| ting.each {|piece| piece.each {|atom| atom.foo } } }
         end
       EOS
-      warnings = detector.inspect(build(:method_context, source: source))
-      expect(warnings.size).to eq(1)
-      warning = warnings.first
-
-      expect(warning.parameters[:name]).to eq('bad')
-      expect(warning.lines).to eq([3])
+      expect(source).to reek_of(:NestedIterators, name: 'bad', lines: [2], count: 2)
+      expect(source).to reek_of(:NestedIterators, name: 'bad', lines: [3], count: 3)
     end
   end
 

data/spec/reek/smells/smell_configuration_spec.rb

@@ -2,11 +2,6 @@ require_relative '../../spec_helper'
 require_lib 'reek/smells/smell_configuration'
 
 RSpec.describe Reek::Smells::SmellConfiguration do
-  it 'returns the default value when key not found' do
-    cf = described_class.new({})
-    expect(cf.value('fred', nil, 27)).to eq(27)
-  end
-
   context 'when overriding default configs' do
     let(:base_config) do
       {

data/spec/reek/smells/utility_function_spec.rb

@@ -217,6 +217,28 @@ RSpec.describe Reek::Smells::UtilityFunction do
     end
   end
 
+  context 'with the default configuration' do
+    it 'reports private methods' do
+      src = <<-EOS
+          class C
+            private
+            def m1(a) a.to_s; end
+          end
+      EOS
+      expect(src).to reek_of(:UtilityFunction)
+    end
+
+    it 'reports protected methods' do
+      src = <<-EOS
+          class C
+            protected
+            def m1(a) a.to_s; end
+          end
+      EOS
+      expect(src).to reek_of(:UtilityFunction)
+    end
+  end
+
   describe 'disabling UtilityFunction via configuration for non-public methods' do
     let(:config) do
       { Reek::Smells::UtilityFunction::PUBLIC_METHODS_ONLY_KEY => true }

data/spec/spec_helper.rb

@@ -82,6 +82,11 @@ RSpec.configure do |config|
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end
+
+  # Avoid infinitely running tests. This is mainly useful when running mutant.
+  config.around(:each) do |example|
+    Timeout.timeout(5, &example)
+  end
 end
 
 private

data/tasks/ataru.rake

@@ -0,0 +1,4 @@
+desc 'Runs ataru to check if our docs are still in sync with our code'
+task :ataru do
+  system 'bundle exec ataru check'
+end

data/tasks/mutant.rake

@@ -0,0 +1,5 @@
+desc 'Runs mutant'
+task :mutant do
+  system 'RUBY_THREAD_VM_STACK_SIZE=64000 bundle exec mutant --include lib '\
+         "--require reek --use rspec --since master --jobs 4 'Reek*'"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-23 00:00:00.000000000 Z
+date: 2016-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -33,20 +33,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0.6
+        version: 2.3.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.3.1
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.0.6
+        version: 2.3.1.2
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -372,8 +372,10 @@ files:
 - spec/samples/two_smelly_files/dirty_one.rb
 - spec/samples/two_smelly_files/dirty_two.rb
 - spec/spec_helper.rb
+- tasks/ataru.rake
 - tasks/configuration.rake
 - tasks/console.rake
+- tasks/mutant.rake
 - tasks/reek.rake
 - tasks/rubocop.rake
 - tasks/test.rake