reek 3.3.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e18d9d5bd7b07494f2c0d1cf7f5bf271d87a918d
-  data.tar.gz: efebbdb49a7872897956b6c1ddf59aadee6dc158
+  metadata.gz: 18055c0f9c08fb0e795cb4417885156291c9f5b7
+  data.tar.gz: b2d41cb4510dd092450c82bae4664bbbb7a10d50
 SHA512:
-  metadata.gz: 6b8306b98fe28fa272395083b7c77a58572501780a2147a582320e433942ec18fa7b81b602a4043aa0cd421f691f2dc177c6a5e9a990ce78282130ee91fa5b99
-  data.tar.gz: f8d76ee8f1f8510b5357f0fa0e2031065d8759837ce05d0351f3bf622b7e286e8af30148482f07a9f2a1c4b35002fe78cb3f19326aae8a784c1605b55d449a21
+  metadata.gz: 92722d3bdd09267e2c5858414b6f91cf066a6f9c3596033a3845d1c2d7cd768d17eb29e932af6d7ea8a432081f77b6f77092051288903b0377f11f6137c292ff
+  data.tar.gz: 0124c0f5b7d1c4f0f580b545757d1f94d51c2f93310b2dfe922abaa9ef241fc91a4ddadbad07832d6d5e92e99b0d4186b70f194f54f68f995693fbc70afc15e5

data/.gitignore

@@ -12,3 +12,4 @@ tags
 .pryrc
 .tags*
 .DS_Store
+.idea/

data/.rubocop.yml

@@ -14,9 +14,9 @@ Metrics/ClassLength:
 Metrics/MethodLength:
   Max: 15
 
-# Be a little more lenient with line length
+# Be rather lenient with line length
 Metrics/LineLength:
-  Max: 100
+  Max: 120
 
 # Indent one level for follow-up lines
 Style/MultilineOperationIndentation:

data/.travis.yml

@@ -20,11 +20,12 @@ matrix:
   allow_failures:
     - rvm: jruby
     - rvm: jruby-head
+    - rvm: rbx-2
     - rvm: ruby-head
   fast_finish: true
 notifications:
-  recipients:
+  email:
     - timo.roessner@googlemail.com
     - matijs@matijs.net
     - chastell@chastell.net
-  irc: "irc.freenode.org#reek"
+  irc: irc.freenode.org#reek

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 3.3.1 (2015-09-03)
+
+* (troessner) Fix file list as argument in rake task
+* (troessner) Ignore `Object#tap` for NestedIterators
+* (mvz) Ensure all YAML methods are loaded (workaround for #653)
+
 ## 3.3.0 (2015-08-23)
 
 * (HParker / Adam Hess) add support for or-assign constants
@@ -9,7 +15,7 @@
 
 ## 3.2.1 (2015-08-17)
 
-* Revert 864f0a9 to hotfix issues/642
+* (troessner) Revert 864f0a9 to hotfix #642
 
 ## 3.2.0 (2015-08-17)
 

data/config/defaults.reek

@@ -45,7 +45,8 @@ NestedIterators:
   enabled: true
   exclude: []
   max_allowed_nesting: 1
-  ignore_iterators: []
+  ignore_iterators:
+  - tap
 NilCheck:
   enabled: true
   exclude: []

data/docs/API.md

@@ -1,29 +1,35 @@
 # Using `reek` inside your Ruby application
 
-`reek` can be used inside another Ruby project.
+## Installation
+
+Either standalone via
 
 ```bash
 gem install reek
 ```
 
-## Using a reporter
+or by adding
+
+```
+gem 'reek'
+```
+
+to your Gemfile.
+
+## Quick start
 
-You can use reek inside your Ruby file `check_dirty.rb`
+Code says more than a thousand words:
 
 ```ruby
 require 'reek'
 
-source = <<-END
+source = <<-EOS
   class Dirty
-    # This method smells of :reek:NestedIterators but ignores them
-    def awful(x, y, offset = 0, log = false)
-      puts @screen.title
-      @screen = widgets.map { |w| w.each { |key| key += 3 * x } }
-      puts @screen.contents
-      fail
+    def m(a,b,c)
+      puts a,b
     end
   end
-END
+EOS
 
 reporter = Reek::Report::TextReport.new
 examiner = Reek::Examiner.new(source)
@@ -31,16 +37,22 @@ reporter.add_examiner examiner
 reporter.show
 ```
 
-This will show the list of errors in variable `source`.
-
-`Reek::Examiner.new` can take `source` as `String`, `File` or `IO`.
+This would output the following on STDOUT:
 
 ```
-# Examine a file object
-reporter.add_examiner Reek::Examiner.new(File.new('dirty.rb'))
+string -- 5 warnings:
+  Dirty has no descriptive comment (IrresponsibleModule)
+  Dirty#m has the name 'm' (UncommunicativeMethodName)
+  Dirty#m has the parameter name 'a' (UncommunicativeParameterName)
+  Dirty#m has the parameter name 'b' (UncommunicativeParameterName)
+  Dirty#m has unused parameter 'c' (UnusedParameters)
 ```
 
-Also, besides normal text output, `reek` can generate output in YAML,
+Note that `Reek::Examiner.new` can take `source` as `String`, `Pathname`, `File` or `IO`.
+
+## Choosing your output format
+
+Besides normal text output, `reek` can generate output in YAML,
 JSON, HTML and XML by using the following Report types:
 
 ```
@@ -51,6 +63,78 @@ HTMLReport
 XMLReport
 ```
 
+## Configuration
+
+Given you have the following configuration file called `config.reek` in your root directory:
+
+```Yaml
+---
+IrresponsibleModule:
+  enabled: false
+```
+
+You can now use either
+
+```Ruby
+Reek::Configuration::AppConfiguration.from_path Pathname.new('config.reek`)
+```
+
+but you can also pass a hash via `Reek::Configuration::AppConfiguration.from_map`.
+
+This hash can have the following 3 keys:
+
+1.) directory_directives [Hash] for instance:
+
+```Ruby
+  { Pathname("spec/samples/three_clean_files/") =>
+    { Reek::Smells::UtilityFunction => { "enabled" => false } } }
+```
+
+2.) default_directive [Hash] for instance:
+
+```Ruby
+  { Reek::Smells::IrresponsibleModule => { "enabled" => false } }
+```
+
+3.) excluded_paths [Array] for instance:
+
+```Ruby
+  [ Pathname('spec/samples/two_smelly_files') ]
+```
+
+Given the example above you should load that as "default directive" which means that it will
+be the default configuration for smell types for which there is
+no "directory directive" (so a directory-specific configuration):
+
+```Ruby
+require 'reek'
+
+default_directive = { Reek::Smells::IrresponsibleModule => { 'enabled' => false } }
+configuration = Reek::Configuration::AppConfiguration.from_map default_directive: default_directive
+
+source = <<-EOS
+  class Dirty
+    def call_me(a,b)
+      puts a,b
+    end
+  end
+EOS
+
+reporter = Reek::Report::TextReport.new
+examiner = Reek::Examiner.new(source, configuration: configuration); nil
+reporter.add_examiner examiner; nil
+reporter.show
+```
+
+This would now only report the `UncommunicativeParameterName` but not the `IrresponsibleModule`
+for the `Dirty` class:
+
+```
+string -- 2 warnings:
+  Dirty#call_me has the parameter name 'a' (UncommunicativeParameterName)
+  Dirty#call_me has the parameter name 'b' (UncommunicativeParameterName)
+```
+
 ## Accessing the smell warnings directly
 
 You can also access the smells detected by an examiner directly:
@@ -59,14 +143,7 @@ You can also access the smells detected by an examiner directly:
 require 'reek'
 
 source = <<-END
-  class Dirty
-    # This method smells of :reek:NestedIterators but ignores them
-    def awful(x, y, offset = 0, log = false)
-      puts @screen.title
-      @screen = widgets.map { |w| w.each { |key| key += 3 * x } }
-      puts @screen.contents
-      fail
-    end
+  class C
   end
 END
 

data/docs/Code-Smells.md

@@ -4,7 +4,7 @@ Smells are indicators of where your code might be hard to read, maintain or evol
 
 Reek currently includes checks for the following smells:
 
-* [Attribute](Attribute.md) (disabled by default)
+* [Attribute](Attribute.md)
 * [Class Variable](Class-Variable.md)
 * [Control Couple](Control-Couple.md), including
   * [Boolean Parameter](Boolean-Parameter.md)
@@ -31,4 +31,4 @@ Reek currently includes checks for the following smells:
   * [Uncommunicative Module Name](Uncommunicative-Module-Name.md)
   * [Uncommunicative Parameter Name](Uncommunicative-Parameter-Name.md)
   * [Uncommunicative Variable Name](Uncommunicative-Variable-Name.md)
-* [Unused Parameters](Unused-Parameters.md)
+* [Unused Parameters](Unused-Parameters.md)

data/docs/Nested-Iterators.md

@@ -32,6 +32,7 @@ test.rb -- 1 warning:
 ## Current Support in Reek
 
 Nested Iterators reports failing methods only once.
+`Object#tap` is ignored by default and thus does not count as iterator.
 
 ## Configuration
 

data/docs/Too-Many-Methods.md

@@ -52,4 +52,4 @@ would cause reek to emit the same warning as in the example above.
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|
-| max_methods     | integer | The maximum number of methods that are permitted. Defaults to 25 |
+| max_methods     | integer | The maximum number of methods that are permitted. Defaults to 15 |

data/lib/reek/ast/object_refs.rb

@@ -3,6 +3,7 @@ require 'private_attr/everywhere'
 module Reek
   # @api private
   module AST
+    # Responsible for holding one specific object reference
     ObjectRef = Struct.new(:name, :line)
     #
     # Manages and counts the references out of a method to other objects.

data/lib/reek/cli/option_interpreter.rb

@@ -34,7 +34,7 @@ module Reek
       end
 
       def warning_formatter
-        warning_formatter_class.new(location_formatter)
+        warning_formatter_class.new(location_formatter: location_formatter)
       end
 
       def warning_formatter_class

data/lib/reek/code_comment.rb

@@ -1,6 +1,9 @@
 require 'yaml'
 require 'private_attr/everywhere'
 
+# NOTE: Work-around for https://github.com/tenderlove/psych/issues/223
+require 'psych.rb' if Object.const_defined?(:Psych)
+
 module Reek
   #
   # A comment header from an abstract syntax tree; found directly above

data/lib/reek/context/code_context.rb

@@ -137,7 +137,7 @@ module Reek
       #
       # @param visibility [Symbol]
       # @param names [Array<Symbol>]
-      def track_visibility(visibility, names = [])
+      def track_visibility(visibility, names)
         if names.any?
           children.each do |child|
             child.visibility = visibility if names.include? child.name

data/lib/reek/examiner.rb

@@ -24,6 +24,8 @@ module Reek
     # @param filter_by_smells [Array<String>]
     #   List of smell types to filter by.
     #
+    # @param configuration [Configuration::AppConfiguration]
+    #   The configuration for this Examiner.
     def initialize(source,
                    filter_by_smells = [],
                    configuration: Configuration::AppConfiguration.default)

data/lib/reek/rake/task.rb

@@ -44,7 +44,7 @@ module Reek
       # Glob pattern to match source files.
       # Setting the REEK_SRC environment variable overrides this.
       # Defaults to 'lib/**/*.rb'.
-      attr_accessor :source_files
+      attr_reader :source_files
 
       # String containing commandline options to be passed to Reek.
       # Setting the REEK_OPTS environment variable overrides this value.
@@ -71,10 +71,19 @@ module Reek
         define_task
       end
 
+      def source_files=(files)
+        raise ArgumentError, no_string_given_for_file_list_warning unless files.is_a?(String)
+        @source_files = FileList[files]
+      end
+
       private
 
       private_attr_reader :fail_on_error, :name, :verbose
 
+      def no_string_given_for_file_list_warning
+        "File list should be a String that can contain a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
+      end
+
       def define_task
         desc 'Check for code smells'
         task(name) { run_task }

data/lib/reek/report/formatter.rb

@@ -10,7 +10,7 @@ module Reek
     #
     # @api private
     module Formatter
-      def self.format_list(warnings, formatter = SimpleWarningFormatter.new)
+      def self.format_list(warnings, formatter: SimpleWarningFormatter.new)
         warnings.map do |warning|
           "  #{formatter.format warning}"
         end.join("\n")
@@ -31,7 +31,7 @@ module Reek
     #
     # @api private
     class SimpleWarningFormatter
-      def initialize(location_formatter = BlankLocationFormatter)
+      def initialize(location_formatter: BlankLocationFormatter)
         @location_formatter = location_formatter
       end
 

data/lib/reek/report/report.rb

@@ -16,13 +16,15 @@ module Reek
       # @api private
       WARNINGS_COLOR = :red
 
-      def initialize(options = {})
+      def initialize(heading_formatter: HeadingFormatter::Quiet,
+                     report_formatter: Formatter, sort_by_issue_count: false,
+                     warning_formatter: SimpleWarningFormatter.new)
         @examiners           = []
+        @heading_formatter   = heading_formatter.new(report_formatter)
+        @report_formatter    = report_formatter
+        @sort_by_issue_count = sort_by_issue_count
         @total_smell_count   = 0
-        @options             = options
-        @warning_formatter   = options.fetch :warning_formatter, SimpleWarningFormatter.new
-        @report_formatter    = options.fetch :report_formatter, Formatter
-        @sort_by_issue_count = options.fetch :sort_by_issue_count, false
+        @warning_formatter   = warning_formatter
       end
 
       # Add Examiner to report on. The report will output results for all
@@ -56,7 +58,7 @@ module Reek
 
       private
 
-      private_attr_reader :examiners, :options, :report_formatter,
+      private_attr_reader :examiners, :heading_formatter, :report_formatter,
                           :sort_by_issue_count, :warning_formatter
     end
 
@@ -89,7 +91,7 @@ module Reek
         result = heading_formatter.header(examiner)
         if examiner.smelly?
           formatted_list = report_formatter.format_list(examiner.smells,
-                                                        warning_formatter)
+                                                        formatter: warning_formatter)
           result += ":\n#{formatted_list}"
         end
         result
@@ -104,11 +106,6 @@ module Reek
         s = total_smell_count == 1 ? '' : 's'
         Rainbow("#{total_smell_count} total warning#{s}\n").color(colour)
       end
-
-      def heading_formatter
-        @heading_formatter ||=
-          options.fetch(:heading_formatter, HeadingFormatter::Quiet).new(report_formatter)
-      end
     end
 
     #
@@ -139,7 +136,7 @@ module Reek
     class HTMLReport < Base
       require 'erb'
 
-      def show(target_path = Pathname.new('reek.html'))
+      def show(target_path: Pathname.new('reek.html'))
         template_path = Pathname.new("#{__dir__}/html_report.html.erb")
         File.write target_path, ERB.new(template_path.read).result(binding)
         puts 'HTML file saved'

data/lib/reek/smells/attribute.rb

@@ -35,7 +35,7 @@ module Reek
           SmellWarning.new self,
                            context: ctx.full_name,
                            lines: [line],
-                           message:  'is a writable attribute',
+                           message: 'is a writable attribute',
                            parameters: { name: attribute.to_s }
         end
       end

data/lib/reek/smells/nested_iterators.rb

@@ -19,7 +19,7 @@ module Reek
       # The name of the config field that sets the names of any
       # methods for which nesting should not be considered
       IGNORE_ITERATORS_KEY = 'ignore_iterators'
-      DEFAULT_IGNORE_ITERATORS = []
+      DEFAULT_IGNORE_ITERATORS = ['tap']
 
       def self.default_config
         super.merge(

data/lib/reek/smells/nil_check.rb

@@ -30,7 +30,7 @@ module Reek
       # A base class that allows to work on all nodes of a certain type.
       #
       class NodeFinder
-        def initialize(ctx, type, detector = nil)
+        def initialize(ctx, type, detector)
           @nodes = ctx.local_nodes(type)
           @detector = detector
         end

data/lib/reek/smells/smell_detector.rb

@@ -9,7 +9,7 @@ module Reek
     # See
     #   - {file:docs/Basic-Smell-Options.md}
     #   - {file:docs/Code-Smells.md}
-    #   - {file:docs/Configuration-Files.md}
+    #   - {file:README.md}
     # for details.
     #
     # @api private

data/lib/reek/smells/smell_warning.rb

@@ -11,12 +11,14 @@ module Reek
       attr_reader :context, :lines, :message, :parameters, :smell_detector
       def_delegators :smell_detector, :smell_category, :smell_type, :source
 
-      def initialize(smell_detector, options = {})
+      # FIXME: switch to required kwargs when dropping Ruby 2.0 compatibility
+      def initialize(smell_detector, context: '', lines: raise, message: raise,
+                                     parameters: {})
         @smell_detector = smell_detector
-        @context        = options.fetch(:context, '').to_s
-        @lines          = options.fetch(:lines)
-        @message        = options.fetch(:message)
-        @parameters     = options.fetch(:parameters, {})
+        @context        = context.to_s
+        @lines          = lines
+        @message        = message
+        @parameters     = parameters
       end
 
       def hash

data/lib/reek/source/source_code.rb

@@ -23,7 +23,7 @@ module Reek
       # code        - Ruby code as String
       # description - 'STDIN', 'string' or a filepath as String
       # parser      - the parser to use for generating AST's out of the given source
-      def initialize(code, description, parser = Parser::Ruby22)
+      def initialize(code, description, parser: Parser::Ruby22)
         @source      = code
         @description = description
         @parser      = parser

data/lib/reek/spec.rb

@@ -106,7 +106,7 @@ module Reek
     # Returns +true+ if and only if the target source code contains smells.
     #
     def reek(configuration = Configuration::AppConfiguration.default)
-      ShouldReek.new configuration
+      ShouldReek.new(configuration: configuration)
     end
   end
 end

data/lib/reek/spec/should_reek.rb

@@ -8,7 +8,7 @@ module Reek
     #
     # @api private
     class ShouldReek
-      def initialize(configuration = Configuration::AppConfiguration.default)
+      def initialize(configuration: Configuration::AppConfiguration.default)
         @configuration = configuration
       end
 

data/lib/reek/tree_dresser.rb

@@ -7,23 +7,38 @@ module Reek
   #
   # @api private
   class TreeDresser
-    def initialize(klass_map = AST::ASTNodeClassMap.new)
+    def initialize(klass_map: AST::ASTNodeClassMap.new)
       @klass_map = klass_map
     end
 
     # Recursively enhance an AST with type-dependent mixins, and comments.
     #
     # See {file:docs/How-reek-works-internally.md} for the big picture of how this works.
-    #
+    # Example:
+    # This
+    #   class Klazz; def meth(argument); argument.call_me; end; end
+    # corresponds to this sexp:
+    #   (class
+    #     (const nil :Klazz) nil
+    #     (def :meth
+    #       (args
+    #         (arg :argument))
+    #       (send
+    #         (lvar :argument) :call_me)))
+    # where every node is of type Parser::AST::Node.
+    # Passing this into `dress` will return the exact same structure, but this
+    # time the nodes will contain type-dependent mixins, e.g. this:
+    #   (const nil :Klazz)
+    #  will be of type Reek::AST::Node with  Reek::AST::SexpExtensions::ConstNode mixed in.
     # @param sexp [Parser::AST::Node] - the given sexp
     # @param comment_map [Hash] - see the documentation for SourceCode#syntax_tree
     # @param parent [Parser::AST::Node] - the parent sexp
     #
     # @return an instance of Reek::AST::Node with type-dependent sexp extensions mixed in.
-    def dress(sexp, comment_map, parent = nil)
+    def dress(sexp, comment_map, parent: nil)
       return sexp unless sexp.is_a? ::Parser::AST::Node
       type = sexp.type
-      children = sexp.children.map { |child| dress(child, comment_map, sexp) }
+      children = sexp.children.map { |child| dress(child, comment_map, parent: sexp) }
       comments = comment_map[sexp]
       klass_map.klass_for(type).new(type, children,
                                     location: sexp.loc, comments: comments, parent: parent)

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '3.3.0'
+    STRING = '3.3.1'
   end
 end

data/spec/reek/ast/node_spec.rb

@@ -4,20 +4,20 @@ require_relative '../../../lib/reek/ast/node'
 RSpec.describe Reek::AST::Node do
   context 'format' do
     it 'formats self' do
-      expect(s(:self).format_to_ruby).to eq('self')
+      expect(sexp(:self).format_to_ruby).to eq('self')
     end
   end
 
   context 'hash' do
     it 'hashes equal for equal sexps' do
-      node1 = s(:def, :jim, s(:args), s(:send, s(:int, 4), :+, s(:send, nil, :fred)))
-      node2 = s(:def, :jim, s(:args), s(:send, s(:int, 4), :+, s(:send, nil, :fred)))
+      node1 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 4), :+, sexp(:send, nil, :fred)))
+      node2 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 4), :+, sexp(:send, nil, :fred)))
       expect(node1.hash).to eq(node2.hash)
     end
 
     it 'hashes diferent for diferent sexps' do
-      node1 = s(:def, :jim, s(:args), s(:send, s(:int, 4), :+, s(:send, nil, :fred)))
-      node2 = s(:def, :jim, s(:args), s(:send, s(:int, 3), :+, s(:send, nil, :fred)))
+      node1 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 4), :+, sexp(:send, nil, :fred)))
+      node2 = sexp(:def, :jim, sexp(:args), sexp(:send, sexp(:int, 3), :+, sexp(:send, nil, :fred)))
       expect(node1.hash).not_to eq(node2.hash)
     end
   end

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -3,7 +3,7 @@ require_relative '../../../lib/reek/ast/sexp_extensions'
 
 RSpec.describe Reek::AST::SexpExtensions::DefNode do
   context 'with no parameters' do
-    let(:node) { s(:def, :hello, s(:args)) }
+    let(:node) { sexp(:def, :hello, sexp(:args)) }
 
     it 'has no arg names' do
       expect(node.arg_names).to eq []
@@ -24,8 +24,8 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
 
   context 'with 1 parameter' do
     let(:node) do
-      s(:def, :hello,
-        s(:args, s(:arg, :param)))
+      sexp(:def, :hello,
+           sexp(:args, sexp(:arg, :param)))
     end
 
     it 'has 1 arg name' do
@@ -47,10 +47,10 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
 
   context 'with a block parameter' do
     let(:node) do
-      s(:def, :hello,
-        s(:args,
-          s(:arg, :param),
-          s(:blockarg, :blk)))
+      sexp(:def, :hello,
+           sexp(:args,
+                sexp(:arg, :param),
+                sexp(:blockarg, :blk)))
     end
 
     it 'has 1 arg name' do
@@ -72,9 +72,9 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
 
   context 'with 1 defaulted parameter' do
     let(:node) do
-      s(:def, :hello,
-        s(:args,
-          s(:optarg, :param, s(:array))))
+      sexp(:def, :hello,
+           sexp(:args,
+                sexp(:optarg, :param, sexp(:array))))
     end
 
     it 'has 1 arg name' do
@@ -96,23 +96,23 @@ RSpec.describe Reek::AST::SexpExtensions::DefNode do
 
   context 'with a body with 2 statements' do
     let(:node) do
-      s(:def, :hello, s(:args),
-        s(:begin,
-          s(:first),
-          s(:second)))
+      sexp(:def, :hello, sexp(:args),
+           sexp(:begin,
+                sexp(:first),
+                sexp(:second)))
     end
 
     it 'has 2 body statements' do
-      expect(node.body).to eq s(:begin, s(:first), s(:second))
+      expect(node.body).to eq sexp(:begin, sexp(:first), sexp(:second))
     end
 
     it 'finds nodes in the body with #body_nodes' do
-      expect(node.body_nodes([:first])).to eq [s(:first)]
+      expect(node.body_nodes([:first])).to eq [sexp(:first)]
     end
   end
 
   context 'with no body' do
-    let(:node) { s(:def, :hello, s(:args), nil) }
+    let(:node) { sexp(:def, :hello, sexp(:args), nil) }
 
     it 'has a body that is nil' do
       expect(node.body).to be_nil
@@ -126,7 +126,7 @@ end
 
 RSpec.describe Reek::AST::SexpExtensions::DefsNode do
   context 'with no parameters' do
-    let(:node) { s(:defs, s(:lvar, :obj), :hello, s(:args)) }
+    let(:node) { sexp(:defs, sexp(:lvar, :obj), :hello, sexp(:args)) }
 
     it 'has no arg names' do
       expect(node.arg_names).to eq []
@@ -147,8 +147,8 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
 
   context 'with 1 parameter' do
     let(:node) do
-      s(:defs, s(:lvar, :obj), :hello,
-        s(:args, s(:arg, :param)))
+      sexp(:defs, sexp(:lvar, :obj), :hello,
+           sexp(:args, sexp(:arg, :param)))
     end
 
     it 'has 1 arg name' do
@@ -170,10 +170,10 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
 
   context 'with a block' do
     let(:node) do
-      s(:defs, s(:lvar, :obj), :hello,
-        s(:args,
-          s(:arg, :param),
-          s(:blockarg, :blk)))
+      sexp(:defs, sexp(:lvar, :obj), :hello,
+           sexp(:args,
+                sexp(:arg, :param),
+                sexp(:blockarg, :blk)))
     end
 
     it 'has 1 arg name' do
@@ -195,9 +195,9 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
 
   context 'with 1 defaulted parameter' do
     let(:node) do
-      s(:defs, s(:lvar, :obj), :hello,
-        s(:args,
-          s(:optarg, :param, s(:array))))
+      sexp(:defs, sexp(:lvar, :obj), :hello,
+           sexp(:args,
+                sexp(:optarg, :param, sexp(:array))))
     end
 
     it 'has 1 arg name' do
@@ -219,21 +219,21 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
 
   context 'with a body with 2 statements' do
     let(:node) do
-      s(:defs, s(:self), :hello, s(:args),
-        s(:begin,
-          s(:first),
-          s(:second)))
+      sexp(:defs, sexp(:self), :hello, sexp(:args),
+           sexp(:begin,
+                sexp(:first),
+                sexp(:second)))
     end
 
     it 'has 2 body statements' do
-      expect(node.body).to eq s(:begin, s(:first), s(:second))
+      expect(node.body).to eq sexp(:begin, sexp(:first), sexp(:second))
     end
   end
 end
 
 RSpec.describe Reek::AST::SexpExtensions::SendNode do
   context 'with no parameters' do
-    let(:node) { s(:send, nil, :hello) }
+    let(:node) { sexp(:send, nil, :hello) }
 
     it 'has no argument names' do
       expect(node.arg_names).to eq []
@@ -241,7 +241,7 @@ RSpec.describe Reek::AST::SexpExtensions::SendNode do
   end
 
   context 'with 1 literal parameter' do
-    let(:node) { s(:send, nil, :hello, s(:lit, :param)) }
+    let(:node) { sexp(:send, nil, :hello, sexp(:lit, :param)) }
 
     it 'has 1 argument name' do
       expect(node.arg_names).to eq [:param]
@@ -249,7 +249,7 @@ RSpec.describe Reek::AST::SexpExtensions::SendNode do
   end
 
   context 'with 2 literal parameters' do
-    let(:node) { s(:send, nil, :hello, s(:lit, :x), s(:lit, :y)) }
+    let(:node) { sexp(:send, nil, :hello, sexp(:lit, :x), sexp(:lit, :y)) }
 
     it 'has 2 argument names' do
       expect(node.arg_names).to eq [:x, :y]
@@ -259,7 +259,7 @@ end
 
 RSpec.describe Reek::AST::SexpExtensions::BlockNode do
   context 'with no parameters' do
-    let(:node) { s(:block, s(:send, nil, :map), s(:args), nil) }
+    let(:node) { sexp(:block, sexp(:send, nil, :map), sexp(:args), nil) }
 
     it 'has no parameter names' do
       expect(node.parameter_names).to eq []
@@ -267,7 +267,7 @@ RSpec.describe Reek::AST::SexpExtensions::BlockNode do
   end
 
   context 'with 1 parameter' do
-    let(:node) { s(:block, s(:send, nil, :map), s(:args, :param), nil) }
+    let(:node) { sexp(:block, sexp(:send, nil, :map), sexp(:args, :param), nil) }
 
     it 'has 1 parameter name' do
       expect(node.parameter_names).to eq [:param]
@@ -275,7 +275,7 @@ RSpec.describe Reek::AST::SexpExtensions::BlockNode do
   end
 
   context 'with 2 parameters' do
-    let(:node) { s(:block, s(:send, nil, :map), s(:args, :x, :y), nil) }
+    let(:node) { sexp(:block, sexp(:send, nil, :map), sexp(:args, :x, :y), nil) }
 
     it 'has 2 parameter names' do
       expect(node.parameter_names).to eq [:x, :y]
@@ -286,7 +286,7 @@ end
 RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
   context 'with a simple name' do
     subject do
-      mod = ast(:module, :Fred, nil)
+      mod = sexp(:module, :Fred, nil)
       mod
     end
 
@@ -309,7 +309,7 @@ RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
 
   context 'with a scoped name' do
     subject do
-      s(:module, s(:const, s(:const, nil, :Foo), :Bar), nil)
+      sexp(:module, sexp(:const, sexp(:const, nil, :Foo), :Bar), nil)
     end
 
     it 'has the correct #name' do
@@ -333,7 +333,7 @@ end
 RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
   context 'with single assignment' do
     subject do
-      s(:casgn, nil, :Foo)
+      sexp(:casgn, nil, :Foo)
     end
 
     it 'does not define a module' do

data/spec/reek/ast/sexp_formatter_spec.rb

@@ -4,30 +4,30 @@ require_relative '../../../lib/reek/ast/sexp_formatter'
 RSpec.describe Reek::AST::SexpFormatter do
   describe '::format' do
     it 'formats a simple s-expression' do
-      result = described_class.format s(:lvar, :foo)
+      result = described_class.format sexp(:lvar, :foo)
       expect(result).to eq('foo')
     end
 
     it 'formats a more complex s-expression' do
-      ast = s(:send, nil, :foo, s(:lvar, :bar))
+      ast = sexp(:send, nil, :foo, sexp(:lvar, :bar))
       result = described_class.format(ast)
       expect(result).to eq('foo(bar)')
     end
 
     it 'reduces very large ASTs to a single line' do
-      ast = s(:if,
-              s(:send, nil, :foo),
-              s(:send, nil, :bar),
-              s(:begin,
-                s(:send, nil, :baz),
-                s(:send, nil, :qux)))
+      ast = sexp(:if,
+                 sexp(:send, nil, :foo),
+                 sexp(:send, nil, :bar),
+                 sexp(:begin,
+                      sexp(:send, nil, :baz),
+                      sexp(:send, nil, :qux)))
       result = described_class.format ast
 
       expect(result).to eq 'if foo ... end'
     end
 
     it "doesn't reduce two-line ASTs" do
-      ast = s(:def, 'my_method', s(:args))
+      ast = sexp(:def, 'my_method', sexp(:args))
       result = described_class.format ast
       expect(result).to eq 'def my_method; end'
     end

data/spec/reek/context/code_context_spec.rb

@@ -78,7 +78,7 @@ RSpec.describe Reek::Context::CodeContext do
 
       it "yields the module's full AST" do
         ctx.each_node(:module, []) do |exp|
-          expect(exp).to eq(s(:module, s(:const, nil, :Emptiness), nil))
+          expect(exp).to eq(sexp(:module, sexp(:const, nil, :Emptiness), nil))
         end
       end
 
@@ -105,11 +105,11 @@ RSpec.describe Reek::Context::CodeContext do
 
       it "yields the module's full AST" do
         ctx.each_node(:module, []) do |exp|
-          expect(exp).to eq s(:module,
-                              s(:const, nil, :Loneliness),
-                              s(:def, :calloo,
-                                s(:args),
-                                s(:send, nil, :puts, s(:str, 'hello'))))
+          expect(exp).to eq sexp(:module,
+                                 sexp(:const, nil, :Loneliness),
+                                 sexp(:def, :calloo,
+                                      sexp(:args),
+                                      sexp(:send, nil, :puts, sexp(:str, 'hello'))))
         end
       end
 
@@ -209,7 +209,7 @@ RSpec.describe Reek::Context::CodeContext do
 
     it 'sets visibility on subsequent child contexts' do
       context.append_child_context first_child
-      context.track_visibility :private
+      context.track_visibility :private, []
       context.append_child_context second_child
       expect(first_child.visibility).to eq :public
       expect(second_child.visibility).to eq :private

data/spec/reek/context/method_context_spec.rb

@@ -23,27 +23,27 @@ RSpec.describe Reek::Context::MethodContext do
   end
 
   describe '#envious_receivers' do
-    let(:exp) { s(:def, :foo, s(:args, s(:arg, :bar)), nil) }
+    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 s(:send, s(:ivar, :@cow), :feed_to)
+      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 s(:send, s(:self), :thing)
+      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 s(:send, s(:lvar, :text), :each, s(:arglist))
-      method_context.record_call_to s(:send, nil, :shelve, s(:arglist))
+      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 s(:send, s(:lvar, :bar), :baz)
+      method_context.record_call_to sexp(:send, sexp(:lvar, :bar), :baz)
       expect(method_context.envious_receivers).to include(:bar)
     end
   end
@@ -66,7 +66,7 @@ RSpec.describe Reek::Context::MethodContext do
       let(:defaults) { assignments_from('def meth(arga, argb=456, &blk) end') }
 
       it 'returns the param-value pair' do
-        expect(defaults[0]).to eq [:argb, s(:int, 456)]
+        expect(defaults[0]).to eq [:argb, sexp(:int, 456)]
       end
 
       it 'returns the nothing else' do
@@ -80,8 +80,8 @@ RSpec.describe Reek::Context::MethodContext do
       end
 
       it 'returns both param-value pairs' do
-        expect(defaults[0]).to eq [:arga, s(:int, 123)]
-        expect(defaults[1]).to eq [:argb, s(:int, 456)]
+        expect(defaults[0]).to eq [:arga, sexp(:int, 123)]
+        expect(defaults[1]).to eq [:argb, sexp(:int, 456)]
       end
 
       it 'returns nothing else' do

data/spec/reek/context/singleton_method_context_spec.rb

@@ -3,13 +3,13 @@ require_relative '../../../lib/reek/context/singleton_method_context'
 
 RSpec.describe Reek::Context::SingletonMethodContext do
   let(:smc) do
-    sexp = s(:def, :foo, s(:args, s(:arg, :bar)), nil)
+    sexp = sexp(:def, :foo, sexp(:args, sexp(:arg, :bar)), nil)
     Reek::Context::SingletonMethodContext.new(nil, sexp)
   end
 
   describe '#envious_receivers' do
     it 'should not record envious calls' do
-      smc.record_call_to s(:send, s(:lvar, :bar), :baz)
+      smc.record_call_to sexp(:send, sexp(:lvar, :bar), :baz)
       expect(smc.envious_receivers).to be_empty
     end
   end

data/spec/reek/report/html_report_spec.rb

@@ -16,7 +16,8 @@ RSpec.describe Reek::Report::HTMLReport do
     it 'has the text 0 total warnings' do
       tempfile = Tempfile.new(['Reek::Report::HTMLReport.', '.html'])
       response = "HTML file saved\n"
-      expect { instance.show tempfile.path }.to output(response).to_stdout
+      expect { instance.show(target_path: tempfile.path) }.
+        to output(response).to_stdout
       expect(tempfile.read).to include('0 total warnings')
     end
   end

data/spec/reek/smells/class_variable_spec.rb

@@ -12,12 +12,12 @@ RSpec.describe Reek::Smells::ClassVariable do
 
   context 'with no class variables' do
     it 'records nothing in the class' do
-      exp = ast(:class, :Fred)
+      exp = sexp(:class, :Fred)
       expect(detector.examine_context(Reek::Context::CodeContext.new(nil, exp))).to be_empty
     end
 
     it 'records nothing in the module' do
-      exp = ast(:module, :Fred)
+      exp = sexp(:module, :Fred)
       expect(detector.examine_context(Reek::Context::CodeContext.new(nil, exp))).to be_empty
     end
   end

data/spec/reek/smells/nested_iterators_spec.rb

@@ -22,6 +22,11 @@ RSpec.describe Reek::Smells::NestedIterators do
     expect(src).to reek_of(:NestedIterators)
   end
 
+  it 'should not report nested iterators for Object#tap' do
+    src = 'def do_stuff(*params); [].tap {|list| params.map {|param| list << (param + param)} } end'
+    expect(src).not_to reek_of(:NestedIterators)
+  end
+
   it 'should not report method with successive iterators' do
     src = <<-EOS
       def bad(fred)

data/spec/reek/source/source_code_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe Reek::Source::SourceCode do
     let(:source_name) { 'Test source' }
     let(:error_message) { 'Error message' }
     let(:parser) { double('parser') }
-    let(:src) { Reek::Source::SourceCode.new('', source_name, parser) }
+    let(:src) { Reek::Source::SourceCode.new('', source_name, parser: parser) }
 
     before { $stderr = catcher }
 

data/spec/reek/spec/should_reek_spec.rb

@@ -46,7 +46,7 @@ RSpec.describe Reek::Spec::ShouldReek do
     context 'matcher without masking' do
       let(:path) { SAMPLES_PATH.join('clean_due_to_masking/masked.reek') }
       let(:configuration) { test_configuration_for(path) }
-      let(:matcher) { Reek::Spec::ShouldReek.new configuration }
+      let(:matcher) { Reek::Spec::ShouldReek.new(configuration: configuration) }
       let(:masked_file) { SAMPLES_PATH.join('clean_due_to_masking/dirty_one.rb') }
 
       it 'masks smells using the relevant configuration' do

data/spec/reek/tree_dresser_spec.rb

@@ -1,16 +1,50 @@
+require_relative '../../lib/reek/cli/silencer'
+Reek::CLI::Silencer.silently do
+  require 'parser/ruby22'
+end
+
 require_relative '../spec_helper'
 require_relative '../../lib/reek/tree_dresser'
 
 RSpec.describe Reek::TreeDresser do
-  let(:ifnode) { ::Parser::AST::Node.new(:if) }
-  let(:sendnode) { ::Parser::AST::Node.new(:send) }
   let(:dresser) { described_class.new }
-
-  it 'dresses :if sexp with IfNode' do
-    expect(dresser.dress(ifnode, {})).to be_a Reek::AST::SexpExtensions::IfNode
+  let(:sexp) do
+    Parser::Ruby22.parse('class Klazz; def meth(argument); argument.call_me; end; end')
+  end
+  let(:dressed_ast) do
+    # The dressed AST looks like this:
+    #   (class
+    #     (const nil :Klazz) nil
+    #     (def :meth
+    #       (args
+    #         (arg :argument))
+    #       (send
+    #         (lvar :argument) :call_me)))
+    dresser.dress(sexp, {})
   end
+  let(:const_node) { dressed_ast.children.first }
+  let(:def_node) { dressed_ast.children.last }
+  let(:args_node) { def_node.children[1] }
+  let(:send_node) { def_node.children[2] }
+
+  context 'dresses the given sexp' do
+    it 'dresses `const` nodes properly' do
+      expect(const_node).to be_a Reek::AST::SexpExtensions::ConstNode
+    end
+
+    it 'dresses `def` nodes properly' do
+      expect(def_node).to be_a Reek::AST::SexpExtensions::DefNode
+      expect(def_node).to be_a Reek::AST::SexpExtensions::SingletonMethod
+      expect(def_node).to be_a Reek::AST::SexpExtensions::MethodNodeBase
+    end
+
+    it 'dresses `args` nodes properly' do
+      expect(args_node).to be_a Reek::AST::SexpExtensions::ArgsNode
+      expect(args_node).to be_a Reek::AST::SexpExtensions::NestedAssignables
+    end
 
-  it 'dresses :send sexp with SendNode' do
-    expect(dresser.dress(sendnode, {})).to be_a Reek::AST::SexpExtensions::SendNode
+    it 'dresses `send` nodes properly' do
+      expect(send_node).to be_a Reek::AST::SexpExtensions::SendNode
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ require_relative '../lib/reek'
 require_relative '../lib/reek/spec'
 require_relative '../lib/reek/ast/ast_node_class_map'
 require_relative '../lib/reek/configuration/app_configuration'
-require 'ostruct'
 
 Reek::CLI::Silencer.silently do
   require 'factory_girl'
@@ -35,17 +34,12 @@ module Helpers
   end
 
   # :reek:UncommunicativeMethodName
-  def s(type, *children)
+  def sexp(type, *children)
     @klass_map ||= Reek::AST::ASTNodeClassMap.new
     @klass_map.klass_for(type).new(type, children)
   end
-
-  def ast(*args)
-    s(*args)
-  end
 end
 
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.filter_run :focus
   config.run_all_when_everything_filtered = true

metadata

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