reek 1.3.8 → 1.4.0

data/lib/reek/smells/utility_function.rb

@@ -4,13 +4,12 @@ require 'reek/source/reference_collector'
 
 module Reek
   module Smells
-
-    # 
+    #
     # A Utility Function is any instance method that has no
     # dependency on the state of the instance.
-    # 
+    #
     # Currently +UtilityFunction+ will warn about any method that:
-    # 
+    #
     # * is non-empty, and
     # * does not override an inherited method, and
     # * calls at least one method on another object, and
@@ -34,8 +33,7 @@ module Reek
     # likely belong there.
     #
     class UtilityFunction < SmellDetector
-
-      SMELL_SUBCLASS = self.name.split(/::/)[-1]
+      SMELL_SUBCLASS = name.split(/::/)[-1]
       SMELL_CLASS = 'LowCohesion'
 
       # The name of the config field that sets the maximum number of
@@ -50,6 +48,7 @@ module Reek
         def contexts      # :nodoc:
           [:defn]
         end
+
         def default_config
           super.merge(HELPER_CALLS_LIMIT_KEY => DEFAULT_HELPER_CALLS_LIMIT)
         end
@@ -64,14 +63,14 @@ module Reek
         return [] if method_ctx.num_statements == 0
         return [] if depends_on_instance?(method_ctx.exp)
         return [] if num_helper_methods(method_ctx) <= value(HELPER_CALLS_LIMIT_KEY, method_ctx, DEFAULT_HELPER_CALLS_LIMIT)
-          # SMELL: loads of calls to value{} with the above pattern
+        # SMELL: loads of calls to value{} with the above pattern
         smell = SmellWarning.new(SMELL_CLASS, method_ctx.full_name, [method_ctx.exp.line],
-          "doesn't depend on instance state",
-          @source, SMELL_SUBCLASS)
+                                 "doesn't depend on instance state",
+                                 @source, SMELL_SUBCLASS)
         [smell]
       end
 
-    private
+      private
 
       def depends_on_instance?(exp)
         Reek::Source::ReferenceCollector.new(exp).num_refs_to_self > 0

data/lib/reek/source.rb

@@ -8,7 +8,6 @@ require 'reek/source/source_locator'
 require 'reek/source/tree_dresser'
 
 module Reek
-
   #
   # This module contains a set of classes for interacting with Ruby
   # source code and abstract syntax trees.

data/lib/reek/source/code_comment.rb

@@ -1,7 +1,6 @@
 
 module Reek
   module Source
-
     #
     # A comment header from an abstract syntax tree; found directly above
     # module, class and method definitions.
@@ -10,7 +9,6 @@ module Reek
       CONFIG_REGEX = /:reek:(\w+)(:\s*\{.*?\})?/
 
       def initialize(text)
-        @config =  Hash.new { |hash,key| hash[key] = {} }
         @text = text.gsub(CONFIG_REGEX) do
           add_to_config($1, $2)
           ''
@@ -18,19 +16,20 @@ module Reek
       end
 
       def config
-        @config
+        @config ||= Hash.new { |hash, key| hash[key] = {} }
       end
 
-      def is_descriptive?
+      def descriptive?
         @text.split(/\s+/).length >= 2
       end
 
-    protected
+      protected
+
       def add_to_config(smell, options)
         options ||= ': { enabled: false }'
-        @config.merge! YAML.load(smell.gsub(/(?:^|_)(.)/) { $1.upcase } + options)
-        # extend this to all configs --------------------------^
-        # extend to allow configuration of whole smell class, not just subclass
+        config.merge! YAML.load(smell.gsub(/(?:^|_)(.)/) { $1.upcase } + options)
+        # TODO: extend this to all configs -------------------^
+        # TODO: extend to allow configuration of whole smell class, not just subclass
       end
     end
   end

data/lib/reek/source/config_file.rb

@@ -3,13 +3,11 @@ require 'reek/config_file_exception'
 
 module Reek
   module Source
-
     #
     # A file called <something>.reek containing configuration settings for
     # any or all of the smell detectors.
     #
     class ConfigFile
-
       #
       # Load the YAML config file from the supplied +file_path+.
       #
@@ -59,7 +57,7 @@ module Reek
           report_error(error.to_s)
         end
 
-        report_error('Not a hash') unless Hash === result
+        report_error('Not a hash') unless result.is_a? Hash
 
         result
       end
@@ -79,7 +77,7 @@ module Reek
       # Error.
       #
       def report_error(reason)
-        raise ConfigFileException.new message(reason)
+        raise ConfigFileException, message(reason)
       end
 
       def message(reason)

data/lib/reek/source/core_extras.rb

@@ -26,7 +26,7 @@ class IO
   # @return [Reek::Source::SourceCode]
   #
   def to_reek_source(description = 'io')
-    Reek::Source::SourceCode.new(self.readlines.join, description)
+    Reek::Source::SourceCode.new(readlines.join, description)
   end
 end
 

data/lib/reek/source/reference_collector.rb

@@ -1,7 +1,6 @@
 
 module Reek
   module Source
-
     #
     # Locates references to the current object within a portion
     # of an abstract syntax tree.
@@ -16,7 +15,7 @@ module Reek
       def num_refs_to_self
         result = 0
         [:self, :zsuper, :ivar, :iasgn].each do |node_type|
-          @ast.look_for(node_type, STOP_NODES) { result += 1}
+          @ast.look_for(node_type, STOP_NODES) { result += 1 }
         end
         @ast.look_for(:call, STOP_NODES) do |call|
           result += 1 unless call.receiver

data/lib/reek/source/sexp_extensions.rb

@@ -3,28 +3,83 @@ require 'reek/source/sexp_node'
 module Reek
   module Source
     module SexpExtensions
+      class MethodParameter
+        attr_reader :name
+
+        def initialize(name)
+          @name = name
+        end
+
+        def ==(other)
+          @name == other
+        end
+
+        def block?
+          @name.to_s =~ /^&/
+        end
+
+        def anonymous_splat?
+          @name == :*
+        end
+
+        def marked_unused?
+          plain_name.start_with?('_')
+        end
+
+        def plain_name
+          @plain_name ||= @name.to_s.sub(/^[*&]+/, '')
+        end
+      end
+
       module AndNode
-        def condition() self[1..2].tap {|node| node.extend SexpNode } end
+        def condition() self[1] end
+
+        def body
+          self[2]
+        end
       end
 
+      # Utility methods for :or nodes
       module OrNode
-        def condition() self[1..2].tap {|node| node.extend SexpNode } end
+        def condition() self[1] end
+
+        def body
+          self[2]
+        end
       end
 
       module AttrasgnNode
         def args() self[3] end
       end
 
+      # Utility methods for :case nodes
       module CaseNode
         def condition() self[1] end
+
+        def body
+          self[2..-1].extend SexpNode
+        end
       end
 
+      # Utility methods for :when nodes
+      module WhenNode
+        def condition_list
+          self[1][1..-1]
+        end
+      end
+
+      # Utility methods for :call nodes
       module CallNode
         def receiver() self[1] end
         def method_name() self[2] end
         def args() self[3..-1] end
+
+        def participants
+          ([receiver] + args).compact
+        end
+
         def arg_names
-          args.map {|arg| arg[1]}
+          args.map { |arg| arg[1] }
         end
       end
 
@@ -36,15 +91,26 @@ module Reek
       CvdeclNode = CvarNode
 
       module LvarNode
-        def value() self[1] end
+        def var_name() self[1] end
       end
 
       module MethodNode
+        def arguments
+          @arguments ||= parameters.reject(&:block?)
+        end
+
         def arg_names
-          @args ||= parameter_names.reject {|param| param.to_s =~ /^&/}
+          @arg_names ||= arguments.map(&:name)
+        end
+
+        def parameters
+          @parameters ||= argslist[1..-1].map do |param|
+            MethodParameter.new(param.is_a?(Sexp) ? param[1] : param)
+          end
         end
+
         def parameter_names
-          @param_names ||= argslist[1..-1].map { |param| Sexp === param ?  param[1] : param }
+          @parameter_names ||= parameters.map(&:name)
         end
 
         def name_without_bang
@@ -59,7 +125,8 @@ module Reek
       module DefnNode
         def name() self[1] end
         def argslist() self[2] end
-        def body()
+
+        def body
           self[3..-1].extend SexpNode
         end
         include MethodNode
@@ -73,7 +140,8 @@ module Reek
         def receiver() self[1] end
         def name() self[2] end
         def argslist() self[3] end
-        def body()
+
+        def body
           self[4..-1].extend SexpNode
         end
         include MethodNode
@@ -83,8 +151,13 @@ module Reek
         end
       end
 
+      # Utility methods for :if nodes
       module IfNode
         def condition() self[1] end
+
+        def body
+          self[2..-1].extend SexpNode
+        end
       end
 
       module IterNode
@@ -92,11 +165,19 @@ module Reek
         def args() self[2] end
         def block() self[3] end
         def parameters() self[2] || [] end
+
         def parameter_names
           parameters[1..-1].to_a
         end
       end
 
+      # Utility methods for :nil nodes
+      module NilNode
+        def nil_node?
+          true
+        end
+      end
+
       module LitNode
         def value() self[1] end
       end
@@ -119,13 +200,14 @@ module Reek
         def name() self[1] end
 
         def simple_name
-          Sexp === name ? name.simple_name : name
+          name.is_a?(Sexp) ? name.simple_name : name
         end
 
         def full_name(outer)
           prefix = outer == '' ? '' : "#{outer}::"
           "#{prefix}#{text_name}"
         end
+
         def text_name
           SexpNode.format(name)
         end
@@ -138,8 +220,9 @@ module Reek
 
       module YieldNode
         def args() self[1..-1] end
+
         def arg_names
-          args.map {|arg| arg[1]}
+          args.map { |arg| arg[1] }
         end
       end
     end

data/lib/reek/source/sexp_formatter.rb

@@ -2,14 +2,13 @@ require 'ruby2ruby'
 
 module Reek
   module Source
-
     #
     # Formats snippets of syntax tree back into Ruby source code.
     #
     class SexpFormatter
       def self.format(sexp)
-        return sexp.to_s unless Array === sexp
-        sexp = Sexp.from_array(YAML::load(YAML::dump(sexp)))
+        return sexp.to_s unless sexp.is_a? Array
+        sexp = Sexp.from_array(YAML.load(YAML.dump(sexp)))
         Ruby2Ruby.new.process(sexp)
       end
     end

data/lib/reek/source/sexp_node.rb

@@ -13,29 +13,33 @@ module Reek
       end
 
       def hash
-        self.inspect.hash
+        inspect.hash
       end
 
-      def is_language_node?
-        Symbol === first
-      end
-
-      def has_type?(type)
-        is_language_node? and first == type
-      end
-
-      def each_node(type, ignoring, &blk)
+      def each_node(type, ignoring = [], &blk)
         if block_given?
           look_for(type, ignoring, &blk)
         else
           result = []
-          look_for(type, ignoring) {|exp| result << exp}
+          look_for(type, ignoring) { |exp| result << exp }
           result
         end
       end
 
+      def unnested_nodes(types)
+        result = []
+        if types.include? first
+          result << self
+        else
+          each_sexp do |elem|
+            result += elem.unnested_nodes(types)
+          end
+        end
+        result
+      end
+
       def each_sexp
-        each { |elem| yield elem if Sexp === elem }
+        each { |elem| yield elem if elem.is_a? Sexp }
       end
 
       #
@@ -50,8 +54,8 @@ module Reek
         blk.call(self) if first == target_type
       end
 
-      def has_nested_node?(target_type)
-        look_for(target_type) { |elem| return true }
+      def contains_nested_node?(target_type)
+        look_for(target_type) { |_elem| return true }
         false
       end
 
@@ -60,7 +64,7 @@ module Reek
       end
 
       def deep_copy
-        Sexp.new(*map { |elem| Sexp === elem ? elem.deep_copy : elem })
+        Sexp.new(*map { |elem| elem.is_a?(Sexp) ? elem.deep_copy : elem })
       end
     end
   end

data/lib/reek/source/source_code.rb

@@ -4,22 +4,10 @@ require 'reek/source/tree_dresser'
 
 module Reek
   module Source
-
     #
     # A +Source+ object represents a chunk of Ruby source code.
     #
     class SourceCode
-
-      @@err_io = $stderr
-
-      class << self
-        def err_io=(io)
-          original = @@err_io
-          @@err_io = io
-          original
-        end
-      end
-
       attr_reader :desc
 
       def initialize(code, desc, parser = RubyParser.new)
@@ -28,13 +16,15 @@ module Reek
         @parser = parser
       end
 
-      def configure(sniffer) end
+      def relevant_config_files
+        []
+      end
 
       def syntax_tree
         begin
           ast = @parser.parse(@source, @desc)
         rescue Racc::ParseError, RubyParser::SyntaxError => error
-          @@err_io.puts "#{desc}: #{error.class.name}: #{error}"
+          $stderr.puts "#{desc}: #{error.class.name}: #{error}"
         end
         ast ||= s()
         TreeDresser.new.dress(ast)