reek 6.0.2 → 6.1.4

data/docs/Unused-Private-Method.md

@@ -1,101 +0,0 @@
-## Introduction
-
-Classes should use their private methods. Otherwise this is dead
-code which is confusing and bad for maintenance.
-
-The _Unused Private Method_ detector reports unused private instance
-methods and instance methods only - class methods are ignored.
-
-## Example
-
-Given:
-
-```Ruby
-class Car
-  private
-  def drive; end
-  def start; end
-end
-```
-
-Reek would emit the following warning:
-
-```
-2 warnings:
-  [3]:Car has the unused private instance method `drive` (UnusedPrivateMethod)
-  [4]:Car has the unused private instance method `start` (UnusedPrivateMethod)
-```
-
-## Configuration
-
-_Unused Private Method_ offers the [Basic Smell Options](Basic-Smell-Options.md).
-
-Private methods that are called via dynamic dispatch
-will trigger a false alarm since detecting something like this is far out of
-scope for Reek. In this case you can disable this detector via the `exclude`
-configuration option (which is part of the [Basic Smell Options](Basic-Smell-Options.md))
-for instance like this (an example from Reek's own codebase):
-
-```Ruby
-# :reek:UnusedPrivateMethod { exclude: [ process_ ] }
-class ContextBuilder
-  def process_begin
-    # ....
-  end
-end
-```
-
-Note that disabling this detector via comment works on a class scope, not
-a method scope (like you can see above).
-
-Another simple example would be:
-
-```Ruby
-class Alfa
-  private
-  def bravo
-  end
-end
-```
-
-This would report:
-
->>
-ruby.rb -- 1 warning:
-  [3]:UnusedPrivateMethod: Alfa has the unused private instance method 'bravo'
-
-If you want to suppress this warning you can do this via source comment like this:
-
-```Ruby
-# :reek:UnusedPrivateMethod: { exclude: bravo }
-class Alfa
-  private
-  def bravo
-  end
-end
-```
-
-## Known limitations
-
-* Method calls via dynamic dispatch (e.g. via `send`) is something Reek (or any other
-  static tool for that matter) cannot detect.
-* Method calls via callback like [Rails filters](http://guides.rubyonrails.org/action_controller_overview.html#filters)
-  will trigger this as well, e.g.:
-
-```Ruby
-  class BankController < ActionController::Base
-    before_action :audit
-
-    private
-    def audit
-      # ....
-    end
-  end
-```
-* Reek works on a per-file base. This means that using something like the [template pattern](https://en.wikipedia.org/wiki/Template_method_pattern)
-  with private methods will trigger this detector.
-  We do believe though that using private methods to fill out a template in a
-  superclass is not a good idea in general so this probably isn't really a problem
-  but still worth mentioning it.
-
-

data/docs/Utility-Function.md

@@ -1,56 +0,0 @@
-# Utility Function
-
-## Introduction
-
-A _Utility Function_ is any instance method that has no dependency on the state of the instance.
-
-_Utility Function_ is heavily related to _[Feature Envy](Feature-Envy.md)_, please check out the explanation there why _Utility Function_ is something you should care about.
-
-## Example
-
-Given
-
-```Ruby
-class UtilityFunction
-  def showcase(argument)
-    argument.to_s + argument.to_i
-  end
-end
-```
-
-Reek would report:
-
-```
-test.rb -- 2 warnings:
-  [2]:UtilityFunction#showcase doesn't depend on instance state (UtilityFunction)
-```
-
-## Current Support in Reek
-
-_Utility Function_ will warn about any method that:
-
-* is non-empty
-* does not override an inherited method
-* calls at least one method on another object
-* doesn't use any of self's instance variables
-* doesn't use any of self's methods
-
-## Differences to _Feature Envy_
-
-_[Feature Envy](Feature-Envy.md)_ is only triggered if there are some references to self and _Utility Function_ is triggered if there are no references to self.
-
-## Configuration
-
-Reek's _Utility Function_ detector supports the [Basic Smell Options](Basic-Smell-Options.md), plus:
-
-| Option                | Value       | Effect  |
-| ----------------------|-------------|---------|
-| `public_methods_only` | Boolean | Disable this smell detector for non-public methods (which means "private" and "protected") |
-
-A sample configuration file would look like this:
-
-```Yaml
----
-UtilityFunction:
-  public_methods_only: true
-```

data/docs/Versioning-Policy.md

@@ -1,7 +0,0 @@
-# Versioning Policy
-
-* CLI interface: Adding options is a non-breaking change, and would warrant an update of the minor version. Removing options is a breaking change and requires a major version update (we did this going to Reek 2). Adding a report format probably also warrents a minor version upgrade.
-* API: We haven't really defined a 'public' API for using Reek programmatically, and we've only just started testing it. So, this is basically a blank slate at the moment. We will work on this as a part of the Reek 3 release.
-* List of detected smells: Adding a smell warrants a minor release, removing a smell is a breaking change. This makes sense if you consider that the CLI allows running a single smell detector.
-* Consistency of detected smells: This is very hard to guarantee. If we fix a bug in one of the detectors, some fragrant code may become smelly, or vice versa. Right now we don't bother with this.
-* Smell configuration: The detectors are quite tolerant regarding configuration options that they don't recognize, so we regard any change here as only requiring a minor release.

data/docs/YAML-Reports.md

@@ -1,93 +0,0 @@
-# YAML Reports
-
-## Introduction
-
-Reek's `--yaml` option writes on $stdout a YAML dump of the smells found. Each reported smell has a number of standard fields and a number of fields that are specific to the smell's type. The common fields are as follows:
-
-| Field         | Type       | Value  |
-| ---------------|-------------|---------|
-| source | string | The name of the source file containing the smell, or `$stdin` |
-| lines | array | The source file line number(s) that contribute to this smell |
-| context | string | The name of the class, module or method containing the smell |
-| class | string | The class to which this smell belongs |
-| subclass | string | This smell's subclass within the above class |
-| message | string | The message that would have been printed in a standard Reek report |
-| is_active | boolean | `false` if the smell is masked by a config file; `true` otherwise |
-
-All of these fields are grouped into hashes `location`, `smell` and `status` (see the examples below).
-
-## Examples
-
-Duplication:
-
-<pre>
-- !ruby/object:Reek::SmellWarning 
-  location: 
-    source: spec/samples/masked/dirty.rb
-    lines: 
-    - 5
-    - 7
-    context: Dirty#a
-  smell: 
-    class: Duplication
-    subclass: DuplicateMethodCall
-    occurrences: 2
-    call: puts(@s.title)
-    message: calls puts(@s.title) twice
-  status:
-    is_active: true
-</pre>
-
-[Nested Iterators](Nested-Iterators.md):
-
-<pre>
-- !ruby/object:Reek::SmellWarning 
-  location: 
-    source: spec/samples/masked/dirty.rb
-    lines: 
-    - 5
-    context: Dirty#a
-  smell: 
-    class: NestedIterators
-    subclass: ""
-    depth: 2
-    message: contains iterators nested 2 deep
-  status:
-    is_active: true
-</pre>
-
-[Uncommunicative Method Name](Uncommunicative-Method-Name.md):
-
-<pre>
-- !ruby/object:Reek::SmellWarning 
-  location: 
-    source: spec/samples/masked/dirty.rb
-    lines: 
-    - 3
-    context: Dirty#a
-  smell: 
-    class: UncommunicativeName
-    subclass: UncommunicativeMethodName
-    method_name: a
-    message: has the name 'a'
-  status:
-    is_active: false
-</pre>
-
-[Uncommunicative Variable Name](Uncommunicative-Variable-Name.md):
-
-<pre>
-- !ruby/object:Reek::SmellWarning 
-  location: 
-    source: spec/samples/masked/dirty.rb
-    lines: 
-    - 5
-    context: Dirty#a
-  smell: 
-    class: UncommunicativeName
-    subclass: UncommunicativeVariableName
-    variable_name: x
-    message: has the variable name 'x'
-  status:
-    is_active: true
-</pre>

data/docs/defaults.reek.yml

@@ -1,129 +0,0 @@
----
-detectors:
-  Attribute:
-    enabled: true
-    exclude: []
-  BooleanParameter:
-    enabled: true
-    exclude: []
-  ClassVariable:
-    enabled: true
-    exclude: []
-  ControlParameter:
-    enabled: true
-    exclude: []
-  DataClump:
-    enabled: true
-    exclude: []
-    max_copies: 2
-    min_clump_size: 2
-  DuplicateMethodCall:
-    enabled: true
-    exclude: []
-    max_calls: 1
-    allow_calls: []
-  FeatureEnvy:
-    enabled: true
-    exclude: []
-  InstanceVariableAssumption:
-    enabled: true
-    exclude: []
-  IrresponsibleModule:
-    enabled: true
-    exclude: []
-  LongParameterList:
-    enabled: true
-    exclude: []
-    max_params: 3
-    overrides:
-      initialize:
-        max_params: 5
-  LongYieldList:
-    enabled: true
-    exclude: []
-    max_params: 3
-  ManualDispatch:
-    enabled: true
-    exclude: []
-  MissingSafeMethod:
-    enabled: true
-    exclude: []
-  ModuleInitialize:
-    enabled: true
-    exclude: []
-  NestedIterators:
-    enabled: true
-    exclude: []
-    max_allowed_nesting: 1
-    ignore_iterators:
-    - tap
-  NilCheck:
-    enabled: true
-    exclude: []
-  RepeatedConditional:
-    enabled: true
-    exclude: []
-    max_ifs: 2
-  SubclassedFromCoreClass:
-    enabled: true
-    exclude: []
-  TooManyConstants:
-    enabled: true
-    exclude: []
-    max_constants: 5
-  TooManyInstanceVariables:
-    enabled: true
-    exclude: []
-    max_instance_variables: 4
-  TooManyMethods:
-    enabled: true
-    exclude: []
-    max_methods: 15
-  TooManyStatements:
-    enabled: true
-    exclude:
-    - initialize
-    max_statements: 5
-  UncommunicativeMethodName:
-    enabled: true
-    exclude: []
-    reject:
-    - "/^[a-z]$/"
-    - "/[0-9]$/"
-    - "/[A-Z]/"
-    accept: []
-  UncommunicativeModuleName:
-    enabled: true
-    exclude: []
-    reject:
-    - "/^.$/"
-    - "/[0-9]$/"
-    accept: []
-  UncommunicativeParameterName:
-    enabled: true
-    exclude: []
-    reject:
-    - "/^.$/"
-    - "/[0-9]$/"
-    - "/[A-Z]/"
-    - "/^_/"
-    accept: []
-  UncommunicativeVariableName:
-    enabled: true
-    exclude: []
-    reject:
-    - "/^.$/"
-    - "/[0-9]$/"
-    - "/[A-Z]/"
-    accept:
-    - "/^_$/"
-  UnusedParameters:
-    enabled: true
-    exclude: []
-  UnusedPrivateMethod:
-    enabled: false
-    exclude: []
-  UtilityFunction:
-    enabled: true
-    exclude: []
-    public_methods_only: false

data/docs/templates/default/docstring/html/public_api_marker.erb

@@ -1,3 +0,0 @@
-<div class="note public">
-  <div class="inline"><p>This <%= object.type %> is part of Reek's public API.</p></div>
-</div>

data/docs/templates/default/docstring/setup.rb

@@ -1,37 +0,0 @@
-def init
-  super
-  return unless show_api_marker_section?
-
-  if sections.first
-    sections.first.place(:api_marker).before(:private)
-  else
-    sections :index, [:api_marker]
-  end
-end
-
-def api_marker
-  return if object.type == :root
-
-  erb(:private) unless ['public', 'private'].include? api_text
-end
-
-private
-
-def api_text
-  api_text = object.has_tag?(:api) && object.tag(:api).text
-  api_text = 'public' if object.has_tag?(:public)
-  api_text
-end
-
-def show_api_marker_section?
-  return false if object.type == :root
-
-  case api_text
-  when 'public'
-    false
-  when 'private'
-    false
-  else
-    true
-  end
-end

data/docs/templates/default/fulldoc/html/css/common.css

@@ -1 +0,0 @@
-.note.public { background: #c5ffc5; border-color: #aaecaa; }

data/docs/yard_plugin.rb

@@ -1,17 +0,0 @@
-require 'yard'
-
-# Template helper to modify processing of links in HTML generated from our
-# markdown files.
-module LocalLinkHelper
-  # Rewrites links to (assumed local) markdown files so they're processed as
-  # {file: } directives.
-  def resolve_links(text)
-    text = text.gsub(%r{<a href="([^"]*.md)">([^<]*)</a>}, '{file:\1 \2}')
-    super text
-  end
-end
-
-YARD::Templates::Template.extra_includes << LocalLinkHelper
-YARD::Tags::Library.define_tag('Guaranteed public API', :public)
-YARD::Tags::Library.define_tag('Code quality configuration', :quality)
-YARD::Templates::Engine.register_template_path File.join(File.dirname(__FILE__), 'templates')

data/features/command_line_interface/basic_usage.feature

@@ -1,15 +0,0 @@
-Feature: The Reek CLI maintains backwards compatibility
-  In order to use Reek without fuss
-  As a developer
-  I want to have a stable basic command line interface
-
-  Scenario: the example from README reports as expected
-    Given the smelly file 'smelly.rb'
-    When I run reek smelly.rb
-    Then the exit status indicates smells
-    And it reports:
-    """
-    smelly.rb -- 2 warnings:
-      [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-      [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-    """

data/features/command_line_interface/options.feature

@@ -1,123 +0,0 @@
-Feature: Reek can be controlled using command-line options
-  In order to change Reek's default behaviour
-  As a developer
-  I want to supply options on the command line
-
-  Scenario: return non-zero status on bad option
-    When I run reek --no-such-option
-    Then the exit status indicates an error
-    And it reports the error "Error: invalid option: --no-such-option"
-    And there is no output on stdout
-
-  Scenario: display the current version number
-    When I run reek --version
-    Then it succeeds
-    And it reports the current version
-
-  Scenario: return given status code when using --failure-exit-code
-    Given the smelly file 'smelly.rb'
-    When I run reek smelly.rb --failure-exit-code 23
-    Then the exit status is 23
-
-  Scenario: return given status code when using --success-exit-code
-    Given the clean file "clean.rb"
-    When I run reek clean.rb --success-exit-code 42
-    Then the exit status is 42
-
-  Scenario: display the help information
-    When I run reek --help
-    Then it succeeds
-    And it reports:
-      """
-      Usage: reek [options] [files]
-
-      Examples:
-
-      reek lib/*.rb
-      reek -s lib
-      cat my_class.rb | reek
-
-      See https://github.com/troessner/reek for detailed help.
-
-      Configuration:
-          -c, --config FILE                Read configuration options from FILE
-              --smell SMELL                Only look for a specific smell.
-                                           Call it like this: reek --smell MissingSafeMethod source.rb
-                                           Check out https://github.com/troessner/reek/blob/v6.0.2/docs/Code-Smells.md for a list of smells
-              --stdin-filename FILE        When passing code in via pipe, assume this filename when checking file or directory rules in the config.
-
-      Generate a todo list:
-          -t, --todo                       Generate a todo list
-
-      Report format:
-          -f, --format FORMAT              Report smells in the given format:
-                                             html
-                                             text (default)
-                                             yaml
-                                             json
-                                             xml
-
-      Text format options:
-              --[no-]color                 Use colors for the output (default: true)
-          -V, --[no-]empty-headings        Show headings for smell-free source files (default: false)
-          -U, --[no-]documentation         Show link to related documentation page for each smell (default: true)
-              --[no-]show-configuration-path
-                                           Show which configuration file Reek is using (default: false)
-          -n, --[no-]line-numbers          Show line numbers in the output (default: true)
-          -s, --single-line                Show location in editor-compatible single-line-per-smell format
-          -P, --[no-]progress              Show progress of each source as it is examined (default: true)
-              --sort-by SORTING            Sort reported files by the given criterium:
-                                             smelliness ("smelliest" files first)
-                                             none (default - output in processing order)
-              --force-exclusion            Force excluding files specified in the configuration `exclude_paths`
-                                             even if they are explicitly passed as arguments
-
-     Exit codes:
-              --success-exit-code CODE     The exit code when no smells are found (default: 0)
-              --failure-exit-code CODE     The exit code when smells are found (default: 2)
-
-      Utility options:
-          -h, --help                       Show this message
-          -l, --list                       List all available smell detectors
-          -v, --version                    Show version
-      """
-
-  Scenario: List all available smell detectors
-    When I run reek --list
-    Then it succeeds
-    And it reports:
-      """
-      All available smell detectors:
-
-      Attribute
-      BooleanParameter
-      ClassVariable
-      ControlParameter
-      DataClump
-      DuplicateMethodCall
-      FeatureEnvy
-      InstanceVariableAssumption
-      IrresponsibleModule
-      LongParameterList
-      LongYieldList
-      ManualDispatch
-      MissingSafeMethod
-      ModuleInitialize
-      NestedIterators
-      NilCheck
-      RepeatedConditional
-      SubclassedFromCoreClass
-      TooManyConstants
-      TooManyInstanceVariables
-      TooManyMethods
-      TooManyStatements
-      UncommunicativeMethodName
-      UncommunicativeModuleName
-      UncommunicativeParameterName
-      UncommunicativeVariableName
-      UnusedParameters
-      UnusedPrivateMethod
-      UtilityFunction
-
-      Check out https://github.com/troessner/reek/blob/v6.0.2/docs/Code-Smells.md for a details on each detector
-      """

data/features/command_line_interface/show_progress.feature

@@ -1,33 +0,0 @@
-Feature: Show progress
-  In order to see the progress of the examiners
-  As a developer
-  I want to be able to selectively activate progress reporting
-
-  # Note that --progress is the default on TTYs, but needs to be explicitely
-  # enabled here because output in the cucumber scenarios does not go to a TTY.
-  Scenario: shows progress output on mixed files by default
-    Given a directory called 'mixed_files' containing some clean and smelly files
-    When I run reek --progress mixed_files
-    Then the exit status indicates smells
-    And it reports:
-      """
-      Inspecting 2 file(s):
-      .S
-
-      mixed_files/dirty.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      2 total warnings
-      """
-
-  Scenario: --no-progress disables progress output
-    Given a directory called 'mixed_files' containing some clean and smelly files
-    When I run reek --no-progress mixed_files
-    Then the exit status indicates smells
-    And it reports:
-      """
-      mixed_files/dirty.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      2 total warnings
-      """

data/features/command_line_interface/smell_selection.feature

@@ -1,15 +0,0 @@
-Feature: Smell selection
-  In order to focus on particular code smells
-  As a developer
-  I want to be able to selectively activate smell detectors
-
-  Scenario: --smell selects a smell to detect
-    Given the smelly file 'smelly.rb'
-    And a configuration file 'partial_mask.reek'
-    When I run reek --no-line-numbers --smell UncommunicativeVariableName smelly.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly.rb -- 1 warning:
-        UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """

data/features/command_line_interface/smells_count.feature

@@ -1,38 +0,0 @@
-Feature: Reports total number of code smells
-  In order to monitor the total number of smells
-  Reek outputs the total number of smells among all files inspected.
-
-  Scenario: Does not output total number of smells when inspecting single file
-    Given the smelly file 'smelly.rb'
-    When I run reek smelly.rb
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      """
-
-  Scenario: Output total number of smells when inspecting multiple files
-    Given a directory called 'smelly' containing two smelly files
-    When I run reek smelly
-    Then the exit status indicates smells
-    And it reports:
-      """
-      smelly/dirty_one.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      smelly/dirty_two.rb -- 2 warnings:
-        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
-      4 total warnings
-      """
-
-  Scenario: Output total number of smells even if total equals 0
-    Given a directory called 'clean' containing two clean files
-    When I run reek clean
-    Then it succeeds
-    And it reports:
-      """
-      0 total warnings
-      """