reek 3.5.0 → 3.6.0

data/lib/reek/ast/sexp_extensions/arguments.rb

@@ -0,0 +1,101 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Base module for utility methods for argument nodes.
+      module ArgNodeBase
+        def name
+          children.first
+        end
+
+        # Other is a symbol?
+        def ==(other)
+          name == other
+        end
+
+        def marked_unused?
+          plain_name.start_with?('_')
+        end
+
+        def plain_name
+          name.to_s
+        end
+
+        def block?
+          false
+        end
+
+        def optional_argument?
+          false
+        end
+
+        def anonymous_splat?
+          false
+        end
+
+        def components
+          [self]
+        end
+      end
+
+      # Utility methods for :arg nodes.
+      module ArgNode
+        include ArgNodeBase
+      end
+
+      # Utility methods for :kwarg nodes.
+      module KwargNode
+        include ArgNodeBase
+      end
+
+      # Utility methods for :optarg nodes.
+      module OptargNode
+        include ArgNodeBase
+
+        def optional_argument?
+          true
+        end
+      end
+
+      # Utility methods for :kwoptarg nodes.
+      module KwoptargNode
+        include ArgNodeBase
+
+        def optional_argument?
+          true
+        end
+      end
+
+      # Utility methods for :blockarg nodes.
+      module BlockargNode
+        include ArgNodeBase
+
+        def block?
+          true
+        end
+      end
+
+      # Utility methods for :restarg nodes.
+      module RestargNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          !name
+        end
+      end
+
+      # Utility methods for :kwrestarg nodes.
+      module KwrestargNode
+        include ArgNodeBase
+
+        def anonymous_splat?
+          !name
+        end
+      end
+
+      # Utility methods for :shadowarg nodes.
+      module ShadowargNode
+        include ArgNodeBase
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/attribute_assignments.rb

@@ -0,0 +1,12 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :attrasgn nodes.
+      module AttrasgnNode
+        def args
+          children[2]
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/block.rb

@@ -0,0 +1,36 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :block nodes.
+      module BlockNode
+        def call
+          children.first
+        end
+
+        def args
+          children[1]
+        end
+
+        def block
+          children[2]
+        end
+
+        def parameters
+          children[1] || []
+        end
+
+        def parameter_names
+          parameters.children
+        end
+
+        def simple_name
+          :block
+        end
+
+        def without_block_arguments?
+          args.components.empty?
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/case.rb

@@ -0,0 +1,20 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :case nodes.
+      module CaseNode
+        def condition
+          children.first
+        end
+
+        def body_nodes(type, ignoring = [])
+          children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
+        end
+
+        def else_body
+          children.last
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/constant.rb

@@ -0,0 +1,12 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :const nodes.
+      module ConstNode
+        def simple_name
+          children.last
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/if.rb

@@ -0,0 +1,16 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :if nodes.
+      module IfNode
+        def condition
+          children.first
+        end
+
+        def body_nodes(type, ignoring = [])
+          children[1..-1].compact.flat_map { |child| child.find_nodes(type, ignoring) }
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/literal.rb

@@ -0,0 +1,12 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Utility methods for :lit nodes.
+      module LitNode
+        def value
+          children.first
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/logical_operators.rb

@@ -0,0 +1,26 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Base module for utility methods for :and and :or nodes.
+      module LogicOperatorBase
+        def condition
+          children.first
+        end
+
+        def body_nodes(type, ignoring = [])
+          children[1].find_nodes type, ignoring
+        end
+      end
+
+      # Utility methods for :and nodes.
+      module AndNode
+        include LogicOperatorBase
+      end
+
+      # Utility methods for :or nodes.
+      module OrNode
+        include LogicOperatorBase
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/methods.rb

@@ -0,0 +1,114 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Base module for utility methods for :def and :defs nodes.
+      module MethodNodeBase
+        def arguments
+          parameters.reject(&:block?)
+        end
+
+        def arg_names
+          arguments.map(&:name)
+        end
+
+        def parameters
+          argslist.components
+        end
+
+        def parameter_names
+          parameters.map(&:name)
+        end
+
+        def name_without_bang
+          name.to_s.chop
+        end
+
+        def ends_with_bang?
+          name[-1] == '!'
+        end
+
+        def body_nodes(types, ignoring = [])
+          if body
+            body.find_nodes(types, ignoring)
+          else
+            []
+          end
+        end
+      end
+
+      # Checking if a method is a singleton method.
+      module SingletonMethod
+        def singleton_method?
+          singleton_method_via_class_self_notation?
+        end
+
+        # Ruby allows us to make a method a singleton_method using the
+        # class << self syntax.
+        #
+        # To check for this we check if the parent node is of type :sclass.
+        #
+        # @return [Boolean]
+        def singleton_method_via_class_self_notation?
+          return unless parent
+          parent.type == :sclass
+        end
+      end
+
+      # Utility methods for :def nodes.
+      module DefNode
+        include MethodNodeBase
+        include SingletonMethod
+
+        def name
+          children.first
+        end
+
+        def argslist
+          children[1]
+        end
+
+        def body
+          children[2]
+        end
+
+        def full_name(outer)
+          [outer, name].reject(&:empty?).join('#')
+        end
+
+        def depends_on_instance?
+          ReferenceCollector.new(self).num_refs_to_self > 0
+        end
+      end
+
+      # Utility methods for :defs nodes.
+      module DefsNode
+        include MethodNodeBase
+
+        def receiver
+          children.first
+        end
+
+        def name
+          children[1]
+        end
+
+        def argslist
+          children[2]
+        end
+
+        def body
+          children[3]
+        end
+
+        def full_name(outer)
+          prefix = outer == '' ? '' : "#{outer}#"
+          "#{prefix}#{SexpFormatter.format(receiver)}.#{name}"
+        end
+
+        def depends_on_instance?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/reek/ast/sexp_extensions/module.rb

@@ -0,0 +1,85 @@
+module Reek
+  module AST
+    module SexpExtensions
+      # Base module for utility methods for module nodes.
+      module ModuleNodeBase
+        # The full name of the module or class, including the name of any
+        # module or class it is nested inside of.
+        #
+        # For example, given code like this:
+        #
+        #   module Foo
+        #     class Bar::Baz
+        #     end
+        #   end
+        #
+        # The full name for the inner class will be 'Foo::Bar::Baz'. To return
+        # the correct name, the name of the outer context has to be passed into this method.
+        #
+        # @param outer [String] full name of the wrapping module or class
+        # @return the module's full name
+        def full_name(outer)
+          [outer, name].reject(&:empty?).join('::')
+        end
+
+        # The final section of the module or class name. For example, for a
+        # module with name 'Foo::Bar' this will return 'Bar'; for a module with
+        # name 'Foo' this will return 'Foo'.
+        #
+        # @return [String] the final section of the name
+        def simple_name
+          name.split('::').last
+        end
+
+        def name
+          SexpFormatter.format(children.first)
+        end
+      end
+
+      # Utility methods for :module nodes.
+      module ModuleNode
+        include ModuleNodeBase
+      end
+
+      # Utility methods for :class nodes.
+      module ClassNode
+        include ModuleNodeBase
+        def superclass() children[1] end
+      end
+
+      # Utility methods for :casgn nodes.
+      module CasgnNode
+        include ModuleNodeBase
+
+        def defines_module?
+          return false unless value
+          call = case value.type
+                 when :block
+                   value.call
+                 when :send
+                   value
+                 end
+          call && call.module_creation_call?
+        end
+
+        def name
+          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[2]
+        end
+      end
+    end
+  end
+end