reek 4.6.2 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 621c25e4d095d1164a97aea57967dcf79f1961ec
-  data.tar.gz: 4e9dbb2eee9bec1ac8616811b1895631206cd394
+  metadata.gz: 1ec8e3f40eb231654c58d4025080c703268e7322
+  data.tar.gz: a018b00cdba03a5da356e1c05e32bd0bc04ba569
 SHA512:
-  metadata.gz: d5c4bf0e5c8f2b344b5bec3c386599e1a2d2eadc6e70c484146d771190fcc6fba24986a7747654962caaac5f27c625a49d2f11a5f9f0c8f375b34b309945178b
-  data.tar.gz: a98dab6abcd0ffdc95695ba0883ca078ae9fa3b50d0493bf1d89f3677947d7056d5a3e7529eb9611ad5a50d1ab1efb682f2611247cd0d7225e3d4fcc12396ccb
+  metadata.gz: 78c20b5e99a3c4f804c530da98b020d634b289ea575f15339e3978088f207112a022345695b7ba45fcaa5edfbac74bcba38409e99ffc6e42d0e46f2add060fdf
+  data.tar.gz: 1bd64f7d805994fb356887cb638e900669c2308d2bc86fed37ad36709df4314dbe4dcfc616240c8790bf1d61ce5e3c1b58fd7b07e5bed385d0ced79cfad19cdf

data/.rubocop.yml

@@ -8,6 +8,30 @@ AllCops:
     - 'vendor/**/*'
   TargetRubyVersion: 2.1
 
+# Place . on the previous line
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+# Require empty lines between defs, except for one-line defs
+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
+
+# Indent one level for follow-up lines
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+# Indent one level for follow-up lines
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
 # Assume the programmer knows how bracketed block syntax works
 Lint/AmbiguousBlockAssociation:
   Enabled: false
@@ -95,14 +119,6 @@ Style/Documentation:
     - 'lib/reek/ast/sexp_extensions/super.rb'
     - 'lib/reek/ast/sexp_extensions/variables.rb'
 
-# Place . on the previous line
-Style/DotPosition:
-  EnforcedStyle: trailing
-
-# Require empty lines between defs, except for one-line defs
-Style/EmptyLineBetweenDefs:
-  AllowAdjacentOneLineDefs: true
-
 # Require comment for files in lib and bin
 Style/FrozenStringLiteralComment:
   Include:
@@ -110,26 +126,10 @@ Style/FrozenStringLiteralComment:
     - 'lib/**/*'
   EnforcedStyle: always
 
-# Use active_support's strip_heredoc to indent heredocs
-Style/IndentHeredoc:
-  EnforcedStyle: active_support
-
 # Allow multiline block chains
 Style/MultilineBlockChain:
   Enabled: false
 
-# Always put the closing brace on the last line
-Style/MultilineMethodCallBraceLayout:
-  EnforcedStyle: same_line
-
-# Indent one level for follow-up lines
-Style/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-# Indent one level for follow-up lines
-Style/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
 # There's nothing wrong with parallel assignment
 Style/ParallelAssignment:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.7.0 (2017-05-31)
+
+* (pocke) Introduce Syntax smell detector
+
 ## 4.6.2 (2017-04-27)
 
 * (pocke) Prevent from breaking on a string with escape sequence incompatible with UTF-8

data/Gemfile

@@ -16,7 +16,7 @@ group :development do
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.48.1'
+    gem 'rubocop',       '~> 0.49.1'
     gem 'rubocop-rspec', '~> 1.15.0'
   end
 

data/defaults.reek

@@ -66,6 +66,9 @@ RepeatedConditional:
 SubclassedFromCoreClass:
   enabled: true
   exclude: []
+Syntax:
+  enabled: true
+  exclude: []
 TooManyConstants:
   enabled: true
   exclude: []

data/docs/Prima-Donna-Method.md

@@ -82,7 +82,7 @@ ruby.rb -- 1 warning:
 If you want to suppress this warning you can do this via source comment like this:
 
 ```Ruby
-# :reek:PrimaDonnaMethod: { exclude: [ bravo! ] }
+# :reek:PrimaDonnaMethod { exclude: [ bravo! ] }
 class Alfa
   def bravo!
   end

data/features/command_line_interface/stdin.feature

@@ -34,6 +34,10 @@ Feature: Reek reads from $stdin when no files are given
 
   Scenario: syntax error causes the source to be ignored
     When I pass "= invalid syntax =" to reek
-    Then it reports a parsing error
-    And the exit status indicates an error
-    And it reports nothing
+    Then the exit status indicates smells
+    And it reports:
+      """
+      STDIN -- 2 warnings:
+        [2]:Syntax: This file has unexpected token $end [https://github.com/troessner/reek/blob/master/docs/Syntax.md]
+        [1]:Syntax: This file has unexpected token tEQL [https://github.com/troessner/reek/blob/master/docs/Syntax.md]
+      """

data/lib/reek/examiner.rb

@@ -97,12 +97,15 @@ module Reek
     #
     # :reek:TooManyStatements { max_statements: 8 }
     def run
-      return [] unless syntax_tree
-      begin
-        examine_tree
-      rescue Errors::BaseError => exception
-        raise unless @error_handler.handle exception
-        []
+      if source.valid_syntax? && syntax_tree
+        begin
+          examine_tree
+        rescue Errors::BaseError => exception
+          raise unless @error_handler.handle exception
+          []
+        end
+      else
+        SmellDetectors::Syntax.smells_from_source(source)
       end
     end
 

data/lib/reek/rake/task.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/env ruby
 # frozen_string_literal: true
 
 require 'rake'

data/lib/reek/report/code_climate/code_climate_configuration.yml

@@ -860,3 +860,7 @@ SubclassedFromCoreClass:
     you are gonna have a bad time.
 
     Source: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
+Syntax:
+  remediation_points: 250_000
+  content: |
+    Check syntax errors.

data/lib/reek/smell_detectors.rb

@@ -18,6 +18,7 @@ require_relative 'smell_detectors/nil_check'
 require_relative 'smell_detectors/prima_donna_method'
 require_relative 'smell_detectors/repeated_conditional'
 require_relative 'smell_detectors/subclassed_from_core_class'
+require_relative 'smell_detectors/syntax'
 require_relative 'smell_detectors/too_many_instance_variables'
 require_relative 'smell_detectors/too_many_constants'
 require_relative 'smell_detectors/too_many_methods'

data/lib/reek/smell_detectors/syntax.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'base_detector'
+
+module Reek
+  module SmellDetectors
+    # Check syntax errors.
+    # Note: this detector is called by examiner directly unlike other detectors.
+    class Syntax < BaseDetector
+      DummyContext = Struct.new(:exp, :full_name).new(
+        Struct.new('Exp', :source).new(nil),
+        'This file')
+
+      def self.contexts
+        []
+      end
+
+      def self.smells_from_source(source)
+        new.smells_from_source(source)
+      end
+
+      # :reek:FeatureEnvy
+      def smells_from_source(source)
+        source.diagnostics.map do |diagnostic|
+          smell_warning(
+            context: DummyContext,
+            lines: [diagnostic.location.line],
+            message: "has #{diagnostic.message}")
+        end
+      end
+    end
+  end
+end

data/lib/reek/source/source_code.rb

@@ -7,7 +7,6 @@ end
 require_relative '../tree_dresser'
 require_relative '../ast/node'
 require_relative '../ast/builder'
-require_relative '../errors/parse_error'
 
 # Opt in to new way of representing lambdas
 Parser::Builders::Default.emit_lambda = true
@@ -21,7 +20,7 @@ module Reek
       IO_IDENTIFIER     = 'STDIN'.freeze
       STRING_IDENTIFIER = 'string'.freeze
 
-      attr_reader :origin
+      attr_reader :origin, :diagnostics, :syntax_tree
 
       # Initializer.
       #
@@ -29,9 +28,9 @@ module Reek
       # origin - 'STDIN', 'string' or a filepath as String
       # parser - the parser to use for generating AST's out of the given source
       def initialize(code:, origin:, parser: default_parser)
-        @source = code
         @origin = origin
-        @parser = parser
+        @diagnostics = []
+        @syntax_tree = parse(parser, code)
       end
 
       # Initializes an instance of SourceCode given a source.
@@ -53,13 +52,22 @@ module Reek
         end
       end
 
+      # @return [true|false] Returns true if parsed file does not have any syntax errors.
+      def valid_syntax?
+        @diagnostics.none? { |diagnostic| [:error, :fatal].include?(diagnostic.level) }
+      end
+
+      private
+
+      attr_reader :source
+
       # Parses the given source into an AST and associates the source code comments with it.
       # This AST is then traversed by a TreeDresser which adorns the nodes in the AST
       # with our SexpExtensions.
       # Finally this AST is returned where each node is an anonymous subclass of Reek::AST::Node
       #
-      # Important to note is that Reek will not fail on unparseable files but rather print out
-      # a warning and then just continue.
+      # Important to note is that Reek will not fail on unparseable files but rather register a
+      # parse error to @diagnostics and then just continue.
       #
       # Given this @source:
       #
@@ -82,36 +90,34 @@ module Reek
       # where each node is possibly adorned with our SexpExtensions (see ast/ast_node_class_map
       # and ast/sexp_extensions for details).
       #
-      #  @return [Anonymous subclass of Reek::AST::Node] the AST presentation
-      #          for the given source
-      # :reek:TooManyStatements: { max_statements: 7 }
-      def syntax_tree
-        @syntax_tree ||=
-          begin
-            buffer = Parser::Source::Buffer.new(origin, 1)
-            buffer.source = source
-            begin
-              ast, comments = parser.parse_with_comments(buffer)
-            rescue Racc::ParseError, Parser::SyntaxError => error
-              raise Errors::ParseError, origin: origin, original_exception: error
-            end
+      # @param parser [Parser::Ruby24]
+      # @param source [String] - Ruby code
+      # @return [Anonymous subclass of Reek::AST::Node] the AST presentation
+      #         for the given source
+      def parse(parser, source)
+        buffer = Parser::Source::Buffer.new(origin, 1)
+        buffer.source = source
+        begin
+          ast, comments = parser.parse_with_comments(buffer)
+        rescue Parser::SyntaxError # rubocop:disable Lint/HandleExceptions
+          # All errors are in diagnostics. No need to handle exception.
+        end
 
-            # See https://whitequark.github.io/parser/Parser/Source/Comment/Associator.html
-            comment_map = Parser::Source::Comment.associate(ast, comments) if ast
-            TreeDresser.new.dress(ast, comment_map)
-          end
+        # See https://whitequark.github.io/parser/Parser/Source/Comment/Associator.html
+        comment_map = Parser::Source::Comment.associate(ast, comments) if ast
+        TreeDresser.new.dress(ast, comment_map)
       end
 
-      private
-
-      attr_reader :parser, :source
-
-      # :reek:UtilityFunction
+      # :reek:TooManyStatements: { max_statements: 6 }
+      # :reek:FeatureEnvy
       def default_parser
         Parser::Ruby24.new(AST::Builder.new).tap do |parser|
           diagnostics = parser.diagnostics
-          diagnostics.all_errors_are_fatal = true
-          diagnostics.ignore_warnings      = true
+          diagnostics.all_errors_are_fatal = false
+          diagnostics.ignore_warnings      = false
+          diagnostics.consumer = lambda do |diagnostic|
+            @diagnostics << diagnostic
+          end
         end
       end
     end

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.6.2'.freeze
+    STRING = '4.7.0'.freeze
   end
 end

data/spec/reek/source/source_code_spec.rb

@@ -34,50 +34,31 @@ RSpec.describe Reek::Source::SourceCode do
 
   context 'when the parser fails' do
     let(:source_name) { 'Test source' }
-    let(:error_message) { 'Error message' }
-    let(:parser) { instance_double('Parser::Ruby24') }
-    let(:src) { described_class.new(code: '', origin: source_name, parser: parser) }
-
-    shared_examples_for 'handling and recording the error' do
-      it 'raises an informative error' do
-        expect { src.syntax_tree }.
-          to raise_error(/#{source_name}: #{error_class.name}: #{error_message}/)
-      end
-    end
+    let(:src) { described_class.new(code: code, origin: source_name, **parser) }
 
     context 'with a Parser::SyntaxError' do
-      let(:error_class) { Parser::SyntaxError }
-      let(:diagnostic) { instance_double('Parser::Diagnostic', message: error_message) }
-
-      before do
-        allow(parser).to receive(:parse_with_comments).
-          and_raise error_class.new(diagnostic)
-      end
+      let(:code) { '== Invalid Syntax ==' }
+      let(:parser) { {} }
 
-      it_behaves_like 'handling and recording the error'
-    end
-
-    context 'with a Racc::ParseError' do
-      let(:error_class) { Racc::ParseError }
-
-      before do
-        allow(parser).to receive(:parse_with_comments).
-          and_raise(error_class.new(error_message))
+      it 'adds a diagnostic' do
+        expect(src.diagnostics.size).to eq 2
       end
-
-      it_behaves_like 'handling and recording the error'
     end
 
     context 'with a generic error' do
+      let(:code) { '' }
       let(:error_class) { RuntimeError }
-
-      before do
-        allow(parser).to receive(:parse_with_comments).
-          and_raise(error_class.new(error_message))
+      let(:error_message) { 'An error' }
+      let(:parser) do
+        parser = instance_double('Parser::Ruby24')
+        allow(parser).to receive(:parse_with_comments).and_raise(error_class, error_message)
+        {
+          parser: parser
+        }
       end
 
       it 'raises the error' do
-        expect { src.syntax_tree }.to raise_error error_class
+        expect { src }.to raise_error error_class, error_message
       end
     end
   end

data/spec/reek/spec/should_reek_of_spec.rb

@@ -1,7 +1,6 @@
 require 'pathname'
 require_relative '../../spec_helper'
 require_lib 'reek/spec'
-require 'active_support/core_ext/string/strip'
 require 'active_support/core_ext/hash/except'
 
 RSpec.describe Reek::Spec::ShouldReekOf do

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'pathname'
 require 'timeout'
+require 'active_support/core_ext/string/strip'
 require_relative '../lib/reek'
 require_relative '../lib/reek/spec'
 require_relative '../lib/reek/ast/ast_node_class_map'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.6.2
+  version: 4.7.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-27 00:00:00.000000000 Z
+date: 2017-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -230,7 +230,6 @@ files:
 - lib/reek/errors/base_error.rb
 - lib/reek/errors/garbage_detector_configuration_in_comment_error.rb
 - lib/reek/errors/incomprehensible_source_error.rb
-- lib/reek/errors/parse_error.rb
 - lib/reek/examiner.rb
 - lib/reek/logging_error_handler.rb
 - lib/reek/rake/task.rb
@@ -275,6 +274,7 @@ files:
 - lib/reek/smell_detectors/prima_donna_method.rb
 - lib/reek/smell_detectors/repeated_conditional.rb
 - lib/reek/smell_detectors/subclassed_from_core_class.rb
+- lib/reek/smell_detectors/syntax.rb
 - lib/reek/smell_detectors/too_many_constants.rb
 - lib/reek/smell_detectors/too_many_instance_variables.rb
 - lib/reek/smell_detectors/too_many_methods.rb

data/lib/reek/errors/parse_error.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_error'
-
-module Reek
-  module Errors
-    # Gets raised when Reek is unable to process the source
-    class ParseError < BaseError
-      MESSAGE_TEMPLATE = '%s: %s: %s'.freeze
-
-      def initialize(origin:, original_exception:)
-        message = format(MESSAGE_TEMPLATE,
-                         origin,
-                         original_exception.class.name,
-                         original_exception.message)
-        super message
-      end
-    end
-  end
-end