reek 3.7.0 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abd5004377700bed9881c5ed437ec2a9d19caa23
-  data.tar.gz: 8a4c3835fb589450122e13b4b449413aa93c9bcc
+  metadata.gz: 0360a27f0d7285b66c630aa23ff08c48273f0ff7
+  data.tar.gz: cf166a5b8541a65c60738afa51aa903c0c673998
 SHA512:
-  metadata.gz: fe96cf2b530e92d25370691e3b8584825b9243016639073575817893dd7645a97bee491b8b73d0e04166a86e0602271186744d1b1eeec9285a4abc533fe9e813
-  data.tar.gz: 1b98379f0590f06b76dcc6e8031a4c7fedeca3af08ba3189c516b3e12bf754addc1e2155747807ef48c65569bedaa389ab0d0a4aa8e34fba03b1e0f8cb939a6f
+  metadata.gz: d52ffb53c36fc67b58993411a6bdeb1f319cadd044736f5cb13e690789dc77c2e0022b7f25261e1ebe4838fe4c11036f47d005472d5af30d6f33f4885651ae37
+  data.tar.gz: 443d185d3acc0d65d3f673e34f1e050e754a87637cc6fae8c63fa1059d9f1150c5936437c0cfe662d8fd9952ca903fa90647036ee35a35fcb07f200909d67f40

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.7.1 (2015-11-29)
+
+* (troessner) Reverse merge default directives into directory directives.
+
 ## 3.7.0 (2015-11-17)
 
 * (andyw8) Add Code Climate JSON report format: `--format code_climate`

data/README.md

@@ -258,7 +258,29 @@ exclude_paths:
   - lib/rake/legacy_tasks
 ```
 
-Note you do not need a configuration file at all. If you're fine with all the [defaults](defaults.reek) we set you can skip this completely.
+If you have a directory directive for which a default directive exists, the more specific
+one (which is the directory directive) will take precedence.
+
+This configuration for instance:
+
+```yaml
+---
+IrresponsibleModule:
+  enabled: false
+
+TooManyStatements:
+  max_statements: 5
+
+"app/controllers":
+  TooManyStatements:
+    max_statements: 10
+```
+
+translates to:
+
+* IrresponsibleModule is disabled everywhere
+* TooManyStatements#max_statements is 10 in "app/controllers"
+* TooManyStatements#max_statements is 5 everywhere else
 
 For more details please check out the [Basic Smell Options](docs/Basic-Smell-Options.md)
 which are supported by every smell type. As you can see above, certain smell
@@ -268,6 +290,9 @@ All options that go beyond the [Basic Smell Options](docs/Basic-Smell-Options.md
 are documented in the corresponding smell type /docs page (if you want to get a quick overview over all possible
 configurations you can also check out [the `default.reek` file in this repository](defaults.reek).
 
+Note that you do not need a configuration file at all.
+If you're fine with all the [defaults](defaults.reek) we set you can skip this completely.
+
 ### Source code comments
 
 In case you need to suppress a smell warning and you can't or don't want to

data/lib/reek/configuration/app_configuration.rb

@@ -90,10 +90,11 @@ module Reek
       #
       # @param source_via [String] - the source of the code inspected
       #
-      # @return [Hash] the directory directive for the source or, if there is
-      # none, the default directive
+      # @return [Hash] the directory directive for the source with the default directive
+      #                reverse-merged into it.
       def directive_for(source_via)
-        directory_directives.directive_for(source_via) || default_directive
+        hit = directory_directives.directive_for(source_via)
+        hit ? default_directive.merge(hit) : default_directive
       end
 
       def path_excluded?(path)

data/lib/reek/smells/module_initialize.rb

@@ -21,7 +21,7 @@ module Reek
       #
       # :reek:FeatureEnvy
       def inspect(ctx)
-        ctx.local_nodes(:def) do |node| # FIXME: also search for :defs?
+        ctx.local_nodes(:def) do |node|
           if node.name.to_s == 'initialize'
             return [
               smell_warning(

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.7.0'
+    STRING = '3.7.1'
   end
 end

data/spec/reek/configuration/app_configuration_spec.rb

@@ -91,9 +91,8 @@ RSpec.describe Reek::Configuration::AppConfiguration do
   end
 
   describe '#directive_for' do
-    let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
-
-    context 'our source is in a directory for which we have a directive' do
+    context 'multiple directory directives and no default directive present' do
+      let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
       let(:baz_config)  { { Reek::Smells::IrresponsibleModule => { enabled: false } } }
       let(:bang_config) { { Reek::Smells::Attribute => { enabled: true } } }
 
@@ -110,7 +109,30 @@ RSpec.describe Reek::Configuration::AppConfiguration do
       end
     end
 
-    context 'our source is not in a directory for which we have a directive' do
+    context 'directory directive and default directive present' do
+      let(:directory) { 'spec/samples/two_smelly_files/' }
+      let(:directory_config) { { Reek::Smells::TooManyStatements => { max_statements: 8 } } }
+      let(:directory_directives) { { directory => directory_config } }
+      let(:default_directive) do
+        {
+          Reek::Smells::IrresponsibleModule => { enabled: false },
+          Reek::Smells::TooManyStatements => { max_statements: 15 }
+        }
+      end
+      let(:source_via) { "#{directory}/dummy.rb" }
+
+      it 'returns the directory directive with the default directive reverse-merged' do
+        configuration = described_class.from_map directory_directives: directory_directives,
+                                                 default_directive: default_directive
+        actual = configuration.directive_for(source_via)
+        expect(actual[Reek::Smells::IrresponsibleModule]).to be_truthy
+        expect(actual[Reek::Smells::TooManyStatements]).to be_truthy
+        expect(actual[Reek::Smells::TooManyStatements][:max_statements]).to eq(8)
+      end
+    end
+
+    context 'no directory directive but a default directive present' do
+      let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }
       let(:default_directive) { { Reek::Smells::IrresponsibleModule => { enabled: false } } }
       let(:attribute_config) { { Reek::Smells::Attribute => { enabled: false } } }
       let(:directory_directives) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.7.1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -530,7 +530,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby