reek 6.0.1 → 6.0.5

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

@@ -59,7 +59,7 @@ BooleanParameter:
 
     ## Getting rid of the smell
 
-    This is highly dependant on your exact architecture, but looking at the example above what you could do is:
+    This is highly dependent on your exact architecture, but looking at the example above what you could do is:
 
     * Move everything in the `if` branch into a separate method
     * Move everything in the `else` branch into a separate method

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_detectors/boolean_parameter.rb

@@ -14,6 +14,8 @@ module Reek
     #
     # See {file:docs/Boolean-Parameter.md} for details.
     class BooleanParameter < BaseDetector
+      BOOLEAN_VALUES = [:true, :false].freeze
+
       #
       # Checks whether the given method has any Boolean parameters.
       #
@@ -21,7 +23,7 @@ module Reek
       #
       def sniff
         context.default_assignments.select do |_parameter, value|
-          [:true, :false].include?(value.type)
+          BOOLEAN_VALUES.include?(value.type)
         end.map do |parameter, _value|
           smell_warning(
             lines: [source_line],

data/lib/reek/smell_detectors/uncommunicative_variable_name.rb

@@ -74,7 +74,7 @@ module Reek
       end
 
       def uncommunicative_variable_name?(name)
-        sanitized_name = name.to_s.gsub(/^[@\*\&]*/, '')
+        sanitized_name = name.to_s.gsub(/^[@*&]*/, '')
         !acceptable_name?(sanitized_name)
       end
 

data/lib/reek/smell_warning.rb

@@ -31,8 +31,7 @@ module Reek
     #   public API.
     #
     # @quality :reek:LongParameterList { max_params: 6 }
-    def initialize(smell_type, context: '', lines:, message:,
-                   source:, parameters: {})
+    def initialize(smell_type, lines:, message:, source:, context: '', parameters: {})
       @smell_type = smell_type
       @source     = source
       @context    = context.to_s
@@ -60,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

@@ -33,23 +33,26 @@ module Reek
 
       attr_reader :configuration, :paths, :options
 
-      # @quality :reek:TooManyStatements { max_statements: 7 }
-      # @quality :reek:NestedIterators { max_allowed_nesting: 2 }
       def source_paths
         paths.each_with_object([]) do |given_path, relevant_paths|
-          unless given_path.exist?
+          if given_path.exist?
+            relevant_paths.concat source_files_from_path(given_path)
+          else
             print_no_such_file_error(given_path)
-            next
           end
+        end
+      end
 
-          given_path.find do |path|
-            if path.directory?
-              ignore_path?(path) ? Find.prune : next
-            elsif ruby_file?(path)
-              relevant_paths << path unless ignore_file?(path)
-            end
+      def source_files_from_path(given_path)
+        relevant_paths = []
+        given_path.find do |path|
+          if path.directory?
+            Find.prune if ignore_path?(path)
+          elsif ruby_file?(path)
+            relevant_paths << path unless ignore_file?(path)
           end
         end
+        relevant_paths
       end
 
       def ignore_file?(path)
@@ -59,10 +62,8 @@ module Reek
 
             false
           end
-        elsif path_excluded?(path)
-          true
         else
-          false
+          path_excluded?(path)
         end
       end
 

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '6.0.1'
+    STRING = '6.0.5'
   end
 end

data/reek.gemspec

@@ -12,15 +12,26 @@ 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/)
   s.required_ruby_version = '>= 2.4.0'
   s.summary = 'Code smell detector for Ruby'
 
+  s.metadata = {
+    'homepage_uri'      => 'https://github.com/troessner/reek',
+    'source_code_uri'   => 'https://github.com/troessner/reek',
+    'bug_tracker_uri'   => 'https://github.com/troessner/reek/issues',
+    'changelog_uri'     => 'https://github.com/troessner/reek/CHANGELOG.md',
+    'documentation_uri' => 'https://www.rubydoc.info/gems/reek'
+  }
+
   s.add_runtime_dependency 'kwalify', '~> 0.7.0'
-  s.add_runtime_dependency 'parser',  '< 2.8', '>= 2.5.0.0', '!= 2.5.1.1'
-  s.add_runtime_dependency 'psych',   '~> 3.1.0'
+  s.add_runtime_dependency 'parser',  '~> 3.0.0'
+  s.add_runtime_dependency 'psych',   '>= 3.1', '< 5.0'
   s.add_runtime_dependency 'rainbow', '>= 2.0', '< 4.0'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 6.0.1
+  version: 6.0.5
 platform: ruby
 authors:
 - Kevin Rutherford
 - Timo Roessner
 - Matijs van Zuijlen
 - Piotr Szotkowski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-26 00:00:00.000000000 Z
+date: 2021-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kwalify
@@ -31,42 +31,36 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.5.1.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0.0
-    - - "!="
-      - !ruby/object:Gem::Version
-        version: 2.5.1.1
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -100,12 +94,13 @@ extra_rdoc_files:
 - License.txt
 files:
 - ".dockerignore"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".simplecov"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -116,92 +111,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
@@ -251,6 +161,7 @@ files:
 - lib/reek/context/ghost_context.rb
 - lib/reek/context/method_context.rb
 - lib/reek/context/module_context.rb
+- lib/reek/context/refinement_context.rb
 - lib/reek/context/root_context.rb
 - lib/reek/context/send_context.rb
 - lib/reek/context/singleton_attribute_context.rb
@@ -343,130 +254,16 @@ 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
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/troessner/reek
+  source_code_uri: https://github.com/troessner/reek
+  bug_tracker_uri: https://github.com/troessner/reek/issues
+  changelog_uri: https://github.com/troessner/reek/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/reek
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -485,8 +282,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []