reek 1.2.7.1 → 1.2.7.2

data/History.txt

@@ -1,4 +1,16 @@
-== 1.2.7.1 (in development)
+== 1.2.8 (in development)
+
+== 1.2.7.2 (2010-03-05)
+
+=== Minor Changes
+* Number of masked smells is no longer shown in report headers
+* Masked smells are no longer listed in --yaml reports
+* DataClump no longer needs infinite memory for large classes (#57)
+* DataClump reports the names of the offending methods in the YAML report
+* UncommunicativeMethodName now accepts operator names (+, -, ...)
+* Uncommunicative Name now warns about uppercase letters in method & var names
+
+== 1.2.7.1 (2010-02-03)
 
 === Minor Changes
 * Fixed crash on a case statement with no condition (#58)

data/config/defaults.reek

@@ -8,6 +8,7 @@ UncommunicativeParameterName:
   reject: 
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
 LargeClass: 
   max_methods: 25
   exclude: []
@@ -21,8 +22,9 @@ UncommunicativeMethodName:
 
   enabled: true
   reject: 
-  - !ruby/regexp /^.$/
+  - !ruby/regexp /^[a-z]$/
   - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
 LongParameterList: 
   max_params: 3
   exclude: []
@@ -84,6 +86,7 @@ UncommunicativeVariableName:
   reject: 
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
 SimulatedPolymorphism: 
   exclude: []
 

data/features/masking_smells.feature

@@ -41,7 +41,7 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
         Dirty#a contains iterators nested 2 deep (Nested Iterators)
@@ -54,7 +54,7 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
         Dirty#a contains iterators nested 2 deep (Nested Iterators)
@@ -66,7 +66,7 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 6 warnings:
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
@@ -81,7 +81,7 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
         Dirty#a contains iterators nested 2 deep (Nested Iterators)
@@ -93,7 +93,7 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/not_quite_masked/dirty.rb -- 5 warnings (+1 masked):
+      spec/samples/not_quite_masked/dirty.rb -- 5 warnings:
         Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
@@ -108,7 +108,7 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
+      spec/samples/overrides/masked/dirty.rb -- 2 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
 
@@ -120,7 +120,7 @@ Feature: Masking smells using config files
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/overrides/masked/dirty.rb -- 2 warnings (+4 masked):
+      spec/samples/overrides/masked/dirty.rb -- 6 warnings:
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)

data/features/rake_task.feature

@@ -13,7 +13,7 @@ Feature: Reek can be driven through its Task
     Then the exit status indicates an error
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
         Dirty#a contains iterators nested 2 deep (Nested Iterators)
@@ -29,7 +29,7 @@ Feature: Reek can be driven through its Task
     Then the exit status indicates an error
     And it reports:
       """
-      spec/samples/masked/dirty.rb -- 3 warnings (+3 masked):
+      spec/samples/masked/dirty.rb -- 3 warnings:
         Dirty#a calls @s.title twice (Duplication)
         Dirty#a calls puts(@s.title) twice (Duplication)
         Dirty#a contains iterators nested 2 deep (Nested Iterators)

data/features/reports.feature

@@ -60,10 +60,10 @@ Feature: Correctly formatted reports
 
   Scenario Outline: -a turns on details in presence of -q
     When I run reek <options> spec/samples/clean_due_to_masking/*.rb
-    Then it succeeds
+    Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/clean_due_to_masking/dirty_one.rb -- 0 warnings (+7 masked):
+      spec/samples/clean_due_to_masking/dirty_one.rb -- 7 warnings:
         (masked) Dirty has no descriptive comment (Irresponsible Module)
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         (masked) Dirty#a calls @s.title twice (Duplication)
@@ -71,7 +71,7 @@ Feature: Correctly formatted reports
         (masked) Dirty#a contains iterators nested 2 deep (Nested Iterators)
         (masked) Dirty#a has the name 'a' (Uncommunicative Name)
         (masked) Dirty#a has the variable name 'x' (Uncommunicative Name)
-      spec/samples/clean_due_to_masking/dirty_two.rb -- 0 warnings (+7 masked):
+      spec/samples/clean_due_to_masking/dirty_two.rb -- 7 warnings:
         (masked) Dirty has no descriptive comment (Irresponsible Module)
         (masked) Dirty has the variable name '@s' (Uncommunicative Name)
         (masked) Dirty#a calls @s.title twice (Duplication)

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 -- 41 warnings (+1 masked):
+    spec/samples/inline.rb -- 41 warnings:
       File has no descriptive comment (Irresponsible Module)
       Inline declares the class variable @@directory (Class Variable)
       Inline declares the class variable @@rootdir (Class Variable)
@@ -178,7 +178,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    spec/samples/redcloth.rb -- 94 warnings:
+    spec/samples/redcloth.rb -- 97 warnings:
       RedCloth has at least 44 methods (Large Class)
       RedCloth has the variable name 'a' (Uncommunicative Name)
       RedCloth has the variable name 'b' (Uncommunicative Name)
@@ -245,6 +245,7 @@ Feature: Basic smell detection
       RedCloth#inline_textile_span contains iterators nested 2 deep (Nested Iterators)
       RedCloth#inline_textile_span has approx 8 statements (Long Method)
       RedCloth#inline_textile_span has the variable name 'm' (Uncommunicative Name)
+      RedCloth#lT has the name 'lT' (Uncommunicative Name)
       RedCloth#no_textile doesn't depend on instance state (Low Cohesion)
       RedCloth#no_textile refers to text more than self (Low Cohesion)
       RedCloth#pba calls $1.length twice (Duplication)
@@ -272,6 +273,8 @@ Feature: Basic smell detection
       RedCloth#textile_fn_ is controlled by argument atts (Control Couple)
       RedCloth#textile_p has 4 parameters (Long Parameter List)
       RedCloth#textile_p is controlled by argument atts (Control Couple)
+      RedCloth#textile_popup_help has the parameter name 'windowH' (Uncommunicative Name)
+      RedCloth#textile_popup_help has the parameter name 'windowW' (Uncommunicative Name)
       RedCloth#to_html has approx 24 statements (Long Method)
 
     """

data/features/yaml.feature

@@ -15,19 +15,6 @@ Feature: Report smells using simple YAML layout
     And it reports:
       """
       --- 
-      - !ruby/object:Reek::SmellWarning 
-        location: 
-          lines: 
-          - 5
-          context: Dirty
-          source: spec/samples/masked/dirty.rb
-        smell: 
-          class: UncommunicativeName
-          subclass: UncommunicativeVariableName
-          variable_name: "@s"
-          message: has the variable name '@s'
-        status: 
-          is_active: false
       - !ruby/object:Reek::SmellWarning 
         location: 
           lines: 
@@ -71,32 +58,6 @@ Feature: Report smells using simple YAML layout
           message: contains iterators nested 2 deep
         status: 
           is_active: true
-      - !ruby/object:Reek::SmellWarning 
-        location: 
-          lines: 
-          - 3
-          context: Dirty#a
-          source: spec/samples/masked/dirty.rb
-        smell: 
-          method_name: a
-          class: UncommunicativeName
-          subclass: UncommunicativeMethodName
-          message: has the name 'a'
-        status: 
-          is_active: false
-      - !ruby/object:Reek::SmellWarning 
-        location: 
-          lines: 
-          - 5
-          context: Dirty#a
-          source: spec/samples/masked/dirty.rb
-        smell: 
-          class: UncommunicativeName
-          subclass: UncommunicativeVariableName
-          variable_name: x
-          message: has the variable name 'x'
-        status: 
-          is_active: false
 
       """
 

data/lib/reek.rb

@@ -2,7 +2,7 @@
 # Reek's core functionality
 #
 module Reek
-  VERSION = '1.2.7.1'
+  VERSION = '1.2.7.2'
 end
 
 require File.join(File.dirname(File.expand_path(__FILE__)), 'reek', 'examiner')

data/lib/reek/cli/command_line.rb

@@ -18,7 +18,7 @@ module Reek
         @argv = argv
         @parser = OptionParser.new
         @report_class = VerboseReport
-        @show_all = false
+        @collection_strategy = ActiveSmellsOnly
         @command_class = ReekCommand
         set_options
       end
@@ -66,7 +66,7 @@ EOB
 
         @parser.separator "\nReport formatting:"
         @parser.on("-a", "--[no-]show-all", "Show all smells, including those masked by config settings") do |opt|
-          @show_all = opt
+          @collection_strategy = opt ? ActiveAndMaskedSmells : ActiveSmellsOnly
         end
         @parser.on("-q", "--[no-]quiet", "Suppress headings for smell-free source files") do |opt|
           @report_class = opt ? QuietReport : VerboseReport
@@ -90,7 +90,7 @@ EOB
           YamlCommand.create(sources)
         else
           sources = get_sources
-          ReekCommand.create(sources, @report_class, @show_all)
+          ReekCommand.create(sources, @report_class, @collection_strategy)
         end
       end
 

data/lib/reek/cli/reek_command.rb

@@ -8,21 +8,20 @@ module Reek
     # text report format.
     #
     class ReekCommand
-      def self.create(sources, report_class, show_all)
-        examiners = sources.map {|src| Examiner.new(src) }
-        new(examiners, report_class, show_all)
+      def self.create(sources, report_class, strategy = ActiveSmellsOnly)
+        examiners = sources.map { |src| Examiner.new(src, strategy.new) }
+        new(examiners, report_class)
       end
 
-      def initialize(examiners, report_class, show_all)
+      def initialize(examiners, report_class)
         @examiners = examiners
         @report_class = report_class
-        @show_all = show_all    #SMELL: boolean parameter
       end
 
       def execute(view)
         had_smells = false
         @examiners.each do |examiner|
-          rpt = @report_class.new(examiner, @show_all)
+          rpt = @report_class.new(examiner)
           had_smells ||= examiner.smelly?
           view.output(rpt.report)
         end

data/lib/reek/cli/report.rb

@@ -10,9 +10,8 @@ module Reek
 
       SMELL_FORMAT = '%m%c %w (%s)'
 
-      def initialize(examiner, display_masked_warnings)
+      def initialize(examiner)
         @examiner = examiner
-        @display_masked_warnings = display_masked_warnings  # SMELL: Control Couple
       end
 
       # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
@@ -31,45 +30,35 @@ module Reek
       end
 
       def header
-        "#{@examiner.description} -- #{visible_header}#{masked_header}"
+        "#{@examiner.description} -- #{visible_header}"
       end
 
       # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
       # this report.
       def smell_list
-        if @display_masked_warnings
-          result = @examiner.all_smells.map {|smell| "  #{smell.report(SMELL_FORMAT)}"}
-        else
-          result = @examiner.all_active_smells.map {|smell| "  #{smell.report(SMELL_FORMAT)}"}
-        end
-        result.join("\n")
+        @examiner.smells.map {|smell| "  #{smell.report(SMELL_FORMAT)}"}.join("\n")
       end
 
     private
 
       def should_report
-        @examiner.num_active_smells > 0 or (@display_masked_warnings and @examiner.num_masked_smells > 0)
+        @examiner.num_smells > 0
       end
 
       def visible_header
-        num_smells = @examiner.all_active_smells.length
+        num_smells = @examiner.smells.length
         result = "#{num_smells} warning"
         result += 's' unless num_smells == 1
         result
       end
-
-      def masked_header
-        num_masked_warnings = @examiner.num_masked_smells
-        num_masked_warnings == 0 ? '' : " (+#{num_masked_warnings} masked)"
-      end
     end
 
     #
     # A report that lists every source, including those that have no smells.
     #
     class VerboseReport
-      def initialize(examiner, display_masked_warnings)
-        @reporter = ReportSection.new(examiner, display_masked_warnings)
+      def initialize(examiner)
+        @reporter = ReportSection.new(examiner)
       end
       def report
         @reporter.verbose_report
@@ -80,8 +69,8 @@ module Reek
     # A report that lists a section for each source that has smells.
     #
     class QuietReport
-      def initialize(examiner, display_masked_warnings)
-        @reporter = ReportSection.new(examiner, display_masked_warnings)
+      def initialize(examiner)
+        @reporter = ReportSection.new(examiner)
       end
       def report
         @reporter.quiet_report

data/lib/reek/cli/yaml_command.rb

@@ -19,7 +19,7 @@ module Reek
 
       def execute(view)
         smells = []
-        @examiners.each {|examiner| smells += examiner.all_smells}
+        @examiners.each {|examiner| smells += examiner.smells}
         if smells.empty?
           view.report_success
         else

data/lib/reek/core/class_context.rb

@@ -12,11 +12,10 @@ module Reek
 
       def initialize(outer, name, exp)
         super
-        @superclass = exp[2]
       end
 
       def is_struct?
-        @superclass == [:const, :Struct]
+        exp.superclass == [:const, :Struct]
       end
     end
   end

data/lib/reek/core/code_context.rb

@@ -1,13 +1,4 @@
 
-#
-# Extensions to +Module+ needed by Reek.
-#
-class Module
-  def const_or_nil(sym)
-    const_defined?(sym) ? const_get(sym) : nil
-  end
-end
-
 module Reek
   module Core
 
@@ -19,12 +10,15 @@ module Reek
     #
     class CodeContext
 
-      attr_reader :name, :exp
+      attr_reader :exp
 
       def initialize(outer, exp)
         @outer = outer
         @exp = exp
-        @scope_connector = ''
+      end
+
+      def name
+        @exp.name
       end
 
       def local_nodes(type, &blk)
@@ -32,22 +26,12 @@ module Reek
       end
 
       def each_node(type, ignoring, &blk)
-        if block_given?
-          @exp.look_for(type, ignoring, &blk)
-        else
-          result = []
-          @exp.look_for(type, ignoring) {|exp| result << exp}
-          result
-        end
+        @exp.each_node(type, ignoring, &blk)
       end
 
-      # SMELL: Temporary Field -- @name isn't always initialized
-      def matches?(strings)
-        me = @name.to_s
-        strings.any? do |str|
-          re = /#{str}/
-          re === me or re === self.full_name
-        end
+      def matches?(candidates)
+        my_fq_name = full_name
+        candidates.any? {|str| /#{str}/ === my_fq_name }
       end
 
       #
@@ -64,8 +48,7 @@ module Reek
 
       def full_name
         outer = @outer ? @outer.full_name : ''
-        prefix = outer == '' ? '' : "#{outer}#{@scope_connector}"
-        "#{prefix}#{@name}"
+        exp.full_name(outer)
       end
     end
   end