Move DSL into its own file

Author: kddnewton

.gitignore

@@ -29,6 +29,7 @@ a.out
 /java/org/yarp/Loader.java
 /java/org/yarp/Nodes.java
 /lib/yarp/dispatcher.rb
+/lib/yarp/dsl.rb
 /lib/yarp/mutation_visitor.rb
 /lib/yarp/node.rb
 /lib/yarp/serialize.rb

docs/configuration.md

@@ -8,6 +8,7 @@ A lot of code in YARP's repository is templated from a single configuration file
 * `java/org/yarp/Loader.java` - for defining how to deserialize the nodes in Java
 * `java/org/yarp/Nodes.java` - for defining the nodes in Java
 * `lib/yarp/dispatcher.rb` - for defining the dispatch visitors for the nodes in Ruby
+* `lib/yarp/dsl.rb` - for defining the DSL for the nodes in Ruby
 * `lib/yarp/mutation_visitor.rb` - for defining the mutation visitor for the nodes in Ruby
 * `lib/yarp/node.rb` - for defining the nodes in Ruby
 * `lib/yarp/serialize.rb` - for defining how to deserialize the nodes in Ruby

lib/yarp.rb

@@ -541,6 +541,7 @@ def self.parse_serialize_file(filepath)
   # of these features.
   autoload :DesugarVisitor, "yarp/desugar_visitor"
   autoload :Dispatcher, "yarp/dispatcher"
+  autoload :DSL, "yarp/dsl"
   autoload :MutationVisitor, "yarp/mutation_visitor"
   autoload :RipperCompat, "yarp/ripper_compat"
   autoload :Pack, "yarp/pack"

templates/lib/yarp/dsl.rb.erb

@@ -0,0 +1,45 @@
+module YARP
+  # The DSL module provides a set of methods that can be used to create YARP
+  # nodes in a more concise manner. For example, instead of writing:
+  #
+  #     source = YARP::Source.new("[1]")
+  #
+  #     YARP::ArrayNode.new(
+  #       [
+  #         YARP::IntegerNode.new(
+  #           YARP::IntegerBaseFlags::DECIMAL,
+  #           YARP::Location.new(source, 1, 1),
+  #         )
+  #       ],
+  #       YARP::Location.new(source, 0, 1),
+  #       YARP::Location.new(source, 2, 1)
+  #     )
+  #
+  # you could instead write:
+  #
+  #     source = YARP::Source.new("[1]")
+  #
+  #     ArrayNode(
+  #       IntegerNode(YARP::IntegerBaseFlags::DECIMAL, Location(source, 1, 1))),
+  #       Location(source, 0, 1),
+  #       Location(source, 2, 1)
+  #     )
+  #
+  # This is mostly helpful in the context of writing tests, but can also be used
+  # to generate trees programmatically.
+  module DSL
+    private
+
+    # Create a new Location object
+    def Location(source = nil, start_offset = 0, length = 0)
+      Location.new(source, start_offset, length)
+    end
+    <%- nodes.each do |node| -%>
+
+    # Create a new <%= node.name %> node
+    def <%= node.name %>(<%= (node.fields.map(&:name) + ["location = Location()"]).join(", ") %>)
+      <%= node.name %>.new(<%= (node.fields.map(&:name) + ["location"]).join(", ") %>)
+    end
+    <%- end -%>
+  end
+end

templates/lib/yarp/node.rb.erb

@@ -181,20 +181,4 @@ module YARP
 <%= "\n" if node != nodes.last -%>
     <%- end -%>
   end
-
-  module DSL
-    private
-
-    # Create a new Location object
-    def Location(source = nil, start_offset = 0, length = 0)
-      Location.new(source, start_offset, length)
-    end
-    <%- nodes.each do |node| -%>
-
-    # Create a new <%= node.name %> node
-    def <%= node.name %>(<%= (node.fields.map(&:name) + ["location = Location()"]).join(", ") %>)
-      <%= node.name %>.new(<%= (node.fields.map(&:name) + ["location"]).join(", ") %>)
-    end
-    <%- end -%>
-  end
 end

templates/template.rb

@@ -367,6 +367,7 @@ def locals
     "java/org/yarp/Nodes.java",
     "java/org/yarp/AbstractNodeVisitor.java",
     "lib/yarp/dispatcher.rb",
+    "lib/yarp/dsl.rb",
     "lib/yarp/mutation_visitor.rb",
     "lib/yarp/node.rb",
     "lib/yarp/serialize.rb",

yarp.gemspec

@@ -61,6 +61,7 @@ Gem::Specification.new do |spec|
     "lib/yarp.rb",
     "lib/yarp/desugar_visitor.rb",
     "lib/yarp/dispatcher.rb",
+    "lib/yarp/dsl.rb",
     "lib/yarp/ffi.rb",
     "lib/yarp/lex_compat.rb",
     "lib/yarp/mutation_visitor.rb",