reek 3.2.1 → 3.3.0

data/lib/reek/smells/smell_detector.rb

@@ -38,12 +38,17 @@ module Reek
         end
 
         def inherited(subclass)
-          @subclasses ||= []
-          @subclasses << subclass
+          subclasses << subclass
         end
 
         def descendants
-          @subclasses
+          subclasses
+        end
+
+        private
+
+        def subclasses
+          @subclasses ||= []
         end
       end
 
@@ -69,7 +74,7 @@ module Reek
         end
       end
 
-      attr_reader :smells_found   # SMELL: only published for tests
+      attr_reader :smells_found # SMELL: only published for tests
 
       def initialize(source, config = self.class.default_config)
         @source = source
@@ -78,17 +83,17 @@ module Reek
       end
 
       def register(hooks)
-        return unless @config.enabled?
+        return unless config.enabled?
         self.class.contexts.each { |ctx| hooks[ctx] << self }
       end
 
       # SMELL: Getter (only used in 1 test)
       def enabled?
-        @config.enabled?
+        config.enabled?
       end
 
-      def configure_with(config)
-        @config.merge!(config)
+      def configure_with(new_config)
+        config.merge!(new_config)
       end
 
       def examine(context)
@@ -96,7 +101,7 @@ module Reek
         return if exception?(context)
 
         sm = examine_context(context)
-        @smells_found += sm
+        self.smells_found += sm
       end
 
       def enabled_for?(context)
@@ -108,16 +113,24 @@ module Reek
       end
 
       def report_on(report)
-        @smells_found.each { |smell| smell.report_on(report) }
+        smells_found.each { |smell| smell.report_on(report) }
       end
 
       def value(key, ctx, fall_back)
-        config_for(ctx)[key] || @config.value(key, ctx, fall_back)
+        config_for(ctx)[key] || config.value(key, ctx, fall_back)
       end
 
       def config_for(ctx)
         ctx.config_for(self.class)
       end
+
+      protected
+
+      attr_writer :smells_found
+
+      private
+
+      private_attr_reader :config
     end
   end
 end

data/lib/reek/smells/smell_repository.rb

@@ -15,7 +15,7 @@ module Reek
 
       def initialize(source_description: nil,
                      smell_types: self.class.smell_types,
-                     configuration: Configuration::AppConfiguration.new)
+                     configuration: Configuration::AppConfiguration.default)
         @source_via    = source_description
         @configuration = configuration
         @smell_types   = smell_types

data/lib/reek/smells/smell_warning.rb

@@ -8,15 +8,15 @@ module Reek
     class SmellWarning
       include Comparable
       extend Forwardable
-      attr_accessor :smell_detector, :context, :lines, :message, :parameters
+      attr_reader :context, :lines, :message, :parameters, :smell_detector
       def_delegators :smell_detector, :smell_category, :smell_type, :source
 
       def initialize(smell_detector, options = {})
-        self.smell_detector = smell_detector
-        self.context        = options.fetch(:context, '').to_s
-        self.lines          = options.fetch(:lines)
-        self.message        = options.fetch(:message)
-        self.parameters     = options.fetch(:parameters, {})
+        @smell_detector = smell_detector
+        @context        = options.fetch(:context, '').to_s
+        @lines          = options.fetch(:lines)
+        @message        = options.fetch(:message)
+        @parameters     = options.fetch(:parameters, {})
       end
 
       def hash

data/lib/reek/smells/too_many_instance_variables.rb

@@ -39,9 +39,9 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        @max_allowed_ivars = value(MAX_ALLOWED_IVARS_KEY, ctx, DEFAULT_MAX_IVARS)
+        max_allowed_ivars = value(MAX_ALLOWED_IVARS_KEY, ctx, DEFAULT_MAX_IVARS)
         count = ctx.local_nodes(:ivasgn).map { |ivasgn| ivasgn[1] }.uniq.length
-        return [] if count <= @max_allowed_ivars
+        return [] if count <= max_allowed_ivars
         [SmellWarning.new(self,
                           context: ctx.full_name,
                           lines: [ctx.exp.line],

data/lib/reek/smells/too_many_methods.rb

@@ -18,7 +18,7 @@ module Reek
       # The name of the config field that sets the maximum number of methods
       # permitted in a class.
       MAX_ALLOWED_METHODS_KEY = 'max_methods'
-      DEFAULT_MAX_METHODS = 25
+      DEFAULT_MAX_METHODS = 15
 
       def self.smell_category
         'LargeClass'
@@ -41,13 +41,13 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        @max_allowed_methods = value(MAX_ALLOWED_METHODS_KEY, ctx, DEFAULT_MAX_METHODS)
+        max_allowed_methods = value(MAX_ALLOWED_METHODS_KEY, ctx, DEFAULT_MAX_METHODS)
         actual = ctx.node_instance_methods.length
-        return [] if actual <= @max_allowed_methods
+        return [] if actual <= max_allowed_methods
         [SmellWarning.new(self,
                           context: ctx.full_name,
                           lines: [ctx.exp.line],
-                          message:  "has at least #{actual} methods",
+                          message: "has at least #{actual} methods",
                           parameters: { count: actual })]
       end
     end

data/lib/reek/smells/too_many_statements.rb

@@ -33,11 +33,11 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        @max_allowed_statements = value(MAX_ALLOWED_STATEMENTS_KEY,
-                                        ctx,
-                                        DEFAULT_MAX_STATEMENTS)
+        max_allowed_statements = value(MAX_ALLOWED_STATEMENTS_KEY,
+                                       ctx,
+                                       DEFAULT_MAX_STATEMENTS)
         count = ctx.num_statements
-        return [] if count <= @max_allowed_statements
+        return [] if count <= max_allowed_statements
         [SmellWarning.new(self,
                           context: ctx.full_name,
                           lines: [ctx.exp.line],

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -47,13 +47,13 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
-        @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
+        reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
+        accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
         name = ctx.name.to_s
-        return [] if @accept_names.include?(ctx.full_name)
+        return [] if accept_names.include?(ctx.full_name)
         var = name.gsub(/^[@\*\&]*/, '')
-        return [] if @accept_names.include?(var)
-        return [] unless @reject_names.find { |patt| patt =~ var }
+        return [] if accept_names.include?(var)
+        return [] unless reject_names.find { |patt| patt =~ var }
         [SmellWarning.new(self,
                           context: ctx.full_name,
                           lines: [ctx.exp.line],

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -41,7 +41,7 @@ module Reek
         )
       end
 
-      def self.contexts      # :nodoc:
+      def self.contexts # :nodoc:
         [:module, :class]
       end
 
@@ -52,15 +52,15 @@ module Reek
       #
       # :reek:Duplication { allow_calls: [ to_s ] }
       def examine_context(ctx)
-        @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
-        @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
+        reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
+        accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
         exp = ctx.exp
         full_name = ctx.full_name
         name = exp.simple_name.to_s
-        return [] if @accept_names.include?(full_name)
+        return [] if accept_names.include?(full_name)
         var = name.gsub(/^[@\*\&]*/, '')
-        return [] if @accept_names.include?(var)
-        return [] unless @reject_names.find { |patt| patt =~ var }
+        return [] if accept_names.include?(var)
+        return [] unless reject_names.find { |patt| patt =~ var }
         [SmellWarning.new(self,
                           context: full_name,
                           lines: [exp.line],

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -47,8 +47,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
-        @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
+        self.reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
+        self.accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
         context_expression = ctx.exp
         context_expression.parameter_names.select do |name|
           bad_name?(name) && ctx.uses_param?(name)
@@ -63,9 +63,13 @@ module Reek
 
       def bad_name?(name)
         var = name.to_s.gsub(/^[@\*\&]*/, '')
-        return false if var == '*' || @accept_names.include?(var)
-        @reject_names.find { |patt| patt =~ var }
+        return false if var == '*' || accept_names.include?(var)
+        reject_names.find { |patt| patt =~ var }
       end
+
+      private
+
+      private_attr_accessor :accept_names, :reject_names
     end
   end
 end

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -41,7 +41,7 @@ module Reek
         )
       end
 
-      def self.contexts      # :nodoc:
+      def self.contexts # :nodoc:
         [:module, :class, :def, :defs]
       end
 
@@ -51,8 +51,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        @reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
-        @accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
+        self.reject_names = value(REJECT_KEY, ctx, DEFAULT_REJECT_SET)
+        self.accept_names = value(ACCEPT_KEY, ctx, DEFAULT_ACCEPT_SET)
         variable_names(ctx.exp).select do |name, _lines|
           bad_name?(name, ctx)
         end.map do |name, lines|
@@ -66,8 +66,8 @@ module Reek
 
       def bad_name?(name, _ctx)
         var = name.to_s.gsub(/^[@\*\&]*/, '')
-        return false if @accept_names.include?(var)
-        @reject_names.find { |patt| patt =~ var }
+        return false if accept_names.include?(var)
+        reject_names.find { |patt| patt =~ var }
       end
 
       def variable_names(exp)
@@ -121,6 +121,10 @@ module Reek
         var = varname.to_sym
         accumulator[var].push(exp.line)
       end
+
+      private
+
+      private_attr_accessor :accept_names, :reject_names
     end
   end
 end

data/lib/reek/smells/utility_function.rb

@@ -43,7 +43,7 @@ module Reek
       end
 
       class << self
-        def contexts      # :nodoc:
+        def contexts # :nodoc:
           [:def]
         end
       end

data/lib/reek/source/source_code.rb

@@ -82,7 +82,7 @@ module Reek
         @syntax_tree ||=
           begin
             begin
-              ast, comments = @parser.parse_with_comments(@source, @description)
+              ast, comments = parser.parse_with_comments(source, description)
             rescue Racc::ParseError, Parser::SyntaxError => error
               $stderr.puts "#{description}: #{error.class.name}: #{error}"
             end
@@ -92,6 +92,10 @@ module Reek
             TreeDresser.new.dress(ast, comment_map)
           end
       end
+
+      private
+
+      private_attr_reader :parser, :source
     end
   end
 end

data/lib/reek/source/source_locator.rb

@@ -1,3 +1,4 @@
+require 'private_attr/everywhere'
 require 'find'
 require 'pathname'
 
@@ -11,7 +12,7 @@ module Reek
       # Initialize with the paths we want to search.
       #
       # paths - a list of paths as Strings
-      def initialize(paths, configuration: Configuration::AppConfiguration.new)
+      def initialize(paths, configuration: Configuration::AppConfiguration.default)
         @paths = paths.flat_map do |string|
           path = Pathname.new(string)
           current_directory?(path) ? path.entries : path
@@ -45,7 +46,7 @@ module Reek
       end
 
       def path_excluded?(path)
-        configuration.exclude_paths.include?(path)
+        configuration.path_excluded?(path)
       end
 
       def print_no_such_file_error(path)

data/lib/reek/spec.rb

@@ -87,7 +87,7 @@ module Reek
     #
     def reek_of(smell_category,
                 smell_details = {},
-                configuration = Configuration::AppConfiguration.new)
+                configuration = Configuration::AppConfiguration.default)
       ShouldReekOf.new(smell_category, smell_details, configuration)
     end
 
@@ -98,14 +98,14 @@ module Reek
     #   1.) "reek_of" doesn't mind if there are other smells of a different category.
     #       "reek_only_of" will fail in that case.
     #   2.) "reek_only_of" doesn't support the additional smell_details hash.
-    def reek_only_of(smell_category, configuration = Configuration::AppConfiguration.new)
+    def reek_only_of(smell_category, configuration = Configuration::AppConfiguration.default)
       ShouldReekOnlyOf.new(smell_category, configuration)
     end
 
     #
     # Returns +true+ if and only if the target source code contains smells.
     #
-    def reek(configuration = Configuration::AppConfiguration.new)
+    def reek(configuration = Configuration::AppConfiguration.default)
       ShouldReek.new configuration
     end
   end

data/lib/reek/spec/should_reek.rb

@@ -8,23 +8,28 @@ module Reek
     #
     # @api private
     class ShouldReek
-      def initialize(configuration = Configuration::AppConfiguration.new)
+      def initialize(configuration = Configuration::AppConfiguration.default)
         @configuration = configuration
       end
 
       def matches?(actual)
-        @examiner = Examiner.new(actual, configuration: @configuration)
-        @examiner.smelly?
+        self.examiner = Examiner.new(actual, configuration: configuration)
+        examiner.smelly?
       end
 
       def failure_message
-        "Expected #{@examiner.description} to reek, but it didn't"
+        "Expected #{examiner.description} to reek, but it didn't"
       end
 
       def failure_message_when_negated
-        rpt = Report::Formatter.format_list(@examiner.smells)
+        rpt = Report::Formatter.format_list(examiner.smells)
         "Expected no smells, but got:\n#{rpt}"
       end
+
+      private
+
+      private_attr_reader :configuration
+      private_attr_accessor :examiner
     end
   end
 end

data/lib/reek/spec/should_reek_of.rb

@@ -10,28 +10,31 @@ module Reek
     class ShouldReekOf
       def initialize(smell_category,
                      smell_details = {},
-                     configuration = Configuration::AppConfiguration.new)
+                     configuration = Configuration::AppConfiguration.default)
         @smell_category = normalize smell_category
         @smell_details  = smell_details
         @configuration  = configuration
       end
 
       def matches?(actual)
-        @examiner = Examiner.new(actual, configuration: @configuration)
-        @all_smells = @examiner.smells
-        @all_smells.any? { |warning| warning.matches?(@smell_category, @smell_details) }
+        self.examiner = Examiner.new(actual, configuration: configuration)
+        self.all_smells = examiner.smells
+        all_smells.any? { |warning| warning.matches?(smell_category, smell_details) }
       end
 
       def failure_message
-        "Expected #{@examiner.description} to reek of #{@smell_category}, but it didn't"
+        "Expected #{examiner.description} to reek of #{smell_category}, but it didn't"
       end
 
       def failure_message_when_negated
-        "Expected #{@examiner.description} not to reek of #{@smell_category}, but it did"
+        "Expected #{examiner.description} not to reek of #{smell_category}, but it did"
       end
 
       private
 
+      private_attr_reader :configuration, :smell_category, :smell_details
+      private_attr_accessor :all_smells, :examiner
+
       def normalize(smell_category_or_type)
         # In theory, users can give us many different types of input (see the documentation for
         # reek_of below), however we're basically ignoring all of those subleties and just

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,5 +1,6 @@
 require_relative '../examiner'
 require_relative '../report/formatter'
+require_relative 'should_reek_of'
 
 module Reek
   module Spec
@@ -10,24 +11,28 @@ module Reek
     # @api private
     class ShouldReekOnlyOf < ShouldReekOf
       def matches?(actual)
-        matches_examiner?(Examiner.new(actual, configuration: @configuration))
+        matches_examiner?(Examiner.new(actual, configuration: configuration))
       end
 
       def matches_examiner?(examiner)
-        @examiner = examiner
-        @warnings = @examiner.smells
-        return false if @warnings.empty?
-        @warnings.all? { |warning| warning.matches?(@smell_category) }
+        self.examiner = examiner
+        self.warnings = examiner.smells
+        return false if warnings.empty?
+        warnings.all? { |warning| warning.matches?(smell_category) }
       end
 
       def failure_message
-        rpt = Report::Formatter.format_list(@warnings)
-        "Expected #{@examiner.description} to reek only of #{@smell_category}, but got:\n#{rpt}"
+        rpt = Report::Formatter.format_list(warnings)
+        "Expected #{examiner.description} to reek only of #{smell_category}, but got:\n#{rpt}"
       end
 
       def failure_message_when_negated
-        "Expected #{@examiner.description} not to reek only of #{@smell_category}, but it did"
+        "Expected #{examiner.description} not to reek only of #{smell_category}, but it did"
       end
+
+      private
+
+      private_attr_accessor :warnings
     end
   end
 end