reek 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 846eb328f05e66b28b63cb9103b710d75a61a98b
-  data.tar.gz: f870a86b912aca22b1720902098afeb575de4a03
+  metadata.gz: 777f1ba21321886d04fe6cb9be80e175250f8490
+  data.tar.gz: 574babd716780ea8013ceb2b485dda1e3eaa521d
 SHA512:
-  metadata.gz: b2ee82efb561b2270381528407b1488b695c24f954e78688999df29b3dc17246faa473b523454a7a1c0e65e8aea4201270786a3df2e251ef57f2760ea924228e
-  data.tar.gz: a80ad9e5f23f1e5db3d5e8df22d55e8cf17656a028582ce25af3d2c00c9bde74002a13f97724ef09c7ea12205e3b0ab0c3ee9a2612aad8fb346ef12f2d4c918f
+  metadata.gz: 4d5a1ea491b81408ae7c6ee5dc8699b21e7df7ecdfa888d3826556acb677dabf6a2a145677c89e783f5aaaf58b914ab3138ce444e393a19e476e3c6940ff6bbe
+  data.tar.gz: cd1ab7b709b02c9d2756fc716aee8418295bebf48757fdaff1dab3fca689bb84a8d5b359fc6026e4f3d8450d80128b36e00ba12138f904596a9752ad200f69e4

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.5.0 (2015-09-28)
+
+* (troessner) Ignore iterators without block arguments for NestedIterators
+
 ## 3.4.1 (2015-09-24)
 
 * (chastell) Fix parsing `Foo = bar.new(new)`

data/docs/API.md

@@ -76,7 +76,7 @@ IrresponsibleModule:
 You can now use either
 
 ```Ruby
-Reek::Configuration::AppConfiguration.from_path Pathname.new('config.reek`)
+Reek::Configuration::AppConfiguration.from_path Pathname.new('config.reek')
 ```
 
 but you can also pass a hash via `Reek::Configuration::AppConfiguration.from_map`.

data/docs/Nested-Iterators.md

@@ -33,6 +33,21 @@ test.rb -- 1 warning:
 
 Nested Iterators reports failing methods only once.
 `Object#tap` is ignored by default and thus does not count as iterator.
+Furthermore iterators without block arguments are not counted, e.g.:
+
+
+```Ruby
+def foo
+  before do
+    item.each do |part|
+      puts part
+    end
+  end
+end
+```
+
+would not smell of NestedIterators (given a maximum allowed nesting of 1) since the
+`before` would not be counted (because it doesn't pass any arguments to the block).
 
 ## Configuration
 

data/features/configuration_files/directory_specific_directives.feature

@@ -24,8 +24,8 @@ Feature: Directory directives
       class UsersController < ApplicationController
         def show
           respond_with do |format|
-            format.json { @user.to_custom_json }
-            format.xlm { @user.to_fancy_xml }
+            format.json { |json| @user.to_custom_json }
+            format.xml { |xml| @user.to_fancy_xml }
           end
         end
       end
@@ -94,7 +94,7 @@ Feature: Directory directives
       class UsersController < ApplicationController
         def show
           respond_with do |format|
-            format.json { @user.to_custom_json }
+            format.json { |json| @user.to_custom_json }
           end
         end
       end
@@ -145,7 +145,7 @@ Feature: Directory directives
       class UsersController < ApplicationController
         def show
           respond_with do |format|
-            format.json { @user.to_custom_json }
+            format.json { |json| @user.to_custom_json }
           end
         end
       end
@@ -155,7 +155,7 @@ Feature: Directory directives
       class ProjectController < ApplicationController
         def show
           respond_with do |format|
-            format.json { @project.to_custom_json }
+            format.json { |json| @project.to_custom_json }
           end
         end
       end
@@ -251,8 +251,8 @@ Feature: Directory directives
       """
       class Klass
         def meth
-          respond_to do
-            answer_to do
+          respond_to do |arg|
+            answer_to do |arg|
             end
           end
         end
@@ -262,8 +262,8 @@ Feature: Directory directives
       """
       class Klazz
         def meth
-          respond_to do
-            answer_to do
+          respond_to do |arg|
+            answer_to do |arg|
             end
           end
         end

data/features/samples.feature

@@ -59,7 +59,7 @@ Feature: Basic smell detection
       Module#inline calls Inline.const_get(lang) 2 times (DuplicateMethodCall)
       Module#inline calls options[:testing] 2 times (DuplicateMethodCall)
       Module#inline has approx 12 statements (TooManyStatements)
-    optparse.rb -- 121 warnings:
+    optparse.rb -- 117 warnings:
       OptionParser has at least 42 methods (TooManyMethods)
       OptionParser has at least 6 instance variables (TooManyInstanceVariables)
       OptionParser has the variable name 'f' (UncommunicativeVariableName)
@@ -73,7 +73,6 @@ Feature: Basic smell detection
       OptionParser tests not_style at least 3 times (RepeatedConditional)
       OptionParser tests s at least 7 times (RepeatedConditional)
       OptionParser#banner is a writable attribute (Attribute)
-      OptionParser#complete contains iterators nested 2 deep (NestedIterators)
       OptionParser#complete has 4 parameters (LongParameterList)
       OptionParser#complete has approx 6 statements (TooManyStatements)
       OptionParser#complete has boolean parameter 'icase' (BooleanParameter)
@@ -93,7 +92,7 @@ Feature: Basic smell detection
       OptionParser#make_switch calls sdesc << "-#{q}" 2 times (DuplicateMethodCall)
       OptionParser#make_switch calls search(:atype, FalseClass) 2 times (DuplicateMethodCall)
       OptionParser#make_switch calls search(:atype, o) 6 times (DuplicateMethodCall)
-      OptionParser#make_switch contains iterators nested 3 deep (NestedIterators)
+      OptionParser#make_switch contains iterators nested 2 deep (NestedIterators)
       OptionParser#make_switch has approx 72 statements (TooManyStatements)
       OptionParser#make_switch has the variable name 'a' (UncommunicativeVariableName)
       OptionParser#make_switch has the variable name 'c' (UncommunicativeVariableName)
@@ -114,7 +113,6 @@ Feature: Basic smell detection
       OptionParser#parse_in_order calls setter.call(sw.switch_name, val) 2 times (DuplicateMethodCall)
       OptionParser#parse_in_order calls sw.block 2 times (DuplicateMethodCall)
       OptionParser#parse_in_order calls sw.switch_name 2 times (DuplicateMethodCall)
-      OptionParser#parse_in_order contains iterators nested 3 deep (NestedIterators)
       OptionParser#parse_in_order has approx 35 statements (TooManyStatements)
       OptionParser#permute calls argv[0] 2 times (DuplicateMethodCall)
       OptionParser#permute refers to argv more than self (maybe move it to another class?) (FeatureEnvy)
@@ -133,7 +131,6 @@ Feature: Basic smell detection
       OptionParser::Arguable has initialize method (ModuleInitialize)
       OptionParser::Arguable#options has approx 6 statements (TooManyStatements)
       OptionParser::Arguable#options= is controlled by argument opt (ControlParameter)
-      OptionParser::CompletingHash#match contains iterators nested 2 deep (NestedIterators)
       OptionParser::Completion#complete calls candidates.size 2 times (DuplicateMethodCall)
       OptionParser::Completion#complete calls k.id2name 2 times (DuplicateMethodCall)
       OptionParser::Completion#complete has approx 23 statements (TooManyStatements)
@@ -172,7 +169,6 @@ Feature: Basic smell detection
       OptionParser::Switch#summarize calls left.shift 2 times (DuplicateMethodCall)
       OptionParser::Switch#summarize calls left[(-1)] 3 times (DuplicateMethodCall)
       OptionParser::Switch#summarize calls s.length 3 times (DuplicateMethodCall)
-      OptionParser::Switch#summarize contains iterators nested 2 deep (NestedIterators)
       OptionParser::Switch#summarize has 5 parameters (LongParameterList)
       OptionParser::Switch#summarize has approx 28 statements (TooManyStatements)
       OptionParser::Switch#summarize has the variable name 'l' (UncommunicativeVariableName)
@@ -215,7 +211,7 @@ Feature: Basic smell detection
       RedCloth#blocks is controlled by argument deep_code (ControlParameter)
       RedCloth#blocks refers to blk more than self (maybe move it to another class?) (FeatureEnvy)
       RedCloth#clean_html calls tags[tag] 2 times (DuplicateMethodCall)
-      RedCloth#clean_html contains iterators nested 3 deep (NestedIterators)
+      RedCloth#clean_html contains iterators nested 2 deep (NestedIterators)
       RedCloth#clean_html doesn't depend on instance state (maybe move it to another class?) (UtilityFunction)
       RedCloth#clean_html has approx 15 statements (TooManyStatements)
       RedCloth#clean_html has the variable name 'q' (UncommunicativeVariableName)
@@ -283,5 +279,5 @@ Feature: Basic smell detection
       RedCloth#textile_popup_help has the parameter name 'windowW' (UncommunicativeParameterName)
       RedCloth#to_html has approx 26 statements (TooManyStatements)
       RedCloth#v_align doesn't depend on instance state (maybe move it to another class?) (UtilityFunction)
-    269 total warnings
+    265 total warnings
     """

data/features/support/env.rb

@@ -37,5 +37,7 @@ World do
 end
 
 Before do
-  @aruba_timeout_seconds = 30
+  Aruba.configure do |config|
+    config.exit_timeout = 30
+  end
 end

data/lib/reek/ast/node.rb

@@ -31,20 +31,10 @@ module Reek
         comment_lines.map(&:text).join("\n")
       end
 
-      # @deprecated
-      def [](index)
-        elements[index]
-      end
-
       def line
         loc && loc.line
       end
 
-      # @deprecated
-      def first
-        type
-      end
-
       #
       # Carries out a depth-first traversal of this syntax tree, yielding
       # every Sexp of type `target_type`. The traversal ignores any node
@@ -129,10 +119,6 @@ module Reek
       def each_sexp
         children.each { |elem| yield elem if elem.is_a? ::Parser::AST::Node }
       end
-
-      def elements
-        [type, *children]
-      end
     end
   end
 end

data/lib/reek/ast/sexp_extensions.rb

@@ -120,10 +120,10 @@ module Reek
 
       # Base module for utility methods for :and and :or nodes.
       module LogicOperatorBase
-        def condition() self[1] end
+        def condition() children.first end
 
         def body_nodes(type, ignoring = [])
-          self[2].find_nodes type, ignoring
+          children[1].find_nodes type, ignoring
         end
       end
 
@@ -139,12 +139,12 @@ module Reek
 
       # Utility methods for :attrasgn nodes.
       module AttrasgnNode
-        def args() self[3] end
+        def args() children[2] end
       end
 
       # Utility methods for :case nodes.
       module CaseNode
-        def condition() self[1] end
+        def condition() children.first end
 
         def body_nodes(type, ignoring = [])
           children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
@@ -177,7 +177,7 @@ module Reek
         end
 
         def arg_names
-          args.map { |arg| arg[1] }
+          args.map { |arg| arg.children.first }
         end
 
         def module_creation_call?
@@ -215,7 +215,7 @@ module Reek
 
       # Base module for utility methods for nodes representing variables.
       module VariableBase
-        def name() self[1] end
+        def name() children.first end
       end
 
       # Utility methods for :cvar nodes.
@@ -301,11 +301,11 @@ module Reek
 
       # Utility methods for :def nodes.
       module DefNode
-        def name() self[1] end
-        def argslist() self[2] end
+        def name() children.first end
+        def argslist() children[1] end
 
         def body
-          self[3]
+          children[2]
         end
 
         def full_name(outer)
@@ -323,12 +323,12 @@ module Reek
 
       # Utility methods for :defs nodes.
       module DefsNode
-        def receiver() self[1] end
-        def name() self[2] end
-        def argslist() self[3] end
+        def receiver() children.first end
+        def name() children[1] end
+        def argslist() children[2] end
 
         def body
-          self[4]
+          children[3]
         end
 
         include MethodNodeBase
@@ -345,7 +345,7 @@ module Reek
 
       # Utility methods for :if nodes.
       module IfNode
-        def condition() self[1] end
+        def condition() children.first end
 
         def body_nodes(type, ignoring = [])
           children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
@@ -354,23 +354,27 @@ module Reek
 
       # Utility methods for :block nodes.
       module BlockNode
-        def call() self[1] end
-        def args() self[2] end
-        def block() self[3] end
-        def parameters() self[2] || [] end
+        def call() children.first end
+        def args() children[1] end
+        def block() children[2] end
+        def parameters() children[1] || [] end
 
         def parameter_names
-          parameters[1..-1].to_a
+          parameters.children
         end
 
         def simple_name
           :block
         end
+
+        def without_block_arguments?
+          args.components.empty?
+        end
       end
 
       # Utility methods for :lit nodes.
       module LitNode
-        def value() self[1] end
+        def value() children.first end
       end
 
       # Utility methods for :const nodes.
@@ -425,7 +429,7 @@ module Reek
       # Utility methods for :class nodes.
       module ClassNode
         include ModuleNode
-        def superclass() self[2] end
+        def superclass() children[1] end
       end
 
       # Utility methods for :casgn nodes.
@@ -464,7 +468,7 @@ module Reek
 
       # Utility methods for :yield nodes.
       module YieldNode
-        def args() self[1..-1] end
+        def args() children end
 
         def arg_names
           args.map { |arg| arg[1] }

data/lib/reek/configuration/app_configuration.rb

@@ -42,10 +42,9 @@ module Reek
       def self.from_map(map = {})
         allocate.tap do |instance|
           instance.instance_eval do
-            self.directory_directives = map.fetch(:directory_directives, {}).
-              extend(DirectoryDirectives)
-            self.default_directive = map.fetch(:default_directive, {}).extend(DefaultDirective)
-            self.excluded_paths = map.fetch(:excluded_paths, []).extend(ExcludedPaths)
+            load_values map.fetch(:directory_directives, {})
+            load_values map.fetch(:default_directive, {})
+            load_values EXCLUDE_PATHS_KEY => map.fetch(:excluded_paths, [])
           end
         end
       end
@@ -90,6 +89,10 @@ module Reek
       def find_and_load(path: nil)
         configuration_file = ConfigurationFileFinder.find_and_load(path: path)
 
+        load_values(configuration_file)
+      end
+
+      def load_values(configuration_file)
         configuration_file.each do |key, value|
           case
           when key == EXCLUDE_PATHS_KEY

data/lib/reek/configuration/configuration_validator.rb

@@ -8,9 +8,26 @@ module Reek
 
       # :reek:UtilityFunction
       def smell_type?(key)
-        Reek::Smells.const_get key
-      rescue NameError
-        false
+        case key
+        when Class
+          true
+        when String
+          begin
+            Reek::Smells.const_defined? key
+          rescue NameError
+            false
+          end
+        end
+      end
+
+      # :reek:UtilityFunction
+      def key_to_smell_detector(key)
+        case key
+        when Class
+          key
+        else
+          Reek::Smells.const_get key
+        end
       end
 
       def error_message_for_missing_directory(pathname)

data/lib/reek/configuration/default_directive.rb

@@ -4,8 +4,10 @@ module Reek
     # Hash extension for the default directive.
     #
     module DefaultDirective
+      include ConfigurationValidator
+
       def add(key, config)
-        self[Reek::Smells.const_get(key)] = config
+        self[key_to_smell_detector(key)] = config
       end
     end
   end

data/lib/reek/configuration/directory_directives.rb

@@ -32,7 +32,7 @@ module Reek
         with_valid_directory(path) do |directory|
           self[directory] = config.each_with_object({}) do |(key, value), hash|
             abort(error_message_for_invalid_smell_type(key)) unless smell_type?(key)
-            hash[Reek::Smells.const_get(key)] = value
+            hash[key_to_smell_detector(key)] = value
           end
         end
         self

data/lib/reek/smells/boolean_parameter.rb

@@ -25,7 +25,7 @@ module Reek
       # :reek:FeatureEnvy
       def examine_context(ctx)
         ctx.default_assignments.select do |_param, value|
-          [:true, :false].include?(value[0])
+          [:true, :false].include?(value.type)
         end.map do |parameter, _value|
           smell_warning(
             context: ctx,

data/lib/reek/smells/nested_iterators.rb

@@ -44,7 +44,6 @@ module Reek
         else
           []
         end
-        # BUG: no longer reports nesting outside methods (eg. in Optparse)
       end
 
       private
@@ -72,9 +71,10 @@ module Reek
         result
       end
 
+      # :reek:FeatureEnvy
       def ignored_iterator?(exp)
-        name = exp.call.method_name.to_s
-        ignore_iterators.any? { |pattern| /#{pattern}/ =~ name }
+        ignore_iterators.any? { |pattern| /#{pattern}/ =~ exp.call.method_name } ||
+          exp.without_block_arguments?
       end
     end
   end

data/lib/reek/smells/too_many_instance_variables.rb

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

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -83,18 +83,18 @@ module Reek
       def find_assignment_variable_names(exp, accumulator)
         assignment_nodes = exp.each_node(:lvasgn, [:class, :module, :defs, :def])
 
-        case exp.first
+        case exp.type
         when :class, :module
           assignment_nodes += exp.each_node(:ivasgn, [:class, :module])
         end
 
-        assignment_nodes.each { |asgn| accumulator[asgn[1]].push(asgn.line) }
+        assignment_nodes.each { |asgn| accumulator[asgn.children.first].push(asgn.line) }
       end
 
       # :reek:FeatureEnvy
       # :reek:TooManyStatements: { max_statements: 6 }
       def find_block_argument_variable_names(exp, accumulator)
-        arg_search_exp = case exp.first
+        arg_search_exp = case exp.type
                          when :class, :module
                            exp
                          when :defs, :def

data/lib/reek/tree_walker.rb

@@ -140,14 +140,15 @@ module Reek
     alias_method :process_kwbegin, :process_begin
 
     def process_if(exp)
-      count_clause(exp[2])
-      count_clause(exp[3])
+      children = exp.children
+      count_clause(children[1])
+      count_clause(children[2])
       element.count_statements(-1)
       process_default(exp)
     end
 
     def process_while(exp)
-      count_clause(exp[2])
+      count_clause(exp.children[1])
       element.count_statements(-1)
       process_default(exp)
     end
@@ -155,19 +156,19 @@ module Reek
     alias_method :process_until, :process_while
 
     def process_for(exp)
-      count_clause(exp[3])
+      count_clause(exp.children[2])
       element.count_statements(-1)
       process_default(exp)
     end
 
     def process_rescue(exp)
-      count_clause(exp[1])
+      count_clause(exp.children.first)
       element.count_statements(-1)
       process_default(exp)
     end
 
     def process_resbody(exp)
-      count_statement_list(exp[2..-1].compact)
+      count_statement_list(exp.children[1..-1].compact)
       process_default(exp)
     end
 

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.4.1'
+    STRING = '3.5.0'
   end
 end

data/spec/factories/factories.rb

@@ -11,6 +11,17 @@ FactoryGirl.define do
     end
   end
 
+  factory :method_context, class: Reek::Context::MethodContext do
+    skip_create
+    transient do
+      source 'def foo; end'
+    end
+
+    initialize_with do
+      new(nil, Reek::Source::SourceCode.from(source).syntax_tree)
+    end
+  end
+
   factory :smell_detector, class: Reek::Smells::SmellDetector do
     skip_create
     transient do

data/spec/reek/configuration/app_configuration_spec.rb

@@ -38,7 +38,31 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     describe '#from_map' do
-      it 'properly sets the configuration' do
+      let(:default_directive_value) do
+        { 'IrresponsibleModule' => { 'enabled' => false } }
+      end
+
+      let(:directory_directives_value) do
+        { 'spec/samples/three_clean_files' =>
+          { 'UtilityFunction' => { 'enabled' => false } } }
+      end
+
+      let(:exclude_paths_value) do
+        ['spec/samples/two_smelly_files',
+         'spec/samples/source_with_non_ruby_files']
+      end
+
+      it 'properly sets the configuration from simple data structures' do
+        config = described_class.from_map(directory_directives: directory_directives_value,
+                                          default_directive: default_directive_value,
+                                          excluded_paths: exclude_paths_value)
+
+        expect(config.send(:excluded_paths)).to eq(expected_excluded_paths)
+        expect(config.send(:default_directive)).to eq(expected_default_directive)
+        expect(config.send(:directory_directives)).to eq(expected_directory_directives)
+      end
+
+      it 'properly sets the configuration from native structures' do
         config = described_class.from_map(directory_directives: expected_directory_directives,
                                           default_directive: expected_default_directive,
                                           excluded_paths: expected_excluded_paths)
@@ -51,17 +75,18 @@ RSpec.describe Reek::Configuration::AppConfiguration do
   end
 
   describe '#directive_for' do
+    let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
+
     context 'our source is in a directory for which we have a directive' do
       let(:baz_config)  { { Reek::Smells::IrresponsibleModule => { enabled: false } } }
       let(:bang_config) { { Reek::Smells::Attribute => { enabled: true } } }
 
       let(:directory_directives) do
         {
-          Pathname.new('foo/bar/baz')  => baz_config,
-          Pathname.new('foo/bar/bang') => bang_config
+          'spec/samples/two_smelly_files' => baz_config,
+          'spec/samples/three_clean_files' => bang_config
         }
       end
-      let(:source_via) { 'foo/bar/bang/dummy.rb' }
 
       it 'returns the corresponding directive' do
         configuration = described_class.from_map directory_directives: directory_directives
@@ -70,22 +95,16 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
 
     context 'our source is not in a directory for which we have a directive' do
-      let(:irresponsible_module_config) do
-        { Reek::Smells::IrresponsibleModule => { enabled: false } }
-      end
+      let(:default_directive) { { Reek::Smells::IrresponsibleModule => { enabled: false } } }
       let(:attribute_config) { { Reek::Smells::Attribute => { enabled: false } } }
-      let(:default_directive) do
-        irresponsible_module_config
-      end
       let(:directory_directives) do
-        { Pathname.new('foo/bar/baz') => attribute_config }
+        { 'spec/samples/two_smelly_files' => attribute_config }
       end
-      let(:source_via) { 'foo/bar/bang/dummy.rb' }
 
       it 'returns the default directive' do
         configuration = described_class.from_map directory_directives: directory_directives,
                                                  default_directive: default_directive
-        expect(configuration.directive_for(source_via)).to eq(irresponsible_module_config)
+        expect(configuration.directive_for(source_via)).to eq(default_directive)
       end
     end
   end

data/spec/reek/context/code_context_spec.rb

@@ -118,7 +118,7 @@ RSpec.describe Reek::Context::CodeContext do
       end
 
       it "yields the method's full AST" do
-        ctx.each_node(:def, []) { |exp| expect(exp[1]).to eq(:calloo) }
+        ctx.each_node(:def, []) { |exp| expect(exp.children.first).to eq(:calloo) }
       end
 
       context 'pruning the traversal' do

data/spec/reek/smells/nested_iterators_spec.rb

@@ -49,27 +49,9 @@ RSpec.describe Reek::Smells::NestedIterators do
   it 'detects an iterator with an empty block' do
     src = <<-EOS
       def foo
-        bar { baz { } }
-      end
-    EOS
-    expect(src).to reek_of(:NestedIterators)
-  end
-
-  it 'should report nested iterators only once per method' do
-    src = <<-EOS
-      def bad(fred)
-        @fred.each {|item| item.each {|part| @joe.send} }
-        @jim.each {|ting| ting.each {|piece| @hal.send} }
-      end
-    EOS
-    expect(src).to reek_of(:NestedIterators)
-  end
-
-  it 'reports nested iterators only once per method even if levels are different' do
-    src = <<-EOS
-      def bad(fred)
-        @fred.each {|item| item.each {|part| part.foo} }
-        @jim.each {|ting| ting.each {|piece| piece.each {|atom| atom.foo } } }
+        bar do |bar|
+          baz {|baz| }
+        end
       end
     EOS
     expect(src).to reek_of(:NestedIterators)
@@ -103,7 +85,7 @@ RSpec.describe Reek::Smells::NestedIterators do
     expect(src).to reek_of(:NestedIterators, count: 3)
   end
 
-  it 'handles the case where super recieves a block' do
+  it 'handles the case where super receives a block' do
     src = <<-EOS
       def super_call_with_block
         super do |k|
@@ -115,7 +97,7 @@ RSpec.describe Reek::Smells::NestedIterators do
     expect(src).to reek_of(:NestedIterators)
   end
 
-  it 'handles the case where super recieves a block and arguments' do
+  it 'handles the case where super receives a block and arguments' do
     src = <<-EOS
       def super_call_with_block
         super(foo) do |k|
@@ -127,6 +109,71 @@ RSpec.describe Reek::Smells::NestedIterators do
     expect(src).to reek_of(:NestedIterators)
   end
 
+  describe 'examine_context / warnings' do
+    let(:detector) { build(:smell_detector, smell_type: :NestedIterators) }
+
+    it 'reports correctly' do
+      source = <<-EOS
+        def foo
+          bar do |bar|
+            baz {|baz| }
+          end
+        end
+      EOS
+      warnings = detector.examine_context(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])
+    end
+
+    it 'should report nested iterators only once per method' do
+      source = <<-EOS
+        def bad(fred)
+          @fred.each {|item| item.each {|part| @joe.send} }
+          @jim.each {|ting| ting.each {|piece| @hal.send} }
+        end
+      EOS
+
+      warnings = detector.examine_context(build(:method_context, source: source))
+      expect(warnings.size).to eq(1)
+      warning = warnings.first
+      expect(warning.parameters[:name]).to eq('bad')
+    end
+
+    it 'reports nested iterators only once per method even if levels are different' do
+      source = <<-EOS
+        def bad(fred)
+          @fred.each {|item| item.each {|part| part.foo} }
+          @jim.each {|ting| ting.each {|piece| piece.each {|atom| atom.foo } } }
+        end
+      EOS
+      warnings = detector.examine_context(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])
+    end
+  end
+
+  describe 'iterators without block arguments' do
+    it 'does not count those iterators' do
+      source = <<-EOS
+        def foo
+          before do
+            item.each do |part|
+              puts part
+            end
+          end
+        end
+      EOS
+      expect(source).not_to reek_of(:NestedIterators)
+    end
+  end
+
   context 'when the allowed nesting depth is 3' do
     let(:configuration) do
       config = { Reek::Smells::NestedIterators =>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser