reek 3.1 → 3.2

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

@@ -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

@@ -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/source/source_code.rb

@@ -20,7 +20,7 @@ module Reek
 
       # Initializer.
       #
-      # code        - ruby code as String
+      # code        - Ruby code as String
       # description - 'STDIN', 'string' or a filepath as String
       # parser      - the parser to use for generating AST's out of the given source
       def initialize(code, description, parser = Parser::Ruby22)
@@ -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

@@ -12,15 +12,15 @@ module Reek
       #
       # paths - a list of paths as Strings
       def initialize(paths, configuration: Configuration::AppConfiguration.new)
-        self.paths = paths.flat_map do |string|
+        @paths = paths.flat_map do |string|
           path = Pathname.new(string)
           current_directory?(path) ? path.entries : path
         end
-        self.configuration = configuration
+        @configuration = configuration
       end
 
       # Traverses all paths we initialized the SourceLocator with, finds
-      # all relevant ruby files and returns them as a list.
+      # all relevant Ruby files and returns them as a list.
       #
       # @return [Array<Pathname>] - Ruby paths found
       def sources
@@ -29,7 +29,7 @@ module Reek
 
       private
 
-      attr_accessor :paths, :configuration
+      private_attr_reader :configuration, :paths
 
       def source_paths
         paths.each_with_object([]) do |given_path, relevant_paths|

data/lib/reek/spec/should_reek.rb

@@ -13,18 +13,23 @@ module Reek
       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

@@ -17,21 +17,24 @@ module Reek
       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

@@ -10,24 +10,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

data/lib/reek/tree_dresser.rb

@@ -25,8 +25,12 @@ module Reek
       type = sexp.type
       children = sexp.children.map { |child| dress(child, comment_map, sexp) }
       comments = comment_map[sexp]
-      @klass_map.klass_for(type).new(type, children,
-                                     location: sexp.loc, comments: comments, parent: parent)
+      klass_map.klass_for(type).new(type, children,
+                                    location: sexp.loc, comments: comments, parent: parent)
     end
+
+    private
+
+    private_attr_reader :klass_map
   end
 end

data/lib/reek/tree_walker.rb

@@ -24,14 +24,20 @@ module Reek
     end
 
     def walk
-      @result ||= process(@exp)
-      @result.each do |element|
-        @smell_repository.examine(element)
+      result.each do |element|
+        smell_repository.examine(element)
       end
     end
 
     private
 
+    private_attr_accessor :element
+    private_attr_reader :exp, :smell_repository
+
+    def result
+      @result ||= process(exp)
+    end
+
     def process(exp)
       context_processor = "process_#{exp.type}"
       if context_processor_exists?(context_processor)
@@ -39,7 +45,7 @@ module Reek
       else
         process_default exp
       end
-      @element
+      element
     end
 
     def process_module(exp)
@@ -86,28 +92,28 @@ module Reek
 
     def process_send(exp)
       if visibility_modifier? exp
-        @element.track_visibility(exp.method_name, exp.arg_names)
+        element.track_visibility(exp.method_name, exp.arg_names)
       end
-      @element.record_call_to(exp)
+      element.record_call_to(exp)
       process_default(exp)
     end
 
     def process_attrasgn(exp)
-      @element.record_call_to(exp)
+      element.record_call_to(exp)
       process_default(exp)
     end
 
     alias_method :process_op_asgn, :process_attrasgn
 
     def process_ivar(exp)
-      @element.record_use_of_self
+      element.record_use_of_self
       process_default(exp)
     end
 
     alias_method :process_ivasgn, :process_ivar
 
     def process_self(_)
-      @element.record_use_of_self
+      element.record_use_of_self
     end
 
     alias_method :process_zsuper, :process_self
@@ -123,7 +129,7 @@ module Reek
 
     def process_begin(exp)
       count_statement_list(exp.children)
-      @element.count_statements(-1)
+      element.count_statements(-1)
       process_default(exp)
     end
 
@@ -132,13 +138,13 @@ module Reek
     def process_if(exp)
       count_clause(exp[2])
       count_clause(exp[3])
-      @element.count_statements(-1)
+      element.count_statements(-1)
       process_default(exp)
     end
 
     def process_while(exp)
       count_clause(exp[2])
-      @element.count_statements(-1)
+      element.count_statements(-1)
       process_default(exp)
     end
 
@@ -146,13 +152,13 @@ module Reek
 
     def process_for(exp)
       count_clause(exp[3])
-      @element.count_statements(-1)
+      element.count_statements(-1)
       process_default(exp)
     end
 
     def process_rescue(exp)
       count_clause(exp[1])
-      @element.count_statements(-1)
+      element.count_statements(-1)
       process_default(exp)
     end
 
@@ -163,7 +169,7 @@ module Reek
 
     def process_case(exp)
       count_clause(exp.else_body)
-      @element.count_statements(-1)
+      element.count_statements(-1)
       process_default(exp)
     end
 
@@ -177,16 +183,16 @@ module Reek
     end
 
     def count_clause(sexp)
-      @element.count_statements(1) if sexp
+      element.count_statements(1) if sexp
     end
 
     def count_statement_list(statement_list)
-      @element.count_statements statement_list.length
+      element.count_statements statement_list.length
     end
 
     def inside_new_context(klass, exp)
-      scope = klass.new(@element, exp)
-      @element.append_child_context(scope)
+      scope = klass.new(element, exp)
+      element.append_child_context(scope)
       push(scope) do
         yield
       end
@@ -194,10 +200,10 @@ module Reek
     end
 
     def push(scope)
-      orig = @element
-      @element = scope
+      orig = element
+      self.element = scope
       yield
-      @element = orig
+      self.element = orig
     end
 
     # FIXME: Move to SendNode?

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '3.1'
+    STRING = '3.2'
   end
 end

data/reek.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
 
   s.license = 'MIT'
   s.email = ['timo.roessner@googlemail.com']
-  s.extra_rdoc_files = ['CHANGELOG', 'License.txt']
+  s.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
   s.files = `git ls-files -z`.split("\0")
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
   s.homepage = 'https://github.com/troessner/reek/wiki'
@@ -22,12 +22,13 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'parser',   '~> 2.2.2.5'
-  s.add_runtime_dependency 'rainbow',  '~> 2.0'
-  s.add_runtime_dependency 'unparser', '~> 0.2.2'
+  s.add_runtime_dependency 'parser',       '~> 2.2.2.5'
+  s.add_runtime_dependency 'private_attr', '~> 1.1'
+  s.add_runtime_dependency 'rainbow',      '~> 2.0'
+  s.add_runtime_dependency 'unparser',     '~> 0.2.2'
 
   s.add_development_dependency 'activesupport', '~> 4.2'
-  s.add_development_dependency 'aruba',         '~> 0.7.2'
+  s.add_development_dependency 'aruba',         '~> 0.8.0'
   s.add_development_dependency 'ataru',         '~> 0.2.0'
   s.add_development_dependency 'bundler',       '~> 1.1'
   s.add_development_dependency 'cucumber',      '~> 2.0'