reek 6.0.3 → 6.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 967e95555fe823e1924a78ff2a8c94c40bdb4d16d031bacd51b885d1475bce30
-  data.tar.gz: c9760389b64b3bb9f96f1896192a540a4de8b7f395808299b9a67e47238e8c42
+  metadata.gz: f6445aae6ec59ea428c09872ffcf768e6b1df34f7c3860d2537ace1465c3f588
+  data.tar.gz: 81768ea8825add3341a059deba602ce5fd9d58093c4b53b37ede59c2256124b2
 SHA512:
-  metadata.gz: ea4c588166903c10bed44c2a459e43e4db479943f8f489ca1eaefbb6db375605e06ff678f5411def292e19ef8c2754245bca78eb24373532474091b0ab8eadbe
-  data.tar.gz: 9e0804841d54d4278149422d66c7e379597e3f99275ba8b9ab4aef6e7041bde6c928db5f3c62a3b5c3d1d6fc4da0216ba5d13aa5562f9e0b565ec31bb115d0fe
+  metadata.gz: b27f1243970e103ea742582ae4f0ae517613b0a7465ff953818a069f1c5354626aa1dc2d72d42ad97d47ee930c294ddde5f6987e337f6314fd4f7c8598f75557
+  data.tar.gz: 2a036cd4900a2cc47aaef1fb3aec83c4793c4da44bdcffc6fe12134094fdfe5ede6dfe4509f251051d6703f52a37da0b7bf8e7b17cd6a3c2af616727d87a402f

data/CHANGELOG.md

@@ -1,11 +1,26 @@
 # Change log
 
+## 6.0.6 (2021-08-12)
+
+* (mvz) Remove explicit dependency on psych. This fixes an issue where
+  installing Reek would unintentionally pull in psych 4.0
+
+## 6.0.5 (2021-08-01)
+
+* (dependabot) Loosen dependency on psych
+* (Nicolás Ferrari) Fix bugs when used by codeclimate 
+
+## 6.0.4 (2021-04-27)
+
+* (Nicolás Ferrari) Add build-base to Dockerfile
+* (Masataka Pocke Kuwabara and Daniel Santos Dantas) Reduce gem package size
+
 ## 6.0.3 (2021-01-11)
 
 * (mvz) Require parser 3.0
 * (mvz) In a refinement, assign smells to the refined module or class
 
-## 6.0.3 (2020-10-17)
+## 6.0.2 (2020-10-17)
 
 * (mvz) Loosen dependency on psych. This should resolve installation problems on
   mingw32

data/CONTRIBUTING.md

@@ -27,6 +27,9 @@ version, Ruby platform (MRI, JRuby, etc.), operating system.
 Try to provide a minimal example that reproduces the issue.
 Extra kudos if you can write it as a failing test. :)
 
+Make sure any code examples and output are properly formatted
+using [code blocks](https://github.github.com/gfm/#fenced-code-blocks).
+
 ## Contributing features, bugfixes, documentation
 
 ### Getting started

data/Dockerfile

@@ -11,7 +11,7 @@ ENV code_dir /code
 ENV app_dir /usr/src/app
 ENV user app
 
-RUN apk --update add git
+RUN apk --update add git build-base
 ADD . ${app_dir}
 
 RUN adduser -u 9000 -D ${user}

data/Gemfile

@@ -7,16 +7,16 @@ ruby RUBY_VERSION
 group :development do
   gem 'aruba',                 '~> 1.0'
   gem 'codeclimate-engine-rb', '~> 0.4.0'
-  gem 'cucumber',              ['>= 4.0', '< 6.0']
+  gem 'cucumber',              ['>= 4.0', '< 7.0']
   gem 'kramdown',              '~> 2.1'
   gem 'kramdown-parser-gfm',   '~> 1.0'
   gem 'rake',                  '~> 13.0'
   gem 'rspec',                 '~> 3.0'
   gem 'rspec-benchmark',       '~> 0.6.0'
-  gem 'rubocop',               '~> 1.7.0'
-  gem 'rubocop-performance',   '~> 1.9.1'
-  gem 'rubocop-rspec',         '~> 2.1.0'
-  gem 'simplecov',             ['>= 0.18.0', '< 0.21.0']
+  gem 'rubocop',               '~> 1.12.0'
+  gem 'rubocop-performance',   '~> 1.10.1'
+  gem 'rubocop-rspec',         '~> 2.2.0'
+  gem 'simplecov',             ['>= 0.18.0', '< 0.22.0']
   gem 'yard',                  '~> 0.9.5'
 
   platforms :mri do
@@ -25,5 +25,5 @@ group :development do
 end
 
 group :debugging do
-  gem 'pry', '~> 0.13.0'
+  gem 'pry', '~> 0.14.0'
 end

data/bin/code_climate_reek

@@ -14,15 +14,14 @@ class CodeClimateToReek
   # we have to exit with a zero for both failure and success.
   ENGINE_CONFIGURATION = [
     '--failure-exit-code', '0',
-    '--success-exit-code', '0',
-    '.'
+    '--success-exit-code', '0'
   ].freeze
 
   attr_reader :configuration_file_path, :include_paths_key, :include_paths_default
 
   def initialize(configuration_file_path: '/config.json',
                  include_paths_key: 'include_paths',
-                 include_paths_default: [])
+                 include_paths_default: ['.'])
     @configuration_file_path = configuration_file_path
     @include_paths_key       = include_paths_key
     @include_paths_default   = include_paths_default

data/lib/reek/ast/ast_node_class_map.rb

@@ -30,7 +30,7 @@ module Reek
                 SexpExtensions.const_get(const)
               ]
             end
-            Hash[assoc]
+            assoc.to_h
           end
       end
 

data/lib/reek/code_comment.rb

@@ -39,13 +39,13 @@ module Reek
 
       @original_comment.scan(CONFIGURATION_REGEX) do |detector_name, separator, options|
         escalate_legacy_separator separator
-        CodeCommentValidator.new(detector_name:    detector_name,
-                                 original_comment: original_comment,
-                                 line:             line,
-                                 source:           source,
-                                 options:          options).validate
-        @config.merge! detector_name => YAML.safe_load(options || DISABLE_DETECTOR_CONFIGURATION,
-                                                       permitted_classes: [Regexp])
+        validator = CodeCommentValidator.new(detector_name:    detector_name,
+                                             original_comment: original_comment,
+                                             line:             line,
+                                             source:           source,
+                                             options:          options)
+        validator.validate
+        @config.merge! detector_name => validator.parsed_options
       end
     end
 
@@ -115,6 +115,21 @@ module Reek
         escalate_unknown_configuration_key
       end
 
+      def parsed_options
+        @parsed_options ||=
+          if Psych::VERSION < '3.1.0'
+            YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION, [Regexp])
+          else
+            YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
+                           permitted_classes: [Regexp])
+          end
+      rescue Psych::SyntaxError
+        raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
+                                                                     original_comment: original_comment,
+                                                                     source: source,
+                                                                     line: line)
+      end
+
       private
 
       attr_reader :detector_name,
@@ -124,16 +139,6 @@ module Reek
                   :separator,
                   :options
 
-      def parsed_options
-        @parsed_options ||= YAML.safe_load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION,
-                                           permitted_classes: [Regexp])
-      rescue Psych::SyntaxError
-        raise Errors::GarbageDetectorConfigurationInCommentError.new(detector_name: detector_name,
-                                                                     original_comment: original_comment,
-                                                                     source: source,
-                                                                     line: line)
-      end
-
       def escalate_unknown_configuration_key
         return if given_keys_legit?
 

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

@@ -57,9 +57,7 @@ module Reek
       end
 
       def configuration
-        @configuration ||= begin
-          CodeClimateConfiguration.load
-        end
+        @configuration ||= CodeClimateConfiguration.load
       end
     end
   end

data/lib/reek/smell_detectors/base_detector.rb

@@ -90,7 +90,7 @@ module Reek
 
       class << self
         def smell_type
-          @smell_type ||= name.split(/::/).last
+          @smell_type ||= name.split('::').last
         end
 
         def contexts

data/lib/reek/smell_warning.rb

@@ -59,7 +59,7 @@ module Reek
 
     # @public
     def to_hash
-      stringified_params = Hash[parameters.map { |key, val| [key.to_s, val] }]
+      stringified_params = parameters.map { |key, val| [key.to_s, val] }.to_h
       base_hash.merge(stringified_params)
     end
 

data/lib/reek/source/source_locator.rb

@@ -62,10 +62,8 @@ module Reek
 
             false
           end
-        elsif path_excluded?(path)
-          true
         else
-          false
+          path_excluded?(path)
         end
       end
 

data/lib/reek/version.rb

@@ -3,11 +3,11 @@
 # @public
 module Reek
   #
-  # This module holds the Reek version informations
+  # This module holds the Reek version information
   #
   # @public
   module Version
     # @public
-    STRING = '6.0.3'
+    STRING = '6.0.6'
   end
 end

data/reek.gemspec

@@ -12,7 +12,10 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
   s.email = ['timo.roessner@googlemail.com']
   s.extra_rdoc_files = ['CHANGELOG.md', 'License.txt']
-  s.files = `git ls-files -z`.split("\0")
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|samples|docs|tasks)/}) }
+  end
+
   s.executables = s.files.grep(%r{^bin/}).map { |path| File.basename(path) }
   s.homepage = 'https://github.com/troessner/reek'
   s.rdoc_options = %w(--main README.md -x assets/|bin/|config/|features/|spec/|tasks/)
@@ -29,6 +32,5 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'kwalify', '~> 0.7.0'
   s.add_runtime_dependency 'parser',  '~> 3.0.0'
-  s.add_runtime_dependency 'psych',   '~> 3.1'
   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: 6.0.3
+  version: 6.0.6
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kwalify
@@ -41,20 +41,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: psych
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -105,92 +91,7 @@ files:
 - Rakefile
 - bin/code_climate_reek
 - bin/reek
-- docs/API.md
-- docs/Attribute.md
-- docs/Basic-Smell-Options.md
-- docs/Boolean-Parameter.md
-- docs/Class-Variable.md
-- docs/Code-Smells.md
-- docs/Command-Line-Options.md
-- docs/Control-Couple.md
-- docs/Control-Parameter.md
-- docs/Data-Clump.md
-- docs/Duplicate-Method-Call.md
-- docs/Feature-Envy.md
-- docs/How-To-Write-New-Detectors.md
-- docs/How-reek-works-internally.md
-- docs/Instance-Variable-Assumption.md
-- docs/Irresponsible-Module.md
-- docs/Large-Class.md
-- docs/Long-Parameter-List.md
-- docs/Long-Yield-List.md
-- docs/Manual-Dispatch.md
-- docs/Missing-Safe-Method.md
-- docs/Module-Initialize.md
-- docs/Nested-Iterators.md
-- docs/Nil-Check.md
-- docs/RSpec-matchers.md
-- docs/Rake-Task.md
-- docs/Reek-4-to-Reek-5-migration.md
-- docs/Reek-Driven-Development.md
-- docs/Repeated-Conditional.md
-- docs/Simulated-Polymorphism.md
-- docs/Smell-Suppression.md
-- docs/Style-Guide.md
-- docs/Subclassed-From-Core-Class.md
-- docs/Too-Many-Constants.md
-- docs/Too-Many-Instance-Variables.md
-- docs/Too-Many-Methods.md
-- docs/Too-Many-Statements.md
-- docs/Uncommunicative-Method-Name.md
-- docs/Uncommunicative-Module-Name.md
-- docs/Uncommunicative-Name.md
-- docs/Uncommunicative-Parameter-Name.md
-- docs/Uncommunicative-Variable-Name.md
-- docs/Unused-Parameters.md
-- docs/Unused-Private-Method.md
-- docs/Utility-Function.md
-- docs/Versioning-Policy.md
-- docs/YAML-Reports.md
-- docs/defaults.reek.yml
-- docs/templates/default/docstring/html/public_api_marker.erb
-- docs/templates/default/docstring/setup.rb
-- docs/templates/default/fulldoc/html/css/common.css
-- docs/yard_plugin.rb
 - engine.json
-- features/command_line_interface/basic_usage.feature
-- features/command_line_interface/options.feature
-- features/command_line_interface/show_progress.feature
-- features/command_line_interface/smell_selection.feature
-- features/command_line_interface/smells_count.feature
-- features/command_line_interface/stdin.feature
-- features/configuration_files/accept_setting.feature
-- features/configuration_files/directory_specific_directives.feature
-- features/configuration_files/exclude_directives.feature
-- features/configuration_files/exclude_paths_directives.feature
-- features/configuration_files/masking_smells.feature
-- features/configuration_files/mix_accept_reject_setting.feature
-- features/configuration_files/reject_setting.feature
-- features/configuration_files/schema_validation.feature
-- features/configuration_files/show_configuration_file.feature
-- features/configuration_files/unused_private_method.feature
-- features/configuration_loading.feature
-- features/configuration_via_source_comments/erroneous_source_comments.feature
-- features/configuration_via_source_comments/well_formed_source_comments.feature
-- features/locales.feature
-- features/programmatic_access.feature
-- features/rake_task/rake_task.feature
-- features/reports/codeclimate.feature
-- features/reports/json.feature
-- features/reports/reports.feature
-- features/reports/yaml.feature
-- features/rspec_matcher.feature
-- features/samples.feature
-- features/step_definitions/.rubocop.yml
-- features/step_definitions/reek_steps.rb
-- features/step_definitions/sample_file_steps.rb
-- features/support/env.rb
-- features/todo_list.feature
 - lib/reek.rb
 - lib/reek/ast/ast_node_class_map.rb
 - lib/reek/ast/builder.rb
@@ -333,125 +234,6 @@ files:
 - logo/reek.text.png
 - logo/reek.text.svg
 - reek.gemspec
-- samples/checkstyle.xml
-- samples/clean_source/clean.rb
-- samples/configuration/accepts_rejects_and_excludes_for_detectors.reek.yml
-- samples/configuration/accepts_rejects_and_excludes_for_directory_directives.reek.yml
-- samples/configuration/corrupt.reek
-- samples/configuration/empty.reek
-- samples/configuration/full_configuration.reek
-- samples/configuration/full_mask.reek
-- samples/configuration/home/home.reek.yml
-- samples/configuration/partial_mask.reek
-- samples/configuration/regular_configuration/.reek.yml
-- samples/configuration/regular_configuration/empty_sub_directory/.gitignore
-- samples/configuration/with_excluded_paths.reek
-- samples/no_config_file/.keep
-- samples/paths.rb
-- samples/smelly_source/inline.rb
-- samples/smelly_source/optparse.rb
-- samples/smelly_source/redcloth.rb
-- samples/smelly_source/ruby.rb
-- samples/smelly_source/smelly.rb
-- samples/source_with_exclude_paths/ignore_me/uncommunicative_method_name.rb
-- samples/source_with_exclude_paths/nested/ignore_me_as_well/irresponsible_module.rb
-- samples/source_with_exclude_paths/nested/uncommunicative_parameter_name.rb
-- samples/source_with_exclude_paths/nested/uncommunicative_variable_name.rb
-- samples/source_with_hidden_directories/.hidden/hidden.rb
-- samples/source_with_hidden_directories/not_hidden.rb
-- samples/source_with_non_ruby_files/gibberish
-- samples/source_with_non_ruby_files/python_source.py
-- samples/source_with_non_ruby_files/ruby.rb
-- spec/performance/reek/smell_detectors/runtime_speed_spec.rb
-- spec/quality/documentation_spec.rb
-- spec/quality/reek_source_spec.rb
-- spec/reek/ast/node_spec.rb
-- spec/reek/ast/object_refs_spec.rb
-- spec/reek/ast/reference_collector_spec.rb
-- spec/reek/ast/sexp_extensions_spec.rb
-- spec/reek/cli/application_spec.rb
-- spec/reek/cli/command/report_command_spec.rb
-- spec/reek/cli/command/todo_list_command_spec.rb
-- spec/reek/cli/options_spec.rb
-- spec/reek/cli/silencer_spec.rb
-- spec/reek/code_comment_spec.rb
-- spec/reek/configuration/app_configuration_spec.rb
-- spec/reek/configuration/configuration_file_finder_spec.rb
-- spec/reek/configuration/default_directive_spec.rb
-- spec/reek/configuration/directory_directives_spec.rb
-- spec/reek/configuration/excluded_paths_spec.rb
-- spec/reek/configuration/rake_task_converter_spec.rb
-- spec/reek/configuration/schema_validator_spec.rb
-- spec/reek/context/code_context_spec.rb
-- spec/reek/context/ghost_context_spec.rb
-- spec/reek/context/method_context_spec.rb
-- spec/reek/context/module_context_spec.rb
-- spec/reek/context/root_context_spec.rb
-- spec/reek/context/statement_counter_spec.rb
-- spec/reek/context_builder_spec.rb
-- spec/reek/detector_repository_spec.rb
-- spec/reek/documentation_link_spec.rb
-- spec/reek/errors/base_error_spec.rb
-- spec/reek/examiner_spec.rb
-- spec/reek/logging_error_handler_spec.rb
-- spec/reek/rake/task_spec.rb
-- spec/reek/report/code_climate/code_climate_configuration_spec.rb
-- spec/reek/report/code_climate/code_climate_fingerprint_spec.rb
-- spec/reek/report/code_climate/code_climate_formatter_spec.rb
-- spec/reek/report/code_climate/code_climate_report_spec.rb
-- spec/reek/report/html_report_spec.rb
-- spec/reek/report/json_report_spec.rb
-- spec/reek/report/location_formatter_spec.rb
-- spec/reek/report/progress_formatter_spec.rb
-- spec/reek/report/text_report_spec.rb
-- spec/reek/report/xml_report_spec.rb
-- spec/reek/report/yaml_report_spec.rb
-- spec/reek/report_spec.rb
-- spec/reek/smell_configuration_spec.rb
-- spec/reek/smell_detectors/attribute_spec.rb
-- spec/reek/smell_detectors/base_detector_spec.rb
-- spec/reek/smell_detectors/boolean_parameter_spec.rb
-- spec/reek/smell_detectors/class_variable_spec.rb
-- spec/reek/smell_detectors/control_parameter_spec.rb
-- spec/reek/smell_detectors/data_clump_spec.rb
-- spec/reek/smell_detectors/duplicate_method_call_spec.rb
-- spec/reek/smell_detectors/feature_envy_spec.rb
-- spec/reek/smell_detectors/instance_variable_assumption_spec.rb
-- spec/reek/smell_detectors/irresponsible_module_spec.rb
-- spec/reek/smell_detectors/long_parameter_list_spec.rb
-- spec/reek/smell_detectors/long_yield_list_spec.rb
-- spec/reek/smell_detectors/manual_dispatch_spec.rb
-- spec/reek/smell_detectors/missing_safe_method_spec.rb
-- spec/reek/smell_detectors/module_initialize_spec.rb
-- spec/reek/smell_detectors/nested_iterators_spec.rb
-- spec/reek/smell_detectors/nil_check_spec.rb
-- spec/reek/smell_detectors/repeated_conditional_spec.rb
-- spec/reek/smell_detectors/subclassed_from_core_class_spec.rb
-- spec/reek/smell_detectors/too_many_constants_spec.rb
-- spec/reek/smell_detectors/too_many_instance_variables_spec.rb
-- spec/reek/smell_detectors/too_many_methods_spec.rb
-- spec/reek/smell_detectors/too_many_statements_spec.rb
-- spec/reek/smell_detectors/uncommunicative_method_name_spec.rb
-- spec/reek/smell_detectors/uncommunicative_module_name_spec.rb
-- spec/reek/smell_detectors/uncommunicative_parameter_name_spec.rb
-- spec/reek/smell_detectors/uncommunicative_variable_name_spec.rb
-- spec/reek/smell_detectors/unused_parameters_spec.rb
-- spec/reek/smell_detectors/unused_private_method_spec.rb
-- spec/reek/smell_detectors/utility_function_spec.rb
-- spec/reek/smell_warning_spec.rb
-- spec/reek/source/source_code_spec.rb
-- spec/reek/source/source_locator_spec.rb
-- spec/reek/spec/should_reek_of_spec.rb
-- spec/reek/spec/should_reek_only_of_spec.rb
-- spec/reek/spec/should_reek_spec.rb
-- spec/reek/spec/smell_matcher_spec.rb
-- spec/reek/tree_dresser_spec.rb
-- spec/spec_helper.rb
-- tasks/configuration.rake
-- tasks/console.rake
-- tasks/reek.rake
-- tasks/rubocop.rake
-- tasks/test.rake
 homepage: https://github.com/troessner/reek
 licenses:
 - MIT
@@ -480,8 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.7
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby