reek 5.3.2 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e78fe759fff41903b35f67c62cd0a823258f46f
-  data.tar.gz: 83e26bb16a5d03352a901311e1db029a5687bfe6
+SHA256:
+  metadata.gz: 5c7a7193dd76b11cd88c3e3f031784a0bb54f3bcaa35a4e3b430dd550749facc
+  data.tar.gz: 0d2f96071b27301ebbd2b3ff82b8e1fbbde2aaf647125e3903d017074c4d061b
 SHA512:
-  metadata.gz: a8db3fdbfd849bfd3e6e7f9f7fd13351ad92622d0aae71206960f70363077638e8de831bdb975c36c2515201c40dc294c6bf68ccc4ed12c3f78cac18b484f9c8
-  data.tar.gz: 8ac99b438e7fe7e9dd72e53a30cb808f4bb9e0527bac80e9cf8ce95aef5e35783e91fce47786162b3db70248915e9c056fd2ef795c68f1f54a514addfd745a7e
+  metadata.gz: cc75695b17d58bf820bf6b874e747c3a7f81c43b0e8c80a33144118b1dbbbb0e0cd294ae386026937ee0799d0a7fa7cd12c65470bfd217faaa9c66dcbd22a03c
+  data.tar.gz: cb9bfef6dd9f799c2f2733b020952909010f489b1cf621d64828a2982cc64ea912211a7bf0f9e21fc1246ce4068edb5bb1571acdd16445df6ddebca2c3c9a84b

data/.rubocop.yml

@@ -62,6 +62,9 @@ Metrics/LineLength:
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+
 # These files do not test classes or modules
 RSpec/DescribeClass:
   Exclude:

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 5.4.0 (2019-04-24)
+
+* (Philippe Bernery) Enable regex for directory directives.
+
 ## 5.3.2 (2019-03-22)
 
 * (troessner) Use Parser26.

data/CONTRIBUTING.md

@@ -190,3 +190,20 @@ We are following [semantic versioning](http://semver.org/).
 If you're working on a change that is breaking backwards-compatibility
 just go ahead with your pull request like normal. We'll discuss this then in
 the pull request and help you to point your pull request to the right branch.
+
+### Releasing Reek
+
+In this example we assume the current version is 5.3.1 and you want to update to 5.3.2.
+
+* Create a branch with a name like "prepare-v.5.3.2"
+* Update the version in `lib/reek/version.rb`
+* List all relevant changes in `CHANGELOG.md`
+* Update the version number in our cucumber features, otherwise the build will fail. You can do this quite easily via
+  ```Bash
+  find features/ -type f -exec sed -i '' 's/v5.3.1/v5.3.2/g' {} +
+  ```
+* Push the branch, create a pull request, have it reviewed and merged
+* Pull the latest master and then do a
+  ```Bash
+  bundle exec rake release
+  ```

data/Gemfile

@@ -12,8 +12,8 @@ group :development do
   gem 'kramdown-parser-gfm', '~> 1.0'
   gem 'rake',                '~> 12.0'
   gem 'rspec',               '~> 3.0'
-  gem 'rspec-benchmark',     '~> 0.4.0'
-  gem 'rubocop',             '~> 0.66.0'
+  gem 'rspec-benchmark',     '~> 0.5.0'
+  gem 'rubocop',             '~> 0.67.2'
   gem 'rubocop-rspec',       '~> 1.32.0'
   gem 'simplecov',           '~> 0.16.1'
   gem 'yard',                '~> 0.9.5'

data/README.md

@@ -309,12 +309,18 @@ detectors:
 # You can configure smells on a per-directory base.
 # E.g. the classic Rails case: controllers smell of NestedIterators (see /docs/Nested-Iterators.md) and
 # helpers smell of UtilityFunction (see docs/Utility-Function.md)
-# Note that we only allow configuration on a directory level, not a file level, so all paths have to point to directories.
+#
+# Note that we only allow configuration on a directory level, not a file level,
+# so all paths have to point to directories.
+# A Dir.glob pattern can be used.
 directories:
   "web_app/app/controllers":
     NestedIterators:
       enabled: false
-  "web_app/app/helpers":
+  "web_app/app/helpers**:
+    UtilityFunction:
+      enabled: false
+  "web_app/lib/**/test/**":
     UtilityFunction:
       enabled: false
 

data/docs/Reek-4-to-Reek-5-migration.md

@@ -175,18 +175,13 @@ reek_of('DuplicateMethodCall')
 * `wiki-links` flag has been renamed to `documentation` flag
 * Reek assumes the default configuration file to be named ".reek.yml" and will ignore all other files. You can
 still use any name you want though by passing in a name via the `-c` flag
-* We have dropped the legacy code comment separator ":" at the end of a detector name. If you wanted to configure
-a smell detector via comment before this release you had to use g like this:
+* We have dropped the legacy code comment separator `:` at the end of a detector name. Before this release,
+to configure a smell detector via comment, you had to end with a colon after the detector name.
+This syntax is disallowed with Reek 5 - now you have to drop the `:` at the end, like this:
 
-```
-# :reek:UnusedPrivateMethod: { exclude: [ bravo ] }
-```
-
-Mind the ":" at the end of "UnusedPrivateMethod". This syntax is disallowed with Reek 5 - you have to drop the ":"
-at the end now like this:
-
-```
-# :reek:UnusedPrivateMethod { exclude: [ bravo ] }
+```diff
+-# :reek:UnusedPrivateMethod: { exclude: [ bravo ] }
++# :reek:UnusedPrivateMethod { exclude: [ bravo ] }
 ```
 
 * We have dropped support for Ruby 2.1 and 2.2 since they are officially not supported by the Ruby core team anymore

data/features/command_line_interface/options.feature

@@ -43,7 +43,7 @@ Feature: Reek can be controlled using command-line options
           -c, --config FILE                Read configuration options from FILE
               --smell SMELL                Only look for a specific smell.
                                            Call it like this: reek --smell MissingSafeMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v5.3.2/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v5.4.0/docs/Code-Smells.md for a list of smells
               --stdin-filename FILE        When passing code in via pipe, assume this filename when checking file or directory rules in the config.
 
       Generate a todo list:
@@ -120,5 +120,5 @@ Feature: Reek can be controlled using command-line options
       UnusedPrivateMethod
       UtilityFunction
 
-      Check out https://github.com/troessner/reek/blob/v5.3.2/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v5.4.0/docs/Code-Smells.md for a details on each detector
       """

data/features/reports/json.feature

@@ -24,7 +24,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 4 ],
               "message": "has the name 'x'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Method-Name.md",
               "name": "x"
           },
           {
@@ -33,7 +33,7 @@ Feature: Report smells using simple JSON layout
               "context": "Smelly#x",
               "lines": [ 5 ],
               "message": "has the variable name 'y'",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Variable-Name.md",
               "name": "y"
           }
       ]
@@ -53,7 +53,7 @@ Feature: Report smells using simple JSON layout
                   1
               ],
               "message": "has no descriptive comment",
-              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.2/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.4.0/docs/Irresponsible-Module.md"
           }
       ]
       """

data/features/reports/reports.feature

@@ -182,8 +182,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Variable-Name.md]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:
@@ -209,8 +209,8 @@ Feature: Correctly formatted reports
     And it reports:
       """
       smelly.rb -- 2 warnings:
-        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Variable-Name.md]
+        UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Method-Name.md]
+        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Variable-Name.md]
       """
 
     Examples:

data/features/reports/yaml.feature

@@ -25,7 +25,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeMethodName
         source: smelly.rb
         name: x
-        documentation_link: https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Method-Name.md
       - context: Smelly#x
         lines:
         - 5
@@ -33,7 +33,7 @@ Feature: Report smells using simple YAML layout
         smell_type: UncommunicativeVariableName
         source: smelly.rb
         name: y
-        documentation_link: https://github.com/troessner/reek/blob/v5.3.2/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.4.0/docs/Uncommunicative-Variable-Name.md
       """
 
   Scenario: Indicate smells and print them as yaml when using STDIN
@@ -48,5 +48,5 @@ Feature: Report smells using simple YAML layout
         lines:
         - 1
         message: has no descriptive comment
-        documentation_link: https://github.com/troessner/reek/blob/v5.3.2/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.4.0/docs/Irresponsible-Module.md
       """

data/lib/reek/configuration/directory_directives.rb

@@ -53,10 +53,37 @@ module Reek
       # @quality :reek:FeatureEnvy
       def best_match_for(source_base_dir)
         keys.
-          select { |pathname| source_base_dir.to_s.match(/#{Regexp.escape(pathname.to_s)}/) }.
+          select { |pathname| source_base_dir.to_s.match(glob_to_regexp(pathname.to_s)) }.
           max_by { |pathname| pathname.to_s.length }
       end
 
+      # Transform a glob pattern to a regexp.
+      #
+      # It changes:
+      # - /** to .*,
+      # - ** to .*,
+      # - * to [^\/]*.
+      #
+      # @quality :reek:FeatureEnvy
+      # @quality :reek:UtilityFunction
+      def glob_to_regexp(glob)
+        is_glob_pattern = glob.include?('*')
+
+        regexp = if is_glob_pattern
+                   glob.
+                     gsub(%r{/\*\*$}, '<<to_eol_wildcards>>').
+                     gsub('**', '<<to_wildcards>>').
+                     gsub('*', '[^/]*').
+                     gsub('.', '\.').
+                     gsub('<<to_eol_wildcards>>', '.*').
+                     gsub('<<to_wildcards>>', '.*')
+                 else
+                   glob + '.*'
+                 end
+
+        Regexp.new("^#{regexp}$", Regexp::IGNORECASE)
+      end
+
       def error_message_for_invalid_smell_type(klass)
         "You are trying to configure smell type #{klass} but we can't find one with that name.\n" \
           "Please make sure you spelled it right. (See 'docs/defaults.reek' in the Reek\n" \

data/lib/reek/examiner.rb

@@ -93,8 +93,8 @@ module Reek
       wrap_exceptions do
         examine_tree
       end
-    rescue StandardError => exception
-      raise unless @error_handler.handle exception
+    rescue StandardError => error
+      raise unless @error_handler.handle error
 
       []
     end

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '5.3.2'
+    STRING = '5.4.0'
   end
 end

data/spec/reek/configuration/directory_directives_spec.rb

@@ -44,9 +44,12 @@ RSpec.describe Reek::Configuration::DirectoryDirectives do
   describe '#best_match_for' do
     let(:directives) do
       {
-        Pathname.new('foo/bar/baz') => {},
-        Pathname.new('foo/bar')     => {},
-        Pathname.new('bar/boo')     => {}
+        Pathname.new('foo/bar/baz')    => {},
+        Pathname.new('foo/bar')        => {},
+        Pathname.new('bar/boo')        => {},
+        Pathname.new('bar/**/test/**') => {},
+        Pathname.new('bar/**/spec/*')  => {},
+        Pathname.new('bar/**/.spec/*') => {}
       }.extend(described_class)
     end
 
@@ -62,6 +65,42 @@ RSpec.describe Reek::Configuration::DirectoryDirectives do
       expect(hit.to_s).to eq('foo/bar')
     end
 
+    it 'returns the corresponding directory when source_base_dir matches the Dir.glob like pattern' do
+      source_base_dir = 'bar/something/test'
+      hit = directives.send :best_match_for, source_base_dir
+      expect(hit.to_s).to eq('bar/**/test/**')
+    end
+
+    it 'returns the corresponding directory when source_base_dir is a leaf of the Dir.glob like pattern' do
+      source_base_dir = 'bar/something/test/with/some/subdirectory'
+      hit = directives.send :best_match_for, source_base_dir
+      expect(hit.to_s).to eq('bar/**/test/**')
+    end
+
+    it 'returns the corresponding directory when source_base_dir is a direct leaf of the Dir.glob like pattern' do
+      source_base_dir = 'bar/something/spec/direct'
+      hit = directives.send :best_match_for, source_base_dir
+      expect(hit.to_s).to eq('bar/**/spec/*')
+    end
+
+    it 'returns the corresponding directory when source_base_dir contains a . character' do
+      source_base_dir = 'bar/something/.spec/direct'
+      hit = directives.send :best_match_for, source_base_dir
+      expect(hit.to_s).to eq('bar/**/.spec/*')
+    end
+
+    it 'does not match an arbitrary directory when source_base_dir contains a character that could match the .' do
+      source_base_dir = 'bar/something/aspec/direct'
+      hit = directives.send :best_match_for, source_base_dir
+      expect(hit.to_s).to eq('')
+    end
+
+    it 'returns nil when source_base_dir is a not direct leaf of the Dir.glob one-folder pattern' do
+      source_base_dir = 'bar/something/spec/with/some/subdirectory'
+      hit = directives.send :best_match_for, source_base_dir
+      expect(hit).to be_nil
+    end
+
     it 'returns nil we are on top of the tree and all other directories are below' do
       source_base_dir = 'foo'
       hit = directives.send :best_match_for, source_base_dir

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 5.3.2
+  version: 5.4.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -500,7 +500,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby