reek 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35357c69cff741c516e6859a55939a19fa860cd5
-  data.tar.gz: d51ca3ff8ae7661304f767e30177b45555789ed9
+  metadata.gz: a55c84d8e8f1583544ec71d2eee88e6009bec7de
+  data.tar.gz: 2293dce903da468f25b4bfb491fe1b60f5e13721
 SHA512:
-  metadata.gz: 47cf34fb7015f78bf8667e16c932068e4eba33b14d12a51c08a34ffd45a2bd4781bbed6f57fcb27e9c2b55a179851873baf4f46ec63cede7041015b4e6999fe3
-  data.tar.gz: 73820da254c9c7f50aa6408442dd0cc04489713d37bc4d44f8d4b8cca1b576a5b00fc37804ef5ecdf702d94be1b729a323adabc31edd23d87744043f3b7c5263
+  metadata.gz: d0083106eb1f3aac9ec626273072670c551c09f42d9624e2497120e9099243c5e8154a90d575b7a9dd0b7505de0787dd4c21218d03702e23dc8dcc904b9553d8
+  data.tar.gz: dc91d3a860e07b2b1edb7c153df02c5e263c145209cf6c577f31cf091eb28da42f489a59a8193de593a98421926f44cf40fb3592bcec5d41afe06f6c73cdd7e5

data/CHANGELOG

@@ -1,3 +1,10 @@
+== 1.3.4
+
+* (apiology) Add --single-line option for reporting
+* (gilles-leblanc) Allow config files to override default config values
+* (gilles-leblanc) Added line numbers by default when you run the reek command
+* (mvz) Support Ruby 2.0 syntax
+
 == 1.3.3
 
 * (bf4) Loosen ruby_parser version dependency

data/features/command_line_interface/options.feature

@@ -39,7 +39,8 @@ Feature: Reek can be controlled using command-line options
 
       Report formatting:
           -q, --[no-]quiet                 Suppress headings for smell-free source files
-          -n, --line-number                Prefix the output with the line number(s).
+          -n, --line-number                Suppress line number(s) from the output.
+          -s, --single-line                Show IDE-compatible single-line-per-warning
           -y, --yaml                       Report smells in YAML format
 
       """

data/features/command_line_interface/smells_count.feature

@@ -9,11 +9,11 @@ Feature: Reports total number of code smells
         And it reports:
         """
         spec/samples/not_quite_masked/dirty.rb -- 5 warnings:
-          Dirty has the variable name '@s' (UncommunicativeVariableName)
-          Dirty#a calls @s.title twice (DuplicateMethodCall)
-          Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-          Dirty#a contains iterators nested 2 deep (NestedIterators)
-          Dirty#a has the name 'a' (UncommunicativeMethodName)
+          [7]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+          [6, 8]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+          [6, 8]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+          [7]:Dirty#a contains iterators nested 2 deep (NestedIterators)
+          [5]:Dirty#a has the name 'a' (UncommunicativeMethodName)
         """
 
     Scenario: Output total number of smells when inspecting multiple files
@@ -22,19 +22,19 @@ Feature: Reports total number of code smells
         And it reports:
         """
         spec/samples/two_smelly_files/dirty_one.rb -- 6 warnings:
-          Dirty has the variable name '@s' (UncommunicativeVariableName)
-          Dirty#a calls @s.title twice (DuplicateMethodCall)
-          Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-          Dirty#a contains iterators nested 2 deep (NestedIterators)
-          Dirty#a has the name 'a' (UncommunicativeMethodName)
-          Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+          [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+          [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+          [4, 6]:Dirty#a calls puts(@s.title) twice (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:
-          Dirty has the variable name '@s' (UncommunicativeVariableName)
-          Dirty#a calls @s.title twice (DuplicateMethodCall)
-          Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-          Dirty#a contains iterators nested 2 deep (NestedIterators)
-          Dirty#a has the name 'a' (UncommunicativeMethodName)
-          Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+          [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+          [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+          [4, 6]:Dirty#a calls puts(@s.title) twice (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
         """
 

data/features/command_line_interface/stdin.feature

@@ -33,9 +33,9 @@ Feature: Reek reads from $stdin when no files are given
     And it reports:
       """
       $stdin -- 3 warnings:
-        Turn has no descriptive comment (IrresponsibleModule)
-        Turn has the variable name '@x' (UncommunicativeVariableName)
-        Turn#y has the name 'y' (UncommunicativeMethodName)
+        [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

@@ -10,12 +10,12 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/empty_config_file/dirty.rb -- 6 warnings:
-        Dirty has the variable name '@s' (UncommunicativeVariableName)
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
-        Dirty#a has the name 'a' (UncommunicativeMethodName)
-        Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (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)
       """
 
   Scenario: corrupt config file prevents normal output
@@ -24,13 +24,13 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/corrupt_config_file/dirty.rb -- 7 warnings:
-        Dirty has no descriptive comment (IrresponsibleModule)
-        Dirty has the variable name '@s' (UncommunicativeVariableName)
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
-        Dirty#a has the name 'a' (UncommunicativeMethodName)
-        Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+        [1]:Dirty has no descriptive comment (IrresponsibleModule)
+        [4]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [3, 5]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [3, 5]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [4]:Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [2]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+        [4]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
       """
     And it reports an error
 
@@ -40,9 +40,9 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 3 warnings:
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
       """
     And it reports the error "Error: No such file - no_such_file.rb"
 
@@ -52,9 +52,9 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 3 warnings:
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
       """
 
   Scenario: non-masked smells are only counted once
@@ -63,11 +63,11 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/not_quite_masked/dirty.rb -- 5 warnings:
-        Dirty has the variable name '@s' (UncommunicativeVariableName)
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
-        Dirty#a has the name 'a' (UncommunicativeMethodName)
+        [7]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [6, 8]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [6, 8]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [7]:Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [5]:Dirty#a has the name 'a' (UncommunicativeMethodName)
       """
 
   @overrides
@@ -77,8 +77,8 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/overrides/masked/dirty.rb -- 2 warnings:
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
       """
 
   Scenario: allow masking some calls for duplication smell
@@ -87,8 +87,8 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/mask_some/dirty.rb -- 2 warnings:
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
       """
 
   @comments
@@ -98,7 +98,7 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/inline_config/dirty.rb -- 1 warning:
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [5, 7]:Dirty#a calls @s.title twice (DuplicateMethodCall)
       """
 
   Scenario: supports a config file
@@ -107,7 +107,7 @@ Feature: Masking smells using config files
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 1 warning:
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
       """
 
   Scenario: supports multiple config files

data/features/configuration_files/overrides_defaults.feature

@@ -0,0 +1,14 @@
+@overrides_defaults
+Feature: Overriding current rules by specifying new configuration values
+  In order to customize Reek to suit my needs
+  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 spec/samples/overrides_defaults/camel_case.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      spec/samples/overrides_defaults/camel_case.rb -- 1 warning:
+        [9]:CamelCase#initialize has the variable name 'x1' (UncommunicativeVariableName)
+      """

data/features/rake_task/rake_task.feature

@@ -14,9 +14,9 @@ Feature: Reek can be driven through its Task
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 3 warnings:
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
       """
 
   Scenario: name changes the task name
@@ -30,9 +30,9 @@ Feature: Reek can be driven through its Task
     And it reports:
       """
       spec/samples/masked/dirty.rb -- 3 warnings:
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
       """
 
   Scenario: verbose prints the reek command
@@ -58,12 +58,12 @@ Feature: Reek can be driven through its Task
     And it reports:
       """
       spec/samples/empty_config_file/dirty.rb -- 6 warnings:
-        Dirty has the variable name '@s' (UncommunicativeVariableName)
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
-        Dirty#a has the name 'a' (UncommunicativeMethodName)
-        Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (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)
       """
 
   Scenario: can be configured with config_files

data/features/reports/reports.feature

@@ -10,19 +10,19 @@ Feature: Correctly formatted reports
     And it reports:
       """
       spec/samples/two_smelly_files/dirty_one.rb -- 6 warnings:
-        Dirty has the variable name '@s' (UncommunicativeVariableName)
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
-        Dirty#a has the name 'a' (UncommunicativeMethodName)
-        Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (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:
-        Dirty has the variable name '@s' (UncommunicativeVariableName)
-        Dirty#a calls @s.title twice (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        Dirty#a contains iterators nested 2 deep (NestedIterators)
-        Dirty#a has the name 'a' (UncommunicativeMethodName)
-        Dirty#a has the variable name 'x' (UncommunicativeVariableName)
+        [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
+        [4, 6]:Dirty#a calls @s.title twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (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
       """
 
@@ -50,7 +50,7 @@ Feature: Correctly formatted reports
   Scenario Outline: --quiet turns off headers for fragrant files
     When I run reek <option> spec/samples/three_clean_files/*.rb
     Then it succeeds
-    And it reports: 
+    And it reports:
     """
     0 total warnings
     """
@@ -62,17 +62,17 @@ Feature: Correctly formatted reports
       | -n -q   |
       | -q -n   |
 
-  Scenario Outline: --line-number turns on line numbers
+  Scenario Outline: --line-number turns off line numbers
     When I run reek <option> 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:
-        [7]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-        [6, 8]:Dirty#a calls @s.title twice (DuplicateMethodCall)
-        [6, 8]:Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
-        [7]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-        [5]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+        Dirty has the variable name '@s' (UncommunicativeVariableName)
+        Dirty#a calls @s.title twice (DuplicateMethodCall)
+        Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        Dirty#a contains iterators nested 2 deep (NestedIterators)
+        Dirty#a has the name 'a' (UncommunicativeMethodName)
       """
 
     Examples:
@@ -81,3 +81,50 @@ Feature: Correctly formatted reports
       | --line-number |
       | -n -q         |
       | -q -n         |
+
+  Scenario Outline: --single-line shows filename and one line number
+    When I run reek <option> 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:
+        spec/samples/not_quite_masked/dirty.rb:7: Dirty has the variable name '@s' (UncommunicativeVariableName)
+        spec/samples/not_quite_masked/dirty.rb:6: Dirty#a calls @s.title twice (DuplicateMethodCall)
+        spec/samples/not_quite_masked/dirty.rb:6: Dirty#a calls puts(@s.title) twice (DuplicateMethodCall)
+        spec/samples/not_quite_masked/dirty.rb:7: Dirty#a contains iterators nested 2 deep (NestedIterators)
+        spec/samples/not_quite_masked/dirty.rb:5: Dirty#a has the name 'a' (UncommunicativeMethodName)
+      """
+
+    Examples:
+      | option        |
+      | -s            |
+      | --single-line |
+      | -s -q         |
+      | -q -s         |
+
+  Scenario Outline: Extra slashes aren't added to directory names
+    When I run reek <args>
+    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 twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (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 twice (DuplicateMethodCall)
+        [4, 6]:Dirty#a calls puts(@s.title) twice (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
+      """
+
+    Examples:
+      | args |
+      | spec/samples/two_smelly_files/ |
+      | spec/samples/two_smelly_files  |

data/features/ruby_api/api.feature

@@ -10,14 +10,14 @@ Feature: The Reek API maintains backwards compatibility
     And it reports:
       """
       spec/samples/demo/demo.rb -- 10 warnings:
-        Dirty has no descriptive comment (IrresponsibleModule)
-        Dirty#awful has 4 parameters (LongParameterList)
-        Dirty#awful has boolean parameter 'log' (BooleanParameter)
-        Dirty#awful has the parameter name 'x' (UncommunicativeParameterName)
-        Dirty#awful has the parameter name 'y' (UncommunicativeParameterName)
-        Dirty#awful has the variable name 'w' (UncommunicativeVariableName)
-        Dirty#awful has unused parameter 'log' (UnusedParameters)
-        Dirty#awful has unused parameter 'offset' (UnusedParameters)
-        Dirty#awful has unused parameter 'x' (UnusedParameters)
-        Dirty#awful has unused parameter 'y' (UnusedParameters)
+        [1]:Dirty has no descriptive comment (IrresponsibleModule)
+        [3]:Dirty#awful has 4 parameters (LongParameterList)
+        [3]:Dirty#awful has boolean parameter 'log' (BooleanParameter)
+        [3]:Dirty#awful has the parameter name 'x' (UncommunicativeParameterName)
+        [3]:Dirty#awful has the parameter name 'y' (UncommunicativeParameterName)
+        [5]:Dirty#awful has the variable name 'w' (UncommunicativeVariableName)
+        [3]:Dirty#awful has unused parameter 'log' (UnusedParameters)
+        [3]:Dirty#awful has unused parameter 'offset' (UnusedParameters)
+        [3]:Dirty#awful has unused parameter 'x' (UnusedParameters)
+        [3]:Dirty#awful has unused parameter 'y' (UnusedParameters)
       """

data/features/samples.feature

@@ -6,7 +6,7 @@ Feature: Basic smell detection
 
   @inline
   Scenario: Correct smells from inline.rb
-    When I run reek spec/samples/inline.rb
+    When I run reek -n spec/samples/inline.rb
     Then the exit status indicates smells
     And it reports:
     """
@@ -54,7 +54,7 @@ Feature: Basic smell detection
     """
 
   Scenario: Correct smells from optparse.rb
-    When I run reek spec/samples/optparse.rb
+    When I run reek -n spec/samples/optparse.rb
     Then the exit status indicates smells
     And it reports:
     """
@@ -171,7 +171,7 @@ Feature: Basic smell detection
     """
 
   Scenario: Correct smells from redcloth.rb
-    When I run reek spec/samples/redcloth.rb
+    When I run reek -n spec/samples/redcloth.rb
     Then the exit status indicates smells
     And it reports:
     """
@@ -278,3 +278,13 @@ Feature: Basic smell detection
       RedCloth#textile_popup_help has the parameter name 'windowW' (UncommunicativeParameterName)
       RedCloth#to_html has approx 24 statements (TooManyStatements)
     """
+
+  Scenario: Correct smells from a source file with Ruby 2.0 specific syntax
+    When I run reek spec/samples/ruby20_syntax.rb
+    Then the exit status indicates smells
+    And it reports:
+    """
+    spec/samples/ruby20_syntax.rb -- 2 warnings:
+      [1]:SomeClass has no descriptive comment (IrresponsibleModule)
+      [2]:SomeClass#method_with_keyword_arguments has unused parameter 'foo' (UnusedParameters)
+    """

data/lib/reek/cli/command_line.rb

@@ -18,7 +18,7 @@ module Reek
         @argv = argv
         @parser = OptionParser.new
         @report_class = VerboseReport
-        @warning_formatter = SimpleWarningFormatter
+        @warning_formatter = WarningFormatterWithLineNumbers
         @command_class = ReekCommand
         @config_files = []
         set_options
@@ -75,9 +75,12 @@ EOB
         @parser.on("-q", "--[no-]quiet", "Suppress headings for smell-free source files") do |opt|
           @report_class = opt ? QuietReport : VerboseReport
         end
-        @parser.on("-n", "--line-number", "Prefix the output with the line number(s).") do 
-          @warning_formatter = WarningFormatterWithLineNumbers
+        @parser.on("-n", "--line-number", "Suppress line number(s) from the output.") do 
+          @warning_formatter = SimpleWarningFormatter
         end
+        @parser.on("-s", "--single-line", "Show IDE-compatible single-line-per-warning") do 
+          @warning_formatter = SingleLineWarningFormatter
+        end        
         @parser.on("-y", "--yaml", "Report smells in YAML format") do
           @command_class = YamlCommand
           # SMELL: the args passed to the command should be tested, because it may

data/lib/reek/cli/report.rb

@@ -27,6 +27,12 @@ module Reek
       end
     end
 
+    module SingleLineWarningFormatter
+      def self.format(warning)
+        "#{warning.source}:#{warning.lines.first}: #{SimpleWarningFormatter.format(warning)}"
+      end
+    end    
+
     #
     # A report that lists every source, including those that have no smells.
     #

data/lib/reek/core/smell_configuration.rb

@@ -18,8 +18,8 @@ module Reek
         @options = hash
       end
 
-      def adopt!(options)
-        @options.adopt!(options)
+      def merge!(options)
+        @options.merge!(options)
       end
 
       #

data/lib/reek/smells/smell_detector.rb

@@ -57,7 +57,7 @@ module Reek
       end
 
       def configure_with(config)
-        @config.adopt!(config)
+        @config.merge!(config)
       end
 
       def examine(context)

data/lib/reek/source/source_locator.rb

@@ -8,7 +8,7 @@ module Reek
     #
     class SourceLocator
       def initialize(paths)
-        @paths = paths
+        @paths = paths.map {|path| path.chomp('/') }
       end
 
       def all_sources

data/lib/reek/source/tree_dresser.rb

@@ -18,7 +18,7 @@ module Reek
       end
 
       def is_language_node?
-        first.class == Symbol
+        Symbol === first
       end
 
       def has_type?(type)
@@ -48,12 +48,13 @@ module Reek
         end
         blk.call(self) if first == target_type
       end
+
       def format_ruby
-        return self[0].to_s unless Array === self
         Ruby2Ruby.new.process(deep_copy)
       end
+
       def deep_copy
-        Sexp.from_array(YAML::load(YAML::dump(self)))
+        Sexp.new(*map { |elem| Sexp === elem ? elem.deep_copy : elem })
       end
     end
 

data/lib/reek/version.rb

@@ -1,3 +1,3 @@
 module Reek
-  VERSION = '1.3.3'
+  VERSION = '1.3.4'
 end

data/reek.gemspec

@@ -26,7 +26,7 @@ and reports any code smells it finds.
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Code smell detector for Ruby}
 
-  s.add_runtime_dependency(%q<ruby_parser>, [">= 3.1.1", "~> 3.1"])
+  s.add_runtime_dependency(%q<ruby_parser>, ["~> 3.2"])
   s.add_runtime_dependency(%q<sexp_processor>)
   s.add_runtime_dependency(%q<ruby2ruby>, ["~> 2.0.2"])
 

data/spec/reek/core/smell_configuration_spec.rb

@@ -8,4 +8,40 @@ describe SmellConfiguration do
     cf = SmellConfiguration.new({})
     cf.value('fred', nil, 27).should == 27
   end
+
+  context 'when overriding default configs' do
+    before(:each) do
+      @base_config = {"enabled"=>true, "exclude"=>[],
+                      "reject"=>[/^.$/, /[0-9]$/, /[A-Z]/],
+                      "accept"=>["_"]}
+      @smell_config = SmellConfiguration.new(@base_config)
+    end
+
+    it { @smell_config.merge!({}).should == @base_config }
+    it { @smell_config.merge!({"enabled"=>true}).should == @base_config }
+    it { @smell_config.merge!({"exclude"=>[]}).should == @base_config }
+    it { @smell_config.merge!({"accept"=>["_"]}).should == @base_config }
+    it { @smell_config.merge!({"reject"=>[/^.$/, /[0-9]$/, /[A-Z]/]}).should == @base_config }
+    it { @smell_config.merge!({"enabled"=>true, "accept"=>["_"]}).should == @base_config }
+
+    it 'should override single values' do
+      @smell_config.merge!({"enabled"=>false}).should == {"enabled"=>false, "exclude"=>[],
+                                                          "reject"=>[/^.$/, /[0-9]$/, /[A-Z]/],
+                                                          "accept"=>["_"]}
+    end
+
+    it 'should override arrays of values' do
+      @smell_config.merge!({"reject"=>[/^.$/, /[3-9]$/]}).should == {"enabled"=>true,
+                                                          "exclude"=>[],
+                                                          "reject"=>[/^.$/, /[3-9]$/],
+                                                          "accept"=>["_"]}
+    end
+
+    it 'should override multiple values' do
+      @smell_config.merge!({"enabled"=>false, "accept"=>[/[A-Z]$/]}).should ==
+                           {"enabled"=>false, "exclude"=>[],
+                            "reject"=>[/^.$/, /[0-9]$/, /[A-Z]/],
+                            "accept"=>[/[A-Z]$/]}
+    end
+  end
 end

data/spec/samples/overrides_defaults/camel_case.rb

@@ -0,0 +1,14 @@
+# Class containing camelCase variable which would normally smell
+class CamelCase
+  def initialize
+    # These next two would normally smell if it weren't for overridden config values
+    camelCaseVariable = []
+    anotherOne = 1
+
+    # this next one should still smell
+    x1 = 0
+
+    # this next one should not smell
+    should_not_smell = true
+  end
+end

data/spec/samples/overrides_defaults/config.reek

@@ -0,0 +1,6 @@
+---
+UncommunicativeVariableName:
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/

data/spec/samples/ruby20_syntax.rb

@@ -0,0 +1,17 @@
+class SomeClass
+  def method_with_keyword_arguments(foo: '123')
+    if foo == '123'
+      bar
+    else
+      baz
+    end
+  end
+
+  def make_symbol_list
+    %i(foo bar baz)
+  end
+
+  def make_other_symbol_list
+    %I(foo bar baz)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,28 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.1.1
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 3.1.1
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: sexp_processor
   requirement: !ruby/object:Gem::Requirement
@@ -163,180 +157,184 @@ files:
 - Rakefile
 - bin/reek
 - config/defaults.reek
-- features/ruby_api/api.feature
-- features/command_line_interface/smells_count.feature
-- features/command_line_interface/stdin.feature
-- features/command_line_interface/options.feature
-- features/step_definitions/reek_steps.rb
 - features/support/env.rb
+- features/configuration_files/masking_smells.feature
+- features/configuration_files/overrides_defaults.feature
 - features/samples.feature
-- features/reports/reports.feature
 - features/reports/yaml.feature
-- features/configuration_files/masking_smells.feature
+- features/reports/reports.feature
+- features/command_line_interface/options.feature
+- features/command_line_interface/smells_count.feature
+- features/command_line_interface/stdin.feature
+- features/step_definitions/reek_steps.rb
 - features/rake_task/rake_task.feature
-- lib/reek.rb
-- lib/reek/spec.rb
+- features/ruby_api/api.feature
 - lib/reek/spec/should_reek_of.rb
 - lib/reek/spec/should_reek_only_of.rb
 - lib/reek/spec/should_reek.rb
+- lib/reek/source/source_code.rb
+- lib/reek/source/code_comment.rb
+- lib/reek/source/source_file.rb
+- lib/reek/source/config_file.rb
+- lib/reek/source/tree_dresser.rb
+- lib/reek/source/source_locator.rb
+- lib/reek/source/reference_collector.rb
+- lib/reek/source/sexp_formatter.rb
+- lib/reek/source/core_extras.rb
+- lib/reek/source/source_repository.rb
+- lib/reek/core/object_refs.rb
+- lib/reek/core/module_context.rb
+- lib/reek/core/smell_repository.rb
+- lib/reek/core/warning_collector.rb
+- lib/reek/core/method_context.rb
+- lib/reek/core/code_parser.rb
+- lib/reek/core/hash_extensions.rb
+- lib/reek/core/stop_context.rb
+- lib/reek/core/singleton_method_context.rb
+- lib/reek/core/code_context.rb
+- lib/reek/core/sniffer.rb
+- lib/reek/core/smell_configuration.rb
+- lib/reek/spec.rb
+- lib/reek/source.rb
+- lib/reek/examiner.rb
+- lib/reek/rake/task.rb
+- lib/reek/smells.rb
+- lib/reek/version.rb
 - lib/reek/cli/version_command.rb
 - lib/reek/cli/application.rb
-- lib/reek/cli/command_line.rb
-- lib/reek/cli/yaml_command.rb
-- lib/reek/cli/help_command.rb
 - lib/reek/cli/report.rb
 - lib/reek/cli/reek_command.rb
-- lib/reek/examiner.rb
-- lib/reek/rake/task.rb
-- lib/reek/smell_warning.rb
-- lib/reek/version.rb
-- lib/reek/smells/boolean_parameter.rb
-- lib/reek/smells/uncommunicative_parameter_name.rb
-- lib/reek/smells/unused_parameters.rb
+- lib/reek/cli/yaml_command.rb
+- lib/reek/cli/command_line.rb
+- lib/reek/cli/help_command.rb
+- lib/reek/smells/irresponsible_module.rb
 - lib/reek/smells/long_yield_list.rb
-- lib/reek/smells/attribute.rb
+- lib/reek/smells/nested_iterators.rb
 - lib/reek/smells/uncommunicative_method_name.rb
-- lib/reek/smells/repeated_conditional.rb
-- lib/reek/smells/nil_check.rb
+- lib/reek/smells/boolean_parameter.rb
 - lib/reek/smells/class_variable.rb
-- lib/reek/smells/long_parameter_list.rb
-- lib/reek/smells/feature_envy.rb
-- lib/reek/smells/irresponsible_module.rb
+- lib/reek/smells/control_parameter.rb
 - lib/reek/smells/utility_function.rb
-- lib/reek/smells/data_clump.rb
+- lib/reek/smells/too_many_instance_variables.rb
 - lib/reek/smells/too_many_methods.rb
-- lib/reek/smells/uncommunicative_variable_name.rb
+- lib/reek/smells/long_parameter_list.rb
+- lib/reek/smells/nil_check.rb
+- lib/reek/smells/attribute.rb
 - lib/reek/smells/uncommunicative_module_name.rb
-- lib/reek/smells/nested_iterators.rb
-- lib/reek/smells/control_parameter.rb
-- lib/reek/smells/too_many_instance_variables.rb
+- lib/reek/smells/repeated_conditional.rb
+- lib/reek/smells/uncommunicative_parameter_name.rb
 - lib/reek/smells/smell_detector.rb
-- lib/reek/smells/duplicate_method_call.rb
+- lib/reek/smells/feature_envy.rb
 - lib/reek/smells/too_many_statements.rb
-- lib/reek/smells.rb
-- lib/reek/source/config_file.rb
-- lib/reek/source/source_code.rb
-- lib/reek/source/sexp_formatter.rb
-- lib/reek/source/source_repository.rb
-- lib/reek/source/reference_collector.rb
-- lib/reek/source/core_extras.rb
-- lib/reek/source/source_file.rb
-- lib/reek/source/code_comment.rb
-- lib/reek/source/source_locator.rb
-- lib/reek/source/tree_dresser.rb
-- lib/reek/source.rb
-- lib/reek/core/smell_configuration.rb
-- lib/reek/core/method_context.rb
-- lib/reek/core/code_parser.rb
-- lib/reek/core/module_context.rb
-- lib/reek/core/stop_context.rb
-- lib/reek/core/code_context.rb
-- lib/reek/core/sniffer.rb
-- lib/reek/core/hash_extensions.rb
-- lib/reek/core/smell_repository.rb
-- lib/reek/core/object_refs.rb
-- lib/reek/core/singleton_method_context.rb
-- lib/reek/core/warning_collector.rb
-- spec/matchers/smell_of_matcher.rb
-- spec/spec_helper.rb
+- lib/reek/smells/uncommunicative_variable_name.rb
+- lib/reek/smells/unused_parameters.rb
+- lib/reek/smells/duplicate_method_call.rb
+- lib/reek/smells/data_clump.rb
+- lib/reek/smell_warning.rb
+- lib/reek.rb
+- spec/gem/yard_spec.rb
+- spec/gem/updates_spec.rb
 - spec/reek/spec/should_reek_of_spec.rb
-- spec/reek/spec/should_reek_spec.rb
 - spec/reek/spec/should_reek_only_of_spec.rb
+- spec/reek/spec/should_reek_spec.rb
+- spec/reek/source/object_source_spec.rb
+- spec/reek/source/reference_collector_spec.rb
+- spec/reek/source/code_comment_spec.rb
+- spec/reek/source/source_code_spec.rb
+- spec/reek/source/sexp_formatter_spec.rb
+- spec/reek/source/tree_dresser_spec.rb
+- spec/reek/core/module_context_spec.rb
+- spec/reek/core/singleton_method_context_spec.rb
+- spec/reek/core/code_parser_spec.rb
+- spec/reek/core/code_context_spec.rb
+- spec/reek/core/warning_collector_spec.rb
+- spec/reek/core/object_refs_spec.rb
+- spec/reek/core/smell_configuration_spec.rb
+- spec/reek/core/stop_context_spec.rb
+- spec/reek/core/config_spec.rb
+- spec/reek/core/method_context_spec.rb
+- spec/reek/smell_warning_spec.rb
 - spec/reek/examiner_spec.rb
-- spec/reek/cli/help_command_spec.rb
-- spec/reek/cli/reek_command_spec.rb
 - spec/reek/cli/yaml_command_spec.rb
+- spec/reek/cli/reek_command_spec.rb
+- spec/reek/cli/help_command_spec.rb
 - spec/reek/cli/report_spec.rb
 - spec/reek/cli/version_command_spec.rb
-- spec/reek/smells/boolean_parameter_spec.rb
-- spec/reek/smells/uncommunicative_method_name_spec.rb
-- spec/reek/smells/uncommunicative_module_name_spec.rb
-- spec/reek/smells/too_many_statements_spec.rb
-- spec/reek/smells/class_variable_spec.rb
-- spec/reek/smells/long_yield_list_spec.rb
-- spec/reek/smells/control_parameter_spec.rb
 - spec/reek/smells/unused_parameters_spec.rb
-- spec/reek/smells/uncommunicative_parameter_name_spec.rb
+- spec/reek/smells/irresponsible_module_spec.rb
+- spec/reek/smells/too_many_methods_spec.rb
+- spec/reek/smells/too_many_statements_spec.rb
+- spec/reek/smells/uncommunicative_module_name_spec.rb
+- spec/reek/smells/utility_function_spec.rb
 - spec/reek/smells/long_parameter_list_spec.rb
+- spec/reek/smells/control_parameter_spec.rb
+- spec/reek/smells/behaves_like_variable_detector.rb
+- spec/reek/smells/class_variable_spec.rb
 - spec/reek/smells/attribute_spec.rb
+- spec/reek/smells/uncommunicative_variable_name_spec.rb
 - spec/reek/smells/data_clump_spec.rb
+- spec/reek/smells/uncommunicative_parameter_name_spec.rb
 - spec/reek/smells/feature_envy_spec.rb
 - spec/reek/smells/smell_detector_shared.rb
-- spec/reek/smells/utility_function_spec.rb
+- spec/reek/smells/nil_check_spec.rb
+- spec/reek/smells/repeated_conditional_spec.rb
+- spec/reek/smells/uncommunicative_method_name_spec.rb
 - spec/reek/smells/nested_iterators_spec.rb
+- spec/reek/smells/long_yield_list_spec.rb
 - spec/reek/smells/duplicate_method_call_spec.rb
+- spec/reek/smells/boolean_parameter_spec.rb
 - spec/reek/smells/too_many_instance_variables_spec.rb
-- spec/reek/smells/too_many_methods_spec.rb
-- spec/reek/smells/behaves_like_variable_detector.rb
-- spec/reek/smells/repeated_conditional_spec.rb
-- spec/reek/smells/nil_check_spec.rb
-- spec/reek/smells/irresponsible_module_spec.rb
-- spec/reek/smells/uncommunicative_variable_name_spec.rb
-- spec/reek/smell_warning_spec.rb
-- spec/reek/source/reference_collector_spec.rb
-- spec/reek/source/tree_dresser_spec.rb
-- spec/reek/source/sexp_formatter_spec.rb
-- spec/reek/source/code_comment_spec.rb
-- spec/reek/source/object_source_spec.rb
-- spec/reek/source/source_code_spec.rb
-- spec/reek/core/object_refs_spec.rb
-- spec/reek/core/warning_collector_spec.rb
-- spec/reek/core/stop_context_spec.rb
-- spec/reek/core/config_spec.rb
-- spec/reek/core/code_parser_spec.rb
-- spec/reek/core/smell_configuration_spec.rb
-- spec/reek/core/module_context_spec.rb
-- spec/reek/core/method_context_spec.rb
-- spec/reek/core/code_context_spec.rb
-- spec/reek/core/singleton_method_context_spec.rb
-- spec/gem/updates_spec.rb
-- spec/gem/yard_spec.rb
-- spec/samples/three_clean_files/clean_one.rb
+- spec/spec_helper.rb
+- spec/samples/inline_config/dirty.rb
+- spec/samples/inline_config/masked.reek
 - spec/samples/three_clean_files/clean_two.rb
 - spec/samples/three_clean_files/clean_three.rb
-- spec/samples/config/allow_duplication.reek
-- spec/samples/config/deeper_nested_iterators.reek
-- spec/samples/overrides/upper.reek
-- spec/samples/overrides/masked/dirty.rb
-- spec/samples/overrides/masked/lower.reek
-- spec/samples/masked_by_dotfile/dirty.rb
+- spec/samples/three_clean_files/clean_one.rb
+- spec/samples/clean_due_to_masking/dirty_one.rb
+- spec/samples/clean_due_to_masking/masked.reek
+- spec/samples/clean_due_to_masking/clean_two.rb
+- spec/samples/clean_due_to_masking/dirty_two.rb
+- spec/samples/clean_due_to_masking/clean_three.rb
+- spec/samples/clean_due_to_masking/clean_one.rb
+- spec/samples/not_quite_masked/dirty.rb
+- spec/samples/not_quite_masked/masked.reek
+- spec/samples/not_quite_masked/smelly.rb
+- spec/samples/optparse.rb
+- spec/samples/all_but_one_masked/dirty.rb
+- spec/samples/all_but_one_masked/masked.reek
+- spec/samples/all_but_one_masked/clean_one.rb
 - spec/samples/demo/demo.rb
+- spec/samples/exceptions.reek
+- spec/samples/masked_by_dotfile/dirty.rb
+- spec/samples/inline.rb
 - spec/samples/redcloth.rb
-- spec/samples/inline_config/masked.reek
-- spec/samples/inline_config/dirty.rb
-- spec/samples/corrupt_config_file/corrupt.reek
+- spec/samples/overrides/masked/dirty.rb
+- spec/samples/overrides/masked/lower.reek
+- spec/samples/overrides/upper.reek
+- spec/samples/two_smelly_files/dirty_one.rb
+- spec/samples/two_smelly_files/dirty_two.rb
+- spec/samples/masked/dirty.rb
+- spec/samples/masked/masked.reek
+- spec/samples/config/deeper_nested_iterators.reek
+- spec/samples/config/allow_duplication.reek
+- spec/samples/ruby20_syntax.rb
+- spec/samples/overrides_defaults/camel_case.rb
+- spec/samples/overrides_defaults/config.reek
 - spec/samples/corrupt_config_file/dirty.rb
+- spec/samples/corrupt_config_file/corrupt.reek
 - spec/samples/empty_config_file/dirty.rb
 - spec/samples/empty_config_file/empty.reek
-- spec/samples/masked/masked.reek
-- spec/samples/masked/dirty.rb
-- spec/samples/all_but_one_masked/masked.reek
-- spec/samples/all_but_one_masked/clean_one.rb
-- spec/samples/all_but_one_masked/dirty.rb
-- spec/samples/inline.rb
-- spec/samples/mask_some/dirty.rb
-- spec/samples/mask_some/some.reek
-- spec/samples/not_quite_masked/masked.reek
-- spec/samples/not_quite_masked/dirty.rb
-- spec/samples/not_quite_masked/smelly.rb
-- spec/samples/exceptions.reek
-- spec/samples/mixed_results/dirty_two.rb
 - spec/samples/mixed_results/dirty_one.rb
-- spec/samples/mixed_results/clean_one.rb
 - spec/samples/mixed_results/clean_two.rb
+- spec/samples/mixed_results/dirty_two.rb
 - spec/samples/mixed_results/clean_three.rb
-- spec/samples/clean_due_to_masking/dirty_two.rb
-- spec/samples/clean_due_to_masking/masked.reek
-- spec/samples/clean_due_to_masking/dirty_one.rb
-- spec/samples/clean_due_to_masking/clean_one.rb
-- spec/samples/clean_due_to_masking/clean_two.rb
-- spec/samples/clean_due_to_masking/clean_three.rb
-- spec/samples/optparse.rb
-- spec/samples/two_smelly_files/dirty_two.rb
-- spec/samples/two_smelly_files/dirty_one.rb
+- spec/samples/mixed_results/clean_one.rb
+- spec/samples/mask_some/dirty.rb
+- spec/samples/mask_some/some.reek
+- spec/matchers/smell_of_matcher.rb
 - tasks/test.rake
-- tasks/reek.rake
 - tasks/develop.rake
+- tasks/reek.rake
 - reek.gemspec
 homepage: http://wiki.github.com/troessner/reek
 licenses: []
@@ -359,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: reek
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby