reek 3.2.1 → 3.3.0

data/lib/reek/cli/option_interpreter.rb

@@ -13,11 +13,11 @@ module Reek
 
       extend Forwardable
 
-      def_delegators :@options, :smells_to_detect
+      def_delegators :options, :smells_to_detect
 
       def initialize(options)
         @options = options
-        @argv = @options.argv
+        @argv = options.argv
       end
 
       def reporter
@@ -30,7 +30,7 @@ module Reek
       end
 
       def report_class
-        Report.report_class(@options.report_format)
+        Report.report_class(options.report_format)
       end
 
       def warning_formatter
@@ -38,20 +38,24 @@ module Reek
       end
 
       def warning_formatter_class
-        Report.warning_formatter_class(@options.show_links ? :wiki_links : :simple)
+        Report.warning_formatter_class(options.show_links ? :wiki_links : :simple)
       end
 
       def location_formatter
-        Report.location_formatter(@options.location_format)
+        Report.location_formatter(options.location_format)
       end
 
       def heading_formatter
-        Report.heading_formatter(@options.show_empty ? :verbose : :quiet)
+        Report.heading_formatter(options.show_empty ? :verbose : :quiet)
       end
 
       def sort_by_issue_count
-        @options.sorting == :smelliness
+        options.sorting == :smelliness
       end
+
+      private
+
+      private_attr_reader :argv, :options
     end
   end
 end

data/lib/reek/cli/options.rb

@@ -23,14 +23,16 @@ module Reek
       end
 
       def parse
-        @parser.parse!(@argv)
-        @options.argv = @argv
-        Rainbow.enabled = @options.colored
-        @options
+        parser.parse!(argv)
+        options.argv = argv
+        Rainbow.enabled = options.colored
+        options
       end
 
       private
 
+      private_attr_reader :argv, :options, :parser
+
       def color_support?
         $stdout.tty?
       end
@@ -44,8 +46,8 @@ module Reek
       end
 
       def set_banner
-        program_name = @parser.program_name
-        @parser.banner = <<-EOB.gsub(/^[ ]+/, '')
+        program_name = parser.program_name
+        parser.banner = <<-EOB.gsub(/^[ ]+/, '')
           Usage: #{program_name} [options] [files]
 
           Examples:
@@ -60,29 +62,29 @@ module Reek
       end
 
       def set_alternative_formatter_options
-        @parser.separator "\nReport format:"
-        @parser.on(
+        parser.separator "\nReport format:"
+        parser.on(
           '-f', '--format FORMAT', [:html, :text, :yaml, :json, :xml],
           'Report smells in the given format:',
           '  html', '  text (default)', '  yaml', '  json', '  xml'
         ) do |opt|
-          @options.report_format = opt
+          options.report_format = opt
         end
       end
 
       def set_configuration_options
-        @parser.separator 'Configuration:'
-        @parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
+        parser.separator 'Configuration:'
+        parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
           raise ArgumentError, "Config file #{file} doesn't exist" unless File.exist?(file)
-          @options.config_file = Pathname.new(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
+        parser.on('--smell SMELL', 'Detect smell SMELL (default: all enabled smells)') do |smell|
+          options.smells_to_detect << smell
         end
       end
 
       def set_report_formatting_options
-        @parser.separator "\nText format options:"
+        parser.separator "\nText format options:"
         set_up_color_option
         set_up_verbosity_options
         set_up_location_formatting_options
@@ -90,50 +92,50 @@ module Reek
       end
 
       def set_up_color_option
-        @parser.on('--[no-]color', 'Use colors for the output (default: true)') do |opt|
-          @options.colored = opt
+        parser.on('--[no-]color', 'Use colors for the output (default: true)') do |opt|
+          options.colored = opt
         end
       end
 
       def set_up_verbosity_options
-        @parser.on('-V', '--[no-]empty-headings',
-                   'Show headings for smell-free source files (default: false)') do |show_empty|
-          @options.show_empty = show_empty
+        parser.on('-V', '--[no-]empty-headings',
+                  'Show headings for smell-free source files (default: false)') do |show_empty|
+          options.show_empty = show_empty
         end
-        @parser.on('-U', '--[no-]wiki-links',
-                   'Show link to related wiki page for each smell (default: false)') do |show_links|
-          @options.show_links = show_links
+        parser.on('-U', '--[no-]wiki-links',
+                  'Show link to related wiki page for each smell (default: false)') do |show_links|
+          options.show_links = show_links
         end
       end
 
       def set_up_location_formatting_options
-        @parser.on('-n', '--[no-]line-numbers',
-                   'Show line numbers in the output (default: true)') do |show_numbers|
-          @options.location_format = show_numbers ? :numbers : :plain
+        parser.on('-n', '--[no-]line-numbers',
+                  'Show line numbers in the output (default: true)') do |show_numbers|
+          options.location_format = show_numbers ? :numbers : :plain
         end
-        @parser.on('-s', '--single-line',
-                   'Show location in editor-compatible single-line-per-smell format') do
-          @options.location_format = :single_line
+        parser.on('-s', '--single-line',
+                  'Show location in editor-compatible single-line-per-smell format') do
+          options.location_format = :single_line
         end
       end
 
       def set_up_sorting_option
-        @parser.on('--sort-by SORTING', [:smelliness, :none],
-                   'Sort reported files by the given criterium:',
-                   '  smelliness ("smelliest" files first)',
-                   '  none (default - output in processing order)') do |sorting|
-                     @options.sorting = sorting
-                   end
+        parser.on('--sort-by SORTING', [:smelliness, :none],
+                  'Sort reported files by the given criterium:',
+                  '  smelliness ("smelliest" files first)',
+                  '  none (default - output in processing order)') do |sorting|
+          options.sorting = sorting
+        end
       end
 
       def set_utility_options
-        @parser.separator "\nUtility options:"
-        @parser.on_tail('-h', '--help', 'Show this message') do
-          puts @parser
+        parser.separator "\nUtility options:"
+        parser.on_tail('-h', '--help', 'Show this message') do
+          puts parser
           exit
         end
-        @parser.on_tail('-v', '--version', 'Show version') do
-          puts "#{@parser.program_name} #{Reek::Version::STRING}\n"
+        parser.on_tail('-v', '--version', 'Show version') do
+          puts "#{parser.program_name} #{Reek::Version::STRING}\n"
           exit
         end
       end

data/lib/reek/cli/reek_command.rb

@@ -10,7 +10,7 @@ module Reek
     # @api private
     class ReekCommand < Command
       def execute(app)
-        @options.sources.each do |source|
+        options.sources.each do |source|
           reporter.add_examiner Examiner.new(source, smell_names, configuration: app.configuration)
         end
         reporter.smells? ? app.report_smells : app.report_success
@@ -20,11 +20,11 @@ module Reek
       private
 
       def reporter
-        @reporter ||= @options.reporter
+        @reporter ||= options.reporter
       end
 
       def smell_names
-        @smell_names ||= @options.smells_to_detect
+        @smell_names ||= options.smells_to_detect
       end
     end
   end

data/lib/reek/cli/silencer.rb

@@ -1,13 +1,22 @@
+require 'stringio'
+
 module Reek
   module CLI
     # CLI silencer
     # @api private
     module Silencer
-      def self.silently
-        old_verbose, $VERBOSE = $VERBOSE, nil
-        yield if block_given?
+      module_function
+
+      def silently(stderr: nil, stdout: nil)
+        old_verbose = $VERBOSE
+        $VERBOSE = false
+        $stderr = StringIO.new if stderr
+        $stdout = StringIO.new if stdout
+        yield
       ensure
         $VERBOSE = old_verbose
+        $stderr = STDERR
+        $stdout = STDOUT
       end
     end
   end

data/lib/reek/cli/warning_collector.rb

@@ -1,3 +1,4 @@
+require 'private_attr/everywhere'
 require 'set'
 
 module Reek
@@ -8,16 +9,20 @@ module Reek
     # @api private
     class WarningCollector
       def initialize
-        @warnings = Set.new
+        @warnings_set = Set.new
       end
 
       def found_smell(warning)
-        @warnings.add(warning)
+        warnings_set.add(warning)
       end
 
       def warnings
-        @warnings.to_a.sort
+        warnings_set.to_a.sort
       end
+
+      private
+
+      private_attr_reader :warnings_set
     end
   end
 end

data/lib/reek/code_comment.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'private_attr/everywhere'
 
 module Reek
   #
@@ -21,7 +22,7 @@ module Reek
     end
 
     def descriptive?
-      @text.split(/\s+/).length >= 2
+      text.split(/\s+/).length >= 2
     end
 
     protected
@@ -32,5 +33,9 @@ module Reek
       # TODO: extend this to all configs -------------------^
       # TODO: extend to allow configuration of whole smell class, not just subclass
     end
+
+    private
+
+    private_attr_reader :text
   end
 end

data/lib/reek/configuration/app_configuration.rb

@@ -1,5 +1,10 @@
 require 'pathname'
+require 'private_attr/everywhere'
 require_relative './configuration_file_finder'
+require_relative './configuration_validator'
+require_relative './default_directive'
+require_relative './directory_directives'
+require_relative './excluded_paths'
 
 module Reek
   # @api private
@@ -10,135 +15,95 @@ module Reek
     #
     # @api private
     class AppConfiguration
+      include ConfigurationValidator
       EXCLUDE_PATHS_KEY = 'exclude_paths'
-      attr_reader :exclude_paths, :default_directive, :directory_directives
+      private_attr_writer :directory_directives, :default_directive, :excluded_paths
 
-      # Given this configuration file:
+      # Instantiate a configuration via given path.
       #
-      # ---
-      # IrresponsibleModule:
-      #   enabled: false
-      # "app/helpers":
-      #   UtilityFunction:
-      #     enabled: false
-      # exclude_paths:
-      #   - "app/controllers"
+      # @param path [Pathname] the path to the config file
       #
-      # this would result in the following configuration:
-      #
-      # exclude_paths = [ Pathname('spec/samples/two_smelly_files') ]
-      # default_directive = { Reek::Smells::IrresponsibleModule => { "enabled" => false } }
-      # directory_directives = { Pathname("spec/samples/three_clean_files/") =>
-      #                          { Reek::Smells::UtilityFunction => { "enabled" => false } } }
+      # @return [AppConfiguration]
+      def self.from_path(path = nil)
+        allocate.tap do |instance|
+          instance.instance_eval { find_and_load(path: path) }
+        end
+      end
+
+      # Instantiate a configuration by passing everything in.
       #
+      # @param map [Hash] can have the following 3 keys:
+      # 1.) directory_directives [Hash] for instance:
+      #   { Pathname("spec/samples/three_clean_files/") =>
+      #     { Reek::Smells::UtilityFunction => { "enabled" => false } } }
+      # 2.) default_directive [Hash] for instance:
+      #   { Reek::Smells::IrresponsibleModule => { "enabled" => false } }
+      # 3.) excluded_paths [Array] for instance:
+      #   [ Pathname('spec/samples/two_smelly_files') ]
       #
-      # @param options [OpenStruct]
-      #   e.g.: #<OpenStruct report_format =: text,
-      #                      location_format =: numbers,
-      #                      colored = true,
-      #                      smells_to_detect = [],
-      #                      config_file = #<Pathname:config/defaults.reek>,
-      #                      argv = [ "lib/reek/spec" ]>
-      def initialize(options = nil)
-        @directory_directives = {}
-        @default_directive    = {}
-        @exclude_paths        = []
+      # @return [AppConfiguration]
+      def self.from_map(map = {})
+        allocate.tap do |instance|
+          instance.instance_eval do
+            self.directory_directives = map.fetch(:directory_directives, {}).
+              extend(DirectoryDirectives)
+            self.default_directive = map.fetch(:default_directive, {}).extend(DefaultDirective)
+            self.excluded_paths = map.fetch(:excluded_paths, []).extend(ExcludedPaths)
+          end
+        end
+      end
 
-        load options
+      def self.default
+        from_path nil
       end
 
+      def self.new(*)
+        raise NotImplementedError,
+              'Calling `new` is not supported, please use one of the factory methods'
+      end
+
+      # Returns the directive for a given directory.
+      #
       # @param source_via [String] - the source of the code inspected
+      #
       # @return [Hash] the directory directive for the source or, if there is
       # none, the default directive
       def directive_for(source_via)
-        directory_directive_for_source(source_via) || default_directive
+        directory_directives.directive_for(source_via) || default_directive
+      end
+
+      def path_excluded?(path)
+        excluded_paths.include?(path)
       end
 
       private
 
-      private_attr_writer :exclude_paths
+      def directory_directives
+        @directory_directives ||= {}.extend(DirectoryDirectives)
+      end
 
-      # @param source_via [String] - the source of the code inspected
-      # Might be a string, STDIN or Filename / Pathname. We're only interested in the source
-      # when it's coming from file since a directory_directive doesn't make sense
-      # for anything else.
-      # @return [Hash | nil] the configuration for the source or nil
-      def directory_directive_for_source(source_via)
-        return unless source_via
-        source_base_dir = Pathname.new(source_via).dirname
-        hit = best_directory_match_for source_base_dir
-        directory_directives[hit]
+      def default_directive
+        @default_directive ||= {}.extend(DefaultDirective)
       end
 
-      def load(options)
-        configuration_file = ConfigurationFileFinder.find_and_load(options: options)
+      def excluded_paths
+        @excluded_paths ||= [].extend(ExcludedPaths)
+      end
+
+      def find_and_load(path: nil)
+        configuration_file = ConfigurationFileFinder.find_and_load(path: path)
 
         configuration_file.each do |key, value|
           case
           when key == EXCLUDE_PATHS_KEY
-            handle_exclude_paths(value)
+            excluded_paths.add value
           when smell_type?(key)
-            handle_default_directive(key, value)
+            default_directive.add key, value
           else
-            handle_directory_directive(key, value)
+            directory_directives.add key, value
           end
         end
       end
-
-      def handle_exclude_paths(paths)
-        self.exclude_paths = paths.map do |path|
-          pathname = Pathname.new path.chomp('/')
-          raise ArgumentError, "Excluded directory #{path} does not exists" unless pathname.exist?
-          pathname
-        end
-      end
-
-      def handle_default_directive(key, config)
-        klass = Reek::Smells.const_get(key)
-        default_directive[klass] = config
-      end
-
-      def handle_directory_directive(path, config)
-        pathname = Pathname.new path.chomp('/')
-        validate_directive pathname
-
-        directory_directives[pathname] = 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
-
-      def best_directory_match_for(source_base_dir)
-        directory_directives.
-          keys.
-          select { |pathname| source_base_dir.to_s =~ /#{pathname}/ }.
-          max_by { |pathname| pathname.to_s.length }
-      end
-
-      def smell_type?(key)
-        Reek::Smells.const_get key
-      rescue NameError
-        false
-      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
-
-      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_directive(pathname)
-        abort(error_message_for_missing_directory(pathname)) unless pathname.exist?
-        abort(error_message_for_file_given(pathname)) unless pathname.directory?
-      end
     end
   end
 end