reek 2.0.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af5e0348f9f24426352d7790b0c3b4574b7128b
-  data.tar.gz: 42b3c7339cae9caebbcab1ab5a6386b21165ae6a
+  metadata.gz: 4e3eceb35601fc0869c63c3b45034947d62e803a
+  data.tar.gz: bfafa8489c105d8cd9681dcd1ba640f501abf928
 SHA512:
-  metadata.gz: c33ef48a39ed8a20ba2a5e4b1973851004f668d4b1878805ce0a245743cd5bbba0c64c4a96747200762b273eae7762433c0509376552620ebd490fa0c2203f9f
-  data.tar.gz: f682a7ae37aa0787e5dd6215e03ee5340b121e0bc7532f8c0275b6c8274ffccd6345a3a61d7b51e3beb80baa53bb47fdfceaac6422802057741de0d45e7d1d36
+  metadata.gz: f2474b97d54de8ed1b7aa7424a706d18e0f2812b2ac9e7959be70f6b301c8a643968f7cffeff6a83a98b3f65a6aae144a9e743bfca82e6bd4832cfb226b11520
+  data.tar.gz: e4cc1838cbefcd6cdd85f3675f64476ffb1a37ec26e541778f742855cae709ae63199e1069dca2d224eb87b00090496cf344eaef2d5e1cff74467bf25ffeb8a4

data/.gitignore

@@ -0,0 +1,13 @@
+pkg
+spec/output
+tmp
+doc
+.yardoc
+.bundle
+.rspec
+.rbx
+Gemfile.lock
+*.swp
+tags
+.pryrc
+.tags*

data/.rubocop.yml

@@ -0,0 +1,66 @@
+AllCops:
+  Exclude:
+    - 'spec/samples/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+
+# FIXME: Lower the ABC size by fixing the biggest offenders
+Metrics/AbcSize:
+  Max: 25
+
+# FIXME: Make the class shorter
+Metrics/ClassLength:
+  Exclude:
+    - lib/reek/core/tree_walker.rb
+
+# FIXME: Lower the method length by fixing the biggest offenders
+Metrics/MethodLength:
+  Max: 46
+
+# Be a little more lenient with line length
+Metrics/LineLength:
+  Max: 100
+
+# Allow small arrays of words with quotes
+Style/WordArray:
+  MinSize: 3
+
+# Allow single-line method definitions
+Style/SingleLineMethods:
+  Enabled: false
+
+# Always use raise to signal exceptions
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Allow multiple Hash parameters to look similar
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+# Place . on the previous line
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Require empty lines between defs, except for one-line defs
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+# Enforce GaurdClause if there are 2 or more lines in the body
+Style/GuardClause:
+  MinBodyLength: 2
+
+# Allow s()
+Style/MethodCallParentheses:
+  Enabled: false
+
+# Allow multiline block chains
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Allow Perl-style references to regex matches
+Style/PerlBackrefs:
+  Enabled: false
+
+# Only register TrivialAccessors offenses when the name matches
+Style/TrivialAccessors:
+  ExactNameMatch: true

data/.ruby-gemset

@@ -0,0 +1 @@
+reek

data/.travis.yml

@@ -0,0 +1,25 @@
+sudo: false
+cache: bundler
+language: ruby
+bundler_args: --without local_development
+script: bundle exec rake
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - jruby-19mode
+  - rbx-2
+  - ruby-head
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+notifications:
+  recipients:
+    - timo.roessner@googlemail.com
+    - matijs@matijs.net
+    - emil.rehnberg@gmail.com
+    - chastell@chastell.net
+  irc: "irc.freenode.org#reek"

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 2.1.0
+
+* (mvz) Ensure require 'reek' is enough to use reek's classes
+* (mvz) Pick config file that comes first alphabetically
+* (mvz) Separate FeatureEnvy and UtilityFunction
+
 == 2.0.4
 
 * (chastell)  Recognise .reek as a valid configuration file

data/CONTRIBUTING.md

@@ -0,0 +1,106 @@
+# Contributing to reek
+
+We welcome any and all contributions to reek!
+
+If what you’re proposing requires significant work discuss it beforehand
+as an issue – it’s much easier for us to guide you towards a good
+solution and less frustrating for you than doing a lot of work
+only to find us suggesting large parts should be rewritten.
+
+Don’t hesitate to offer trivial fixes (spelling, better naming
+ideas, etc.) – we’ll let you know if you’re overdoing it. :)
+
+
+
+## Reporting Issues
+
+Search [all existing (open _and_ closed)
+issues](https://github.com/troessner/reek/issues?q=is%3Aissue)
+for a possible previous report; comment there if the issue is not
+actually resolved properly or you have any additional information.
+
+Include the steps to reproduce the issue,
+the expected outcome and the actual outcome.
+
+Include as much information as possible: the exact reek
+invocation that you use, reek’s config and version, Ruby
+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. :)
+
+
+
+## Setup and Pull Request Basics
+
+Fork reek, then clone it, make sure you have
+[Bundler](http://bundler.io) installed, install dependencies
+and make sure all of the existing tests pass:
+
+```
+git clone git@github.com:…username…/reek.git
+cd reek
+gem install bundler
+bundle
+bundle exec rake
+```
+
+Once you’re sure your copy of reek works (and that there are no
+failing tests on master…) create your own branch and start hacking:
+
+```
+git checkout -b your_feature_or_fix_name
+```
+
+Add new tests which make sure that your new feature works or
+demonstrate that your fix was needed; please also [write 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
+again make sure all of the tests pass. This will also run
+[RuboCop](https://github.com/bbatsov/rubocop) – fix any
+offences RuboCop finds (or discuss them in the pull request):
+
+```
+bundle exec rake
+```
+
+Once your code is ready for review push it to your repository:
+
+```
+git push -u origin
+```
+
+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
+
+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.
+
+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.
+
+GitHub doesn’t have a good way to amend pull requests from external
+repositories. In cases where it’s easier to make a direct fix
+to your pull request (rather than describing it in the comments)
+we’ll either open a separate pull request to the branch in your
+repository or ask you to give us commit access to your repository.
+
+If there were any fixes to your pull request we’ll ask you to
+[squash](http://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits)
+all of the commits into one:
+
+```
+git rebase -i master
+# squash squash squash
+git push -f origin
+```

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# The gem's dependencies are specified in the gemspec
+gemspec
+
+group :local_development do
+  gem 'pry'
+  platforms :mri do
+    if RUBY_VERSION >= '2.0.0'
+      gem 'byebug'
+      gem 'pry-byebug'
+    end
+  end
+end

data/README.md

@@ -31,7 +31,7 @@ class Dirty
   # This method smells of :reek:NestedIterators but ignores them
   def awful(x, y, offset = 0, log = false)
     puts @screen.title
-    @screen = widgets.map {|w| w.each {|key| key += 3}}
+    @screen = widgets.map {|w| w.each {|key| key += 3 * x}}
     puts @screen.contents
   end
 end
@@ -41,17 +41,15 @@ Reek will report the following code smells in this file:
 
 ```
 $ reek demo.rb
-spec/samples/demo/demo.rb -- 6 warnings:
-  Dirty has no descriptive comment (IrresponsibleModule)
-  Dirty#awful has 4 parameters (LongParameterList)
-  Dirty#awful has boolean parameter 'log' (ControlCouple)
-  Dirty#awful has the parameter name 'x' (UncommunicativeName)
-  Dirty#awful has the parameter name 'y' (UncommunicativeName)
-  Dirty#awful has the variable name 'w' (UncommunicativeName)
-  Dirty#awful has unused parameter 'log' (UnusedParameters)
-  Dirty#awful has unused parameter 'offset' (UnusedParameters)
-  Dirty#awful has unused parameter 'x' (UnusedParameters)
-  Dirty#awful has unused parameter 'y' (UnusedParameters)
+demo.rb -- 8 warnings:
+  [1]:Dirty has no descriptive comment (IrresponsibleModule)
+  [3]:Dirty#awful has 4 parameters (LongParameterList)
+  [3]:Dirty#awful has boolean parameter 'log' (BooleanParameter)
+  [3]:Dirty#awful has the parameter name 'x' (UncommunicativeParameterName)
+  [5]:Dirty#awful has the variable name 'w' (UncommunicativeVariableName)
+  [3]:Dirty#awful has unused parameter 'log' (UnusedParameters)
+  [3]:Dirty#awful has unused parameter 'offset' (UnusedParameters)
+  [3]:Dirty#awful has unused parameter 'y' (UnusedParameters)
 ```
 
 ## Sources
@@ -171,7 +169,7 @@ reek [options] [dir_or_source_file]*
 there are quite a few other ways how to use reek in your projects:
 
 * Use `reek`'s [Rake Task](https://github.com/troessner/reek/wiki/Rake-Task) to automate detecting code smells
-* Add `reek`'s custom matcher to your [RSpec examples](https://github.com/troessner/reek/wiki/RSpec-Integration)
+* Add `reek`'s custom matcher to your [RSpec examples](https://github.com/troessner/reek/wiki/RSpec-matchers)
 * Include `reek` using the [Developer API](https://github.com/troessner/reek/wiki/Developer-Api)
 
 ## Developing reek / Contributing
@@ -217,14 +215,11 @@ If you don't feel like getting your hands dirty with code there are still other
 
 ### Tools
 
-There's a vim plugin for `reek`:
-[https://github.com/rainerborene/vim-reek](https://github.com/rainerborene/vim-reek)
-
-TextMate Bundle for `reek`:
-[https://github.com/peeyush1234/reek.tmbundle](https://github.com/peeyush1234/reek.tmbundle)
-
-Colorful output for `reek`: [Preek](https://github.com/joenas/preek) (also with
-[Guard::Preek](https://github.com/joenas/guard-preek))
+* [Vim plugin for `reek`](https://github.com/rainerborene/vim-reek)
+* [TextMate Bundle for `reek`](https://github.com/peeyush1234/reek.tmbundle)
+* [Colorful output for `reek`](https://github.com/joenas/preek)
+  (also with [Guard::Preek](https://github.com/joenas/guard-preek))
+* [Atom plugin for `reek`](https://atom.io/packages/linter-reek)
 
 ### Find out more:
 

data/bin/reek

@@ -6,6 +6,6 @@
 # Author: Kevin Rutherford
 #
 
-require 'reek/cli/application'
+require_relative '../lib/reek/cli/application'
 
-exit Reek::Cli::Application.new(ARGV).execute
+exit Reek::CLI::Application.new(ARGV).execute

data/config/cucumber.yml

@@ -0,0 +1,3 @@
+default: --tags ~@wip -fprogress -r features features
+wip: -fpretty --tags @wip --wip features
+

data/config/defaults.reek

@@ -109,4 +109,4 @@ UnusedParameters:
 UtilityFunction:
   enabled: true
   exclude: []
-  max_helper_calls: 1
+  max_helper_calls: 0

data/features/command_line_interface/smell_selection.feature

@@ -4,15 +4,11 @@ Feature: Smell selection
   I want to be able to selectively activate smell detectors
 
   Scenario: --smell selects a smell to detect
-    When I run reek --no-line-numbers --smell DuplicateMethodCall spec/samples/two_smelly_files
+    Given a smelly file called 'smelly.rb'
+    When I run reek --no-line-numbers --smell UncommunicativeMethodName smelly.rb
     Then the exit status indicates smells
     And it reports:
       """
-      spec/samples/two_smelly_files/dirty_one.rb -- 2 warnings:
-        Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      spec/samples/two_smelly_files/dirty_two.rb -- 2 warnings:
-        Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-        Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      4 total warnings
+      smelly.rb -- 1 warning:
+        Smelly#m has the name 'm' (UncommunicativeMethodName)
       """

data/features/command_line_interface/smells_count.feature

@@ -3,45 +3,38 @@ Feature: Reports total number of code smells
   Reek outputs the total number of smells among all files inspected.
 
   Scenario: Does not output total number of smells when inspecting single file
-    When I run reek spec/samples/standard_smelly/dirty.rb
+    Given a smelly file called 'smelly.rb'
+    When I run reek smelly.rb
     Then the exit status indicates smells
     And it reports:
-    """
-    spec/samples/standard_smelly/dirty.rb -- 6 warnings:
-      [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-      [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-      [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-      [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-      [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
-    """
+      """
+      smelly.rb -- 3 warnings:
+        [4, 5]:Smelly#m calls @foo.bar 2 times (DuplicateMethodCall)
+        [4, 5]:Smelly#m calls puts(@foo.bar) 2 times (DuplicateMethodCall)
+        [3]:Smelly#m has the name 'm' (UncommunicativeMethodName)
+      """
 
   Scenario: Output total number of smells when inspecting multiple files
-    When I run reek spec/samples/two_smelly_files
+    Given a directory called 'smelly' containing two smelly files
+    When I run reek smelly
     Then the exit status indicates smells
     And it reports:
-    """
-    spec/samples/two_smelly_files/dirty_one.rb -- 6 warnings:
-      [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-      [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-      [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-      [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-      [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
-    spec/samples/two_smelly_files/dirty_two.rb -- 6 warnings:
-      [5]:Dirty has the variable name '@s' (UncommunicativeVariableName)
-      [4, 6]:Dirty#a calls @s.title 2 times (DuplicateMethodCall)
-      [4, 6]:Dirty#a calls puts(@s.title) 2 times (DuplicateMethodCall)
-      [5]:Dirty#a contains iterators nested 2 deep (NestedIterators)
-      [3]:Dirty#a has the name 'a' (UncommunicativeMethodName)
-      [5]:Dirty#a has the variable name 'x' (UncommunicativeVariableName)
-    12 total warnings
-    """
+      """
+      smelly/dirty_one.rb -- 2 warnings:
+        [1]:Dirty has no descriptive comment (IrresponsibleModule)
+        [2]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+      smelly/dirty_two.rb -- 3 warnings:
+        [1]:Dirty has no descriptive comment (IrresponsibleModule)
+        [2]:Dirty#a has the name 'a' (UncommunicativeMethodName)
+        [3]:Dirty#b has the name 'b' (UncommunicativeMethodName)
+      5 total warnings
+      """
 
   Scenario: Output total number of smells even if total equals 0
-    When I run reek spec/samples/three_clean_files
+    Given a directory called 'clean_files' containing some clean files
+    When I run reek clean_files
     Then it succeeds
     And it reports:
-    """
-    0 total warnings
-    """
+      """
+      0 total warnings
+      """

data/features/command_line_interface/stdin.feature

@@ -18,7 +18,7 @@ Feature: Reek reads from $stdin when no files are given
     Then it succeeds
     And it reports:
       """
-      $stdin -- 0 warnings
+      STDIN -- 0 warnings
       """
 
   Scenario: return non-zero status when there are smells
@@ -26,7 +26,7 @@ Feature: Reek reads from $stdin when no files are given
     Then the exit status indicates smells
     And it reports:
       """
-      $stdin -- 3 warnings:
+      STDIN -- 3 warnings:
         [1]:Turn has no descriptive comment (IrresponsibleModule)
         [1]:Turn has the variable name '@x' (UncommunicativeVariableName)
         [1]:Turn#y has the name 'y' (UncommunicativeMethodName)