reek 4.4.2 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9726cb15a47090a670c986a90860b2ba22826416
-  data.tar.gz: 61c5759684ec24d5d0e7bd1e4d2e035a5263d25f
+  metadata.gz: f44c19009380c9dff7c4d8ef4dcdbe6f788d46b2
+  data.tar.gz: b9cfe47dc250a613611f414463a6dbca748690c8
 SHA512:
-  metadata.gz: ee0920b75d4b8be3d47940587f97aea414a0eb9faa83b2871d1d8627021c155674e108746a74588357f576b0d2783c59fadb40eae2d1972493eeb873e268b5af
-  data.tar.gz: 235a55cefe8256fb4d20529f10e1db0c3f4719641cd34c1c8e8d7b20d6c4e86fe07ae541990c92c4f22f838c2fe2476c9ce48b1a7145af2d74c735867d4940b0
+  metadata.gz: 221c0dbe79b6a6758a30ded23285fd715634843c3ac9bb0b9883aef9a0ebffcf84531dc6e492f091b2fa11cb7087470c96632aa45b53704da831a0a64feb7c1a
+  data.tar.gz: 51c17f02b1aa2c8ff8cf701ba7bc9d98c058a9c4e62fc2b6f246fd43f3be17ed12b6cc58ccb247f99527f909db50c5b4ab7085b08392a4b2c9e26137c8081bb2

data/.rubocop.yml

@@ -44,7 +44,9 @@ RSpec/ExampleLength:
 RSpec/MultipleDescribes:
   Exclude:
     - 'spec/reek/ast/sexp_extensions_spec.rb'
-    - 'spec/reek/report/location_formatter_spec.rb'
+    - 'spec/reek/code_comment_spec.rb'
+    - 'spec/reek/report/formatter/location_formatter_spec.rb'
+    - 'spec/reek/report/formatter/progress_formatter_spec.rb'
 
 # FIXME: Update specs to avoid offenses
 RSpec/MultipleExpectations:
@@ -69,6 +71,13 @@ RSpec/VerifiedDoubles:
     - 'spec/reek/context/method_context_spec.rb'
     - 'spec/reek/context/module_context_spec.rb'
 
+# rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
+RSpec/FilePath:
+  Exclude:
+    - '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'
+
 Style/AccessorMethodName:
   Exclude:
     - 'lib/reek/context/visibility_tracker.rb'

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Change log
 
+## 4.5.0 (2016-10-12)
+
+* (maxjacobson) Emit fingerprints in Code Climate reporter
+* (mvz) Disable progress for piped output
+* (mvz) Update progress formatter to match changed file location
+* (jhubert) Add progress formatters for showing progress on each file
+
+## 4.4.4 (2016-09-29)
+
+* (troessner) Create a fresh todo file on every run
+* (troessner) Handle garbage in comment config properly
+
+## 4.4.3 (2016-09-24)
+
+* (troessner) Improve handling of internal errors in detectors and the corresponding error messages
+
 ## 4.4.2 (2016-09-21)
 
 * (troessner) Fail properly on bad configuration comments

data/CONTRIBUTING.md

@@ -27,7 +27,7 @@ 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. :)
 
-## Contribute features, bugfixes, documentation
+## Contributing features, bugfixes, documentation
 
 ### Getting started
 
@@ -55,20 +55,21 @@ start contributing.
 Then start hacking and add new tests which make sure that your new feature works or
 demonstrate that your fix was needed.
 
-### Tests
+### RSpec Specs
 
-Reek is using [Rspec](http://rspec.info/) for unit and functional testing and [cucumber]() for integration tests.
+Reek uses [Rspec](http://rspec.info/) for unit and functional testing.
 
-When it comes to Rspec we're trying to follow [betterspecs](http://betterspecs.org/).
-We're not using Rspec's [shared examples](https://www.relishapp.com/rspec/rspec-core/docs/example-groups/shared-examples) because we find
-them rather harming than helpful.
-You can find an excellent cheat sheet on how to write idiomatic Rspec [here](http://www.rubypigeon.com/posts/rspec-core-cheat-sheet).
+We're trying to follow [betterspecs](http://betterspecs.org/). We're not using
+RSpec's
+[shared examples](https://www.relishapp.com/rspec/rspec-core/docs/example-groups/shared-examples)
+because we find them rather harming than helpful. You can find an excellent
+cheat sheet on how to write idiomatic Rspec
+[here](http://www.rubypigeon.com/posts/rspec-core-cheat-sheet).
 
-**Spec naming conventions**
-
-We do not use the popular "foo" / "bar" naming when it comes to the question "how to come up with good example names?".
-Instead, we use the [military alphabet](https://en.wikipedia.org/wiki/NATO_phonetic_alphabet) in ascending order
-which means that we would write this
+We do not use the popular "foo" / "bar" naming when it comes to the question
+"how to come up with good example names?". Instead, we use the
+[military alphabet](https://en.wikipedia.org/wiki/NATO_phonetic_alphabet) in
+ascending order which means that we would write this
 
 ```Ruby
 class Foo
@@ -88,13 +89,43 @@ class Alfa
 end
 ```
 
-### How to write new smell detectors
+### Cucumber Features
+
+Reek uses [Cucumber](https://cucumber.io/) with
+[Aruba](https://github.com/cucumber/aruba) for integration tests. Keep the
+following in mind when writing cucumber features.
+
+#### What to test
+
+Not everything needs a cucumber feature. We try to limit cucumber features to
+things that really require end-to-end testing of Reek's behavior. In
+particular, this means individual smell detectors should not have their own
+scenarios.
+
+#### TTY output checks
+
+Some default behaviors of Reek depend on whether the output is a TTY, for
+example output coloring and the progress bar. Because under Aruba stdout is
+*not* a TTY, Reeks default behavior in the scenarios is different in this
+regard than if it were run in a terminal.
+
+#### Failing Cucumber Scenarios
+
+If there is a failing scenario and you can not figure out why it is failing,
+just run the failing scenario: `bundle exec cucumber
+features/failing_scenario.feature:line`. By doing so Aruba will leave its set
+up in the `tmp/aruba` directory. You can then `cd` into this directory and run
+Reek the same way the cucumber scenario actually ran it. This way you can debug
+scenario failures that can be very opaque sometimes.
+
+### Writing new smell detectors
 
 Please see [our separate guide](docs/How-To-Write-New-Detectors.md) for this.
 
-### Finishing up
+### Creating your pull request
 
-We care a lot about [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+We care a lot about [good commit
+messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 
 Once you’re happy with your feature / fix – or want to
 share it as a work-in-progress and request comments – once
@@ -116,13 +147,14 @@ Then go to your GitHub fork and [make a pull
 request](https://help.github.com/articles/creating-a-pull-request/)
 to the original repository.
 
-## Review and Fixes
+### Review and Fixes
 
 Try to gauge and let us know in the pull request whether what
 you propose is a backward-compatible bugfix and should go into the
 next patch release, is a backward-compatible feature and should go
 into the next minor release, or has to break backward-compatibility
-and so needs to wait for the next major release of Reek.
+and so needs to wait for the next major release of Reek. See also our
+versioning policy below.
 
 Once your PR is open someone will review it, discuss the details (if
 needed) and either merge right away or ask for some further fixes.
@@ -142,14 +174,11 @@ git rebase -i master
 # squash squash squash
 git push -f origin
 ```
-## Failing Cucumber Scenarios
-
-If there is a failing scenario and you can not figure out why it is failing, just run the failing scenario: `bundle exec cucumber features/failing_scenario.feature:line`. By doing so Aruba will leave its set up in the `tmp/aruba` directory. You can then `cd` into this directory and run Reek the same way the cucumber scenario actually ran it. This way you can debug scenario failures that can be very opaque sometimes.
 
 ## Versioning policy
 
 We are following [semantic versioning](http://semver.org/).
 
-## Breaking changes
-
-If you're working on a change that is breaking backwards-compatibility according to our versioning policy from above just go ahead with your pull request like normal. We'll discuss this then in the pull request and help you to point your pull request to the right branch.
+If you're working on a change that is breaking backwards-compatibility
+just go ahead with your pull request like normal. We'll discuss this then in
+the pull request and help you to point your pull request to the right branch.

data/README.md

@@ -84,6 +84,9 @@ Reek will report the following code smells in this file:
 
 ```
 $ reek demo.rb
+Inspecting 1 file(s):
+S
+
 demo.rb -- 2 warnings:
   [4]:UncommunicativeMethodName: Smelly#x has the name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
   [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
@@ -404,13 +407,23 @@ via:
 reek -c whatever/.todo.reek lib/
 ```
 
-Note that if you re-run
+It's important to understand that the number one use case of the `--todo` flag
+is to be run once at the beginning of the introduction of Reek to ease the transition.
+If you find yourself re-running Reek with the `--todo` flag in order to silence new warnings
+you're defeating the purpose of both the `--todo` flag and of Reek itself.
+
+As a consequence, running Reek with the `--todo` flag again will overwrite '.todo.reek' without
+asking (should not be a problem since this file is supposed to be versioned) and
+without taking **any** other configuration file you might have into account.
+
+This means that when you run
 
 ```Bash
-reek --todo lib/
+reek -c other_configuration.reek --todo lib/
 ```
 
-'.todo.reek' will get overwritten with a possibly updated configuration.
+`other_configuration.reek` will simply be ignored (as outlined before, Reek
+is supposed to have one configuration file and one file only).
 
 ## Usage
 

data/ataru_setup.rb

@@ -1,5 +1,5 @@
 require 'reek'
-require 'reek/smells'
+require 'reek/smell_detectors'
 
 # Ataru setup module.
 module Setup

data/docs/API.md

@@ -55,9 +55,6 @@ Note that `Reek::Examiner.new` can take `source` as `String`, `Pathname`, `File`
 Everything that is mentioned in this document can be considered stable in the
 sense that it will only change across major versions.
 
-`Reek 3` was the first major version with a stable API. As soon as `Reek 4`
-is released we will mark the differences between `3` and `4`.
-
 There is one thing in this API documentation you can't and shouldn't rely on:
 The `SmellWarning` messages itself.
 
@@ -147,7 +144,7 @@ Instead of the smell detector names you can also use the full detector class in
 your configuration hash, for example:
 
 ```ruby
-config_hash = { Reek::Smells::IrresponsibleModule => { 'enabled' => false } }
+config_hash = { Reek::SmellDetectors::IrresponsibleModule => { 'enabled' => false } }
 ```
 
 Of course, directory specific configuration and excluded paths are supported as

data/docs/How-reek-works-internally.md

@@ -40,9 +40,9 @@
                                       Examiner (core/examiner)  --------------------------------------
                                   * generates the AST out of the given source
                                   * adorns the generated AST via a TreeDresser (core/tree_dresser)
-                                  * initializes a SmellRepository with all relevant smells (smells/smell_repository)
+                                  * initializes a DetectorRepository with all relevant smells (smells/detector_repository)
                                   * builds a tree of Contexts using ContextBuilder
-                                  * tells the SmellRepository above to run each of its smell detectors above on each of the contexts
+                                  * tells the DetectorRepository above to run each of its smell detectors above on each of the contexts
                                   /       |       \
                                  /        |        \
                                 /         |         \
@@ -50,7 +50,7 @@
                                 \         |         /
                                  \        |        /
                                   \       |       /
-                                   SmellRepository
+                                   DetectorRepository
                                           |
                                           |
                                           |
@@ -66,7 +66,7 @@ The overall workflow is like this:
             |
             |
             |
-        Initialize SmellRepository only with eligible smells
+        Initialize DetectorRepository only with eligible SmellDetectors
             |
             |
             |
@@ -111,4 +111,4 @@ The overall workflow is like this:
             |
             |
       A ContextBuilder then traverses this now adorned tree again and
-      runs all SmellDetectors from the SmellRepository above
+      runs all SmellDetectors from the DetectorRepository above

data/docs/Style-Guide.md

@@ -10,3 +10,10 @@ We use instance vars only:
 For everything else we use proper getters / setters.
 
 If possible those should be private.
+
+## Data types
+
+- Class or module names that are carried around in hashes and configuration and what
+not should be designated by constants. So `DuplicateMethodCall`, not `:DuplicateMethodCall` or `"DuplicateMethodCall"`
+- Hash keys should be all symbols unless they designate classes / modules - see above.
+- Everything else like messages or parameters in smell warnings should be strings, nothing else.

data/features/command_line_interface/options.feature

@@ -61,6 +61,7 @@ Feature: Reek can be controlled using command-line options
           -U, --[no-]wiki-links            Show link to related wiki page for each smell (default: true)
           -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)

data/features/command_line_interface/show_progress.feature

@@ -0,0 +1,33 @@
+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' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+      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' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Method-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+      2 total warnings
+      """

data/features/configuration_files/masking_smells.feature

@@ -52,7 +52,6 @@ Feature: Masking smells using config files
       [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
     """
 
-
   Scenario: Disable UtilityFunction for non-public methods
     Given the smelly file 'smelly_with_modifiers.rb'
     And a configuration file 'non_public_modifiers_mask.reek'

data/features/configuration_via_source_comments/erroneous_source_comments.feature

@@ -8,18 +8,18 @@ Feature: Erroneous source comments are handled properly
   re-run Reek.
 
   Scenario: Unknown smell detector
-    Given a file named "bad_detector.rb" with:
+    Given a file named "bad_comment.rb" with:
       """
       # Test class
       # :reek:UnknownDetectorName
       def x
       end
       """
-    When I run reek bad_detector.rb
+    When I run reek bad_comment.rb
     Then it reports the error "Error: You are trying to configure an unknown smell detector 'UnknownDetectorName'"
 
   Scenario: One good file, one bad file
-    Given a file named "bad_detector.rb" with:
+    Given a file named "bad_comment.rb" with:
       """
       # Test class
       # :reek:UnknownDetectorName
@@ -27,7 +27,7 @@ Feature: Erroneous source comments are handled properly
       end
       """
     Given the smelly file 'smelly.rb'
-    When I run reek bad_detector.rb smelly.rb
+    When I run reek bad_comment.rb smelly.rb
     Then it reports the error "Error: You are trying to configure an unknown smell detector 'UnknownDetectorName'"
     And the exit status indicates smells
     And it reports:
@@ -37,3 +37,17 @@ Feature: Erroneous source comments are handled properly
         [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       2 total warnings
       """
+
+  Scenario: Garbage as content
+    Given a file named "bad_comment.rb" with:
+      """
+      # Test class
+      # :reek:UncommunicativeMethodName { thats: a: bad: config }
+      def x
+      end
+      """
+    When I run reek bad_comment.rb
+    Then it reports the error "Error: You are trying to configure the smell detector 'UncommunicativeMethodName'"
+    And it reports the error "Unfortunately we can not parse the configuration you have given."
+    And it reports the error "The source is 'bad_comment.rb'"
+    And it reports the error "the comment belongs to the expression starting in line 3"

data/features/configuration_via_source_comments/well_formed_source_comments.feature

@@ -0,0 +1,116 @@
+Feature: Well formed source comments are handled properly
+  As a developer I want to be able to have a fine-grained control
+  over how Reek handles smells via source code comments.
+
+  Scenario: Disable smell detector implicitly
+    Given a file named "disable_detector_implicitly.rb" with:
+      """
+      # Test class
+      # :reek:TooManyInstanceVariables
+      class Alfa
+        def initialize
+          @charlie = @delta = @echo = @foxtrot = @hotel = 1
+        end
+      end
+      """
+    When I run reek disable_detector_implicitly.rb
+    Then it succeeds
+    And it reports nothing
+
+  Scenario: Disable smell detector explicitly
+    Given a file named "disable_detector_explicitly.rb" with:
+      """
+      # Test class
+      # :reek:TooManyInstanceVariables { enabled: false }
+      class Alfa
+        def initialize
+          @charlie = @delta = @echo = @foxtrot = @hotel = 1
+        end
+      end
+      """
+    When I run reek disable_detector_explicitly.rb
+    Then it succeeds
+    And it reports nothing
+
+  Scenario: Enable smell detector explicitly
+    Given a file named "enable_detector_explicitly.rb" with:
+      """
+      # Test class
+      # :reek:TooManyInstanceVariables { enabled: true }
+      class Alfa
+        def initialize
+          @charlie = @delta = @echo = @foxtrot = @hotel = 1
+        end
+      end
+      """
+    When I run reek enable_detector_explicitly.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      enable_detector_explicitly.rb -- 1 warning:
+        [3]:TooManyInstanceVariables: Alfa has at least 5 instance variables [https://github.com/troessner/reek/blob/master/docs/Too-Many-Instance-Variables.md]
+      """
+
+  Scenario: Configure smell detector with the basic exclude option as string
+    Given a file named "configure_exclude_option.rb" with:
+      """
+      # Test class
+      # :reek:TooManyInstanceVariables { exclude: '@hotel' }
+      class Alfa
+        def initialize
+          @charlie = @delta = @echo = @foxtrot = @hotel = 1
+        end
+      end
+      """
+    When I run reek configure_exclude_option.rb
+    Then it succeeds
+    And it reports nothing
+
+  Scenario: Configure smell detector with the basic exclude option as regex
+    Given a file named "configure_exclude_option.rb" with:
+      """
+      # Test class
+      # :reek:TooManyInstanceVariables { exclude: /hotel/ }
+      class Alfa
+        def initialize
+          @charlie = @delta = @echo = @foxtrot = @hotel = 1
+        end
+      end
+      """
+    When I run reek configure_exclude_option.rb
+    Then it succeeds
+    And it reports nothing
+
+  Scenario: Configure smell detector with a detector specific option that silences it
+    Given a file named "configure_detector_specific_option.rb" with:
+    """
+      # Test class
+      # :reek:TooManyInstanceVariables { max_instance_variables: 5 }
+      class Alfa
+        def initialize
+          @charlie = @delta = @echo = @foxtrot = @hotel = 1
+        end
+      end
+      """
+    When I run reek configure_detector_specific_option.rb
+    Then it succeeds
+    And it reports nothing
+
+  Scenario: Configure smell detector with a detector specific option that makes it report again
+    Given a file named "configure_detector_specific_option.rb" with:
+    """
+      # Test class
+      # :reek:TooManyInstanceVariables { max_instance_variables: 2 }
+      class Alfa
+        def initialize
+          @charlie = @delta = @echo = 1
+        end
+      end
+      """
+    When I run reek configure_detector_specific_option.rb
+    Then the exit status indicates smells
+    And it reports:
+      """
+      configure_detector_specific_option.rb -- 1 warning:
+        [3]:TooManyInstanceVariables: Alfa has at least 3 instance variables [https://github.com/troessner/reek/blob/master/docs/Too-Many-Instance-Variables.md]
+      """