reek 3.8.2 → 3.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b0a5ac6a8b0b3a7b7c68c09462e3337c8914e9e
-  data.tar.gz: 519f5ade29783ce076e8b6ee58b126ccef9afc27
+  metadata.gz: bee0377800c5a5a58c7a27bf63f92cc56b195327
+  data.tar.gz: d824f0e71d925b69c3c2d23d95b4a4c68f4d5a2c
 SHA512:
-  metadata.gz: 336a10dfe8f830398b76dc288aab1eaad282d6f6e83d904d5292ee08436ea932e14090f791f9eee039fea211b772aee472ca66a0f31f4b10c5742db147b5e414
-  data.tar.gz: 8a120730d0611c4ca5e23bbddfca5c0ea76badf734dfe925588b299e2d5508298cbeae7be1c943e6e3b8dfe21e813907085eda4fcf15024c96dd32926edd0f4d
+  metadata.gz: fdd5cd74638b200650968a537305b71aca06e986643a30a06f703652f59e0b663510425dd4aaf5ebc292fd315ecf85793dca4bfe3aff14873ddfddb15602103c
+  data.tar.gz: 9bea39cdfbaf775cf748852b69bc009f8b1adfa7b6cfa1f5763810c3236c1ed5f5336691e81e34d88bc66ba2c3208605d291104531711beb4778614d91d2af55

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 3.8.3 (2016-01-15)
+
+* (avdgaag) Accept FileList as Rake task source file
+
 ## 3.8.2 (2016-01-07)
 
 * (pocke) Skip path if path doesn't exist.

data/docs/Rake-Task.md

@@ -41,6 +41,14 @@ Reek::Rake::Task.new do |t|
 end
 ```
 
+Alternatively, you can create your own [Rake::FileList](http://rake.rubyforge.org/classes/Rake/FileList.html) and use that for `source_files`:
+
+```Ruby
+Reek::Rake::Task.new do |t|
+  t.source_files = FileList['lib/**/*.rb'].exclude('lib/templates/**/*.rb')
+end
+```
+
 ## Configuration via environment variables
 
 You can overwrite the following attributes by environment variables:

data/docs/Unused-Private-Method.md

@@ -45,3 +45,30 @@ class ContextBuilder
 end
 ```
 
+Note that disabling this detector via comment works on a class scope, not
+a method scope (like you can see above).
+
+## Known limitations
+
+* Method calls via dynamic dispatch (e.g. via `send`) is something `Reek` (or any other
+  static tool for that matter) can not detect.
+* Method calls via callback like [Rails filters](http://guides.rubyonrails.org/action_controller_overview.html#filters)
+  will trigger this as well, e.g.:
+
+```Ruby
+  class BankController < ActionController::Base
+    before_filter :audit
+
+    private
+    def audit
+      # ....
+    end
+  end
+```
+* `Reek` works on a per-file base. This means that using something like the [template pattern](https://en.wikipedia.org/wiki/Template_method_pattern)
+  with private methods will trigger this detector.
+  We do believe though that using private methods to fill out a template in a
+  superclass is not a good idea in general so this probably isn't really a problem
+  but still worth mentioning it.
+
+

data/features/rake_task/rake_task.feature

@@ -20,6 +20,24 @@ Feature: Reek can be driven through its Task
         [3]:UncommunicativeMethodName: Smelly#m has the name 'm' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
       """
 
+  Scenario: source_files using a FileList instead of a String
+    Given a smelly file called 'smelly.rb'
+    When I run rake reek with:
+      """
+      Reek::Rake::Task.new do |t|
+        t.source_files = FileList['smelly.*']
+        t.reek_opts = '--no-color'
+      end
+      """
+    Then the exit status indicates an error
+    And it reports:
+      """
+      smelly.rb -- 3 warnings:
+        [4, 5]:DuplicateMethodCall: Smelly#m calls @foo.bar 2 times [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        [4, 5]:DuplicateMethodCall: Smelly#m calls puts(@foo.bar) 2 times [https://github.com/troessner/reek/blob/master/docs/Duplicate-Method-Call.md]
+        [3]:UncommunicativeMethodName: Smelly#m has the name 'm' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+      """
+
   Scenario: name changes the task name
     Given a smelly file called 'smelly.rb'
     When I run rake silky with:

data/lib/reek/rake/task.rb

@@ -85,7 +85,10 @@ module Reek
 
       # @public
       def source_files=(files)
-        raise ArgumentError, no_string_given_for_file_list_warning unless files.is_a?(String)
+        unless files.is_a?(String) || files.is_a?(FileList)
+          raise ArgumentError, 'File list should be a FileList or a String that can contain'\
+            " a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
+        end
         @source_files = FileList[files]
       end
 
@@ -93,10 +96,6 @@ module Reek
 
       private_attr_reader :fail_on_error, :name, :verbose
 
-      def no_string_given_for_file_list_warning
-        "File list should be a String that can contain a glob pattern, e.g. '{app,lib,spec}/**/*.rb'"
-      end
-
       def define_task
         desc 'Check for code smells'
         task(name) { run_task }

data/lib/reek/version.rb

@@ -6,6 +6,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '3.8.2'
+    STRING = '3.8.3'
   end
 end

metadata

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