reek 3.7.1 → 3.8.0

data/spec/reek/smells/unused_private_method_spec.rb

@@ -0,0 +1,110 @@
+require_relative '../../spec_helper'
+require_lib 'reek/smells/unused_private_method'
+require_lib 'reek/examiner'
+require_relative 'smell_detector_shared'
+
+RSpec.describe Reek::Smells::UnusedPrivateMethod do
+  let(:detector) { build(:smell_detector, smell_type: :UnusedPrivateMethod) }
+
+  it_should_behave_like 'SmellDetector'
+
+  context 'unused private methods' do
+    it 'reports instance methods' do
+      source = <<-EOF
+        class Car
+          private
+          def start; end
+          def drive; end
+        end
+      EOF
+
+      expect(source).to reek_of(:UnusedPrivateMethod, name: :start)
+      expect(source).to reek_of(:UnusedPrivateMethod, name: :drive)
+    end
+
+    it 'creates warnings correctly' do
+      source = <<-EOF
+        class Car
+          private
+          def start; end
+          def drive; end
+        end
+      EOF
+
+      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod')
+
+      first_warning = examiner.smells.first
+      expect(first_warning.smell_category).to eq(Reek::Smells::UnusedPrivateMethod.smell_category)
+      expect(first_warning.smell_type).to eq(Reek::Smells::UnusedPrivateMethod.smell_type)
+      expect(first_warning.parameters[:name]).to eq(:drive)
+      expect(first_warning.lines).to eq([4])
+
+      second_warning = examiner.smells.last
+      expect(second_warning.smell_category).to eq(Reek::Smells::UnusedPrivateMethod.smell_category)
+      expect(second_warning.smell_type).to eq(Reek::Smells::UnusedPrivateMethod.smell_type)
+      expect(second_warning.parameters[:name]).to eq(:start)
+      expect(second_warning.lines).to eq([3])
+    end
+  end
+
+  describe 'configuring the detector via source code comment' do
+    it 'does not report methods we excluded' do
+      source = <<-EOF
+        # :reek:UnusedPrivateMethod: { exclude: [ start ] }
+        class Car
+          private
+          def start; end
+          def drive; end
+        end
+      EOF
+
+      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod')
+
+      expect(examiner.smells.size).to eq(1)
+      warning_for_drive = examiner.smells.first
+      expect(warning_for_drive.parameters[:name]).to eq(:drive)
+    end
+  end
+
+  context 'used private methods' do
+    it 'are not reported' do
+      source = <<-EOF
+        class Car
+          def drive
+            start
+          end
+
+          private
+          def start; end
+        end
+      EOF
+
+      expect(source).not_to reek_of(:UnusedPrivateMethod)
+    end
+  end
+
+  context 'unused protected methods' do
+    it 'are not reported' do
+      source = <<-EOF
+        class Car
+          protected
+          def start; end
+        end
+      EOF
+
+      expect(source).not_to reek_of(:UnusedPrivateMethod)
+    end
+  end
+
+  context 'unused public methods' do
+    it 'are not reported' do
+      source = <<-EOF
+        class Car
+          def start; end
+        end
+      EOF
+
+      expect(source).not_to reek_of(:UnusedPrivateMethod)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -33,6 +33,13 @@ module Helpers
     configuration
   end
 
+  # @param code [String] The given code.
+  #
+  # @return syntax_tree [Reek::AST::Node]
+  def syntax_tree(code)
+    Reek::Source::SourceCode.from(code).syntax_tree
+  end
+
   # :reek:UncommunicativeMethodName
   def sexp(type, *children)
     @klass_map ||= Reek::AST::ASTNodeClassMap.new

data/tasks/console.rake

@@ -0,0 +1,5 @@
+desc 'Starts the interactive console'
+task :console do
+  require 'pry'
+  Pry.start
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.8.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -276,6 +276,7 @@ files:
 - docs/Uncommunicative-Parameter-Name.md
 - docs/Uncommunicative-Variable-Name.md
 - docs/Unused-Parameters.md
+- docs/Unused-Private-Method.md
 - docs/Utility-Function.md
 - docs/Versioning-Policy.md
 - docs/YAML-Reports.md
@@ -342,11 +343,16 @@ files:
 - lib/reek/configuration/directory_directives.rb
 - lib/reek/configuration/excluded_paths.rb
 - lib/reek/context/attribute_context.rb
+- lib/reek/context/class_context.rb
 - lib/reek/context/code_context.rb
 - lib/reek/context/method_context.rb
 - lib/reek/context/module_context.rb
 - lib/reek/context/root_context.rb
+- lib/reek/context/send_context.rb
 - lib/reek/context/singleton_method_context.rb
+- lib/reek/context/statement_counter.rb
+- lib/reek/context/visibility_tracker.rb
+- lib/reek/context_builder.rb
 - lib/reek/examiner.rb
 - lib/reek/rake/task.rb
 - lib/reek/report.rb
@@ -384,6 +390,7 @@ files:
 - lib/reek/smells/uncommunicative_parameter_name.rb
 - lib/reek/smells/uncommunicative_variable_name.rb
 - lib/reek/smells/unused_parameters.rb
+- lib/reek/smells/unused_private_method.rb
 - lib/reek/smells/utility_function.rb
 - lib/reek/source/source_code.rb
 - lib/reek/source/source_locator.rb
@@ -393,7 +400,6 @@ files:
 - lib/reek/spec/should_reek_only_of.rb
 - lib/reek/spec/smell_matcher.rb
 - lib/reek/tree_dresser.rb
-- lib/reek/tree_walker.rb
 - lib/reek/version.rb
 - logo/reek.bw.png
 - logo/reek.bw.svg
@@ -409,6 +415,7 @@ files:
 - spec/reek/ast/reference_collector_spec.rb
 - spec/reek/ast/sexp_extensions_spec.rb
 - spec/reek/ast/sexp_formatter_spec.rb
+- spec/reek/cli/input_spec.rb
 - spec/reek/cli/option_interpreter_spec.rb
 - spec/reek/cli/options_spec.rb
 - spec/reek/cli/warning_collector_spec.rb
@@ -422,7 +429,7 @@ files:
 - spec/reek/context/method_context_spec.rb
 - spec/reek/context/module_context_spec.rb
 - spec/reek/context/root_context_spec.rb
-- spec/reek/context/singleton_method_context_spec.rb
+- spec/reek/context_builder_spec.rb
 - spec/reek/examiner_spec.rb
 - spec/reek/report/code_climate_formatter_spec.rb
 - spec/reek/report/code_climate_report_spec.rb
@@ -459,6 +466,7 @@ files:
 - spec/reek/smells/uncommunicative_parameter_name_spec.rb
 - spec/reek/smells/uncommunicative_variable_name_spec.rb
 - spec/reek/smells/unused_parameters_spec.rb
+- spec/reek/smells/unused_private_method_spec.rb
 - spec/reek/smells/utility_function_spec.rb
 - spec/reek/source/source_code_spec.rb
 - spec/reek/source/source_locator_spec.rb
@@ -467,7 +475,6 @@ files:
 - spec/reek/spec/should_reek_spec.rb
 - spec/reek/spec/smell_matcher_spec.rb
 - spec/reek/tree_dresser_spec.rb
-- spec/reek/tree_walker_spec.rb
 - spec/samples/all_but_one_masked/clean_one.rb
 - spec/samples/all_but_one_masked/dirty.rb
 - spec/samples/all_but_one_masked/masked.reek
@@ -503,6 +510,7 @@ files:
 - spec/samples/two_smelly_files/dirty_two.rb
 - spec/spec_helper.rb
 - tasks/configuration.rake
+- tasks/console.rake
 - tasks/reek.rake
 - tasks/rubocop.rake
 - tasks/test.rake

data/lib/reek/tree_walker.rb

@@ -1,237 +0,0 @@
-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 'ast/node'
-
-module Reek
-  #
-  # Traverses an abstract syntax tree and fires events whenever it encounters
-  # specific node types.
-  #
-  # SMELL: This class is responsible for counting statements and for feeding
-  # each context to the smell repository.
-  #
-  # TODO: Make TreeWalker responsible only for creating Context objects, and
-  # loop over the created set of contexts elsewhere.
-  #
-  # :reek:TooManyMethods: { max_methods: 29 }
-  class TreeWalker
-    def initialize(smell_repository, exp)
-      @smell_repository = smell_repository
-      @exp = exp
-      @element = Context::RootContext.new(exp)
-    end
-
-    def walk
-      context_tree.each do |element|
-        smell_repository.examine(element)
-      end
-    end
-
-    private
-
-    private_attr_accessor :element
-    private_attr_reader :exp, :smell_repository
-
-    # Processes the given AST, memoizes it and returns a tree of nested
-    # contexts.
-    #
-    # For example this ruby code:
-    #   class Car; def drive; end; end
-    # would get compiled into this AST:
-    #   (class
-    #     (const nil :Car) nil
-    #     (def :drive
-    #       (args) nil))
-    # Processing this AST would result in a context tree where each node
-    # contains the outer context, the AST and the child contexts. The top
-    # node is always Reek::Context::RootContext. Using the example above,
-    # the tree would look like this:
-    #
-    # RootContext -> children: 1 ModuleContext -> children: 1 MethodContext
-    #
-    # @return [Reek::Context::RootContext] tree of nested contexts
-    def context_tree
-      @context_tree ||= process(exp)
-    end
-
-    def process(exp)
-      context_processor = "process_#{exp.type}"
-      if context_processor_exists?(context_processor)
-        send(context_processor, exp)
-      else
-        process_default exp
-      end
-      element
-    end
-
-    def process_module(exp)
-      inside_new_context(Context::ModuleContext, exp) do
-        process_default(exp)
-      end
-    end
-
-    alias_method :process_class, :process_module
-
-    def process_casgn(exp)
-      if exp.defines_module?
-        process_module(exp)
-      else
-        process_default(exp)
-      end
-    end
-
-    def process_def(exp)
-      inside_new_context(Context::MethodContext, exp) do
-        count_clause(exp.body)
-        process_default(exp)
-      end
-    end
-
-    def process_defs(exp)
-      inside_new_context(Context::SingletonMethodContext, exp) do
-        count_clause(exp.body)
-        process_default(exp)
-      end
-    end
-
-    def process_default(exp)
-      exp.children.each do |child|
-        process(child) if child.is_a? AST::Node
-      end
-    end
-
-    def process_args(_) end
-
-    # :reek:TooManyStatements: { max_statements: 6 }
-    # :reek:FeatureEnvy
-    def process_send(exp)
-      if exp.visibility_modifier?
-        element.track_visibility(exp.method_name, exp.arg_names)
-      end
-      if exp.attribute_writer?
-        exp.args.each do |arg|
-          next unless arg.type == :sym
-          new_context(Context::AttributeContext, arg, exp)
-        end
-      end
-      element.record_call_to(exp)
-      process_default(exp)
-    end
-
-    def process_attrasgn(exp)
-      element.record_call_to(exp)
-      process_default(exp)
-    end
-
-    alias_method :process_op_asgn, :process_attrasgn
-
-    def process_ivar(exp)
-      element.record_use_of_self
-      process_default(exp)
-    end
-
-    alias_method :process_ivasgn, :process_ivar
-
-    def process_self(_)
-      element.record_use_of_self
-    end
-
-    alias_method :process_zsuper, :process_self
-
-    #
-    # Statement counting
-    #
-
-    def process_block(exp)
-      count_clause(exp.block)
-      process_default(exp)
-    end
-
-    def process_begin(exp)
-      count_statement_list(exp.children)
-      element.count_statements(-1)
-      process_default(exp)
-    end
-
-    alias_method :process_kwbegin, :process_begin
-
-    def process_if(exp)
-      children = exp.children
-      count_clause(children[1])
-      count_clause(children[2])
-      element.count_statements(-1)
-      process_default(exp)
-    end
-
-    def process_while(exp)
-      count_clause(exp.children[1])
-      element.count_statements(-1)
-      process_default(exp)
-    end
-
-    alias_method :process_until, :process_while
-
-    def process_for(exp)
-      count_clause(exp.children[2])
-      element.count_statements(-1)
-      process_default(exp)
-    end
-
-    def process_rescue(exp)
-      count_clause(exp.children.first)
-      element.count_statements(-1)
-      process_default(exp)
-    end
-
-    def process_resbody(exp)
-      count_statement_list(exp.children[1..-1].compact)
-      process_default(exp)
-    end
-
-    def process_case(exp)
-      count_clause(exp.else_body)
-      element.count_statements(-1)
-      process_default(exp)
-    end
-
-    def process_when(exp)
-      count_clause(exp.body)
-      process_default(exp)
-    end
-
-    def context_processor_exists?(name)
-      self.class.private_method_defined?(name)
-    end
-
-    # :reek:ControlParameter
-    def count_clause(sexp)
-      element.count_statements(1) if sexp
-    end
-
-    def count_statement_list(statement_list)
-      element.count_statements statement_list.length
-    end
-
-    def inside_new_context(klass, exp)
-      push(new_context(klass, exp)) do
-        yield
-      end
-    end
-
-    def new_context(klass, *args)
-      klass.new(element, *args).tap do |scope|
-        element.append_child_context(scope)
-      end
-    end
-
-    def push(scope)
-      orig = element
-      self.element = scope
-      yield
-      self.element = orig
-    end
-  end
-end

data/spec/reek/context/singleton_method_context_spec.rb

@@ -1,16 +0,0 @@
-require_relative '../../spec_helper'
-require_lib 'reek/context/singleton_method_context'
-
-RSpec.describe Reek::Context::SingletonMethodContext do
-  let(:smc) do
-    sexp = sexp(:def, :foo, sexp(:args, sexp(:arg, :bar)), nil)
-    Reek::Context::SingletonMethodContext.new(nil, sexp)
-  end
-
-  describe '#envious_receivers' do
-    it 'should not record envious calls' do
-      smc.record_call_to sexp(:send, sexp(:lvar, :bar), :baz)
-      expect(smc.envious_receivers).to be_empty
-    end
-  end
-end