reek 3.2.1 → 3.3.0

data/lib/reek/configuration/configuration_file_finder.rb

@@ -18,21 +18,12 @@ module Reek
     module ConfigurationFileFinder
       module_function
 
-      def find_and_load(params = {})
-        load_from_file(find(params))
+      def find_and_load(path: nil)
+        load_from_file(find(path: path))
       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 find_by_cli(options)
-        options && options.config_file
+      def find(path: nil, current: Pathname.pwd, home: Pathname.new(Dir.home))
+        path || find_by_dir(current) || find_by_dir(home)
       end
 
       def find_by_dir(start)

data/lib/reek/configuration/configuration_validator.rb

@@ -0,0 +1,35 @@
+module Reek
+  module Configuration
+    #
+    # Configuration validator module.
+    #
+    module ConfigurationValidator
+      private
+
+      def smell_type?(key)
+        Reek::Smells.const_get key
+      rescue NameError
+        false
+      end
+
+      def error_message_for_missing_directory(pathname)
+        "Configuration error: Directory `#{pathname}` does not exist"
+      end
+
+      def error_message_for_file_given(pathname)
+        "Configuration error: `#{pathname}` is supposed to be a directory but is a file"
+      end
+
+      def validate_directory(pathname)
+        abort(error_message_for_missing_directory(pathname)) unless pathname.exist?
+        abort(error_message_for_file_given(pathname)) if pathname.file?
+      end
+
+      def with_valid_directory(path)
+        directory = Pathname.new path.to_s.chomp('/')
+        validate_directory directory
+        yield directory if block_given?
+      end
+    end
+  end
+end

data/lib/reek/configuration/default_directive.rb

@@ -0,0 +1,12 @@
+module Reek
+  module Configuration
+    #
+    # Hash extension for the default directive.
+    #
+    module DefaultDirective
+      def add(key, config)
+        self[Reek::Smells.const_get(key)] = config
+      end
+    end
+  end
+end

data/lib/reek/configuration/directory_directives.rb

@@ -0,0 +1,54 @@
+require_relative './configuration_validator'
+
+module Reek
+  module Configuration
+    #
+    # Hash extension for directory directives.
+    #
+    module DirectoryDirectives
+      include ConfigurationValidator
+
+      # Returns the directive for a given source.
+      #
+      # @param source_via [String] the source of the code inspected
+      #
+      # @return [Hash | nil] the configuration for the source or nil
+      def directive_for(source_via)
+        return unless source_via
+        source_base_dir = Pathname.new(source_via).dirname
+        hit = best_match_for source_base_dir
+        self[hit]
+      end
+
+      # Adds a directive and returns self.
+      #
+      # @param path [Pathname] the path
+      # @param config [Hash] the configuration
+      #
+      # @return [self]
+      def add(path, config)
+        with_valid_directory(path) do |directory|
+          self[directory] = config.each_with_object({}) do |(key, value), hash|
+            abort(error_message_for_invalid_smell_type(key)) unless smell_type?(key)
+            hash[Reek::Smells.const_get(key)] = value
+          end
+        end
+        self
+      end
+
+      private
+
+      def best_match_for(source_base_dir)
+        keys.
+          select { |pathname| source_base_dir.to_s.match(/#{Regexp.escape(pathname.to_s)}/) }.
+          max_by { |pathname| pathname.to_s.length }
+      end
+
+      def error_message_for_invalid_smell_type(klass)
+        "You are trying to configure smell type #{klass} but we can't find one with that name.\n" \
+          "Please make sure you spelled it right (see 'config/defaults.reek' in the reek\n" \
+          'repository for a list of all available smell types.'
+      end
+    end
+  end
+end

data/lib/reek/configuration/excluded_paths.rb

@@ -0,0 +1,18 @@
+require_relative './configuration_validator'
+
+module Reek
+  module Configuration
+    #
+    # Hash extension for excluded paths.
+    #
+    module ExcludedPaths
+      include ConfigurationValidator
+
+      def add(paths)
+        paths.each do |path|
+          with_valid_directory(path) { |directory| self << directory }
+        end
+      end
+    end
+  end
+end

data/lib/reek/context/code_context.rb

@@ -70,11 +70,11 @@ module Reek
       # @param child [CodeContext] the child context to register
       def append_child_context(child)
         child.visibility = tracked_visibility
-        @children << child
+        children << child
       end
 
       def count_statements(num)
-        @num_statements += num
+        self.num_statements += num
       end
 
       def record_call_to(exp)
@@ -83,19 +83,19 @@ module Reek
         case type
         when :lvar, :lvasgn
           unless exp.object_creation_call?
-            @refs.record_reference_to(receiver.name, line: exp.line)
+            refs.record_reference_to(receiver.name, line: exp.line)
           end
         when :self
-          @refs.record_reference_to(:self, line: exp.line)
+          refs.record_reference_to(:self, line: exp.line)
         end
       end
 
       def record_use_of_self
-        @refs.record_reference_to(:self)
+        refs.record_reference_to(:self)
       end
 
       def name
-        @exp.name
+        exp.name
       end
 
       def local_nodes(type, &blk)
@@ -103,7 +103,7 @@ module Reek
       end
 
       def each_node(type, ignoring, &blk)
-        @exp.each_node(type, ignoring, &blk)
+        exp.each_node(type, ignoring, &blk)
       end
 
       def matches?(candidates)
@@ -119,8 +119,7 @@ module Reek
       end
 
       def full_name
-        context = @context ? @context.full_name : ''
-        exp.full_name(context)
+        exp.full_name(context ? context.full_name : '')
       end
 
       def config_for(detector_class)
@@ -140,46 +139,49 @@ module Reek
       # @param names [Array<Symbol>]
       def track_visibility(visibility, names = [])
         if names.any?
-          @children.each do |child|
+          children.each do |child|
             child.visibility = visibility if names.include? child.name
           end
         else
-          @tracked_visibility = visibility
+          self.tracked_visibility = visibility
         end
       end
 
       def type
-        @exp.type
+        exp.type
       end
 
       # Iterate over +self+ and child contexts.
       def each(&block)
         yield self
-        @children.each do |child|
+        children.each do |child|
           child.each(&block)
         end
       end
 
       protected
 
-      attr_writer :visibility
+      attr_writer :num_statements, :visibility
 
       private
 
+      private_attr_writer :tracked_visibility
+      private_attr_reader :context, :refs
+
       def tracked_visibility
         @tracked_visibility ||= :public
       end
 
       def config
-        @config ||= if @exp
-                      CodeComment.new(@exp.full_comment || '').config
+        @config ||= if exp
+                      CodeComment.new(exp.full_comment || '').config
                     else
                       {}
                     end
       end
 
       def context_config_for(detector_class)
-        @context ? @context.config_for(detector_class) : {}
+        context ? context.config_for(detector_class) : {}
       end
     end
   end

data/lib/reek/examiner.rb

@@ -26,7 +26,7 @@ module Reek
     #
     def initialize(source,
                    filter_by_smells = [],
-                   configuration: Configuration::AppConfiguration.new)
+                   configuration: Configuration::AppConfiguration.default)
       @source        = Source::SourceCode.from(source)
       @configuration = configuration
       @collector     = CLI::WarningCollector.new
@@ -39,14 +39,14 @@ module Reek
     # @return [String] description of the source being analysed
     #
     def description
-      @description ||= @source.description
+      @description ||= source.description
     end
 
     #
     # @return [Array<SmellWarning>] the smells found in the source
     #
     def smells
-      @smells ||= @collector.warnings
+      @smells ||= collector.warnings
     end
 
     #
@@ -65,13 +65,15 @@ module Reek
 
     private
 
+    private_attr_reader :configuration, :collector, :smell_types, :source
+
     def run
       smell_repository = Smells::SmellRepository.new(source_description: description,
-                                                     smell_types: @smell_types,
-                                                     configuration: @configuration)
-      syntax_tree = @source.syntax_tree
+                                                     smell_types: smell_types,
+                                                     configuration: configuration)
+      syntax_tree = source.syntax_tree
       TreeWalker.new(smell_repository, syntax_tree).walk if syntax_tree
-      smell_repository.report_on(@collector)
+      smell_repository.report_on(collector)
     end
 
     def eligible_smell_types(filter_by_smells = [])

data/lib/reek/rake/task.rb

@@ -39,17 +39,17 @@ module Reek
 
       # Path to reek's config file.
       # Setting the REEK_CFG environment variable overrides this.
-      attr_writer :config_file
+      attr_accessor :config_file
 
       # Glob pattern to match source files.
       # Setting the REEK_SRC environment variable overrides this.
       # Defaults to 'lib/**/*.rb'.
-      attr_writer :source_files
+      attr_accessor :source_files
 
       # String containing commandline options to be passed to Reek.
       # Setting the REEK_OPTS environment variable overrides this value.
       # Defaults to ''.
-      attr_writer :reek_opts
+      attr_accessor :reek_opts
 
       # Whether or not to fail Rake when an error occurs (typically when smells are found).
       # Defaults to true.
@@ -60,10 +60,11 @@ module Reek
       attr_writer :verbose
 
       def initialize(name = :reek)
+        @config_file   = ENV['REEK_CFG']
         @name          = name
-        @reek_opts     = ''
+        @reek_opts     = ENV['REEK_OPTS'] || ''
         @fail_on_error = true
-        @source_files  = 'lib/**/*.rb'
+        @source_files  = FileList[ENV['REEK_SRC'] || 'lib/**/*.rb']
         @verbose       = false
 
         yield self if block_given?
@@ -72,15 +73,17 @@ module Reek
 
       private
 
+      private_attr_reader :fail_on_error, :name, :verbose
+
       def define_task
         desc 'Check for code smells'
-        task(@name) { run_task }
+        task(name) { run_task }
       end
 
       def run_task
-        puts "\n\n!!! Running 'reek' rake command: #{command}\n\n" if @verbose
+        puts "\n\n!!! Running 'reek' rake command: #{command}\n\n" if verbose
         system(*command)
-        abort("\n\n!!! `reek` has found smells - exiting!") if sys_call_failed? && @fail_on_error
+        abort("\n\n!!! `reek` has found smells - exiting!") if sys_call_failed? && fail_on_error
       end
 
       def command
@@ -89,25 +92,12 @@ module Reek
           reject(&:empty?)
       end
 
-      def source_files
-        FileList[ENV['REEK_SRC'] || @source_files]
-      end
-
-      def reek_opts
-        ENV['REEK_OPTS'] || @reek_opts
-      end
-
-      def config_file
-        ENV['REEK_CFG'] || @config_file
-      end
-
       def sys_call_failed?
         !$CHILD_STATUS.success?
       end
 
       def config_file_as_argument
-        return [] unless @config_file
-        ['-c', @config_file]
+        config_file ? ['-c', config_file] : []
       end
 
       def reek_opts_as_arguments

data/lib/reek/report/formatter.rb

@@ -1,3 +1,4 @@
+require 'private_attr/everywhere'
 require_relative 'location_formatter'
 
 module Reek
@@ -35,7 +36,7 @@ module Reek
       end
 
       def format(warning)
-        "#{@location_formatter.format(warning)}#{base_format(warning)}"
+        "#{location_formatter.format(warning)}#{base_format(warning)}"
       end
 
       private
@@ -43,6 +44,10 @@ module Reek
       def base_format(warning)
         "#{warning.context} #{warning.message} (#{warning.smell_type})"
       end
+
+      private
+
+      private_attr_reader :location_formatter
     end
 
     #

data/lib/reek/report/report.rb

@@ -30,8 +30,8 @@ module Reek
       #
       # @param [Reek::Examiner] examiner object to report on
       def add_examiner(examiner)
-        @total_smell_count += examiner.smells_count
-        @examiners << examiner
+        self.total_smell_count += examiner.smells_count
+        examiners << examiner
         self
       end
 
@@ -42,13 +42,22 @@ module Reek
 
       # @api private
       def smells?
-        @total_smell_count > 0
+        total_smell_count > 0
       end
 
       # @api private
       def smells
-        @examiners.map(&:smells).flatten
+        examiners.map(&:smells).flatten
       end
+
+      protected
+
+      attr_accessor :total_smell_count
+
+      private
+
+      private_attr_reader :examiners, :options, :report_formatter,
+                          :sort_by_issue_count, :warning_formatter
     end
 
     #
@@ -64,7 +73,7 @@ module Reek
       private
 
       def smell_summaries
-        @examiners.map { |ex| summarize_single_examiner(ex) }.reject(&:empty?)
+        examiners.map { |ex| summarize_single_examiner(ex) }.reject(&:empty?)
       end
 
       def display_summary
@@ -72,33 +81,33 @@ module Reek
       end
 
       def display_total_smell_count
-        return unless @examiners.size > 1
+        return unless examiners.size > 1
         print total_smell_count_message
       end
 
       def summarize_single_examiner(examiner)
         result = heading_formatter.header(examiner)
         if examiner.smelly?
-          formatted_list = @report_formatter.format_list(examiner.smells,
-                                                         @warning_formatter)
+          formatted_list = report_formatter.format_list(examiner.smells,
+                                                        warning_formatter)
           result += ":\n#{formatted_list}"
         end
         result
       end
 
       def sort_examiners
-        @examiners.sort_by!(&:smells_count).reverse! if @sort_by_issue_count
+        examiners.sort_by!(&:smells_count).reverse! if sort_by_issue_count
       end
 
       def total_smell_count_message
         colour = smells? ? WARNINGS_COLOR : NO_WARNINGS_COLOR
-        s = @total_smell_count == 1 ? '' : 's'
-        Rainbow("#{@total_smell_count} total warning#{s}\n").color(colour)
+        s = total_smell_count == 1 ? '' : 's'
+        Rainbow("#{total_smell_count} total warning#{s}\n").color(colour)
       end
 
       def heading_formatter
         @heading_formatter ||=
-          @options.fetch(:heading_formatter, HeadingFormatter::Quiet).new(@report_formatter)
+          options.fetch(:heading_formatter, HeadingFormatter::Quiet).new(report_formatter)
       end
     end
 
@@ -118,7 +127,7 @@ module Reek
       def show
         print ::JSON.generate(
           smells.map do |smell|
-            smell.yaml_hash(@warning_formatter)
+            smell.yaml_hash(warning_formatter)
           end
         )
       end