super-quick-rb 0.0.1

data/rdoc-8.0.0/lib/rdoc/parser/ruby_colorizer.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+require 'prism'
+require 'set'
+
+# Ruby code syntax highlighter.
+# Colorize result is an array of +RDoc::Parser::RubyColorizer::ColoredToken+
+# Actual color for each token kind is determined elsewhere (e.g., HTML generator)
+module RDoc::Parser::RubyColorizer
+
+  ColoredToken = Struct.new(:kind, :text)
+
+  # Prism operator token types except assignment '='
+  OP_TOKENS = %i[
+    AMPERSAND AMPERSAND_AMPERSAND
+    BANG BANG_EQUAL BANG_TILDE CARET COLON COLON_COLON
+    EQUAL_EQUAL EQUAL_GREATER EQUAL_TILDE
+    GREATER GREATER_GREATER
+    LESS LESS_EQUAL LESS_EQUAL_GREATER LESS_LESS
+    MINUS MINUS_GREATER PERCENT PIPE PIPE_PIPE PLUS
+    QUESTION_MARK SLASH STAR STAR_STAR TILDE
+    UAMPERSAND UMINUS UPLUS USTAR USTAR_STAR
+  ].to_set
+
+  # Prism token type to ColoredToken kind map
+  TOKEN_TYPE_MAP = {
+    IDENTIFIER: :identifier,
+    METHOD_NAME: :identifier,
+    INSTANCE_VARIABLE: :ivar,
+    CLASS_VARIABLE: :identifier,
+    GLOBAL_VARIABLE: :identifier,
+    BACK_REFERENCE: :identifier,
+    NUMBERED_REFERENCE: :identifier,
+    CONSTANT: :constant,
+    LABEL: :value,
+    INTEGER: :value,
+    INTEGER_IMAGINARY: :value,
+    INTEGER_RATIONAL: :value,
+    INTEGER_RATIONAL_IMAGINARY: :value,
+    FLOAT: :value,
+    FLOAT_IMAGINARY: :value,
+    FLOAT_RATIONAL: :value,
+    FLOAT_RATIONAL_IMAGINARY: :value,
+    COMMENT: :comment,
+    EMBDOC_BEGIN: :comment,
+    EMBDOC_LINE: :comment,
+    EMBDOC_END: :comment
+  }
+
+  class << self
+
+    # Colorize the entire +code+ and returns colored token stream.
+    def colorize(code)
+      result = Prism.parse_lex(code)
+      program_node, unordered_tokens = result.value
+      prism_tokens = unordered_tokens.map(&:first).sort_by! { |token| token.location.start_offset }
+      partial_colorize(code, program_node, prism_tokens, 0, code.bytesize)
+    end
+
+    # Colorize partial +node+ in +whole_code+ and returns colored token stream.
+    def partial_colorize(whole_code, node, prism_tokens, start_offset = nil, end_offset = nil)
+      start_offset ||= node.location.start_offset
+      end_offset ||= node.location.end_offset
+      visitor = NodeColorizeVisitor.new
+      node.accept(visitor)
+      prior_tokens = visitor.tokens.sort_by {|_, start_offset, _| start_offset }
+      normal_tokens = normal_tokens(slice_by_location(prism_tokens, start_offset, end_offset))
+      colored_tokens = unify_tokens(whole_code, prior_tokens, normal_tokens, start_offset, end_offset)
+      colored_tokens.unshift(ColoredToken.new(:plain, ' ' * node.location.start_column)) if node.location.start_column > 0
+      colored_tokens
+    end
+
+    private
+
+    def slice_by_location(items, start_offset, end_offset)
+      start_index = items.bsearch_index { |item| item.location.end_offset > start_offset } || items.size
+      end_index = items.bsearch_index { |item| item.location.start_offset >= end_offset } || items.size
+      items[start_index...end_index]
+    end
+
+    # Unify prior tokens and normal tokens into a single token stream.
+    # Prior tokens have higher priority than normal tokens.
+    # Also adds missing text (spaces, newlines, etc.) as :plain tokens
+    # so that the entire range is covered.
+    def unify_tokens(whole_code, prior_tokens, normal_tokens, start_offset, end_offset)
+      tokens = []
+      offset = start_offset
+
+      # Add missing text such as spaces and newlines as a separate :plain token
+      flush = -> next_offset {
+        return if offset == next_offset
+
+        whole_code.byteslice(offset...next_offset).scan(/\n|\s+|[^\s]+/) do |text|
+          tokens << ColoredToken.new(:plain, text)
+        end
+      }
+
+      until prior_tokens.empty? && normal_tokens.empty?
+        ptok = prior_tokens.first
+        ntok = normal_tokens.first
+        if ntok && (!ptok || ntok[2] <= ptok[1])
+          token = normal_tokens.shift
+        else
+          token = prior_tokens.shift
+        end
+        kind, start_pos, end_pos = token
+        next if start_pos < offset
+
+        flush.call(start_pos)
+        tokens << ColoredToken.new(kind, whole_code.byteslice(start_pos...end_pos))
+        offset = end_pos
+      end
+      flush.call(end_offset)
+      tokens
+    end
+
+    # Convert normal Prism tokens to [kind, start_offset, end_offset]
+    def normal_tokens(tokens)
+      tokens.map do |token,|
+        kind =
+          if token.type.start_with?('KEYWORD_')
+            :keyword
+          elsif OP_TOKENS.include?(token.type.to_sym)
+            :operator
+          else
+            TOKEN_TYPE_MAP[token.type] || :plain
+          end
+        [kind, token.location.start_offset, token.location.end_offset]
+      end
+    end
+  end
+
+  # Visitor to determine node colorizing which can't be determined by tokens.
+  # STRING_CONTENT/EMBEXPR_BEGIN/EMBEXPR_END in string/regexp/symbol have different colorizing
+  class NodeColorizeVisitor < Prism::Visitor # :nodoc:
+    attr_reader :tokens
+
+    def initialize
+      @tokens = []
+    end
+
+    def visit_symbol_node(node)
+      # SymbolNode#location may contain heredoc content and closing
+      # e.g., `<<A; :\\\nA\nsymbol`
+      # So we need to colorize opening, content and closing separately.
+      push_location(:symbol, node.opening_loc)
+      push_location(:symbol, node.value_loc)
+      push_location(:symbol, node.closing_loc)
+    end
+
+    def visit_interpolated_symbol_node(node)
+      push_location(:symbol, node.opening_loc)
+      handle_interpolated_parts(:symbol, node.parts)
+      push_location(:symbol, node.closing_loc)
+    end
+
+    def visit_regular_expression_node(node)
+      push_location(:regexp, node.location)
+    end
+
+    def visit_interpolated_regular_expression_node(node)
+      push_location(:regexp, node.opening_loc)
+      handle_interpolated_parts(:regexp, node.parts)
+      push_location(:regexp, node.closing_loc)
+    end
+
+    alias visit_match_last_line_node visit_regular_expression_node
+    alias visit_interpolated_match_last_line_node visit_interpolated_regular_expression_node
+
+    def visit_string_node(node)
+      # Node's location may not cover the entire string literal.
+      # For example, in a heredoc string, the node's location covers only the heredoc opening.
+      # We need to colorize opening, content and closing separately.
+      push_location(:string, node.opening_loc)
+      push_location(:string, node.content_loc)
+      push_location(:string, node.closing_loc)
+    end
+
+    def visit_interpolated_string_node(node)
+      push_location(:string, node.opening_loc)
+      handle_interpolated_parts(:string, node.parts)
+      push_location(:string, node.closing_loc)
+    end
+
+    def visit_x_string_node(node)
+      # Same as visit_string_node, node.location of <<`X` only covers opening,
+      # so we need to colorize opening, content and closing separately.
+      push_location(:x_string, node.opening_loc)
+      push_location(:x_string, node.content_loc)
+      push_location(:x_string, node.closing_loc)
+    end
+
+    def visit_interpolated_x_string_node(node)
+      push_location(:x_string, node.opening_loc)
+      handle_interpolated_parts(:x_string, node.parts)
+      push_location(:x_string, node.closing_loc)
+    end
+
+    def visit_array_node(node)
+      super
+      # Colorize %w[...] array literal like string literals, and %i[...] like symbol literals
+      case node.opening
+      when /\A%[wW].\z/
+        push_location(:string, node.opening_loc)
+        push_location(:string, node.closing_loc)
+      when /\A%[iI].\z/
+        push_location(:symbol, node.opening_loc)
+        push_location(:symbol, node.closing_loc)
+      end
+    end
+
+    def visit_def_node(node)
+      # For special colorizing of method name in def node
+      # e.g., `def <=>; end`
+      push_location(:identifier, node.name_loc)
+      super
+    end
+
+    private
+
+    def push_location(kind, location)
+      # Only push tokens that have a non-zero length
+      if location && location.start_offset < location.end_offset
+        @tokens << [kind, location.start_offset, location.end_offset]
+      end
+    end
+
+    def handle_interpolated_parts(kind, parts)
+      # StringNode, EmbeddedStatementsNode brackets, and EmbeddedVariableNode hash in
+      # interpolated regexp/symbol/string parts should be colored as regexp/symbol/string respectively.
+      parts.each do |part|
+        case part
+        when Prism::StringNode
+          # InterpolatedStringNode#parts may have its own opening/closing. e.g., `'a' "b"`
+          push_location(kind, part.opening_loc)
+          push_location(kind, part.content_loc)
+          push_location(kind, part.closing_loc)
+        when Prism::InterpolatedStringNode
+          # InterpolatedStringNode#parts may contain InterpolatedStringNode. e.g., `'a' "#{}"`
+          part.accept(self)
+        when Prism::EmbeddedStatementsNode
+          push_location(kind, part.opening_loc)
+          push_location(kind, part.closing_loc)
+          part.accept(self)
+        when Prism::EmbeddedVariableNode
+          push_location(kind, part.operator_loc)
+        end
+      end
+    end
+  end
+
+  private_constant :NodeColorizeVisitor
+end

data/rdoc-8.0.0/lib/rdoc/parser/simple.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+##
+# Parse a non-source file. We basically take the whole thing as one big
+# comment.
+
+class RDoc::Parser::Simple < RDoc::Parser
+
+  include RDoc::Parser::Text
+
+  parse_files_matching(//)
+
+  attr_reader :content # :nodoc:
+
+  ##
+  # Prepare to parse a plain file
+
+  def initialize(top_level, content, options, stats)
+    super
+
+    preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
+
+    content = RDoc::Text.expand_tabs(@content)
+    @content, = preprocess.run_pre_processes(content, @top_level, 1, :simple)
+  end
+
+  ##
+  # Extract the file contents and attach them to the TopLevel as a comment
+
+  def scan
+    content = remove_coding_comment @content
+
+    comment = RDoc::Comment.new content, @top_level
+
+    @top_level.comment = comment
+    @top_level
+  end
+
+  ##
+  # Removes the encoding magic comment from +text+
+
+  def remove_coding_comment(text)
+    text.sub(/\A# .*coding[=:].*$/, '')
+  end
+end

data/rdoc-8.0.0/lib/rdoc/parser/text.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+##
+# Indicates this parser is text and doesn't contain code constructs.
+#
+# Include this module in a RDoc::Parser subclass to make it show up as a file,
+# not as part of a class or module.
+#--
+# This is not named File to avoid overriding ::File
+
+module RDoc::Parser::Text
+end

data/rdoc-8.0.0/lib/rdoc/parser.rb

@@ -0,0 +1,298 @@
+# -*- coding: us-ascii -*-
+# frozen_string_literal: true
+
+##
+# A parser is simple a class that subclasses RDoc::Parser and implements #scan
+# to fill in an RDoc::TopLevel with parsed data.
+#
+# The initialize method takes an RDoc::TopLevel to fill with parsed content,
+# the name of the file to be parsed, the content of the file, an RDoc::Options
+# object and an RDoc::Stats object to inform the user of parsed items.  The
+# scan method is then called to parse the file and must return the
+# RDoc::TopLevel object.  By calling super these items will be set for you.
+#
+# In order to be used by RDoc the parser needs to register the file extensions
+# it can parse.  Use ::parse_files_matching to register extensions.
+#
+#   require 'rdoc'
+#
+#   class RDoc::Parser::Xyz < RDoc::Parser
+#     parse_files_matching /\.xyz$/
+#
+#     def initialize top_level, file_name, content, options, stats
+#       super
+#
+#       # extra initialization if needed
+#     end
+#
+#     def scan
+#       # parse file and fill in @top_level
+#     end
+#   end
+
+class RDoc::Parser
+
+  @parsers = []
+
+  class << self
+
+    ##
+    # An Array of arrays that maps file extension (or name) regular
+    # expressions to parser classes that will parse matching filenames.
+    #
+    # Use parse_files_matching to register a parser's file extensions.
+
+    attr_reader :parsers
+
+  end
+
+  ##
+  # The name of the file being parsed
+
+  attr_reader :file_name
+
+  ##
+  # Alias an extension to another extension. After this call, files ending
+  # "new_ext" will be parsed using the same parser as "old_ext"
+
+  def self.alias_extension(old_ext, new_ext)
+    old_ext = old_ext.sub(/^\.(.*)/, '\1')
+    new_ext = new_ext.sub(/^\.(.*)/, '\1')
+
+    parser = can_parse_by_name "xxx.#{old_ext}"
+    return false unless parser
+
+    RDoc::Parser.parsers.unshift [/\.#{new_ext}$/, parser]
+
+    true
+  end
+
+  ##
+  # Determines if the file is a "binary" file which basically means it has
+  # content that an RDoc parser shouldn't try to consume.
+
+  def self.binary?(file)
+    return false if file =~ /\.(rdoc|txt)$/
+
+    s = File.read(file, 1024) or return false
+
+    return true if s[0, 2] == Marshal.dump('')[0, 2] or s.index("\x00")
+
+    mode = 'r:utf-8' # default source encoding has been changed to utf-8
+    s.sub!(/\A#!.*\n/, '')     # assume shebang line isn't longer than 1024.
+    encoding = s[/^\s*\#\s*(?:-\*-\s*)?(?:en)?coding:\s*([^\s;]+?)(?:-\*-|[\s;])/, 1]
+    mode = "rb:#{encoding}" if encoding
+    s = File.open(file, mode) {|f| f.gets(nil, 1024)}
+
+    not s.valid_encoding?
+  end
+
+  ##
+  # Checks if +file+ is a zip file in disguise.  Signatures from
+  # http://www.garykessler.net/library/file_sigs.html
+
+  def self.zip?(file)
+    zip_signature = File.read file, 4
+
+    zip_signature == "PK\x03\x04" or
+      zip_signature == "PK\x05\x06" or
+      zip_signature == "PK\x07\x08"
+  rescue
+    false
+  end
+
+  ##
+  # Return a parser that can handle a particular extension
+
+  def self.can_parse(file_name)
+    parser = can_parse_by_name file_name
+
+    # HACK Selenium hides a jar file using a .txt extension
+    return if parser == RDoc::Parser::Simple and zip? file_name
+
+    parser
+  end
+
+  ##
+  # Returns a parser that can handle the extension for +file_name+.  This does
+  # not depend upon the file being readable.
+
+  def self.can_parse_by_name(file_name)
+    _, parser = RDoc::Parser.parsers.find { |regexp,| regexp =~ file_name }
+
+    # The default parser must not parse binary files
+    ext_name = File.extname file_name
+    return parser if ext_name.empty?
+
+    if parser == RDoc::Parser::Simple and ext_name !~ /txt|rdoc/ then
+      case mode = check_modeline(file_name)
+      when nil, 'rdoc' then # continue
+      else
+        RDoc::Parser.parsers.find { |_, p| return p if mode.casecmp?(p.name[/\w+\z/]) }
+        return nil
+      end
+    end
+
+    parser
+  rescue Errno::EACCES
+  end
+
+  ##
+  # Returns the file type from the modeline in +file_name+
+
+  def self.check_modeline(file_name)
+    line = File.open file_name do |io|
+      io.gets
+    end
+
+    /-\*-\s*(.*?\S)\s*-\*-/ =~ line
+
+    return nil unless type = $1
+
+    if /;/ =~ type then
+      return nil unless /(?:\s|\A)mode:\s*([^\s;]+)/i =~ type
+      type = $1
+    end
+
+    return nil if /coding:/i =~ type
+
+    type.downcase
+  rescue ArgumentError
+  rescue Encoding::InvalidByteSequenceError # invalid byte sequence
+
+  end
+
+  ##
+  # Finds and instantiates the correct parser for the given +file_name+ and
+  # +content+.
+
+  def self.for(top_level, content, options, stats)
+    file_name = top_level.absolute_name
+    return if binary? file_name
+
+    parser = use_markup content
+
+    unless parser then
+      parse_name = file_name
+
+      # If no extension, look for shebang
+      if file_name !~ /\.\w+$/ && content =~ %r{\A#!(.+)} then
+        shebang = $1
+        case shebang
+        when %r{env\s+ruby}, %r{/ruby}
+          parse_name = 'dummy.rb'
+        end
+      end
+
+      parser = can_parse parse_name
+    end
+
+    return unless parser
+
+    content = remove_modeline content
+
+    parser.new top_level, content, options, stats
+  rescue SystemCallError
+    nil
+  end
+
+  ##
+  # Record which file types this parser can understand.
+  #
+  # It is ok to call this multiple times.
+
+  def self.parse_files_matching(regexp)
+    RDoc::Parser.parsers.unshift [regexp, self]
+  end
+
+  ##
+  # Removes an emacs-style modeline from the first line of the document
+
+  def self.remove_modeline(content)
+    content.sub(/\A.*-\*-\s*(.*?\S)\s*-\*-.*\r?\n/, '')
+  end
+
+  ##
+  # If there is a <tt>markup: parser_name</tt> comment at the front of the
+  # file, use it to determine the parser.  For example:
+  #
+  #   # markup: rdoc
+  #   # Class comment can go here
+  #
+  #   class C
+  #   end
+  #
+  # The comment should appear as the first line of the +content+.
+  #
+  # If the content contains a shebang or editor modeline the comment may
+  # appear on the second or third line.
+  #
+  # Any comment style may be used to hide the markup comment.
+
+  def self.use_markup(content)
+    markup = content.lines.first(3).grep(/markup:\s+(\w+)/) { $1 }.first
+
+    return unless markup
+
+    # TODO Ruby should be returned only when the filename is correct
+    return RDoc::Parser::Ruby if %w[tomdoc markdown].include? markup
+
+    markup = Regexp.escape markup
+
+    _, selected = RDoc::Parser.parsers.find do |_, parser|
+      /^#{markup}$/i =~ parser.name.sub(/.*:/, '')
+    end
+
+    selected
+  end
+
+  ##
+  # Creates a new Parser storing +top_level+, +file_name+, +content+,
+  # +options+ and +stats+ in instance variables.  In +@preprocess+ an
+  # RDoc::Markup::PreProcess object is created which allows processing of
+  # directives.
+
+  def initialize(top_level, content, options, stats)
+    @top_level = top_level
+    @top_level.parser = self.class
+    @store = @top_level.store
+
+    @file_name = top_level.absolute_name
+    @content = content
+    @options = options
+    @stats = stats
+
+    @preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
+    @preprocess.options = @options
+  end
+
+  autoload :Text, "#{__dir__}/parser/text"
+
+  ##
+  # Normalizes tabs in +body+
+
+  def handle_tab_width(body)
+    if /\t/ =~ body
+      tab_width = @options.tab_width
+      body.split(/\n/).map do |line|
+        1 while line.gsub!(/\t+/) do
+          b, e = $~.offset(0)
+          ' ' * (tab_width * (e-b) - b % tab_width)
+        end
+        line
+      end.join "\n"
+    else
+      body
+    end
+  end
+end
+
+# simple must come first in order to show up last in the parsers list
+require_relative 'parser/simple'
+require_relative 'parser/c'
+require_relative 'parser/changelog'
+require_relative 'parser/markdown'
+require_relative 'parser/rd'
+require_relative 'parser/rbs'
+require_relative 'parser/ruby'
+require_relative 'parser/ruby_colorizer'