reek 3.2 → 3.2.1

data/lib/reek/code_comment.rb

@@ -21,7 +21,7 @@ module Reek
     end
 
     def descriptive?
-      text.split(/\s+/).length >= 2
+      @text.split(/\s+/).length >= 2
     end
 
     protected
@@ -32,9 +32,5 @@ 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/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)
-        self.num_statements += num
+        @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,7 +119,8 @@ module Reek
       end
 
       def full_name
-        exp.full_name(context ? context.full_name : '')
+        context = @context ? @context.full_name : ''
+        exp.full_name(context)
       end
 
       def config_for(detector_class)
@@ -139,49 +140,46 @@ 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
-          self.tracked_visibility = visibility
+          @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 :num_statements, :visibility
+      attr_writer :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

@@ -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,15 +65,13 @@ 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_accessor :config_file
+      attr_writer :config_file
 
       # Glob pattern to match source files.
       # Setting the REEK_SRC environment variable overrides this.
       # Defaults to 'lib/**/*.rb'.
-      attr_accessor :source_files
+      attr_writer :source_files
 
       # String containing commandline options to be passed to Reek.
       # Setting the REEK_OPTS environment variable overrides this value.
       # Defaults to ''.
-      attr_accessor :reek_opts
+      attr_writer :reek_opts
 
       # Whether or not to fail Rake when an error occurs (typically when smells are found).
       # Defaults to true.
@@ -60,11 +60,10 @@ module Reek
       attr_writer :verbose
 
       def initialize(name = :reek)
-        @config_file   = ENV['REEK_CFG']
         @name          = name
-        @reek_opts     = ENV['REEK_OPTS'] || ''
+        @reek_opts     = ''
         @fail_on_error = true
-        @source_files  = ENV['REEK_SRC'] || 'lib/**/*.rb'
+        @source_files  = 'lib/**/*.rb'
         @verbose       = false
 
         yield self if block_given?
@@ -73,17 +72,15 @@ 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
@@ -92,12 +89,25 @@ 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
-        config_file ? ['-c', config_file] : []
+        return [] unless @config_file
+        ['-c', @config_file]
       end
 
       def reek_opts_as_arguments

data/lib/reek/report/formatter.rb

@@ -35,7 +35,7 @@ module Reek
       end
 
       def format(warning)
-        "#{location_formatter.format(warning)}#{base_format(warning)}"
+        "#{@location_formatter.format(warning)}#{base_format(warning)}"
       end
 
       private
@@ -43,10 +43,6 @@ 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)
-        self.total_smell_count += examiner.smells_count
-        examiners << examiner
+        @total_smell_count += examiner.smells_count
+        @examiners << examiner
         self
       end
 
@@ -42,22 +42,13 @@ 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
 
     #
@@ -73,7 +64,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
@@ -81,33 +72,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
 
@@ -127,7 +118,7 @@ module Reek
       def show
         print ::JSON.generate(
           smells.map do |smell|
-            smell.yaml_hash(warning_formatter)
+            smell.yaml_hash(@warning_formatter)
           end
         )
       end

data/lib/reek/smells/attribute.rb

@@ -34,8 +34,8 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def examine_context(ctx)
-        self.visiblity_tracker = {}
-        self.visiblity_mode = :public
+        @visiblity_tracker = {}
+        @visiblity_mode = :public
         attributes_in(ctx).map do |attribute, line|
           SmellWarning.new self,
                            context: ctx.full_name,
@@ -47,9 +47,6 @@ module Reek
 
       private
 
-      private_attr_accessor :visiblity_mode, :visiblity_tracker
-      private_attr_reader :result
-
       def attributes_in(module_ctx)
         attributes = Set.new
         module_ctx.local_nodes(:send) do |call_node|
@@ -81,7 +78,7 @@ module Reek
 
       def track_argument(arg, line)
         arg_name = arg.children.first
-        visiblity_tracker[arg_name] = visiblity_mode
+        @visiblity_tracker[arg_name] = @visiblity_mode
         [arg_name, line]
       end
 
@@ -91,14 +88,14 @@ module Reek
 
       def track_visibility(call_node)
         if call_node.arg_names.any?
-          call_node.arg_names.each { |arg| visiblity_tracker[arg] = call_node.method_name }
+          call_node.arg_names.each { |arg| @visiblity_tracker[arg] = call_node.method_name }
         else
-          self.visiblity_mode = call_node.method_name
+          @visiblity_mode = call_node.method_name
         end
       end
 
       def recorded_public_methods
-        visiblity_tracker.select { |_, visbility| visbility == :public }
+        @visiblity_tracker.select { |_, visbility| visbility == :public }
       end
     end
   end

data/lib/reek/smells/control_parameter.rb

@@ -73,20 +73,16 @@ module Reek
         end
 
         def smells?
-          occurences.any?
+          @occurences.any?
         end
 
         def lines
-          occurences.map(&:line)
+          @occurences.map(&:line)
         end
 
         def name
-          param.to_s
+          @param.to_s
         end
-
-        private
-
-        private_attr_reader :occurences, :param
       end
 
       # Finds cases of ControlParameter in a particular node for a particular parameter
@@ -112,15 +108,13 @@ module Reek
 
         private
 
-        private_attr_reader :node, :param
-
         def conditional_nodes
-          node.body_nodes(CONDITIONAL_NODE_TYPES)
+          @node.body_nodes(CONDITIONAL_NODE_TYPES)
         end
 
         def nested_finders
           @nested_finders ||= conditional_nodes.flat_map do |node|
-            self.class.new(node, param)
+            self.class.new(node, @param)
           end
         end
 
@@ -135,12 +129,12 @@ module Reek
 
         def uses_of_param_in_condition
           return [] unless condition
-          condition.each_node(:lvar).select { |inner| inner.var_name == param }
+          condition.each_node(:lvar).select { |inner| inner.var_name == @param }
         end
 
         def condition
-          return nil unless CONDITIONAL_NODE_TYPES.include? node.type
-          node.condition
+          return nil unless CONDITIONAL_NODE_TYPES.include? @node.type
+          @node.condition
         end
 
         def regular_call_involving_param?(call_node)
@@ -156,12 +150,12 @@ module Reek
         end
 
         def call_involving_param?(call_node)
-          call_node.each_node(:lvar).any? { |it| it.var_name == param }
+          call_node.each_node(:lvar).any? { |it| it.var_name == @param }
         end
 
         def uses_param_in_body?
-          nodes = node.body_nodes([:lvar], [:if, :case, :and, :or])
-          nodes.any? { |lvar_node| lvar_node.var_name == param }
+          nodes = @node.body_nodes([:lvar], [:if, :case, :and, :or])
+          nodes.any? { |lvar_node| lvar_node.var_name == @param }
         end
       end
 
@@ -181,14 +175,12 @@ module Reek
 
         private
 
-        private_attr_reader :context
-
         def potential_parameters
-          context.exp.parameter_names
+          @context.exp.parameter_names
         end
 
         def find_matches(param)
-          ControlParameterFinder.new(context.exp, param).find_matches
+          ControlParameterFinder.new(@context.exp, param).find_matches
         end
       end
     end