Nodoc translator implementation details

As well as some functionality from ripper that is nodoc in ruby

Author: Earlopain

lib/prism/translation/parser.rb

@@ -33,7 +33,7 @@ class Parser < ::Parser::Base
       # The parser gem has a list of diagnostics with a hard-coded set of error
       # messages. We create our own diagnostic class in order to set our own
       # error messages.
-      class PrismDiagnostic < Diagnostic
+      class PrismDiagnostic < Diagnostic # :nodoc:
         # This is the cached message coming from prism.
         attr_reader :message
 

lib/prism/translation/parser/compiler.rb

@@ -6,9 +6,9 @@ module Translation
     class Parser
       # A visitor that knows how to convert a prism syntax tree into the
       # whitequark/parser gem's syntax tree.
-      class Compiler < ::Prism::Compiler
+      class Compiler < ::Prism::Compiler # :nodoc:
         # Raised when the tree is malformed or there is a bug in the compiler.
-        class CompilationError < StandardError
+        class CompilationError < StandardError # :nodoc:
         end
 
         # The Parser::Base instance that is being used to build the AST.

lib/prism/translation/parser/lexer.rb

@@ -10,7 +10,7 @@ module Translation
     class Parser
       # Accepts a list of prism tokens and converts them into the expected
       # format for the parser gem.
-      class Lexer
+      class Lexer # :nodoc:
         # These tokens are always skipped
         TYPES_ALWAYS_SKIP = Set.new(%i[IGNORED_NEWLINE __END__ EOF])
         private_constant :TYPES_ALWAYS_SKIP
@@ -188,8 +188,8 @@ class Lexer
         # without them. We should find another way to do this, but in the
         # meantime we'll hide them from the documentation and mark them as
         # private constants.
-        EXPR_BEG = 0x1 # :nodoc:
-        EXPR_LABEL = 0x400 # :nodoc:
+        EXPR_BEG = 0x1
+        EXPR_LABEL = 0x400
 
         # It is used to determine whether `do` is of the token type `kDO` or `kDO_LAMBDA`.
         #
@@ -232,7 +232,7 @@ def initialize(source_buffer, lexed, offset_cache)
           @offset_cache = offset_cache
         end
 
-        Range = ::Parser::Source::Range # :nodoc:
+        Range = ::Parser::Source::Range
         private_constant :Range
 
         # Convert the prism tokens into the expected format for the parser gem.

lib/prism/translation/ripper.rb

@@ -594,6 +594,8 @@ def parse
       # Visitor methods
       ##########################################################################
 
+      # :stopdoc:
+
       # alias foo bar
       # ^^^^^^^^^^^^^
       def visit_alias_method_node(node)
@@ -3458,6 +3460,8 @@ def bounds(location)
         @column = location.start_column
       end
 
+      # :startdoc:
+
       ##########################################################################
       # Ripper interface
       ##########################################################################

lib/prism/translation/ripper/lexer.rb

@@ -7,8 +7,7 @@ module Prism
   module Translation
     class Ripper
       class Lexer < Ripper # :nodoc:
-        # :stopdoc:
-        class State
+        class State # :nodoc:
           attr_reader :to_int, :to_s
 
           def initialize(i)
@@ -48,7 +47,7 @@ def self.[](i)
           end
         end
 
-        class Elem
+        class Elem # :nodoc:
           attr_accessor :pos, :event, :tok, :state, :message
 
           def initialize(pos, event, tok, state, message = nil)
@@ -128,8 +127,6 @@ def parse(...)
         def scan(...)
           parse(...)
         end
-
-        # :startdoc:
       end
     end
   end

lib/prism/translation/ripper/sexp.rb

@@ -8,9 +8,7 @@ module Translation
     class Ripper
       # This class mirrors the ::Ripper::SexpBuilder subclass of ::Ripper that
       # returns the arrays of [type, *children].
-      class SexpBuilder < Ripper
-        # :stopdoc:
-
+      class SexpBuilder < Ripper # :nodoc:
         attr_reader :error
 
         private
@@ -65,16 +63,12 @@ def on_error(mesg)
         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:
-
+      class SexpBuilderPP < SexpBuilder # :nodoc:
         private
 
         def on_heredoc_dedent(val, width)
@@ -118,8 +112,6 @@ def on_mlhs_add_post(list, post)
             alias_method "on_#{event}", :_dispatch_event_push
           end
         end
-
-        # :startdoc:
       end
     end
   end

lib/prism/translation/ruby_parser.rb

@@ -19,7 +19,7 @@ module Translation
     # seattlerb/ruby_parser gem's syntax tree.
     class RubyParser
       # A prism visitor that builds Sexp objects.
-      class Compiler < ::Prism::Compiler
+      class Compiler < ::Prism::Compiler # :nodoc:
         # This is the name of the file that we are compiling. We set it on every
         # Sexp object that is generated, and also use it to compile `__FILE__`
         # nodes.