reek 3.1 → 3.2

data/lib/reek/cli/command.rb

@@ -10,6 +10,10 @@ module Reek
       def initialize(options)
         @options = options
       end
+
+      private
+
+      private_attr_reader :options
     end
   end
 end

data/lib/reek/cli/input.rb

@@ -26,9 +26,9 @@ module Reek
       end
 
       def no_source_files_given?
-        # At this point we have deleted all options from @argv. The only remaining entries
-        # are paths to the source files. If @argv is empty, this means that no files were given.
-        @argv.empty?
+        # At this point we have deleted all options from argv. The only remaining entries
+        # are paths to the source files. If argv is empty, this means that no files were given.
+        argv.empty?
       end
 
       def working_directory_as_source
@@ -36,7 +36,7 @@ module Reek
       end
 
       def sources_from_argv
-        Source::SourceLocator.new(@argv).sources
+        Source::SourceLocator.new(argv).sources
       end
 
       def source_from_pipe

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/warning_collector.rb

@@ -8,16 +8,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

@@ -21,7 +21,7 @@ module Reek
     end
 
     def descriptive?
-      @text.split(/\s+/).length >= 2
+      text.split(/\s+/).length >= 2
     end
 
     protected
@@ -32,5 +32,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

@@ -40,9 +40,9 @@ module Reek
       #                      config_file = #<Pathname:config/defaults.reek>,
       #                      argv = [ "lib/reek/spec" ]>
       def initialize(options = nil)
-        self.directory_directives = {}
-        self.default_directive    = {}
-        self.exclude_paths        = []
+        @directory_directives = {}
+        @default_directive    = {}
+        @exclude_paths        = []
 
         load options
       end
@@ -56,7 +56,7 @@ module Reek
 
       private
 
-      attr_writer :exclude_paths, :default_directive, :directory_directives
+      private_attr_writer :exclude_paths
 
       # @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

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)
-        @num_statements += num
+        self.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,8 +119,7 @@ module Reek
       end
 
       def full_name
-        context = @context ? @context.full_name : ''
-        exp.full_name(context)
+        exp.full_name(context ? context.full_name : '')
       end
 
       def config_for(detector_class)
@@ -140,46 +139,49 @@ 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
-          @tracked_visibility = visibility
+          self.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 :visibility
+      attr_writer :num_statements, :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,13 +65,15 @@ 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 = [])