reek 2.0.4 → 2.1.0

data/features/support/env.rb

@@ -1,8 +1,6 @@
-require 'English'
-require 'tempfile'
-require 'fileutils'
-require 'open3'
-require 'reek/cli/application'
+require_relative '../../lib/reek/cli/application'
+require 'aruba/cucumber'
+require 'active_support/core_ext/string/strip'
 
 begin
   require 'pry-byebug'
@@ -13,39 +11,30 @@ end
 # Provides runner methods used in the cucumber steps.
 #
 class ReekWorld
-  def run(cmd)
-    stderr_file = Tempfile.new('reek-world')
-    stderr_file.close
-    @last_stdout = `#{cmd} 2> #{stderr_file.path}`
-    @last_exit_status = $CHILD_STATUS.exitstatus
-    @last_stderr = IO.read(stderr_file.path)
-  end
-
   def reek(args)
-    run("ruby -Ilib bin/reek --no-color #{args}")
+    run_simple("reek --no-color #{args}", false)
   end
 
   def reek_with_pipe(stdin, args)
-    run("echo \"#{stdin}\" | ruby -Ilib bin/reek --no-color #{args}")
+    run_interactive("reek --no-color #{args}")
+    type(stdin)
+    close_input
   end
 
   def rake(name, task_def)
-    header = <<EOS
-$:.unshift('lib')
-require 'reek/rake/task'
+    header = <<-EOS.strip_heredoc
+      require 'reek/rake/task'
 
-EOS
-    rakefile = Tempfile.new('rake_task', '.')
-    rakefile.puts(header + task_def)
-    rakefile.close
-    run("rake -f #{rakefile.path} #{name}")
-    lines = @last_stdout.split("\n")
-    if lines.length > 0 && lines[0] =~ /^\(/
-      @last_stdout = lines[1..-1].join("\n")
-    end
+    EOS
+    write_file 'Rakefile', header + task_def
+    run_simple("rake #{name}", false)
   end
 end
 
 World do
   ReekWorld.new
 end
+
+Before do
+  @aruba_timeout_seconds = 30
+end

data/lib/reek.rb

@@ -1,6 +1,6 @@
 #
 # Reek's core functionality
 #
-require 'reek/version'
-require 'reek/examiner'
-require 'reek/smell_warning'
+require_relative 'reek/version'
+require_relative 'reek/examiner'
+require_relative 'reek/smell_warning'

data/lib/reek/cli/application.rb

@@ -1,9 +1,9 @@
-require 'reek/cli/options'
-require 'reek/cli/reek_command'
-require 'reek/configuration/app_configuration'
+require_relative 'options'
+require_relative 'reek_command'
+require_relative '../configuration/app_configuration'
 
 module Reek
-  module Cli
+  module CLI
     #
     # Represents an instance of a Reek application.
     # This is the entry point for all invocations of Reek from the

data/lib/reek/cli/command.rb

@@ -1,5 +1,5 @@
 module Reek
-  module Cli
+  module CLI
     #
     # Base class for all commands
     #

data/lib/reek/cli/input.rb

@@ -1,7 +1,5 @@
-require 'reek/source'
-
 module Reek
-  module Cli
+  module CLI
     #
     # CLI Input utility
     #
@@ -39,7 +37,7 @@ module Reek
       end
 
       def source_from_pipe
-        [$stdin.to_reek_source('$stdin')]
+        [Source::SourceCode.from($stdin)]
       end
     end
   end

data/lib/reek/cli/option_interpreter.rb

@@ -1,16 +1,16 @@
 require 'forwardable'
-require 'reek/cli/input'
-require 'reek/cli/report/report'
-require 'reek/cli/report/formatter'
-require 'reek/cli/report/heading_formatter'
+require_relative 'input'
+require_relative 'report/report'
+require_relative 'report/formatter'
+require_relative 'report/heading_formatter'
 
 module Reek
-  module Cli
+  module CLI
     #
     # Interprets the options set from the command line
     #
     class OptionInterpreter
-      include Cli::Input
+      include CLI::Input
 
       extend Forwardable
 
@@ -33,11 +33,11 @@ module Reek
       def report_class
         case @options.report_format
         when :yaml
-          Report::YamlReport
+          Report::YAMLReport
         when :json
-          Report::JsonReport
+          Report::JSONReport
         when :html
-          Report::HtmlReport
+          Report::HTMLReport
         else # :text
           Report::TextReport
         end

data/lib/reek/cli/options.rb

@@ -1,11 +1,11 @@
 require 'optparse'
 require 'ostruct'
 require 'rainbow'
-require 'reek/cli/option_interpreter'
-require 'reek/version'
+require_relative 'option_interpreter'
+require_relative '../version'
 
 module Reek
-  module Cli
+  module CLI
     #
     # Parses the command line
     #
@@ -64,7 +64,8 @@ module Reek
       def set_configuration_options
         @parser.separator 'Configuration:'
         @parser.on('-c', '--config FILE', 'Read configuration options from FILE') do |file|
-          @options.config_file = file
+          raise ArgumentError, "Config file #{file} doesn't exist" unless File.exist?(file)
+          @options.config_file = Pathname.new(file)
         end
         @parser.on('--smell SMELL', 'Detect smell SMELL (default: all enabled smells)') do |smell|
           @options.smells_to_detect << smell

data/lib/reek/cli/reek_command.rb

@@ -1,8 +1,8 @@
-require 'reek/cli/command'
-require 'reek/examiner'
+require_relative 'command'
+require_relative '../examiner'
 
 module Reek
-  module Cli
+  module CLI
     #
     # A command to collect smells from a set of sources and write them out in
     # text report format.

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

@@ -1,7 +1,7 @@
-require 'reek/cli/report/location_formatter'
+require_relative 'location_formatter'
 
 module Reek
-  module Cli
+  module CLI
     module Report
       #
       # Formatter handling the formatting of the report at large.

data/lib/reek/cli/report/heading_formatter.rb

@@ -1,5 +1,5 @@
 module Reek
-  module Cli
+  module CLI
     module Report
       module HeadingFormatter
         #

data/lib/reek/cli/report/location_formatter.rb

@@ -1,5 +1,5 @@
 module Reek
-  module Cli
+  module CLI
     module Report
       #
       # Formats the location of a warning as an empty string.

data/lib/reek/cli/report/report.rb

@@ -2,7 +2,7 @@ require 'rainbow'
 require 'json'
 
 module Reek
-  module Cli
+  module CLI
     module Report
       #
       # A report that contains the smells and smell counts following source code analysis.
@@ -92,7 +92,7 @@ module Reek
       #
       # Displays a list of smells in YAML format
       # YAML with empty array for 0 smells
-      class YamlReport < Base
+      class YAMLReport < Base
         def show
           print smells.map(&:yaml_hash).to_yaml
         end
@@ -101,7 +101,7 @@ module Reek
       #
       # Displays a list of smells in JSON format
       # JSON with empty array for 0 smells
-      class JsonReport < Base
+      class JSONReport < Base
         def show
           print ::JSON.generate(
             smells.map do |smell|
@@ -114,7 +114,7 @@ module Reek
       #
       # Saves the report as a HTML file
       #
-      class HtmlReport < Base
+      class HTMLReport < Base
         require 'erb'
 
         def show

data/lib/reek/configuration/app_configuration.rb

@@ -15,7 +15,7 @@ module Reek
 
         def initialize_with(options)
           @has_been_initialized = true
-          configuration_file_path = ConfigurationFileFinder.find(options)
+          configuration_file_path = ConfigurationFileFinder.find(options: options)
           return unless configuration_file_path
           load_from_file configuration_file_path
         end

data/lib/reek/configuration/configuration_file_finder.rb

@@ -14,41 +14,26 @@ module Reek
     # The order in which ConfigurationFileFinder tries to find such a
     # configuration file is exactly like above.
     module ConfigurationFileFinder
-      class << self
-        def find(options)
-          configuration_by_cli(options) ||
-            configuration_in_file_system    ||
-            configuration_in_home_directory
-        end
-
-        private
-
-        def configuration_by_cli(options)
-          return unless options # Return gracefully allowing calls without app context
-          config_file_option = options.config_file
-          return unless config_file_option
-          path_name = Pathname.new config_file_option
-          raise ArgumentError, "Config file #{path_name} doesn't exist" unless path_name.exist?
-          path_name
-        end
-
-        def configuration_in_file_system
-          detect_or_traverse_up Pathname.pwd
-        end
+      module_function
 
-        def configuration_in_home_directory
-          detect_configuration_in_directory Pathname.new(Dir.home)
-        end
+      # FIXME: switch to kwargs on upgrade to Ruby 2 and drop `params.fetch` calls:
+      # def find(options: nil, current: Pathname.pwd, home: Pathname.new(Dir.home))
+      def find(params = {})
+        options = params.fetch(:options) { nil                    }
+        current = params.fetch(:current) { Pathname.pwd           }
+        home    = params.fetch(:home)    { Pathname.new(Dir.home) }
+        find_by_cli(options) || find_by_dir(current) || find_by_dir(home)
+      end
 
-        def detect_or_traverse_up(directory)
-          file = detect_configuration_in_directory(directory)
-          return file unless file.nil?
-          return if directory.root?
-          detect_or_traverse_up directory.parent
-        end
+      def find_by_cli(options)
+        options && options.config_file
+      end
 
-        def detect_configuration_in_directory(directory)
-          directory.children.select(&:file?).find { |path| path.to_s.end_with?('.reek') }
+      def find_by_dir(start)
+        start.ascend do |dir|
+          files = dir.children.select(&:file?).sort
+          found = files.find { |file| file.to_s.end_with?('.reek') }
+          return found if found
         end
       end
     end

data/lib/reek/core/code_context.rb

@@ -13,7 +13,7 @@ module Reek
       # Initializes a new CodeContext.
       #
       # context - *_context from the `core` namespace
-      # exp - Reek::Source::AstNode
+      # exp - Reek::Source::ASTNode
       #
       # Examples:
       #

data/lib/reek/core/method_context.rb

@@ -1,5 +1,5 @@
-require 'reek/core/code_context'
-require 'reek/core/object_refs'
+require_relative 'code_context'
+require_relative 'object_refs'
 
 module Reek
   module Core
@@ -58,6 +58,10 @@ module Reek
         @refs.max_keys
       end
 
+      def references_self?
+        exp.depends_on_instance?
+      end
+
       def uses_param?(param)
         local_nodes(:lvar).find { |node| node.var_name == param.to_sym }
       end

data/lib/reek/core/module_context.rb

@@ -1,5 +1,5 @@
-require 'reek/core/code_context'
-require 'reek/source/sexp_formatter'
+require_relative 'code_context'
+require_relative '../source/sexp_formatter'
 
 module Reek
   module Core

data/lib/reek/core/singleton_method_context.rb

@@ -1,4 +1,4 @@
-require 'reek/core/method_context'
+require_relative 'method_context'
 
 module Reek
   module Core

data/lib/reek/core/smell_repository.rb

@@ -1,5 +1,6 @@
-require 'reek/smells'
-require 'reek/smells/smell_detector'
+require_relative '../smells'
+require_relative '../smells/smell_detector'
+require_relative '../configuration/app_configuration'
 
 module Reek
   module Core

data/lib/reek/core/tree_walker.rb

@@ -1,7 +1,7 @@
-require 'reek/core/method_context'
-require 'reek/core/module_context'
-require 'reek/core/stop_context'
-require 'reek/core/singleton_method_context'
+require_relative 'method_context'
+require_relative 'module_context'
+require_relative 'stop_context'
+require_relative 'singleton_method_context'
 
 module Reek
   module Core

data/lib/reek/examiner.rb

@@ -1,7 +1,7 @@
-require 'reek/source/source_repository'
-require 'reek/core/warning_collector'
-require 'reek/core/smell_repository'
-require 'reek/core/tree_walker'
+require_relative 'source/source_repository'
+require_relative 'core/warning_collector'
+require_relative 'core/smell_repository'
+require_relative 'core/tree_walker'
 
 module Reek
   #

data/lib/reek/smells/attribute.rb

@@ -1,6 +1,6 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
-require 'reek/core/smell_configuration'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
+require_relative '../core/smell_configuration'
 
 module Reek
   module Smells

data/lib/reek/smells/boolean_parameter.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/class_variable.rb

@@ -1,6 +1,6 @@
 require 'set'
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/control_parameter.rb

@@ -1,5 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells

data/lib/reek/smells/data_clump.rb

@@ -1,6 +1,5 @@
-require 'reek/smells/smell_detector'
-require 'reek/smell_warning'
-require 'reek/source'
+require_relative 'smell_detector'
+require_relative '../smell_warning'
 
 module Reek
   module Smells