source_code.rb in reek-2.2.0

- old
+ new
@@ -1,43 +1,61 @@
-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
     #
     # 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)
         when IO     then new(source.readlines.join, 'STDIN')
         when String then new(source, 'string')
         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
   end
 end