reek 4.8.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 03a8001a3b22bcc9d88119e88b42854baec8a7e6
-  data.tar.gz: 51eeaee185f5d97ef76ba341a875aad0202c14ad
+SHA256:
+  metadata.gz: 2d66c9a36e561c26a8a5cd27af9780ded54de1fdfe9b00b289701027403330b3
+  data.tar.gz: 592050ff0e9af5744467c2299cb085246059fbdc96358dbadbad68a0f2e36763
 SHA512:
-  metadata.gz: a8302cbf65eb954433fb21243998da37fdc1755a7a82f10a465f7205c9b697f8498b593584d3fbc857c6d8544bbd49441c42f62ea5049916ad2a02bdf7a6ef94
-  data.tar.gz: 3150c68090b560dbdd91e51dc520c63bc6d6367c3efa4772e64205969b22fb0cdf292ed297a3f09ef271f32b9594d9380bc817cc855021e003c641a561606143
+  metadata.gz: 431ee00e3a0021baa1c752d0a2393b84bdf873d7be702c428f57b1b538ff9dceb11957551674be4031ddd26d9ddb7aa9a01a00b84aa53cd1650f76f045243370
+  data.tar.gz: 58c93de891eec497652eda081101a7b77a93eee296c4824b379beb4982de4064c9488d67fa9dd9fe2cfe822f428be305befd65a80b77fe5ec3eb2a4d428a3b5a

data/.travis.yml

@@ -2,7 +2,9 @@ sudo: false
 dist: trusty
 cache: bundler
 language: ruby
-before_install: gem update --system
+before_install:
+  - gem update --system
+  - gem install bundler
 bundler_args: --without debugging
 script: bundle exec rake ci
 rvm:

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Change log
 
-## Unreleased
+## 4.8.1 (2018-04-12)
+
+* (mvz) Loosen dependency on rainbow
 
 ## 4.8.0 (2018-03-05)
 

data/Gemfile

@@ -12,11 +12,11 @@ group :development do
   gem 'factory_bot',   '~> 4.0'
   gem 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
-  gem 'simplecov',     '~> 0.15.0'
+  gem 'simplecov',     '~> 0.16.1'
   gem 'yard',          '~> 0.9.5'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.52.0'
+    gem 'rubocop',       '~> 0.53.0'
     gem 'rubocop-rspec', '~> 1.20'
   end
 

data/docs/Unused-Private-Method.md

@@ -84,7 +84,7 @@ end
 
 ```Ruby
   class BankController < ActionController::Base
-    before_filter :audit
+    before_action :audit
 
     private
     def audit

data/lib/reek/cli/command/todo_list_command.rb

@@ -14,12 +14,11 @@ module Reek
         FILE_NAME = '.todo.reek'.freeze
 
         def execute
-          smells = scan_for_smells
           if smells.empty?
             puts "\n'.todo.reek' not generated because "\
                     'there were no smells found!'
           else
-            File.write FILE_NAME, groups_for(smells).to_yaml
+            File.write FILE_NAME, groups.to_yaml
             puts "\n'.todo.reek' generated! You can now use "\
                     'this as a starting point for your configuration.'
           end
@@ -28,14 +27,13 @@ module Reek
 
         private
 
-        def scan_for_smells
-          sources.map do |source|
-            Examiner.new(source,
-                         filter_by_smells: smell_names)
+        def smells
+          @smells ||= sources.map do |source|
+            Examiner.new(source, filter_by_smells: smell_names)
           end.map(&:smells).flatten
         end
 
-        def groups_for(smells)
+        def groups
           @groups ||=
             begin
               todos = smells.group_by(&:smell_class).map do |smell_class, smells_for_class|

data/lib/reek/context_builder.rb

@@ -206,7 +206,7 @@ module Reek
     #
     #   def self.foo; end
     #
-    def process_self(_, _parent)
+    def process_self(_exp, _parent)
       current_context.record_use_of_self
     end
 
@@ -226,7 +226,7 @@ module Reek
     #
     # We record one reference to `self`.
     #
-    def process_zsuper(_, _parent)
+    def process_zsuper(_exp, _parent)
       current_context.record_use_of_self
     end
 

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

@@ -5,7 +5,7 @@ module Reek
     # loads the smell type metadata to present in Code Climate
     module CodeClimateConfiguration
       def self.load
-        config_file = File.expand_path('../code_climate_configuration.yml', __FILE__)
+        config_file = File.expand_path('code_climate_configuration.yml', __dir__)
         YAML.load_file config_file
       end
     end

data/lib/reek/smell_detectors/base_detector.rb

@@ -59,7 +59,7 @@ module Reek
       end
 
       def source_line
-        @line ||= expression.line
+        @source_line ||= expression.line
       end
 
       def exception?

data/lib/reek/source/source_code.rb

@@ -17,6 +17,21 @@ module Reek
     # A +Source+ object represents a chunk of Ruby source code.
     #
     class SourceCode
+      # Consume and store parser diagnostics
+      class DiagnosticsConsumer
+        def initialize
+          @diagnostics = []
+        end
+
+        def call(item)
+          @diagnostics << item
+        end
+
+        def result
+          @diagnostics
+        end
+      end
+
       IO_IDENTIFIER     = 'STDIN'.freeze
       STRING_IDENTIFIER = 'string'.freeze
 
@@ -26,11 +41,11 @@ 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: default_parser)
+      # parser - the parser to use for generating AST's out of the given code
+      def initialize(code:, origin:, parser: self.class.default_parser)
         @origin = origin
-        @diagnostics = []
         @parser = parser
+        code.force_encoding(Encoding::UTF_8)
         @code = code
       end
 
@@ -54,23 +69,32 @@ module Reek
       end
 
       def diagnostics
-        parse_if_needed
-        @diagnostics
+        parse_result.last
       end
 
       def syntax_tree
-        parse_if_needed
+        parse_result.first
+      end
+
+      def self.default_parser
+        Parser::Ruby25.new(AST::Builder.new).tap do |parser|
+          diagnostics = parser.diagnostics
+          diagnostics.all_errors_are_fatal = false
+          diagnostics.ignore_warnings      = false
+          diagnostics.consumer = DiagnosticsConsumer.new
+        end
       end
 
       private
 
-      def parse_if_needed
-        @syntax_tree ||= parse(@parser, @code)
+      def parse_result
+        @parse_result ||= parse
       end
 
-      attr_reader :source
+      attr_reader :code
+      attr_reader :parser
 
-      # Parses the given source into an AST and associates the source code comments with it.
+      # Parses the given code 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
@@ -78,7 +102,7 @@ module Reek
       # 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:
+      # Given this @code:
       #
       #   # comment about C
       #   class C
@@ -99,33 +123,16 @@ module Reek
       # where each node is possibly adorned with our SexpExtensions (see ast/ast_node_class_map
       # and ast/sexp_extensions for details).
       #
-      # @param parser [Parser::Ruby25]
-      # @param source [String] - Ruby code
-      # @return [Anonymous subclass of Reek::AST::Node] the AST presentation
-      #         for the given source
-      # :reek:TooManyStatements { max_statements: 6 }
-      def parse(parser, source)
+      # @return [Anonymous subclass of Reek::AST::Node, Array] the AST presentation
+      #         for the given code, List of diagnostics messages
+      def parse
         buffer = Parser::Source::Buffer.new(origin, 1)
-        source.force_encoding(Encoding::UTF_8)
-        buffer.source = source
+        buffer.source = code
         ast, comments = parser.parse_with_comments(buffer)
 
         # See https://whitequark.github.io/parser/Parser/Source/Comment/Associator.html
         comment_map = Parser::Source::Comment.associate(ast, comments)
-        TreeDresser.new.dress(ast, comment_map)
-      end
-
-      # :reek:TooManyStatements: { max_statements: 6 }
-      # :reek:FeatureEnvy
-      def default_parser
-        Parser::Ruby25.new(AST::Builder.new).tap do |parser|
-          diagnostics = parser.diagnostics
-          diagnostics.all_errors_are_fatal = false
-          diagnostics.ignore_warnings      = false
-          diagnostics.consumer = lambda do |diagnostic|
-            @diagnostics << diagnostic
-          end
-        end
+        [TreeDresser.new.dress(ast, comment_map), parser.diagnostics.consumer.result]
       end
     end
   end

data/lib/reek/version.rb

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

data/reek.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'codeclimate-engine-rb', '~> 0.4.0'
   s.add_runtime_dependency 'parser',                '< 2.6', '>= 2.5.0.0'
-  s.add_runtime_dependency 'rainbow',               '~> 3.0'
+  s.add_runtime_dependency 'rainbow',               '>= 2.0', '< 4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.8.1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -51,16 +51,22 @@ dependencies:
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 description: Reek is a tool that examines Ruby classes, modules and methods and reports
   any code smells it finds.
 email:
@@ -447,7 +453,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Code smell detector for Ruby