reek 6.0.2 → 6.0.4

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.0.4
 platform: ruby
 authors:
 - Kevin Rutherford
 - Timo Roessner
 - Matijs van Zuijlen
 - Piotr Szotkowski
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2021-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kwalify
@@ -31,28 +31,16 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0.0
-    - - "!="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1.1
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.5.0.0
-    - - "!="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1.1
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -100,12 +88,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 +105,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 +155,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,125 +248,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
@@ -471,7 +257,7 @@ metadata:
   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: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -490,8 +276,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Code smell detector for Ruby
 test_files: []

data/.travis.yml

@@ -1,40 +0,0 @@
-language: ruby
-
-dist: xenial
-
-cache:
-  bundler: true
-
-bundler_args: --without debugging
-
-script: bundle exec rake ci
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - jruby-9.2
-  - jruby-head
-  - ruby-head
-
-matrix:
-  allow_failures:
-    - rvm: jruby-head
-    - rvm: ruby-head
-  fast_finish: true
-
-notifications:
-  email:
-    - timo.roessner@googlemail.com
-    - matijs@matijs.net
-    - chastell@chastell.net
-  irc: irc.freenode.org#reek
-
-branches:
-  only:
-    - master
-
-env:
-  global:
-    - JRUBY_OPTS="--dev"

data/docs/API.md

@@ -1,174 +0,0 @@
-# Using Reek inside your Ruby application
-
-## Installation
-
-Either standalone via
-
-```bash
-gem install reek
-```
-
-or by adding
-
-```
-gem 'reek'
-```
-
-to your Gemfile.
-
-## Quick start
-
-Code says more than a thousand words:
-
-```ruby
-require 'reek'
-
-source = <<-RUBY
-  class Dirty
-    def m(a,b,c)
-      puts a,b
-    end
-  end
-RUBY
-
-reporter = Reek::Report::TextReport.new
-examiner = Reek::Examiner.new source
-reporter.add_examiner examiner
-reporter.show
-```
-
-This would output the following on STDOUT:
-
-```
-string -- 5 warnings:
-  Dirty has no descriptive comment (IrresponsibleModule)
-  Dirty#m has the name 'm' (UncommunicativeMethodName)
-  Dirty#m has the parameter name 'a' (UncommunicativeParameterName)
-  Dirty#m has the parameter name 'b' (UncommunicativeParameterName)
-  Dirty#m has unused parameter 'c' (UnusedParameters)
-```
-
-Note that `Reek::Examiner.new` can take `source` as `String`, `Pathname`, `File` or `IO`.
-
-## API stability
-
-Everything that is mentioned in this document can be considered stable in the
-sense that it will only change across major versions.
-
-There is one thing in this API documentation you can't and shouldn't rely on:
-The `SmellWarning` messages itself.
-
-Something like this
-
-```
-Dirty#m has the parameter name 'a' (UncommunicativeParameterName)
-```
-
-might change even across minor versions.
-
-You should not need to be specific about those messages anyways.
-In case you'd like to be specific about `SmellWarnings` please have a look at
-[accessing the smell warnings directly](#accessing-the-smell-warnings-directly).
-
-Additionally you can use one of our structured [outputs formats](#choosing-your-output-format)
-like JSON or YAML if you need a more fine-grained access to our
-`SmellWarnings`.
-
-## Choosing your output format
-
-Besides normal text output, Reek can generate output in YAML,
-JSON, HTML and XML by using the following Report types:
-
-```
-TextReport
-YAMLReport
-JSONReport
-HTMLReport
-XMLReport
-```
-
-## Configuration
-
-Given you have the following configuration file called `.reek.yml` in your root directory:
-
-```Yaml
----
-IrresponsibleModule:
-  enabled: false
-```
-
-Reek will load this file automatically by default. If you want to load the
-configuration explicitely, you can use one of the methods below.
-
-You can now use either
-
-```Ruby
-Reek::Configuration::AppConfiguration.from_path Pathname.new('config.reek')
-```
-
-but you can also pass a hash with the contents of the `.reek.yml` YAML file
-to `Reek::Configuration::AppConfiguration.from_hash`.
-
-Given the example above you would load that as follows:
-
-```Ruby
-require 'reek'
-
-config_hash = { 'IrresponsibleModule' => { 'enabled' => false } }
-configuration = Reek::Configuration::AppConfiguration.from_hash config_hash
-
-source = <<-RUBY
-  class Dirty
-    def call_me(a,b)
-      puts a,b
-    end
-  end
-RUBY
-
-reporter = Reek::Report::TextReport.new
-examiner = Reek::Examiner.new(source, configuration: configuration); nil
-reporter.add_examiner examiner; nil
-reporter.show
-```
-
-This would now only report `UncommunicativeParameterName` but not
-`IrresponsibleModule` for the `Dirty` class:
-
-```
-string -- 2 warnings:
-  Dirty#call_me has the parameter name 'a' (UncommunicativeParameterName)
-  Dirty#call_me has the parameter name 'b' (UncommunicativeParameterName)
-```
-
-Of course, directory specific configuration and excluded paths are supported as
-well:
-
-```
-config_hash = {
-  'IrresponsibleModule' => { 'enabled' => false }
-  'spec/samples/three_clean_files/' =>
-    { 'UtilityFunction' => { "enabled" => false } }
-  'exclude_paths' =>
-    [ 'spec/samples/two_smelly_files' ]
-}
-```
-
-## Accessing the smell warnings directly
-
-You can also access the smells detected by an examiner directly:
-
-```ruby
-require 'reek'
-
-source = <<-END
-  class C
-  end
-END
-
-examiner = Reek::Examiner.new source
-examiner.smells.each do |smell|
-  puts smell.message
-end
-```
-
-`Examiner#smells` returns a list of `SmellWarning` objects.

data/docs/Attribute.md

@@ -1,39 +0,0 @@
-# Attribute
-
-## Introduction
-
-A class that publishes a setter for an instance variable invites
-client classes to become too intimate with its inner workings, and in
-particular with its representation of state.
-
-The same holds to a lesser extent for getters, but Reek doesn't flag those.
-
-## Example
-
-Given:
-
-```Ruby
-class Klass
-  attr_accessor :dummy
-end
-```
-
-Reek would emit the following warning:
-
-```
-reek test.rb
-
-test.rb -- 1 warning:
-  [2]:Attribute: Klass#dummy is a writable attribute
-```
-
-## Support in Reek
-
-This detector raises a warning for every public `attr_writer`,
-`attr_accessor`, and `attr` with the writable flag set to `true`.
-
-Reek does not raise warnings for read-only attributes.
-
-## Configuration
-
-_Attribute_ supports only the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Basic-Smell-Options.md

@@ -1,85 +0,0 @@
-# Basic Smell Options
-
-## Introduction
-
-Every smell detector in Reek offers at least the following configuration options:
-
-| Option         | Value       | Effect  |
-| ---------------|-------------|---------|
-| `enabled` |  Boolean | Determines whether the smell detector is active. Defaults to `true` |
-| `exclude` | an array of strings that will be converted into regular expressions | Ignores any context whose full description matches any element of this array. |
-
-The file `docs/defaults.reek.yml` (shipped with the Reek gem) lists any default
-exclusions for each smell.
-
-## Examples
-
-**An easy one:**
-
-To stop Reek reporting smells in any method called `write` you might create a configuration file containing this:
-
-```yaml
-DuplicateMethodCall:
-  exclude:
-  - write
-```
-
-Internally Reek will convert this to the Regexp /write/.
-
-**A more sophisticated one:**
-
-```yaml
-FeatureEnvy:
-  exclude:
-    - "MyModel#do_things"
-    - "MyHelper"
-    - "ApplicationController#respond"
-```
-
-This would not report FeatureEnvy for the instance method `MyModel#do_things`, the whole module `MyHelper` and the `respond` instance method of `ApplicationController`
-
-## Advanced configuration
-
-Sometimes just strings are not enough for configuration. E.g. consider this code sample:
-
-```Ruby
-class Klass
-  def foo1; end
-  def foo1bar; end
-end
-```
-Both "Klass#foo1" and "Klass#foo1bar" will smell of UncommunicativeMethodName. Now let's assume
-you are ok with "Klass#foo1" but not "Klass#foo1bar".
-Just having this configuration 
-
-```yaml
-UncommunicativeMethodName:
-  exclude:
-    - "Klass#foo1"
-```
-
-wouldn't work because now "Klass#foo1bar" wouldn't smell as well.
-
-For this reason Reek has a special syntax that allows you to use regexes by using a forward slash at the beginning and the end of the string.
-Everything within the forward slashes will be loaded as a regex.
-
-A possible configuration that hat excludes "Klass#foo1" from this scan but not "Klass#foo1bar" could look like this:
-
-```yaml
-UncommunicativeMethodName:
-  exclude:
-    - "/Klass#foo1$/"
-```
-
-## Reek 4
-
-In Reek 4 you could also pass regexes to `exclude`, meaning this was perfectly valid as well:
-
-```yaml
-DuplicateMethodCall:
-  exclude:
-    - !ruby/regexp /write/
-```
-
-Support for this has been scrapped with Reek 5 to make the Reek configuration more yaml standard compliant.
-You can still pass in regexes, you just have to wrap them into a string. Please see "Advanced configuration" above.