reek 3.2.1 → 3.3.0

data/spec/reek/tree_walker_spec.rb

@@ -5,9 +5,9 @@ require_relative '../../lib/reek/source/source_code'
 # Dummy repository to inject into TreeWalker in order to count statements in
 # all contexts.
 class TestSmellRepository
-  attr_reader :num_statements
+  attr_accessor :num_statements
   def examine(context)
-    @num_statements = context.num_statements
+    self.num_statements = context.num_statements
   end
 end
 
@@ -95,6 +95,18 @@ RSpec.describe Reek::TreeWalker, 'statement counting' do
       expect(method.num_statements).to eq(6)
     end
 
+    it 'does not count constant assignment with or equals' do
+      source = 'class Hi; CONST ||= 1; end'
+      klass = process_method(source)
+      expect(klass.num_statements).to eq(0)
+    end
+
+    it 'does not count multi constant assignment' do
+      source = 'class Hi; CONST, OTHER_CONST = 1, 2; end'
+      klass = process_method(source)
+      expect(klass.num_statements).to eq(0)
+    end
+
     it 'does not count empty conditional expression' do
       method = process_method('def one() if val == 4; ; end; end')
       expect(method.num_statements).to eq(0)

data/spec/spec_helper.rb

@@ -25,10 +25,9 @@ SAMPLES_PATH = Pathname.new("#{__dir__}/samples").relative_path_from(Pathname.pw
 module Helpers
   def test_configuration_for(config)
     if config.is_a? Pathname
-      configuration = Reek::Configuration::AppConfiguration.new OpenStruct.new(config_file: config)
+      configuration = Reek::Configuration::AppConfiguration.from_path(config)
     elsif config.is_a? Hash
-      configuration = Reek::Configuration::AppConfiguration.new
-      configuration.instance_variable_set :@default_directive, config
+      configuration = Reek::Configuration::AppConfiguration.from_map default_directive: config
     else
       raise "Unknown config given in `test_configuration_for`: #{config.inspect}"
     end

data/tasks/test.rake

@@ -7,11 +7,6 @@ namespace 'test' do
     t.ruby_opts = ['-Ilib -w']
   end
 
-  desc 'Tests various release attributes of the gem'
-  RSpec::Core::RakeTask.new('gem') do |t|
-    t.pattern = 'spec/gem/**/*_spec.rb'
-  end
-
   desc 'Tests code quality'
   RSpec::Core::RakeTask.new('quality') do |t|
     t.pattern = 'spec/quality/**/*_spec.rb'

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Kevin Rutherford
 - Timo Roessner
 - Matijs van Zuijlen
+- Piotr Szotkowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -226,7 +227,6 @@ files:
 - docs/Class-Variable.md
 - docs/Code-Smells.md
 - docs/Command-Line-Options.md
-- docs/Configuration-Files.md
 - docs/Control-Couple.md
 - docs/Control-Parameter.md
 - docs/Data-Clump.md
@@ -296,6 +296,10 @@ files:
 - lib/reek/code_comment.rb
 - lib/reek/configuration/app_configuration.rb
 - lib/reek/configuration/configuration_file_finder.rb
+- lib/reek/configuration/configuration_validator.rb
+- lib/reek/configuration/default_directive.rb
+- lib/reek/configuration/directory_directives.rb
+- lib/reek/configuration/excluded_paths.rb
 - lib/reek/context/code_context.rb
 - lib/reek/context/method_context.rb
 - lib/reek/context/module_context.rb
@@ -349,8 +353,6 @@ files:
 - lib/reek/version.rb
 - reek.gemspec
 - spec/factories/factories.rb
-- spec/gem/updates_spec.rb
-- spec/gem/yard_spec.rb
 - spec/quality/reek_source_spec.rb
 - spec/reek/ast/node_spec.rb
 - spec/reek/ast/object_refs_spec.rb
@@ -363,6 +365,9 @@ files:
 - spec/reek/code_comment_spec.rb
 - spec/reek/configuration/app_configuration_spec.rb
 - spec/reek/configuration/configuration_file_finder_spec.rb
+- spec/reek/configuration/default_directive_spec.rb
+- spec/reek/configuration/directory_directives_spec.rb
+- spec/reek/configuration/excluded_paths_spec.rb
 - spec/reek/context/code_context_spec.rb
 - spec/reek/context/method_context_spec.rb
 - spec/reek/context/module_context_spec.rb
@@ -375,7 +380,6 @@ files:
 - spec/reek/report/xml_report_spec.rb
 - spec/reek/report/yaml_report_spec.rb
 - spec/reek/smells/attribute_spec.rb
-- spec/reek/smells/behaves_like_variable_detector.rb
 - spec/reek/smells/boolean_parameter_spec.rb
 - spec/reek/smells/class_variable_spec.rb
 - spec/reek/smells/control_parameter_spec.rb

data/docs/Configuration-Files.md

@@ -1,49 +0,0 @@
-# Configuration Files
-
-## Configuration loading
-
-Configuring `reek` via configuration file is by far the most powerful way.
-
-There are 3 ways of passing `reek` a configuration file:
-
-1. Using the cli "-c" switch (see [Command Line Options](Command-Line-Options.md))
-2. Having a file ending with .reek either in your current working directory or in a parent directory (more on that later)
-3. Having a file ending with .reek in your HOME directory
-
-The order in which `reek` tries to find such a configuration file is exactly like above: First `reek` checks if we have given it a configuration file explicitly via CLI. Then it checks the current working directory for a file and if it can't find one, it traverses up the directories until it hits the root directory. And lastly, it checks your HOME directory.
-
-As soon as `reek` detects a configuration file it stops searching immediately, meaning that from `reek`'s point of view there exists one configuration file and one configuration only regardless of how many ".reek" files you might have on your filesystem.
-
-## Configuration options for smells
-
-The first thing you probably want to check out are the [Basic Smell Options](Basic-Smell-Options.md) which are supported by every smell type.
-Certain smell types offer a configuration that goes beyond that of the basic smell options - for instance [Data Clump](Data-Clump.md).
-All options that go beyond the [Basic Smell Options](Basic-Smell-Options.md) should be documented in the corresponding smell type wiki page but if you want to get a quick and full overview over all possible configurations you can always check out [the default.reek file in this repository](https://github.com/troessner/reek/blob/master/config/defaults.reek).
-
-Here's an excerpt of a `reek` configuration file from a commercial project:
-
-```yaml
----
-IrresponsibleModule:
-  enabled: false
-NestedIterators:
-  exclude:
-    - "ActiveModelErrorAdder#self.run" # should be refactored
-    - "BookingRequests::Transfer#remote_validation"
-    - "BookingRequestsController#vehicle_options" # respond_to block
-    - "Content::Base#self.expose_fields" # unavoidable due to metaprogramming
-DataClump:
-  max_copies: 3
-  min_clump_size: 3
-```
-
-## Excluding directories from scans
-
-You can exclude whole directories from scans using `exclude_paths` in your configuration file:
-
-```yaml
----
-exclude_paths:
-  - app/views
-  - app/controllers
-```

data/spec/gem/updates_spec.rb

@@ -1,25 +0,0 @@
-require_relative '../spec_helper'
-require 'find'
-
-release_timestamp_file = 'build/.last-release'
-if test('f', release_timestamp_file)
-  describe 'updates' do
-    before :each do
-      @release_time = File.stat(release_timestamp_file).mtime
-    end
-
-    context 'version file' do
-      it 'has been updated since the last release' do
-        version_time = File.stat('lib/reek.rb').mtime
-        expect(version_time).to be > @release_time
-      end
-    end
-
-    context 'history file' do
-      it 'has been updated since the last release' do
-        history_time = File.stat('History.txt').mtime
-        expect(history_time).to be > @release_time
-      end
-    end
-  end
-end

data/spec/gem/yard_spec.rb

@@ -1,11 +0,0 @@
-require 'open3'
-require_relative '../spec_helper'
-
-RSpec.describe 'yardoc' do
-  it 'executes successfully with no warnings' do
-    stdout, stderr, status = Open3.capture3('yardoc')
-    expect(stdout).to_not include('[warn]')
-    expect(stderr).to be_empty
-    expect(status).to be_success
-  end
-end

data/spec/reek/smells/behaves_like_variable_detector.rb

@@ -1,39 +0,0 @@
-RSpec.shared_examples_for 'a variable detector' do
-  context 'with no variables' do
-    it "doesn't record a smell" do
-      @detector.examine_context(@ctx)
-      expect(@detector.smells_found.length).to eq(0)
-    end
-  end
-
-  context 'with one variable encountered twice' do
-    before :each do
-      @ctx.send(@record_variable, :something)
-      @ctx.send(@record_variable, :something)
-      @detector.examine_context(@ctx)
-    end
-
-    it 'records only one smell' do
-      expect(@detector.smells_found.length).to eq(1)
-    end
-    it 'mentions the variable name in the report' do
-      expect(@detector).to have_smell([/something/])
-    end
-  end
-
-  context 'with two variables' do
-    before :each do
-      @ctx.send(@record_variable, :something)
-      @ctx.send(@record_variable, :something_else)
-      @detector.examine_context(@ctx)
-    end
-
-    it 'records both smells' do
-      expect(@detector.num_smells).to eq(2)
-    end
-    it 'mentions both variable names in the report' do
-      expect(@detector).to have_smell([/something/])
-      expect(@detector).to have_smell([/something_else/])
-    end
-  end
-end