reek 1.5.1 → 1.6.0

data/lib/reek/cli/reek_command.rb

@@ -9,8 +9,8 @@ module Reek
     #
     class ReekCommand < Command
       def execute(app)
-        @parser.sources.each do |source|
-          reporter.add_examiner(Examiner.new(source, config_files, smell_names))
+        @options.sources.each do |source|
+          reporter.add_examiner Examiner.new(source, smell_names)
         end
         reporter.smells? ? app.report_smells : app.report_success
         reporter.show
@@ -19,15 +19,11 @@ module Reek
       private
 
       def reporter
-        @reporter ||= @parser.reporter
+        @reporter ||= @options.reporter
       end
 
       def smell_names
-        @smell_names ||= @parser.smells_to_detect
-      end
-
-      def config_files
-        @config_files ||= @parser.config_files
+        @smell_names ||= @options.smells_to_detect
       end
     end
   end

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

@@ -10,7 +10,8 @@ module Reek
 
         def self.header(examiner)
           count = examiner.smells_count
-          result = Rainbow("#{examiner.description} -- ").cyan + Rainbow("#{count} warning").yellow
+          result = Rainbow("#{examiner.description} -- ").cyan +
+                   Rainbow("#{count} warning").yellow
           result += Rainbow('s').yellow unless count == 1
           result
         end
@@ -22,11 +23,12 @@ module Reek
         module_function
 
         def format(warning)
-          "#{WarningFormatterWithLineNumbers.format(warning)} [#{explanatory_link(warning)}]"
+          "#{WarningFormatterWithLineNumbers.format(warning)} " \
+          "[#{explanatory_link(warning)}]"
         end
 
         def explanatory_link(warning)
-          "#{BASE_URL_FOR_HELP_LINK}#{class_name_to_param(warning.subclass)}"
+          "#{BASE_URL_FOR_HELP_LINK}#{class_name_to_param(warning.smell_type)}"
         end
 
         def class_name_to_param(name)
@@ -36,7 +38,7 @@ module Reek
 
       module SimpleWarningFormatter
         def self.format(warning)
-          "#{warning.context} #{warning.message} (#{warning.subclass})"
+          "#{warning.context} #{warning.message} (#{warning.smell_type})"
         end
       end
 
@@ -48,7 +50,8 @@ module Reek
 
       module SingleLineWarningFormatter
         def self.format(warning)
-          "#{warning.source}:#{warning.lines.first}: #{SimpleWarningFormatter.format(warning)}"
+          "#{warning.source}:#{warning.lines.first}: " \
+          "#{SimpleWarningFormatter.format(warning)}"
         end
       end
     end

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

@@ -58,12 +58,13 @@ module Reek
         end
 
         def sort_examiners
-          @examiners.sort! { |first, second| second.smells_count <=> first.smells_count } 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
-          Rainbow("#{@total_smell_count} total warning#{'s' unless @total_smell_count == 1 }\n").color(colour)
+          s = @total_smell_count == 1 ? '' : 's'
+          Rainbow("#{@total_smell_count} total warning#{s}\n").color(colour)
         end
       end
 
@@ -92,11 +93,11 @@ module Reek
 
         require 'erb'
 
-        TEMPLATE = File.read(File.expand_path('../../../../../assets/html_output.html.erb', __FILE__))
-
         def show
+          path = File.expand_path('../../../../../assets/html_output.html.erb',
+                                  __FILE__)
           File.open('reek.html', 'w+') do |file|
-            file.puts ERB.new(TEMPLATE).result(binding)
+            file.puts ERB.new(File.read(path)).result(binding)
           end
           print("Html file saved\n")
         end

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

@@ -18,7 +18,8 @@ module Reek
           def summarize_single_examiner(examiner)
             result = report_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
@@ -54,7 +55,7 @@ module Reek
         class Normal < Base
           def gather_results
             examiners.each_with_object([]) { |examiner, smells| smells << examiner.smells }.
-                             flatten
+              flatten
           end
         end
       end

data/lib/reek/cli/version_command.rb

@@ -8,7 +8,7 @@ module Reek
     #
     class VersionCommand < Command
       def execute(view)
-        view.output("#{@parser.program_name} #{Reek::VERSION}\n")
+        view.output("#{@options.program_name} #{Reek::VERSION}\n")
         view.report_success
       end
     end

data/lib/reek/configuration/app_configuration.rb

@@ -0,0 +1,75 @@
+require_relative './configuration_file_finder'
+
+module Reek
+  module Configuration
+    class ConfigFileException < StandardError; end
+    #
+    # Reeks singleton configuration instance.
+    #
+    module AppConfiguration
+      @configuration = {}
+      @has_been_initialized = false
+
+      class << self
+        attr_reader :configuration
+
+        def initialize_with(application)
+          @has_been_initialized = true
+          configuration_file_path = ConfigurationFileFinder.find(application)
+          return unless configuration_file_path
+          load_from_file configuration_file_path
+        end
+
+        def configure_smell_repository(smell_repository)
+          # 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|
+            klass = load_smell_type(klass_name)
+            smell_repository.configure(klass, config) if klass
+          end
+        end
+
+        def load_from_file(path)
+          if File.size(path) == 0
+            report_problem('Empty file', path)
+            return
+          end
+
+          begin
+            @configuration = YAML.load_file(path) || {}
+          rescue => error
+            raise_error(error.to_s, path)
+          end
+
+          raise_error('Not a hash', path) unless @configuration.is_a? Hash
+        end
+
+        def reset
+          @configuration.clear
+        end
+
+        private
+
+        def load_smell_type(name)
+          Reek::Smells.const_get(name)
+        rescue NameError
+          report_problem("\"#{name}\" is not a code smell")
+          nil
+        end
+
+        def report_problem(reason, path)
+          $stderr.puts "Warning: #{message(reason, path)}"
+        end
+
+        def raise_error(reason, path)
+          raise ConfigFileException, message(reason, path)
+        end
+
+        def message(reason, path)
+          "Invalid configuration file \"#{File.basename(path)}\" -- #{reason}"
+        end
+      end
+    end
+  end
+end

data/lib/reek/configuration/configuration_file_finder.rb

@@ -0,0 +1,56 @@
+require 'pathname'
+
+module Reek
+  module Configuration
+    #
+    # ConfigurationFileFinder is responsible for finding reeks configuration.
+    #
+    # There are 3 ways of passing `reek` a configuration file:
+    # 1. Using the cli "-c" switch (see "Command line interface" above)
+    # 2. Having a file ending with .reek either in your current working directory or in a parent
+    #    directory
+    # 3. Having a file ending with .reek in your HOME directory
+    #
+    # The order in which ConfigurationFileFinder tries to find such a configuration file is exactly
+    # like above.
+    module ConfigurationFileFinder
+      class << self
+        def find(application)
+          configuration_by_cli(application) ||
+            configuration_in_file_system    ||
+            configuration_in_home_directory
+        end
+
+        private
+
+        def configuration_by_cli(application)
+          return unless application # Return gracefully allowing calls without app context
+          config_file_option = application.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
+
+        def configuration_in_home_directory
+          detect_configuration_in_directory Pathname.new(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 detect_configuration_in_directory(directory)
+          Pathname.glob(directory.join('*.reek')).detect(&:file?)
+        end
+      end
+    end
+  end
+end

data/lib/reek/core/code_context.rb

@@ -19,12 +19,8 @@ module Reek
         @exp.name
       end
 
-      def node_instance_methods
-        local_nodes(:def)
-      end
-
       def local_nodes(type, &blk)
-        each_node(type, [:class, :module], &blk)
+        each_node(type, [:casgn, :class, :module], &blk)
       end
 
       def each_node(type, ignoring, &blk)
@@ -55,7 +51,7 @@ module Reek
 
       def config_for(detector_class)
         outer_config_for(detector_class).merge(
-          config[detector_class.smell_class_name] || {})
+          config[detector_class.smell_type] || {})
       end
 
       private

data/lib/reek/core/module_context.rb

@@ -11,6 +11,10 @@ module Reek
         super(outer, exp)
         @name = Source::SexpFormatter.format(exp.children.first)
       end
+
+      def node_instance_methods
+        local_nodes(:def)
+      end
     end
   end
 end

data/lib/reek/core/smell_repository.rb

@@ -6,7 +6,9 @@ module Reek
     # Contains all the existing smells and exposes operations on them.
     #
     class SmellRepository
-      def self.smell_classes
+      attr_reader :detectors
+
+      def self.smell_types
         # SMELL: Duplication -- these should be loaded by listing the files
         [
           Smells::Attribute,
@@ -36,10 +38,10 @@ module Reek
         ]
       end
 
-      def initialize(source_description, smell_classes = SmellRepository.smell_classes)
+      def initialize(source_description, smell_types = SmellRepository.smell_types)
         @typed_detectors = nil
         @detectors = {}
-        smell_classes.each do |klass|
+        smell_types.each do |klass|
           @detectors[klass] = klass.new(source_description)
         end
       end

data/lib/reek/core/sniffer.rb

@@ -1,6 +1,6 @@
 require 'reek/core/code_parser'
 require 'reek/core/smell_repository'
-require 'reek/source/config_file'
+require 'reek/configuration/app_configuration'
 
 module Reek
   module Core
@@ -8,24 +8,28 @@ module Reek
     # Configures all available smell detectors and applies them to a source.
     #
     class Sniffer
-      def initialize(src,
-                     extra_config_files = [],
-                     smell_repository = Core::SmellRepository.new(src.desc))
+      def initialize(source, # Either Source::SourceFile or Source::SourceCode
+                     smell_repository = Core::SmellRepository.new(source.desc))
         @smell_repository = smell_repository
-        @source = src
+        @source = source
 
-        config_files = extra_config_files + @source.relevant_config_files
-        config_files.each { |cf| Reek::Source::ConfigFile.new(cf).configure(@smell_repository) }
+        Configuration::AppConfiguration.configure_smell_repository(@smell_repository)
       end
 
       def report_on(listener)
-        CodeParser.new(@smell_repository).process(@source.syntax_tree)
+        CodeParser.new(@smell_repository).process(syntax_tree) if syntax_tree
         @smell_repository.report_on(listener)
       end
 
       def examine(scope, node_type)
         @smell_repository.examine scope, node_type
       end
+
+      private
+
+      def syntax_tree
+        @syntax_tree ||= @source.syntax_tree
+      end
     end
   end
 end

data/lib/reek/examiner.rb

@@ -25,19 +25,20 @@ module Reek
     #   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.
     #
-    def initialize(source, config_files = [], smell_names = [])
+    def initialize(source, smell_types_to_filter_by = [])
       sources = Source::SourceRepository.parse(source)
       @description = sources.description
       @collector = Core::WarningCollector.new
 
-      smell_classes = Core::SmellRepository.smell_classes
-      if smell_names.any?
-        smell_classes.select! { |klass| smell_names.include? klass.smell_class_name }
+      smell_types = Core::SmellRepository.smell_types
+
+      if smell_types_to_filter_by.any?
+        smell_types.select! { |klass| smell_types_to_filter_by.include? klass.smell_type }
       end
 
       sources.each do |src|
-        repository = Core::SmellRepository.new(src.desc, smell_classes)
-        Core::Sniffer.new(src, config_files, repository).report_on(@collector)
+        repository = Core::SmellRepository.new(src.desc, smell_types)
+        Core::Sniffer.new(src, repository).report_on(@collector)
       end
     end
 

data/lib/reek/rake/task.rb

@@ -42,7 +42,7 @@ module Reek
       # Glob pattern to match config files.
       # Setting the REEK_CFG environment variable overrides this.
       # Defaults to 'config/**/*.reek'.
-      attr_accessor :config_files
+      attr_accessor :config_file
 
       # Glob pattern to match source files.
       # Setting the REEK_SRC environment variable overrides this.
@@ -69,7 +69,7 @@ module Reek
       def initialize(name = :reek)
         @name = name
         @libs = [File.expand_path(File.dirname(__FILE__) + '/../../../lib')]
-        @config_files = nil
+        @config_file = nil
         @source_files = nil
         @ruby_opts = []
         @reek_opts = ''
@@ -77,7 +77,7 @@ module Reek
         @sort = nil
 
         yield self if block_given?
-        @config_files ||= 'config/**/*.reek'
+        @config_file ||= Pathname.glob('config/**/*.reek').detect(&:file?)
         @source_files ||= 'lib/**/*.rb'
         define
       end
@@ -103,17 +103,15 @@ module Reek
 
       def cmd_words
         [Task.ruby_exe] +
-            ruby_options +
-            [%(reek)] +
-            [sort_option] +
-            config_file_list.map { |fn| ['-c', %("#{fn}")] }.flatten +
-            source_file_list.map { |fn| %("#{fn}") }
+          ruby_options +
+          [%(reek)] +
+          [sort_option] +
+          ['-c', config_file] +
+          source_file_list.map { |fn| %("#{fn}") }
       end
 
-      def config_file_list
-        files = ENV['REEK_CFG'] || @config_files
-        return [] unless files
-        FileList[files]
+      def config_file
+        ENV['REEK_CFG'] || @config_file
       end
 
       def ruby_options