reek 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afd9361841a4f7ae194b659bbc70c06e4bef20f2
-  data.tar.gz: 52e321f176aca45a3c424aff60749ad3bc11f695
+  metadata.gz: 988f551b421341be717b93689070ad4d8b809a2a
+  data.tar.gz: 2089735509323d24ea39425e5aa3a67ba888cb40
 SHA512:
-  metadata.gz: 87df16e382177e9a3a2f0f6465fb3eaed25ccebf274f9ebb8f3918ba81a860f93895a780c48ee12ddcae529ac544dda89715e132880ddbeee5b001a165c38003
-  data.tar.gz: 82b2b6aa9cde0da91999aff5ddcf8f2b6a7096b1766294023ddc3c58b0162f3e5bb27cdc653d8d0a2521f844c5580f2459d0ea2b6d66df7c31b4d7f29ab50f87
+  metadata.gz: 38f11b564b3ae5f11d53849ece35b2ea544f83c4ced89e4e344a8a4b7a2d76470f614fd51890f2379faeac35860cc01fca62c643c8a864786ac15a3640c8aa16
+  data.tar.gz: c24c9b966287c29db29073c5aad19e4890d1949d9d49c0d38478d4ed48f45818d4665b302704a98a58867f99156ee0865cccff71ebb18fbda90bd34eeca9e2c1

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 2.2.1
+
+* (mvz) Support methods using array decomposition arguments
+
 == 2.2.0
 
 * (sauliusgrigaitis) Add support for XML reports

data/features/samples.feature

@@ -279,22 +279,14 @@ Feature: Basic smell detection
       RedCloth#v_align doesn't depend on instance state (UtilityFunction)
     """
 
-  Scenario: Correct smells from a source file with Ruby 2.0 specific syntax
-    Given the "ruby20_syntax.rb" sample file exists
-    When I run reek ruby20_syntax.rb
+  Scenario: Correct smells from a source file with unusual syntax samples
+    Given the "unusual_syntax.rb" sample file exists
+    When I run reek unusual_syntax.rb
     Then the exit status indicates smells
     And it reports:
     """
-    ruby20_syntax.rb -- 1 warning:
-      [1]:SomeClass has no descriptive comment (IrresponsibleModule)
-    """
-
-  Scenario: Correct smells from a source file with Ruby 2.1 specific syntax
-    Given the "ruby21_syntax.rb" sample file exists
-    When I run reek ruby21_syntax.rb
-    Then the exit status indicates smells
-    And it reports:
-    """
-    ruby21_syntax.rb -- 1 warning:
+    unusual_syntax.rb -- 3 warnings:
       [1]:SomeClass has no descriptive comment (IrresponsibleModule)
+      [18]:SomeClass#method_with_array_decomposition has the parameter name 'a' (UncommunicativeParameterName)
+      [18]:SomeClass#method_with_array_decomposition has the parameter name 'b' (UncommunicativeParameterName)
     """

data/lib/reek/sexp/sexp_extensions.rb

@@ -38,6 +38,10 @@ module Reek
         def anonymous_splat?
           false
         end
+
+        def components
+          [self]
+        end
       end
 
       # Utility methods for :arg nodes.
@@ -97,6 +101,24 @@ module Reek
         include ArgNodeBase
       end
 
+      # Base module for utility methods for nodes that can contain argument
+      # nodes nested through :mlhs nodes.
+      module NestedAssignables
+        def components
+          children.flat_map(&:components)
+        end
+      end
+
+      # Utility methods for :args nodes.
+      module ArgsNode
+        include NestedAssignables
+      end
+
+      # Utility methods for :mlhs nodes.
+      module MlhsNode
+        include NestedAssignables
+      end
+
       # Base module for utility methods for :and and :or nodes.
       module LogicOperatorBase
         def condition() self[1] end
@@ -203,7 +225,7 @@ module Reek
         end
 
         def parameters
-          argslist.children
+          argslist.components
         end
 
         def parameter_names

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '2.2.0'
+    STRING = '2.2.1'
   end
 end

data/spec/reek/smells/boolean_parameter_spec.rb

@@ -20,6 +20,32 @@ RSpec.describe Reek::Smells::BooleanParameter do
         expect(src).to reek_of(:BooleanParameter, name: 'arga')
         expect(src).to reek_of(:BooleanParameter, name: 'argb')
       end
+
+      it 'reports keyword parameters defaulted to booleans' do
+        src = 'def cc(arga: true, argb: false) end'
+        expect(src).to reek_of(:BooleanParameter, name: 'arga')
+        expect(src).to reek_of(:BooleanParameter, name: 'argb')
+      end
+
+      it 'does not report regular parameters' do
+        src = 'def cc(a, b) end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
+
+      it 'does not report array decomposition parameters' do
+        src = 'def cc((a, b)) end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
+
+      it 'does not report keyword parameters with no default' do
+        src = 'def cc(a:, b:) end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
+
+      it 'does not report keyword parameters with non-boolean default' do
+        src = 'def cc(a: 42, b: "32") end'
+        expect(src).not_to reek_of(:BooleanParameter)
+      end
     end
 
     context 'in a singleton method' do

data/spec/reek/smells/uncommunicative_parameter_name_spec.rb

@@ -63,6 +63,18 @@ RSpec.describe Reek::Smells::UncommunicativeParameterName do
         expect("def #{host}help(_unused) basics(_unused) end").
           to reek_of(:UncommunicativeParameterName)
       end
+
+      it 'reports names inside array decomposition' do
+        src = "def #{host}help((b, nice)) basics(b, nice) end"
+        expect(src).to reek_of(:UncommunicativeParameterName,
+                               name: 'b')
+      end
+
+      it 'reports names inside nested array decomposition' do
+        src = "def #{host}help((foo, (bar, c))) basics(foo, c) end"
+        expect(src).to reek_of(:UncommunicativeParameterName,
+                               name: 'c')
+      end
     end
   end
 

data/spec/samples/{ruby20_syntax.rb → unusual_syntax.rb}

@@ -10,4 +10,12 @@ class SomeClass
   def make_other_symbol_list
     %I(foo bar baz)
   end
+
+  def method_with_required_keyword_arguments(foo:)
+    puts foo
+  end
+
+  def method_with_array_decomposition((a, b))
+    puts "#{a}, #{b}"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-09 00:00:00.000000000 Z
+date: 2015-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -414,14 +414,13 @@ files:
 - spec/samples/no_config_file/dirty.rb
 - spec/samples/optparse.rb
 - spec/samples/redcloth.rb
-- spec/samples/ruby20_syntax.rb
-- spec/samples/ruby21_syntax.rb
 - spec/samples/simple_configuration.reek
 - spec/samples/three_clean_files/clean_one.rb
 - spec/samples/three_clean_files/clean_three.rb
 - spec/samples/three_clean_files/clean_two.rb
 - spec/samples/two_smelly_files/dirty_one.rb
 - spec/samples/two_smelly_files/dirty_two.rb
+- spec/samples/unusual_syntax.rb
 - spec/spec_helper.rb
 - tasks/develop.rake
 - tasks/reek.rake
@@ -451,7 +450,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby

data/spec/samples/ruby21_syntax.rb

@@ -1,5 +0,0 @@
-class SomeClass
-  def method_with_required_keyword_arguments(foo:)
-    puts foo
-  end
-end