reek 2.2.1 → 3.0.0

data/lib/reek/code_comment.rb

@@ -0,0 +1,36 @@
+require 'yaml'
+
+module Reek
+  #
+  # A comment header from an abstract syntax tree; found directly above
+  # module, class and method definitions.
+  #
+  # @api private
+  class CodeComment
+    CONFIG_REGEX = /:reek:(\w+)(:\s*\{.*?\})?/
+
+    def initialize(text)
+      @text = text.gsub(CONFIG_REGEX) do
+        add_to_config($1, $2)
+        ''
+      end.gsub(/#/, '').gsub(/\n/, '').strip
+    end
+
+    def config
+      @config ||= Hash.new { |hash, key| hash[key] = {} }
+    end
+
+    def descriptive?
+      @text.split(/\s+/).length >= 2
+    end
+
+    protected
+
+    def add_to_config(smell, options)
+      options ||= ': { enabled: false }'
+      config.merge! YAML.load(smell.gsub(/(?:^|_)(.)/) { $1.upcase } + options)
+      # TODO: extend this to all configs -------------------^
+      # TODO: extend to allow configuration of whole smell class, not just subclass
+    end
+  end
+end

data/lib/reek/configuration/app_configuration.rb

@@ -1,13 +1,18 @@
 require_relative './configuration_file_finder'
 
 module Reek
+  # @api private
   module Configuration
+    # @api private
     class ConfigFileException < StandardError; end
     #
     # Reek's singleton configuration instance.
     #
+    # @api private
     module AppConfiguration
-      @configuration = {}
+      NON_SMELL_TYPE_KEYS   = %w(exclude_paths)
+      EXCLUDE_PATHS_KEY     = 'exclude_paths'
+      @configuration        = {}
       @has_been_initialized = false
 
       class << self
@@ -24,7 +29,7 @@ module Reek
           # Let users call this method directly without having initialized AppConfiguration before
           # and if they do, initialize it without application context
           initialize_with(nil) unless @has_been_initialized
-          @configuration.each do |klass_name, config|
+          for_smell_types.each do |klass_name, config|
             klass = load_smell_type(klass_name)
             smell_repository.configure(klass, config) if klass
           end
@@ -49,8 +54,18 @@ module Reek
           @configuration.clear
         end
 
+        def exclude_paths
+          @exclude_paths ||= @configuration.
+                             fetch(EXCLUDE_PATHS_KEY, []).
+                             map { |path| path.chomp('/') }
+        end
+
         private
 
+        def for_smell_types
+          @configuration.reject { |key, _value| NON_SMELL_TYPE_KEYS.include?(key) }
+        end
+
         def load_smell_type(name)
           Reek::Smells.const_get(name)
         rescue NameError

data/lib/reek/configuration/configuration_file_finder.rb

@@ -13,6 +13,7 @@ module Reek
     #
     # The order in which ConfigurationFileFinder tries to find such a
     # configuration file is exactly like above.
+    # @api private
     module ConfigurationFileFinder
       module_function
 

data/lib/reek/{core → context}/code_context.rb

@@ -1,12 +1,14 @@
+require_relative '../code_comment'
 
 module Reek
-  module Core
+  module Context
     #
     # Superclass for all types of source code context. Each instance represents
     # a code element of some kind, and each provides behaviour relevant to that
     # code element. CodeContexts form a tree in the same way the code does,
     # with each context holding a reference to a unique outer context.
     #
+    # @api private
     class CodeContext
       attr_reader :exp
 
@@ -21,9 +23,9 @@ module Reek
       #
       #   class Omg; def foo(x); puts x; end; end
       #
-      # the first time this is instantianted from TreeWalker `context` is a StopContext:
+      # the first time this is instantianted from TreeWalker `context` is a RootContext:
       #
-      #   #<Reek::Core::StopContext:0x00000002231098 @name="">
+      #   #<Reek::Context::RootContext:0x00000002231098 @name="">
       #
       # and `exp` looks like this:
       #
@@ -37,7 +39,7 @@ module Reek
       #
       # The next time we instantiate a CodeContext via TreeWalker `context` would be:
       #
-      #   Reek::Core::ModuleContext
+      #   Reek::Context::ModuleContext
       #
       # and `exp` is:
       #
@@ -97,7 +99,7 @@ module Reek
 
       def config
         @config ||= if @exp
-                      Core::CodeComment.new(@exp.comments || '').config
+                      CodeComment.new(@exp.full_comment || '').config
                     else
                       {}
                     end

data/lib/reek/{core → context}/method_context.rb

@@ -1,11 +1,12 @@
 require_relative 'code_context'
-require_relative 'object_refs'
+require_relative '../ast/object_refs'
 
 module Reek
-  module Core
+  module Context
     #
     # The parameters in a method's definition.
     #
+    # @api private
     module MethodParameters
       def default_assignments
         result = []
@@ -19,6 +20,7 @@ module Reek
     #
     # A context wrapper for any method definition found in a syntax tree.
     #
+    # @api private
     class MethodContext < CodeContext
       attr_reader :parameters
       attr_reader :refs
@@ -29,7 +31,7 @@ module Reek
         @parameters = exp.parameters.dup
         @parameters.extend MethodParameters
         @num_statements = 0
-        @refs = ObjectRefs.new
+        @refs = AST::ObjectRefs.new
       end
 
       def count_statements(num)

data/lib/reek/{core → context}/module_context.rb

@@ -1,20 +1,25 @@
 require_relative 'code_context'
-require_relative '../sexp/sexp_formatter'
+require_relative '../ast/sexp_formatter'
 
 module Reek
-  module Core
+  module Context
     #
     # A context wrapper for any module found in a syntax tree.
     #
+    # @api private
     class ModuleContext < CodeContext
       def initialize(outer, exp)
         super(outer, exp)
-        @name = Sexp::SexpFormatter.format(exp.children.first)
+        @name = AST::SexpFormatter.format(exp.children.first)
       end
 
       def node_instance_methods
         local_nodes(:def)
       end
+
+      def descriptively_commented?
+        CodeComment.new(exp.leading_comment).descriptive?
+      end
     end
   end
 end

data/lib/reek/{core/stop_context.rb → context/root_context.rb}

@@ -1,9 +1,11 @@
 module Reek
-  module Core
+  # @api private
+  module Context
     #
     # A context wrapper representing the root of an abstract syntax tree.
     #
-    class StopContext
+    # @api private
+    class RootContext
       def initialize
         @name = ''
       end

data/lib/reek/{core → context}/singleton_method_context.rb

@@ -1,10 +1,11 @@
 require_relative 'method_context'
 
 module Reek
-  module Core
+  module Context
     #
     # A context wrapper for any singleton method definition found in a syntax tree.
     #
+    # @api private
     class SingletonMethodContext < MethodContext
       def envious_receivers
         []

data/lib/reek/examiner.rb

@@ -0,0 +1,82 @@
+# NOTE: tree_walker is required first to ensure unparser is required before
+# parser. This prevents a potentially incompatible version of parser from being
+# loaded first. This is only relevant when running bin/reek straight from a
+# checkout directory without using Bundler.
+#
+# See also https://github.com/troessner/reek/pull/468
+require_relative 'tree_walker'
+require_relative 'source/source_code'
+require_relative 'cli/warning_collector'
+require_relative 'smells/smell_repository'
+
+module Reek
+  #
+  # Applies all available smell detectors to a source.
+  #
+  class Examiner
+    #
+    # Creates an Examiner which scans the given +source+ for code smells.
+    #
+    # @param source [File, IO, String]
+    #   If +source+ is a String it is assumed to be Ruby source code;
+    #   if it is a File or IO, it is opened and Ruby source code is read from it;
+    #
+    # @param smell_types_to_filter_by [Array<String>]
+    #   List of smell types to filter by.
+    #
+    def initialize(source, smell_types_to_filter_by = [])
+      @source       = Source::SourceCode.from(source)
+      @collector    = CLI::WarningCollector.new
+      @smell_types  = eligible_smell_types(smell_types_to_filter_by)
+
+      run
+    end
+
+    #
+    # @return [String] description of the source being analysed
+    #
+    def description
+      @description ||= @source.description
+    end
+
+    #
+    # @return [Array<SmellWarning>] the smells found in the source
+    #
+    def smells
+      @smells ||= @collector.warnings
+    end
+
+    #
+    # @return [Integer] the number of smells found in the source
+    #
+    def smells_count
+      smells.length
+    end
+
+    #
+    # @return [Boolean] true if and only if there are code smells in the source.
+    #
+    def smelly?
+      !smells.empty?
+    end
+
+    private
+
+    def run
+      smell_repository = Smells::SmellRepository.new(description, @smell_types)
+      syntax_tree = @source.syntax_tree
+      TreeWalker.new(smell_repository).process(syntax_tree) if syntax_tree
+      smell_repository.report_on(@collector)
+    end
+
+    def eligible_smell_types(smell_types_to_filter_by = [])
+      if smell_types_to_filter_by.any?
+        Smells::SmellRepository.smell_types.select do |klass|
+          smell_types_to_filter_by.include? klass.smell_type
+        end
+      else
+        Smells::SmellRepository.smell_types
+      end
+    end
+  end
+end

data/lib/reek/report/formatter.rb

@@ -0,0 +1,70 @@
+require_relative 'location_formatter'
+
+module Reek
+  module Report
+    #
+    # Formatter handling the formatting of the report at large.
+    # Formatting of the individual warnings is handled by the
+    # passed-in warning formatter.
+    #
+    # @api private
+    module Formatter
+      def self.format_list(warnings, formatter = SimpleWarningFormatter.new)
+        warnings.map do |warning|
+          "  #{formatter.format warning}"
+        end.join("\n")
+      end
+
+      def self.header(examiner)
+        count = examiner.smells_count
+        result = Rainbow("#{examiner.description} -- ").cyan +
+                 Rainbow("#{count} warning").yellow
+        result += Rainbow('s').yellow unless count == 1
+        result
+      end
+    end
+
+    #
+    # Basic formatter that just shows a simple message for each warning,
+    # prepended with the result of the passed-in location formatter.
+    #
+    # @api private
+    class SimpleWarningFormatter
+      def initialize(location_formatter = BlankLocationFormatter)
+        @location_formatter = location_formatter
+      end
+
+      def format(warning)
+        "#{@location_formatter.format(warning)}#{base_format(warning)}"
+      end
+
+      private
+
+      def base_format(warning)
+        "#{warning.context} #{warning.message} (#{warning.smell_type})"
+      end
+    end
+
+    #
+    # Formatter that adds a link to the wiki to the basic message from
+    # SimpleWarningFormatter.
+    #
+    # @api private
+    class WikiLinkWarningFormatter < SimpleWarningFormatter
+      BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/wiki/'
+
+      def format(warning)
+        "#{super} " \
+          "[#{explanatory_link(warning)}]"
+      end
+
+      def explanatory_link(warning)
+        "#{BASE_URL_FOR_HELP_LINK}#{class_name_to_param(warning.smell_type)}"
+      end
+
+      def class_name_to_param(name)
+        name.split(/(?=[A-Z])/).join('-')
+      end
+    end
+  end
+end

data/lib/reek/report/heading_formatter.rb

@@ -0,0 +1,45 @@
+module Reek
+  module Report
+    # @api private
+    module HeadingFormatter
+      #
+      # Base class for heading formatters.
+      # Is responsible for formatting the heading emitted for each examiner
+      #
+      # @abstract Override {#show_header?} to implement a heading formatter.
+      class Base
+        attr_reader :report_formatter
+
+        def initialize(report_formatter)
+          @report_formatter = report_formatter
+        end
+
+        def header(examiner)
+          if show_header?(examiner)
+            report_formatter.header examiner
+          else
+            ''
+          end
+        end
+      end
+
+      #
+      # Lists out each examiner, even if it has no smell
+      #
+      class Verbose < Base
+        def show_header?(_examiner)
+          true
+        end
+      end
+
+      #
+      # Lists only smelly examiners
+      #
+      class Quiet < Base
+        def show_header?(examiner)
+          examiner.smelly?
+        end
+      end
+    end
+  end
+end

data/lib/reek/report/location_formatter.rb

@@ -0,0 +1,35 @@
+module Reek
+  module Report
+    #
+    # Formats the location of a warning as an empty string.
+    #
+    # @api private
+    module BlankLocationFormatter
+      def self.format(_warning)
+        ''
+      end
+    end
+
+    #
+    # Formats the location of a warning as an array of line numbers.
+    #
+    # @api private
+    module DefaultLocationFormatter
+      def self.format(warning)
+        "#{warning.lines.inspect}:"
+      end
+    end
+
+    #
+    # Formats the location of a warning as a combination of source file name
+    # and line number. In this format, it is not possible to show more than
+    # one line number, so the first number is displayed.
+    #
+    # @api private
+    module SingleLineLocationFormatter
+      def self.format(warning)
+        "#{warning.source}:#{warning.lines.first}: "
+      end
+    end
+  end
+end