reek 4.1.1 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd5651b2cc5c8b32a2eb8d1297c190b67ebf3f6b
-  data.tar.gz: 948781b5c00280ff13499c1a31cf634f495e5736
+  metadata.gz: 300e8430e0cb4dcd0ca01529abb40921ed54f29f
+  data.tar.gz: c844e886e736762ddb4d61cdcf5bc5931aabc041
 SHA512:
-  metadata.gz: 16653eda1cae7ac27cf6f439f45b8d2f77e8c954bd9e989cd70fdfa0c5c553cebb3caa97bb6a8696312a5029120455a7e7c45e20a46b42b3823d77c25abc3a2d
-  data.tar.gz: ecc7e1105e00ae9e6f284889ad5fc58e19eee73d79fde9f6c6ae9194ed6ad2b29c06006e3eee8e74356a4f629b04cfb001ab6e8ea9c7ad1dc4e263051a1edb83
+  metadata.gz: 287000e19154d5d0fff6a0996a175eeb4ff091506b19487dd126d3b858a2513d21afa284a2a603791b8c1e7a8e4538c0c3d75c213f3e04264e6e59deedcb3837
+  data.tar.gz: 7e67159cc8a61f025a1d36f25fba7fefd0b1abda631d7f590c44242292a179804c26604ae4c72dc2af012a9b4c7e359be169f1c29a3d88868a7470810eebe8db

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change log
 
+## 4.2.0 (2016-07-16)
+
+* (waldyr) Add Too Many Constants smell detector
+
 ## 4.1.1 (2016-07-05)
 
 * (waldyr) Checking lambda should not raise error

data/Gemfile

@@ -11,9 +11,9 @@ group :development do
   gem 'rake',          '~> 11.1'
   gem 'rspec',         '~> 3.0'
   gem 'rubocop',       '~> 0.41.1'
-  gem 'simplecov',     '~> 0.11.1'
+  gem 'simplecov',     '~> 0.12.0'
   gem 'yard',          '~> 0.8.7'
-  gem 'activesupport', '~> 4.2.7.rc1'
+  gem 'activesupport', '~> 4.2'
 
   platforms :mri do
     gem 'redcarpet', '~> 3.3.1'

data/README.md

@@ -461,6 +461,23 @@ bundle exec rake console
 => Reek::Examiner
 ```
 
+You can also use Pry while running the tests by adding the following at the
+point where you want to start debugging:
+
+```Ruby
+require 'pry'
+binding.pry
+```
+
+If you do this, you need to also run the specs with `DEBUG=1` set, e.g.:
+
+```
+DEBUG=1 bundle exec rspec spec/your/file_spec.rb:23
+```
+
+This is necessary because normally all specs run with a timeout of 5 seconds,
+which isn't much if you're busy using Pry.
+
 Have a look at our [Developer API](docs/API.md) for more inspiration.
 
 From then on you should check out:
@@ -545,6 +562,7 @@ The Reek core team consists of:
 
 * [Matijs van Zuijlen](https://github.com/mvz)
 * [Piotr Szotkowski](https://github.com/chastell)
+* [Waldyr Souza](https://github.com/waldyr)
 * [Timo Rößner](https://github.com/troessner)
 
 The original author of Reek is [Kevin Rutherford](https://github.com/kevinrutherford).

data/defaults.reek

@@ -60,6 +60,10 @@ RepeatedConditional:
 SubclassedFromCoreClass:
   enabled: true
   exclude: []
+TooManyConstants:
+  enabled: true
+  exclude: []
+  max_constants: 5
 TooManyInstanceVariables:
   enabled: true
   exclude: []
@@ -115,4 +119,3 @@ UnusedPrivateMethod:
 UtilityFunction:
   enabled: true
   exclude: []
-  public_methods_only: false

data/docs/Too-Many-Constants.md

@@ -0,0 +1,37 @@
+## Introduction
+
+_Too Many Constants_ is a case of [Large Class](Large-Class.md).
+
+## Example
+
+Given this configuration
+
+```yaml
+TooManyConstants:
+  max_constants: 3
+```
+
+and this code:
+
+```Ruby
+class Smelly
+  CONST_1 = :dummy
+  CONST_2 = :dummy
+  CONST_3 = :dummy
+  CONST_4 = :dummy
+end
+```
+
+Reek would emit the following warning:
+
+```
+test.rb -- 1 warning:
+  [1]:TooManyConstants: Smelly has 4 constants
+```
+## Configuration
+
+Reek's _Too Many Constants_ detector offers the [Basic Smell Options](Basic-Smell-Options.md), plus:
+
+| Option                   | Value   | Effect  |
+| -------------------------|---------|---------|
+| `max_constants` | integer | The maximum number of constants that are permitted. Defaults to 5 |

data/features/samples.feature

@@ -11,7 +11,7 @@ Feature: Basic smell detection
     Then the exit status indicates smells
     And it reports:
     """
-    inline.rb -- 47 warnings:
+    inline.rb -- 48 warnings:
       BooleanParameter: Inline::C#parse_signature has boolean parameter 'raw' [https://github.com/troessner/reek/blob/master/docs/Boolean-Parameter.md]
       ClassVariable: Inline declares the class variable @@directory [https://github.com/troessner/reek/blob/master/docs/Class-Variable.md]
       ClassVariable: Inline declares the class variable @@rootdir [https://github.com/troessner/reek/blob/master/docs/Class-Variable.md]
@@ -41,6 +41,7 @@ Feature: Basic smell detection
       RepeatedConditional: Inline::C tests $DEBUG at least 7 times [https://github.com/troessner/reek/blob/master/docs/Repeated-Conditional.md]
       RepeatedConditional: Inline::C tests $TESTING at least 4 times [https://github.com/troessner/reek/blob/master/docs/Repeated-Conditional.md]
       RepeatedConditional: Inline::C tests @@type_map.has_key? type at least 3 times [https://github.com/troessner/reek/blob/master/docs/Repeated-Conditional.md]
+      TooManyConstants: Inline has 6 constants [https://github.com/troessner/reek/blob/master/docs/Too-Many-Constants.md]
       TooManyInstanceVariables: Inline::C has at least 13 instance variables [https://github.com/troessner/reek/blob/master/docs/Too-Many-Instance-Variables.md]
       TooManyMethods: Inline::C has at least 25 methods [https://github.com/troessner/reek/blob/master/docs/Too-Many-Methods.md]
       TooManyStatements: File#self.write_with_backup has approx 6 statements [https://github.com/troessner/reek/blob/master/docs/Too-Many-Statements.md]
@@ -59,7 +60,7 @@ Feature: Basic smell detection
       UncommunicativeVariableName: Inline::C#module_name has the variable name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       UncommunicativeVariableName: Inline::C#parse_signature has the variable name 'x' [https://github.com/troessner/reek/blob/master/docs/Uncommunicative-Variable-Name.md]
       UtilityFunction: Inline::C#strip_comments doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    optparse.rb -- 119 warnings:
+    optparse.rb -- 120 warnings:
       Attribute: OptionParser#banner is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: OptionParser#default_argv is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: OptionParser#program_name is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -131,6 +132,7 @@ Feature: Basic smell detection
       RepeatedConditional: OptionParser tests s at least 7 times [https://github.com/troessner/reek/blob/master/docs/Repeated-Conditional.md]
       SubclassedFromCoreClass: OptionParser::CompletingHash inherits from a core class (Hash) [https://github.com/troessner/reek/blob/master/docs/Subclassed-From-Core-Class.md]
       SubclassedFromCoreClass: OptionParser::OptionMap inherits from a core class (Hash) [https://github.com/troessner/reek/blob/master/docs/Subclassed-From-Core-Class.md]
+      TooManyConstants: OptionParser has 16 constants [https://github.com/troessner/reek/blob/master/docs/Too-Many-Constants.md]
       TooManyInstanceVariables: OptionParser has at least 6 instance variables [https://github.com/troessner/reek/blob/master/docs/Too-Many-Instance-Variables.md]
       TooManyInstanceVariables: OptionParser::Switch has at least 7 instance variables [https://github.com/troessner/reek/blob/master/docs/Too-Many-Instance-Variables.md]
       TooManyMethods: OptionParser has at least 42 methods [https://github.com/troessner/reek/blob/master/docs/Too-Many-Methods.md]
@@ -179,7 +181,7 @@ Feature: Basic smell detection
       UnusedParameters: OptionParser::Completion#convert has unused parameter 'opt' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::NoArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
       UnusedParameters: OptionParser::Switch::OptionalArgument#parse has unused parameter 'argv' [https://github.com/troessner/reek/blob/master/docs/Unused-Parameters.md]
-    redcloth.rb -- 103 warnings:
+    redcloth.rb -- 104 warnings:
       Attribute: RedCloth#filter_html is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#filter_styles is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
       Attribute: RedCloth#hard_breaks is a writable attribute [https://github.com/troessner/reek/blob/master/docs/Attribute.md]
@@ -229,6 +231,7 @@ Feature: Basic smell detection
       RepeatedConditional: RedCloth tests href at least 3 times [https://github.com/troessner/reek/blob/master/docs/Repeated-Conditional.md]
       RepeatedConditional: RedCloth tests title at least 4 times [https://github.com/troessner/reek/blob/master/docs/Repeated-Conditional.md]
       SubclassedFromCoreClass: RedCloth inherits from a core class (String) [https://github.com/troessner/reek/blob/master/docs/Subclassed-From-Core-Class.md]
+      TooManyConstants: RedCloth has 45 constants [https://github.com/troessner/reek/blob/master/docs/Too-Many-Constants.md]
       TooManyMethods: RedCloth has at least 44 methods [https://github.com/troessner/reek/blob/master/docs/Too-Many-Methods.md]
       TooManyStatements: RedCloth#block_markdown_bq has approx 6 statements [https://github.com/troessner/reek/blob/master/docs/Too-Many-Statements.md]
       TooManyStatements: RedCloth#block_textile_lists has approx 21 statements [https://github.com/troessner/reek/blob/master/docs/Too-Many-Statements.md]
@@ -283,5 +286,5 @@ Feature: Basic smell detection
       UtilityFunction: RedCloth#lT doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#no_textile doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
       UtilityFunction: RedCloth#v_align doesn't depend on instance state (maybe move it to another class?) [https://github.com/troessner/reek/blob/master/docs/Utility-Function.md]
-    269 total warnings
+    272 total warnings
     """

data/features/smells/too_many_constants.feature

@@ -0,0 +1,19 @@
+Feature: Smell - TooManyConstants
+  Scenario: Reports smell
+    Given a file named "my_class.rb" with:
+      """
+      class MyClass
+        A = 1
+        B = 2
+        C = 3
+        D = 4
+        E = 5
+        F = 6
+      end
+      """
+    When I run `reek my_class.rb`
+    Then it reports:
+    """
+    my_class.rb -- 1 warning:
+      [1]:TooManyConstants: MyClass has 6 constants [https://github.com/troessner/reek/blob/master/docs/Too-Many-Constants.md]
+    """

data/lib/reek/ast/node.rb

@@ -101,6 +101,11 @@ module Reek
         end
       end
 
+      # Provide length for statement counting. A sexp counts as one statement.
+      def length
+        1
+      end
+
       protected
 
       # See ".each_node" for documentation.

data/lib/reek/ast/sexp_extensions/lambda.rb

@@ -7,10 +7,6 @@ module Reek
         def name
           'lambda'
         end
-
-        def module_creation_call?
-          false
-        end
       end
     end
   end

data/lib/reek/ast/sexp_extensions/module.rb

@@ -58,6 +58,47 @@ module Reek
           call && call.module_creation_call?
         end
 
+        # Sometimes we assign classes like:
+        #
+        # Foo = Class.new(Bar)
+        #
+        # This is mapped into the following expression:
+        #
+        # s(:casgn, nil :Foo,
+        #   s(:send,
+        #     s(:const, nil, :Class), :new,
+        #     s(:const, nil, :Bar)
+        #   )
+        # )
+        #
+        # And we are only looking for s(:const, nil, :Bar)
+        #
+        def superclass
+          return nil unless defines_module?
+
+          constant_definition.args.first if constant_definition.receiver.name == 'Class'
+        end
+
+        def name
+          children[1].to_s
+        end
+
+        # there are two valid forms of the casgn sexp
+        # (casgn <namespace> <name> <value>) and
+        # (casgn <namespace> <name>) used in or-asgn and mlhs
+        #
+        # source = "class Hi; THIS ||= 3; end"
+        # (class
+        #   (const nil :Hi) nil
+        #   (or-asgn
+        #    (casgn nil :THIS)
+        #    (int 3)))
+        def value
+          children[2]
+        end
+
+        private
+
         # This is the right hand side of a constant
         # assignment.
         #
@@ -92,50 +133,12 @@ module Reek
 
           case value.type
           when :block
-            value.call
+            call = value.call
+            call if call.type == :send
           when :send
             value
           end
         end
-
-        # Sometimes we assign classes like:
-        #
-        # Foo = Class.new(Bar)
-        #
-        # This is mapped into the following expression:
-        #
-        # s(:casgn, nil :Foo,
-        #   s(:send,
-        #     s(:const, nil, :Class), :new,
-        #     s(:const, nil, :Bar)
-        #   )
-        # )
-        #
-        # And we are only looking for s(:const, nil, :Bar)
-        #
-        def superclass
-          return nil unless constant_definition
-
-          constant_definition.args.first
-        end
-
-        def name
-          children[1].to_s
-        end
-
-        # there are two valid forms of the casgn sexp
-        # (casgn <namespace> <name> <value>) and
-        # (casgn <namespace> <name>) used in or-asgn and mlhs
-        #
-        # source = "class Hi; THIS ||= 3; end"
-        # (class
-        #   (const nil :Hi) nil
-        #   (or-asgn
-        #    (casgn nil :THIS)
-        #    (int 3)))
-        def value
-          children[2]
-        end
       end
     end
   end

data/lib/reek/cli/options.rb

@@ -89,7 +89,6 @@ module Reek
       def set_configuration_options
         parser.separator 'Configuration:'
         parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
-          raise ArgumentError, "Config file #{file} doesn't exist" unless File.exist?(file)
           self.config_file = Pathname.new(file)
         end
         parser.on('--smell SMELL', 'Detect smell SMELL (default: all enabled smells)') do |smell|

data/lib/reek/configuration/app_configuration.rb

@@ -47,12 +47,7 @@ module Reek
       end
 
       def self.default
-        from_path nil
-      end
-
-      def self.new(*)
-        raise NotImplementedError,
-              'Calling `new` is not supported, please use one of the factory methods'
+        new
       end
 
       # Returns the directive for a given directory.

data/lib/reek/context/statement_counter.rb

@@ -12,15 +12,7 @@ module Reek
       end
 
       def increase_by(sexp)
-        return unless sexp
-        case sexp
-        when Reek::AST::Node
-          self.value = value + 1
-        when Array
-          self.value = value + sexp.length
-        else
-          raise ArgumentError, "Invalid type #{sexp} given"
-        end
+        self.value = value + sexp.length if sexp
       end
 
       def decrease_by(number)

data/lib/reek/report.rb

@@ -6,8 +6,6 @@ require_relative 'report/heading_formatter'
 module Reek
   # Reek reporting functionality.
   module Report
-    module_function
-
     REPORT_CLASSES = {
       yaml: YAMLReport,
       json: JSONReport,
@@ -39,28 +37,38 @@ module Reek
     #
     # @return The mapped report class
     #
-    def report_class(report_format)
-      REPORT_CLASSES.fetch(report_format) do
-        raise "Unknown report format: #{report_format}"
-      end
+    def self.report_class(report_format)
+      REPORT_CLASSES.fetch(report_format)
     end
 
-    def location_formatter(location_format)
-      LOCATION_FORMATTERS.fetch(location_format) do
-        raise "Unknown location format: #{location_format}"
-      end
+    # Map location format symbol to a report class.
+    #
+    # @param [Symbol] location_format The format to map
+    #
+    # @return The mapped location class
+    #
+    def self.location_formatter(location_format)
+      LOCATION_FORMATTERS.fetch(location_format)
     end
 
-    def heading_formatter(heading_format)
-      HEADING_FORMATTERS.fetch(heading_format) do
-        raise "Unknown heading format: #{heading_format}"
-      end
+    # Map heading format symbol to a report class.
+    #
+    # @param [Symbol] heading_format The format to map
+    #
+    # @return The mapped heading class
+    #
+    def self.heading_formatter(heading_format)
+      HEADING_FORMATTERS.fetch(heading_format)
     end
 
-    def warning_formatter_class(warning_format)
-      WARNING_FORMATTER_CLASSES.fetch(warning_format) do
-        raise "Unknown warning format: #{warning_format}"
-      end
+    # Map warning format symbol to a report class.
+    #
+    # @param [Symbol] warning_format The format to map
+    #
+    # @return The mapped warning class
+    #
+    def self.warning_formatter_class(warning_format)
+      WARNING_FORMATTER_CLASSES.fetch(warning_format)
     end
   end
 end

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

@@ -525,6 +525,37 @@ TooManyInstanceVariables:
     test.rb -- 5 warnings:
       [1]:TooManyInstanceVariables has at least 4 instance variables (TooManyInstanceVariables)
     ```
+TooManyConstants:
+  remediation_points: 500_000
+  content: |
+    `Too Many Constants` is a special case of `LargeClass`.
+
+    ## Example
+
+    Given this configuration
+
+    ```yaml
+    TooManyConstants:
+      max_constants: 3
+    ```
+
+    and this code:
+
+    ```Ruby
+    class TooManyConstants
+      CONST_1 = :dummy
+      CONST_2 = :dummy
+      CONST_3 = :dummy
+      CONST_4 = :dummy
+    end
+    ```
+
+    Reek would emit the following warning:
+
+    ```
+    test.rb -- 1 warnings:
+      [1]:TooManyConstants has 4 constants (TooManyConstants)
+    ```
 TooManyMethods:
   remediation_points: 500_000
   content: |

data/lib/reek/smells.rb

@@ -16,6 +16,7 @@ require_relative 'smells/prima_donna_method'
 require_relative 'smells/repeated_conditional'
 require_relative 'smells/subclassed_from_core_class'
 require_relative 'smells/too_many_instance_variables'
+require_relative 'smells/too_many_constants'
 require_relative 'smells/too_many_methods'
 require_relative 'smells/too_many_statements'
 require_relative 'smells/uncommunicative_method_name'

data/lib/reek/smells/too_many_constants.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+require_relative 'smell_detector'
+require_relative 'smell_warning'
+
+module Reek
+  module Smells
+    #
+    # A Large Class is a class or module that has a large number of
+    # instance variables, methods, constants or lines of code.
+    #
+    # +TooManyConstants' reports classes having more than a
+    # configurable number of constants.
+    #
+    # See {file:docs/Too-Many-Constants.md} for details.
+    class TooManyConstants < SmellDetector
+      # The name of the config field that sets the maximum number
+      # of constants permitted in a class.
+      MAX_ALLOWED_CONSTANTS_KEY = 'max_constants'.freeze
+      DEFAULT_MAX_CONSTANTS = 5
+
+      def self.contexts
+        [:class, :module]
+      end
+
+      def self.default_config
+        super.merge(
+          MAX_ALLOWED_CONSTANTS_KEY => DEFAULT_MAX_CONSTANTS,
+          EXCLUDE_KEY => [])
+      end
+
+      #
+      # Checks +klass+ for too many constants.
+      #
+      # @return [Array<SmellWarning>]
+      #
+      def inspect(ctx)
+        max_allowed_constants = value(MAX_ALLOWED_CONSTANTS_KEY, ctx)
+
+        count = ctx.each_node(:casgn, [:class]).delete_if(&:defines_module?).length
+
+        return [] if count <= max_allowed_constants
+
+        build_smell_warning(ctx, count)
+      end
+
+      private
+
+      def build_smell_warning(ctx, count)
+        [smell_warning(
+          context: ctx,
+          lines: [ctx.exp.line],
+          message: "has #{count} constants",
+          parameters: { count: count })]
+      end
+    end
+  end
+end

data/lib/reek/version.rb

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

data/spec/reek/ast/node_spec.rb

@@ -69,4 +69,10 @@ RSpec.describe Reek::AST::Node do
       expect(node1.hash).not_to eq(node2.hash)
     end
   end
+
+  describe '#length' do
+    it 'counts itself as representing one statement' do
+      expect(sexp(:foo).length).to eq 1
+    end
+  end
 end

data/spec/reek/ast/sexp_extensions_spec.rb

@@ -441,7 +441,7 @@ RSpec.describe Reek::AST::SexpExtensions::ModuleNode do
 end
 
 RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
-  context '#defines_module' do
+  describe '#defines_module?' do
     context 'with single assignment' do
       subject do
         sexp(:casgn, nil, :Foo)
@@ -467,16 +467,24 @@ RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
       end
     end
 
-    context 'when assign a lambda to a constant' do
+    context 'when assigning a lambda to a constant' do
       it 'does not define a module' do
         exp = Reek::Source::SourceCode.from('C = ->{}').syntax_tree
 
         expect(exp.defines_module?).to be_falsey
       end
     end
+
+    context 'when assigning a string to a constant' do
+      it 'does not define a module' do
+        exp = Reek::Source::SourceCode.from('C = "hello"').syntax_tree
+
+        expect(exp.defines_module?).to be_falsey
+      end
+    end
   end
 
-  context '#superclass' do
+  describe '#superclass' do
     it 'returns the superclass from the class definition' do
       exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
 
@@ -494,33 +502,17 @@ RSpec.describe Reek::AST::SexpExtensions::CasgnNode do
 
       expect(exp.superclass).to be_nil
     end
-  end
 
-  context '#constant_definition' do
-    context 'simple constant assignment' do
-      it 'is not important' do
-        exp = sexp(:casgn, nil, :Foo, sexp(:int, 23))
+    it 'returns nothing for a class definition using Struct.new' do
+      exp = Reek::Source::SourceCode.from('Foo = Struct.new("Bar")').syntax_tree
 
-        expect(exp.constant_definition).to be_nil
-      end
+      expect(exp.superclass).to be_nil
     end
 
-    context 'complicated constant assignments' do
-      it 'calls the block and returns what is being sent' do
-        exp = Reek::Source::SourceCode.from('Iterator = Struct.new(:exp) { def p; end; }').syntax_tree
+    it 'returns nothing for a constant assigned with a bare method call' do
+      exp = Reek::Source::SourceCode.from('Foo = foo("Bar")').syntax_tree
 
-        struct_exp = sexp(:send, sexp(:const, nil, :Struct), :new, sexp(:sym, :exp))
-
-        expect(exp.constant_definition).to eq struct_exp
-      end
-
-      it 'returns the expression responsible for class creation' do
-        exp = Reek::Source::SourceCode.from('Foo = Class.new(Bar)').syntax_tree
-
-        class_exp = sexp(:send, sexp(:const, nil, :Class), :new, sexp(:const, nil, :Bar))
-
-        expect(exp.constant_definition).to eq class_exp
-      end
+      expect(exp.superclass).to be_nil
     end
   end
 end

data/spec/reek/cli/application_spec.rb

@@ -68,8 +68,6 @@ RSpec.describe Reek::CLI::Application do
         let(:app) { Reek::CLI::Application.new ['--config', 'some_file.reek'] }
 
         before do
-          allow(File).to receive(:exist?).and_call_original
-          allow(File).to receive(:exist?).with('some_file.reek').and_return true
           allow(Reek::Configuration::AppConfiguration).
             to receive(:from_path).
             with(Pathname.new('some_file.reek')).

data/spec/reek/configuration/app_configuration_spec.rb

@@ -6,12 +6,6 @@ require_lib 'reek/configuration/default_directive'
 require_lib 'reek/configuration/excluded_paths'
 
 RSpec.describe Reek::Configuration::AppConfiguration do
-  describe '#new' do
-    it 'raises NotImplementedError' do
-      expect { subject }.to raise_error(NotImplementedError)
-    end
-  end
-
   describe 'factory methods' do
     let(:expected_excluded_paths) do
       [SAMPLES_PATH.join('two_smelly_files'),
@@ -68,6 +62,16 @@ RSpec.describe Reek::Configuration::AppConfiguration do
     end
   end
 
+  describe '#default' do
+    it 'returns a blank AppConfiguration' do
+      config = described_class.default
+      expect(config).to be_instance_of described_class
+      expect(config.send(:excluded_paths)).to eq([])
+      expect(config.send(:default_directive)).to eq({})
+      expect(config.send(:directory_directives)).to eq({})
+    end
+  end
+
   describe '#directive_for' do
     context 'multiple directory directives and no default directive present' do
       let(:source_via) { 'spec/samples/three_clean_files/dummy.rb' }

data/spec/reek/context/statement_counter_spec.rb

@@ -0,0 +1,23 @@
+require_relative '../../spec_helper'
+require_lib 'reek/context/statement_counter'
+
+RSpec.describe Reek::Context::StatementCounter do
+  let(:counter) { described_class.new }
+  describe '#increase_by' do
+    it 'does not increase if passed a falsy value' do
+      counter.increase_by(nil)
+      expect(counter.value).to eq 0
+    end
+
+    it 'increase by the lengh of the passed in argument' do
+      counter.increase_by([1, 2, 3])
+      expect(counter.value).to eq 3
+    end
+
+    it 'accumulates increases' do
+      counter.increase_by([1, 2, 3])
+      counter.increase_by([1, 2, 3])
+      expect(counter.value).to eq 6
+    end
+  end
+end

data/spec/reek/report_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../spec_helper'
+require_lib 'reek/report'
+
+RSpec.describe Reek::Report do
+  describe '.report_class' do
+    it 'returns the correct class' do
+      expect(Reek::Report.report_class(:text)).to eq Reek::Report::TextReport
+    end
+  end
+
+  describe '.location_formatter' do
+    it 'returns the correct class' do
+      expect(Reek::Report.location_formatter(:plain)).to eq Reek::Report::BlankLocationFormatter
+    end
+  end
+
+  describe '.heading_formatter' do
+    it 'returns the correct class' do
+      expect(Reek::Report.heading_formatter(:quiet)).to eq Reek::Report::HeadingFormatter::Quiet
+    end
+  end
+
+  describe '.warning_formatter_class' do
+    it 'returns the correct class' do
+      expect(Reek::Report.warning_formatter_class(:simple)).to eq Reek::Report::SimpleWarningFormatter
+    end
+  end
+end

data/spec/reek/smells/subclassed_from_core_class_spec.rb

@@ -119,7 +119,7 @@ RSpec.describe Reek::Smells::SubclassedFromCoreClass do
         end
       end
     EOS
-    expect(src).to_not reek_of(:SubclassedFromCoreClass, ancestor: 'Array')
+    expect(src).to_not reek_of(:SubclassedFromCoreClass)
   end
 
   it 'should not report if inner class inherits from allowed classes' do
@@ -130,6 +130,28 @@ RSpec.describe Reek::Smells::SubclassedFromCoreClass do
         end
       end
     EOS
-    expect(src).to_not reek_of(:SubclassedFromCoreClass, ancestor: 'StandardError')
+    expect(src).to_not reek_of(:SubclassedFromCoreClass)
+  end
+
+  it 'should not report if class is created with Struct.new' do
+    src = <<-EOS
+      module Namespace
+        class Dummy
+          Dummiest = Struct.new('Array')
+        end
+      end
+    EOS
+    expect(src).to_not reek_of(:SubclassedFromCoreClass)
+  end
+
+  it 'should only report classes created with Class.new' do
+    src = <<-EOS
+      module Namespace
+        class Dummy
+          Dummiest = Foo.new(Array)
+        end
+      end
+    EOS
+    expect(src).to_not reek_of(:SubclassedFromCoreClass)
   end
 end

data/spec/reek/smells/too_many_constants_spec.rb

@@ -0,0 +1,216 @@
+require_relative '../../spec_helper'
+require_lib 'reek/smells/too_many_constants'
+require_relative 'smell_detector_shared'
+
+RSpec.describe Reek::Smells::TooManyConstants do
+  context 'counting constants' do
+    it 'should not report for non-excessive constants' do
+      src = <<-EOS
+        class Dummy
+          A = B = C = D = E = 1
+        end
+      EOS
+
+      expect(src).not_to reek_of(:TooManyConstants)
+    end
+
+    it 'should not report when increasing default' do
+      src = <<-EOS
+        # :reek:TooManyConstants: { max_constants: 6 }
+        class Dummy
+          A = B = C = D = E = 1
+          F = 1
+        end
+      EOS
+
+      expect(src).not_to reek_of(:TooManyConstants)
+    end
+
+    it 'should not report when disabled' do
+      src = <<-EOS
+        # :reek:TooManyConstants: { enabled: false }
+        class Dummy
+          A = B = C = D = E = 1
+          F = 1
+        end
+      EOS
+
+      expect(src).not_to reek_of(:TooManyConstants)
+    end
+
+    it 'should not account class definition' do
+      src = <<-EOS
+        module Dummiest
+          class Dummy
+            A = B = C = D = E = 1
+
+            Error = Class.new(StandardError)
+          end
+        end
+      EOS
+
+      expect(src).not_to reek_of(:TooManyConstants)
+    end
+
+    it 'should not account struct definition' do
+      src = <<-EOS
+        module Dummiest
+          class Dummy
+            A = B = C = D = E = 1
+
+            Struct = Struct.new
+          end
+        end
+      EOS
+
+      expect(src).to_not reek_of(:TooManyConstants)
+    end
+
+    it 'should count each constant only once' do
+      src = <<-EOS
+        class Good
+          A = B = C = D = E = 1
+        end
+
+        class Bad
+          A = B = C = D = E = 1
+        end
+
+        class Ugly
+          A = B = C = D = E = 1
+        end
+      EOS
+
+      expect(src).not_to reek_of(:TooManyConstants)
+    end
+
+    it 'should count each constant only once for each class' do
+      src = <<-EOS
+        module Movie
+          class Good
+            A = B = C = D = E = 1
+          end
+
+          class Bad
+            F = G = H = I = J = 1
+          end
+
+          class Ugly
+            K = L = M = N = O = 1
+          end
+        end
+      EOS
+
+      expect(src).not_to reek_of(:TooManyConstants)
+    end
+
+    it 'should count each constant only once for each namespace' do
+      src = <<-EOS
+        module Movie
+          A = B = C = D = E = 1
+
+          class Good
+            F = 1
+          end
+        end
+      EOS
+
+      expect(src).not_to reek_of(:TooManyConstants)
+    end
+
+    it 'should report for excessive constants inside a class' do
+      src = <<-EOS
+        class Dummy
+          A = B = C = D = E = 1
+          F = 1
+        end
+      EOS
+
+      expect(src).to reek_of(:TooManyConstants)
+    end
+
+    it 'should report for excessive constants inside a module' do
+      src = <<-EOS
+        module Dummiest
+          A = B = C = D = E = 1
+          F = 1
+
+          class Dummy
+          end
+        end
+      EOS
+
+      expect(src).to reek_of(:TooManyConstants, context: 'Dummiest')
+    end
+  end
+
+  context 'smell report' do
+    it 'reports the number of constants' do
+      src = <<-EOS
+        module Moduly
+          class Klass
+            A = B = C = D = E = 1
+            F = 1
+          end
+        end
+      EOS
+
+      expect(src).to reek_of(:TooManyConstants, count: 6)
+    end
+
+    it 'reports the line where it occurs' do
+      src = <<-EOS
+        module Moduly
+          class Klass
+            A = B = C = D = E = 1
+            F = 1
+          end
+        end
+      EOS
+
+      expect(src).to reek_of(:TooManyConstants, lines: [2])
+    end
+
+    it 'reports a readable message' do
+      src = <<-EOS
+        module Moduly
+          class Klass
+            A = B = C = D = E = 1
+            F = 1
+          end
+        end
+      EOS
+
+      expect(src).to reek_of(:TooManyConstants, message: 'has 6 constants')
+    end
+
+    context 'context' do
+      it 'reports the full class name' do
+        src = <<-EOS
+          module Moduly
+            class Klass
+              A = B = C = D = E = 1
+              F = 1
+            end
+          end
+        EOS
+
+        expect(src).to reek_of(:TooManyConstants, context: 'Moduly::Klass')
+      end
+
+      it 'reports the module name' do
+        src = <<-EOS
+          module Moduly
+            A = B = C = D = E = 1
+            F = 1
+
+            class Klass
+            end
+          end
+        EOS
+
+        expect(src).to reek_of(:TooManyConstants, context: 'Moduly')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -84,8 +84,12 @@ RSpec.configure do |config|
   end
 
   # Avoid infinitely running tests. This is mainly useful when running mutant.
-  config.around(:each) do |example|
-    Timeout.timeout(5, &example)
+  # Set the DEBUG environment variable to something truthy like '1' to disable
+  # this and allow using pry without specs failing.
+  unless ENV['DEBUG']
+    config.around(:each) do |example|
+      Timeout.timeout(5, &example)
+    end
   end
 end
 

data/tasks/ataru.rake

@@ -1,4 +1,5 @@
 desc 'Runs ataru to check if our docs are still in sync with our code'
 task :ataru do
   system 'bundle exec ataru check'
+  abort unless $CHILD_STATUS.success?
 end

data/tasks/mutant.rake

@@ -15,4 +15,5 @@ task :mutant do
     fi
   EOS
   system command
+  abort unless $CHILD_STATUS.success?
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reek
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Kevin Rutherford
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-05 00:00:00.000000000 Z
+date: 2016-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codeclimate-engine-rb
@@ -119,6 +119,7 @@ files:
 - docs/Simulated-Polymorphism.md
 - docs/Smell-Suppression.md
 - docs/Subclassed-From-Core-Class.md
+- docs/Too-Many-Constants.md
 - docs/Too-Many-Instance-Variables.md
 - docs/Too-Many-Methods.md
 - docs/Too-Many-Statements.md
@@ -158,6 +159,7 @@ files:
 - features/reports/yaml.feature
 - features/samples.feature
 - features/smells/subclassed_from_core_class.feature
+- features/smells/too_many_constants.feature
 - features/step_definitions/.rubocop.yml
 - features/step_definitions/reek_steps.rb
 - features/step_definitions/sample_file_steps.rb
@@ -246,6 +248,7 @@ files:
 - lib/reek/smells/smell_repository.rb
 - lib/reek/smells/smell_warning.rb
 - lib/reek/smells/subclassed_from_core_class.rb
+- lib/reek/smells/too_many_constants.rb
 - lib/reek/smells/too_many_instance_variables.rb
 - lib/reek/smells/too_many_methods.rb
 - lib/reek/smells/too_many_statements.rb
@@ -294,6 +297,7 @@ files:
 - spec/reek/context/method_context_spec.rb
 - spec/reek/context/module_context_spec.rb
 - spec/reek/context/root_context_spec.rb
+- spec/reek/context/statement_counter_spec.rb
 - spec/reek/context_builder_spec.rb
 - spec/reek/examiner_spec.rb
 - spec/reek/rake/task_spec.rb
@@ -305,6 +309,7 @@ files:
 - spec/reek/report/text_report_spec.rb
 - spec/reek/report/xml_report_spec.rb
 - spec/reek/report/yaml_report_spec.rb
+- spec/reek/report_spec.rb
 - spec/reek/smells/attribute_spec.rb
 - spec/reek/smells/boolean_parameter_spec.rb
 - spec/reek/smells/class_variable_spec.rb
@@ -326,6 +331,7 @@ files:
 - spec/reek/smells/smell_repository_spec.rb
 - spec/reek/smells/smell_warning_spec.rb
 - spec/reek/smells/subclassed_from_core_class_spec.rb
+- spec/reek/smells/too_many_constants_spec.rb
 - spec/reek/smells/too_many_instance_variables_spec.rb
 - spec/reek/smells/too_many_methods_spec.rb
 - spec/reek/smells/too_many_statements_spec.rb