reek 3.0.4 → 3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02b11e29be1e78d0ca3b5c5bb7e209d215a34142
-  data.tar.gz: 2fbda696128728c307a65abe0c61479bccc197ea
+  metadata.gz: c490c79513c93451a148336881db8ffec7665e7e
+  data.tar.gz: 88059b5d7db2a76be01ca26339e3753f1ef4fa68
 SHA512:
-  metadata.gz: 08a97e6cba42ad58c4f6691d89cf4267ce79777095766859421ef6853b98f51c44521988f977e2d78d6dd1ebcdb56bc9b88e53e1fdc0af204f1aba22fe38be8c
-  data.tar.gz: 6074cc6366979c9e75722d8359fbdba75a2539eba9b3ffad21b5eaee59fa4ae7789d717ea6044b128577ccf13010a49caf69156eef34f239594cc592354eb2d1
+  metadata.gz: a93e6367ce746f4c1fba78e8ca91e035b9f3f9624316f329c1f5640415649816dfcc5608427ec113ac4c66aceb7f3eaed800af0c11a8931ebfc828e0a1931413
+  data.tar.gz: 24b764ba2d1a15fefe32702567f55cdf49270aaf00c78b6cab50420ebad3b96651d450c210934b8e76e50da2048b14e0b496c4a861ebeb98f4a6d6fedfdac21c

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 3.1
+
+* (troessner) Make smells configurable on a directory base
+* (mvz) Handle modules defined by constant assignment
+* (mvz) Handle modifier style use of module_function for UtilityFunction
+
 == 3.0.4
 
 * (troessner) Fix wiki-link cli option.

data/README.md

@@ -144,42 +144,63 @@ of how many `*.reek` files you might have on your filesystem.
 
 #### Configuration options
 
-The first thing you probably want to check out are the
-[Basic Smell Options](docs/Basic-Smell-Options.md)
-which are supported by every smell type. Certain smell
-types offer a configuration that goes beyond that
-of the basic smell options, for instance
-[Data Clump](docs/Data-Clump.md).
-All options that go beyond the [Basic Smell Options](docs/Basic-Smell-Options.md)
-should be documented in the corresponding smell type wiki page,
-but if you want to get a quick and full overview over all possible
-configurations you can always check out [the `config/default.reek`
-file in this repository](config/defaults.reek).
-
-Here's an excerpt of a `reek` configuration file from a commercial project:
+We put a lot of effort into making `reek`'s configuration as self explanatory as possible so the
+best way to understand it is by looking at a simple
+example (e.g. `config.reek` in your project directory):
 
 ```yaml
 ---
+
+### Generic smell configuration
+
+# You can disable smells completely
 IrresponsibleModule:
   enabled: false
 
+# You can use filters to silence reek warnings.
+# Either because you simply disagree with reek (we are not the police) or
+# because you want to fix this at a later point in time.
 NestedIterators:
   exclude:
-    - "ActiveModelErrorAdder#self.run" # should be refactored
-    - "BookingRequests::Transfer#remote_validation"
-    - "BookingRequestsController#vehicle_options" # respond_to block
-    - "Content::Base#self.expose_fields" # unavoidable due to metaprogramming
+    - "MyWorker#self.class_method" # should be refactored
+    - "AnotherWorker#instance_method" # should be refactored as well
 
+# A lot of smells allow fine tuning their configuration. You can look up all available options
+# in the corresponding smell documentation in /docs. In most cases you probably can just go
+# with the defaults we set in config/defaults.reek.
 DataClump:
   max_copies: 3
   min_clump_size: 3
 
+### Directory specific configuration
+
+# You can configure smells on a per-directory base.
+# E.g. the classic Rails case: controllers smell of NestedIterators (see /docs/Nested-Iterators.md) and
+# helpers smell of UtilityFunction (see docs/Utility-Function.md)
+"web_app/app/controllers":
+  NestedIterators:
+    enabled: false
+"web_app/app/helpers":
+  UtilityFunction:
+    enabled: false
+
+### Excluding directories
+
+# Directories below will not be scanned at all
 exclude_paths:
-  - app/views
-  - app/controllers
+  - lib/legacy
+  - lib/rake/legacy_tasks
 ```
 
-Additionally to the smell configuration you can exclude whole directories from scans using `exclude_paths` as you can see at the end of the configuration above.
+Note you do not need a configuration file at all. If you're fine with all the [defaults](config/defaults.reek) we set you can skip this completely.
+
+For more details please check out the [Basic Smell Options](docs/Basic-Smell-Options.md)
+which are supported by every smell type. As you can see above, certain smell
+types offer a configuration that goes beyond that of the basic smell options, for instance
+[Data Clump](docs/Data-Clump.md).
+All options that go beyond the [Basic Smell Options](docs/Basic-Smell-Options.md)
+are documented in the corresponding smell type /docs page (if you want to get a quick overview over all possible
+configurations you can also check out [the `config/default.reek` file in this repository](config/defaults.reek).
 
 ### Source code comments
 

data/features/configuration_files/directory_specific_directives.feature

@@ -0,0 +1,280 @@
+Feature: Directory directives
+  In order to have a more fine-grained control over what reek reports
+  And to enable domain specific modes (like a Ruby on Rails mode)
+  As a user
+  I want to be able to configure reek using directory directives
+
+  Scenario: Configure multiple directories
+    Given a file named "web_app/config.reek" with:
+      """
+      ---
+      "web_app/app/controllers":
+        IrresponsibleModule:
+          enabled: false
+        NestedIterators:
+          enabled: false
+      "web_app/app/helpers":
+        IrresponsibleModule:
+          enabled: false
+        UtilityFunction:
+          enabled: false
+      """
+    And a file named "web_app/app/controllers/users_controller.rb" with:
+      """
+      class UsersController < ApplicationController
+        def show
+          respond_with do |format|
+            format.json { @user.to_custom_json }
+            format.xlm { @user.to_fancy_xml }
+          end
+        end
+      end
+      """
+    And a file named "web_app/app/helpers/application_helper.rb" with:
+      """
+      module ApplicationHelper
+        def current_year
+          Time.zone.now.year
+        end
+      end
+      """
+    And a file named "web_app/app/models/user.rb" with:
+      """
+      class User < ActiveRecord::Base
+        def logged_in_with_role(r)
+          true
+        end
+      end
+      """
+    When I run `reek -c web_app/config.reek web_app/`
+    Then it reports:
+    """
+    web_app/app/models/user.rb -- 2 warnings:
+      [1]:User has no descriptive comment (IrresponsibleModule)
+      [2]:User#logged_in_with_role has unused parameter 'r' (UnusedParameters)
+    2 total warnings
+    """
+
+  Scenario: Ignore trailing slashes
+    Given a file named "web_app/config.reek" with:
+      """
+      ---
+      "controllers/":
+        IrresponsibleModule:
+          enabled: false
+      """
+    And a file named "controllers/users_controller.rb" with:
+      """
+      class UsersController
+        def show
+        end
+      end
+      """
+    When I run `reek -c web_app/config.reek controllers`
+    Then it reports nothing
+
+  Scenario: Partially mask smells in different directories
+    Given a file named "web_app/config.reek" with:
+      """
+      ---
+      "web_app/app/controllers":
+        IrresponsibleModule:
+          enabled: true
+      "web_app/app/helpers":
+        IrresponsibleModule:
+          enabled: false
+        UtilityFunction:
+          enabled: false
+      "web_app/app/models":
+        IrresponsibleModule:
+          enabled: false
+      """
+    And a file named "web_app/app/controllers/users_controller.rb" with:
+      """
+      class UsersController < ApplicationController
+        def show
+          respond_with do |format|
+            format.json { @user.to_custom_json }
+          end
+        end
+      end
+      """
+    And a file named "web_app/app/helpers/application_helper.rb" with:
+      """
+      module ApplicationHelper
+        def current_year
+          Time.zone.now.year
+        end
+      end
+      """
+    And a file named "web_app/app/models/user.rb" with:
+      """
+      class User < ActiveRecord::Base
+        def logged_in_with_role(r)
+          true
+        end
+      end
+      """
+    When I run `reek -c web_app/config.reek web_app/`
+    Then it reports:
+    """
+    web_app/app/controllers/users_controller.rb -- 2 warnings:
+      [1]:UsersController has no descriptive comment (IrresponsibleModule)
+      [4]:UsersController#show contains iterators nested 2 deep (NestedIterators)
+    web_app/app/models/user.rb -- 1 warning:
+      [2]:User#logged_in_with_role has unused parameter 'r' (UnusedParameters)
+    3 total warnings
+    """
+
+  Scenario: Use the default directive if there is no directory directive
+    Given a file named "config.reek" with:
+      """
+      ---
+      "web_app/app/controllers":
+        IrresponsibleModule:
+          enabled: true
+        NestedIterators:
+          enabled: false
+      IrresponsibleModule:
+        enabled: false
+      NestedIterators:
+        enabled: true
+      """
+    And a file named "web_app/app/controllers/users_controller.rb" with:
+      """
+      class UsersController < ApplicationController
+        def show
+          respond_with do |format|
+            format.json { @user.to_custom_json }
+          end
+        end
+      end
+      """
+    And a file named "other/projects_controller.rb" with:
+      """
+      class ProjectController < ApplicationController
+        def show
+          respond_with do |format|
+            format.json { @project.to_custom_json }
+          end
+        end
+      end
+      """
+    When I run `reek -c config.reek other/ web_app/`
+    Then it reports:
+    """
+    other/projects_controller.rb -- 1 warning:
+      [4]:ProjectController#show contains iterators nested 2 deep (NestedIterators)
+    web_app/app/controllers/users_controller.rb -- 1 warning:
+      [1]:UsersController has no descriptive comment (IrresponsibleModule)
+    2 total warnings
+    """
+
+  Scenario: Abort on non-existent directory
+    Given a file named "config.reek" with:
+      """
+      ---
+      "does/not/exist":
+        NestedIterators:
+          enabled: false
+      """
+    When I run `reek -c config.reek lib/`
+    Then the exit status indicates an error
+    And stderr reports:
+    """
+    Configuration error: Directory `does/not/exist` does not exist
+
+    """
+
+  Scenario: Abort on non-existent smell type in directory directive
+    Given a file named "config.reek" with:
+      """
+      ---
+      "dummy_directory":
+        # Typo: Should be NestedIterators
+        IteratorsNested:
+          enabled: false
+      """
+    And a file named "dummy_directory/dummy.rb" with:
+      """
+      class Dummy
+      end
+      """
+
+    When I run `reek -c config.reek dummy_directory/`
+    Then the exit status indicates an error
+    And stderr reports:
+    """
+    You are trying to configure smell type IteratorsNested but we can't find one with that name.
+    Please make sure you spelled it right (see 'config/defaults.reek' in the reek
+    repository for a list of all available smell types.
+
+    """
+
+  Scenario: Abort on file as directory directive
+    Given a file named "config.reek" with:
+      """
+      ---
+      "dummy_directory/dummy.rb":
+        NestedIterators:
+          enabled: false
+      """
+    And a file named "dummy_directory/dummy.rb" with:
+      """
+      class Dummy
+      end
+      """
+    When I run `reek -c config.reek dummy_directory/`
+    Then the exit status indicates an error
+    And stderr reports:
+    """
+    Configuration error: `dummy_directory/dummy.rb` is supposed to be a directory but is a file
+
+    """
+
+  Scenario: In case of overlapping configurations, pick the most appropriate one
+    Given a file named "config.reek" with:
+      """
+      ---
+      "foo/bar/baz":
+        IrresponsibleModule:
+          enabled: false
+        NestedIterators:
+          enabled: true
+      "foo/bar":
+        IrresponsibleModule:
+          enabled: true
+        NestedIterators:
+          enabled: false
+      """
+    And a file named "foo/bar/baz/klass.rb" with:
+      """
+      class Klass
+        def meth
+          respond_to do
+            answer_to do
+            end
+          end
+        end
+      end
+      """
+    And a file named "foo/bar/klazz.rb" with:
+      """
+      class Klazz
+        def meth
+          respond_to do
+            answer_to do
+            end
+          end
+        end
+      end
+      """
+    When I run `reek -c config.reek foo/`
+    Then it reports:
+    """
+    foo/bar/baz/klass.rb -- 1 warning:
+      [4]:Klass#meth contains iterators nested 2 deep (NestedIterators)
+    foo/bar/klazz.rb -- 1 warning:
+      [1]:Klazz has no descriptive comment (IrresponsibleModule)
+    2 total warnings
+    """

data/features/configuration_files/masking_smells.feature

@@ -3,20 +3,6 @@ Feature: Masking smells using config files
   As a developer
   I want to mask some smells using config files
 
-  Scenario: empty config file is ignored
-    Given a smelly file called 'smelly.rb'
-    And an empty configuration file called 'empty.reek'
-    When I run reek -c empty.reek smelly.rb
-    Then it reports the error 'Warning: Invalid configuration file "empty.reek" -- Empty file'
-    And the exit status indicates smells
-    And it reports:
-      """
-      smelly.rb -- 3 warnings:
-        [4, 5]:Smelly#m calls @foo.bar 2 times (DuplicateMethodCall)
-        [4, 5]:Smelly#m calls puts(@foo.bar) 2 times (DuplicateMethodCall)
-        [3]:Smelly#m has the name 'm' (UncommunicativeMethodName)
-      """
-
   Scenario: corrupt config file prevents normal output
     Given a smelly file called 'smelly.rb'
     And a corrupt configuration file called 'corrupt.reek'

data/features/step_definitions/sample_file_steps.rb

@@ -26,7 +26,7 @@ Given(/^a smelly file with inline masking called 'inline.rb'$/) do
 end
 
 Given(/^the "(.*?)" sample file exists$/) do |file_name|
-  full_path = File.expand_path file_name, 'spec/samples'
+  full_path = Pathname.new("#{__dir__}/../../spec/samples/#{file_name}")
   in_current_directory { FileUtils.cp full_path, file_name }
 end
 
@@ -135,7 +135,7 @@ When(/^I run "reek (.*?)" in the subdirectory$/) do |args|
 end
 
 Given(/^a masking configuration file in the HOME directory$/) do
-  set_env('HOME', File.expand_path(File.join(current_directory, 'home')))
+  set_env 'HOME', Pathname.new("#{current_directory}/home").expand_path.to_s
   write_file('home/config.reek', <<-EOS.strip_heredoc)
     ---
     DuplicateMethodCall:

data/lib/reek/ast/sexp_extensions.rb

@@ -169,9 +169,9 @@ module Reek
 
       # Utility methods for :send nodes.
       module SendNode
-        def receiver() self[1] end
-        def method_name() self[2] end
-        def args() self[3..-1] end
+        def receiver; children.first; end
+        def method_name() children[1]; end
+        def args() children[2..-1] end
 
         def participants
           ([receiver] + args).compact
@@ -180,8 +180,14 @@ module Reek
         def arg_names
           args.map { |arg| arg[1] }
         end
+
+        def object_creation_call?
+          method_name == :new
+        end
       end
 
+      Op_AsgnNode = SendNode
+
       # Base module for utility methods for nodes representing variables.
       module VariableBase
         def name() self[1] end
@@ -252,43 +258,7 @@ module Reek
       # Checking if a method is a singleton method.
       module SingletonMethod
         def singleton_method?
-          singleton_method_via_class_self_notation? ||
-            singleton_method_via_module_function?
-        end
-
-        # Ruby allows us to make a method a singleton_method after having defined the
-        # method via `module_function`.
-        #
-        # To check if we used "module_function" for a method we need to check on the parent
-        # level of the method in question if there is a call to "module_function".
-        # Given someting like
-        #   class C
-        #     def m; 3 + 7; end
-        #     module_function :m
-        #   end
-        # the AST (truncated, without the class definition) would look like this:
-        #   (def :m
-        #     (args)
-        #     (send
-        #       (int 3) :+
-        #       (int 7)))
-        #   (send nil :module_function
-        #     (sym :m))))
-        # With multiple arguments to module_function this gets more complicated:
-        #   (send nil :module_function
-        #     (sym :m1)
-        #     (send nil :m2))
-        #
-        # @return [Boolean]
-        def singleton_method_via_module_function?
-          return unless parent
-          module_function_calls(parent).any? do |module_function_call|
-            method_name_nodes = module_function_call.children[2..-1]
-            method_names = method_name_nodes.map do |node|
-              node.children.last
-            end
-            method_names.include?(name)
-          end
+          singleton_method_via_class_self_notation?
         end
 
         # Ruby allows us to make a method a singleton_method using the
@@ -301,16 +271,6 @@ module Reek
           return unless parent
           parent.type == :sclass
         end
-
-        private
-
-        def module_function_calls(parent)
-          parent.children.select do |elem|
-            elem.is_a?(::Parser::AST::Node) &&
-              elem.type == :send &&
-              elem.children[1] == :module_function
-          end
-        end
       end
 
       # Utility methods for :def nodes.
@@ -346,6 +306,7 @@ module Reek
         end
 
         include MethodNodeBase
+
         def full_name(outer)
           prefix = outer == '' ? '' : "#{outer}#"
           "#{prefix}#{SexpFormatter.format(receiver)}.#{name}"
@@ -389,21 +350,45 @@ module Reek
         end
       end
 
-      # Utility methods for :module nodes.
-      module ModuleNode
-        def name() self[1] end
+      # Base module for utility methods for module nodes.
+      module ModuleNodeBase
+        # The full name of the module or class, including the name of any
+        # module or class it is nested inside of.
+        #
+        # For example, given code like this:
+        #
+        #   module Foo
+        #     class Bar::Baz
+        #     end
+        #   end
+        #
+        # The full name for the inner class will be 'Foo::Bar::Baz'. To return
+        # the correct name, the name of the outer context has to be passed into this method.
+        #
+        # @param outer [String] full name of the wrapping module or class
+        # @return the module's full name
+        def full_name(outer)
+          prefix = outer == '' ? '' : "#{outer}::"
+          "#{prefix}#{name}"
+        end
 
+        # The final section of the module or class name. For example, for a
+        # module with name 'Foo::Bar' this will return 'Bar'; for a module with
+        # name 'Foo' this will return 'Foo'.
+        #
+        # @return [String] the final section of the name
         def simple_name
-          name.is_a?(::Parser::AST::Node) ? name.simple_name : name
+          name.split('::').last
         end
+      end
 
-        def full_name(outer)
-          prefix = outer == '' ? '' : "#{outer}::"
-          "#{prefix}#{text_name}"
-        end
+      # Utility methods for :module nodes.
+      module ModuleNode
+        include ModuleNodeBase
 
-        def text_name
-          SexpFormatter.format(name)
+        # @return [String] name as given in the module statement
+        def name
+          SexpFormatter.format(children.first)
         end
       end
 
@@ -413,6 +398,33 @@ module Reek
         def superclass() self[2] end
       end
 
+      # Utility methods for :casgn nodes.
+      module CasgnNode
+        include ModuleNodeBase
+
+        MODULE_DEFINERS = [:Class, :Struct]
+
+        def defines_module?
+          call = case value.type
+                 when :block
+                   value.call
+                 when :send
+                   value
+                 end
+          call &&
+            call.object_creation_call? &&
+            MODULE_DEFINERS.include?(call.receiver.simple_name)
+        end
+
+        def name
+          SexpFormatter.format(children[1])
+        end
+
+        def value
+          children.last
+        end
+      end
+
       # Utility methods for :yield nodes.
       module YieldNode
         def args() self[1..-1] end