super-quick-rb 0.0.1

data/rdoc-8.0.0/lib/rdoc/code_object/constant.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+##
+# A constant
+
+class RDoc::Constant < RDoc::CodeObject
+
+  MARSHAL_VERSION = 0 # :nodoc:
+
+  ##
+  # Sets the module or class this is constant is an alias for.
+
+  attr_writer :is_alias_for
+
+  ##
+  # The constant's name
+
+  attr_accessor :name
+
+  ##
+  # The constant's value
+
+  attr_accessor :value
+
+  ##
+  # The constant's visibility
+
+  attr_accessor :visibility
+
+  ##
+  # The constant path on the RHS when the RHS is a bare constant reference
+  # (+Foo = Bar+ or +Foo = Bar::Baz+). Captured at parse time so
+  # #resolved_alias_target doesn't have to re-derive it from the textual
+  # #value. nil for other RHS shapes.
+
+  attr_accessor :is_alias_for_path
+
+  ##
+  # Creates a new constant with +name+, +value+ and +comment+
+
+  def initialize(name, value, comment)
+    super()
+
+    @name  = name
+    @value = value
+
+    @is_alias_for      = nil
+    @is_alias_for_path = nil
+    @visibility        = :public
+
+    self.comment = comment
+  end
+
+  ##
+  # Constants are ordered by name
+
+  def <=>(other)
+    return unless self.class === other
+
+    [parent_name, name] <=> [other.parent_name, other.name]
+  end
+
+  ##
+  # Constants are equal when their #parent and #name is the same
+
+  def ==(other)
+    self.class == other.class and
+      @parent == other.parent and
+      @name == other.name
+  end
+
+  ##
+  # A constant is documented if it has a comment, or is an alias
+  # for a documented class or module.
+
+  def documented?
+    return true if super
+    return false unless @is_alias_for
+    case @is_alias_for
+    when String then
+      found = @store.find_class_or_module @is_alias_for
+      return false unless found
+      @is_alias_for = found
+    end
+    @is_alias_for.documented?
+  end
+
+  ##
+  # Full constant name including namespace
+
+  def full_name
+    @full_name ||= "#{parent_name}::#{@name}"
+  end
+
+  ##
+  # The module or class this constant is an alias for, when one was recorded
+  # explicitly (by RDoc::Context#add_module_alias, RDoc::ClassModule#update_aliases,
+  # or ri marshal load). Pure accessor; see #resolved_alias_target for the
+  # opportunistic lookup path.
+
+  def is_alias_for
+    case @is_alias_for
+    when String then
+      found = @store.find_class_or_module @is_alias_for
+      @is_alias_for = found if found
+      @is_alias_for
+    else
+      @is_alias_for
+    end
+  end
+
+  ##
+  # Returns the class/module this constant *would* alias if #is_alias_for_path
+  # was set by the parser and that path resolves to a known class/module, or
+  # nil. Used to support `Const = RHS` parsed before `class RHS;end` is defined
+  # in another file. Pure lookup; does not mutate state. Honors :nodoc:
+  # (returns nil if document_self is false). Note that module nesting
+  # information is lost, so constant lookup is inaccurate.
+
+  def resolved_alias_target
+    return nil unless document_self
+    return nil unless @is_alias_for_path
+    parent.find_module_named(@is_alias_for_path)
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x %s::%s>" % [
+      self.class, object_id,
+      parent_name, @name,
+    ]
+  end
+
+  ##
+  # Dumps this Constant for use by ri.  See also #marshal_load
+
+  def marshal_dump
+    alias_name = case found = is_alias_for
+                 when RDoc::CodeObject then found.full_name
+                 else                       found
+                 end
+
+    [ MARSHAL_VERSION,
+      @name,
+      full_name,
+      @visibility,
+      alias_name,
+      parse(@comment),
+      @file.relative_name,
+      parent.name,
+      parent.class,
+      section.title,
+    ]
+  end
+
+  ##
+  # Loads this Constant from +array+.  For a loaded Constant the following
+  # methods will return cached values:
+  #
+  # * #full_name
+  # * #parent_name
+
+  def marshal_load(array)
+    initialize array[1], nil, RDoc::Comment.from_document(array[5])
+
+    @full_name     = array[2]
+    @visibility    = array[3] || :public
+    @is_alias_for  = array[4]
+    #                      5 handled above
+    #                      6 handled below
+    @parent_name   = array[7]
+    @parent_class  = array[8]
+    @section_title = array[9]
+
+    @file = RDoc::TopLevel.new array[6]
+  end
+
+  ##
+  # Path to this constant for use with HTML generator output.
+
+  def path
+    "#{@parent.path}##{@name}"
+  end
+
+  ##
+  # Returns an HTML snippet of the comment for search results.
+
+  def search_snippet
+    return '' if comment.empty?
+
+    snippet(comment)
+  end
+
+  def pretty_print(q) # :nodoc:
+    q.group 2, "[#{self.class.name} #{full_name}", "]" do
+      unless comment.empty? then
+        q.breakable
+        q.text "comment:"
+        q.breakable
+        q.pp @comment
+      end
+    end
+  end
+
+  ##
+  # Sets the store for this class or module and its contained code objects.
+
+  def store=(store)
+    super
+
+    @file = @store.add_file @file.full_name if @file
+  end
+
+  def to_s # :nodoc:
+    parent_name = parent ? parent.full_name : '(unknown)'
+    if is_alias_for
+      "constant #{parent_name}::#@name -> #{is_alias_for}"
+    else
+      "constant #{parent_name}::#@name"
+    end
+  end
+
+end

data/rdoc-8.0.0/lib/rdoc/code_object/context/section.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+require 'cgi/escape'
+require 'cgi/util' unless defined?(CGI::EscapeExt)
+
+##
+# A section of documentation like:
+#
+#   # :section: The title
+#   # The body
+#
+# Sections can be referenced multiple times and will be collapsed into a
+# single section.
+
+class RDoc::Context::Section
+
+  include RDoc::Text
+
+  MARSHAL_VERSION = 0 # :nodoc:
+
+  ##
+  # Section comments
+
+  attr_reader :comments
+
+  ##
+  # Context this Section lives in
+
+  attr_reader :parent
+
+  ##
+  # Section title
+
+  attr_reader :title
+
+  ##
+  # The RDoc::Store for this object.
+
+  attr_reader :store
+
+  ##
+  # Creates a new section with +title+ and +comment+
+
+  def initialize(parent, title, comment, store = nil)
+    @parent = parent
+    @title = title ? title.strip : title
+    @store = store
+
+    @comments = []
+
+    add_comment comment
+  end
+
+  ##
+  # Sections are equal when they have the same #title
+
+  def ==(other)
+    self.class === other and @title == other.title
+  end
+
+  alias eql? ==
+
+  ##
+  # Adds +comment+ to this section
+
+  def add_comment(comment)
+    Array(comment).each do |c|
+      next if c.nil?
+      raise TypeError, "unknown comment #{c.inspect}" unless RDoc::Comment === c
+      @comments << c unless c.empty?
+    end
+  end
+
+  ##
+  # Anchor reference for linking to this section using GitHub-style format.
+  #
+  # Examples:
+  #   "Section"     -> "section"
+  #   "One Two"     -> "one-two"
+  #   "[untitled]"  -> "untitled"
+
+  def aref
+    title = @title || '[untitled]'
+
+    RDoc::Text.to_anchor(title)
+  end
+
+  ##
+  # Legacy anchor reference for backward compatibility.
+  #
+  # Examples:
+  #   "Section"     -> "section"
+  #   "One Two"     -> "one+two"
+  #   "[untitled]"  -> "5Buntitled-5D"
+
+  def legacy_aref
+    title = @title || '[untitled]'
+
+    CGI.escape(title).gsub('%', '-').sub(/^-/, '')
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x %p>" % [self.class, object_id, title]
+  end
+
+  def hash # :nodoc:
+    @title.hash
+  end
+
+  ##
+  # The files comments in this section come from
+
+  def in_files
+    @comments.map(&:file)
+  end
+
+  ##
+  # Serializes this Section.  The title and parsed comment are saved, but not
+  # the section parent which must be restored manually.
+
+  def marshal_dump
+    [
+      MARSHAL_VERSION,
+      @title,
+      to_document,
+    ]
+  end
+
+  ##
+  # De-serializes this Section.  The section parent must be restored manually.
+
+  def marshal_load(array)
+    @parent  = nil
+
+    @title    = array[1]
+    @comments = array[2].parts.map { |doc| RDoc::Comment.from_document(doc) }
+  end
+
+  ##
+  # Parses +comment_location+ into an RDoc::Markup::Document composed of
+  # multiple RDoc::Markup::Documents with their file set.
+
+  def to_document
+    RDoc::Markup::Document.new(*@comments.map(&:parse))
+  end
+
+  ##
+  # The section's title, or 'Top Section' if the title is nil.
+  #
+  # This is used by the table of contents template so the name is silly.
+
+  def plain_html
+    @title || 'Top Section'
+  end
+
+  ##
+  # Section comment
+
+  def comment
+    return nil if @comments.empty?
+    RDoc::Comment.from_document(to_document)
+  end
+
+  def description
+    return '' if @comments.empty?
+    markup comment
+  end
+
+  def language
+    @comments.first&.language
+  end
+
+  ##
+  # Removes a comment from this section if it is from the same file as
+  # +comment+
+
+  def remove_comment(target_comment)
+    @comments.delete_if do |stored_comment|
+      stored_comment.file == target_comment.file
+    end
+  end
+
+end