reek 4.6.1 → 4.6.2

data/lib/reek/smell_detectors/utility_function.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../ast/reference_collector'
 require_relative 'base_detector'
 

data/lib/reek/smell_warning.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'forwardable'
 
 module Reek

data/lib/reek/source/source_code.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 require_relative '../cli/silencer'
 Reek::CLI::Silencer.silently do
-  require 'parser/ruby23'
+  require 'parser/ruby24'
 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
@@ -26,7 +28,7 @@ module Reek
       # code   - Ruby code as String
       # 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: Parser::Ruby23)
+      def initialize(code:, origin:, parser: default_parser)
         @source = code
         @origin = origin
         @parser = parser
@@ -82,11 +84,14 @@ module Reek
       #
       #  @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(source, origin)
+              ast, comments = parser.parse_with_comments(buffer)
             rescue Racc::ParseError, Parser::SyntaxError => error
               raise Errors::ParseError, origin: origin, original_exception: error
             end
@@ -100,6 +105,15 @@ module Reek
       private
 
       attr_reader :parser, :source
+
+      # :reek:UtilityFunction
+      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
+        end
+      end
     end
   end
 end

data/lib/reek/source/source_locator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'find'
 require 'pathname'
 

data/lib/reek/spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'spec/should_reek'
 require_relative 'spec/should_reek_of'
 require_relative 'spec/should_reek_only_of'

data/lib/reek/spec/should_reek.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../examiner'
 require_relative '../report/formatter'
 

data/lib/reek/spec/should_reek_of.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../examiner'
 require_relative 'smell_matcher'
 

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../examiner'
 require_relative '../report/formatter'
 require_relative 'should_reek_of'

data/lib/reek/spec/smell_matcher.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Reek
   module Spec
     #
@@ -7,7 +8,7 @@ module Reek
     class SmellMatcher
       attr_reader :smell_warning
 
-      COMPARABLE_ATTRIBUTES = %i(message lines context source).freeze
+      COMPARABLE_ATTRIBUTES = [:message, :lines, :context, :source].freeze
 
       def initialize(smell_warning)
         @smell_warning = smell_warning

data/lib/reek/tree_dresser.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative 'ast/ast_node_class_map'
 
 module Reek

data/lib/reek/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # @public
 module Reek
   #
@@ -7,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.6.1'.freeze
+    STRING = '4.6.2'.freeze
   end
 end

data/reek.gemspec

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 -*-
+
 require File.join(File.dirname(__FILE__), 'lib/reek/version')
 
 Gem::Specification.new do |s|
@@ -22,6 +23,6 @@ Gem::Specification.new do |s|
   s.summary = 'Code smell detector for Ruby'
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
-  s.add_runtime_dependency 'parser',                '< 2.5', '>= 2.3.1.2'
+  s.add_runtime_dependency 'parser',                '< 2.5', '>= 2.4.0.0'
   s.add_runtime_dependency 'rainbow',               '~> 2.0'
 end

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -253,6 +253,7 @@ end
 
 RSpec.describe Reek::AST::SexpExtensions::LvarNode do
   let(:node) { sexp(:lvar, :foo) }
+
   describe '#var_name' do
     it 'returns the lvar’s name' do
       expect(node.var_name).to eq(:foo)

data/spec/reek/context/statement_counter_spec.rb

@@ -3,6 +3,7 @@ require_lib 'reek/context/statement_counter'
 
 RSpec.describe Reek::Context::StatementCounter do
   let(:counter) { described_class.new }
+
   describe '#increase_by' do
     it 'does not increase if passed a falsy value' do
       counter.increase_by(nil)

data/spec/reek/examiner_spec.rb

@@ -145,6 +145,7 @@ RSpec.describe Reek::Examiner do
 
   describe 'bad comment config' do
     let(:examiner) { described_class.new(source) }
+
     context 'unknown smell detector' do
       let(:source) do
         <<-EOS

data/spec/reek/report/code_climate/code_climate_fingerprint_spec.rb

@@ -23,11 +23,13 @@ RSpec.describe Reek::Report::CodeClimateFingerprint do
 
     context 'with code at a specific location' do
       let(:lines) { [1] }
+
       it_behaves_like 'computes a fingerprint with no parameters'
     end
 
     context 'with code at a different location' do
       let(:lines) { [5] }
+
       it_behaves_like 'computes a fingerprint with no parameters'
     end
 

data/spec/reek/report/code_climate/code_climate_report_spec.rb

@@ -26,28 +26,28 @@ RSpec.describe Reek::Report::CodeClimateReport do
     let(:source) { 'def simple(a) a[3] end' }
 
     it 'prints smells as json' do
-      expected = <<-EOS.delete("\n")
-{\"type\":\"issue\",
-\"check_name\":\"UncommunicativeParameterName\",
-\"description\":\"simple has the parameter name 'a'\",
-\"categories\":[\"Complexity\"],
-\"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
-\"remediation_points\":150000,
-\"content\":{\"body\":\"An `Uncommunicative Parameter Name` is a parameter name that
- doesn't communicate its intent well enough.\\n\\nPoor names make it hard for the reader
- to build a mental picture of what's going on in the code. They can also be
- mis-interpreted; and they hurt the flow of reading, because the reader must slow down
- to interpret the names.\\n\"},
-\"fingerprint\":\"09970037d92b5a628bf682a3e2bb126d\"}\u0000
-{\"type\":\"issue\",
-\"check_name\":\"UtilityFunction\",
-\"description\":\"simple doesn't depend on instance state (maybe move it to another class?)\",
-\"categories\":[\"Complexity\"],
-\"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
-\"remediation_points\":250000,
-\"content\":{\"body\":\"A _Utility Function_ is any instance method that has no
- dependency on the state of the instance.\\n\"},
-\"fingerprint\":\"db456db7cb344bb5a98b8fc54a2f382e\"}\u0000
+      expected = <<-EOS.strip_heredoc.delete("\n")
+        {\"type\":\"issue\",
+        \"check_name\":\"UncommunicativeParameterName\",
+        \"description\":\"simple has the parameter name 'a'\",
+        \"categories\":[\"Complexity\"],
+        \"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
+        \"remediation_points\":150000,
+        \"content\":{\"body\":\"An `Uncommunicative Parameter Name` is a parameter name that
+         doesn't communicate its intent well enough.\\n\\nPoor names make it hard for the reader
+         to build a mental picture of what's going on in the code. They can also be
+         mis-interpreted; and they hurt the flow of reading, because the reader must slow down
+         to interpret the names.\\n\"},
+        \"fingerprint\":\"09970037d92b5a628bf682a3e2bb126d\"}\u0000
+        {\"type\":\"issue\",
+        \"check_name\":\"UtilityFunction\",
+        \"description\":\"simple doesn't depend on instance state (maybe move it to another class?)\",
+        \"categories\":[\"Complexity\"],
+        \"location\":{\"path\":\"string\",\"lines\":{\"begin\":1,\"end\":1}},
+        \"remediation_points\":250000,
+        \"content\":{\"body\":\"A _Utility Function_ is any instance method that has no
+         dependency on the state of the instance.\\n\"},
+        \"fingerprint\":\"db456db7cb344bb5a98b8fc54a2f382e\"}\u0000
       EOS
 
       expect { instance.show }.to output(expected).to_stdout

data/spec/reek/report/yaml_report_spec.rb

@@ -31,21 +31,21 @@ RSpec.describe Reek::Report::YAMLReport do
       instance.show(out)
       out.rewind
       result = YAML.safe_load(out.read)
-      expected = YAML.safe_load <<-EOS
----
-- context:        "simple"
-  lines:
-  - 1
-  message:        "has the parameter name 'a'"
-  smell_type:     "UncommunicativeParameterName"
-  source:         "string"
-  name:           "a"
-- context:        "simple"
-  lines:
-  - 1
-  message:        "doesn't depend on instance state (maybe move it to another class?)"
-  smell_type:     "UtilityFunction"
-  source:         "string"
+      expected = YAML.safe_load <<-EOS.strip_heredoc
+        ---
+        - context:        "simple"
+          lines:
+          - 1
+          message:        "has the parameter name 'a'"
+          smell_type:     "UncommunicativeParameterName"
+          source:         "string"
+          name:           "a"
+        - context:        "simple"
+          lines:
+          - 1
+          message:        "doesn't depend on instance state (maybe move it to another class?)"
+          smell_type:     "UtilityFunction"
+          source:         "string"
       EOS
 
       expect(result).to eq expected
@@ -58,23 +58,23 @@ RSpec.describe Reek::Report::YAMLReport do
         instance.show(out)
         out.rewind
         result = YAML.safe_load(out.read)
-        expected = YAML.safe_load <<-EOS
----
-- context:        "simple"
-  lines:
-  - 1
-  message:        "has the parameter name 'a'"
-  smell_type:     "UncommunicativeParameterName"
-  source:         "string"
-  name:           "a"
-  wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
-- context:        "simple"
-  lines:
-  - 1
-  message:        "doesn't depend on instance state (maybe move it to another class?)"
-  smell_type:     "UtilityFunction"
-  source:         "string"
-  wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
+        expected = YAML.safe_load <<-EOS.strip_heredoc
+          ---
+          - context:        "simple"
+            lines:
+            - 1
+            message:        "has the parameter name 'a'"
+            smell_type:     "UncommunicativeParameterName"
+            source:         "string"
+            name:           "a"
+            wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
+          - context:        "simple"
+            lines:
+            - 1
+            message:        "doesn't depend on instance state (maybe move it to another class?)"
+            smell_type:     "UtilityFunction"
+            source:         "string"
+            wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
         EOS
 
         expect(result).to eq expected

data/spec/reek/source/source_code_spec.rb

@@ -23,12 +23,19 @@ RSpec.describe Reek::Source::SourceCode do
       result = source_code.syntax_tree
       expect(result).to be_nil
     end
+
+    it 'does not crash with sequences incompatible with UTF-8' do
+      source = '"\xFF"'
+      source_code = described_class.new(code: source, origin: '(string)')
+      result = source_code.syntax_tree
+      expect(result.children.first).to eq "\xFF"
+    end
   end
 
   context 'when the parser fails' do
     let(:source_name) { 'Test source' }
     let(:error_message) { 'Error message' }
-    let(:parser) { class_double(Parser::Ruby23) }
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.6.2
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -36,7 +36,7 @@ dependencies:
         version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1.2
+        version: 2.4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -46,7 +46,7 @@ dependencies:
         version: '2.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1.2
+        version: 2.4.0.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +173,7 @@ files:
 - features/todo_list.feature
 - lib/reek.rb
 - lib/reek/ast/ast_node_class_map.rb
+- lib/reek/ast/builder.rb
 - lib/reek/ast/node.rb
 - lib/reek/ast/object_refs.rb
 - lib/reek/ast/reference_collector.rb