reek 2.0.4 → 3.0.0

data/features/command_line_interface/smells_count.feature

@@ -3,45 +3,38 @@ Feature: Reports total number of code smells
   Reek outputs the total number of smells among all files inspected.
 
   Scenario: Does not output total number of smells when inspecting single file
-    When I run reek spec/samples/standard_smelly/dirty.rb
+    Given a smelly file called 'smelly.rb'
+    When I run reek smelly.rb
     Then the exit status indicates smells
     And it reports:
-    """
-    spec/samples/standard_smelly/dirty.rb -- 6 warnings:
-      [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-      [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-      [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-      [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-      [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
-    """
+      """
+      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: Output total number of smells when inspecting multiple files
-    When I run reek spec/samples/two_smelly_files
+    Given a directory called 'smelly' containing two smelly files
+    When I run reek smelly
     Then the exit status indicates smells
     And it reports:
-    """
-    spec/samples/two_smelly_files/dirty_one.rb -- 6 warnings:
-      [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-      [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-      [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-      [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-      [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
-    spec/samples/two_smelly_files/dirty_two.rb -- 6 warnings:
-      [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-      [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-      [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-      [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-      [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
-    12 total warnings
-    """
+      """
+      smelly/dirty_one.rb -- 2 warnings:
+        [1]:Dirty has no descriptive comment (IrresponsibleModule)
+        [2]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+      smelly/dirty_two.rb -- 3 warnings:
+        [1]:Dirty has no descriptive comment (IrresponsibleModule)
+        [2]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+        [3]:Dirty#b has the name 'b' (UncommunicativeMethodName)
+      5 total warnings
+      """
 
   Scenario: Output total number of smells even if total equals 0
-    When I run reek spec/samples/three_clean_files
+    Given a directory called 'clean_files' containing some clean files
+    When I run reek clean_files
     Then it succeeds
     And it reports:
-    """
-    0 total warnings
-    """
+      """
+      0 total warnings
+      """

data/features/command_line_interface/stdin.feature

@@ -18,7 +18,7 @@ Feature: Reek reads from $stdin when no files are given
     Then it succeeds
     And it reports:
       """
-      $stdin -- 0 warnings
+      STDIN -- 0 warnings
       """
 
   Scenario: return non-zero status when there are smells
@@ -26,7 +26,7 @@ Feature: Reek reads from $stdin when no files are given
     Then the exit status indicates smells
     And it reports:
       """
-      $stdin -- 3 warnings:
+      STDIN -- 3 warnings:
         [1]:Turn has no descriptive comment (IrresponsibleModule)
         [1]:Turn has the variable name '@x' (UncommunicativeVariableName)
         [1]:Turn#y has the name 'y' (UncommunicativeMethodName)

data/features/configuration_files/masking_smells.feature

@@ -4,69 +4,58 @@ Feature: Masking smells using config files
   I want to mask some smells using config files
 
   Scenario: empty config file is ignored
-    When I run reek -c spec/samples/empty_config_file/empty.reek spec/samples/empty_config_file/dirty.rb
+    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:
       """
-      spec/samples/empty_config_file/dirty.rb -- 6 warnings:
-        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-        [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-        [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-        [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-        [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+      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
-    When I run reek -c spec/samples/corrupt_config_file/corrupt.reek spec/samples/corrupt_config_file
+    Given a smelly file called 'smelly.rb'
+    And a corrupt configuration file called 'corrupt.reek'
+    When I run reek -c corrupt.reek smelly.rb
     Then it reports the error 'Error: Invalid configuration file "corrupt.reek" -- Not a hash'
     And the exit status indicates an error
     And it reports nothing
 
   Scenario: missing source file is an error
-    When I run reek spec/samples/missing_source_file/dirty.rb
-    Then it reports the error "Error: No such file - spec/samples/missing_source_file/dirty.rb"
-
-  Scenario: switch off one smell
-    When I run reek -c spec/samples/masked/masked.reek spec/samples/masked/dirty.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      spec/samples/masked/dirty.rb -- 3 warnings:
-        [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-        [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-      """
+    When I run reek not_here.rb
+    Then it reports the error "Error: No such file - not_here.rb"
 
-  Scenario: non-masked smells are only counted once
-    When I run reek -c spec/samples/not_quite_masked/masked.reek spec/samples/not_quite_masked/dirty.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      spec/samples/not_quite_masked/dirty.rb -- 5 warnings:
-        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-        [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-        [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-        [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-      """
+  Scenario: masking smells in the configuration file
+    Given a smelly file called 'smelly.rb'
+    And a masking configuration file called 'config.reek'
+    When I run reek -c config.reek smelly.rb
+    Then it succeeds
+    And it reports nothing
 
   Scenario: allow masking some calls for duplication smell
-    When I run reek -c spec/samples/mask_some/some.reek spec/samples/mask_some/dirty.rb
+    Given a smelly file called 'smelly.rb'
+    And a configuration file masking some duplication smells called 'config.reek'
+    When I run reek -c config.reek smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/mask_some/dirty.rb -- 2 warnings:
-        [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
+      smelly.rb -- 2 warnings:
+        [4, 5]:Smelly#m calls @foo.bar 2 times (DuplicateMethodCall)
+        [3]:Smelly#m has the name 'm' (UncommunicativeMethodName)
       """
 
   Scenario: provide extra masking inline in comments
-    When I run reek -c spec/samples/inline_config/masked.reek spec/samples/inline_config
+    Given a smelly file with inline masking called 'inline.rb'
+    And a masking configuration file called 'config.reek'
+    When I run reek -c config.reek inline.rb
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/inline_config/dirty.rb -- 1 warning:
-        [5, 7]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
+      inline.rb -- 2 warnings:
+        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
       """

data/features/configuration_files/overrides_defaults.feature

@@ -3,11 +3,13 @@ Feature: Overriding current rules by specifying new configuration values
   As a developer
   I want to be able to override the default configuration values
 
-  Scenario: List of configuration values is overridden by a lower config file
-    When I run reek -c spec/samples/overrides_defaults/config.reek spec/samples/overrides_defaults/camel_case.rb
+  Scenario: List of configuration values is overridden by a lower configuration file
+    Given a file with smelly variable names called 'camel_case.rb'
+    And a configuration file allowing camel case variables
+    When I run reek camel_case.rb
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/overrides_defaults/camel_case.rb -- 1 warning:
+      camel_case.rb -- 1 warning:
         [9]:CamelCase#initialize has the variable name 'x1' (UncommunicativeVariableName)
       """

data/features/configuration_loading.feature

@@ -11,52 +11,55 @@ Feature: Offer different ways how to load configuration
   And finally, it should check your HOME directory.
 
   Scenario: No configuration
-    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Given a smelly file called 'smelly.rb'
+    When I run reek smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/configuration_loading/minimal_dirty.rb -- 3 warnings:
-        [1]:C has no descriptive comment (IrresponsibleModule)
-        [1]:C has the name 'C' (UncommunicativeModuleName)
-        [2]:C#m has the name 'm' (UncommunicativeMethodName)
+      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: Configuration via CLI
-    When I run reek -c spec/samples/minimal_smelly_and_masked/config.reek spec/samples/minimal_smelly_and_masked/minimal_dirty.rb
+    Given a smelly file called 'smelly.rb'
+    And a masking configuration file called 'config.reek'
+    When I run reek -c config.reek smelly.rb
     Then it reports no errors
     And it succeeds
 
-  @remove-disable-smell-config-from-current-dir
   Scenario: Configuration file in working directory
-    Given "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the working directory
-    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Given a smelly file called 'smelly.rb'
+    And a masking configuration file called 'config.reek'
+    When I run reek smelly.rb
     Then it reports no errors
     And it succeeds
 
-  @remove-disable-smell-config-from-parent-dir
   Scenario: Configuration file in the parent directory of the working directory
-    Given "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the parent directory of the working directory
-    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Given a smelly file called 'smelly.rb' in a subdirectory
+    And a masking configuration file called 'config.reek'
+    When I run "reek smelly.rb" in the subdirectory
     Then it reports no errors
     And it succeeds
 
-  @remove-disable-smell-config-from-home-dir
   Scenario: Configuration file in the HOME directory
-    Given "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the HOME directory
-    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Given a smelly file called 'smelly.rb'
+    And a masking configuration file in the HOME directory
+    When I run reek smelly.rb
     Then it reports no errors
     And it succeeds
 
-  @remove-enable-smell-config-from-current-dir @remove-disable-smell-config-from-parent-dir
   Scenario: Two opposing configuration files and we stop after the first one
-    Given "spec/samples/configuration_loading/reek-test-run-enable_smells.reek" exists in the working directory
-    And "spec/samples/configuration_loading/reek-test-run-disable_smells.reek" exists in the parent directory of the working directory
-    When I run reek spec/samples/configuration_loading/minimal_dirty.rb
+    Given a smelly file called 'smelly.rb' in a subdirectory
+    And an enabling configuration file in the subdirectory
+    And a masking configuration file called 'config.reek'
+    When I run "reek smelly.rb" in the subdirectory
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/configuration_loading/minimal_dirty.rb -- 3 warnings:
-        [1]:C has no descriptive comment (IrresponsibleModule)
-        [1]:C has the name 'C' (UncommunicativeModuleName)
-        [2]:C#m has the name 'm' (UncommunicativeMethodName)
+      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)
       """

data/features/programmatic_access.feature

@@ -0,0 +1,43 @@
+Feature: Using reek programmatically
+  In order to use reek from inside my program
+  As a developer
+  I want to be able to use its classes
+
+  Scenario: Accessing smells found by an examiner
+    Given a smelly file called 'smelly.rb'
+    And a file named "examine.rb" with:
+      """
+      require 'reek'
+      examiner = Reek::Examiner.new(File.new('smelly.rb'))
+      examiner.smells.each do |smell|
+        puts smell.message
+      end
+      """
+    When I run `ruby examine.rb`
+    Then it reports no errors
+    And it reports:
+      """
+      calls @foo.bar 2 times
+      calls puts(@foo.bar) 2 times
+      has the name 'm'
+      """
+
+  Scenario: Using reek's built-in report classes
+    Given a smelly file called 'smelly.rb'
+    And a file named "examine.rb" with:
+      """
+      require 'reek'
+      examiner = Reek::Examiner.new(File.new('smelly.rb'))
+      report = Reek::Report::TextReport.new
+      report.add_examiner examiner
+      report.show
+      """
+    When I run `ruby examine.rb`
+    Then it reports no errors
+    And it reports:
+      """
+      smelly.rb -- 3 warnings:
+        Smelly#m calls @foo.bar 2 times (DuplicateMethodCall)
+        Smelly#m calls puts(@foo.bar) 2 times (DuplicateMethodCall)
+        Smelly#m has the name 'm' (UncommunicativeMethodName)
+      """

data/features/rake_task/rake_task.feature

@@ -3,56 +3,60 @@ Feature: Reek can be driven through its Task
   via the Task class. These scenarios test its various options.
 
   Scenario: source_files points at the desired files
+    Given a smelly file called 'smelly.rb'
     When I run rake reek with:
       """
       Reek::Rake::Task.new do |t|
-        t.source_files = 'spec/samples/standard_smelly/minimal_dirty.rb'
+        t.source_files = 'smelly.rb'
         t.reek_opts = '--no-color'
       end
       """
     Then the exit status indicates an error
     And it reports:
       """
-      spec/samples/standard_smelly/minimal_dirty.rb -- 3 warnings:
-        [1]:C has no descriptive comment (IrresponsibleModule)
-        [1]:C has the name 'C' (UncommunicativeModuleName)
-        [2]:C#m has the name 'm' (UncommunicativeMethodName)
+      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: name changes the task name
+    Given a smelly file called 'smelly.rb'
     When I run rake silky with:
       """
       Reek::Rake::Task.new('silky') do |t|
-        t.source_files = 'spec/samples/standard_smelly/minimal_dirty.rb'
+        t.source_files = 'smelly.rb'
         t.reek_opts = '--no-color'
       end
       """
     Then the exit status indicates an error
     And it reports:
       """
-      spec/samples/standard_smelly/minimal_dirty.rb -- 3 warnings:
-        [1]:C has no descriptive comment (IrresponsibleModule)
-        [1]:C has the name 'C' (UncommunicativeModuleName)
-        [2]:C#m has the name 'm' (UncommunicativeMethodName)
+      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: verbose prints the reek command
+    Given a smelly file called 'smelly.rb'
     When I run rake reek with:
       """
       Reek::Rake::Task.new do |t|
-        t.source_files = 'spec/samples/masked/dirty.rb'
+        t.source_files = 'smelly.rb'
         t.verbose = true
       end
       """
     Then the exit status indicates an error
-    And stdout includes "spec/samples/masked/dirty.rb"
+    And stdout includes "Running 'reek' rake command"
 
   Scenario: fail_on_error can hide the error status
+    Given a smelly file called 'smelly.rb'
     When I run rake reek with:
       """
       Reek::Rake::Task.new do |t|
         t.fail_on_error = false
-        t.source_files = 'spec/samples/no_config_file/dirty.rb'
+        t.source_files = 'smelly.rb'
         t.reek_opts = '--no-color'
       end
       """
@@ -60,21 +64,20 @@ Feature: Reek can be driven through its Task
     And it succeeds
     And it reports:
       """
-      spec/samples/no_config_file/dirty.rb -- 6 warnings:
-        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-        [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-        [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-        [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-        [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+      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: can be configured with config_file
+    Given a smelly file called 'smelly.rb'
+    And a masking configuration file called 'config.reek'
     When I run rake reek with:
       """
       Reek::Rake::Task.new do |t|
-        t.config_file  = 'spec/samples/minimal_smelly_and_masked/config.reek'
-        t.source_files = 'spec/samples/minimal_smelly_and_masked/minimal_dirty.rb'
+        t.config_file  = 'config.reek'
+        t.source_files = 'smelly.rb'
       end
       """
     Then it succeeds

data/features/reports/json.feature

@@ -3,7 +3,8 @@ Feature: Report smells using simple JSON layout
   output a list of smells in JSON.
 
   Scenario: output is empty when there are no smells
-    When I run reek --format json spec/samples/three_clean_files
+    Given a directory called 'clean_files' containing some clean files
+    When I run reek --format json clean_files
     Then it succeeds
     And it reports this JSON:
     """
@@ -11,41 +12,38 @@ Feature: Report smells using simple JSON layout
     """
 
   Scenario: Indicate smells and print them as JSON when using files
-    When I run reek --format json spec/samples/standard_smelly/minimal_dirty.rb
+    Given a smelly file called 'smelly.rb'
+    When I run reek --format json smelly.rb
     Then the exit status indicates smells
     And it reports this JSON:
       """
       [
           {
-              "smell_category": "IrresponsibleModule",
-              "smell_type": "IrresponsibleModule",
-              "source": "spec/samples/standard_smelly/minimal_dirty.rb",
-              "context": "C",
-              "lines": [
-                  1
-              ],
-              "message": "has no descriptive comment",
-              "name": "C"
+              "smell_category": "Duplication",
+              "smell_type": "DuplicateMethodCall",
+              "source": "smelly.rb",
+              "context": "Smelly#m",
+              "lines": [ 4, 5 ],
+              "message": "calls @foo.bar 2 times",
+              "name": "@foo.bar",
+              "count": 2
           },
           {
-              "smell_category": "UncommunicativeName",
-              "smell_type": "UncommunicativeModuleName",
-              "source": "spec/samples/standard_smelly/minimal_dirty.rb",
-              "context": "C",
-              "lines": [
-                  1
-              ],
-              "message": "has the name 'C'",
-              "name": "C"
+              "smell_category": "Duplication",
+              "smell_type": "DuplicateMethodCall",
+              "source": "smelly.rb",
+              "context": "Smelly#m",
+              "lines": [ 4, 5 ],
+              "message": "calls puts(@foo.bar) 2 times",
+              "name": "puts(@foo.bar)",
+              "count": 2
           },
           {
               "smell_category": "UncommunicativeName",
               "smell_type": "UncommunicativeMethodName",
-              "source": "spec/samples/standard_smelly/minimal_dirty.rb",
-              "context": "C#m",
-              "lines": [
-                  2
-              ],
+              "source": "smelly.rb",
+              "context": "Smelly#m",
+              "lines": [ 3 ],
               "message": "has the name 'm'",
               "name": "m"
           }
@@ -61,7 +59,7 @@ Feature: Report smells using simple JSON layout
           {
               "smell_category": "IrresponsibleModule",
               "smell_type": "IrresponsibleModule",
-              "source": "$stdin",
+              "source": "STDIN",
               "context": "Turn",
               "lines": [
                   1