Fix up linting in ripper translation

Author: kddnewton

bin/prism

@@ -48,15 +48,19 @@ module Prism
       require "benchmark/ips"
       require "parser/current"
       require "ruby_parser"
+      require "ripper"
 
       filepath = argv.fetch(0) { File.expand_path("../lib/prism/node.rb", __dir__) }
+      source = File.read(filepath)
 
       Benchmark.ips do |x|
-        x.report("prism") { Prism.parse_file(filepath) }
-        x.report("parser") { Parser::CurrentRuby.parse_file(filepath) }
-        x.report("Prism::Translation::Parser") { Prism::Translation::Parser.parse_file(filepath) }
-        x.report("ruby_parser") { RubyParser.new.parse(File.read(filepath), filepath) }
-        x.report("Prism::Translation::RubyParser") { Prism::Translation::RubyParser.parse_file(filepath) }
+        x.report("Prism") { Prism.parse(source, filepath: filepath) }
+        x.report("Ripper::SexpBuilder") { Ripper.sexp_raw(source, filepath) }
+        x.report("Prism::Translation::Ripper::SexpBuilder") { Prism::Translation::Ripper.sexp_raw(source, filepath) }
+        x.report("Parser::CurrentRuby") { Parser::CurrentRuby.parse(source, filepath) }
+        x.report("Prism::Translation::Parser") { Prism::Translation::Parser.parse(source, filepath) }
+        x.report("RubyParser") { RubyParser.new.parse(source, filepath) }
+        x.report("Prism::Translation::RubyParser") { Prism::Translation::RubyParser.new.parse(source, filepath) }
         x.compare!
       end
     end

lib/prism/translation/ripper.rb

@@ -2814,7 +2814,7 @@ def visit_source_file_node(node)
       # ^^^^^^^^
       def visit_source_line_node(node)
         bounds(node.location)
-        on_var_ref(on_kw("__LINE__")) 
+        on_var_ref(on_kw("__LINE__"))
       end
 
       # foo(*bar)
@@ -2943,6 +2943,7 @@ def visit_string_node(node)
         end
       end
 
+      # Visit a heredoc node that is representing a string.
       private def visit_heredoc_string_node(node)
         bounds(node.opening_loc)
         on_heredoc_beg(node.opening)
@@ -2959,6 +2960,7 @@ def visit_string_node(node)
         result
       end
 
+      # Visit a heredoc node that is representing an xstring.
       private def visit_heredoc_x_string_node(node)
         bounds(node.opening_loc)
         on_heredoc_beg(node.opening)

lib/prism/translation/ripper/sexp.rb

@@ -8,8 +8,10 @@ class Ripper
       # This class mirrors the ::Ripper::SexpBuilder subclass of ::Ripper that
       # returns the arrays of [type, *children].
       class SexpBuilder < Ripper
+        # :stopdoc:
+
         attr_reader :error
-    
+
         private
 
         def dedent_element(e, width)
@@ -18,7 +20,7 @@ def dedent_element(e, width)
           end
           e
         end
-    
+
         def on_heredoc_dedent(val, width)
           sub = proc do |cont|
             cont.map! do |e|
@@ -38,7 +40,7 @@ def on_heredoc_dedent(val, width)
           sub[val]
           val
         end
-    
+
         events = private_instance_methods(false).grep(/\Aon_/) {$'.to_sym}
         (PARSER_EVENTS - events).each do |event|
           module_eval(<<-End, __FILE__, __LINE__ + 1)
@@ -47,29 +49,33 @@ def on_#{event}(*args)
             end
           End
         end
-    
+
         SCANNER_EVENTS.each do |event|
           module_eval(<<-End, __FILE__, __LINE__ + 1)
             def on_#{event}(tok)
               [:@#{event}, tok, [lineno(), column()]]
             end
           End
         end
-    
+
         def on_error(mesg)
           @error = mesg
         end
         remove_method :on_parse_error
         alias on_parse_error on_error
         alias compile_error on_error
+
+        # :startdoc:
       end
 
       # This class mirrors the ::Ripper::SexpBuilderPP subclass of ::Ripper that
       # returns the same values as ::Ripper::SexpBuilder except with a couple of
       # niceties that flatten linked lists into arrays.
       class SexpBuilderPP < SexpBuilder
+        # :stopdoc:
+
         private
-    
+
         def on_heredoc_dedent(val, width)
           val.map! do |e|
             next e if Symbol === e and /_content\z/ =~ e
@@ -82,35 +88,37 @@ def on_heredoc_dedent(val, width)
           end
           val
         end
-    
+
         def _dispatch_event_new
           []
         end
-    
+
         def _dispatch_event_push(list, item)
           list.push item
           list
         end
-    
+
         def on_mlhs_paren(list)
           [:mlhs, *list]
         end
-    
+
         def on_mlhs_add_star(list, star)
           list.push([:rest_param, star])
         end
-    
+
         def on_mlhs_add_post(list, post)
           list.concat(post)
         end
-    
+
         PARSER_EVENT_TABLE.each do |event, arity|
           if /_new\z/ =~ event and arity == 0
             alias_method "on_#{event}", :_dispatch_event_new
           elsif /_add\z/ =~ event
             alias_method "on_#{event}", :_dispatch_event_push
           end
         end
+
+        # :startdoc:
       end
     end
   end

lib/prism/translation/ripper/shim.rb

@@ -1,3 +1,5 @@
 # frozen_string_literal: true
 
+# This writes the prism ripper translation into the Ripper constant so that
+# users can transparently use Ripper without any changes.
 Ripper = Prism::Translation::Ripper

lib/prism/translation/ruby_parser.rb

@@ -6,7 +6,7 @@ module Prism
   module Translation
     # This module is the entry-point for converting a prism syntax tree into the
     # seattlerb/ruby_parser gem's syntax tree.
-    module RubyParser
+    class RubyParser
       # A prism visitor that builds Sexp objects.
       class Compiler < ::Prism::Compiler
         # This is the name of the file that we are compiling. We set it on every
@@ -1490,31 +1490,43 @@ def visit_write_value(node)
 
       private_constant :Compiler
 
+      # Parse the given source and translate it into the seattlerb/ruby_parser
+      # gem's Sexp format.
+      def parse(source, filepath = "(string)")
+        translate(Prism.parse(source), filepath)
+      end
+
+      # Parse the given file and translate it into the seattlerb/ruby_parser
+      # gem's Sexp format.
+      def parse_file(filepath)
+        translate(Prism.parse_file(filepath), filepath)
+      end
+
       class << self
         # Parse the given source and translate it into the seattlerb/ruby_parser
         # gem's Sexp format.
         def parse(source, filepath = "(string)")
-          translate(Prism.parse(source), filepath)
+          new.parse(source, filepath)
         end
 
         # Parse the given file and translate it into the seattlerb/ruby_parser
         # gem's Sexp format.
         def parse_file(filepath)
-          translate(Prism.parse_file(filepath), filepath)
+          new.parse_file(filepath)
         end
+      end
 
-        private
-
-        # Translate the given parse result and filepath into the
-        # seattlerb/ruby_parser gem's Sexp format.
-        def translate(result, filepath)
-          if result.failure?
-            error = result.errors.first
-            raise ::RubyParser::SyntaxError, "#{filepath}:#{error.location.start_line} :: #{error.message}"
-          end
+      private
 
-          result.value.accept(Compiler.new(filepath))
+      # Translate the given parse result and filepath into the
+      # seattlerb/ruby_parser gem's Sexp format.
+      def translate(result, filepath)
+        if result.failure?
+          error = result.errors.first
+          raise ::RubyParser::SyntaxError, "#{filepath}:#{error.location.start_line} :: #{error.message}"
         end
+
+        result.value.accept(Compiler.new(filepath))
       end
     end
   end

rakelib/lint.rake

@@ -48,12 +48,12 @@ task :lint do
 
     File.foreach(filepath).with_index(1) do |line, index|
       if line.match?(/[ \t]+$/)
-        warn("Trailing spaces found in #{filepath} on line #{index}")
+        warn("Trailing spaces found in #{filepath}:#{index}")
         failed = true
       end
 
       if line.match?(/^\t/)
-        warn("Tabs found in #{filepath} on line #{index}")
+        warn("Tabs found in #{filepath}:#{index}")
         failed = true
       end
     end