reek 4.5.3 → 4.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34053f46644b02e67bce28cf14ec83289581d477
-  data.tar.gz: 66637070f65e2c5a95ef84c3e981de7a0ffa5bf5
+  metadata.gz: 779579909e4877e391f86f92756b1ce1b45a3202
+  data.tar.gz: a7f30fb8db30c839c335c47be2eb00ce0f321bac
 SHA512:
-  metadata.gz: 9125b0336673170f5466a661f9c1893fcefc16bc7ace54d75979e817854844e7ccdd6cac5a223ca0c1a200fbaeafd56da79f0435b3f9ea14c9d67e9bea0dc024
-  data.tar.gz: a8308b810ce8785c1fdd39abbcb19708a86c0aa276698f3d803550a4d1d332ec2612fcfa5c92dbdf29096c4fed4066b05506a78ce8ea6ff1a0a708e5e6fa42aa
+  metadata.gz: 5e10d6f4cf3e8f9bc0cf499261647cd167eb5bed0296c97d79263408b4f82b371904da23927e6853ddf2d5643137a513b9f947ce2c3593f3b7b89d602baae21e
+  data.tar.gz: 8b3e07023d3001002650fd4489aa130d1350093f4e604ba3ee5a33fa71c916618f2fc14d037c5e4eb737823e64ebc054166db2b6643b0e832c906210e85fd6c6

data/.rubocop.yml

@@ -65,6 +65,7 @@ RSpec/MultipleExpectations:
 
 # FIXME: Update specs to avoid offenses
 RSpec/NestedGroups:
+  MaxNesting: 3
   Exclude:
     - 'spec/reek/cli/application_spec.rb'
 

data/.travis.yml

@@ -21,6 +21,8 @@ matrix:
     - rvm: rbx-2
     - rvm: ruby-head
   fast_finish: true
+before_install:
+  - gem install bundler
 notifications:
   email:
     - timo.roessner@googlemail.com

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.5.4 (2017-01-17)
+
+* (troessner) Improve documentation and fix PrimaDonnaMethod detector configuration via comment.
+
 ## 4.5.3 (2016-12-05)
 
 * (jhubert) Stop reporting FeatureEnvy with super and arguments.

data/Dockerfile

@@ -3,7 +3,7 @@
 # Build and run via:
 #   docker build -t codeclimate/codeclimate-reek . && docker run codeclimate/codeclimate-reek
 
-FROM codeclimate/alpine-ruby:b38
+FROM ruby:2.3.3-alpine
 
 MAINTAINER The Reek core team
 
@@ -12,17 +12,17 @@ ENV app_dir /usr/src/app
 ENV user app
 
 RUN apk --update add git
-
 ADD . ${app_dir}
 
+RUN adduser -u 9000 -D ${user}
+RUN chown -R ${user}:${user} ${app_dir}
+USER ${user}
+
 WORKDIR ${app_dir}
 
 RUN bundle install --without debugging development
-RUN adduser -u 9000 -D ${user}
-RUN chown -R ${user}:${user} ${app_dir}
 
 VOLUME ${code_dir}
 WORKDIR ${code_dir}
-USER ${user}
 
 CMD [ "/usr/src/app/bin/code_climate_reek" ]

data/Gemfile

@@ -2,25 +2,27 @@ source 'https://rubygems.org'
 
 gemspec
 
+ruby RUBY_VERSION
+
 group :development do
+  gem 'activesupport', '>= 4.2'
   gem 'aruba',         '~> 0.14.0'
   gem 'ataru',         '~> 0.2.0'
   gem 'cucumber',      '~> 2.0'
   gem 'factory_girl',  '~> 4.0'
   gem 'mutant-rspec',  '~> 0.8.8'
-  gem 'rake',          '~> 11.1'
+  gem 'rake',          '~> 12.0'
   gem 'rspec',         '~> 3.0'
   gem 'simplecov',     '~> 0.12.0'
   gem 'yard',          '~> 0.9.5'
-  gem 'activesupport', '~> 4.2'
 
   if RUBY_VERSION >= '2.3'
-    gem 'rubocop',       '~> 0.45.0'
-    gem 'rubocop-rspec', '~> 1.7'
+    gem 'rubocop',       '~> 0.46.0'
+    gem 'rubocop-rspec', '~> 1.9.0'
   end
 
   platforms :mri do
-    gem 'redcarpet', '~> 3.3.1'
+    gem 'redcarpet', '~> 3.4.0'
   end
 end
 

data/docs/Prima-Donna-Method.md

@@ -61,3 +61,30 @@ method `foo` of the `Dangerous` module.
 ## Configuration
 
 _Prima Donna Method_ offers the [Basic Smell Options](Basic-Smell-Options.md).
+
+## Example configuration via source comment
+
+Imagine code like this:
+
+```Ruby
+class Alfa
+  def bravo!
+  end
+end
+```
+
+This would report:
+
+>>
+ruby.rb -- 1 warning:
+  [1]:PrimaDonnaMethod: Alfa has prima donna method 'bravo!'
+
+If you want to suppress this warning you can do this via source comment like this:
+
+```Ruby
+# :reek:PrimaDonnaMethod: { exclude: [ bravo! ] }
+class Alfa
+  def bravo!
+  end
+end
+```

data/docs/Unused-Private-Method.md

@@ -48,6 +48,33 @@ 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

data/features/command_line_interface/options.feature

@@ -41,7 +41,9 @@ Feature: Reek can be controlled using command-line options
 
       Configuration:
           -c, --config FILE                Read configuration options from FILE
-              --smell SMELL                Detect smell SMELL (default: all enabled smells)
+              --smell SMELL                Only look for a specific smell.
+                                           Call it like this: reek --smell PrimaDonnaMethod source.rb
+                                           Check out https://github.com/troessner/reek/blob/master/docs/Code-Smells.md for a list of smells
 
       Generate a todo list:
           -t, --todo                       Generate a todo list

data/lib/reek/ast/reference_collector.rb

@@ -6,8 +6,6 @@ module Reek
     # of an abstract syntax tree.
     #
     class ReferenceCollector
-      STOP_NODES = [:class, :module, :def, :defs].freeze
-
       def initialize(ast)
         @ast = ast
       end
@@ -22,12 +20,12 @@ module Reek
 
       def explicit_self_calls
         [:self, :super, :zsuper, :ivar, :ivasgn].flat_map do |node_type|
-          ast.each_node(node_type, STOP_NODES)
+          ast.each_node(node_type)
         end
       end
 
       def implicit_self_calls
-        ast.each_node(:send, STOP_NODES).reject(&:receiver)
+        ast.each_node(:send).reject(&:receiver)
       end
     end
   end

data/lib/reek/cli/options.rb

@@ -95,7 +95,11 @@ module Reek
         parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
           self.config_file = Pathname.new(file)
         end
-        parser.on('--smell SMELL', 'Detect smell SMELL (default: all enabled smells)') do |smell|
+        parser.on('--smell SMELL',
+                  'Only look for a specific smell.',
+                  'Call it like this: reek --smell PrimaDonnaMethod source.rb',
+                  'Check out https://github.com/troessner/reek/blob/master/docs/Code-Smells.md '\
+                  'for a list of smells') do |smell|
           smells_to_detect << smell
         end
       end

data/lib/reek/context/ghost_context.rb

@@ -40,8 +40,7 @@ module Reek
                                             names: names
       end
 
-      def track_singleton_visibility(_visibility, _names)
-      end
+      def track_singleton_visibility(_visibility, _names); end
 
       def record_use_of_self
         parent.record_use_of_self

data/lib/reek/smell_detectors/prima_donna_method.rb

@@ -28,6 +28,24 @@ module Reek
         [:class]
       end
 
+      #
+      # @param ctx [Context::ModuleContext]
+      # @return [Array<SmellWarning>]
+      #
+      # Given this code:
+      #
+      # class Alfa
+      #   def bravo!
+      #   end
+      # end
+      #
+      # An example `ctx` could look like this:
+      #
+      # s(:class,
+      #   s(:const, nil, :Alfa), nil,
+      #     s(:def, :bravo!,
+      #       s(:args), nil))
+      #
       def sniff(ctx)
         ctx.node_instance_methods.select do |method_sexp|
           prima_donna_method?(method_sexp, ctx)
@@ -45,6 +63,7 @@ module Reek
 
       def prima_donna_method?(method_sexp, ctx)
         return false unless method_sexp.ends_with_bang?
+        return false if ignore_method?(method_sexp, ctx)
         return false if version_without_bang_exists?(method_sexp, ctx)
         true
       end
@@ -55,6 +74,17 @@ module Reek
           sexp_item.name.to_s == method_sexp.name_without_bang
         end
       end
+
+      #
+      # @param method_node [Reek::AST::Node],
+      #   e.g. s(:def, :bravo!, s(:args), nil)
+      # @param ctx [Context::ModuleContext]
+      # @return [Boolean]
+      #
+      def ignore_method?(method_node, ctx)
+        ignore_method_names = value(EXCLUDE_KEY, ctx) # e.g. ["bravo!"]
+        ignore_method_names.include? method_node.name.to_s # method_node.name is e.g.: :bravo!
+      end
     end
   end
 end

data/lib/reek/version.rb

@@ -7,6 +7,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.5.3'.freeze
+    STRING = '4.5.4'.freeze
   end
 end

data/spec/reek/ast/reference_collector_spec.rb

@@ -43,22 +43,5 @@ RSpec.describe Reek::AST::ReferenceCollector do
     it 'ignores global variables' do
       expect(refs_to_self('def no_envy(arga) $s2.to_a; $s2[arga] end')).to eq(0)
     end
-
-    it 'ignores global variables' do
-      src = <<-EOS
-        def accept(t, pat = /.*/nm, &block)
-          if pat
-            pat.respond_to?(:match) or raise TypeError, "has no `match'"
-          else
-            pat = t if t.respond_to?(:match)
-          end
-          unless block
-            block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
-          end
-          @atype[t] = [pat, block]
-        end
-      EOS
-      expect(refs_to_self(src)).to eq(2)
-    end
   end
 end

data/spec/reek/smell_detectors/prima_donna_method_spec.rb

@@ -47,4 +47,16 @@ RSpec.describe Reek::SmellDetectors::PrimaDonnaMethod do
 
     expect(src).not_to reek_of(:PrimaDonnaMethod)
   end
+
+  it 'does not report methods we excluded via comment' do
+    source = <<-EOF
+      # :reek:PrimaDonnaMethod: { exclude: [ bravo! ] }
+      class Alfa
+        def bravo!
+        end
+      end
+    EOF
+
+    expect(source).not_to reek_of(:PrimaDonnaMethod)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.5.3
+  version: 4.5.4
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb