reek 4.8.1 → 4.8.2

data/features/support/env.rb

@@ -13,11 +13,11 @@ end
 #
 class ReekWorld
   def reek(args)
-    run_simple("reek --no-color #{args}", false)
+    run_simple("reek --no-color --no-wiki-links #{args}", false)
   end
 
   def reek_with_pipe(stdin, args)
-    run "reek --no-color #{args}"
+    run "reek --no-color --no-wiki-links #{args}"
     type(stdin)
     close_input
   end

data/features/todo_list.feature

@@ -15,8 +15,8 @@ Feature: Auto-generate a todo file
     And it reports:
       """
       smelly.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]
+        [4]:UncommunicativeMethodName: Smelly#x has the name 'x'
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
     When I run reek --todo smelly.rb
     Then it succeeds
@@ -59,15 +59,15 @@ Feature: Auto-generate a todo file
       UncommunicativeMethodName:
         enabled: false
       """
-    When I run `reek -c .todo.reek smelly.rb`
+    When I run reek -c .todo.reek smelly.rb
     Then it reports:
       """
       smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
-    When I run `reek --todo smelly.rb`
+    When I run reek --todo smelly.rb
     Then it succeeds
-    When I run `reek -c .todo.reek smelly.rb`
+    When I run reek -c .todo.reek smelly.rb
     Then it reports nothing
 
   Scenario: Ignore existing other configuration files that are passed explicitly
@@ -80,13 +80,13 @@ Feature: Auto-generate a todo file
       UncommunicativeMethodName:
         enabled: false
       """
-    When I run `reek -c config.reek smelly.rb`
+    When I run reek -c config.reek smelly.rb
     Then it reports:
       """
       smelly.rb -- 1 warning:
-        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
+        [5]:UncommunicativeVariableName: Smelly#x has the variable name 'y'
       """
-    When I run `reek -c config.reek --todo smelly.rb`
+    When I run reek -c config.reek --todo smelly.rb
     Then it succeeds
-    When I run `reek -c .todo.reek smelly.rb`
+    When I run reek -c .todo.reek smelly.rb
     Then it reports nothing

data/lib/reek/cli/options.rb

@@ -4,6 +4,7 @@ require 'optparse'
 require 'rainbow'
 require_relative '../version'
 require_relative 'status'
+require_relative '../documentation_link'
 
 module Reek
   module CLI
@@ -105,7 +106,7 @@ module Reek
         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 '\
+                  "Check out #{DocumentationLink.build('Code Smells')} "\
                   'for a list of smells') do |smell|
           smells_to_detect << smell
         end

data/lib/reek/documentation_link.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Reek
+  # Generate versioned links to our documentation
+  module DocumentationLink
+    HELP_LINK_TEMPLATE = 'https://github.com/troessner/reek/blob/v%<version>s/docs/%<item>s.md'.freeze
+
+    module_function
+
+    # Build link to the documentation about the given subject for the current
+    # version of Reek. The subject can be either a smell type like
+    # 'FeatureEnvy' or a general subject like 'Rake Task'.
+    #
+    # @param subject [String]
+    # @return [String] - the full URL for the relevant documentation
+    def build(subject)
+      Kernel.format(HELP_LINK_TEMPLATE, version: Version::STRING, item: name_to_param(subject))
+    end
+
+    # Convert the given subject name to a form that is acceptable in a URL.
+    def name_to_param(name)
+      # Splits the subject on the start of capitalized words, optionally
+      # preceded by a space. The space is discarded, the start of the word is
+      # not.
+      name.split(/ *(?=[A-Z][a-z])/).join('-')
+    end
+  end
+end

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
@@ -17,8 +18,8 @@ module Reek
         %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what basic options are available: https://github.com/troessner/reek/blob/master/docs/Basic-Smell-Options.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what basic options are available: #{DocumentationLink.build('Basic Smell Options')}
           * what custom options are available by checking the detector specific documentation in /docs
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 

data/lib/reek/errors/bad_detector_in_comment_error.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
@@ -18,8 +19,8 @@ module Reek
         %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what smell detectors are available: #{DocumentationLink.build('Code Smells')}
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
       MESSAGE

data/lib/reek/errors/garbage_detector_configuration_in_comment_error.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'base_error'
+require_relative '../documentation_link'
 
 module Reek
   module Errors
@@ -17,8 +18,8 @@ module Reek
         %<comment>s
 
         Please see the Reek docs for:
-          * how to configure Reek via source code comments: https://github.com/troessner/reek/blob/master/docs/Smell-Suppression.md
-          * what smell detectors are available: https://github.com/troessner/reek/blob/master/docs/Code-Smells.md
+          * how to configure Reek via source code comments: #{DocumentationLink.build('Smell Suppression')}
+          * what smell detectors are available: #{DocumentationLink.build('Code Smells')}
         Update the offensive comment (or remove it if no longer applicable) and re-run Reek.
 
       MESSAGE

data/lib/reek/report/code_climate/code_climate_configuration.yml

@@ -284,7 +284,7 @@ InstanceVariableAssumption:
     would report:
 
     ```Bash
-      [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar [https://github.com/troessner/reek/blob/master/docs/Instance-Variable-Assumption.md]
+      [1]:InstanceVariableAssumption: Dummy assumes too much for instance variable @ivar
     ```
 
     Note that this example would trigger this smell warning as well:

data/lib/reek/report/formatter/wiki_link_warning_formatter.rb

@@ -10,25 +10,12 @@ module Reek
       # SimpleWarningFormatter.
       #
       class WikiLinkWarningFormatter < SimpleWarningFormatter
-        BASE_URL_FOR_HELP_LINK = 'https://github.com/troessner/reek/blob/master/docs/'.freeze
-
         def format(warning)
-          "#{super} [#{explanatory_link(warning)}]"
+          "#{super} [#{warning.explanatory_link}]"
         end
 
         def format_hash(warning)
-          super.merge('wiki_link' => explanatory_link(warning))
-        end
-
-        private
-
-        def explanatory_link(warning)
-          "#{BASE_URL_FOR_HELP_LINK}#{class_name_to_param(warning.smell_type)}.md"
-        end
-
-        # :reek:UtilityFunction
-        def class_name_to_param(name)
-          name.split(/(?=[A-Z])/).join('-')
+          super.merge('wiki_link' => warning.explanatory_link)
         end
       end
     end

data/lib/reek/smell_detectors/feature_envy.rb

@@ -43,6 +43,7 @@ module Reek
       # @return [Array<SmellWarning>]
       #
       def sniff
+        return [] if context.singleton_method? || context.module_function?
         return [] unless context.references_self?
         envious_receivers.map do |name, lines|
           smell_warning(

data/lib/reek/smell_warning.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'forwardable'
+require_relative 'documentation_link'
 
 module Reek
   #
@@ -65,6 +66,10 @@ module Reek
       smell_detector.class
     end
 
+    def explanatory_link
+      DocumentationLink.build(smell_type)
+    end
+
     protected
 
     def identifying_values

data/lib/reek/version.rb

@@ -8,6 +8,6 @@ module Reek
   # @public
   module Version
     # @public
-    STRING = '4.8.1'.freeze
+    STRING = '4.8.2'.freeze
   end
 end

data/spec/reek/documentation_link_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../spec_helper'
+
+RSpec.describe Reek::DocumentationLink do
+  describe '.build' do
+    it 'returns the correct link for a smell type' do
+      expect(described_class.build('FeatureEnvy')).
+        to eq "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Feature-Envy.md"
+    end
+
+    it 'returns the correct link for general documentation' do
+      expect(described_class.build('Rake Task')).
+        to eq "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Rake-Task.md"
+    end
+
+    it 'returns the correct link for subjects with abbreviations' do
+      expect(described_class.build('YAML Report')).
+        to eq "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/YAML-Report.md"
+    end
+  end
+end

data/spec/reek/report/json_report_spec.rb

@@ -71,7 +71,7 @@ RSpec.describe Reek::Report::JSONReport do
               "smell_type":     "UncommunicativeParameterName",
               "source":         "string",
               "name":           "a",
-              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
+              "wiki_link":      "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Uncommunicative-Parameter-Name.md"
             },
             {
               "context":        "simple",
@@ -79,7 +79,7 @@ RSpec.describe Reek::Report::JSONReport do
               "message":        "doesn't depend on instance state (maybe move it to another class?)",
               "smell_type":     "UtilityFunction",
               "source":         "string",
-              "wiki_link":      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
+              "wiki_link":      "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
             }
           ]
         EOS

data/spec/reek/report/yaml_report_spec.rb

@@ -67,14 +67,14 @@ RSpec.describe Reek::Report::YAMLReport do
             smell_type:     "UncommunicativeParameterName"
             source:         "string"
             name:           "a"
-            wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Parameter-Name.md"
+            wiki_link:      "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Uncommunicative-Parameter-Name.md"
           - context:        "simple"
             lines:
             - 1
             message:        "doesn't depend on instance state (maybe move it to another class?)"
             smell_type:     "UtilityFunction"
             source:         "string"
-            wiki_link:      "https://github.com/troessner/reek/blob/master/docs/Utility-Function.md"
+            wiki_link:      "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Utility-Function.md"
         EOS
 
         expect(result).to eq expected

data/spec/reek/smell_detectors/feature_envy_spec.rb

@@ -247,4 +247,49 @@ RSpec.describe Reek::SmellDetectors::FeatureEnvy do
 
     expect(src).not_to reek_of(:FeatureEnvy)
   end
+
+  it 'does not report on class methods defined by opening the metaclass' do
+    src = <<-EOS
+      class Alfa
+        class << self
+          def bravo(charlie)
+            delta = new(charlie)
+            delta.echo
+            delta.echo
+          end
+        end
+      end
+    EOS
+
+    expect(src).not_to reek_of(:FeatureEnvy)
+  end
+
+  it 'does not report on class methods defined with an explicit receiver' do
+    src = <<-EOS
+      class Alfa
+        def self.bravo(charlie)
+          delta = new(charlie)
+          delta.echo
+          delta.echo
+        end
+      end
+    EOS
+
+    expect(src).not_to reek_of(:FeatureEnvy)
+  end
+
+  it 'does not report module functions' do
+    src = <<-EOF
+      module Alfa
+        module_function
+        def bravo(charlie)
+          echo = delta(charlie)
+          echo.foxtrot
+          echo.foxtrot
+        end
+      end
+    EOF
+
+    expect(src).not_to reek_of(:FeatureEnvy)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.8.1
+  version: 4.8.2
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -235,6 +235,7 @@ files:
 - lib/reek/context/visibility_tracker.rb
 - lib/reek/context_builder.rb
 - lib/reek/detector_repository.rb
+- lib/reek/documentation_link.rb
 - lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb
 - lib/reek/errors/bad_detector_in_comment_error.rb
 - lib/reek/errors/base_error.rb
@@ -366,6 +367,7 @@ files:
 - spec/reek/context/statement_counter_spec.rb
 - spec/reek/context_builder_spec.rb
 - spec/reek/detector_repository_spec.rb
+- spec/reek/documentation_link_spec.rb
 - spec/reek/errors/base_error_spec.rb
 - spec/reek/examiner_spec.rb
 - spec/reek/logging_error_handler_spec.rb