reek 3.10.1 → 3.10.2

data/lib/reek/smells/smell_detector.rb

@@ -17,15 +17,14 @@ module Reek
     # :reek:UnusedPrivateMethod: { exclude: [ inherited, smell_warning ] }
     class SmellDetector
       attr_reader :config
-      private_attr_accessor :smells_found
       # The name of the config field that lists the names of code contexts
       # that should not be checked. Add this field to the config for each
       # smell that should ignore this code element.
-      EXCLUDE_KEY = 'exclude'
+      EXCLUDE_KEY = 'exclude'.freeze
 
       # The default value for the +EXCLUDE_KEY+ if it isn't specified
       # in any configuration file.
-      DEFAULT_EXCLUDE_SET = []
+      DEFAULT_EXCLUDE_SET = [].freeze
 
       def initialize(config = {})
         @config       = SmellConfiguration.new self.class.default_config.merge(config)
@@ -61,6 +60,8 @@ module Reek
 
       private
 
+      attr_accessor :smells_found
+
       def enabled_for?(context)
         config.enabled? && config_for(context)[SmellConfiguration::ENABLED_KEY] != false
       end

data/lib/reek/smells/smell_repository.rb

@@ -8,8 +8,6 @@ module Reek
     # Contains all the existing smells and exposes operations on them.
     #
     class SmellRepository
-      private_attr_reader :configuration, :smell_types, :detectors
-
       # @return [Array<Reek::Smells::SmellDetector>] All known SmellDetectors
       #         e.g. [Reek::Smells::BooleanParameter, Reek::Smells::ClassVariable].
       def self.smell_types
@@ -51,6 +49,8 @@ module Reek
 
       private
 
+      attr_reader :configuration, :smell_types, :detectors
+
       def configuration_for(klass)
         configuration.fetch klass, {}
       end

data/lib/reek/smells/smell_warning.rb

@@ -25,7 +25,7 @@ module Reek
       #
       # :reek:LongParameterList: { max_params: 6 }
       def initialize(smell_detector, context: '', lines: raise, message: raise,
-                                     source: raise, parameters: {})
+                     source: raise, parameters: {})
         @smell_detector = smell_detector
         @source         = source
         @context        = context.to_s

data/lib/reek/smells/too_many_instance_variables.rb

@@ -14,7 +14,7 @@ module Reek
     class TooManyInstanceVariables < SmellDetector
       # The name of the config field that sets the maximum number of instance
       # variables permitted in a class.
-      MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'
+      MAX_ALLOWED_IVARS_KEY = 'max_instance_variables'.freeze
       DEFAULT_MAX_IVARS = 4
 
       def self.smell_category

data/lib/reek/smells/too_many_methods.rb

@@ -16,7 +16,7 @@ module Reek
     class TooManyMethods < SmellDetector
       # The name of the config field that sets the maximum number of methods
       # permitted in a class.
-      MAX_ALLOWED_METHODS_KEY = 'max_methods'
+      MAX_ALLOWED_METHODS_KEY = 'max_methods'.freeze
       DEFAULT_MAX_METHODS = 15
 
       def self.smell_category

data/lib/reek/smells/too_many_statements.rb

@@ -12,7 +12,7 @@ module Reek
     class TooManyStatements < SmellDetector
       # The name of the config field that sets the maximum number of
       # statements permitted in any method.
-      MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'
+      MAX_ALLOWED_STATEMENTS_KEY = 'max_statements'.freeze
       DEFAULT_MAX_STATEMENTS = 5
 
       def self.smell_category

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -18,10 +18,10 @@ module Reek
     #
     # See {file:docs/Uncommunicative-Method-Name.md} for details.
     class UncommunicativeMethodName < SmellDetector
-      REJECT_KEY = 'reject'
-      ACCEPT_KEY = 'accept'
-      DEFAULT_REJECT_PATTERNS = [/^[a-z]$/, /[0-9]$/, /[A-Z]/]
-      DEFAULT_ACCEPT_NAMES = []
+      REJECT_KEY = 'reject'.freeze
+      ACCEPT_KEY = 'accept'.freeze
+      DEFAULT_REJECT_PATTERNS = [/^[a-z]$/, /[0-9]$/, /[A-Z]/].freeze
+      DEFAULT_ACCEPT_NAMES = [].freeze
 
       def self.smell_category
         'UncommunicativeName'

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -20,14 +20,14 @@ module Reek
     class UncommunicativeModuleName < 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]$/]
+      REJECT_KEY = 'reject'.freeze
+      DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/].freeze
 
       # 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 = []
+      ACCEPT_KEY = 'accept'.freeze
+      DEFAULT_ACCEPT_NAMES = [].freeze
 
       def self.smell_category
         'UncommunicativeName'

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -18,11 +18,11 @@ module Reek
     #
     # See {file:docs/Uncommunicative-Parameter-Name.md} for details.
     class UncommunicativeParameterName < SmellDetector
-      REJECT_KEY = 'reject'
-      DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/, /[A-Z]/, /^_/]
+      REJECT_KEY = 'reject'.freeze
+      DEFAULT_REJECT_PATTERNS = [/^.$/, /[0-9]$/, /[A-Z]/, /^_/].freeze
 
-      ACCEPT_KEY = 'accept'
-      DEFAULT_ACCEPT_NAMES = []
+      ACCEPT_KEY = 'accept'.freeze
+      DEFAULT_ACCEPT_NAMES = [].freeze
 
       def self.smell_category
         'UncommunicativeName'

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -22,14 +22,14 @@ module Reek
     class UncommunicativeVariableName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.
-      REJECT_KEY = 'reject'
-      DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/, /[A-Z]/]
+      REJECT_KEY = 'reject'.freeze
+      DEFAULT_REJECT_SET = [/^.$/, /[0-9]$/, /[A-Z]/].freeze
 
       # 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_SET = ['_']
+      ACCEPT_KEY = 'accept'.freeze
+      DEFAULT_ACCEPT_SET = ['_'].freeze
 
       def self.smell_category
         'UncommunicativeName'
@@ -130,7 +130,7 @@ module Reek
 
       private
 
-      private_attr_accessor :accept_names, :reject_names
+      attr_accessor :accept_names, :reject_names
     end
   end
 end

data/lib/reek/source/source_code.rb

@@ -11,8 +11,8 @@ module Reek
     # A +Source+ object represents a chunk of Ruby source code.
     #
     class SourceCode
-      IO_IDENTIFIER     = 'STDIN'
-      STRING_IDENTIFIER = 'string'
+      IO_IDENTIFIER     = 'STDIN'.freeze
+      STRING_IDENTIFIER = 'string'.freeze
 
       attr_reader :origin
 
@@ -94,7 +94,7 @@ module Reek
 
       private
 
-      private_attr_reader :parser, :source
+      attr_reader :parser, :source
     end
   end
 end

data/lib/reek/source/source_locator.rb

@@ -1,4 +1,3 @@
-require 'private_attr/everywhere'
 require 'find'
 require 'pathname'
 
@@ -29,7 +28,7 @@ module Reek
 
       private
 
-      private_attr_reader :configuration, :paths
+      attr_reader :configuration, :paths
 
       # :reek:TooManyStatements: { max_statements: 7 }
       # :reek:NestedIterators: { max_allowed_nesting: 2 }
@@ -43,8 +42,8 @@ module Reek
           given_path.find do |path|
             if path.directory?
               ignore_path?(path) ? Find.prune : next
-            else
-              relevant_paths << path if ruby_file?(path)
+            elsif ruby_file?(path)
+              relevant_paths << path
             end
           end
         end

data/lib/reek/spec/should_reek.rb

@@ -25,8 +25,10 @@ module Reek
         "Expected no smells, but got:\n#{rpt}"
       end
 
-      private_attr_reader :configuration
-      private_attr_accessor :examiner
+      private
+
+      attr_reader :configuration
+      attr_accessor :examiner
     end
   end
 end

data/lib/reek/spec/should_reek_of.rb

@@ -10,10 +10,6 @@ module Reek
     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)
@@ -30,6 +26,10 @@ module Reek
 
       private
 
+      attr_reader :configuration, :smell_category, :smell_details
+      attr_writer :failure_message, :failure_message_when_negated
+      attr_accessor :examiner
+
       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.

data/lib/reek/spec/should_reek_only_of.rb

@@ -32,7 +32,7 @@ module Reek
 
       private
 
-      private_attr_accessor :warnings
+      attr_accessor :warnings
     end
   end
 end

data/lib/reek/spec/smell_matcher.rb

@@ -6,7 +6,7 @@ module Reek
     class SmellMatcher
       attr_reader :smell_warning
 
-      COMPARABLE_ATTRIBUTES = %i(message lines context source)
+      COMPARABLE_ATTRIBUTES = %i(message lines context source).freeze
 
       def initialize(smell_warning)
         @smell_warning = smell_warning

data/lib/reek/tree_dresser.rb

@@ -48,6 +48,6 @@ module Reek
 
     private
 
-    private_attr_reader :klass_map
+    attr_reader :klass_map
   end
 end

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.10.1'
+    STRING = '3.10.2'.freeze
   end
 end

data/reek.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |s|
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.3.1'
-  s.add_runtime_dependency 'parser',                '~> 2.3'
-  s.add_runtime_dependency 'private_attr',          '~> 1.1'
+  s.add_runtime_dependency 'parser',                '~> 2.3', '>= 2.3.0.6'
   s.add_runtime_dependency 'rainbow',               '~> 2.0'
 end

data/spec/reek/cli/application_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../../spec_helper'
+require_lib 'reek/cli/application'
+
+RSpec.describe Reek::CLI::Application do
+  describe '#initialize' do
+    it 'exits with default error code on invalid options' do
+      call = lambda do
+        Reek::CLI::Silencer.silently do
+          Reek::CLI::Application.new ['--foo']
+        end
+      end
+      expect(call).to raise_error(SystemExit) do |error|
+        expect(error.status).to eq Reek::CLI::Options::DEFAULT_ERROR_EXIT_CODE
+      end
+    end
+  end
+
+  describe '#execute' do
+    let(:command) { double 'reek_command' }
+    let(:app) { Reek::CLI::Application.new [] }
+
+    before do
+      allow(Reek::CLI::ReekCommand).to receive(:new).and_return command
+    end
+
+    it "returns the command's result code" do
+      allow(command).to receive(:execute).and_return 'foo'
+      expect(app.execute).to eq 'foo'
+    end
+  end
+end

data/spec/reek/cli/reek_command_spec.rb

@@ -0,0 +1,45 @@
+require_relative '../../spec_helper'
+require_lib 'reek/cli/reek_command'
+require_lib 'reek/cli/options'
+require_lib 'reek/cli/option_interpreter'
+
+RSpec.describe Reek::CLI::ReekCommand do
+  describe '#execute' do
+    let(:options) { Reek::CLI::Options.new [] }
+    let(:option_interpreter) { Reek::CLI::OptionInterpreter.new(options) }
+
+    let(:reporter) { double 'reporter' }
+    let(:app) { double 'app' }
+
+    let(:command) { described_class.new option_interpreter }
+
+    before do
+      allow(option_interpreter).to receive(:reporter).and_return reporter
+      allow(reporter).to receive(:show)
+    end
+
+    context 'when no smells are found' do
+      before do
+        allow(option_interpreter).to receive(:sources).and_return []
+        allow(reporter).to receive(:smells?).and_return false
+      end
+
+      it 'returns a success code' do
+        result = command.execute app
+        expect(result).to eq Reek::CLI::Options::DEFAULT_SUCCESS_EXIT_CODE
+      end
+    end
+
+    context 'when smells are found' do
+      before do
+        allow(option_interpreter).to receive(:sources).and_return []
+        allow(reporter).to receive(:smells?).and_return true
+      end
+
+      it 'returns a failure code' do
+        result = command.execute app
+        expect(result).to eq Reek::CLI::Options::DEFAULT_FAILURE_EXIT_CODE
+      end
+    end
+  end
+end

data/spec/reek/rake/task_spec.rb

@@ -0,0 +1,33 @@
+require_relative '../../spec_helper'
+require_lib 'reek/rake/task'
+
+RSpec.describe Reek::Rake::Task do
+  describe '#source_files' do
+    it 'is set to "lib/**/*.rb" by default' do
+      task = Reek::Rake::Task.new
+      expect(task.source_files).to eq FileList['lib/**/*.rb']
+    end
+  end
+
+  describe '#source_files=' do
+    it 'sets source_files to a FileList when passed a string' do
+      task = Reek::Rake::Task.new
+      task.source_files = '*.rb'
+      expect(task.source_files).to eq FileList['*.rb']
+    end
+  end
+
+  # SMELL: Testing a private method
+  describe '#command' do
+    let(:task) { Reek::Rake::Task.new }
+
+    it 'does not include a config file by default' do
+      expect(task.send(:command)).not_to include '-c'
+    end
+
+    it 'includes a config file when set' do
+      task.config_file = 'foo.reek'
+      expect(task.send(:command)[1..2]).to eq ['-c', 'foo.reek']
+    end
+  end
+end

data/spec/reek/smells/utility_function_spec.rb

@@ -172,7 +172,7 @@ RSpec.describe Reek::Smells::UtilityFunction do
       expect('def simple(arga=local) arga.to_s end').not_to reek_of(:UtilityFunction)
     end
 
-    it 'should count usages of self'do
+    it 'should count usages of self' do
       expect('def <=>(other) Options[:sort_order].compare(self, other) end').
         not_to reek_of(:UtilityFunction)
     end

data/spec/spec_helper.rb

@@ -23,9 +23,10 @@ SAMPLES_PATH = Pathname.new("#{__dir__}/samples").relative_path_from(Pathname.pw
 # Simple helpers for our specs.
 module Helpers
   def test_configuration_for(config)
-    if config.is_a? Pathname
+    case config
+    when Pathname
       configuration = Reek::Configuration::AppConfiguration.from_path(config)
-    elsif config.is_a? Hash
+    when Hash
       configuration = Reek::Configuration::AppConfiguration.from_map default_directive: config
     else
       raise "Unknown config given in `test_configuration_for`: #{config.inspect}"

data/tasks/configuration.rake

@@ -4,7 +4,7 @@ require 'yaml'
 namespace :configuration do
   desc 'Updates the default configuration file when smell defaults change'
   task :update_default_configuration do
-    DEFAULT_SMELL_CONFIGURATION = 'defaults.reek'
+    DEFAULT_SMELL_CONFIGURATION = 'defaults.reek'.freeze
     content = Reek::Smells::SmellRepository.smell_types.each_with_object({}) do |klass, hash|
       hash[klass.smell_type] = klass.default_config
     end

data/tasks/test.rake

@@ -4,7 +4,7 @@ require 'rspec/core/rake_task'
 namespace 'test' do
   RSpec::Core::RakeTask.new('spec') do |t|
     t.pattern = 'spec/reek/**/*_spec.rb'
-    t.ruby_opts = ['-Ilib -w']
+    t.ruby_opts = ['-rsimplecov -Ilib -w']
   end
 
   desc 'Tests code quality'