reek 2.1.0 → 2.2.0

data/lib/reek/smells/too_many_instance_variables.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -10,6 +9,7 @@ module Reek
     # +TooManyInstanceVariables' reports classes having more than a
     # configurable number of instance variables.
     #
+    # See docs/Too-Many-Instance-Variables for details.
     class TooManyInstanceVariables < SmellDetector
       # The name of the config field that sets the maximum number of instance
       # variables permitted in a class.

data/lib/reek/smells/too_many_methods.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -12,6 +11,7 @@ module Reek
     # methods, and excludes methods inherited from superclasses or included
     # modules.
     #
+    # See docs/Too-Many-Methods for details.
     class TooManyMethods < SmellDetector
       # The name of the config field that sets the maximum number of methods
       # permitted in a class.

data/lib/reek/smells/too_many_statements.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -8,6 +7,7 @@ module Reek
     #
     # +TooManyStatements+ reports any method with more than 5 statements.
     #
+    # See docs/Too-Many-Statements for details.
     class TooManyStatements < SmellDetector
       # The name of the config field that sets the maximum number of
       # statements permitted in any method.

data/lib/reek/smells/uncommunicative_method_name.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +15,7 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See docs/Uncommunicative-Method-Name for details.
     class UncommunicativeMethodName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/uncommunicative_module_name.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +15,7 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See docs/Uncommunicative-Module-Name for details.
     class UncommunicativeModuleName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/uncommunicative_parameter_name.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +15,7 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See docs/Uncommunicative-Parameter-Name for details.
     class UncommunicativeParameterName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/uncommunicative_variable_name.rb

@@ -1,5 +1,4 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
@@ -16,6 +15,7 @@ module Reek
     # * 1-character names
     # * names ending with a number
     #
+    # See docs/Uncommunicative-Variable-Name for details.
     class UncommunicativeVariableName < SmellDetector
       # The name of the config field that lists the regexps of
       # smelly names to be reported.

data/lib/reek/smells/unused_parameters.rb

@@ -1,11 +1,11 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
 
 module Reek
   module Smells
     #
     # Methods should use their parameters.
     #
+    # See docs/Unused-Parameters for details.
     class UnusedParameters < SmellDetector
       def self.smell_category
         'UnusedCode'

data/lib/reek/smells/utility_function.rb

@@ -1,6 +1,5 @@
 require_relative 'smell_detector'
-require_relative '../smell_warning'
-require_relative '../source/reference_collector'
+require_relative '../core/reference_collector'
 
 module Reek
   module Smells
@@ -35,14 +34,8 @@ module Reek
     # If the method does refer to self, but refers to some other object more,
     # +FeatureEnvy+ is reported instead.
     #
+    # See docs/Utility-Function for details.
     class UtilityFunction < SmellDetector
-      # The name of the config field that sets the maximum number of
-      # calls permitted within a helper method. Any method with more than
-      # this number of method calls on other objects will be considered a
-      # candidate Utility Function.
-      HELPER_CALLS_LIMIT_KEY = 'max_helper_calls'
-      DEFAULT_HELPER_CALLS_LIMIT = 0
-
       def self.smell_category
         'LowCohesion'
       end
@@ -51,10 +44,6 @@ module Reek
         def contexts      # :nodoc:
           [:def]
         end
-
-        def default_config
-          super.merge(HELPER_CALLS_LIMIT_KEY => DEFAULT_HELPER_CALLS_LIMIT)
-        end
       end
 
       #
@@ -65,9 +54,7 @@ module Reek
       def examine_context(method_ctx)
         return [] if method_ctx.num_statements == 0
         return [] if method_ctx.references_self?
-        return [] if num_helper_methods(method_ctx) <= value(HELPER_CALLS_LIMIT_KEY,
-                                                             method_ctx,
-                                                             DEFAULT_HELPER_CALLS_LIMIT)
+        return [] if num_helper_methods(method_ctx).zero?
 
         [SmellWarning.new(self,
                           context: method_ctx.full_name,

data/lib/reek/source/source_code.rb

@@ -1,8 +1,9 @@
-old_verbose, $VERBOSE = $VERBOSE, nil
-require 'parser/current'
-$VERBOSE = old_verbose
-require_relative 'tree_dresser'
-require_relative 'ast_node'
+require_relative '../cli/silencer'
+Reek::CLI::Silencer.silently do
+  require 'parser/current'
+end
+require_relative '../core/tree_dresser'
+require_relative '../core/ast_node'
 
 module Reek
   module Source
@@ -10,14 +11,28 @@ module Reek
     # A +Source+ object represents a chunk of Ruby source code.
     #
     class SourceCode
-      attr_reader :desc
+      attr_reader :description
 
-      def initialize(code, desc, parser = Parser::Ruby21)
-        @source = code
-        @desc = desc
-        @parser = parser
+      # Initializer.
+      #
+      # code        - ruby code as String
+      # description - in case of STDIN this is "STDIN" otherwise it's a filepath as String
+      # parser      - the parser to use for generating AST's out of the given source
+      def initialize(code, description, parser = Parser::Ruby21)
+        @source      = code
+        @description = description
+        @parser      = parser
       end
 
+      # Initializes an instance of SourceCode given a source.
+      # This source can come via 3 different ways:
+      # - from files a la `reek lib/reek/`
+      # - from IO (STDIN) a la `echo "class Foo; end" | reek`
+      # - from String via our rspec matchers a la `expect("class Foo; end").to reek`
+      #
+      # source - One of File|IO|String
+      #
+      # Returns an instance of SourceCode
       def self.from(source)
         case source
         when File   then new(source.read, source.path)
@@ -26,17 +41,20 @@ module Reek
         end
       end
 
+      # Parses the given source into an AST.
+      #
+      #  @return [Reek::Core::ASTNode] the AST presentation of the given source
       def syntax_tree
         @syntax_tree ||=
           begin
             begin
-              ast, comments = @parser.parse_with_comments(@source, @desc)
+              ast, comments = @parser.parse_with_comments(@source, @description)
             rescue Racc::ParseError, Parser::SyntaxError => error
-              $stderr.puts "#{desc}: #{error.class.name}: #{error}"
+              $stderr.puts "#{description}: #{error.class.name}: #{error}"
             end
 
             comment_map = Parser::Source::Comment.associate(ast, comments) if ast
-            TreeDresser.new.dress(ast, comment_map)
+            Core::TreeDresser.new.dress(ast, comment_map)
           end
       end
     end

data/lib/reek/source/source_locator.rb

@@ -4,36 +4,35 @@ module Reek
     # Finds Ruby source files in a filesystem.
     #
     class SourceLocator
+      # Initialize with the paths we want to search.
+      #
+      # paths - a list of paths as Strings
       def initialize(paths)
         @paths = paths.map { |path| path.chomp('/') }
       end
 
-      def all_sources
-        valid_paths.map { |path| Source::SourceCode.from File.new(path) }
+      # Traverses all paths we initialized the SourceLocator with, finds
+      # all relevant ruby files and returns them as a list.
+      #
+      # Returns a list of Source::SourceCode.
+      def sources
+        find_sources.map { |pathname| Source::SourceCode.from File.new(pathname) }
       end
 
       private
 
-      def all_ruby_source_files(paths)
+      def find_sources(paths = @paths)
         paths.map do |path|
-          if test 'd', path
-            all_ruby_source_files(Dir["#{path}/**/*.rb"])
+          pathname = Pathname.new(path)
+          if pathname.directory?
+            find_sources(Dir["#{pathname}/**/*.rb"])
           else
-            path
+            next pathname if pathname.file?
+            $stderr.puts "Error: No such file - #{pathname}"
+            nil
           end
         end.flatten.sort
       end
-
-      def valid_paths
-        all_ruby_source_files(@paths).select do |path|
-          if test 'f', path
-            true
-          else
-            $stderr.puts "Error: No such file - #{path}"
-            false
-          end
-        end
-      end
     end
   end
 end

data/lib/reek/source/source_repository.rb

@@ -9,6 +9,13 @@ module Reek
     # single unit of Ruby source code.
     #
     class SourceRepository
+      attr_reader :description
+
+      def initialize(description, sources)
+        @description = description
+        @sources     = sources
+      end
+
       # TODO: This method is a least partially broken.
       # Regardless of how you call reek, be it:
       #   reek lib/
@@ -19,23 +26,15 @@ module Reek
       def self.parse(source)
         case source
         when Array
-          new 'dir', Source::SourceLocator.new(source).all_sources
+          new 'dir', Source::SourceLocator.new(source).sources
         when Source::SourceCode
-          new source.desc, [source]
+          new source.description, [source]
         else
           src = Source::SourceCode.from source
-          new src.desc, [src]
+          new src.description, [src]
         end
       end
 
-      include Enumerable
-      attr_reader :description
-
-      def initialize(description, sources)
-        @description = description
-        @sources = sources
-      end
-
       def each(&block)
         @sources.each(&block)
       end

data/lib/reek/spec/should_reek.rb

@@ -1,4 +1,4 @@
-require_relative '../examiner'
+require_relative '../core/examiner'
 require_relative '../cli/report/formatter'
 
 module Reek
@@ -8,7 +8,7 @@ module Reek
     #
     class ShouldReek        # :nodoc:
       def matches?(actual)
-        @examiner = Examiner.new(actual)
+        @examiner = Core::Examiner.new(actual)
         @examiner.smelly?
       end
 

data/lib/reek/spec/should_reek_of.rb

@@ -1,4 +1,4 @@
-require_relative '../examiner'
+require_relative '../core/examiner'
 
 module Reek
   module Spec
@@ -13,7 +13,7 @@ module Reek
       end
 
       def matches?(actual)
-        @examiner = Examiner.new(actual)
+        @examiner = Core::Examiner.new(actual)
         @all_smells = @examiner.smells
         @all_smells.any? { |warning| warning.matches?(@smell_category, @smell_details) }
       end

data/lib/reek/spec/should_reek_only_of.rb

@@ -1,4 +1,4 @@
-require_relative '../examiner'
+require_relative '../core/examiner'
 require_relative '../cli/report/formatter'
 
 module Reek
@@ -9,7 +9,7 @@ module Reek
     #
     class ShouldReekOnlyOf < ShouldReekOf
       def matches?(actual)
-        matches_examiner?(Examiner.new(actual))
+        matches_examiner?(Core::Examiner.new(actual))
       end
 
       def matches_examiner?(examiner)

data/lib/reek/version.rb

@@ -3,6 +3,6 @@ module Reek
   # This module holds the Reek version informations
   #
   module Version
-    STRING = '2.1.0'
+    STRING = '2.2.0'
   end
 end

data/reek.gemspec

@@ -22,10 +22,9 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 1.9.3'
   s.summary = 'Code smell detector for Ruby'
 
-  s.add_runtime_dependency 'parser',      '~> 2.2'
-  s.add_runtime_dependency 'rainbow',     '~> 2.0'
-  s.add_runtime_dependency 'require_all', '~> 1.3'
-  s.add_runtime_dependency 'unparser',    '~> 0.2.2'
+  s.add_runtime_dependency 'parser',   '~> 2.2'
+  s.add_runtime_dependency 'rainbow',  '~> 2.0'
+  s.add_runtime_dependency 'unparser', '~> 0.2.2'
 
   s.add_development_dependency 'activesupport', '~> 4.2'
   s.add_development_dependency 'aruba',         '~> 0.6.2'

data/spec/factories/factories.rb

@@ -13,7 +13,7 @@ FactoryGirl.define do
     end
   end
 
-  factory :smell_warning, class: Reek::SmellWarning do
+  factory :smell_warning, class: Reek::Smells::SmellWarning do
     skip_create
     smell_detector
     context 'self'

data/spec/gem/yard_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../spec_helper'
 require 'tempfile'
 
-describe 'yardoc' do
+RSpec.describe 'yardoc' do
   before :each do
     stderr_file = Tempfile.new('yardoc')
     stderr_file.close

data/spec/quality/reek_source_spec.rb

@@ -1,7 +1,7 @@
 require_relative '../spec_helper'
 
-describe 'Reek source code' do
+RSpec.describe 'Reek source code' do
   it 'has no smells' do
-    Dir['lib/**/*.rb'].should_not reek
+    expect(Dir['lib/**/*.rb']).to_not reek
   end
 end

data/spec/reek/cli/html_report_spec.rb

@@ -1,12 +1,12 @@
 require_relative '../../spec_helper'
-require_relative '../../../lib/reek/examiner'
+require_relative '../../../lib/reek/core/examiner'
 require_relative '../../../lib/reek/cli/report/report'
 
-describe Reek::CLI::Report::HTMLReport do
+RSpec.describe Reek::CLI::Report::HTMLReport do
   let(:instance) { Reek::CLI::Report::HTMLReport.new }
 
   context 'with an empty source' do
-    let(:examiner) { Reek::Examiner.new('') }
+    let(:examiner) { Reek::Core::Examiner.new('') }
 
     before do
       instance.add_examiner examiner