kevinrutherford-reek 1.1.3.13 → 1.1.3.14

data/History.txt

@@ -2,6 +2,8 @@
 
 === Major Changes
 * Reek passes all its tests under ruby 1.8.6, 1.8.7 and 1.9.1 (fixed #16)
+* New smell -- Simulated Polymorphism:
+** Currently only performs basic check for multiple tests of same value
 * Reek's output reports are now formatted differently:
 ** Reek is no longer silent about smell-free source code
 ** Output now reports on all files examined, even if they have no smells
@@ -16,15 +18,19 @@
 === Minor Changes
 * Reek's RDoc is now hosted at http://rdoc.info/projects/kevinrutherford/reek
 * If a dir is passed on the command-line all **/*.rb files below it are examined (fixed #41)
+* Duplication warnings now report the number of identical calls
+* FeatureEnvy no longer ignores :self when passed as a method parameter
+* LargeClass is disabled when checking in-memory classes (fixed #28)
+* LongParameterList accepts upto 5 parameters for #initialize methods
 * Several changes to the LongMethod counting algorithm:
 ** LongMethod now counts statements deeper into each method (fixed #25)
 ** LongMethod no longer counts control structures, only their contained stmts
 ** See http://wiki.github.com/kevinrutherford/reek/long-method for details
-* LargeClass is disabled when checking in-memory classes (fixed #28)
+* UncommunicativeName warns about any name ending in a number (fixed #18)
 * UtilityFunction no longer reports methods that call 'super' (fixed #39)
-* Duplication warnings now report the number of identical calls
 * Now reports an error for corrupt config files
 * Empty config files are ignored
+* Smells can be configured with scope-specific overrides for any config item
 
 
 == 1.1.3 2009-05-19

data/config/defaults.reek

@@ -10,6 +10,9 @@ LongParameterList:
   exclude: []
 
   enabled: true
+  overrides: 
+    initialize: 
+      max_params: 5
 FeatureEnvy: 
   exclude: 
   - initialize
@@ -21,9 +24,10 @@ UncommunicativeName:
 
   enabled: true
   reject: 
-  - !ruby/regexp /^.[0-9]*$/
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
 NestedIterators: 
-  exclude: []
+  exclude: &id001 []
 
   enabled: true
 LongMethod: 
@@ -37,9 +41,13 @@ Duplication:
   enabled: true
   max_calls: 1
 UtilityFunction: 
+  exclude: *id001
+  enabled: true
+SimulatedPolymorphism: 
   exclude: []
 
   enabled: true
+  max_ifs: 2
 ControlCouple: 
   exclude: 
   - initialize
@@ -49,3 +57,6 @@ LongYieldList:
   exclude: []
 
   enabled: true
+  overrides: 
+    initialize: 
+      max_params: 5

data/features/masking_smells.feature

@@ -56,7 +56,7 @@ Feature: Masking smells using config files
 
       """
 
-  Scenario: switch off one smell and show hide them in the report
+  Scenario: switch off one smell and hide them in the report
     When I run reek --no-show-all spec/samples/masked/dirty.rb
     Then it fails with exit status 2
     And it reports:
@@ -81,3 +81,31 @@ Feature: Masking smells using config files
         Dirty#a/block/block is nested (Nested Iterators)
 
       """
+
+  @overrides
+  Scenario: lower overrides upper
+    When I run reek spec/samples/overrides
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
+        Dirty#a calls @s.title twice (Duplication)
+        Dirty#a calls puts(@s.title) twice (Duplication)
+
+      """
+
+  @overrides
+  Scenario: all show up masked even when overridden
+    When I run reek --show-all spec/samples/overrides
+    Then it fails with exit status 2
+    And it reports:
+      """
+      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
+        (masked) Dirty has the variable name '@s' (Uncommunicative Name)
+        Dirty#a calls @s.title twice (Duplication)
+        Dirty#a calls puts(@s.title) twice (Duplication)
+        (masked) Dirty#a has the name 'a' (Uncommunicative Name)
+        (masked) Dirty#a/block has the variable name 'x' (Uncommunicative Name)
+        (masked) Dirty#a/block/block is nested (Nested Iterators)
+
+      """

data/features/samples.feature

@@ -9,8 +9,11 @@ Feature: Basic smell detection
     Then it fails with exit status 2
     And it reports:
     """
-    spec/samples/inline.rb -- 32 warnings:
+    spec/samples/inline.rb -- 35 warnings (+1 masked):
       Inline::C has at least 13 instance variables (Large Class)
+      Inline::C tests $DEBUG at least 7 times (Simulated Polymorphism)
+      Inline::C tests $TESTING at least 4 times (Simulated Polymorphism)
+      Inline::C tests @@type_map.has_key?(type) at least 3 times (Simulated Polymorphism)
       Inline::C#build calls ($? == 0) twice (Duplication)
       Inline::C#build calls Inline.directory 5 times (Duplication)
       Inline::C#build calls io.puts 6 times (Duplication)
@@ -50,8 +53,13 @@ Feature: Basic smell detection
     Then it fails with exit status 2
     And it reports:
     """
-    spec/samples/optparse.rb -- 117 warnings:
+    spec/samples/optparse.rb -- 121 warnings:
       OptionParser has at least 59 methods (Large Class)
+      OptionParser tests ((argv.size == 1) and Array.===(argv[0])) at least 3 times (Simulated Polymorphism)
+      OptionParser tests a at least 7 times (Simulated Polymorphism)
+      OptionParser tests default_pattern at least 7 times (Simulated Polymorphism)
+      OptionParser tests not_style at least 3 times (Simulated Polymorphism)
+      OptionParser tests s at least 7 times (Simulated Polymorphism)
       OptionParser#CompletingHash#match/block/block is nested (Nested Iterators)
       OptionParser#Completion::complete calls candidates.size twice (Duplication)
       OptionParser#Completion::complete calls k.id2name twice (Duplication)
@@ -102,7 +110,6 @@ Feature: Basic smell detection
       OptionParser#Switch#summarize has the variable name 'l' (Uncommunicative Name)
       OptionParser#Switch#summarize has the variable name 'r' (Uncommunicative Name)
       OptionParser#Switch#summarize has the variable name 's' (Uncommunicative Name)
-      OptionParser#Switch#summarize refers to left more than self (Feature Envy)
       OptionParser#Switch#summarize/block has the variable name 's' (Uncommunicative Name)
       OptionParser#Switch#summarize/block/block is nested (Nested Iterators)
       OptionParser#block has the variable name 'f' (Uncommunicative Name)
@@ -176,8 +183,12 @@ Feature: Basic smell detection
     Then it fails with exit status 2
     And it reports:
     """
-    spec/samples/redcloth.rb -- 93 warnings:
+    spec/samples/redcloth.rb -- 99 warnings:
       RedCloth has at least 44 methods (Large Class)
+      RedCloth tests atts at least 6 times (Simulated Polymorphism)
+      RedCloth tests codepre.zero? at least 3 times (Simulated Polymorphism)
+      RedCloth tests href at least 3 times (Simulated Polymorphism)
+      RedCloth tests title at least 4 times (Simulated Polymorphism)
       RedCloth#block has the variable name 'a' (Uncommunicative Name)
       RedCloth#block has the variable name 'b' (Uncommunicative Name)
       RedCloth#block_markdown_atx refers to text more than self (Feature Envy)
@@ -235,6 +246,8 @@ Feature: Basic smell detection
       RedCloth#inline_markdown_reflink/block has the variable name 'm' (Uncommunicative Name)
       RedCloth#inline_textile_code/block has the variable name 'm' (Uncommunicative Name)
       RedCloth#inline_textile_image has approx 17 statements (Long Method)
+      RedCloth#inline_textile_image/block has the variable name 'href_a1' (Uncommunicative Name)
+      RedCloth#inline_textile_image/block has the variable name 'href_a2' (Uncommunicative Name)
       RedCloth#inline_textile_image/block has the variable name 'm' (Uncommunicative Name)
       RedCloth#inline_textile_link has approx 9 statements (Long Method)
       RedCloth#inline_textile_link/block has the variable name 'm' (Uncommunicative Name)

data/lib/reek/adapters/object_source.rb

@@ -1,4 +1,5 @@
 require 'reek/adapters/source'
+require 'reek/configuration'
 
 module Reek
   class ObjectSource < Source   # :nodoc:
@@ -13,7 +14,7 @@ module Reek
 
     def configure(sniffer)
       super
-      disabled_config = {Reek::Smells::SmellDetector::ENABLED_KEY => false}
+      disabled_config = {Reek::SmellConfiguration::ENABLED_KEY => false}
       sniffer.configure(LargeClass, disabled_config)
     end
 

data/lib/reek/class_context.rb

@@ -24,6 +24,8 @@ module Reek
       CodeParser.new(sniffer).process_class(source.syntax_tree)
     end
 
+    attr_reader :conditionals
+
     # SMELL: inconsistent with other contexts (not linked to the sexp)
     def initialize(outer, name, superclass = nil)
       super(outer, nil)
@@ -31,6 +33,7 @@ module Reek
       @superclass = superclass
       @parsed_methods = []
       @instance_variables = Set.new
+      @conditionals = []
     end
 
     def myself
@@ -74,5 +77,9 @@ module Reek
     def variable_names
       @instance_variables
     end
+
+    def record_conditional(exp)
+      @conditionals << exp
+    end
   end
 end

data/lib/reek/code_parser.rb

@@ -128,6 +128,7 @@ module Reek
     end
 
     def process_if(exp)
+      @element.record_conditional(exp[1])
       count_clause(exp[2])
       count_clause(exp[3])
       handle_context(IfContext, :if, exp)
@@ -159,6 +160,7 @@ module Reek
     end
 
     def process_case(exp)
+      @element.record_conditional(exp[1])
       process_default(exp)
       @element.count_statements(-1)
     end
@@ -184,7 +186,7 @@ module Reek
     end
 
     def process_self(exp)
-      @element.record_depends_on_self
+      @element.record_use_of_self
     end
 
     def count_clause(sexp)

data/lib/reek/configuration.rb

@@ -0,0 +1,51 @@
+module Reek
+
+  #
+  # Represents a single set of configuration options for a smell detector
+  #
+  class SmellConfiguration
+
+    # The name of the config field that specifies whether a smell is
+    # enabled. Set to +true+ or +false+.
+    ENABLED_KEY = 'enabled'
+
+    # The name of the config field that sets scope-specific overrides
+    # for other values in the current smell detector's configuration.
+    OVERRIDES_KEY = 'overrides'
+
+    attr_reader :hash
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    # SMELL: Getter
+    def enabled?
+      @hash[ENABLED_KEY]
+    end
+
+    def overrides_for(context)
+      Overrides.new(@hash.fetch(OVERRIDES_KEY, {})).for_context(context)
+    end
+
+    # Retrieves the value, if any, for the given +key+.
+    #
+    # Returns +fall_back+ if this config has no value for the key.
+    #
+    def value(key, context, fall_back)
+      overrides_for(context).each { |conf| return conf[key] if conf.has_key?(key) }
+      return @hash.fetch(key, fall_back)
+    end
+  end
+
+  class Overrides
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def for_context(context)
+      contexts = @hash.keys.select {|ckey| context.matches?([ckey])}
+      contexts.map { |exc| @hash[exc] }
+    end
+  end
+end

data/lib/reek/detector_stack.rb

@@ -7,9 +7,7 @@ module Reek
     end
 
     def push(config)
-      clone = @detectors[0].copy
-      clone.configure_with(config)
-      @detectors.each {|det| det.be_masked}
+      clone = @detectors[-1].supersede_with(config)
       @detectors << clone
     end
 

data/lib/reek/exceptions.reek

@@ -12,6 +12,9 @@ LongMethod:
   exclude:
   - Reek::SexpFormatter#self.format
   - Reek::Options#set_options
+UncommunicativeName:
+  accept:
+  - process_op_asgn1
 UtilityFunction:
   exclude:
   - Reek::Spec

data/lib/reek/smell_warning.rb

@@ -8,11 +8,11 @@ module Reek
   class SmellWarning
     include Comparable
 
-    def initialize(smell, context, warning)
+    def initialize(smell, context, warning, masked)
       @detector = smell
       @context = context
       @warning = warning
-      @is_masked = smell.masked?
+      @is_masked = masked
     end
 
     def hash  # :nodoc:
@@ -55,5 +55,13 @@ module Reek
     def report
       basic_report.gsub(/\%m/, @is_masked ? '(masked) ' : '')
     end
+
+    def report_on(report)
+      if @is_masked
+        report.record_masked_smell(self)
+      else
+        report << self
+      end
+    end
   end
 end

data/lib/reek/smells/duplication.rb

@@ -24,8 +24,10 @@ module Reek
       # identical calls to be permitted within any single method.
       MAX_ALLOWED_CALLS_KEY = 'max_calls'
 
+      DEFAULT_MAX_CALLS = 1
+
       def self.default_config
-        super.adopt(MAX_ALLOWED_CALLS_KEY => 1)
+        super.adopt(MAX_ALLOWED_CALLS_KEY => DEFAULT_MAX_CALLS)
       end
 
       def initialize(config = Duplication.default_config)
@@ -42,7 +44,7 @@ module Reek
       
       def smelly_calls(method)   # :nodoc:
         method.calls.select do |key,val|
-          val > @config[MAX_ALLOWED_CALLS_KEY] and key[2] != :new
+          val > value(MAX_ALLOWED_CALLS_KEY, method, DEFAULT_MAX_CALLS) and key[2] != :new
         end
       end
     end

data/lib/reek/smells/large_class.rb

@@ -20,18 +20,22 @@ module Reek
       # permitted in a class.
       MAX_ALLOWED_METHODS_KEY = 'max_methods'
 
+      DEFAULT_MAX_METHODS = 25
+
       # The name of the config field that sets the maximum number of instance
       # variables permitted in a class.
       MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'
 
+      DEFAULT_MAX_IVARS = 9
+
       def self.contexts      # :nodoc:
         [:class]
       end
 
       def self.default_config
         super.adopt(
-          MAX_ALLOWED_METHODS_KEY => 25,
-          MAX_ALLOWED_IVARS_KEY => 9,
+          MAX_ALLOWED_METHODS_KEY => DEFAULT_MAX_METHODS,
+          MAX_ALLOWED_IVARS_KEY => DEFAULT_MAX_IVARS,
           EXCLUDE_KEY => []
           )
       end
@@ -42,13 +46,13 @@ module Reek
 
       def check_num_methods(klass)  # :nodoc:
         count = klass.num_methods
-        return if count <= @config[MAX_ALLOWED_METHODS_KEY]
+        return if count <= value(MAX_ALLOWED_METHODS_KEY, klass, DEFAULT_MAX_METHODS)
         found(klass, "has at least #{count} methods")
       end
 
       def check_num_ivars(klass)  # :nodoc:
         count = klass.variable_names.length
-        return if count <= @config[MAX_ALLOWED_IVARS_KEY]
+        return if count <= value(MAX_ALLOWED_IVARS_KEY, klass, DEFAULT_MAX_IVARS)
         found(klass, "has at least #{count} instance variables")
       end
 

data/lib/reek/smells/long_method.rb

@@ -16,9 +16,11 @@ module Reek
       # statements permitted in any method.
       MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'
 
+      DEFAULT_MAX_STATEMENTS = 5
+
       def self.default_config
         super.adopt(
-          MAX_ALLOWED_STATEMENTS_KEY => 5,
+          MAX_ALLOWED_STATEMENTS_KEY => DEFAULT_MAX_STATEMENTS,
           EXCLUDE_KEY => ['initialize']
         )
       end
@@ -29,17 +31,13 @@ module Reek
         super(config)
       end
 
-      def max_statements
-        @config['max_statements']
-      end
-
       #
       # Checks the length of the given +method+.
       # Remembers any smells found.
       #
       def examine_context(method)
         num = method.num_statements
-        return false if num <= max_statements
+        return false if num <= value(MAX_ALLOWED_STATEMENTS_KEY, method, DEFAULT_MAX_STATEMENTS)
         found(method, "has approx #{num} statements")
       end
     end

data/lib/reek/smells/long_parameter_list.rb

@@ -1,5 +1,4 @@
 require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
 
 module Reek
   module Smells
@@ -18,8 +17,17 @@ module Reek
       # parameters permitted in any method or block.
       MAX_ALLOWED_PARAMS_KEY = 'max_params'
 
+      # The default value of the +MAX_ALLOWED_PARAMS_KEY+ configuration
+      # value.
+      DEFAULT_MAX_ALLOWED_PARAMS = 3
+
       def self.default_config
-        super.adopt(MAX_ALLOWED_PARAMS_KEY => 3)
+        super.adopt(
+          MAX_ALLOWED_PARAMS_KEY => DEFAULT_MAX_ALLOWED_PARAMS,
+          SmellConfiguration::OVERRIDES_KEY => {
+            "initialize" => {MAX_ALLOWED_PARAMS_KEY => 5}
+            }
+        )
       end
 
       def initialize(config = LongParameterList.default_config)
@@ -33,7 +41,7 @@ module Reek
       #
       def examine_context(ctx)
         num_params = ctx.parameters.length
-        return false if num_params <= @config['max_params']
+        return false if num_params <= value(MAX_ALLOWED_PARAMS_KEY, ctx, DEFAULT_MAX_ALLOWED_PARAMS)
         found(ctx, "#{@action} #{num_params} parameters")
       end
     end

data/lib/reek/smells/simulated_polymorphism.rb

@@ -0,0 +1,58 @@
+require 'reek/smells/smell_detector'
+require 'reek/smell_warning'
+require 'reek/sexp_formatter'
+
+module Reek
+  module Smells
+
+    #
+    # Simulated Polymorphism occurs when
+    # * code uses a case statement (especially on a type field);
+    # * or code has several if statements in a row (especially if they're comparing against the same value);
+    # * or code uses instance_of?, kind_of?, is_a?, or === to decide what type it's working with;
+    # * or multiple conditionals in different places test the same value.
+    #
+    # Conditional code is hard to read and understand, because the reader must
+    # hold more state in his head.
+    # When the same value is tested in multiple places throughout an application,
+    # any change to the set of possible values will require many methods and
+    # classes to change. Tests for the type of an object may indicate that the
+    # abstraction represented by that type is not completely defined (or understood).
+    #
+    # In the current implementation, Reek only checks for multiple conditionals
+    # testing the same value throughout a single class.
+    #
+    class SimulatedPolymorphism < SmellDetector
+
+      def self.contexts      # :nodoc:
+        [:class]
+      end
+
+      # The name of the config field that sets the maximum number of
+      # identical conditionals permitted within any single class.
+      MAX_IDENTICAL_IFS_KEY = 'max_ifs'
+
+      DEFAULT_MAX_IFS = 2
+
+      def self.default_config
+        super.adopt(MAX_IDENTICAL_IFS_KEY => DEFAULT_MAX_IFS)
+      end
+
+      def initialize(config = SimulatedPolymorphism.default_config)
+        super(config)
+      end
+
+      #
+      # Checks the given ClassContext for multiple identical conditional tests.
+      # Remembers any smells found.
+      #
+      def examine_context(klass)
+        counts = Hash.new(0)
+        klass.conditionals.each {|cond| counts[cond] += 1}
+        counts.each do |key, val|
+          found(klass, "tests #{SexpFormatter.format(key)} at least #{val} times") if val > value(MAX_IDENTICAL_IFS_KEY, klass, DEFAULT_MAX_IFS)
+        end
+      end
+    end
+  end
+end