Move formatter into its own file

Author: kddnewton

CHANGELOG.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 
 ## [Unreleased]
 
+## [2.0.0] - 2022-03-30
+
+### Changed
+
+- Changed `SyntaxTree` from being a class to being a module. The parser functionality is moved into `SyntaxTree::Parser`.
+- There is now a parent class for all of the nodes named `SyntaxTree::Node`.
+
 ## [1.2.0] - 2022-01-09
 
 ### Added

lib/syntax_tree.rb

@@ -5,6 +5,7 @@
 require "ripper"
 require "stringio"
 
+require_relative "syntax_tree/formatter"
 require_relative "syntax_tree/node"
 require_relative "syntax_tree/parser"
 require_relative "syntax_tree/version"
@@ -24,88 +25,20 @@
 end
 
 module SyntaxTree
-  # A slightly enhanced PP that knows how to format recursively including
-  # comments.
-  class Formatter < PP
-    COMMENT_PRIORITY = 1
-    HEREDOC_PRIORITY = 2
-
-    attr_reader :source, :stack, :quote
-
-    def initialize(source, ...)
-      super(...)
-
-      @source = source
-      @stack = []
-      @quote = "\""
-    end
-
-    def format(node, stackable: true)
-      stack << node if stackable
-      doc = nil
-
-      # If there are comments, then we're going to format them around the node
-      # so that they get printed properly.
-      if node.comments.any?
-        leading, trailing = node.comments.partition(&:leading?)
-
-        # Print all comments that were found before the node.
-        leading.each do |comment|
-          comment.format(self)
-          breakable(force: true)
-        end
-
-        # If the node has a stree-ignore comment right before it, then we're
-        # going to just print out the node as it was seen in the source.
-        if leading.last&.ignore?
-          doc = text(source[node.location.start_char...node.location.end_char])
-        else
-          doc = node.format(self)
-        end
-
-        # Print all comments that were found after the node.
-        trailing.each do |comment|
-          line_suffix(priority: COMMENT_PRIORITY) do
-            text(" ")
-            comment.format(self)
-            break_parent
-          end
-        end
-      else
-        doc = node.format(self)
-      end
-
-      stack.pop if stackable
-      doc
-    end
-
-    def format_each(nodes)
-      nodes.each { |node| format(node) }
-    end
-
-    def parent
-      stack[-2]
-    end
-
-    def parents
-      stack[0...-1].reverse_each
-    end
-  end
-
+  # Parses the given source and returns the syntax tree.
   def self.parse(source)
     parser = Parser.new(source)
     response = parser.parse
     response unless parser.error?
   end
 
+  # Parses the given source and returns the formatted source.
   def self.format(source)
-    output = []
-
-    formatter = Formatter.new(source, output)
+    formatter = Formatter.new(source, [])
     parse(source).format(formatter)
 
     formatter.flush
-    output.join
+    formatter.output.join
   end
 
   # Returns the source from the given filepath taking into account any potential

lib/syntax_tree/formatter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module SyntaxTree
+  # A slightly enhanced PP that knows how to format recursively including
+  # comments.
+  class Formatter < PP
+    COMMENT_PRIORITY = 1
+    HEREDOC_PRIORITY = 2
+
+    attr_reader :source, :stack, :quote
+
+    def initialize(source, ...)
+      super(...)
+
+      @source = source
+      @stack = []
+      @quote = "\""
+    end
+
+    def format(node, stackable: true)
+      stack << node if stackable
+      doc = nil
+
+      # If there are comments, then we're going to format them around the node
+      # so that they get printed properly.
+      if node.comments.any?
+        leading, trailing = node.comments.partition(&:leading?)
+
+        # Print all comments that were found before the node.
+        leading.each do |comment|
+          comment.format(self)
+          breakable(force: true)
+        end
+
+        # If the node has a stree-ignore comment right before it, then we're
+        # going to just print out the node as it was seen in the source.
+        if leading.last&.ignore?
+          doc = text(source[node.location.start_char...node.location.end_char])
+        else
+          doc = node.format(self)
+        end
+
+        # Print all comments that were found after the node.
+        trailing.each do |comment|
+          line_suffix(priority: COMMENT_PRIORITY) do
+            text(" ")
+            comment.format(self)
+            break_parent
+          end
+        end
+      else
+        doc = node.format(self)
+      end
+
+      stack.pop if stackable
+      doc
+    end
+
+    def format_each(nodes)
+      nodes.each { |node| format(node) }
+    end
+
+    def parent
+      stack[-2]
+    end
+
+    def parents
+      stack[0...-1].reverse_each
+    end
+  end
+end