reek 2.0.4 → 3.0.0

data/lib/reek/cli/options.rb

@@ -1,19 +1,22 @@
 require 'optparse'
 require 'ostruct'
 require 'rainbow'
-require 'reek/cli/option_interpreter'
-require 'reek/version'
+require_relative 'option_interpreter'
+require_relative '../version'
 
 module Reek
-  module Cli
+  module CLI
     #
     # Parses the command line
     #
+    # See {file:docs/Command-Line-Options.md} for details.
+    # @api private
     class Options
-      def initialize(argv)
+      def initialize(argv = [])
         @argv    = argv
         @parser  = OptionParser.new
-        @options = OpenStruct.new(colored: true, smells_to_detect: [])
+        @options = OpenStruct.new(colored: color_support?,
+                                  smells_to_detect: [])
         set_up_parser
       end
 
@@ -26,6 +29,10 @@ module Reek
 
       private
 
+      def color_support?
+        $stdout.tty?
+      end
+
       def set_up_parser
         set_banner
         set_configuration_options
@@ -53,9 +60,9 @@ module Reek
       def set_alternative_formatter_options
         @parser.separator "\nReport format:"
         @parser.on(
-          '-f', '--format FORMAT', [:html, :text, :yaml, :json],
+          '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml],
           'Report smells in the given format:',
-          '  html', '  text (default)', '  yaml', '  json'
+          '  html', '  text (default)', '  yaml', '  json', '  xml'
         ) do |opt|
           @options.report_format = opt
         end
@@ -64,7 +71,8 @@ module Reek
       def set_configuration_options
         @parser.separator 'Configuration:'
         @parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
-          @options.config_file = file
+          raise ArgumentError, "Config file #{file} doesn't exist" unless File.exist?(file)
+          @options.config_file = Pathname.new(file)
         end
         @parser.on('--smell SMELL', 'Detect smell SMELL (default: all enabled smells)') do |smell|
           @options.smells_to_detect << smell

data/lib/reek/cli/reek_command.rb

@@ -1,12 +1,13 @@
-require 'reek/cli/command'
-require 'reek/examiner'
+require_relative 'command'
+require_relative '../examiner'
 
 module Reek
-  module Cli
+  module CLI
     #
     # A command to collect smells from a set of sources and write them out in
     # text report format.
     #
+    # @api private
     class ReekCommand < Command
       def execute(app)
         @options.sources.each do |source|

data/lib/reek/cli/silencer.rb

@@ -0,0 +1,14 @@
+module Reek
+  module CLI
+    # CLI silencer
+    # @api private
+    module Silencer
+      def self.silently
+        old_verbose, $VERBOSE = $VERBOSE, nil
+        yield if block_given?
+      ensure
+        $VERBOSE = old_verbose
+      end
+    end
+  end
+end

data/lib/reek/{core → cli}/warning_collector.rb

@@ -1,10 +1,11 @@
 require 'set'
 
 module Reek
-  module Core
+  module CLI
     #
     # Collects and sorts smells warnings.
     #
+    # @api private
     class WarningCollector
       def initialize
         @warnings = Set.new

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
@@ -15,7 +20,7 @@ module Reek
 
         def initialize_with(options)
           @has_been_initialized = true
-          configuration_file_path = ConfigurationFileFinder.find(options)
+          configuration_file_path = ConfigurationFileFinder.find(options: options)
           return unless configuration_file_path
           load_from_file configuration_file_path
         end
@@ -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,42 +13,28 @@ module Reek
     #
     # The order in which ConfigurationFileFinder tries to find such a
     # configuration file is exactly like above.
+    # @api private
     module ConfigurationFileFinder
-      class << self
-        def find(options)
-          configuration_by_cli(options) ||
-            configuration_in_file_system    ||
-            configuration_in_home_directory
-        end
-
-        private
-
-        def configuration_by_cli(options)
-          return unless options # Return gracefully allowing calls without app context
-          config_file_option = options.config_file
-          return unless config_file_option
-          path_name = Pathname.new config_file_option
-          raise ArgumentError, "Config file #{path_name} doesn't exist" unless path_name.exist?
-          path_name
-        end
-
-        def configuration_in_file_system
-          detect_or_traverse_up Pathname.pwd
-        end
+      module_function
 
-        def configuration_in_home_directory
-          detect_configuration_in_directory Pathname.new(Dir.home)
-        end
+      # FIXME: switch to kwargs on upgrade to Ruby 2 and drop `params.fetch` calls:
+      # def find(options: nil, current: Pathname.pwd, home: Pathname.new(Dir.home))
+      def find(params = {})
+        options = params.fetch(:options) { nil                    }
+        current = params.fetch(:current) { Pathname.pwd           }
+        home    = params.fetch(:home)    { Pathname.new(Dir.home) }
+        find_by_cli(options) || find_by_dir(current) || find_by_dir(home)
+      end
 
-        def detect_or_traverse_up(directory)
-          file = detect_configuration_in_directory(directory)
-          return file unless file.nil?
-          return if directory.root?
-          detect_or_traverse_up directory.parent
-        end
+      def find_by_cli(options)
+        options && options.config_file
+      end
 
-        def detect_configuration_in_directory(directory)
-          directory.children.select(&:file?).find { |path| path.to_s.end_with?('.reek') }
+      def find_by_dir(start)
+        start.ascend do |dir|
+          files = dir.children.select(&:file?).sort
+          found = files.find { |file| file.to_s.end_with?('.reek') }
+          return found if found
         end
       end
     end

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

@@ -1,19 +1,21 @@
+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
 
       # Initializes a new CodeContext.
       #
       # context - *_context from the `core` namespace
-      # exp - Reek::Source::AstNode
+      # exp - Reek::Source::ASTNode
       #
       # Examples:
       #
@@ -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
-                      Source::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 'reek/core/code_context'
-require 'reek/core/object_refs'
+require_relative 'code_context'
+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,17 +20,18 @@ 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
       attr_reader :num_statements
 
       def initialize(outer, exp)
-        super(outer, exp)
+        super
         @parameters = exp.parameters.dup
         @parameters.extend MethodParameters
         @num_statements = 0
-        @refs = ObjectRefs.new
+        @refs = AST::ObjectRefs.new
       end
 
       def count_statements(num)
@@ -58,6 +60,10 @@ module Reek
         @refs.max_keys
       end
 
+      def references_self?
+        exp.depends_on_instance?
+      end
+
       def uses_param?(param)
         local_nodes(:lvar).find { |node| node.var_name == param.to_sym }
       end

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

@@ -1,20 +1,25 @@
-require 'reek/core/code_context'
-require 'reek/source/sexp_formatter'
+require_relative 'code_context'
+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 = Source::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,15 +1,12 @@
-require 'reek/core/method_context'
+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 initialize(outer, exp)
-        super(outer, exp)
-      end
-
       def envious_receivers
         []
       end

data/lib/reek/examiner.rb

@@ -1,55 +1,60 @@
-require 'reek/source/source_repository'
-require 'reek/core/warning_collector'
-require 'reek/core/smell_repository'
-require 'reek/core/tree_walker'
+# 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
-    #
-    # A simple description of the source being analysed for smells.
-    # If the source is a single File, this will be the file's path.
-    #
-    attr_accessor :description
-
     #
     # Creates an Examiner which scans the given +source+ for code smells.
     #
-    # @param [Source::SourceCode, Array<String>, #to_reek_source]
+    # @param source [File, IO, String]
     #   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;
-    #   and if it is an Array, it is assumed to be a list of file paths,
-    #   each of which is opened and parsed for 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 = [])
-      @sources      = Source::SourceRepository.parse(source)
-      @description  = @sources.description
-      @collector    = Core::WarningCollector.new
+      @source       = Source::SourceCode.from(source)
+      @collector    = CLI::WarningCollector.new
       @smell_types  = eligible_smell_types(smell_types_to_filter_by)
 
       run
     end
 
     #
-    # List the smells found in the source.
+    # @return [String] description of the source being analysed
     #
-    # @return [Array<SmellWarning>]
+    def description
+      @description ||= @source.description
+    end
+
+    #
+    # @return [Array<SmellWarning>] the smells found in the source
     #
     def smells
       @smells ||= @collector.warnings
     end
 
     #
-    # Returns the number of smells found in the source
+    # @return [Integer] the number of smells found in the source
     #
     def smells_count
       smells.length
     end
 
     #
-    # True if and only if there are code smells in the source.
+    # @return [Boolean] true if and only if there are code smells in the source.
     #
     def smelly?
       !smells.empty?
@@ -58,21 +63,19 @@ module Reek
     private
 
     def run
-      @sources.each do |source|
-        smell_repository = Core::SmellRepository.new(source.desc, @smell_types)
-        syntax_tree = source.syntax_tree
-        Core::TreeWalker.new(smell_repository).process(syntax_tree) if syntax_tree
-        smell_repository.report_on(@collector)
-      end
+      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?
-        Core::SmellRepository.smell_types.select do |klass|
+        Smells::SmellRepository.smell_types.select do |klass|
           smell_types_to_filter_by.include? klass.smell_type
         end
       else
-        Core::SmellRepository.smell_types
+        Smells::SmellRepository.smell_types
       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