reek 1.3.1 → 1.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a338252f57ae1f1a0a900faf8d0e90bde20545b
+  data.tar.gz: b3a5757e5b1bd95b40981258c2b32ef356488004
+SHA512:
+  metadata.gz: 79b07042b5798fb49fbeeaf3de39785345ddc6b7d9ce219a588f213136063be2e242f687ed70e1ac7cde9a378186f52899ad38b69ce6d704493cf22d183e524a
+  data.tar.gz: e79e4e27c15f357b7cfbd6001e9ec0ceaec237c3ccfc896da902aea1825f561365a75c01ed194948460a222aadebc0de928f8a9b3e07e9d28bdd5565265da604

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 1.3.2
+
+* (mvz) Allow duplicate calls to variable-like methods
+* (mvz) Improve NestedIterators smell detector
+* (mvz) Make combination of -n and -q options work
+
 == 1.3.1
 
 * (EmilRehnberg) Added smell for nil checks

data/README.md

@@ -1,6 +1,10 @@
 # Reek -- code smell detection for Ruby
 
+##Overview
+
 [![Build Status](https://secure.travis-ci.org/troessner/reek.png?branch=master)](http://travis-ci.org/troessner/reek?branch=master)
+[![Gem Version](https://badge.fury.io/rb/reek.png)](http://badge.fury.io/rb/reek)
+
 
 Reek is a tool that examines Ruby classes, modules and methods and
 reports any code smells it finds. Install it like this:
@@ -15,8 +19,8 @@ and run it like this:
 $ reek [options] [dir_or_source_file]*
 ```
 
-For a full list of command-line options see the Reek
-wiki[http://wiki.github.com/troessner/reek/command-line-options]
+For a full list of command-line options see the
+[Reek wiki](https://github.com/troessner/reek/wiki/command-line-options)
 or run
 
 ```bash
@@ -56,7 +60,7 @@ spec/samples/demo/demo.rb -- 6 warnings:
 Reek currently includes checks for some aspects of Control Couple,
 Data Clump, Feature Envy, Large Class, Long Method, Long Parameter List,
 Simulated Polymorphism, Uncommunicative Name and more.
-See the [Reek wiki](http://wiki.github.com/troessner/reek/code-smells)
+See the [Reek wiki](https://github.com/troessner/reek/wiki/code-smells)
 for up to date details of exactly what Reek will check in your code.
 
 ### Integration
@@ -72,7 +76,6 @@ require 'rubygems'
 require 'spec'
 require 'reek'
 require 'reek/spec'
-require 'reek/spec'
 
 include Reek::Spec
 
@@ -97,7 +100,11 @@ spec spec/your/file -l 23  # Runs test in line 23
 spec spec/your/file -u     # Runs all tests stopping at the breakpoints you have set before with `debugger`
 ```
 
-### Tool Integration
+## Miscellaneous
+
+### Tools
+
+There's a vim plugin for `reek`: [https://github.com/rainerborene/vim-reek](https://github.com/rainerborene/vim-reek)
 
 ### Dependencies
 
@@ -107,12 +114,11 @@ Reek makes use of the following other gems:
 * sexp_processor
 * ruby2ruby
 
-Learn More
-----------
+### Learn More
 
 Find out more about Reek from any of the following sources:
 
-* Browse the Reek documentation at [http://wiki.github.com/troessner/reek](http://wiki.github.com/troessner/reek)
-* Browse the code or install the latest development version from [http://github.com/troessner/reek/tree](http://github.com/troessner/reek/tree)
+* Browse the Reek documentation at [https://github.com/troessner/reek/wiki](https://github.com/troessner/reek/wiki)
+* Browse the code or install the latest development version from [https://github.com/troessner/reek/tree](https://github.com/troessner/reek/tree)
 * Read the code API at [http://rdoc.info/projects/troessner/reek](http://rdoc.info/projects/troessner/reek)
 

data/bin/reek

@@ -6,6 +6,6 @@
 # Author: Kevin Rutherford
 #
 
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'lib', 'reek', 'cli', 'application')
+require 'reek/cli/application'
 
 exit Reek::Cli::Application.new(ARGV).execute

data/config/defaults.reek

@@ -1,120 +1,105 @@
---- 
-UncommunicativeParameterName: 
-  accept: []
-
+---
+Attribute:
+  enabled: false
   exclude: []
-
+BooleanParameter:
   enabled: true
-  reject: 
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-LargeClass: 
-  max_methods: 25
   exclude: []
-
+ClassVariable:
   enabled: true
-  max_instance_variables: 9
-UncommunicativeMethodName: 
-  accept: []
-
   exclude: []
-
+ControlParameter:
   enabled: true
-  reject: 
-  - !ruby/regexp /^[a-z]$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-LongParameterList: 
-  max_params: 3
   exclude: []
-
+DataClump:
   enabled: true
-  overrides: 
-    initialize: 
-      max_params: 5
-FeatureEnvy: 
-  exclude: &id001 []
-
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
   enabled: true
-ClassVariable: 
-  exclude: *id001
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
   enabled: true
-BooleanParameter: 
-  exclude: *id001
+  exclude: []
+IrresponsibleModule:
   enabled: true
-IrresponsibleModule: 
-  exclude: *id001
+  exclude: []
+LongParameterList:
   enabled: true
-UncommunicativeModuleName: 
-  accept: 
-  - Inline::C
   exclude: []
-
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 5
+LongYieldList:
   enabled: true
-  reject: 
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-NestedIterators: 
-  ignore_iterators: []
-
   exclude: []
-
+  max_params: 3
+NestedIterators:
   enabled: true
+  exclude: []
   max_allowed_nesting: 1
-LongMethod: 
-  max_statements: 5
-  exclude: 
-  - initialize
+  ignore_iterators: []
+NilCheck:
   enabled: true
-Duplication: 
-  allow_calls: []
-
   exclude: []
-
+RepeatedConditional:
   enabled: true
-  max_calls: 1
-UtilityFunction: 
-  max_helper_calls: 1
   exclude: []
-
+  max_ifs: 2
+TooManyInstanceVariables:
   enabled: true
-Attribute: 
   exclude: []
-
-  enabled: false
-UncommunicativeVariableName: 
-  accept: []
-
+  max_instance_variables: 9
+TooManyMethods:
+  enabled: true
   exclude: []
-
+  max_methods: 25
+TooManyStatements:
   enabled: true
-  reject: 
-  - !ruby/regexp /^.$/
+  exclude:
+  - initialize
+  max_statements: 5
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
-SimulatedPolymorphism: 
-  exclude: []
-
+  accept: []
+UncommunicativeModuleName:
   enabled: true
-  max_ifs: 2
-DataClump: 
   exclude: []
-
-  enabled: true
-  max_copies: 2
-  min_clump_size: 2
-ControlCouple: 
-  exclude: *id001
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept:
+  - Inline::C
+UncommunicativeParameterName:
   enabled: true
-LongYieldList: 
-  max_params: 3
   exclude: []
-
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
   enabled: true
-UnusedParameters: 
-  exclude: *id001
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept:
+  - _
+UnusedParameters:
   enabled: true
-NilCheck:
-  exclude: *id001
+  exclude: []
+UtilityFunction:
   enabled: true
+  exclude: []
+  max_helper_calls: 1

data/features/command_line_interface/options.feature

@@ -43,18 +43,3 @@ Feature: Reek can be controlled using command-line options
           -y, --yaml                       Report smells in YAML format
 
       """
-
-  Scenario: output line numbers if -n flag is passed
-    When I run reek -n spec/samples/not_quite_masked/dirty.rb
-    Then the exit status indicates smells
-    And it should indicate the line numbers of those 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)
-
-      """

data/features/reports/reports.feature

@@ -56,3 +56,26 @@ Feature: Correctly formatted reports
       | option  |
       | -q      |
       | --quiet |
+      | -n -q   |
+      | -q -n   |
+
+  Scenario Outline: --line-number turns on 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)
+
+      """
+
+    Examples:
+      | option        |
+      | -n            |
+      | --line-number |
+      | -n -q         |
+      | -q -n         |

data/features/samples.feature

@@ -10,7 +10,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/inline.rb -- 42 warnings:
+    spec/samples/inline.rb -- 40 warnings:
       File has no descriptive comment (IrresponsibleModule)
       Inline declares the class variable @@directory (ClassVariable)
       Inline declares the class variable @@rootdir (ClassVariable)
@@ -28,7 +28,6 @@ Feature: Basic smell detection
       Inline::C#build calls io.puts 6 times (DuplicateMethodCall)
       Inline::C#build calls io.puts("#endif") twice (DuplicateMethodCall)
       Inline::C#build calls io.puts("#ifdef __cplusplus") twice (DuplicateMethodCall)
-      Inline::C#build calls module_name twice (DuplicateMethodCall)
       Inline::C#build calls warn("Output:\n#{result}") twice (DuplicateMethodCall)
       Inline::C#build contains iterators nested 2 deep (NestedIterators)
       Inline::C#build has approx 60 statements (TooManyStatements)
@@ -41,7 +40,6 @@ Feature: Basic smell detection
       Inline::C#generate calls signature["args"].map twice (DuplicateMethodCall)
       Inline::C#generate has approx 32 statements (TooManyStatements)
       Inline::C#initialize calls stack.empty? twice (DuplicateMethodCall)
-      Inline::C#load calls so_name twice (DuplicateMethodCall)
       Inline::C#module_name has the variable name 'm' (UncommunicativeVariableName)
       Inline::C#module_name has the variable name 'x' (UncommunicativeVariableName)
       Inline::C#parse_signature has approx 15 statements (TooManyStatements)
@@ -61,7 +59,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/optparse.rb -- 115 warnings:
+    spec/samples/optparse.rb -- 109 warnings:
       OptionParser has at least 42 methods (TooManyMethods)
       OptionParser has the variable name 'f' (UncommunicativeVariableName)
       OptionParser has the variable name 'k' (UncommunicativeVariableName)
@@ -90,7 +88,6 @@ Feature: Basic smell detection
       OptionParser#make_switch calls q.downcase 3 times (DuplicateMethodCall)
       OptionParser#make_switch calls search(:atype, FalseClass) twice (DuplicateMethodCall)
       OptionParser#make_switch calls search(:atype, o) 6 times (DuplicateMethodCall)
-      OptionParser#make_switch contains iterators nested 2 deep (NestedIterators)
       OptionParser#make_switch contains iterators nested 3 deep (NestedIterators)
       OptionParser#make_switch has approx 68 statements (TooManyStatements)
       OptionParser#make_switch has the variable name 'a' (UncommunicativeVariableName)
@@ -112,7 +109,6 @@ Feature: Basic smell detection
       OptionParser#parse_in_order calls setter.call(sw.switch_name, val) twice (DuplicateMethodCall)
       OptionParser#parse_in_order calls sw.block twice (DuplicateMethodCall)
       OptionParser#parse_in_order calls sw.switch_name twice (DuplicateMethodCall)
-      OptionParser#parse_in_order contains iterators nested 2 deep (NestedIterators)
       OptionParser#parse_in_order contains iterators nested 3 deep (NestedIterators)
       OptionParser#parse_in_order has approx 28 statements (TooManyStatements)
       OptionParser#parse_in_order is controlled by argument setter (ControlParameter)
@@ -123,7 +119,6 @@ Feature: Basic smell detection
       OptionParser#summarize has 4 parameters (LongParameterList)
       OptionParser#summarize has the variable name 'l' (UncommunicativeVariableName)
       OptionParser#ver has the variable name 'v' (UncommunicativeVariableName)
-      OptionParser::Arguable#initialize has unused parameter '*args' (UnusedParameters)
       OptionParser::CompletingHash#match contains iterators nested 2 deep (NestedIterators)
       OptionParser::Completion#complete calls candidates.size twice (DuplicateMethodCall)
       OptionParser::Completion#complete calls k.id2name twice (DuplicateMethodCall)
@@ -148,9 +143,7 @@ Feature: Basic smell detection
       OptionParser::List#update is controlled by argument sopts (ControlParameter)
       OptionParser::ParseError#set_option is controlled by argument eq (ControlParameter)
       OptionParser::Switch#add_banner has the variable name 's' (UncommunicativeVariableName)
-      OptionParser::Switch#conv_arg calls conv twice (DuplicateMethodCall)
       OptionParser::Switch#initialize has 7 parameters (LongParameterList)
-      OptionParser::Switch#parse_arg calls pattern twice (DuplicateMethodCall)
       OptionParser::Switch#parse_arg calls s.length twice (DuplicateMethodCall)
       OptionParser::Switch#parse_arg has approx 11 statements (TooManyStatements)
       OptionParser::Switch#parse_arg has the variable name 'm' (UncommunicativeVariableName)
@@ -158,7 +151,6 @@ Feature: Basic smell detection
       OptionParser::Switch#self.guess has the variable name 't' (UncommunicativeVariableName)
       OptionParser::Switch#self.incompatible_argument_styles has the parameter name 't' (UncommunicativeParameterName)
       OptionParser::Switch#summarize calls (indent + l) twice (DuplicateMethodCall)
-      OptionParser::Switch#summarize calls arg 4 times (DuplicateMethodCall)
       OptionParser::Switch#summarize calls left.collect twice (DuplicateMethodCall)
       OptionParser::Switch#summarize calls left.collect { |s| s.length }.max twice (DuplicateMethodCall)
       OptionParser::Switch#summarize calls left.collect { |s| s.length }.max.to_i twice (DuplicateMethodCall)
@@ -185,7 +177,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/redcloth.rb -- 102 warnings:
+    spec/samples/redcloth.rb -- 101 warnings:
       RedCloth has at least 44 methods (TooManyMethods)
       RedCloth has the variable name 'a' (UncommunicativeVariableName)
       RedCloth has the variable name 'b' (UncommunicativeVariableName)
@@ -210,7 +202,6 @@ Feature: Basic smell detection
       RedCloth#block_textile_lists has the variable name 'i' (UncommunicativeVariableName)
       RedCloth#block_textile_lists has the variable name 'v' (UncommunicativeVariableName)
       RedCloth#block_textile_lists refers to depth more than self (FeatureEnvy)
-      RedCloth#block_textile_table contains iterators nested 2 deep (NestedIterators)
       RedCloth#block_textile_table contains iterators nested 3 deep (NestedIterators)
       RedCloth#block_textile_table has approx 18 statements (TooManyStatements)
       RedCloth#block_textile_table has the variable name 'x' (UncommunicativeVariableName)

data/lib/reek.rb

@@ -1,6 +1,6 @@
 #
 # Reek's core functionality
 #
-require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'version')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'examiner')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'smell_warning')
+require 'reek/version'
+require 'reek/examiner'
+require 'reek/smell_warning'

data/lib/reek/cli/application.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(File.expand_path(__FILE__)), 'command_line')
+require 'reek/cli/command_line'
 
 module Reek
   module Cli

data/lib/reek/cli/command_line.rb

@@ -1,10 +1,10 @@
 require 'optparse'
-require File.join(File.dirname(File.expand_path(__FILE__)), 'report')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'reek_command')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'help_command')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'version_command')
-require File.join(File.dirname(File.expand_path(__FILE__)), 'yaml_command')
-require File.join(File.dirname(File.dirname(File.expand_path(__FILE__))), 'source')
+require 'reek/cli/report'
+require 'reek/cli/reek_command'
+require 'reek/cli/help_command'
+require 'reek/cli/version_command'
+require 'reek/cli/yaml_command'
+require 'reek/source'
 
 module Reek
   module Cli
@@ -18,6 +18,7 @@ module Reek
         @argv = argv
         @parser = OptionParser.new
         @report_class = VerboseReport
+        @warning_formatter = SimpleWarningFormatter
         @command_class = ReekCommand
         @config_files = []
         set_options
@@ -75,7 +76,7 @@ EOB
           @report_class = opt ? QuietReport : VerboseReport
         end
         @parser.on("-n", "--line-number", "Prefix the output with the line number(s).") do 
-          @report_class = ShowLineReport
+          @warning_formatter = WarningFormatterWithLineNumbers
         end
         @parser.on("-y", "--yaml", "Report smells in YAML format") do
           @command_class = YamlCommand
@@ -96,7 +97,8 @@ EOB
           if @command_class == YamlCommand
             YamlCommand.create(sources, @config_files)
           else
-            ReekCommand.create(sources, @report_class, @config_files)
+            report = @report_class.new(@warning_formatter)
+            ReekCommand.create(sources, report, @config_files)
           end
         end
       end