docspring 3.0.0 → 3.1.0

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/code_object/normal_module.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+##
+# A normal module, like NormalClass
+
+class RDoc::NormalModule < RDoc::ClassModule
+
+  def aref_prefix # :nodoc:
+    'module'
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x module %s includes: %p extends: %p attributes: %p methods: %p aliases: %p>" % [
+      self.class, object_id,
+      full_name, @includes, @extends, @attributes, @method_list, @aliases
+    ]
+  end
+
+  ##
+  # The definition of this module, <tt>module MyModuleName</tt>
+
+  def definition
+    "module #{full_name}"
+  end
+
+  ##
+  # This is a module, returns true
+
+  def module?
+    true
+  end
+
+  def pretty_print q # :nodoc:
+    q.group 2, "[module #{full_name}:", "]" do
+      q.breakable
+      q.text "includes:"
+      q.breakable
+      q.seplist @includes do |inc| q.pp inc end
+      q.breakable
+
+      q.breakable
+      q.text "constants:"
+      q.breakable
+      q.seplist @constants do |const| q.pp const end
+
+      q.text "attributes:"
+      q.breakable
+      q.seplist @attributes do |attr| q.pp attr end
+      q.breakable
+
+      q.text "methods:"
+      q.breakable
+      q.seplist @method_list do |meth| q.pp meth end
+      q.breakable
+
+      q.text "aliases:"
+      q.breakable
+      q.seplist @aliases do |aliaz| q.pp aliaz end
+      q.breakable
+
+      q.text "comment:"
+      q.breakable
+      q.pp comment
+    end
+  end
+
+  ##
+  # Modules don't have one, raises NoMethodError
+
+  def superclass
+    raise NoMethodError, "#{full_name} is a module"
+  end
+
+end

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/code_object/require.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+##
+# A file loaded by \#require
+
+class RDoc::Require < RDoc::CodeObject
+
+  ##
+  # Name of the required file
+
+  attr_accessor :name
+
+  ##
+  # Creates a new Require that loads +name+ with +comment+
+
+  def initialize(name, comment)
+    super()
+    @name = name.gsub(/'|"/, "") #'
+    @top_level = nil
+    self.comment = comment
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x require '%s' in %s>" % [
+      self.class,
+      object_id,
+      @name,
+      parent_file_name,
+    ]
+  end
+
+  def to_s # :nodoc:
+    "require #{name} in: #{parent}"
+  end
+
+  ##
+  # The RDoc::TopLevel corresponding to this require, or +nil+ if not found.
+
+  def top_level
+    @top_level ||= begin
+      tl = RDoc::TopLevel.all_files_hash[name + '.rb']
+
+      if tl.nil? and RDoc::TopLevel.all_files.first.full_name =~ %r(^lib/) then
+        # second chance
+        tl = RDoc::TopLevel.all_files_hash['lib/' + name + '.rb']
+      end
+
+      tl
+    end
+  end
+
+end

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/code_object/single_class.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+##
+# A singleton class
+
+class RDoc::SingleClass < RDoc::ClassModule
+
+  ##
+  # Adds the superclass to the included modules.
+
+  def ancestors
+    superclass ? super + [superclass] : super
+  end
+
+  def aref_prefix # :nodoc:
+    'sclass'
+  end
+
+  ##
+  # The definition of this singleton class, <tt>class << MyClassName</tt>
+
+  def definition
+    "class << #{full_name}"
+  end
+
+  def pretty_print q # :nodoc:
+    q.group 2, "[class << #{full_name}", "]" do
+      next
+    end
+  end
+end

data/vendor/bundle/ruby/3.3.0/gems/rdoc-6.12.0/lib/rdoc/code_object/top_level.rb

@@ -0,0 +1,291 @@
+# frozen_string_literal: true
+##
+# A TopLevel context is a representation of the contents of a single file
+
+class RDoc::TopLevel < RDoc::Context
+
+  MARSHAL_VERSION = 0 # :nodoc:
+
+  ##
+  # This TopLevel's File::Stat struct
+
+  attr_accessor :file_stat
+
+  ##
+  # Relative name of this file
+
+  attr_accessor :relative_name
+
+  ##
+  # Absolute name of this file
+
+  attr_accessor :absolute_name
+
+  ##
+  # All the classes or modules that were declared in
+  # this file. These are assigned to either +#classes_hash+
+  # or +#modules_hash+ once we know what they really are.
+
+  attr_reader :classes_or_modules
+
+  attr_accessor :diagram # :nodoc:
+
+  ##
+  # The parser class that processed this file
+
+  attr_reader :parser
+
+  ##
+  # Creates a new TopLevel for the file at +absolute_name+.  If documentation
+  # is being generated outside the source dir +relative_name+ is relative to
+  # the source directory.
+
+  def initialize absolute_name, relative_name = absolute_name
+    super()
+    @name = nil
+    @absolute_name = absolute_name
+    @relative_name = relative_name
+    @file_stat     = File.stat(absolute_name) rescue nil # HACK for testing
+    @diagram       = nil
+    @parser        = nil
+
+    @classes_or_modules = []
+  end
+
+  ##
+  # Sets the parser for this toplevel context, also the store.
+
+  def parser=(val)
+    @parser = val
+    @store.update_parser_of_file(absolute_name, val) if @store
+    @parser
+  end
+
+  ##
+  # An RDoc::TopLevel is equal to another with the same relative_name
+
+  def == other
+    self.class === other and @relative_name == other.relative_name
+  end
+
+  alias eql? ==
+
+  ##
+  # Adds +an_alias+ to +Object+ instead of +self+.
+
+  def add_alias(an_alias)
+    object_class.record_location self
+    return an_alias unless @document_self
+    object_class.add_alias an_alias
+  end
+
+  ##
+  # Adds +constant+ to +Object+ instead of +self+.
+
+  def add_constant constant
+    object_class.record_location self
+    return constant unless @document_self
+    object_class.add_constant constant
+  end
+
+  ##
+  # Adds +include+ to +Object+ instead of +self+.
+
+  def add_include(include)
+    object_class.record_location self
+    return include unless @document_self
+    object_class.add_include include
+  end
+
+  ##
+  # Adds +method+ to +Object+ instead of +self+.
+
+  def add_method(method)
+    object_class.record_location self
+    return method unless @document_self
+    object_class.add_method method
+  end
+
+  ##
+  # Adds class or module +mod+. Used in the building phase
+  # by the Ruby parser.
+
+  def add_to_classes_or_modules mod
+    @classes_or_modules << mod
+  end
+
+  ##
+  # Base name of this file
+
+  def base_name
+    File.basename @relative_name
+  end
+
+  alias name base_name
+
+  ##
+  # Only a TopLevel that contains text file) will be displayed.  See also
+  # RDoc::CodeObject#display?
+
+  def display?
+    text? and super
+  end
+
+  ##
+  # See RDoc::TopLevel::find_class_or_module
+  #--
+  # TODO Why do we search through all classes/modules found, not just the
+  #       ones of this instance?
+
+  def find_class_or_module name
+    @store.find_class_or_module name
+  end
+
+  ##
+  # Finds a class or module named +symbol+
+
+  def find_local_symbol(symbol)
+    find_class_or_module(symbol) || super
+  end
+
+  ##
+  # Finds a module or class with +name+
+
+  def find_module_named(name)
+    find_class_or_module(name)
+  end
+
+  ##
+  # Returns the relative name of this file
+
+  def full_name
+    @relative_name
+  end
+
+  ##
+  # An RDoc::TopLevel has the same hash as another with the same
+  # relative_name
+
+  def hash
+    @relative_name.hash
+  end
+
+  ##
+  # URL for this with a +prefix+
+
+  def http_url(prefix)
+    path = [prefix, @relative_name.tr('.', '_')]
+
+    File.join(*path.compact) + '.html'
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x %p modules: %p classes: %p>" % [
+      self.class, object_id,
+      base_name,
+      @modules.map { |n, m| m },
+      @classes.map { |n, c| c }
+    ]
+  end
+
+  ##
+  # Time this file was last modified, if known
+
+  def last_modified
+    @file_stat ? file_stat.mtime : nil
+  end
+
+  ##
+  # Dumps this TopLevel for use by ri.  See also #marshal_load
+
+  def marshal_dump
+    [
+      MARSHAL_VERSION,
+      @relative_name,
+      @parser,
+      parse(@comment),
+    ]
+  end
+
+  ##
+  # Loads this TopLevel from +array+.
+
+  def marshal_load array # :nodoc:
+    initialize array[1]
+
+    @parser  = array[2]
+    @comment = RDoc::Comment.from_document array[3]
+
+    @file_stat          = nil
+  end
+
+  ##
+  # Returns the NormalClass "Object", creating it if not found.
+  #
+  # Records +self+ as a location in "Object".
+
+  def object_class
+    @object_class ||= begin
+      oc = @store.find_class_named('Object') || add_class(RDoc::NormalClass, 'Object')
+      oc.record_location self
+      oc
+    end
+  end
+
+  ##
+  # Base name of this file without the extension
+
+  def page_name
+    basename = File.basename @relative_name
+    basename =~ /\.(rb|rdoc|txt|md)$/i
+
+    $` || basename
+  end
+
+  ##
+  # Path to this file for use with HTML generator output.
+
+  def path
+    http_url @store.rdoc.generator.file_dir
+  end
+
+  def pretty_print q # :nodoc:
+    q.group 2, "[#{self.class}: ", "]" do
+      q.text "base name: #{base_name.inspect}"
+      q.breakable
+
+      items = @modules.map { |n, m| m }
+      items.concat @modules.map { |n, c| c }
+      q.seplist items do |mod| q.pp mod end
+    end
+  end
+
+  ##
+  # Search record used by RDoc::Generator::JsonIndex
+
+  def search_record
+    return unless @parser < RDoc::Parser::Text
+
+    [
+      page_name,
+      '',
+      page_name,
+      '',
+      path,
+      '',
+      snippet(@comment),
+    ]
+  end
+
+  ##
+  # Is this TopLevel from a text file instead of a source code file?
+
+  def text?
+    @parser and @parser.include? RDoc::Parser::Text
+  end
+
+  def to_s # :nodoc:
+    "file #{full_name}"
+  end
+
+end