reek 3.2.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe2528f9142f9b45b13b25d3c5b05913ef16f190
-  data.tar.gz: b3d969d1feedbe459e2f073f86cbb4d2fb6774da
+  metadata.gz: e18d9d5bd7b07494f2c0d1cf7f5bf271d87a918d
+  data.tar.gz: efebbdb49a7872897956b6c1ddf59aadee6dc158
 SHA512:
-  metadata.gz: d7a4a4ea2e5bf9cff1a99fa6ca67cc2709bc9cb806f0296acdc7b91ab3a8f7a59217b5d680cad008e33cf0f7887fd62299660f9efde81a978da6ea6b633eae41
-  data.tar.gz: 86b336f6aa1c9d9a4e3db2734ac01b35406bd389cef54fa1f67f1b7bbc707847ddabbbc318c257a0f16a8573a96ed08c12a2b9c06d9ee66a0ace9cfd9e03c5e3
+  metadata.gz: 6b8306b98fe28fa272395083b7c77a58572501780a2147a582320e433942ec18fa7b81b602a4043aa0cd421f691f2dc177c6a5e9a990ce78282130ee91fa5b99
+  data.tar.gz: f8d76ee8f1f8510b5357f0fa0e2031065d8759837ce05d0351f3bf622b7e286e8af30148482f07a9f2a1c4b35002fe78cb3f19326aae8a784c1605b55d449a21

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 3.3.0 (2015-08-23)
+
+* (HParker / Adam Hess) add support for or-assign constants
+* (troessner) Update TooManyMethods default value to 15
+
 ## 3.2.1 (2015-08-17)
 
 * Revert 864f0a9 to hotfix issues/642

data/Rakefile

@@ -1,5 +1,4 @@
 require 'bundler/gem_tasks'
-require 'private_attr/everywhere'
 require 'rake/clean'
 
 Dir['tasks/**/*.rake'].each { |t| load t }

data/config/defaults.reek

@@ -63,7 +63,7 @@ TooManyInstanceVariables:
 TooManyMethods:
   enabled: true
   exclude: []
-  max_methods: 25
+  max_methods: 15
 TooManyStatements:
   enabled: true
   exclude:

data/features/samples.feature

@@ -11,7 +11,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    inline.rb -- 45 warnings:
+    inline.rb -- 46 warnings:
       CompilationError has no descriptive comment (IrresponsibleModule)
       Dir has no descriptive comment (IrresponsibleModule)
       File has no descriptive comment (IrresponsibleModule)
@@ -23,6 +23,7 @@ Feature: Basic smell detection
       Inline#self.rootdir performs a nil-check (NilCheck)
       Inline::C declares the class variable @@type_map (ClassVariable)
       Inline::C has at least 13 instance variables (TooManyInstanceVariables)
+      Inline::C has at least 25 methods (TooManyMethods)
       Inline::C takes parameters [options, src] to 5 methods (DataClump)
       Inline::C tests $DEBUG at least 7 times (RepeatedConditional)
       Inline::C tests $TESTING at least 4 times (RepeatedConditional)
@@ -58,13 +59,6 @@ Feature: Basic smell detection
       Module#inline calls options[:testing] 2 times (DuplicateMethodCall)
       Module#inline has approx 12 statements (TooManyStatements)
     optparse.rb -- 121 warnings:
-      OptionParser declares the writable attribute banner (Attribute)
-      OptionParser declares the writable attribute default_argv (Attribute)
-      OptionParser declares the writable attribute program_name (Attribute)
-      OptionParser declares the writable attribute release (Attribute)
-      OptionParser declares the writable attribute summary_indent (Attribute)
-      OptionParser declares the writable attribute summary_width (Attribute)
-      OptionParser declares the writable attribute version (Attribute)
       OptionParser has at least 42 methods (TooManyMethods)
       OptionParser has at least 6 instance variables (TooManyInstanceVariables)
       OptionParser has the variable name 'f' (UncommunicativeVariableName)
@@ -77,10 +71,12 @@ Feature: Basic smell detection
       OptionParser tests default_pattern at least 7 times (RepeatedConditional)
       OptionParser tests not_style at least 3 times (RepeatedConditional)
       OptionParser tests s at least 7 times (RepeatedConditional)
+      OptionParser#banner is a writable attribute (Attribute)
       OptionParser#complete contains iterators nested 2 deep (NestedIterators)
       OptionParser#complete has 4 parameters (LongParameterList)
       OptionParser#complete has approx 6 statements (TooManyStatements)
       OptionParser#complete has boolean parameter 'icase' (BooleanParameter)
+      OptionParser#default_argv is a writable attribute (Attribute)
       OptionParser#getopts calls result[opt] = false 2 times (DuplicateMethodCall)
       OptionParser#getopts has approx 18 statements (TooManyStatements)
       OptionParser#load has approx 6 statements (TooManyStatements)
@@ -122,12 +118,17 @@ Feature: Basic smell detection
       OptionParser#permute calls argv[0] 2 times (DuplicateMethodCall)
       OptionParser#permute refers to argv more than self (FeatureEnvy)
       OptionParser#permute! has approx 6 statements (TooManyStatements)
+      OptionParser#program_name is a writable attribute (Attribute)
+      OptionParser#release is a writable attribute (Attribute)
       OptionParser#search has the variable name 'k' (UncommunicativeVariableName)
       OptionParser#self.inc performs a nil-check (NilCheck)
       OptionParser#summarize has 4 parameters (LongParameterList)
       OptionParser#summarize has the variable name 'l' (UncommunicativeVariableName)
       OptionParser#summarize is controlled by argument blk (ControlParameter)
+      OptionParser#summary_indent is a writable attribute (Attribute)
+      OptionParser#summary_width is a writable attribute (Attribute)
       OptionParser#ver has the variable name 'v' (UncommunicativeVariableName)
+      OptionParser#version is a writable attribute (Attribute)
       OptionParser::Arguable has initialize method (ModuleInitialize)
       OptionParser::Arguable#options has approx 6 statements (TooManyStatements)
       OptionParser::Arguable#options= is controlled by argument opt (ControlParameter)
@@ -150,7 +151,7 @@ Feature: Basic smell detection
       OptionParser::List#update has 5 parameters (LongParameterList)
       OptionParser::List#update has approx 10 statements (TooManyStatements)
       OptionParser::List#update has the variable name 'o' (UncommunicativeVariableName)
-      OptionParser::ParseError declares the writable attribute reason (Attribute)
+      OptionParser::ParseError#reason is a writable attribute (Attribute)
       OptionParser::ParseError#set_option is controlled by argument eq (ControlParameter)
       OptionParser::Switch has at least 7 instance variables (TooManyInstanceVariables)
       OptionParser::Switch#add_banner has the variable name 's' (UncommunicativeVariableName)
@@ -180,12 +181,6 @@ Feature: Basic smell detection
       OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv' (UnusedParameters)
       OptionParser::Switch::PlacedArgument#parse has approx 6 statements (TooManyStatements)
     redcloth.rb -- 101 warnings:
-      RedCloth declares the writable attribute filter_html (Attribute)
-      RedCloth declares the writable attribute filter_styles (Attribute)
-      RedCloth declares the writable attribute hard_breaks (Attribute)
-      RedCloth declares the writable attribute lite_mode (Attribute)
-      RedCloth declares the writable attribute no_span_caps (Attribute)
-      RedCloth declares the writable attribute rules (Attribute)
       RedCloth has at least 44 methods (TooManyMethods)
       RedCloth has the variable name 'a' (UncommunicativeVariableName)
       RedCloth has the variable name 'b' (UncommunicativeVariableName)
@@ -226,10 +221,13 @@ Feature: Basic smell detection
       RedCloth#clean_html has the variable name 'q2' (UncommunicativeVariableName)
       RedCloth#clean_white_space has approx 7 statements (TooManyStatements)
       RedCloth#clean_white_space refers to text more than self (FeatureEnvy)
+      RedCloth#filter_html is a writable attribute (Attribute)
+      RedCloth#filter_styles is a writable attribute (Attribute)
       RedCloth#flush_left doesn't depend on instance state (UtilityFunction)
       RedCloth#footnote_ref doesn't depend on instance state (UtilityFunction)
       RedCloth#glyphs_textile has approx 10 statements (TooManyStatements)
       RedCloth#h_align doesn't depend on instance state (UtilityFunction)
+      RedCloth#hard_breaks is a writable attribute (Attribute)
       RedCloth#htmlesc doesn't depend on instance state (UtilityFunction)
       RedCloth#htmlesc is controlled by argument mode (ControlParameter)
       RedCloth#incoming_entities doesn't depend on instance state (UtilityFunction)
@@ -252,6 +250,8 @@ Feature: Basic smell detection
       RedCloth#lT doesn't depend on instance state (UtilityFunction)
       RedCloth#lT has the name 'lT' (UncommunicativeMethodName)
       RedCloth#lT is controlled by argument text (ControlParameter)
+      RedCloth#lite_mode is a writable attribute (Attribute)
+      RedCloth#no_span_caps is a writable attribute (Attribute)
       RedCloth#no_textile doesn't depend on instance state (UtilityFunction)
       RedCloth#pba calls $1.length 2 times (DuplicateMethodCall)
       RedCloth#pba has approx 21 statements (TooManyStatements)
@@ -270,6 +270,7 @@ Feature: Basic smell detection
       RedCloth#rip_offtags calls used_offtags.length 2 times (DuplicateMethodCall)
       RedCloth#rip_offtags calls used_offtags["notextile"] 3 times (DuplicateMethodCall)
       RedCloth#rip_offtags has approx 18 statements (TooManyStatements)
+      RedCloth#rules is a writable attribute (Attribute)
       RedCloth#textile_bq has 4 parameters (LongParameterList)
       RedCloth#textile_bq has unused parameter 'tag' (UnusedParameters)
       RedCloth#textile_fn_ has 5 parameters (LongParameterList)
@@ -281,5 +282,5 @@ Feature: Basic smell detection
       RedCloth#textile_popup_help has the parameter name 'windowW' (UncommunicativeParameterName)
       RedCloth#to_html has approx 26 statements (TooManyStatements)
       RedCloth#v_align doesn't depend on instance state (UtilityFunction)
-    267 total warnings
+    268 total warnings
     """

data/lib/reek.rb

@@ -1,7 +1,6 @@
 #
 # Reek's core functionality
 #
-require 'private_attr/everywhere'
 require_relative 'reek/version'
 require_relative 'reek/examiner'
 require_relative 'reek/report/report'

data/lib/reek/ast/ast_node_class_map.rb

@@ -13,7 +13,7 @@ module Reek
       end
 
       def klass_for(type)
-        @klass_map[type] ||= Class.new(Node).tap do |klass|
+        klass_map[type] ||= Class.new(Node).tap do |klass|
           extension = extension_map[type]
           klass.send :include, extension if extension
         end
@@ -31,6 +31,10 @@ module Reek
             Hash[assoc]
           end
       end
+
+      private
+
+      private_attr_reader :klass_map
     end
   end
 end

data/lib/reek/ast/node.rb

@@ -1,4 +1,9 @@
-require 'parser'
+require 'private_attr/everywhere'
+require_relative '../cli/silencer'
+
+Reek::CLI::Silencer.silently stderr: true, stdout: true do
+  require 'parser'
+end
 
 module Reek
   # @api private
@@ -17,12 +22,12 @@ module Reek
       end
 
       def full_comment
-        @comments.map(&:text).join("\n")
+        comments.map(&:text).join("\n")
       end
 
       def leading_comment
         line = location.line
-        comment_lines = @comments.select do |comment|
+        comment_lines = comments.select do |comment|
           comment.location.line < line
         end
         comment_lines.map(&:text).join("\n")
@@ -120,6 +125,8 @@ module Reek
 
       private
 
+      private_attr_reader :comments
+
       def each_sexp
         children.each { |elem| yield elem if elem.is_a? ::Parser::AST::Node }
       end

data/lib/reek/ast/object_refs.rb

@@ -1,3 +1,5 @@
+require 'private_attr/everywhere'
+
 module Reek
   # @api private
   module AST
@@ -11,21 +13,25 @@ module Reek
       end
 
       def most_popular
-        max = @refs.values.map(&:size).max
-        @refs.select { |_name, refs| refs.size == max }
+        max = refs.values.map(&:size).max
+        refs.select { |_name, refs| refs.size == max }
       end
 
       def record_reference_to(name, line: nil)
-        @refs[name] << ObjectRef.new(name, line)
+        refs[name] << ObjectRef.new(name, line)
       end
 
       def references_to(name)
-        @refs[name]
+        refs[name]
       end
 
       def self_is_max?
-        @refs.empty? || most_popular.keys.include?(:self)
+        refs.empty? || most_popular.keys.include?(:self)
       end
+
+      private
+
+      private_attr_reader :refs
     end
   end
 end

data/lib/reek/ast/reference_collector.rb

@@ -1,3 +1,5 @@
+require 'private_attr/everywhere'
+
 module Reek
   module AST
     #
@@ -18,14 +20,16 @@ module Reek
 
       private
 
+      private_attr_reader :ast
+
       def explicit_self_calls
         [:self, :zsuper, :ivar, :ivasgn].flat_map do |node_type|
-          @ast.each_node(node_type, STOP_NODES)
+          ast.each_node(node_type, STOP_NODES)
         end
       end
 
       def implicit_self_calls
-        @ast.each_node(:send, STOP_NODES).reject(&:receiver)
+        ast.each_node(:send, STOP_NODES).reject(&:receiver)
       end
     end
   end

data/lib/reek/ast/sexp_extensions.rb

@@ -184,6 +184,24 @@ module Reek
         def object_creation_call?
           method_name == :new
         end
+
+        def visibility_modifier?
+          VISIBILITY_MODIFIERS.include?(method_name)
+        end
+
+        def attribute_writer?
+          ATTR_DEFN_METHODS.include?(method_name) ||
+            attr_with_writable_flag?
+        end
+
+        # Handles the case where we create an attribute writer via:
+        # attr :foo, true
+        def attr_with_writable_flag?
+          method_name == :attr && args.last.type == :true
+        end
+
+        VISIBILITY_MODIFIERS = [:private, :public, :protected, :module_function]
+        ATTR_DEFN_METHODS = [:attr_writer, :attr_accessor]
       end
 
       Op_AsgnNode = SendNode
@@ -405,6 +423,7 @@ module Reek
         MODULE_DEFINERS = [:Class, :Struct]
 
         def defines_module?
+          return false if value.nil?
           call = case value.type
                  when :block
                    value.call
@@ -420,8 +439,18 @@ module Reek
           SexpFormatter.format(children[1])
         end
 
+        # there are two valid forms of the casgn sexp
+        # (casgn <namespace> <name> <value>) and
+        # (casgn <namespace> <name>) used in or-asgn and mlhs
+        #
+        # source = "class Hi; THIS ||= 3; end"
+        # (class
+        #   (const nil :Hi) nil
+        #   (or-asgn
+        #    (casgn nil :THIS)
+        #    (int 3)))
         def value
-          children.last
+          children[2]
         end
       end
 
@@ -442,6 +471,18 @@ module Reek
       end
 
       ZsuperNode = SuperNode
+
+      # Utility methods for :sym nodes.
+      module SymNode
+        def name
+          children.first
+        end
+
+        def full_name(outer)
+          prefix = outer == '' ? '' : "#{outer}#"
+          "#{prefix}#{name}"
+        end
+      end
     end
   end
 end

data/lib/reek/ast/sexp_formatter.rb

@@ -1,5 +1,6 @@
 require_relative '../cli/silencer'
-Reek::CLI::Silencer.silently do
+
+Reek::CLI::Silencer.silently stderr: true, stdout: true do
   require 'unparser'
 end
 

data/lib/reek/cli/application.rb

@@ -20,9 +20,9 @@ module Reek
         @status = STATUS_SUCCESS
         options_parser = Options.new(argv)
         begin
-          @options = options_parser.parse
-          @command = ReekCommand.new(OptionInterpreter.new(@options))
-          @configuration = Configuration::AppConfiguration.new @options
+          options = options_parser.parse
+          @command = ReekCommand.new(OptionInterpreter.new(options))
+          @configuration = Configuration::AppConfiguration.from_path(options.config_file)
         rescue OptionParser::InvalidOption, Reek::Configuration::ConfigFileException => error
           $stderr.puts "Error: #{error}"
           @status = STATUS_ERROR
@@ -30,9 +30,9 @@ module Reek
       end
 
       def execute
-        return @status if error_occured?
-        @command.execute self
-        @status
+        return status if error_occured?
+        command.execute self
+        status
       end
 
       def output(text)
@@ -40,17 +40,20 @@ module Reek
       end
 
       def report_success
-        @status = STATUS_SUCCESS
+        self.status = STATUS_SUCCESS
       end
 
       def report_smells
-        @status = STATUS_SMELLS
+        self.status = STATUS_SMELLS
       end
 
       private
 
+      private_attr_accessor :status
+      private_attr_reader :command
+
       def error_occured?
-        @status == STATUS_ERROR
+        status == STATUS_ERROR
       end
     end
   end

data/lib/reek/cli/command.rb

@@ -1,3 +1,5 @@
+require 'private_attr/everywhere'
+
 module Reek
   module CLI
     #
@@ -10,6 +12,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