More utility functions

Author: kddnewton

lib/syntax_tree.rb

@@ -60,9 +60,36 @@ def self.format(
     maxwidth = DEFAULT_PRINT_WIDTH,
     base_indentation = DEFAULT_INDENTATION,
     options: Formatter::Options.new
+  )
+    format_node(
+      source,
+      parse(source),
+      maxwidth,
+      base_indentation,
+      options: options
+    )
+  end
+
+  # Parses the given file and returns the formatted source.
+  def self.format_file(
+    filepath,
+    maxwidth = DEFAULT_PRINT_WIDTH,
+    base_indentation = DEFAULT_INDENTATION,
+    options: Formatter::Options.new
+  )
+    format(read(filepath), maxwidth, base_indentation, options: options)
+  end
+
+  # Accepts a node in the tree and returns the formatted source.
+  def self.format_node(
+    source,
+    node,
+    maxwidth = DEFAULT_PRINT_WIDTH,
+    base_indentation = DEFAULT_INDENTATION,
+    options: Formatter::Options.new
   )
     formatter = Formatter.new(source, [], maxwidth, options: options)
-    parse(source).format(formatter)
+    node.format(formatter)
 
     formatter.flush(base_indentation)
     formatter.output.join
@@ -130,4 +157,10 @@ def self.search(source, query, &block)
 
     Search.new(pattern).scan(program, &block)
   end
+
+  # Searches through the given file using the given pattern and yields each
+  # node in the tree that matches the pattern to the given block.
+  def self.search_file(filepath, query, &block)
+    search(read(filepath), query, &block)
+  end
 end

lib/syntax_tree/mermaid_visitor.rb

@@ -29,11 +29,7 @@ def field(name, value)
         flowchart.link(target, visit(value), name)
       else
         to =
-          flowchart.node(
-            "#{target.id}_#{name}",
-            value.inspect,
-            shape: :stadium
-          )
+          flowchart.node("#{target.id}_#{name}", value.inspect, shape: :stadium)
         flowchart.link(target, to, name)
       end
     end

lib/syntax_tree/mutation_visitor.rb

@@ -35,10 +35,7 @@ def visit(node)
 
     # Visit a BEGINBlock node.
     def visit_BEGIN(node)
-      node.copy(
-        lbrace: visit(node.lbrace),
-        statements: visit(node.statements)
-      )
+      node.copy(lbrace: visit(node.lbrace), statements: visit(node.statements))
     end
 
     # Visit a CHAR node.
@@ -48,10 +45,7 @@ def visit_CHAR(node)
 
     # Visit a ENDBlock node.
     def visit_END(node)
-      node.copy(
-        lbrace: visit(node.lbrace),
-        statements: visit(node.statements)
-      )
+      node.copy(lbrace: visit(node.lbrace), statements: visit(node.statements))
     end
 
     # Visit a EndContent node.
@@ -101,10 +95,7 @@ def visit_args_forward(node)
 
     # Visit a ArrayLiteral node.
     def visit_array(node)
-      node.copy(
-        lbracket: visit(node.lbracket),
-        contents: visit(node.contents)
-      )
+      node.copy(lbracket: visit(node.lbracket), contents: visit(node.contents))
     end
 
     # Visit a AryPtn node.
@@ -493,10 +484,7 @@ def visit_label_end(node)
 
     # Visit a Lambda node.
     def visit_lambda(node)
-      node.copy(
-        params: visit(node.params),
-        statements: visit(node.statements)
-      )
+      node.copy(params: visit(node.params), statements: visit(node.statements))
     end
 
     # Visit a LambdaVar node.
@@ -541,10 +529,7 @@ def visit_mlhs_paren(node)
 
     # Visit a ModuleDeclaration node.
     def visit_module(node)
-      node.copy(
-        constant: visit(node.constant),
-        bodystmt: visit(node.bodystmt)
-      )
+      node.copy(constant: visit(node.constant), bodystmt: visit(node.bodystmt))
     end
 
     # Visit a MRHS node.

lib/syntax_tree/with_environment.rb

@@ -5,22 +5,25 @@ module SyntaxTree
   # from Visitor. The module overrides a few visit methods to automatically keep
   # track of local variables and arguments defined in the current environment.
   # Example usage:
-  #   class MyVisitor < Visitor
-  #     include WithEnvironment
   #
-  #     def visit_ident(node)
-  #       # Check if we're visiting an identifier for an argument, a local
-  #       variable or something else
-  #       local = current_environment.find_local(node)
+  #     class MyVisitor < Visitor
+  #       include WithEnvironment
   #
-  #       if local.type == :argument
-  #         # handle identifiers for arguments
-  #       elsif local.type == :variable
-  #         # handle identifiers for variables
-  #       else
-  #         # handle other identifiers, such as method names
+  #       def visit_ident(node)
+  #         # Check if we're visiting an identifier for an argument, a local
+  #         # variable or something else
+  #         local = current_environment.find_local(node)
+  #
+  #         if local.type == :argument
+  #           # handle identifiers for arguments
+  #         elsif local.type == :variable
+  #           # handle identifiers for variables
+  #         else
+  #           # handle other identifiers, such as method names
+  #         end
   #       end
-  #   end
+  #     end
+  #
   module WithEnvironment
     # The environment class is used to keep track of local variables and
     # arguments inside a particular scope
@@ -37,19 +40,16 @@ class Local
         # [Array[Location]] The locations of all usages of this local
         attr_reader :usages
 
-        #   initialize: (Symbol type) -> void
         def initialize(type)
           @type = type
           @definitions = []
           @usages = []
         end
 
-        #   add_definition: (Location location) -> void
         def add_definition(location)
           @definitions << location
         end
 
-        #   add_usage: (Location location) -> void
         def add_usage(location)
           @usages << location
         end
@@ -62,17 +62,15 @@ def add_usage(location)
       # [Environment | nil] The parent environment
       attr_reader :parent
 
-      #   initialize: (Environment | nil parent) -> void
       def initialize(parent = nil)
         @locals = {}
         @parent = parent
       end
 
       # Adding a local definition will either insert a new entry in the locals
-      # hash or append a new definition location to an existing local. Notice that
-      # it's not possible to change the type of a local after it has been
-      # registered
-      #   add_local_definition: (Ident | Label identifier, Symbol type) -> void
+      # hash or append a new definition location to an existing local. Notice
+      # that it's not possible to change the type of a local after it has been
+      # registered.
       def add_local_definition(identifier, type)
         name = identifier.value.delete_suffix(":")
 
@@ -83,8 +81,7 @@ def add_local_definition(identifier, type)
       # Adding a local usage will either insert a new entry in the locals
       # hash or append a new usage location to an existing local. Notice that
       # it's not possible to change the type of a local after it has been
-      # registered
-      #   add_local_usage: (Ident | Label identifier, Symbol type) -> void
+      # registered.
       def add_local_usage(identifier, type)
         name = identifier.value.delete_suffix(":")
 
@@ -93,8 +90,7 @@ def add_local_usage(identifier, type)
       end
 
       # Try to find the local given its name in this environment or any of its
-      # parents
-      #   find_local: (String name) -> Local | nil
+      # parents.
       def find_local(name)
         local = @locals[name]
         return local unless local.nil?
@@ -116,7 +112,7 @@ def with_new_environment
     end
 
     # Visits for nodes that create new environments, such as classes, modules
-    # and method definitions
+    # and method definitions.
     def visit_class(node)
       with_new_environment { super }
     end
@@ -127,7 +123,7 @@ def visit_module(node)
 
     # When we find a method invocation with a block, only the code that happens
     # inside of the block needs a fresh environment. The method invocation
-    # itself happens in the same environment
+    # itself happens in the same environment.
     def visit_method_add_block(node)
       visit(node.call)
       with_new_environment { visit(node.block) }
@@ -138,7 +134,7 @@ def visit_def(node)
     end
 
     # Visit for keeping track of local arguments, such as method and block
-    # arguments
+    # arguments.
     def visit_params(node)
       add_argument_definitions(node.requireds)