reek 5.3.1 → 5.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: db4147666bde8bb5b529a24811652b2962207c644f391bef9dd134091490ae44
-  data.tar.gz: 1bc45d794c8c4a678801a612e533c2f1fff5a490ccc3e0e60013b95ff6a387f2
+SHA1:
+  metadata.gz: 8e78fe759fff41903b35f67c62cd0a823258f46f
+  data.tar.gz: 83e26bb16a5d03352a901311e1db029a5687bfe6
 SHA512:
-  metadata.gz: e7dddc4d7211d87887bbb3d639d499a9eb4730f1915c88793fe591f67332a549dcb88fa678bc4acd50bc6e05c8183eede890b03b6e000c036825c58e10f14b2e
-  data.tar.gz: 49ebed1b359d43a42e843dc5e994c62c7d9ca7a9e3b0cb8640bd345664c8d8d094b7c42a14efea81280a3575c9f9f2b25b22ecceece76b09cfcc40589de7fc18
+  metadata.gz: a8db3fdbfd849bfd3e6e7f9f7fd13351ad92622d0aae71206960f70363077638e8de831bdb975c36c2515201c40dc294c6bf68ccc4ed12c3f78cac18b484f9c8
+  data.tar.gz: 8ac99b438e7fe7e9dd72e53a30cb808f4bb9e0527bac80e9cf8ce95aef5e35783e91fce47786162b3db70248915e9c056fd2ef795c68f1f54a514addfd745a7e

data/.rubocop.yml

@@ -24,10 +24,6 @@ Layout/DotPosition:
 Layout/EmptyLineBetweenDefs:
   AllowAdjacentOneLineDefs: true
 
-# Use active_support's strip_heredoc to indent heredocs
-Layout/IndentHeredoc:
-  EnforcedStyle: active_support
-
 # Always put the closing brace on the last line
 Layout/MultilineMethodCallBraceLayout:
   EnforcedStyle: same_line
@@ -66,11 +62,6 @@ Metrics/LineLength:
 Metrics/ParameterLists:
   CountKeywordArgs: false
 
-# EOS is a fine name to use in our specs
-Naming/HeredocDelimiterNaming:
-  Exclude:
-    - 'spec/**/*'
-
 # These files do not test classes or modules
 RSpec/DescribeClass:
   Exclude:

data/.travis.yml

@@ -1,4 +1,3 @@
-sudo: false
 dist: trusty
 cache: bundler
 language: ruby
@@ -14,7 +13,7 @@ rvm:
   - 2.5
   - 2.6
   - jruby-9.1.17.0
-  - jruby-9.2.5.0
+  - jruby-9.2.6.0
   - jruby-head
   - ruby-head
   - rubinius-3

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 5.3.2 (2019-03-22)
+
+* (troessner) Use Parser26.
+
 ## 5.3.1 (2019-02-08)
 
 * (Al Snow) Upgrade parser dependency

data/Gemfile

@@ -13,7 +13,7 @@ group :development do
   gem 'rake',                '~> 12.0'
   gem 'rspec',               '~> 3.0'
   gem 'rspec-benchmark',     '~> 0.4.0'
-  gem 'rubocop',             '~> 0.63.0'
+  gem 'rubocop',             '~> 0.66.0'
   gem 'rubocop-rspec',       '~> 1.32.0'
   gem 'simplecov',           '~> 0.16.1'
   gem 'yard',                '~> 0.9.5'

data/docs/API.md

@@ -23,13 +23,13 @@ Code says more than a thousand words:
 ```ruby
 require 'reek'
 
-source = <<-EOS
+source = <<-RUBY
   class Dirty
     def m(a,b,c)
       puts a,b
     end
   end
-EOS
+RUBY
 
 reporter = Reek::Report::TextReport.new
 examiner = Reek::Examiner.new source
@@ -117,13 +117,13 @@ require 'reek'
 config_hash = { 'IrresponsibleModule' => { 'enabled' => false } }
 configuration = Reek::Configuration::AppConfiguration.from_hash config_hash
 
-source = <<-EOS
+source = <<-RUBY
   class Dirty
     def call_me(a,b)
       puts a,b
     end
   end
-EOS
+RUBY
 
 reporter = Reek::Report::TextReport.new
 examiner = Reek::Examiner.new(source, configuration: configuration); nil

data/docs/Duplicate-Method-Call.md

@@ -3,7 +3,74 @@
 ## Introduction
 
 Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.
-Reek implements a check for _Duplicate Method Call_.
+
+Let's look at an example that is quite common in the Rails world:
+
+```Ruby
+def not_production?
+  Rails.env.development? || Rails.env.test?
+end  
+```
+
+While this duplicate usage of `Rails.env` might seem innocuous there are 2 problems with it:
+
+1.) Efficiency
+
+```Ruby
+Rails.env.development? || Rails.env.test?
+```
+
+is not as efficient as it could be. If the call to `env` is not memoized your basically paying twice in terms of computation for something that you should only pay once.
+
+Here
+
+```Ruby
+Rails.env.development? || Rails.env.test?
+```
+
+you have 4 method calls while here:
+
+```Ruby
+env = Rails.env
+env.development? || env.test?
+```
+
+you have one assignment (which is very cheap in terms of computation) and 3 method calls.
+The difference might not be much here but just imagine you're writing a high performance app or you doing some expensive database calls in each method call.
+
+It doesn't really matter though if the efficiency difference is significant. This is a matter of principle - we believe that being efficient is one of the vital traits of good software.
+
+2.) Maintainability
+
+The second point is a bit more subtle. This
+
+```Ruby
+env = Rails.env
+env.development? || env.test?
+```
+
+is a lot more intention revealing than 
+
+```Ruby
+Rails.env.development? || Rails.env.test?
+```
+
+Here
+
+```Ruby
+env = Rails.env
+env.development? || env.test?
+```
+
+I'm very clear on what I do: I get the environment and then I run some checks on it.
+
+Here
+
+```Ruby
+Rails.env.development? || Rails.env.test?
+```
+
+I'm not very clear on what I do and it requires quite more mental effort: Ok, so I'm talking to Rails, getting the environment and then running a check on it ...or .....oh, I get the same Rails constant again, get the same environment and run another check on it.
 
 ## Example
 

data/docs/How-To-Write-New-Detectors.md

@@ -91,11 +91,11 @@ Here's what it looks like for `UncommunicativeVariableName`:
 
 ```Ruby
 it 'reports the right values' do
-  src = <<-EOS
+  src = <<-RUBY
     def alfa
       bravo = 5
     end
-  EOS
+  RUBY
 
   expect(src).to reek_of(:UncommunicativeVariableName,
                          lines:   [2],
@@ -106,12 +106,12 @@ it 'reports the right values' do
 end
 
 it 'does count all occurences' do
-  src = <<-EOS
+  src = <<-RUBY
     def alfa
       bravo = 3
       charlie = 7
     end
-  EOS
+  RUBY
 
   expect(src).to reek_of(:UncommunicativeVariableName,
                          lines: [2],

data/docs/Reek-Driven-Development.md

@@ -1,8 +1,10 @@
-# Reek Driven Development
+# Reek-Driven Development
 
-## rake
+One way to drive quality into your code from the very beginning of a project is to run Reek as a part of your testing process.
 
-One way to drive quality into your code from the very beginning of a project is to run Reek as a part of your testing process. For example, you could do that by adding a [Rake Task](Rake-Task.md) to your rakefile, which will make it easy to run Reek on all your source files whenever you need to.
+## Rake: `Reek::Rake::Task`
+
+You can add a [Rake Task] to your Rakefile, which will run Reek on all your source files.
 
 ```Ruby
 require 'reek/rake/task'
@@ -14,13 +16,21 @@ Reek::Rake::Task.new do |t|
 end
 ```
 
-Now the command `reek` will run Reek on your source code (and in this case, it fails if it finds any smells). For more detailed information about Reek's integration with Rake, see [Rake Task](Rake-Task.md).
+Now, `rake reek` will run Reek on your source code. And, in this case, it fails if it finds any smells.
+
+For more detailed information about Reek's integration with Rake, see [Rake Task].
+
+[Rake Task]: Rake-Task.md
+
+## RSpec: `reek/spec`
 
-## reek/spec
+You can add Reek expectations directly into your RSpec specs.
 
-But there's another way; a much more effective "Reek-driven" approach: add Reek expectations directly into your Rspec specs. Here's an example taken directly from Reek's own source code:
+This example is from Reek's own source code:
 
 ```Ruby
+require 'reek/spec'
+
 it 'contains no code smells' do
   Pathname.glob('lib/**/*.rb').each do |file|
     expect(file).not_to reek
@@ -28,12 +38,9 @@ it 'contains no code smells' do
 end
 ```
 
-By requiring "reek/spec":http://reek.rubyforge.org/rdoc/classes/Reek/Spec.html you gain access to the `reek` matcher, which returns true if and only if Reek finds smells in your code. And if the test fails, the matcher produces an error message that includes details of all the smells it found.
+By requiring [`reek/spec`] you gain access to the `reek` matcher.
 
-## assert
+The `reek` matcher returns true if and only if Reek finds smells in your code. If the test fails, the matcher produces an error message that includes details of all the smells it found.
 
-If you're not yet into BDD with Rspec, you can still gain the benefits of Reek-driven development using assertions:
+[`reek/spec`]: ../lib/reek/spec.rb
 
-```Ruby
-assert !Dir['lib/**/*.rb'].to_source.smelly?
-```

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.1/docs/Code-Smells.md for a list of smells
+                                           Check out https://github.com/troessner/reek/blob/v5.3.2/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.1/docs/Code-Smells.md for a details on each detector
+      Check out https://github.com/troessner/reek/blob/v5.3.2/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.1/docs/Uncommunicative-Method-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.2/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.1/docs/Uncommunicative-Variable-Name.md",
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.2/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.1/docs/Irresponsible-Module.md"
+              "documentation_link": "https://github.com/troessner/reek/blob/v5.3.2/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.1/docs/Uncommunicative-Method-Name.md]
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.3.1/docs/Uncommunicative-Variable-Name.md]
+        [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]
       """
 
     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.1/docs/Uncommunicative-Method-Name.md]
-        UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/v5.3.1/docs/Uncommunicative-Variable-Name.md]
+        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]
       """
 
     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.1/docs/Uncommunicative-Method-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.3.2/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.1/docs/Uncommunicative-Variable-Name.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.3.2/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.1/docs/Irresponsible-Module.md
+        documentation_link: https://github.com/troessner/reek/blob/v5.3.2/docs/Irresponsible-Module.md
       """

data/lib/reek/source/source_code.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../cli/silencer'
-Reek::CLI::Silencer.without_warnings { require 'parser/ruby25' }
+Reek::CLI::Silencer.without_warnings { require 'parser/ruby26' }
 require_relative '../tree_dresser'
 require_relative '../ast/node'
 require_relative '../ast/builder'
@@ -53,7 +53,7 @@ module Reek
       end
 
       def self.default_parser
-        Parser::Ruby25.new(AST::Builder.new).tap do |parser|
+        Parser::Ruby26.new(AST::Builder.new).tap do |parser|
           diagnostics = parser.diagnostics
           diagnostics.all_errors_are_fatal = true
           diagnostics.ignore_warnings      = true

data/lib/reek/version.rb

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

data/spec/reek/ast/node_spec.rb

@@ -68,7 +68,7 @@ RSpec.describe Reek::AST::Node do
     end
 
     it 'finds 3 ifs in a class' do
-      src = <<-EOS
+      src = <<-RUBY
         class Scrunch
           def first
             return @field == :sym ? 0 : 3;
@@ -82,7 +82,7 @@ RSpec.describe Reek::AST::Node do
             raise 'flu!' unless @field == :sym
           end
         end
-      EOS
+      RUBY
       ast = Reek::Source::SourceCode.from(src).syntax_tree
       expect(ast.each_node(:if).to_a.length).to eq(3)
     end

data/spec/reek/code_comment_spec.rb

@@ -58,10 +58,10 @@ RSpec.describe Reek::CodeComment do
     end
 
     it 'parses multiple hashed options' do
-      comment = <<-EOF
+      comment = <<-RUBY
         # :reek:DuplicateMethodCall { enabled: false }
         # :reek:NestedIterators { enabled: true }
-      EOF
+      RUBY
       config = build(:code_comment, comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
@@ -72,9 +72,9 @@ RSpec.describe Reek::CodeComment do
     end
 
     it 'parses multiple hashed options on the same line' do
-      comment = <<-EOF
+      comment = <<-RUBY
         #:reek:DuplicateMethodCall { enabled: false } and :reek:NestedIterators { enabled: true }
-      EOF
+      RUBY
       config = build(:code_comment, comment: comment).config
 
       expect(config).to include('DuplicateMethodCall', 'NestedIterators')
@@ -111,12 +111,12 @@ RSpec.describe Reek::CodeComment do
     end
 
     it 'removes the configuration options from the comment' do
-      original_comment = <<-EOF
+      original_comment = <<-RUBY
         # Actual
         # :reek:DuplicateMethodCall { enabled: false }
         # :reek:NestedIterators { enabled: true }
         # comment
-      EOF
+      RUBY
       comment = build(:code_comment, comment: original_comment)
 
       expect(comment.send(:sanitized_comment)).to eq('Actual comment')

data/spec/reek/context/code_context_spec.rb

@@ -120,13 +120,13 @@ RSpec.describe Reek::Context::CodeContext do
 
   describe '#config_for' do
     let(:src) do
-      <<-EOS
+      <<-RUBY
         # :reek:DuplicateMethodCall { allow_calls: [ puts ] }')
         def repeated_greeting
           puts 'Hello!'
           puts 'Hello!'
         end
-      EOS
+      RUBY
     end
     let(:expression) { Reek::Source::SourceCode.from(src).syntax_tree }
     let(:outer) { nil }