reek 5.0.2 → 5.1.0

data/spec/reek/configuration/schema_validator_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
     context 'when configuration is valid' do
       let(:configuration) do
         {
-          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+          Reek::DETECTORS_KEY => {
             'UncommunicativeVariableName' => { 'enabled' => false },
             'UncommunicativeMethodName'   => { 'enabled' => false }
           }
@@ -24,7 +24,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
     context 'when detector is invalid' do
       let(:configuration) do
         {
-          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+          Reek::DETECTORS_KEY => {
             'DoesNotExist' => { 'enabled' => false }
           }
         }
@@ -39,7 +39,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
     context 'when `enabled` has a non-boolean value' do
       let(:configuration) do
         {
-          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+          Reek::DETECTORS_KEY => {
             'FeatureEnvy' => { 'enabled' => 'foo' }
           }
         }
@@ -54,7 +54,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
     context 'when detector has an unknown option' do
       let(:configuration) do
         {
-          Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+          Reek::DETECTORS_KEY => {
             'DataClump' => { 'does_not_exist' => 42 }
           }
         }
@@ -71,7 +71,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
         context 'when a scalar' do
           let(:configuration) do
             {
-              Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+              Reek::DETECTORS_KEY => {
                 'UncommunicativeMethodName' => { attribute => 42 }
               }
             }
@@ -86,7 +86,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
         context 'when types are mixed' do
           let(:configuration) do
             {
-              Reek::Configuration::AppConfiguration::DETECTORS_KEY => {
+              Reek::DETECTORS_KEY => {
                 'UncommunicativeMethodName' => { attribute => [42, 'foo'] }
               }
             }
@@ -103,7 +103,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
     context 'when `exclude_paths` is a scalar' do
       let(:configuration) do
         {
-          Reek::Configuration::AppConfiguration::EXCLUDE_PATHS_KEY => 42
+          Reek::EXCLUDE_PATHS_KEY => 42
         }
       end
 
@@ -116,7 +116,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
     context 'when `exclude_paths` mixes types' do
       let(:configuration) do
         {
-          Reek::Configuration::AppConfiguration::EXCLUDE_PATHS_KEY => [42, 'foo']
+          Reek::EXCLUDE_PATHS_KEY => [42, 'foo']
         }
       end
 
@@ -130,7 +130,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
       context 'when bad detector' do
         let(:configuration) do
           {
-            Reek::Configuration::AppConfiguration::DIRECTORIES_KEY => {
+            Reek::DIRECTORIES_KEY => {
               'web_app/app/helpers' => {
                 'Bar' => { 'enabled' => false }
               }
@@ -147,7 +147,7 @@ RSpec.describe Reek::Configuration::SchemaValidator do
       context 'when unknown attribute' do
         let(:configuration) do
           {
-            Reek::Configuration::AppConfiguration::DIRECTORIES_KEY => {
+            Reek::DIRECTORIES_KEY => {
               'web_app/app/controllers' => {
                 'NestedIterators' => { 'foo' => false }
               }

data/spec/reek/detector_repository_spec.rb

@@ -7,8 +7,8 @@ RSpec.describe Reek::DetectorRepository do
     let(:smell_types) { described_class.smell_types }
 
     it 'includes existing smell_types' do
-      expect(smell_types).to include(Reek::SmellDetectors::IrresponsibleModule).
-        and include(Reek::SmellDetectors::TooManyStatements)
+      expect(smell_types).to include(Reek::SmellDetectors::IrresponsibleModule,
+                                     Reek::SmellDetectors::TooManyStatements)
     end
 
     it 'excludes the smell detector base class' do

data/spec/reek/smell_detectors/control_parameter_spec.rb

@@ -30,6 +30,23 @@ RSpec.describe Reek::SmellDetectors::ControlParameter do
       and reek_of(:ControlParameter, lines: [3], argument: 'charlie')
   end
 
+  it 'does count multiple occurences of the same parameter' do
+    src = <<-EOS
+      def alfa(bravo, charlie)
+        if bravo
+          delta if charlie
+        end
+        if charlie
+          delta if bravo
+        end
+      end
+    EOS
+
+    expect(src).
+      to reek_of(:ControlParameter, lines: [2, 6], argument: 'bravo').
+      and reek_of(:ControlParameter, lines: [3, 5], argument: 'charlie')
+  end
+
   context 'when a parameter is not used to determine code path' do
     it 'does not report a ternary check on an ivar' do
       src = 'def alfa(bravo) @charlie ? bravo : false end'

data/spec/reek/source/source_locator_spec.rb

@@ -29,7 +29,6 @@ RSpec.describe Reek::Source::SourceLocator do
       end
     end
 
-    # rubocop:disable RSpec/NestedGroups
     context 'with excluded paths' do
       let(:configuration) do
         test_configuration_for(CONFIGURATION_DIR.join('with_excluded_paths.reek'))
@@ -118,7 +117,6 @@ RSpec.describe Reek::Source::SourceLocator do
         end
       end
     end
-    # rubocop:enable RSpec/NestedGroups
 
     context 'with non-Ruby paths' do
       let(:path) { SAMPLES_DIR.join('source_with_non_ruby_files') }

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 require 'timeout'
 require 'active_support/core_ext/string/strip'
+require 'rspec-benchmark'
 require_relative '../lib/reek'
 require_relative '../lib/reek/spec'
 require_relative '../lib/reek/ast/ast_node_class_map'
@@ -76,6 +77,7 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.include FactoryBot::Syntax::Methods
   config.include Helpers
+  config.include RSpec::Benchmark::Matchers
 
   config.disable_monkey_patching!
 

data/tasks/configuration.rake

@@ -1,3 +1,4 @@
+require_relative '../lib/reek'
 require_relative '../lib/reek/detector_repository'
 require_relative '../lib/reek/configuration/rake_task_converter'
 require_relative '../lib/reek/configuration/app_configuration'
@@ -12,7 +13,7 @@ namespace :configuration do
       hash[klass.smell_type] = Reek::Configuration::RakeTaskConverter.convert klass.default_config
     end
     File.open(DEFAULT_SMELL_CONFIGURATION, 'w') do |file|
-      YAML.dump({ Reek::Configuration::AppConfiguration::DETECTORS_KEY => content }, file)
+      YAML.dump({ Reek::DETECTORS_KEY => content }, file)
     end
   end
 end

data/tasks/test.rake

@@ -7,6 +7,10 @@ namespace 'test' do
     t.ruby_opts = ['-rbundler/setup -rsimplecov -Ilib -w']
   end
 
+  RSpec::Core::RakeTask.new('performance') do |t|
+    t.pattern = 'spec/performance/**/*_spec.rb'
+  end
+
   desc 'Tests code quality'
   RSpec::Core::RakeTask.new('quality') do |t|
     t.pattern = 'spec/quality/**/*_spec.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 5.0.2
+  version: 5.1.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2018-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -103,6 +103,7 @@ files:
 - ".gitignore"
 - ".reek.yml"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".simplecov"
 - ".travis.yml"
 - ".yardopts"
@@ -113,7 +114,6 @@ files:
 - License.txt
 - README.md
 - Rakefile
-- ataru_setup.rb
 - bin/code_climate_reek
 - bin/reek
 - docs/API.md
@@ -183,6 +183,7 @@ files:
 - features/configuration_files/mix_accept_reject_setting.feature
 - features/configuration_files/reject_setting.feature
 - features/configuration_files/schema_validation.feature
+- features/configuration_files/show_configuration_file.feature
 - features/configuration_files/unused_private_method.feature
 - features/configuration_loading.feature
 - features/configuration_via_source_comments/erroneous_source_comments.feature
@@ -298,6 +299,9 @@ files:
 - lib/reek/smell_detectors/boolean_parameter.rb
 - lib/reek/smell_detectors/class_variable.rb
 - lib/reek/smell_detectors/control_parameter.rb
+- lib/reek/smell_detectors/control_parameter_helpers/call_in_condition_finder.rb
+- lib/reek/smell_detectors/control_parameter_helpers/candidate.rb
+- lib/reek/smell_detectors/control_parameter_helpers/control_parameter_finder.rb
 - lib/reek/smell_detectors/data_clump.rb
 - lib/reek/smell_detectors/duplicate_method_call.rb
 - lib/reek/smell_detectors/feature_envy.rb
@@ -358,6 +362,7 @@ files:
 - samples/smelly_source/inline.rb
 - samples/smelly_source/optparse.rb
 - samples/smelly_source/redcloth.rb
+- samples/smelly_source/ruby.rb
 - samples/smelly_source/smelly.rb
 - samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb
 - samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb
@@ -368,6 +373,8 @@ files:
 - samples/source_with_non_ruby_files/python_source.py
 - samples/source_with_non_ruby_files/ruby.rb
 - spec/factories/factories.rb
+- spec/performance/reek/smell_detectors/runtime_speed_spec.rb
+- spec/quality/documentation_spec.rb
 - spec/quality/reek_source_spec.rb
 - spec/reek/ast/node_spec.rb
 - spec/reek/ast/object_refs_spec.rb
@@ -451,7 +458,6 @@ files:
 - spec/reek/spec/smell_matcher_spec.rb
 - spec/reek/tree_dresser_spec.rb
 - spec/spec_helper.rb
-- tasks/ataru.rake
 - tasks/configuration.rake
 - tasks/console.rake
 - tasks/reek.rake
@@ -481,7 +487,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby

data/ataru_setup.rb

@@ -1,13 +0,0 @@
-require 'reek'
-require 'reek/smell_detectors'
-
-# Ataru setup module.
-module Setup
-  def setup
-    # Run before every snippet.
-  end
-
-  def teardown
-    # Run after every snippet.
-  end
-end

data/tasks/ataru.rake

@@ -1,5 +0,0 @@
-desc 'Runs ataru to check if our docs are still in sync with our code'
-task :ataru do
-  system 'bundle exec ataru check'
-  abort unless $CHILD_STATUS.success?
-end