reek 3.1 → 3.2

data/README.md

@@ -218,7 +218,7 @@ end
 This is further explained under [Smell Suppresion](docs/Smell-Suppression.md).
 
 
-## Integration
+## Usage
 
 Besides the obvious
 
@@ -277,23 +277,73 @@ If you don't feel like getting your hands dirty with code there are still other
 
 ## Working with Rails
 
-With current versions of `reek` it's best to examine only your `app/models` folder, because `reek` raises false positives against views and controllers.
+Making `reek` "Rails"-friendly is fairly simple since we support directory specific configurations (`directory directives` in `reek` talk).
+Just add this to your configuration file:
 
-For example, `params` is a kind of DTO (data transfer object) close to the system boundary, and so its characteristics should be different than regular code. But Reek doesn't know that (yet); `reek` thinks that all those `params[:something]` calls are a problem, and reports them as smells.
+```Yaml
+"app/controllers":
+  IrresponsibleModule:
+    enabled: false
+  NestedIterators:
+    max_allowed_nesting: 2
+"app/helpers":
+  IrresponsibleModule:
+    enabled: false
+  UtilityFunction:
+    enabled: false
+```
 
-We plan to improve Reek in the near future so that it plays better with Rails. For now though, your best bet is to restrict it to looking at `app/models` and `lib`.
+Be careful though, `reek` does not merge your configuration entries, so if you already have a directory directive for "app/controllers" or "app/helpers" you need to update those directives instead of copying the above YAML sample into your configuration file.
 
-## Additional resources
+## Integrations
 
-### Tools
+### Editor integrations
+
+* [Vim plugin](https://github.com/rainerborene/vim-reek)
+* [TextMate Bundle](https://github.com/peeyush1234/reek.tmbundle)
+* [Atom plugin](https://atom.io/packages/linter-reek)
+
+### Projects that use or support us
+
+* [overcommit](https://github.com/brigade/overcommit) - a Git commit hook manager with support for
+  `reek`
+* [ruby-critic](https://github.com/whitesmith/rubycritic) - gem that wraps around static analysis gems such as `reek`, [flay](https://github.com/seattlerb/flay) and [flog](https://github.com/seattlerb/flog)
+* [pronto-reek](https://github.com/mmozuras/pronto-reek) - `reek` integration for [pronto](https://github.com/mmozuras/pronto)
+
+### Misc
 
-* [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)
-* [overcommit, a Git commit hook manager with support for
-  `reek`](https://github.com/brigade/overcommit)
+
+## Brothers and sisters
+
+A non-exhaustive list of other static code analyzers you might want to look into:
+
+* [debride](https://github.com/seattlerb/debride) - analyze code for potentially uncalled / dead methods
+* [flay](https://github.com/seattlerb/flay) - analyze code for structural similarities
+* [flog](https://github.com/seattlerb/flog) - reports the most tortured code in an easy to read pain
+report
+* [SandiMeter](https://github.com/makaroni4/sandi_meter) - checking your Ruby code for Sandi Metz' four rules
+* [ruby-lint](https://github.com/YorickPeterse/ruby-lint) - static code analysis tool
+* [Fasterer](https://github.com/DamirSvrtan/fasterer) - Fasterer will suggest some speed improvements based on [fast-ruby](https://github.com/JuanitoFatas/fast-ruby)
+
+## Contributors
+
+The `reek` core team consists of:
+
+* [Matijs van Zuijlen](https://github.com/mvz)
+* [Piotr Szotkowski](https://github.com/chastell)
+* [Timo Rößner](https://github.com/troessner)
+
+The original author of `reek` is [Kevin Rutherford](https://github.com/kevinrutherford).
+
+Notable contributions came from:
+
+* [Andrew Wagner](https://github.com/arwagner)
+* [Gilles Leblanc](https://github.com/gilles-leblanc)
+* [Emil Rehnberg](https://github.com/EmilRehnberg)
+
+## Additional resources
 
 ### Miscellaneous
 
@@ -304,13 +354,3 @@ We plan to improve Reek in the near future so that it plays better with Rails. F
 
 * [Stack Overflow](https://stackoverflow.com/questions/tagged/reek)
 * [RubyDoc.info](http://www.rubydoc.info/gems/reek)
-
-## Contributors
-
-A non-exhaustive list:
-
-* Kevin Rutherford
-* Matijs van Zuijlen
-* Andrew Wagner
-* Gilles Leblanc
-* Timo Rößner

data/Rakefile

@@ -1,5 +1,6 @@
-require 'rake/clean'
 require 'bundler/gem_tasks'
+require 'private_attr/everywhere'
+require 'rake/clean'
 
 Dir['tasks/**/*.rake'].each { |t| load t }
 

data/bin/reek

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

data/config/defaults.reek

@@ -1,6 +1,6 @@
 ---
 Attribute:
-  enabled: false
+  enabled: true
   exclude: []
 BooleanParameter:
   enabled: true
@@ -59,7 +59,7 @@ RepeatedConditional:
 TooManyInstanceVariables:
   enabled: true
   exclude: []
-  max_instance_variables: 9
+  max_instance_variables: 4
 TooManyMethods:
   enabled: true
   exclude: []

data/docs/Attribute.md

@@ -2,7 +2,11 @@
 
 ## Introduction
 
-A class that publishes a getter or setter for an instance variable invites client classes to become too intimate with its inner workings, and in particular with its representation of state.
+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
 
@@ -20,24 +24,16 @@ end
 reek test.rb
 
 test.rb -- 1 warning:
-  [2]:Klass declares the attribute dummy (Attribute)
+  [2]:Klass declares the writable attribute dummy (Attribute)
 ```
 
 ## Support in Reek
 
-Right now this smell is disabled by default since it is highly subjective.
+This detector it raises a warning for every public `attr_writer`,
+`attr_accessor`, and `attr` with the writable flag set to `true`.
 
-When this detector is enabled it raises a warning for every `attr`, `attr_reader`, `attr_writer` and `attr_accessor` -- including those that are private.
+Reek does not raise warnings for read-only attributes.
 
 ## Configuration
 
-If you want to enable it you can do so by placing
-
-```yaml
-Attribute:
-  enabled: true
-```
-
-in your reek configuration file.
-
 `Attribute` supports only the [Basic Smell Options](Basic-Smell-Options.md).

data/docs/Basic-Smell-Options.md

@@ -23,7 +23,7 @@ ControlCouple:
   - write
 ```
 
-Or a little more sophisticated using a ruby regex like this:
+Or a little more sophisticated using a Ruby regex like this:
 
 ```yaml
 ControlCouple: 
@@ -41,4 +41,4 @@ FeatureEnvy:
     - "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`
+This would not report FeatureEnvy for the instance method `MyModel#do_things`, the whole module `MyHelper` and the `respond` instance method of `ApplicationController`

data/docs/Command-Line-Options.md

@@ -14,7 +14,7 @@ for details.
 
 ## Telling Reek Which Code to Check
 
-Probably the most standard use case would be to check all ruby files in the lib directory:
+Probably the most standard use case would be to check all Ruby files in the lib directory:
 
 ```Bash
 reek lib/*.rb
@@ -81,4 +81,4 @@ test.rb -- 1 warning:
   [2]:Dummy declares the class variable @@class_variable (ClassVariable) [https://github.com/troessner/reek/wiki/Class-Variable]
 ```
 
-Note the link at the end.
+Note the link at the end.

data/docs/Too-Many-Instance-Variables.md

@@ -40,4 +40,4 @@ test.rb -- 5 warnings:
 
 | Option         | Value       | Effect  |
 | ---------------|-------------|---------|
-| max_instance_variables     | integer | The maximum number of instance variables that are permitted. Defaults to 9 |
+| max_instance_variables     | integer | The maximum number of instance variables that are permitted. Defaults to 4 |

data/features/samples.feature

@@ -5,7 +5,9 @@ Feature: Basic smell detection
 
   Scenario: Correct smells from inline.rb
     Given the "inline.rb" sample file exists
-    When I run reek --no-line-numbers inline.rb
+    And the "optparse.rb" sample file exists
+    And the "redcloth.rb" sample file exists
+    When I run reek --no-line-numbers inline.rb optparse.rb redcloth.rb
     Then the exit status indicates smells
     And it reports:
     """
@@ -55,16 +57,16 @@ Feature: Basic smell detection
       Module#inline calls Inline.const_get(lang) 2 times (DuplicateMethodCall)
       Module#inline calls options[:testing] 2 times (DuplicateMethodCall)
       Module#inline has approx 12 statements (TooManyStatements)
-    """
-
-  Scenario: Correct smells from optparse.rb
-    Given the "optparse.rb" sample file exists
-    When I run reek --no-line-numbers optparse.rb
-    Then the exit status indicates smells
-    And it reports:
-    """
-    optparse.rb -- 111 warnings:
+    optparse.rb -- 121 warnings:
+      OptionParser declares the writable attribute banner (Attribute)
+      OptionParser declares the writable attribute default_argv (Attribute)
+      OptionParser declares the writable attribute program_name (Attribute)
+      OptionParser declares the writable attribute release (Attribute)
+      OptionParser declares the writable attribute summary_indent (Attribute)
+      OptionParser declares the writable attribute summary_width (Attribute)
+      OptionParser declares the writable attribute version (Attribute)
       OptionParser has at least 42 methods (TooManyMethods)
+      OptionParser has at least 6 instance variables (TooManyInstanceVariables)
       OptionParser has the variable name 'f' (UncommunicativeVariableName)
       OptionParser has the variable name 'k' (UncommunicativeVariableName)
       OptionParser has the variable name 'o' (UncommunicativeVariableName)
@@ -148,7 +150,9 @@ Feature: Basic smell detection
       OptionParser::List#update has 5 parameters (LongParameterList)
       OptionParser::List#update has approx 10 statements (TooManyStatements)
       OptionParser::List#update has the variable name 'o' (UncommunicativeVariableName)
+      OptionParser::ParseError declares the writable attribute reason (Attribute)
       OptionParser::ParseError#set_option is controlled by argument eq (ControlParameter)
+      OptionParser::Switch has at least 7 instance variables (TooManyInstanceVariables)
       OptionParser::Switch#add_banner has the variable name 's' (UncommunicativeVariableName)
       OptionParser::Switch#initialize has 7 parameters (LongParameterList)
       OptionParser::Switch#parse_arg calls s.length 2 times (DuplicateMethodCall)
@@ -175,15 +179,13 @@ Feature: Basic smell detection
       OptionParser::Switch::NoArgument#parse has unused parameter 'argv' (UnusedParameters)
       OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv' (UnusedParameters)
       OptionParser::Switch::PlacedArgument#parse has approx 6 statements (TooManyStatements)
-    """
-
-  Scenario: Correct smells from redcloth.rb
-    Given the "redcloth.rb" sample file exists
-    When I run reek --no-line-numbers redcloth.rb
-    Then the exit status indicates smells
-    And it reports:
-    """
-    redcloth.rb -- 95 warnings:
+    redcloth.rb -- 101 warnings:
+      RedCloth declares the writable attribute filter_html (Attribute)
+      RedCloth declares the writable attribute filter_styles (Attribute)
+      RedCloth declares the writable attribute hard_breaks (Attribute)
+      RedCloth declares the writable attribute lite_mode (Attribute)
+      RedCloth declares the writable attribute no_span_caps (Attribute)
+      RedCloth declares the writable attribute rules (Attribute)
       RedCloth has at least 44 methods (TooManyMethods)
       RedCloth has the variable name 'a' (UncommunicativeVariableName)
       RedCloth has the variable name 'b' (UncommunicativeVariableName)
@@ -279,16 +281,5 @@ Feature: Basic smell detection
       RedCloth#textile_popup_help has the parameter name 'windowW' (UncommunicativeParameterName)
       RedCloth#to_html has approx 26 statements (TooManyStatements)
       RedCloth#v_align doesn't depend on instance state (UtilityFunction)
-    """
-
-  Scenario: Correct smells from a source file with unusual syntax samples
-    Given the "unusual_syntax.rb" sample file exists
-    When I run reek unusual_syntax.rb
-    Then the exit status indicates smells
-    And it reports:
-    """
-    unusual_syntax.rb -- 3 warnings:
-      [1]:SomeClass has no descriptive comment (IrresponsibleModule)
-      [18]:SomeClass#method_with_array_decomposition has the parameter name 'a' (UncommunicativeParameterName)
-      [18]:SomeClass#method_with_array_decomposition has the parameter name 'b' (UncommunicativeParameterName)
+    267 total warnings
     """

data/features/step_definitions/sample_file_steps.rb

@@ -27,7 +27,7 @@ end
 
 Given(/^the "(.*?)" sample file exists$/) do |file_name|
   full_path = Pathname.new("#{__dir__}/../../spec/samples/#{file_name}")
-  in_current_directory { FileUtils.cp full_path, file_name }
+  cd('.') { FileUtils.cp full_path, file_name }
 end
 
 Given(/^a directory called 'clean_files' containing some clean files$/) do
@@ -135,7 +135,7 @@ When(/^I run "reek (.*?)" in the subdirectory$/) do |args|
 end
 
 Given(/^a masking configuration file in the HOME directory$/) do
-  set_env 'HOME', Pathname.new("#{current_directory}/home").expand_path.to_s
+  set_environment_variable 'HOME', Pathname.new("#{expand_path('.')}/home")
   write_file('home/config.reek', <<-EOS.strip_heredoc)
     ---
     DuplicateMethodCall:

data/features/support/env.rb

@@ -1,3 +1,4 @@
+require_relative '../../lib/reek'
 require_relative '../../lib/reek/cli/application'
 require 'aruba/cucumber'
 require 'active_support/core_ext/string/strip'

data/lib/reek.rb

@@ -1,6 +1,7 @@
 #
 # Reek's core functionality
 #
+require 'private_attr/everywhere'
 require_relative 'reek/version'
 require_relative 'reek/examiner'
 require_relative 'reek/report/report'

data/lib/reek/ast/ast_node_class_map.rb

@@ -13,7 +13,7 @@ module Reek
       end
 
       def klass_for(type)
-        @klass_map[type] ||= Class.new(Node).tap do |klass|
+        klass_map[type] ||= Class.new(Node).tap do |klass|
           extension = extension_map[type]
           klass.send :include, extension if extension
         end
@@ -31,6 +31,10 @@ module Reek
             Hash[assoc]
           end
       end
+
+      private
+
+      private_attr_reader :klass_map
     end
   end
 end

data/lib/reek/ast/node.rb

@@ -17,12 +17,12 @@ module Reek
       end
 
       def full_comment
-        @comments.map(&:text).join("\n")
+        comments.map(&:text).join("\n")
       end
 
       def leading_comment
         line = location.line
-        comment_lines = @comments.select do |comment|
+        comment_lines = comments.select do |comment|
           comment.location.line < line
         end
         comment_lines.map(&:text).join("\n")
@@ -120,6 +120,8 @@ module Reek
 
       private
 
+      private_attr_reader :comments
+
       def each_sexp
         children.each { |elem| yield elem if elem.is_a? ::Parser::AST::Node }
       end

data/lib/reek/ast/object_refs.rb

@@ -11,21 +11,25 @@ module Reek
       end
 
       def most_popular
-        max = @refs.values.map(&:size).max
-        @refs.select { |_name, refs| refs.size == max }
+        max = refs.values.map(&:size).max
+        refs.select { |_name, refs| refs.size == max }
       end
 
       def record_reference_to(name, line: nil)
-        @refs[name] << ObjectRef.new(name, line)
+        refs[name] << ObjectRef.new(name, line)
       end
 
       def references_to(name)
-        @refs[name]
+        refs[name]
       end
 
       def self_is_max?
-        @refs.empty? || most_popular.keys.include?(:self)
+        refs.empty? || most_popular.keys.include?(:self)
       end
+
+      private
+
+      private_attr_reader :refs
     end
   end
 end

data/lib/reek/ast/reference_collector.rb

@@ -18,14 +18,16 @@ module Reek
 
       private
 
+      private_attr_reader :ast
+
       def explicit_self_calls
         [:self, :zsuper, :ivar, :ivasgn].flat_map do |node_type|
-          @ast.each_node(node_type, STOP_NODES)
+          ast.each_node(node_type, STOP_NODES)
         end
       end
 
       def implicit_self_calls
-        @ast.each_node(:send, STOP_NODES).reject(&:receiver)
+        ast.each_node(:send, STOP_NODES).reject(&:receiver)
       end
     end
   end

data/lib/reek/cli/application.rb

@@ -20,9 +20,9 @@ module Reek
         @status = STATUS_SUCCESS
         options_parser = Options.new(argv)
         begin
-          @options = options_parser.parse
-          @command = ReekCommand.new(OptionInterpreter.new(@options))
-          @configuration = Configuration::AppConfiguration.new @options
+          options = options_parser.parse
+          @command = ReekCommand.new(OptionInterpreter.new(options))
+          @configuration = Configuration::AppConfiguration.new(options)
         rescue OptionParser::InvalidOption, Reek::Configuration::ConfigFileException => error
           $stderr.puts "Error: #{error}"
           @status = STATUS_ERROR
@@ -30,9 +30,9 @@ module Reek
       end
 
       def execute
-        return @status if error_occured?
-        @command.execute self
-        @status
+        return status if error_occured?
+        command.execute self
+        status
       end
 
       def output(text)
@@ -40,17 +40,20 @@ module Reek
       end
 
       def report_success
-        @status = STATUS_SUCCESS
+        self.status = STATUS_SUCCESS
       end
 
       def report_smells
-        @status = STATUS_SMELLS
+        self.status = STATUS_SMELLS
       end
 
       private
 
+      private_attr_accessor :status
+      private_attr_reader :command
+
       def error_occured?
-        @status == STATUS_ERROR
+        status == STATUS_ERROR
       end
     end
   end