reek 3.4.0 → 3.4.1

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -18,14 +18,9 @@ module Reek
     #
     # See {file:docs/Uncommunicative-Parameter-Name.md} for details.
     class UncommunicativeParameterName < SmellDetector
-      # The name of the config field that lists the regexps of
-      # smelly names to be reported.
       REJECT_KEY = 'reject'
       DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/, /[A-Z]/, /^_/]
 
-      # The name of the config field that lists the specific names that are
-      # to be treated as exceptions; these names will not be reported as
-      # uncommunicative.
       ACCEPT_KEY = 'accept'
       DEFAULT_ACCEPT_NAMES = []
 
@@ -45,14 +40,15 @@ module Reek
       #
       # @return [Array<SmellWarning>]
       #
-      def examine_context(ctx)
-        context_expression = ctx.exp
-        context_expression.parameter_names.select do |name|
-          bad_name?(ctx, name) && ctx.uses_param?(name)
+      def examine_context(context)
+        expression = context.exp
+        expression.parameter_names.select do |name|
+          sanitized_name = sanitize name
+          uncommunicative_parameter_name?(name: sanitized_name, context: context)
         end.map do |name|
           smell_warning(
-            context: ctx,
-            lines: [context_expression.line],
+            context: context,
+            lines: [expression.line],
             message: "has the parameter name '#{name}'",
             parameters: { name: name.to_s })
         end
@@ -60,10 +56,13 @@ module Reek
 
       private
 
-      def bad_name?(ctx, name)
-        sanitized_name = sanitize name
-        return false if sanitized_name == '*' || accept_names(ctx).include?(sanitized_name)
-        reject_patterns(ctx).any? { |pattern| sanitized_name.match pattern }
+      def uncommunicative_parameter_name?(name: raise, context: raise)
+        !acceptable_name?(name: name, context: context) && context.uses_param?(name)
+      end
+
+      def acceptable_name?(name: raise, context: raise)
+        accept_names(context).any? { |accept_name| name == accept_name } ||
+          reject_patterns(context).none? { |pattern| name.match pattern }
       end
 
       def reject_patterns(context)

data/lib/reek/spec/should_reek_of.rb

@@ -7,6 +7,12 @@ module Reek
     # code smell.
     #
     class ShouldReekOf
+      attr_reader :failure_message, :failure_message_when_negated
+
+      private_attr_reader :configuration, :smell_category, :smell_details
+      private_attr_writer :failure_message, :failure_message_when_negated
+      private_attr_accessor :examiner
+
       def initialize(smell_category,
                      smell_details = {},
                      configuration = Configuration::AppConfiguration.default)
@@ -17,22 +23,51 @@ module Reek
 
       def matches?(actual)
         self.examiner = Examiner.new(actual, configuration: configuration)
-        self.all_smells = examiner.smells
-        all_smells.any? { |warning| warning.matches?(smell_category, smell_details) }
+        set_failure_messages
+        matching_smell_types? && matching_smell_details?
       end
 
-      def failure_message
-        "Expected #{examiner.description} to reek of #{smell_category}, but it didn't"
+      private
+
+      def set_failure_messages
+        # We set the failure messages for non-matching smell type unconditionally since we
+        # need that in any case for "failure_message_when_negated" below.
+        # Depending on the existence of matching smell type we check for matching
+        # smell details and then overwrite our failure messages conditionally.
+        set_failure_messages_for_smell_type
+        set_failure_messages_for_smell_details if matching_smell_types? && !matching_smell_details?
       end
 
-      def failure_message_when_negated
-        "Expected #{examiner.description} not to reek of #{smell_category}, but it did"
+      def matching_smell_types
+        @matching_smell_types ||= examiner.smells.
+          select { |warning| warning.matches_smell_type?(smell_category) }
       end
 
-      private
+      def matching_smell_types?
+        matching_smell_types.any?
+      end
 
-      private_attr_reader :configuration, :smell_category, :smell_details
-      private_attr_accessor :all_smells, :examiner
+      def matching_smell_details?
+        matching_smell_types.any? { |warning| warning.matches_smell_details?(smell_details) }
+      end
+
+      def set_failure_messages_for_smell_type
+        self.failure_message = "Expected #{origin} to reek of #{smell_category}, "\
+          'but it didn\'t'
+        self.failure_message_when_negated = "Expected #{origin} not to reek "\
+          "of #{smell_category}, but it did"
+      end
+
+      def set_failure_messages_for_smell_details
+        self.failure_message = "Expected #{origin} to reek of #{smell_category} "\
+          "(which it did) with smell details #{smell_details}, which it didn't"
+        self.failure_message_when_negated = "Expected #{origin} not to reek of "\
+          "#{smell_category} with smell details #{smell_details}, but it did"
+      end
+
+      def origin
+        examiner.description
+      end
 
       # :reek:UtilityFunction
       def normalize(smell_category_or_type)

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.4.0'
+    STRING = '3.4.1'
   end
 end

data/reek.gemspec

@@ -28,12 +28,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'unparser',     '~> 0.2.2'
 
   s.add_development_dependency 'activesupport', '~> 4.2'
-  s.add_development_dependency 'aruba',         '~> 0.8.0'
+  s.add_development_dependency 'aruba',         '~> 0.9.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.33.0'
+  s.add_development_dependency 'rubocop',       '~> 0.34.0'
 end

data/spec/reek/ast/node_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/ast/node'
+require_lib 'reek/ast/node'
 
 RSpec.describe Reek::AST::Node do
   context 'format' do

data/spec/reek/ast/object_refs_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/ast/object_refs'
+require_lib 'reek/ast/object_refs'
 
 RSpec.describe Reek::AST::ObjectRefs do
   let(:refs) { Reek::AST::ObjectRefs.new }

data/spec/reek/ast/reference_collector_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/ast/reference_collector'
+require_lib 'reek/ast/reference_collector'
 
 RSpec.describe Reek::AST::ReferenceCollector do
   context 'counting refs to self' do

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/ast/sexp_extensions'
+require_lib 'reek/ast/sexp_extensions'
 
 RSpec.describe Reek::AST::SexpExtensions::DefNode do
   context 'with no parameters' do
@@ -231,6 +231,22 @@ RSpec.describe Reek::AST::SexpExtensions::DefsNode do
   end
 end
 
+RSpec.describe Reek::AST::SexpExtensions::LvarNode do
+  let(:node) { sexp(:lvar, :foo) }
+
+  describe '#simple_name' do
+    it 'returns the lvar’s name' do
+      expect(node.simple_name).to eq(:foo)
+    end
+  end
+
+  describe '#var_name' do
+    it 'returns the lvar’s name' do
+      expect(node.var_name).to eq(:foo)
+    end
+  end
+end
+
 RSpec.describe Reek::AST::SexpExtensions::SendNode do
   context 'with no parameters' do
     let(:node) { sexp(:send, nil, :hello) }
@@ -238,6 +254,26 @@ RSpec.describe Reek::AST::SexpExtensions::SendNode do
     it 'has no argument names' do
       expect(node.arg_names).to eq []
     end
+
+    it 'is not considered to be a writable attr' do
+      expect(sexp(:send, nil, :attr).attr_with_writable_flag?).to be_falsey
+    end
+  end
+
+  context 'when it’s ‘new’ with no parameters and no receiver' do
+    let(:bare_new) { sexp(:send, nil, :new) }
+
+    it 'is not considered to be a module creation call' do
+      expect(bare_new.module_creation_call?).to be_falsey
+    end
+
+    it 'is not considered to have a module creation receiver' do
+      expect(bare_new.module_creation_receiver?).to be_falsey
+    end
+
+    it 'is considered to be an object creation call' do
+      expect(bare_new.object_creation_call?).to be_truthy
+    end
   end
 
   context 'with 1 literal parameter' do
@@ -264,6 +300,10 @@ RSpec.describe Reek::AST::SexpExtensions::BlockNode do
     it 'has no parameter names' do
       expect(node.parameter_names).to eq []
     end
+
+    it 'has a name' do
+      expect(node.simple_name).to eq(:block)
+    end
   end
 
   context 'with 1 parameter' do
@@ -337,7 +377,14 @@ RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
     end
 
     it 'does not define a module' do
-      expect(subject.defines_module?).to eq(false)
+      expect(subject.defines_module?).to be_falsey
+    end
+  end
+
+  context 'with implicit receiver to new' do
+    it 'does not define a module' do
+      exp = sexp(:casgn, nil, :Foo, sexp(:send, nil, :new))
+      expect(exp.defines_module?).to be_falsey
     end
   end
 end

data/spec/reek/ast/sexp_formatter_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/ast/sexp_formatter'
+require_lib 'reek/ast/sexp_formatter'
 
 RSpec.describe Reek::AST::SexpFormatter do
   describe '::format' do

data/spec/reek/cli/option_interpreter_spec.rb

@@ -1,19 +1,19 @@
 require_relative '../../spec_helper'
 
-require_relative '../../../lib/reek/cli/options'
-require_relative '../../../lib/reek/report/report'
+require_lib 'reek/cli/options'
+require_lib 'reek/cli/option_interpreter'
+require_lib 'reek/report/report'
 
 RSpec.describe Reek::CLI::OptionInterpreter do
   describe '#reporter' do
-    let(:instance) { Reek::CLI::OptionInterpreter.new(options) }
-
     context 'with a valid set of options' do
       let(:options) do
-        OpenStruct.new(report_format: :text,
-                       location_format: :plain)
+        Reek::CLI::Options.new.parse
       end
+      subject { described_class.new(options) }
+
       it 'returns an object of the correct subclass of Report::Base' do
-        expect(instance.reporter).to be_instance_of Reek::Report::TextReport
+        expect(subject.reporter).to be_instance_of Reek::Report::TextReport
       end
     end
   end

data/spec/reek/cli/options_spec.rb

@@ -1,28 +1,36 @@
 require_relative '../../spec_helper'
-
-require_relative '../../../lib/reek/cli/options'
+require_lib 'reek/cli/options'
 
 RSpec.describe Reek::CLI::Options do
-  describe '#parse' do
-    context 'with no arguments passed' do
-      let(:options) { Reek::CLI::Options.new.parse }
-      it 'enables colors when stdout is a TTY' do
-        allow($stdout).to receive_messages(tty?: false)
-        expect(options.colored).to be false
-      end
+  describe '#initialize' do
+    it 'sets a valid default value for report_format' do
+      expect(subject.report_format).to eq :text
+    end
 
-      it 'does not enable colors when stdout is not a TTY' do
-        allow($stdout).to receive_messages(tty?: true)
-        expect(options.colored).to be true
-      end
+    it 'sets a valid default value for location_format' do
+      expect(subject.location_format).to eq :numbers
+    end
+
+    it 'enables colors when stdout is a TTY' do
+      allow($stdout).to receive_messages(tty?: false)
+      expect(subject.colored).to be false
+    end
 
-      it 'sets a valid default value for report_format' do
-        expect(options.report_format).to eq :text
-      end
+    it 'does not enable colors when stdout is not a TTY' do
+      allow($stdout).to receive_messages(tty?: true)
+      expect(subject.colored).to be true
+    end
+  end
+
+  describe 'parse' do
+    it 'raises on invalid argument in ARGV' do
+      options = described_class.new
+      options.argv = ['-z']
+      expect { options.parse }.to raise_error(OptionParser::InvalidOption)
+    end
 
-      it 'sets a valid default value for location_format' do
-        expect(options.location_format).to eq :numbers
-      end
+    it 'returns self' do
+      expect(subject.parse).to be_a(described_class)
     end
   end
 end

data/spec/reek/cli/warning_collector_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/cli/warning_collector'
-require_relative '../../../lib/reek/smells/smell_warning'
+require_lib 'reek/cli/warning_collector'
+require_lib 'reek/smells/smell_warning'
 
 RSpec.describe Reek::CLI::WarningCollector do
   let(:collector) { described_class.new }

data/spec/reek/code_comment_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../spec_helper'
-require_relative '../../lib/reek/code_comment'
+require_lib 'reek/code_comment'
 
 RSpec.describe Reek::CodeComment do
   context 'with an empty comment' do

data/spec/reek/configuration/app_configuration_spec.rb

@@ -1,9 +1,9 @@
 require 'pathname'
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/configuration/app_configuration'
-require_relative '../../../lib/reek/configuration/directory_directives'
-require_relative '../../../lib/reek/configuration/default_directive'
-require_relative '../../../lib/reek/configuration/excluded_paths'
+require_lib 'reek/configuration/app_configuration'
+require_lib 'reek/configuration/directory_directives'
+require_lib 'reek/configuration/default_directive'
+require_lib 'reek/configuration/excluded_paths'
 
 RSpec.describe Reek::Configuration::AppConfiguration do
   describe '#new' do

data/spec/reek/configuration/default_directive_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/configuration/default_directive'
+require_lib 'reek/configuration/default_directive'
 
 RSpec.describe Reek::Configuration::DefaultDirective do
   describe '#add' do

data/spec/reek/configuration/directory_directives_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/configuration/directory_directives'
+require_lib 'reek/configuration/directory_directives'
 
 RSpec.describe Reek::Configuration::DirectoryDirectives do
   describe '#directive_for' do

data/spec/reek/configuration/excluded_paths_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/configuration/excluded_paths'
+require_lib 'reek/configuration/excluded_paths'
 
 RSpec.describe Reek::Configuration::ExcludedPaths do
   describe '#add' do

data/spec/reek/context/code_context_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/method_context'
-require_relative '../../../lib/reek/context/module_context'
+require_lib 'reek/context/method_context'
+require_lib 'reek/context/module_context'
 
 RSpec.describe Reek::Context::CodeContext do
   context 'name recognition' do

data/spec/reek/context/method_context_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/method_context'
+require_lib 'reek/context/method_context'
 
 RSpec.describe Reek::Context::MethodContext do
   let(:method_context) { Reek::Context::MethodContext.new(nil, exp) }

data/spec/reek/context/module_context_spec.rb

@@ -1,6 +1,6 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/module_context'
-require_relative '../../../lib/reek/context/root_context'
+require_lib 'reek/context/module_context'
+require_lib 'reek/context/root_context'
 
 RSpec.describe Reek::Context::ModuleContext do
   it 'should report module name for smell in method' do

data/spec/reek/context/root_context_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/root_context'
+require_lib 'reek/context/root_context'
 
 RSpec.describe Reek::Context::RootContext do
   context 'full_name' do

data/spec/reek/context/singleton_method_context_spec.rb

@@ -1,5 +1,5 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/context/singleton_method_context'
+require_lib 'reek/context/singleton_method_context'
 
 RSpec.describe Reek::Context::SingletonMethodContext do
   let(:smc) do