reek 1.2.0 → 1.2.1

data/History.txt

@@ -1,3 +1,10 @@
+== 1.2.1 (2009-10-02)
+
+=== Minor Changes
+* New smell: Class Variable
+
+See http://wiki.github.com/kevinrutherford/reek for details
+
 == 1.2 2009-09-20
 
 === Major Changes

data/README.rdoc

@@ -73,6 +73,7 @@ Reek makes use of the following other gems:
 
 * ruby_parser
 * sexp_processor
+* ruby2ruby
 
 == Learn More
 

data/config/defaults.reek

@@ -16,6 +16,10 @@ LongParameterList:
 FeatureEnvy: 
   exclude: 
   - initialize
+  enabled: true
+ClassVariable: 
+  exclude: &id001 []
+
   enabled: true
 UncommunicativeName: 
   accept: 
@@ -27,8 +31,7 @@ UncommunicativeName:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
 NestedIterators: 
-  exclude: []
-
+  exclude: *id001
   enabled: true
 LongMethod: 
   max_statements: 5

data/features/samples.feature

@@ -9,7 +9,10 @@ Feature: Basic smell detection
     Then it fails with exit status 2
     And it reports:
     """
-    spec/samples/inline.rb -- 36 warnings (+1 masked):
+    spec/samples/inline.rb -- 39 warnings (+1 masked):
+      Inline declares the class variable @@directory (Class Variable)
+      Inline declares the class variable @@rootdir (Class Variable)
+      Inline::C declares the class variable @@type_map (Class Variable)
       Inline::C has at least 13 instance variables (Large Class)
       Inline::C takes parameters [options, src] to 5 methods (Data Clump)
       Inline::C tests $DEBUG at least 7 times (Simulated Polymorphism)

data/lib/reek.rb

@@ -1,5 +1,5 @@
 $:.unshift File.dirname(__FILE__)
 
 module Reek # :doc:
-  VERSION = '1.2.0'
+  VERSION = '1.2.1'
 end

data/lib/reek/adapters/application.rb

@@ -1,7 +1,6 @@
-require 'reek/command_line'
+require 'reek/adapters/command_line'
 require 'reek/adapters/source'
 require 'reek/adapters/core_extras'
-require 'reek/adapters/report'
 
 module Reek
   #
@@ -11,13 +10,13 @@ module Reek
   #
   class Application
     def initialize(argv)
-      @argv = argv
+      @options = Options.new(argv)
     end
 
     def examine_sources
       # SMELL: Greedy Method
       # Options.parse executes the -v and -h commands and throws a SystemExit
-      args = Options.new(@argv).parse
+      args = @options.parse
       if args.length > 0
         @sniffer = args.sniff
       else
@@ -27,9 +26,7 @@ module Reek
 
     def reek
       examine_sources
-      # SMELL:
-      # This should use the actual type of report selected by the user's options
-      puts Report.new(@sniffer.sniffers).full_report
+      puts @options.create_report(@sniffer.sniffers).report
       return @sniffer.smelly? ? 2 : 0
     end
 

data/lib/reek/{command_line.rb → adapters/command_line.rb}

@@ -1,5 +1,6 @@
 require 'optparse'
 require 'reek'
+require 'reek/adapters/report'
 
 module Reek
     
@@ -12,24 +13,12 @@ module Reek
     CTX_SORT = '%m%c %w (%s)'
     SMELL_SORT = '%m[%s] %c %w'
 
-    def self.default_options
-      {
-        :format => CTX_SORT,
-        :show_all => false,
-        :quiet => false
-      }
-    end
-
-    # SMELL: Global Variable
-    @@opts = default_options
-
-    def self.[](key)
-      @@opts[key]
-    end
-
     def initialize(argv)
       @argv = argv
       @parser = OptionParser.new
+      @quiet = false
+      @show_all = false
+      @format = CTX_SORT
       set_options
     end
 
@@ -66,20 +55,24 @@ EOB
       @parser.separator "\nReport formatting:"
 
       @parser.on("-a", "--[no-]show-all", "Show all smells, including those masked by config settings") do |opt|
-        @@opts[:show_all] = opt
+        @show_all = opt
       end
       @parser.on("-q", "--quiet", "Suppress headings for smell-free source files") do
-        @@opts[:quiet] = true
+        @quiet = true
       end
       @parser.on('-f', "--format FORMAT", 'Specify the format of smell warnings') do |arg|
-        @@opts[:format] = arg unless arg.nil?
+        @format = arg unless arg.nil?
       end
       @parser.on('-c', '--context-first', "Sort by context; sets the format string to \"#{CTX_SORT}\"") do
-        @@opts[:format] = CTX_SORT
+        @format = CTX_SORT
       end
       @parser.on('-s', '--smell-first', "Sort by smell; sets the format string to \"#{SMELL_SORT}\"") do
-        @@opts[:format] = SMELL_SORT
+        @format = SMELL_SORT
       end
     end
+
+    def create_report(sniffers)
+      @quiet ? QuietReport.new(sniffers, @format, @show_all) : FullReport.new(sniffers, @format, @show_all)
+    end
   end
 end

data/lib/reek/adapters/object_source.rb

@@ -1,5 +1,8 @@
 require 'reek/adapters/source'
 require 'reek/configuration'
+require 'reek/smells/large_class'
+
+include Reek::Smells
 
 module Reek
   class ObjectSource < Source   # :nodoc:

data/lib/reek/adapters/report.rb

@@ -1,13 +1,15 @@
 require 'set'
-require 'reek/command_line'   # SMELL: Global Variable
+require 'reek/adapters/command_line'   # SMELL: Global Variable
 
 module Reek
   class ReportSection
 
-    def initialize(sniffer)  # :nodoc:
+    def initialize(sniffer, display_masked_warnings, format)  # :nodoc:
+      @format = format
       @masked_warnings = SortedSet.new
       @warnings = SortedSet.new
       @desc = sniffer.desc
+      @display_masked_warnings = display_masked_warnings
       sniffer.report_on(self)
     end
 
@@ -27,7 +29,6 @@ module Reek
     # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
     # this report, with a heading.
     def full_report
-      return quiet_report if Options[:quiet]
       result = header
       result += ":\n#{smell_list}" if should_report
       result += "\n"
@@ -48,14 +49,14 @@ module Reek
     # Creates a formatted report of all the +Smells::SmellWarning+ objects recorded in
     # this report.
     def smell_list
-      smells = Options[:show_all] ? @all_warnings : @warnings
-      smells.map {|smell| "  #{smell.report}"}.join("\n")
+      smells = @display_masked_warnings ? @all_warnings : @warnings
+      smells.map {|smell| "  #{smell.report(@format)}"}.join("\n")
     end
 
   private
 
     def should_report
-      @warnings.length > 0 or (Options[:show_all] and @masked_warnings.length > 0)
+      @warnings.length > 0 or (@display_masked_warnings and @masked_warnings.length > 0)
     end
 
     def visible_header
@@ -72,19 +73,19 @@ module Reek
   end
 
   class Report
-
-    def initialize(sniffers)
-      @partials = Array(sniffers).map {|sn| ReportSection.new(sn)}
+    def initialize(sniffers, format, display_masked_warnings = false)
+      @partials = Array(sniffers).map {|sn| ReportSection.new(sn, display_masked_warnings, format)}
     end
+  end
 
-    # SMELL: Shotgun Surgery
-    # This method and the next will have to be repeated for every new
-    # kind of report.
-    def full_report
+  class FullReport < Report
+    def report
       @partials.map { |rpt| rpt.full_report }.join
     end
+  end
 
-    def quiet_report
+  class QuietReport < Report
+    def report
       @partials.map { |rpt| rpt.quiet_report }.join
     end
   end

data/lib/reek/adapters/spec.rb

@@ -44,9 +44,14 @@ module Reek
   #
   module Spec
     module ReekMatcher
+      def create_reporter(sniffers)
+        QuietReport.new(sniffers, '%c %w (%s)', false)
+      end
       def report
-        Report.new(@sniffer.sniffers).quiet_report
+        create_reporter(@sniffer.sniffers).report
       end
+
+      module_function :create_reporter
     end
 
     class ShouldReek        # :nodoc:

data/lib/reek/class_context.rb

@@ -24,7 +24,7 @@ module Reek
       CodeParser.new(sniffer).process_class(source.syntax_tree)
     end
 
-    attr_reader :conditionals, :parsed_methods
+    attr_reader :conditionals, :parsed_methods, :class_variables
 
     # SMELL: inconsistent with other contexts (not linked to the sexp)
     def initialize(outer, name, superclass = nil)
@@ -34,6 +34,7 @@ module Reek
       @parsed_methods = []
       @instance_variables = Set.new
       @conditionals = []
+      @class_variables = Set.new
     end
 
     def myself
@@ -58,6 +59,10 @@ module Reek
       @parsed_methods.length
     end
 
+    def record_class_variable(cvar)
+      @class_variables << Name.new(cvar)
+    end
+
     def record_instance_variable(sym)
       @instance_variables << Name.new(sym)
     end

data/lib/reek/code_parser.rb

@@ -51,10 +51,12 @@ module Reek
     end
 
     def process_module(exp)
-      push(ModuleContext.create(@element, exp)) do
+      scope = ModuleContext.create(@element, exp)
+      push(scope) do
         process_default(exp)
         check_smells(:module)
       end
+      scope
     end
 
     def process_class(exp)
@@ -66,6 +68,18 @@ module Reek
       scope
     end
 
+    def process_cvar(exp)
+      @element.record_class_variable(exp[1])
+    end
+
+    def process_cvasgn(exp)
+      process_cvar(exp)
+    end
+
+    def process_cvdecl(exp)
+      process_cvar(exp)
+    end
+
     def process_defn(exp)
       handle_context(MethodContext, :defn, exp)
     end

data/lib/reek/module_context.rb

@@ -8,9 +8,18 @@ module Reek
       ModuleContext.new(res[0], res[1])
     end
 
+    def ModuleContext.from_s(src)
+      source = src.to_reek_source
+      sniffer = Sniffer.new(source)
+      CodeParser.new(sniffer).process_module(source.syntax_tree)
+    end
+
+    attr_reader :class_variables
+
     def initialize(outer, name)
       super(outer, nil)
       @name = name
+      @class_variables = Set.new
     end
 
     def myself
@@ -26,6 +35,10 @@ module Reek
       "#{@outer.outer_name}#{@name}::"
     end
 
+    def record_class_variable(cvar)
+      @class_variables << Name.new(cvar)
+    end
+
     def variable_names
       []
     end

data/lib/reek/smell_warning.rb

@@ -1,5 +1,3 @@
-require 'reek/command_line'    # SMELL: Global Variable used for options
-
 module Reek
 
   #
@@ -16,11 +14,11 @@ module Reek
     end
 
     def hash  # :nodoc:
-      basic_report.hash
+      sort_key.hash
     end
 
     def <=>(other)
-      basic_report <=> other.basic_report
+      sort_key <=> other.sort_key
     end
 
     alias eql? <=>  # :nodoc:
@@ -35,25 +33,18 @@ module Reek
     end
 
     def contains_all?(patterns)
-      rpt = report
+      rpt = sort_key.to_s
       return patterns.all? {|exp| exp === rpt}
     end
 
-    def basic_report
-      Options[:format].gsub(/\%s/, @detector.smell_name).gsub(/\%c/, @context.to_s).gsub(/\%w/, @warning)
+    def sort_key
+      [@context.to_s, @warning, @detector.smell_name]
     end
 
-    #
-    # Returns a copy of the current report format (see +Options+)
-    # in which the following magic tokens have been substituted:
-    #
-    # * %c <-- a description of the +CodeContext+ containing the smell
-    # * %m <-- "(is_masked) " if this is a is_masked smell
-    # * %s <-- the name of the smell that was detected
-    # * %w <-- the specific problem that was detected
-    #
-    def report
-      basic_report.gsub(/\%m/, @is_masked ? '(masked) ' : '')
+    protected :sort_key
+
+    def report(format)
+      format.gsub(/\%s/, @detector.smell_name).gsub(/\%c/, @context.to_s).gsub(/\%w/, @warning).gsub(/\%m/, @is_masked ? '(masked) ' : '')
     end
 
     def report_on(report)

data/lib/reek/smells/class_variable.rb

@@ -0,0 +1,31 @@
+require 'reek/smells/smell_detector'
+
+module Reek
+  module Smells
+
+    #
+    # Class variables form part of the global runtime state, and as such make
+    # it easy for one part of the system to accidentally or inadvertently
+    # depend on another part of the system. So the system becomes more prone to
+    # problems where changing something over here breaks something over there.
+    # In particular, class variables can make it hard to set up tests (because
+    # the context of the test includes all global state).
+    #
+    class ClassVariable < SmellDetector
+
+      def self.contexts      # :nodoc:
+        [:class, :module]
+      end
+
+      #
+      # Checks whether the given class declares any class variables.
+      # Remembers any smells found.
+      #
+      def examine_context(klass)
+        klass.class_variables.each do |cvar|
+          found(klass, "declares the class variable #{cvar}")
+        end
+      end
+    end
+  end
+end

data/lib/reek/sniffer.rb

@@ -1,6 +1,7 @@
 require 'reek/detector_stack'
 
 # SMELL: Duplication -- all these should be found automagically
+require 'reek/smells/class_variable'
 require 'reek/smells/control_couple'
 require 'reek/smells/data_clump'
 require 'reek/smells/duplication'
@@ -48,6 +49,7 @@ module Reek
     def self.smell_classes
       # SMELL: Duplication -- these should be loaded by listing the files
       [
+        Smells::ClassVariable,
         Smells::ControlCouple,
         Smells::DataClump,
         Smells::Duplication,