reek 3.8.3 → 3.9.0

data/lib/reek/context/singleton_method_context.rb

@@ -6,6 +6,26 @@ module Reek
     # A context wrapper for any singleton method definition found in a syntax tree.
     #
     class SingletonMethodContext < MethodContext
+      def singleton_method?
+        true
+      end
+
+      def instance_method?
+        false
+      end
+
+      def module_function?
+        false
+      end
+
+      # Was this singleton method defined with an instance method-like syntax?
+      def defined_as_instance_method?
+        type == :def
+      end
+
+      def apply_current_visibility(current_visibility)
+        super if defined_as_instance_method?
+      end
     end
   end
 end

data/lib/reek/context/visibility_tracker.rb

@@ -3,13 +3,14 @@ require 'private_attr/everywhere'
 module Reek
   module Context
     # Responsible for tracking visibilities in regards to CodeContexts.
-    # :reek:Attribute
     class VisibilityTracker
-      attr_accessor :visibility
       private_attr_accessor :tracked_visibility
 
-      def initialize(visibility = :public)
-        @visibility = visibility
+      VISIBILITY_MODIFIERS = [:private, :public, :protected, :module_function]
+      VISIBILITY_MAP = { public_class_method: :public, private_class_method: :private }
+
+      def initialize
+        @tracked_visibility = :public
       end
 
       # Handle the effects of a visibility modifier.
@@ -22,6 +23,7 @@ module Reek
       # @param names [Array<Symbol>]
       #
       def track_visibility(children: raise, visibility: raise, names: raise)
+        return unless VISIBILITY_MODIFIERS.include? visibility
         if names.any?
           children.each do |child|
             child.visibility = visibility if names.include?(child.name)
@@ -31,23 +33,30 @@ module Reek
         end
       end
 
+      # Handle the effects of a singleton visibility modifier. These can only
+      # be used to modify existing children.
+      #
+      # @example
+      #   track_singleton_visibility children, :private_class_method,
+      #     [:hide_me, :implementation_detail]
+      #
+      # @param children [Array<CodeContext>]
+      # @param visibility [Symbol]
+      # @param names [Array<Symbol>]
+      #
+      def track_singleton_visibility(children: raise, visibility: raise, names: raise)
+        return if names.empty?
+        visibility = VISIBILITY_MAP[visibility]
+        return unless visibility
+        track_visibility children: children, visibility: visibility, names: names
+      end
+
       # Sets the visibility of a child CodeContext to the tracked visibility.
       #
       # @param child [CodeContext]
       #
       def set_child_visibility(child)
-        child.visibility = tracked_visibility
-      end
-
-      # @return [Boolean] If the visibility is public or not.
-      def non_public_visibility?
-        visibility != :public
-      end
-
-      private
-
-      def tracked_visibility
-        @tracked_visibility ||= :public
+        child.apply_current_visibility tracked_visibility
       end
     end
   end

data/lib/reek/context_builder.rb

@@ -1,10 +1,12 @@
+require_relative 'context/attribute_context'
+require_relative 'context/class_context'
+require_relative 'context/ghost_context'
 require_relative 'context/method_context'
 require_relative 'context/module_context'
 require_relative 'context/root_context'
-require_relative 'context/singleton_method_context'
-require_relative 'context/attribute_context'
 require_relative 'context/send_context'
-require_relative 'context/class_context'
+require_relative 'context/singleton_attribute_context'
+require_relative 'context/singleton_method_context'
 require_relative 'ast/node'
 
 module Reek
@@ -16,16 +18,16 @@ module Reek
   # counting. Ideally `ContextBuilder` would only build up the context tree and leave the
   # statement and reference counting to the contexts.
   #
-  # :reek:TooManyMethods: { max_methods: 27 }
+  # :reek:TooManyMethods: { max_methods: 30 }
   # :reek:UnusedPrivateMethod: { exclude: [ !ruby/regexp /process_/ ] }
   class ContextBuilder
     attr_reader :context_tree
-    private_attr_accessor :element
+    private_attr_accessor :current_context
     private_attr_reader :exp
 
     def initialize(syntax_tree)
       @exp = syntax_tree
-      @element = Context::RootContext.new(exp)
+      @current_context = Context::RootContext.new(exp)
       @context_tree = build(exp)
     end
 
@@ -60,7 +62,7 @@ module Reek
       else
         process exp
       end
-      element
+      current_context
     end
 
     # Handles every node for which we have no context_processor.
@@ -79,6 +81,19 @@ module Reek
 
     alias_method :process_class, :process_module
 
+    # Handles `sclass` nodes
+    #
+    # An input example that would trigger this method would be:
+    #
+    #   class << self
+    #   end
+    #
+    def process_sclass(exp)
+      inside_new_context(Context::GhostContext, exp) do
+        process(exp)
+      end
+    end
+
     # Handles `casgn` ("class assign") nodes.
     #
     # An input example that would trigger this method would be:
@@ -102,7 +117,7 @@ module Reek
     # Given the above example we would count 2 statements overall.
     #
     def process_def(exp)
-      inside_new_context(Context::MethodContext, exp) do
+      inside_new_context(current_context.method_context_class, exp) do
         increase_statement_count_by(exp.body)
         process(exp)
       end
@@ -133,20 +148,13 @@ module Reek
     # we also record to what the method call is referring to
     # which we later use for smell detectors like FeatureEnvy.
     #
-    # :reek:TooManyStatements: { max_statements: 7 }
-    # :reek:FeatureEnvy
     def process_send(exp)
-      method_name = exp.method_name
-      if exp.visibility_modifier?
-        element.track_visibility(method_name, exp.arg_names)
-      elsif exp.attribute_writer?
-        exp.args.each do |arg|
-          append_new_context(Context::AttributeContext, arg, exp)
-        end
-      else
-        append_new_context(Context::SendContext, exp, method_name)
+      case current_context
+      when Context::ModuleContext
+        handle_send_for_modules exp
+      when Context::MethodContext
+        handle_send_for_methods exp
       end
-      element.record_call_to(exp)
       process(exp)
     end
 
@@ -163,7 +171,7 @@ module Reek
     # We record one reference to `x` given the example above.
     #
     def process_op_asgn(exp)
-      element.record_call_to(exp)
+      current_context.record_call_to(exp)
       process(exp)
     end
 
@@ -182,7 +190,7 @@ module Reek
     # We record one reference to `self`.
     #
     def process_ivar(exp)
-      element.record_use_of_self
+      current_context.record_use_of_self
       process(exp)
     end
 
@@ -195,7 +203,7 @@ module Reek
     #   def self.foo; end
     #
     def process_self(_)
-      element.record_use_of_self
+      current_context.record_use_of_self
     end
 
     # Handles `zsuper` nodes a.k.a. calls to `super` without any arguments but a block possibly.
@@ -215,7 +223,7 @@ module Reek
     # We record one reference to `self`.
     #
     def process_zsuper(_)
-      element.record_use_of_self
+      current_context.record_use_of_self
     end
 
     # Handles `block` nodes.
@@ -435,11 +443,11 @@ module Reek
 
     # :reek:ControlParameter
     def increase_statement_count_by(sexp)
-      element.statement_counter.increase_by sexp
+      current_context.statement_counter.increase_by sexp
     end
 
     def decrease_statement_count
-      element.statement_counter.decrease_by 1
+      current_context.statement_counter.decrease_by 1
     end
 
     # Stores a reference to the current context, creates a nested new one,
@@ -452,12 +460,13 @@ module Reek
     def inside_new_context(klass, exp)
       new_context = append_new_context(klass, exp)
 
-      orig, self.element = element, new_context
+      orig, self.current_context = current_context, new_context
       yield
-      self.element = orig
+      self.current_context = orig
     end
 
-    # Append a new child context to the current element.
+    # Append a new child context to the current context but does not change the
+    # current context.
     #
     # @param klass [Context::*Context] - context class
     # @param args - arguments for the class initializer
@@ -465,8 +474,29 @@ module Reek
     # @return [Context::*Context] - the context that was appended
     #
     def append_new_context(klass, *args)
-      klass.new(element, *args).tap do |new_context|
-        element.append_child_context new_context
+      klass.new(current_context, *args).tap do |new_context|
+        new_context.register_with_parent(current_context)
+      end
+    end
+
+    def handle_send_for_modules(exp)
+      method_name = exp.name
+      arg_names = exp.arg_names
+      current_context.track_visibility(method_name, arg_names)
+      current_context.track_singleton_visibility(method_name, arg_names)
+      register_attributes(exp)
+    end
+
+    def handle_send_for_methods(exp)
+      append_new_context(Context::SendContext, exp, exp.name)
+      current_context.record_call_to(exp)
+    end
+
+    def register_attributes(exp)
+      return unless exp.attribute_writer?
+      klass = current_context.attribute_context_class
+      exp.args.each do |arg|
+        append_new_context(klass, arg, exp)
       end
     end
   end

data/lib/reek/examiner.rb

@@ -1,9 +1,3 @@
-# NOTE: context_builder is required first to ensure unparser is required before
-# parser. This prevents a potentially incompatible version of parser from being
-# loaded first. This is only relevant when running bin/reek straight from a
-# checkout directory without using Bundler.
-#
-# See also https://github.com/troessner/reek/pull/468
 require_relative 'context_builder'
 require_relative 'source/source_code'
 require_relative 'cli/warning_collector'

data/lib/reek/smells/control_parameter.rb

@@ -149,7 +149,7 @@ module Reek
         end
 
         def comparison_call?(call_node)
-          comparison_method_names.include? call_node.method_name
+          comparison_method_names.include? call_node.name
         end
 
         def comparison_method_names

data/lib/reek/smells/nested_iterators.rb

@@ -120,7 +120,7 @@ module Reek
 
       # :reek:FeatureEnvy
       def ignored_iterator?(exp)
-        ignore_iterators.any? { |pattern| /#{pattern}/ =~ exp.call.method_name } ||
+        ignore_iterators.any? { |pattern| /#{pattern}/ =~ exp.call.name } ||
           exp.without_block_arguments?
       end
     end

data/lib/reek/smells/nil_check.rb

@@ -54,7 +54,7 @@ module Reek
         end
 
         def nil_query?(call)
-          call.method_name == :nil?
+          call.name == :nil?
         end
 
         def nil_comparison?(call)
@@ -62,7 +62,7 @@ module Reek
         end
 
         def comparison_call?(call)
-          comparison_methods.include? call.method_name
+          comparison_methods.include? call.name
         end
 
         def involves_nil?(call)

data/lib/reek/smells/utility_function.rb

@@ -58,8 +58,7 @@ module Reek
       # :reek:FeatureEnvy
       # :reek:TooManyStatements: { max_statements: 6 }
       def inspect(ctx)
-        return [] if ctx.singleton_method?
-        return [] if ctx.number_of_statements == 0
+        return [] if ctx.singleton_method? || ctx.module_function?
         return [] if ctx.references_self?
         return [] if num_helper_methods(ctx).zero?
         return [] if ignore_method?(ctx)

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.8.3'
+    STRING = '3.9.0'
   end
 end

data/reek.gemspec

@@ -23,18 +23,7 @@ Gem::Specification.new do |s|
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.1.0'
-  s.add_runtime_dependency 'parser',                '~> 2.2', '>= 2.2.2.5'
+  s.add_runtime_dependency 'parser',                '~> 2.3'
   s.add_runtime_dependency 'private_attr',          '~> 1.1'
   s.add_runtime_dependency 'rainbow',               '~> 2.0'
-  s.add_runtime_dependency 'unparser',              '~> 0.2.2'
-
-  s.add_development_dependency 'activesupport', '~> 4.2'
-  s.add_development_dependency 'aruba',         '~> 0.10.0'
-  s.add_development_dependency 'ataru',         '~> 0.2.0'
-  s.add_development_dependency 'bundler',       '~> 1.1'
-  s.add_development_dependency 'cucumber',      '~> 2.0'
-  s.add_development_dependency 'factory_girl',  '~> 4.0'
-  s.add_development_dependency 'rake',          '~> 10.0'
-  s.add_development_dependency 'rspec',         '~> 3.0'
-  s.add_development_dependency 'rubocop',       '~> 0.34.0'
 end

data/spec/reek/ast/node_spec.rb

@@ -2,9 +2,57 @@ require_relative '../../spec_helper'
 require_lib 'reek/ast/node'
 
 RSpec.describe Reek::AST::Node do
-  context 'format' do
-    it 'formats self' do
-      expect(sexp(:self).format_to_ruby).to eq('self')
+  describe '#format_to_ruby' do
+    it 'returns #to_s if location is not present' do
+      ast = sexp(:self)
+      expect(ast.format_to_ruby).to eq ast.to_s
+    end
+
+    it 'gives the right result for self' do
+      ast = Reek::Source::SourceCode.from('self').syntax_tree
+      expect(ast.format_to_ruby).to eq 'self'
+    end
+
+    it 'gives the right result for a simple expression' do
+      ast = Reek::Source::SourceCode.from('foo').syntax_tree
+      expect(ast.format_to_ruby).to eq 'foo'
+    end
+
+    it 'gives the right result for a more complex expression' do
+      ast = Reek::Source::SourceCode.from('foo(bar)').syntax_tree
+      result = ast.format_to_ruby
+      expect(result).to eq 'foo(bar)'
+    end
+
+    it 'gives te right result for send with a receiver' do
+      ast = Reek::Source::SourceCode.from('baz.foo(bar)').syntax_tree
+      expect(ast.format_to_ruby).to eq 'baz.foo(bar)'
+    end
+
+    it 'gives the right result for if' do
+      source = <<-SRC
+        if foo
+          bar
+        else
+          baz
+          qux
+        end
+      SRC
+
+      ast = Reek::Source::SourceCode.from(source).syntax_tree
+      expect(ast.format_to_ruby).to eq 'if foo ... end'
+    end
+
+    it 'gives the right result for def with no body' do
+      source = "def my_method\nend"
+      ast = Reek::Source::SourceCode.from(source).syntax_tree
+      expect(ast.format_to_ruby).to eq 'def my_method; end'
+    end
+
+    it 'gives the right result for ivar' do
+      source = '@foo'
+      ast = Reek::Source::SourceCode.from(source).syntax_tree
+      expect(ast.format_to_ruby).to eq '@foo'
     end
   end
 

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -319,8 +319,7 @@ end
 RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
   context 'with a simple name' do
     subject do
-      mod = sexp(:module, :Fred, nil)
-      mod
+      Reek::Source::SourceCode.from('module Fred; end').syntax_tree
     end
 
     it 'has the correct #name' do
@@ -342,7 +341,7 @@ RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
 
   context 'with a scoped name' do
     subject do
-      sexp(:module, sexp(:const, sexp(:const, nil, :Foo), :Bar), nil)
+      Reek::Source::SourceCode.from('module Foo::Bar; end').syntax_tree
     end
 
     it 'has the correct #name' do
@@ -361,6 +360,20 @@ RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
       expect(subject.full_name('Blimey::O::Reilly')).to eq 'Blimey::O::Reilly::Foo::Bar'
     end
   end
+
+  context 'with a name scoped in a namespace that is not a constant' do
+    subject do
+      Reek::Source::SourceCode.from('module foo::Bar; end').syntax_tree
+    end
+
+    it 'has the correct #name' do
+      expect(subject.name).to eq 'foo::Bar'
+    end
+
+    it 'has the correct #simple_name' do
+      expect(subject.simple_name).to eq 'Bar'
+    end
+  end
 end
 
 RSpec.describe Reek::AST::SexpExtensions::CasgnNode do