reek 3.10.0 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb34a3d020ec6d9c214ba0601080f6f3f1be9f62
-  data.tar.gz: 7f9ce71ca71ef44adad6fc79f99abeef88f72a02
+  metadata.gz: bf831607e9695f0bd26f4cd6ba2c5e155c43bbdf
+  data.tar.gz: d8288adc73c7bfbd81af8d81546f1e0583181a74
 SHA512:
-  metadata.gz: b1f7e66b52c231fe72f07e209ca06bd3abe9f65af64e9b886d1137b744f244cd93de634769da9598f6bd403d82bfce674d4ace97118b77d19c5d19da974f6496
-  data.tar.gz: d43adf2de2ffb4ec3a4351afed0ddd1be460b1d1dbfcd10afd3a04a15e747d54da7132c56f5cc324e44c39ad167546204195f96ef6b35e024af142d41852fd10
+  metadata.gz: 408e265b23ef389a7d8a1f651c1b1c3d6cd77a3521abcb5cdd7233043ae389b709f48dbb1509cfceed38c815266b97acfcb0d2376811cc36da32fe71edec1534
+  data.tar.gz: af007da9b29b3c6f3bd70ccb0caec7aa7b8177a09ac3036cccb7725d2e208bd060bb167dba0e165df708f48aac87717d9fb645540da281c6de3ee36690d48ba1

data/.travis.yml

@@ -9,6 +9,7 @@ rvm:
   - 2.0.0
   - 2.1
   - 2.2
+  - 2.3.0
   - rbx-2
   - ruby-head
 matrix:

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 3.10.1 (2016-02-07)
+
+* (mvz) Fix edge case syntax problems
+* (troessner) Disable UnusedPrivateMethod detector by default
+
 ## 3.10.0 (2016-01-27)
 
 * Add CodeClimate Docker integration. This will allow users to deduct their own docker image

data/README.md

@@ -172,6 +172,15 @@ Reek currently includes checks for some aspects of
 and more. See the [Code Smells](docs/Code-Smells.md)
 for up to date details of exactly what Reek will check in your code.
 
+Note that [Unused Private Method](docs/Unused-Private-Method.md) is disabled by default
+because it is [kind of controversial](https://github.com/troessner/reek/issues/844) which means
+you have to explicitly activate in your configuration via
+
+```Yaml
+UnusedPrivateMethod:
+  enabled: true
+```
+
 ## Configuration
 
 ### Command-line interface

data/defaults.reek

@@ -107,7 +107,7 @@ UnusedParameters:
   enabled: true
   exclude: []
 UnusedPrivateMethod:
-  enabled: true
+  enabled: false
   exclude: []
 UtilityFunction:
   enabled: true

data/features/samples.feature

@@ -177,7 +177,7 @@ Feature: Basic smell detection
       UnusedParameters: OptionParser::Completion#convert has unused parameter 'opt' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::NoArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
-    redcloth.rb -- 121 warnings:
+    redcloth.rb -- 101 warnings:
       Attribute: RedCloth#filter_html is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#filter_styles is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#hard_breaks is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -269,26 +269,6 @@ Feature: Basic smell detection
       UnusedParameters: RedCloth#textile_fn_ has unused parameter 'cite' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: RedCloth#textile_fn_ has unused parameter 'tag' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: RedCloth#textile_p has unused parameter 'cite' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_markdown_atx` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_markdown_bq` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_markdown_lists` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_markdown_rule` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_markdown_setext` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_textile_lists` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_textile_prefix` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `block_textile_table` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `inline_markdown_link` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `inline_markdown_reflink` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `inline_textile_code` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `inline_textile_image` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `inline_textile_link` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `inline_textile_span` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `refs_markdown` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `refs_textile` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `textile_bq` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `textile_fn_` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `textile_p` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
-      UnusedPrivateMethod: RedCloth has the unused private instance method `textile_popup_help` [https://github.com/troessner/reek/blob/master/docs/Unused-Private-Method.md]
       UtilityFunction: RedCloth#block_markdown_rule doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#clean_html doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#flush_left doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
@@ -299,5 +279,5 @@ Feature: Basic smell detection
       UtilityFunction: RedCloth#lT doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#no_textile doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#v_align doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    285 total warnings
+    265 total warnings
     """

data/lib/reek/ast/sexp_extensions/send.rb

@@ -30,7 +30,9 @@ module Reek
         end
 
         def module_creation_receiver?
-          receiver && [:Class, :Struct].include?(receiver.simple_name)
+          receiver &&
+            receiver.type == :const &&
+            [:Class, :Struct].include?(receiver.simple_name)
         end
 
         def object_creation_call?

data/lib/reek/smells/unused_private_method.rb

@@ -11,6 +11,10 @@ module Reek
     # See {file:docs/Unused-Private-Method.md} for details.
     #
     class UnusedPrivateMethod < SmellDetector
+      def self.default_config
+        super.merge(SmellConfiguration::ENABLED_KEY => false)
+      end
+
       # Class for storing `hits` which are unused private methods
       # we found in the given context. `name` and `line` are then used to
       # construct SmellWarnings.

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.10.0'
+    STRING = '3.10.1'
   end
 end

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -269,6 +269,22 @@ RSpec.describe Reek::AST::SexpExtensions::SendNode do
     end
   end
 
+  context 'when it’s ‘new’ with a complex receiver' do
+    let(:node) { Reek::Source::SourceCode.from('(foo ? bar : baz).new').syntax_tree }
+
+    it 'is not considered to be a module creation call' do
+      expect(node.module_creation_call?).to be_falsey
+    end
+
+    it 'is not considered to have a module creation receiver' do
+      expect(node.module_creation_receiver?).to be_falsey
+    end
+
+    it 'is considered to be an object creation call' do
+      expect(node.object_creation_call?).to be_truthy
+    end
+  end
+
   context 'with 1 literal parameter' do
     let(:node) { sexp(:send, nil, :hello, sexp(:lit, :param)) }
 

data/spec/reek/smells/irresponsible_module_spec.rb

@@ -162,6 +162,13 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
     expect(src).to reek_of(:IrresponsibleModule, name: 'Foo')
   end
 
+  it 'reports top level classes defined through assignment' do
+    src = <<-EOS
+      Foo = Class.new Bar
+    EOS
+    expect(src).to reek_of(:IrresponsibleModule, name: 'Foo')
+  end
+
   it 'reports structs defined through assignment' do
     src = <<-EOS
       # Qux is responsible, but Foo is not
@@ -172,12 +179,20 @@ RSpec.describe Reek::Smells::IrresponsibleModule do
     expect(src).to reek_of(:IrresponsibleModule, name: 'Foo')
   end
 
+  it 'reports top level structs defined through assignment' do
+    src = <<-EOS
+      Foo = Struct.new(:x, :y)
+    EOS
+    expect(src).to reek_of(:IrresponsibleModule, name: 'Foo')
+  end
+
   it 'does not report constants that are not classes' do
     src = <<-EOS
       module Qux
         Foo = 23
         Bar = Hash.new
         Quuz = 'foo'.freeze
+        Zyxxy = Class.new.new
       end
     EOS
     expect(src).not_to reek_of(:IrresponsibleModule)

data/spec/reek/smells/unused_private_method_spec.rb

@@ -4,6 +4,12 @@ require_lib 'reek/examiner'
 require_relative 'smell_detector_shared'
 
 RSpec.describe Reek::Smells::UnusedPrivateMethod do
+  let(:configuration) do
+    test_configuration_for(
+      described_class =>
+        { Reek::Smells::SmellConfiguration::ENABLED_KEY => true }
+    )
+  end
   let(:detector) { build(:smell_detector, smell_type: :UnusedPrivateMethod) }
 
   it_should_behave_like 'SmellDetector'
@@ -18,8 +24,8 @@ RSpec.describe Reek::Smells::UnusedPrivateMethod do
         end
       EOF
 
-      expect(source).to reek_of(:UnusedPrivateMethod, name: :start)
-      expect(source).to reek_of(:UnusedPrivateMethod, name: :drive)
+      expect(source).to reek_of(:UnusedPrivateMethod, { name: :start }, configuration)
+      expect(source).to reek_of(:UnusedPrivateMethod, { name: :drive }, configuration)
     end
 
     it 'creates warnings correctly' do
@@ -31,7 +37,7 @@ RSpec.describe Reek::Smells::UnusedPrivateMethod do
         end
       EOF
 
-      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod')
+      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod', configuration: configuration)
 
       first_warning = examiner.smells.first
       expect(first_warning.smell_category).to eq(Reek::Smells::UnusedPrivateMethod.smell_category)
@@ -58,7 +64,7 @@ RSpec.describe Reek::Smells::UnusedPrivateMethod do
         end
       EOF
 
-      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod')
+      examiner = Reek::Examiner.new(source, 'UnusedPrivateMethod', configuration: configuration)
 
       expect(examiner.smells.size).to eq(1)
       warning_for_drive = examiner.smells.first

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.10.1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -401,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby