reek 2.0.0 → 2.0.1

data/lib/reek/cli/report/report.rb

@@ -1,4 +1,5 @@
 require 'rainbow'
+require 'json'
 
 module Reek
   module Cli
@@ -58,12 +59,11 @@ module Reek
         private
 
         def display_summary
-          print smells.reject(&:empty?).join("\n")
+          smells.reject(&:empty?).each { |smell| puts smell }
         end
 
         def display_total_smell_count
           return unless @examiners.size > 1
-          print "\n"
           print total_smell_count_message
         end
 
@@ -102,6 +102,15 @@ module Reek
         end
       end
 
+      #
+      # Displays a list of smells in JSON format
+      # JSON with empty array for 0 smells
+      class JsonReport < Base
+        def show
+          print ::JSON.generate(smells.map(&:yaml_hash))
+        end
+      end
+
       #
       # Saves the report as a HTML file
       #

data/lib/reek/core/code_context.rb

@@ -10,9 +10,45 @@ module Reek
     class CodeContext
       attr_reader :exp
 
-      def initialize(outer, exp)
-        @outer = outer
-        @exp = exp
+      # Initializes a new CodeContext.
+      #
+      # context - *_context from the `core` namespace
+      # exp - Reek::Source::AstNode
+      #
+      # Examples:
+      #
+      # Given something like:
+      #
+      #   class Omg; def foo(x); puts x; end; end
+      #
+      # the first time this is instantianted from TreeWalker `context` is a StopContext:
+      #
+      #   #<Reek::Core::StopContext:0x00000002231098 @name="">
+      #
+      # and `exp` looks like this:
+      #
+      #  (class
+      #    (const nil :Omg) nil
+      #    (def :foo
+      #      (args
+      #        (arg :x))
+      #      (send nil :puts
+      #        (lvar :x))))
+      #
+      # The next time we instantiate a CodeContext via TreeWalker `context` would be:
+      #
+      #   Reek::Core::ModuleContext
+      #
+      # and `exp` is:
+      #
+      # (def :foo
+      #   (args
+      #     (arg :x))
+      #   (send nil :puts
+      #     (lvar :x)))
+      def initialize(context, exp)
+        @context = context
+        @exp     = exp
       end
 
       def name
@@ -29,7 +65,10 @@ module Reek
 
       def matches?(candidates)
         my_fq_name = full_name
-        candidates.any? { |str| /#{str}/ =~ my_fq_name }
+        candidates.any? do |candidate|
+          candidate = Regexp.quote(candidate) if candidate.is_a?(String)
+          /#{candidate}/ =~ my_fq_name
+        end
       end
 
       #
@@ -37,7 +76,7 @@ module Reek
       # that knows how to deal with the request.
       #
       def method_missing(method, *args)
-        @outer.send(method, *args)
+        @context.send(method, *args)
       end
 
       def num_methods
@@ -45,12 +84,12 @@ module Reek
       end
 
       def full_name
-        outer = @outer ? @outer.full_name : ''
-        exp.full_name(outer)
+        context = @context ? @context.full_name : ''
+        exp.full_name(context)
       end
 
       def config_for(detector_class)
-        outer_config_for(detector_class).merge(
+        context_config_for(detector_class).merge(
           config[detector_class.smell_type] || {})
       end
 
@@ -64,8 +103,8 @@ module Reek
                     end
       end
 
-      def outer_config_for(detector_class)
-        @outer ? @outer.config_for(detector_class) : {}
+      def context_config_for(detector_class)
+        @context ? @context.config_for(detector_class) : {}
       end
     end
   end

data/lib/reek/core/sniffer.rb

@@ -1,4 +1,4 @@
-require 'reek/core/code_parser'
+require 'reek/core/tree_walker'
 require 'reek/core/smell_repository'
 require 'reek/configuration/app_configuration'
 
@@ -17,7 +17,7 @@ module Reek
       end
 
       def report_on(listener)
-        CodeParser.new(@smell_repository).process(syntax_tree) if syntax_tree
+        TreeWalker.new(@smell_repository).process(syntax_tree) if syntax_tree
         @smell_repository.report_on(listener)
       end
 

data/lib/reek/core/{code_parser.rb → tree_walker.rb}

@@ -12,21 +12,26 @@ module Reek
     # SMELL: This class is responsible for counting statements and for feeding
     # each context to the smell repository.
     # SMELL: This class has a name that doesn't match its responsibility.
-    class CodeParser
-      def initialize(smell_repository, ctx = StopContext.new)
+    class TreeWalker
+      def initialize(smell_repository)
         @smell_repository = smell_repository
-        @element = ctx
+        @element = StopContext.new
       end
 
       def process(exp)
-        meth = "process_#{exp.type}"
-        meth = :process_default unless self.respond_to?(meth)
-        send(meth, exp)
+        context_processor = "process_#{exp.type}"
+        if context_processor_exists?(context_processor)
+          send(context_processor, exp)
+        else
+          process_default exp
+        end
         @element
       end
 
       def process_default(exp)
-        exp.children.each { |sub| process(sub) if sub.is_a? AST::Node }
+        exp.children.each do |child|
+          process(child) if child.is_a? AST::Node
+        end
       end
 
       def process_module(exp)
@@ -140,6 +145,10 @@ module Reek
 
       private
 
+      def context_processor_exists?(name)
+        respond_to?(name)
+      end
+
       def count_clause(sexp)
         @element.count_statements(1) if sexp
       end

data/lib/reek/examiner.rb

@@ -16,9 +16,6 @@ module Reek
     #
     # Creates an Examiner which scans the given +source+ for code smells.
     #
-    # The smells reported against any source file can be "masked" by
-    # creating *.reek files. See TBS for details.
-    #
     # @param [Source::SourceCode, Array<String>, #to_reek_source]
     #   If +source+ is a String it is assumed to be Ruby source code;
     #   if it is a File, the file is opened and parsed for Ruby source code;
@@ -64,41 +61,5 @@ module Reek
     def smelly?
       !smells.empty?
     end
-
-    #
-    # Returns an Array of SmellWarning objects, one for each non-masked smell
-    # in the source.
-    #
-    # @deprecated Use #smells instead.
-    #
-    alias_method :all_active_smells, :smells
-
-    #
-    # Returns an Array of SmellWarning objects, one for each smell
-    # in the source; includes active smells and masked smells.
-    #
-    # @return [Array<SmellWarning>]
-    #
-    # @deprecated Use #smells instead.
-    #
-    alias_method :all_smells, :smells
-
-    #
-    # Returns the number of non-masked smells in the source.
-    #
-    # @deprecated Use #smells_count instead.
-    #
-    def num_active_smells
-      smells.length
-    end
-
-    #
-    # Returns the number of masked smells in the source.
-    #
-    # @deprecated Masked smells are no longer reported; this method always returns 0.
-    #
-    def num_masked_smells
-      0
-    end
   end
 end

data/lib/reek/smells.rb

@@ -1,28 +1,6 @@
-require 'reek/smells/attribute'
-require 'reek/smells/boolean_parameter'
-require 'reek/smells/class_variable'
-require 'reek/smells/control_parameter'
-require 'reek/smells/data_clump'
-require 'reek/smells/duplicate_method_call'
-require 'reek/smells/feature_envy'
-require 'reek/smells/irresponsible_module'
-require 'reek/smells/long_parameter_list'
-require 'reek/smells/long_yield_list'
-require 'reek/smells/module_initialize'
-require 'reek/smells/nested_iterators'
-require 'reek/smells/nil_check'
-require 'reek/smells/prima_donna_method'
-require 'reek/smells/repeated_conditional'
-require 'reek/smells/too_many_instance_variables'
-require 'reek/smells/too_many_methods'
-require 'reek/smells/too_many_statements'
-require 'reek/smells/uncommunicative_method_name'
-require 'reek/smells/uncommunicative_module_name'
-require 'reek/smells/uncommunicative_parameter_name'
-require 'reek/smells/uncommunicative_variable_name'
-require 'reek/smells/unused_parameters'
-require 'reek/smells/utility_function'
-# SMELL: Duplication -- all these should be found automagically
+require 'require_all'
+
+require_rel 'smells'
 
 module Reek
   #

data/lib/reek/smells/feature_envy.rb

@@ -31,8 +31,6 @@ module Reek
     # often than it refers to (ie. send messages to) some other object.
     #
     class FeatureEnvy < SmellDetector
-      include ExcludeInitialize
-
       def self.smell_category
         'LowCohesion'
       end

data/lib/reek/smells/smell_detector.rb

@@ -4,12 +4,6 @@ require 'reek/core/smell_configuration'
 
 module Reek
   module Smells
-    module ExcludeInitialize
-      def self.default_config
-        super.merge(EXCLUDE_KEY => ['initialize'])
-      end
-    end
-
     #
     # Shared responsibilities of all smell detectors.
     #

data/lib/reek/source/sexp_extensions.rb

@@ -2,6 +2,10 @@ require 'reek/source/sexp_node'
 
 module Reek
   module Source
+    #
+    # Extension modules providing utility methods to AstNode objects, depending
+    # on their type.
+    #
     module SexpExtensions
       # Base module for utility methods for argument nodes.
       module ArgNodeBase
@@ -96,21 +100,22 @@ module Reek
         end
       end
 
+      # Utility methods for :and nodes.
       module AndNode
         include LogicOperatorBase
       end
 
-      # Utility methods for :or nodes
+      # Utility methods for :or nodes.
       module OrNode
         include LogicOperatorBase
       end
 
-      # Utility methods for :attrasgn nodes
+      # Utility methods for :attrasgn nodes.
       module AttrasgnNode
         def args() self[3] end
       end
 
-      # Utility methods for :case nodes
+      # Utility methods for :case nodes.
       module CaseNode
         def condition() self[1] end
 
@@ -123,7 +128,7 @@ module Reek
         end
       end
 
-      # Utility methods for :when nodes
+      # Utility methods for :when nodes.
       module WhenNode
         def condition_list
           children[0..-2]
@@ -134,7 +139,7 @@ module Reek
         end
       end
 
-      # Utility methods for :send nodes
+      # Utility methods for :send nodes.
       module SendNode
         def receiver() self[1] end
         def method_name() self[2] end
@@ -172,6 +177,7 @@ module Reek
         include VariableBase
       end
 
+      # Utility methods for :lvar nodes.
       module LvarNode
         def var_name() self[1] end
       end
@@ -226,6 +232,7 @@ module Reek
         end
       end
 
+      # Utility methods for :defs nodes.
       module DefsNode
         def receiver() self[1] end
         def name() self[2] end
@@ -242,7 +249,7 @@ module Reek
         end
       end
 
-      # Utility methods for :if nodes
+      # Utility methods for :if nodes.
       module IfNode
         def condition() self[1] end
 
@@ -263,6 +270,7 @@ module Reek
         end
       end
 
+      # Utility methods for :lit nodes.
       module LitNode
         def value() self[1] end
       end
@@ -292,11 +300,13 @@ module Reek
         end
       end
 
+      # Utility methods for :class nodes.
       module ClassNode
         include ModuleNode
         def superclass() self[2] end
       end
 
+      # Utility methods for :yield nodes.
       module YieldNode
         def args() self[1..-1] end
 
@@ -305,6 +315,7 @@ module Reek
         end
       end
 
+      # Utility methods for :zsuper nodes.
       module ZsuperNode
         def method_name
           :super

data/lib/reek/source/sexp_node.rb

@@ -1,7 +1,7 @@
 module Reek
   module Source
     #
-    # Extensions to +Sexp+ to allow +CodeParser+ to navigate the abstract
+    # Extensions to +Sexp+ to allow +TreeWalker+ to navigate the abstract
     # syntax tree more easily.
     #
     module SexpNode

data/lib/reek/spec.rb

@@ -40,6 +40,72 @@ module Reek
   #   ruby.should_not reek_of(:FeatureEnvy)
   #
   module Spec
+    #
+    # Checks the target source code for instances of "smell category"
+    # and returns true only if it can find one of them that matches.
+    #
+    # Remember that this includes our "smell types" as well. So it could be the
+    # "smell type" UtilityFunction, which is represented as a concrete class
+    # in reek but it could also be "Duplication" which is a "smell categgory".
+    #
+    # In theory you could pass many different types of input here:
+    #   - :UtilityFunction
+    #   - "UtilityFunction"
+    #   - UtilityFunction (this works in our specs because we tend to do "include Reek:Smells")
+    #   - Reek::Smells::UtilityFunction (the right way if you really want to pass a class)
+    #   - "Duplication" or :Duplication which is an abstract "smell category"
+    #
+    # It is recommended to pass this as a symbol like :UtilityFunction. However we don't
+    # enforce this.
+    #
+    # Additionally you can be more specific and pass in "smell_details" you
+    # want to check for as well e.g. "name" or "count" (see the examples below).
+    # The parameters you can check for are depending on the smell you are checking for.
+    # For instance "count" doesn't make sense everywhere whereas "name" does in most cases.
+    # If you pass in a parameter that doesn't exist (e.g. you make a typo like "namme") reek will
+    # raise an ArgumentError to give you a hint that you passed something that doesn't make
+    # much sense.
+    #
+    # smell_category - The "smell category" or "smell_type" we check for.
+    # smells_details - A hash containing "smell warning" parameters
+    #
+    # Examples
+    #
+    #   Without smell_details:
+    #
+    #   reek_of(:FeatureEnvy)
+    #   reek_of(Reek::Smells::UtilityFunction)
+    #
+    #   With smell_details:
+    #
+    #   reek_of(UncommunicativeParameterName, name: 'x2')
+    #   reek_of(DataClump, count: 3)
+    #
+    # Examples from a real spec
+    #
+    #   expect(src).to reek_of(Reek::Smells::DuplicateMethodCall, name: '@other.thing')
+    #
+    def reek_of(smell_category, smell_details = {})
+      ShouldReekOf.new(smell_category, smell_details)
+    end
+
+    #
+    # See the documentaton for "reek_of".
+    #
+    # Notable differences to reek_of:
+    #   1.) "reek_of" doesn't mind if there are other smells of a different category.
+    #       "reek_only_of" will fail in that case.
+    #   2.) "reek_only_of" doesn't support the additional smell_details hash.
+    def reek_only_of(smell_category)
+      ShouldReekOnlyOf.new(smell_category)
+    end
+
+    #
+    # Returns +true+ if and only if the target source code contains smells.
+    #
+    def reek
+      ShouldReek.new
+    end
   end
 end