reek 4.5.0 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f44c19009380c9dff7c4d8ef4dcdbe6f788d46b2
-  data.tar.gz: b9cfe47dc250a613611f414463a6dbca748690c8
+  metadata.gz: e73dfbe510f33f5080c142589e06141d394590c4
+  data.tar.gz: c97e989ed22ab395217099122515d0b1e02ca8e2
 SHA512:
-  metadata.gz: 221c0dbe79b6a6758a30ded23285fd715634843c3ac9bb0b9883aef9a0ebffcf84531dc6e492f091b2fa11cb7087470c96632aa45b53704da831a0a64feb7c1a
-  data.tar.gz: 51c17f02b1aa2c8ff8cf701ba7bc9d98c058a9c4e62fc2b6f246fd43f3be17ed12b6cc58ccb247f99527f909db50c5b4ab7085b08392a4b2c9e26137c8081bb2
+  metadata.gz: 27c163213eee8653498e261dc44b3e6b8a1c7e9a17dfeb19bafdd914a7b7ec741168cc1f1505b71b7f8653c8eff889dbb0cbb3f953220bd46876ca4a12e310d4
+  data.tar.gz: 3884c786a8deda2eab21427011f595b0484c61075ab96beb759bbe1ecbefc92f244650a9ef045850ce261783ef397516d5cf8fd16956cbdec16ab712fe86546b

data/.rubocop.yml

@@ -74,6 +74,7 @@ RSpec/VerifiedDoubles:
 # rubocop-rspec expects a CodeClimate namespace to go with the code_climate directory.
 RSpec/FilePath:
   Exclude:
+    - 'spec/reek/report/code_climate/code_climate_configuration_spec.rb'
     - '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'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.5.1 (2016-10-16)
+
+* (troessner) Validate configuration keys in code comments.
+
 ## 4.5.0 (2016-10-12)
 
 * (maxjacobson) Emit fingerprints in Code Climate reporter

data/features/configuration_via_source_comments/erroneous_source_comments.feature

@@ -51,3 +51,18 @@ Feature: Erroneous source comments are handled properly
     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"
+
+  Scenario: Bad configuration key
+    Given a file named "bad_comment.rb" with:
+      """
+      # Test class
+      # exclude -> elude and accept -> accipt are bad keys
+      # :reek:UncommunicativeMethodName { elude: 'foo', accipt: 'bar' }
+      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 "in one of your source code comments with the unknown option 'elude', 'accipt'"
+    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 4"

data/lib/reek/code_comment.rb

@@ -4,6 +4,7 @@ require 'yaml'
 
 require_relative 'smell_detectors/base_detector'
 require_relative 'errors/bad_detector_in_comment_error'
+require_relative 'errors/bad_detector_configuration_key_in_comment_error'
 require_relative 'errors/garbage_detector_configuration_in_comment_error'
 
 module Reek
@@ -75,10 +76,10 @@ module Reek
     # 2.) Garbage in the detector configuration like { thats: a: bad: config }
     # 3.) Unknown configuration keys (e.g. by doing a simple typo: "exclude" vs. "exlude" )
     # 4.) Bad data types given as values for those keys
-    # This class validates [1] and [2] at the moment but will also validate [3]
-    # and [4] in the future.
+    # This class validates [1], [2] and [3] at the moment but will also validate
+    # [4] in the future.
     #
-    # :reek:TooManyInstanceVariables: { max_instance_variables: 5 }
+    # :reek:TooManyInstanceVariables: { max_instance_variables: 7 }
     class CodeCommentValidator
       #
       # @param detector_name [String] - the detector class that was parsed out of the original
@@ -94,16 +95,20 @@ module Reek
         @line             = line
         @source           = source
         @options          = options
+        @detector_class   = nil # We only know this one after our first initial checks
+        @parsed_options   = nil # We only know this one after our first initial checks
       end
 
       #
       # Method can raise the following errors:
       #   * Errors::BadDetectorInCommentError
       #   * Errors::GarbageDetectorConfigurationInCommentError
+      #   * Errors::BadDetectorConfigurationKeyInCommentError
       # @return [undefined]
       def validate
         escalate_bad_detector
         escalate_bad_detector_configuration
+        escalate_unknown_configuration_key
       end
 
       private
@@ -112,7 +117,9 @@ module Reek
                   :original_comment,
                   :line,
                   :source,
-                  :options
+                  :options,
+                  :detector_class,
+                  :parsed_options
 
       def escalate_bad_detector
         return if SmellDetectors::BaseDetector.valid_detector?(detector_name)
@@ -123,13 +130,46 @@ module Reek
       end
 
       def escalate_bad_detector_configuration
-        YAML.load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION)
+        @parsed_options = YAML.load(options || CodeComment::DISABLE_DETECTOR_CONFIGURATION)
       rescue Psych::SyntaxError
         raise Errors::GarbageDetectorConfigurationInCommentError, detector_name: detector_name,
                                                                   original_comment: original_comment,
                                                                   source: source,
                                                                   line: line
       end
+
+      def escalate_unknown_configuration_key
+        @detector_class = SmellDetectors::BaseDetector.to_detector(detector_name)
+
+        return if given_keys_legit?
+        raise Errors::BadDetectorConfigurationKeyInCommentError, detector_name: detector_name,
+                                                                 offensive_keys: configuration_keys_difference,
+                                                                 original_comment: original_comment,
+                                                                 source: source,
+                                                                 line: line
+      end
+
+      # @return [Boolean] - all keys in code comment are applicable to the detector in question
+      def given_keys_legit?
+        given_configuration_keys.subset? valid_detector_keys
+      end
+
+      # @return [Set] - the configuration keys that are found in the code comment
+      def given_configuration_keys
+        parsed_options.keys.map(&:to_sym).to_set
+      end
+
+      # @return [String] - all keys from the code comment that look bad
+      def configuration_keys_difference
+        given_configuration_keys.difference(valid_detector_keys).
+          to_a.map { |key| "'#{key}'" }.
+          join(', ')
+      end
+
+      # @return [Set] - all keys that are legit for the given detector
+      def valid_detector_keys
+        detector_class.configuration_keys
+      end
     end
   end
 end

data/lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Reek
+  module Errors
+    # Gets raised when trying to configure a detector with an option
+    # which is unknown to it.
+    class BadDetectorConfigurationKeyInCommentError < RuntimeError
+      UNKNOWN_SMELL_DETECTOR_MESSAGE = <<-EOS.freeze
+
+        Error: You are trying to configure the smell detector '%s'
+        in one of your source code comments with the unknown option %s.
+        The source is '%s' and the comment belongs to the expression starting in line %d.
+        Here's the original 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
+          * 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.
+
+      EOS
+
+      def initialize(detector_name:, offensive_keys:, source:, line:, original_comment:)
+        message = format(UNKNOWN_SMELL_DETECTOR_MESSAGE,
+                         detector_name,
+                         offensive_keys,
+                         source,
+                         line,
+                         original_comment)
+        super message
+      end
+    end
+  end
+end

data/lib/reek/examiner.rb

@@ -121,7 +121,8 @@ module Reek
       begin
         examine_tree
       rescue Errors::BadDetectorInCommentError,
-             Errors::GarbageDetectorConfigurationInCommentError => exception
+             Errors::GarbageDetectorConfigurationInCommentError,
+             Errors::BadDetectorConfigurationKeyInCommentError => exception
         warn exception
         []
       rescue StandardError => exception

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Reek
+  module Report
+    # loads the smell type metadata to present in Code Climate
+    module CodeClimateConfiguration
+      def self.load
+        config_file = File.expand_path('../code_climate_configuration.yml', __FILE__)
+        YAML.load_file config_file
+      end
+    end
+  end
+end

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

@@ -222,6 +222,135 @@ FeatureEnvy:
     ```
 
     belongs to the Item class, not the Warehouse.
+InstanceVariableAssumption:
+  remediation_points: 350_000
+  content: |
+    Classes should not assume that instance variables are set or present outside of the current class definition.
+
+    Good:
+
+    ```Ruby
+    class Foo
+      def initialize
+        @bar = :foo
+      end
+
+      def foo?
+        @bar == :foo
+      end
+    end
+    ```
+
+    Good as well:
+
+    ```Ruby
+    class Foo
+      def foo?
+        bar == :foo
+      end
+
+      def bar
+        @bar ||= :foo
+      end
+    end
+    ```
+
+    Bad:
+
+    ```Ruby
+    class Foo
+      def go_foo!
+        @bar = :foo
+      end
+
+      def foo?
+        @bar == :foo
+      end
+    end
+    ```
+
+    ## Example
+
+    Running Reek on:
+
+    ```Ruby
+    class Dummy
+      def test
+        @ivar
+      end
+    end
+    ```
+
+    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]
+    ```
+
+    Note that this example would trigger this smell warning as well:
+
+    ```Ruby
+    class Parent
+      def initialize(omg)
+        @omg = omg
+      end
+    end
+
+    class Child < Parent
+      def foo
+        @omg
+      end
+    end
+    ```
+
+    The way to address the smell warning is that you should create an `attr_reader` to use `@omg` in the subclass and not access `@omg` directly like this:
+
+    ```Ruby
+    class Parent
+      attr_reader :omg
+
+      def initialize(omg)
+        @omg = omg
+      end
+    end
+
+    class Child < Parent
+      def foo
+        omg
+      end
+    end
+    ```
+
+    Directly accessing instance variables is considered a smell because it [breaks encapsulation](http://designisrefactoring.com/2015/03/29/organizing-data-self-encapsulation/) and makes it harder to reason about code.
+
+    If you don't want to expose those methods as public API just make them private like this:
+
+    ```Ruby
+    class Parent
+      def initialize(omg)
+        @omg = omg
+      end
+
+      private
+      attr_reader :omg
+    end
+
+    class Child < Parent
+      def foo
+        omg
+      end
+    end
+    ```
+
+
+    ## Current Support in Reek
+
+    An instance variable must:
+
+    * be set in the constructor
+    * or be accessed through a method with lazy initialization / memoization.
+
+    If not, _Instance Variable Assumption_ will be reported.
 IrresponsibleModule:
   remediation_points: 350_000
   content: |
@@ -300,6 +429,33 @@ LongYieldList:
     ```
 
     A common solution to this problem would be the introduction of parameter objects.
+ManualDispatch:
+  remediation_points: 350_000
+  content: |
+    Reek reports a _Manual Dispatch_ smell if it finds source code that manually checks whether an object responds to a method before that method is called. Manual dispatch is a type of [Simulated Polymorphism](Simulated-Polymorphism.md) which leads to code that is harder to reason about, debug, and refactor.
+
+    ## Example
+
+    ```Ruby
+    class MyManualDispatcher
+      attr_reader :foo
+
+      def initialize(foo)
+        @foo = foo
+      end
+
+      def call
+        foo.bar if foo.respond_to?(:bar)
+      end
+    end
+    ```
+
+    Reek would emit the following warning:
+
+    ```
+    test.rb -- 1 warning:
+      [9]: MyManualDispatcher manually dispatches method call (ManualDispatch)
+    ```
 ModuleInitialize:
   remediation_points: 350_000
   content: |

data/lib/reek/report/code_climate/code_climate_fingerprint.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'digest'
+
 module Reek
   module Report
     # Generates a string to uniquely identify a smell
@@ -14,7 +16,7 @@ module Reek
 
         identify_warning
 
-        identifying_aspects.hexdigest
+        identifying_aspects.hexdigest.freeze
       end
 
       private
@@ -33,7 +35,7 @@ module Reek
       end
 
       def parameters
-        warning.parameters.except(*NON_IDENTIFYING_PARAMETERS).sort.to_s
+        warning.parameters.reject { |key, _| NON_IDENTIFYING_PARAMETERS.include?(key) }.sort.to_s
       end
 
       def warning_uniquely_identifiable?

data/lib/reek/report/code_climate/code_climate_formatter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 require 'codeclimate_engine'
+require_relative 'code_climate_configuration'
 
 module Reek
   module Report
@@ -56,8 +57,7 @@ module Reek
 
       def configuration
         @configuration ||= begin
-          config_file = File.expand_path('../code_climate_configuration.yml', __FILE__)
-          YAML.load_file config_file
+          CodeClimateConfiguration.load
         end
       end
     end

data/lib/reek/smell_detectors/base_detector.rb

@@ -14,6 +14,7 @@ module Reek
     # for details.
     #
     # :reek:UnusedPrivateMethod: { exclude: [ smell_warning ] }
+    # :reek:TooManyMethods: { max_methods: 18 }
     class BaseDetector
       attr_reader :config
       # The name of the config field that lists the names of code contexts
@@ -122,6 +123,24 @@ module Reek
           descendants.map { |descendant| descendant.to_s.split('::').last }.
             include?(detector)
         end
+
+        #
+        # Transform a detector name to the corresponding constant.
+        # Note that we assume a valid name - exceptions are not handled here.
+        #
+        # @param detector_name [String] the detector in question, e.g. 'DuplicateMethodCall'
+        # @return [SmellDetector] - this will return the class, not an instance
+        #
+        def to_detector(detector_name)
+          SmellDetectors.const_get detector_name
+        end
+
+        #
+        # @return [Set<Symbol>] - all configuration keys that are available for this detector
+        #
+        def configuration_keys
+          Set.new(default_config.keys.map(&:to_sym))
+        end
       end
     end
   end

data/lib/reek/version.rb

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

data/spec/reek/code_comment_spec.rb

@@ -142,4 +142,44 @@ RSpec.describe Reek::CodeComment::CodeCommentValidator do
       end.to raise_error(Reek::Errors::GarbageDetectorConfigurationInCommentError)
     end
   end
+
+  describe 'validating configuration keys' do
+    context 'basic options mispelled' do
+      it 'raises BadDetectorConfigurationKeyInCommentError' do
+        expect do
+          # exclude -> exlude and enabled -> nabled
+          comment = '# :reek:UncommunicativeMethodName { exlude: alfa, nabled: true }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
+      end
+    end
+
+    context 'basic options not mispelled' do
+      it 'does not raise' do
+        expect do
+          comment = '# :reek:UncommunicativeMethodName { exclude: alfa, enabled: true }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.not_to raise_error
+      end
+    end
+
+    context 'unknown custom options' do
+      it 'raises BadDetectorConfigurationKeyInCommentError' do
+        expect do
+          # max_copies -> mx_copies and min_clump_size -> mn_clump_size
+          comment = '# :reek:DataClump { mx_copies: 4, mn_clump_size: 3 }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.to raise_error(Reek::Errors::BadDetectorConfigurationKeyInCommentError)
+      end
+    end
+
+    context 'valid custom options' do
+      it 'does not raise' do
+        expect do
+          comment = '# :reek:DataClump { max_copies: 4, min_clump_size: 3 }'
+          FactoryGirl.build(:code_comment, comment: comment)
+        end.not_to raise_error
+      end
+    end
+  end
 end

data/spec/reek/report/code_climate/code_climate_configuration_spec.rb

@@ -0,0 +1,24 @@
+require_relative '../../../spec_helper'
+require_lib 'reek/report/code_climate/code_climate_configuration'
+
+RSpec.describe Reek::Report::CodeClimateConfiguration do
+  yml = described_class.load
+  smell_types = Reek::SmellDetectors::BaseDetector.descendants.map do |descendant|
+    descendant.name.demodulize
+  end
+
+  smell_types.each do |name|
+    config = yml.fetch(name)
+    it "provides remediation_points for #{name}" do
+      expect(config['remediation_points']).to be_a Fixnum
+    end
+
+    it "provides content for #{name}" do
+      expect(config['content']).to be_a String
+    end
+  end
+
+  it 'does not include extraneous configuration' do
+    expect(smell_types).to match_array(yml.keys)
+  end
+end

data/spec/reek/smell_detectors/base_detector_spec.rb

@@ -1,5 +1,6 @@
 require_relative '../../spec_helper'
 require_lib 'reek/smell_detectors/base_detector'
+require_lib 'reek/smell_detectors/duplicate_method_call'
 
 RSpec.describe Reek::SmellDetectors::BaseDetector do
   describe '.todo_configuration_for' do
@@ -43,4 +44,21 @@ RSpec.describe Reek::SmellDetectors::BaseDetector do
       expect(described_class.valid_detector?('Unknown')).to be false
     end
   end
+
+  describe '.to_detector' do
+    it 'returns the right detector' do
+      expect(described_class.to_detector('DuplicateMethodCall')).to eq(Reek::SmellDetectors::DuplicateMethodCall)
+    end
+
+    it 'raise NameError for an invalid detector name' do
+      expect { described_class.to_detector('Unknown') }.to raise_error(NameError)
+    end
+  end
+
+  describe '.configuration_keys' do
+    it 'returns the right keys' do
+      expected_keys = Reek::SmellDetectors::DuplicateMethodCall.configuration_keys.to_a
+      expect(expected_keys).to eq([:enabled, :exclude, :max_calls, :allow_calls])
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.5.1
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2016-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -220,6 +220,7 @@ files:
 - lib/reek/context/statement_counter.rb
 - lib/reek/context/visibility_tracker.rb
 - lib/reek/context_builder.rb
+- lib/reek/errors/bad_detector_configuration_key_in_comment_error.rb
 - lib/reek/errors/bad_detector_in_comment_error.rb
 - lib/reek/errors/garbage_detector_configuration_in_comment_error.rb
 - lib/reek/examiner.rb
@@ -227,6 +228,7 @@ files:
 - lib/reek/report.rb
 - lib/reek/report/base_report.rb
 - lib/reek/report/code_climate.rb
+- lib/reek/report/code_climate/code_climate_configuration.rb
 - lib/reek/report/code_climate/code_climate_configuration.yml
 - lib/reek/report/code_climate/code_climate_fingerprint.rb
 - lib/reek/report/code_climate/code_climate_formatter.rb
@@ -344,6 +346,7 @@ files:
 - spec/reek/context_builder_spec.rb
 - spec/reek/examiner_spec.rb
 - spec/reek/rake/task_spec.rb
+- spec/reek/report/code_climate/code_climate_configuration_spec.rb
 - 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